commit 8297bf0873f42ecb3e51fcd369b3402083c6763c Author: loliball <26589867+loliball@users.noreply.github.com> Date: Sun Sep 8 12:21:59 2024 +0800 初始化仓库 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..77cf741 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/cmake-build* \ No newline at end of file diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..13566b8 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/.idea/.name b/.idea/.name new file mode 100644 index 0000000..db37c4b --- /dev/null +++ b/.idea/.name @@ -0,0 +1 @@ +DXGI \ No newline at end of file diff --git a/.idea/_DXGI.iml b/.idea/_DXGI.iml new file mode 100644 index 0000000..f08604b --- /dev/null +++ b/.idea/_DXGI.iml @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/.idea/cmake.xml b/.idea/cmake.xml new file mode 100644 index 0000000..12ec6b4 --- /dev/null +++ b/.idea/cmake.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..0b76fe5 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,7 @@ + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..f9f52fc --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..0ac34d4 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,43 @@ +cmake_minimum_required(VERSION 3.20) + +set(PROJECT_NAME DXGI) +set(CMAKE_CXX_STANDARD 20) +set(CMAKE_BUILD_TYPE Ninja) +#set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3") +project(${PROJECT_NAME}) + +include_directories(ffmpeg-n4.3.2-win64-gpl-shared-4.3\\include) +link_directories(ffmpeg-n4.3.2-win64-gpl-shared-4.3\\lib) + +add_executable( + ${PROJECT_NAME} + WIN32 + DesktopDuplication.cpp + DisplayManager.cpp + DuplicationManager.cpp + ffvideo.cpp + OutputManager.cpp + ThreadManager.cpp +) + +target_link_libraries( + ${PROJECT_NAME} + avformat + avcodec + avdevice + avfilter + avutil + postproc + swresample + swscale + d3d11 +) + +# 复制dll +set(DLL_SOURCE_DIR ${CMAKE_SOURCE_DIR}/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin) +set(DLL_DEST_DIR $) +file(GLOB DLL_FILES "${DLL_SOURCE_DIR}/*.dll") +add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD + COMMAND ${CMAKE_COMMAND} -E copy_if_different + ${DLL_FILES} ${DLL_DEST_DIR} +) diff --git a/CommonTypes.h b/CommonTypes.h new file mode 100644 index 0000000..c46050e --- /dev/null +++ b/CommonTypes.h @@ -0,0 +1,115 @@ +// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF +// ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO +// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A +// PARTICULAR PURPOSE. +// +// Copyright (c) Microsoft Corporation. All rights reserved + +#ifndef _COMMONTYPES_H_ +#define _COMMONTYPES_H_ + +#include +#include +#include +#include +#include +#include +#include + +#include "PixelShader.h" +#include "VertexShader.h" + +#define NUMVERTICES 6 +#define BPP 4 + +#define OCCLUSION_STATUS_MSG WM_USER + +extern HRESULT SystemTransitionsExpectedErrors[]; +extern HRESULT CreateDuplicationExpectedErrors[]; +extern HRESULT FrameInfoExpectedErrors[]; +extern HRESULT AcquireFrameExpectedError[]; +extern HRESULT EnumOutputsExpectedErrors[]; + +typedef _Return_type_success_(return == DUPL_RETURN_SUCCESS) enum +{ + DUPL_RETURN_SUCCESS = 0, + DUPL_RETURN_ERROR_EXPECTED = 1, + DUPL_RETURN_ERROR_UNEXPECTED = 2 +}DUPL_RETURN; + +_Post_satisfies_(return != DUPL_RETURN_SUCCESS) +DUPL_RETURN ProcessFailure(_In_opt_ ID3D11Device* Device, _In_ LPCWSTR Str, _In_ LPCWSTR Title, HRESULT hr, _In_opt_z_ HRESULT* ExpectedErrors = nullptr); + +void DisplayMsg(_In_ LPCWSTR Str, _In_ LPCWSTR Title, HRESULT hr); + +// +// Holds info about the pointer/cursor +// +typedef struct _PTR_INFO +{ + _Field_size_bytes_(BufferSize) BYTE* PtrShapeBuffer; + DXGI_OUTDUPL_POINTER_SHAPE_INFO ShapeInfo; + POINT Position; + bool Visible; + UINT BufferSize; + UINT WhoUpdatedPositionLast; + LARGE_INTEGER LastTimeStamp; +} PTR_INFO; + +// +// Structure that holds D3D resources not directly tied to any one thread +// +typedef struct _DX_RESOURCES +{ + ID3D11Device* Device; + ID3D11DeviceContext* Context; + ID3D11VertexShader* VertexShader; + ID3D11PixelShader* PixelShader; + ID3D11InputLayout* InputLayout; + ID3D11SamplerState* SamplerLinear; +} DX_RESOURCES; + +// +// Structure to pass to a new thread +// +typedef struct _THREAD_DATA +{ + // Used to indicate abnormal error condition + HANDLE UnexpectedErrorEvent; + + // Used to indicate a transition event occurred e.g. PnpStop, PnpStart, mode change, TDR, desktop switch and the application needs to recreate the duplication interface + HANDLE ExpectedErrorEvent; + + // Used by WinProc to signal to threads to exit + HANDLE TerminateThreadsEvent; + + HANDLE TexSharedHandle; + UINT Output; + INT OffsetX; + INT OffsetY; + PTR_INFO* PtrInfo; + DX_RESOURCES DxRes; +} THREAD_DATA; + +// +// FRAME_DATA holds information about an acquired frame +// +typedef struct _FRAME_DATA +{ + ID3D11Texture2D* Frame; + DXGI_OUTDUPL_FRAME_INFO FrameInfo; + _Field_size_bytes_((MoveCount * sizeof(DXGI_OUTDUPL_MOVE_RECT)) + (DirtyCount * sizeof(RECT))) BYTE* MetaData; + UINT DirtyCount; + UINT MoveCount; +} FRAME_DATA; + +// +// A vertex with a position and texture coordinate +// +typedef struct _VERTEX +{ + DirectX::XMFLOAT3 Pos; + DirectX::XMFLOAT2 TexCoord; +} VERTEX; + +#endif diff --git a/DesktopDuplication.cpp b/DesktopDuplication.cpp new file mode 100644 index 0000000..196663b --- /dev/null +++ b/DesktopDuplication.cpp @@ -0,0 +1,644 @@ +// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF +// ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO +// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A +// PARTICULAR PURPOSE. +// +// Copyright (c) Microsoft Corporation. All rights reserved + +#include + +#include "DisplayManager.h" +#include "DuplicationManager.h" +#include "OutputManager.h" +#include "ThreadManager.h" + +//#include +#include +#include +#include + +// +// Globals +// +OUTPUTMANAGER OutMgr; + +// Below are lists of errors expect from Dxgi API calls when a transition event like mode change, PnpStop, PnpStart +// desktop switch, TDR or session disconnect/reconnect. In all these cases we want the application to clean up the threads that process +// the desktop updates and attempt to recreate them. +// If we get an error that is not on the appropriate list then we exit the application + +// These are the errors we expect from general Dxgi API due to a transition +HRESULT SystemTransitionsExpectedErrors[] = { + DXGI_ERROR_DEVICE_REMOVED, + DXGI_ERROR_ACCESS_LOST, + static_cast(WAIT_ABANDONED), + S_OK // Terminate list with zero valued HRESULT +}; + +// These are the errors we expect from IDXGIOutput1::DuplicateOutput due to a transition +HRESULT CreateDuplicationExpectedErrors[] = { + DXGI_ERROR_DEVICE_REMOVED, + static_cast(E_ACCESSDENIED), + DXGI_ERROR_UNSUPPORTED, + DXGI_ERROR_SESSION_DISCONNECTED, + S_OK // Terminate list with zero valued HRESULT +}; + +// These are the errors we expect from IDXGIOutputDuplication methods due to a transition +HRESULT FrameInfoExpectedErrors[] = { + DXGI_ERROR_DEVICE_REMOVED, + DXGI_ERROR_ACCESS_LOST, + S_OK // Terminate list with zero valued HRESULT +}; + +// These are the errors we expect from IDXGIAdapter::EnumOutputs methods due to outputs becoming stale during a transition +HRESULT EnumOutputsExpectedErrors[] = { + DXGI_ERROR_NOT_FOUND, + S_OK // Terminate list with zero valued HRESULT +}; + + +// +// Forward Declarations +// +DWORD WINAPI DDProc(_In_ void* Param); +LRESULT CALLBACK WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam); +bool ProcessCmdline(_Out_ INT* Output); +void ShowHelp(); + +// +// Class for progressive waits +// +typedef struct { + UINT WaitTime; + UINT WaitCount; +}WAIT_BAND; + +#define WAIT_BAND_COUNT 3 +#define WAIT_BAND_STOP 0 + +class DYNAMIC_WAIT { +public: + DYNAMIC_WAIT(); + ~DYNAMIC_WAIT(); + + void Wait(); + +private: + + static const WAIT_BAND m_WaitBands[WAIT_BAND_COUNT]; + + // Period in seconds that a new wait call is considered part of the same wait sequence + static const UINT m_WaitSequenceTimeInSeconds = 2; + + UINT m_CurrentWaitBandIdx; + UINT m_WaitCountInCurrentBand; + LARGE_INTEGER m_QPCFrequency; + LARGE_INTEGER m_LastWakeUpTime; + BOOL m_QPCValid; +}; +const WAIT_BAND DYNAMIC_WAIT::m_WaitBands[WAIT_BAND_COUNT] = { + {250, 20}, + {2000, 60}, + {5000, WAIT_BAND_STOP} // Never move past this band +}; + +DYNAMIC_WAIT::DYNAMIC_WAIT() : m_CurrentWaitBandIdx(0), m_WaitCountInCurrentBand(0) { + m_QPCValid = QueryPerformanceFrequency(&m_QPCFrequency); + m_LastWakeUpTime.QuadPart = 0L; +} + +DYNAMIC_WAIT::~DYNAMIC_WAIT() { +} + +void DYNAMIC_WAIT::Wait() { + LARGE_INTEGER CurrentQPC = { 0 }; + + // Is this wait being called with the period that we consider it to be part of the same wait sequence + QueryPerformanceCounter(&CurrentQPC); + if (m_QPCValid && (CurrentQPC.QuadPart <= (m_LastWakeUpTime.QuadPart + (m_QPCFrequency.QuadPart * m_WaitSequenceTimeInSeconds)))) { + // We are still in the same wait sequence, lets check if we should move to the next band + if ((m_WaitBands[m_CurrentWaitBandIdx].WaitCount != WAIT_BAND_STOP) && (m_WaitCountInCurrentBand > m_WaitBands[m_CurrentWaitBandIdx].WaitCount)) { + m_CurrentWaitBandIdx++; + m_WaitCountInCurrentBand = 0; + } + } + else { + // Either we could not get the current time or we are starting a new wait sequence + m_WaitCountInCurrentBand = 0; + m_CurrentWaitBandIdx = 0; + } + + // Sleep for the required period of time + Sleep(m_WaitBands[m_CurrentWaitBandIdx].WaitTime); + + // Record the time we woke up so we can detect wait sequences + QueryPerformanceCounter(&m_LastWakeUpTime); + m_WaitCountInCurrentBand++; +} + + +// +// Program entry point +// +int WINAPI WinMain(_In_ HINSTANCE hInstance, _In_opt_ HINSTANCE hPrevInstance, _In_ LPSTR lpCmdLine, _In_ INT nCmdShow) { + UNREFERENCED_PARAMETER(hPrevInstance); + UNREFERENCED_PARAMETER(lpCmdLine); + + INT SingleOutput; + + // Synchronization + HANDLE UnexpectedErrorEvent = nullptr; + HANDLE ExpectedErrorEvent = nullptr; + HANDLE TerminateThreadsEvent = nullptr; + + // Window + HWND WindowHandle = nullptr; + + bool CmdResult = ProcessCmdline(&SingleOutput); + if (!CmdResult) { + ShowHelp(); + return 0; + } + + // Event used by the threads to signal an unexpected error and we want to quit the app + UnexpectedErrorEvent = CreateEvent(nullptr, TRUE, FALSE, nullptr); + if (!UnexpectedErrorEvent) { + ProcessFailure(nullptr, L"UnexpectedErrorEvent creation failed", L"Error", E_UNEXPECTED); + return 0; + } + + // Event for when a thread encounters an expected error + ExpectedErrorEvent = CreateEvent(nullptr, TRUE, FALSE, nullptr); + if (!ExpectedErrorEvent) { + ProcessFailure(nullptr, L"ExpectedErrorEvent creation failed", L"Error", E_UNEXPECTED); + return 0; + } + + // Event to tell spawned threads to quit + TerminateThreadsEvent = CreateEvent(nullptr, TRUE, FALSE, nullptr); + if (!TerminateThreadsEvent) { + ProcessFailure(nullptr, L"TerminateThreadsEvent creation failed", L"Error", E_UNEXPECTED); + return 0; + } + + // Load simple cursor + HCURSOR Cursor = nullptr; + Cursor = LoadCursor(nullptr, IDC_ARROW); + if (!Cursor) { + ProcessFailure(nullptr, L"Cursor load failed", L"Error", E_UNEXPECTED); + return 0; + } + + // Register class + WNDCLASSEXW Wc; + Wc.cbSize = sizeof(WNDCLASSEXW); + Wc.style = CS_HREDRAW | CS_VREDRAW; + Wc.lpfnWndProc = WndProc; + Wc.cbClsExtra = 0; + Wc.cbWndExtra = 0; + Wc.hInstance = hInstance; + Wc.hIcon = nullptr; + Wc.hCursor = Cursor; + Wc.hbrBackground = nullptr; + Wc.lpszMenuName = nullptr; + Wc.lpszClassName = L"ddasample"; + Wc.hIconSm = nullptr; + if (!RegisterClassExW(&Wc)) { + ProcessFailure(nullptr, L"Window class registration failed", L"Error", E_UNEXPECTED); + return 0; + } + + // Create window + RECT WindowRect = { 0, 0, 960, 540 }; + AdjustWindowRect(&WindowRect, WS_OVERLAPPEDWINDOW, FALSE); + WindowHandle = CreateWindowW(L"ddasample", L"DXGI desktop duplication sample", + WS_OVERLAPPEDWINDOW, + 0, 0, + WindowRect.right - WindowRect.left, WindowRect.bottom - WindowRect.top, + nullptr, nullptr, hInstance, nullptr); + if (!WindowHandle) { + ProcessFailure(nullptr, L"Window creation failed", L"Error", E_FAIL); + return 0; + } + + DestroyCursor(Cursor); + + ShowWindow(WindowHandle, nCmdShow); + UpdateWindow(WindowHandle); + + THREADMANAGER ThreadMgr; + RECT DeskBounds; + UINT OutputCount; + + // Message loop (attempts to update screen when no other messages to process) + MSG msg = { 0 }; + bool FirstTime = true; + bool Occluded = true; + DYNAMIC_WAIT DynamicWait; + + while (WM_QUIT != msg.message) { + DUPL_RETURN Ret = DUPL_RETURN_SUCCESS; + if (PeekMessage(&msg, nullptr, 0, 0, PM_REMOVE)) { + if (msg.message == OCCLUSION_STATUS_MSG) { + // Present may not be occluded now so try again + Occluded = false; + } + else { + // Process window messages + TranslateMessage(&msg); + DispatchMessage(&msg); + } + } + else if (WaitForSingleObjectEx(UnexpectedErrorEvent, 0, FALSE) == WAIT_OBJECT_0) { + // Unexpected error occurred so exit the application + break; + } + else if (FirstTime || WaitForSingleObjectEx(ExpectedErrorEvent, 0, FALSE) == WAIT_OBJECT_0) { + if (!FirstTime) { + // Terminate other threads + SetEvent(TerminateThreadsEvent); + ThreadMgr.WaitForThreadTermination(); + ResetEvent(TerminateThreadsEvent); + ResetEvent(ExpectedErrorEvent); + + // Clean up + ThreadMgr.Clean(); + OutMgr.CleanRefs(); + + // As we have encountered an error due to a system transition we wait before trying again, using this dynamic wait + // the wait periods will get progressively long to avoid wasting too much system resource if this state lasts a long time + DynamicWait.Wait(); + } + else { + // First time through the loop so nothing to clean up + FirstTime = false; + } + + // Re-initialize + Ret = OutMgr.InitOutput(WindowHandle, SingleOutput, &OutputCount, &DeskBounds); + if (Ret == DUPL_RETURN_SUCCESS) { + HANDLE SharedHandle = OutMgr.GetSharedHandle(); + if (SharedHandle) { + Ret = ThreadMgr.Initialize(SingleOutput, OutputCount, UnexpectedErrorEvent, ExpectedErrorEvent, TerminateThreadsEvent, SharedHandle, &DeskBounds); + } + else { + DisplayMsg(L"Failed to get handle of shared surface", L"Error", S_OK); + Ret = DUPL_RETURN_ERROR_UNEXPECTED; + } + } + + // We start off in occluded state and we should immediate get a occlusion status window message + Occluded = true; + } + else { + // Nothing else to do, so try to present to write out to window if not occluded + if (!Occluded) { + Ret = OutMgr.UpdateApplicationWindow(ThreadMgr.GetPointerInfo(), &Occluded); + } + } + + // Check if for errors + if (Ret != DUPL_RETURN_SUCCESS) { + if (Ret == DUPL_RETURN_ERROR_EXPECTED) { + // Some type of system transition is occurring so retry + SetEvent(ExpectedErrorEvent); + } + else { + // Unexpected error so exit + break; + } + } + } + + // Make sure all other threads have exited + if (SetEvent(TerminateThreadsEvent)) { + ThreadMgr.WaitForThreadTermination(); + } + + // Clean up + CloseHandle(UnexpectedErrorEvent); + CloseHandle(ExpectedErrorEvent); + CloseHandle(TerminateThreadsEvent); + + if (msg.message == WM_QUIT) { + // For a WM_QUIT message we should return the wParam value + return static_cast(msg.wParam); + } + + return 0; +} + +// +// Shows help +// +void ShowHelp() { + DisplayMsg(L"The following optional parameters can be used -\n /output [all | n]\t\tto duplicate all outputs or the nth output\n /?\t\t\tto display this help section", + L"Proper usage", S_OK); +} + +// +// Process command line parameters +// +bool ProcessCmdline(_Out_ INT* Output) { + *Output = -1; + + // __argv and __argc are global vars set by system + for (UINT i = 1; i < static_cast(__argc); ++i) { + if ((strcmp(__argv[i], "-output") == 0) || + (strcmp(__argv[i], "/output") == 0)) { + if (++i >= static_cast(__argc)) { + return false; + } + + if (strcmp(__argv[i], "all") == 0) { + *Output = -1; + } + else { + *Output = atoi(__argv[i]); + } + continue; + } + else { + return false; + } + } + return true; +} + +// +// Window message processor +// +LRESULT CALLBACK WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam) { + switch (message) { + case WM_DESTROY: + { + PostQuitMessage(0); + break; + } + case WM_SIZE: + { + // Tell output manager that window size has changed + OutMgr.WindowResize(); + break; + } + default: + return DefWindowProc(hWnd, message, wParam, lParam); + } + + return 0; +} + + + + +// +// Entry point for new duplication threads +// +DWORD WINAPI DDProc(_In_ void* Param) { + // Classes + DISPLAYMANAGER DispMgr; + DUPLICATIONMANAGER DuplMgr; + + // D3D objects + ID3D11Texture2D* SharedSurf = nullptr; + IDXGIKeyedMutex* KeyMutex = nullptr; + + // Data passed in from thread creation + THREAD_DATA* TData = reinterpret_cast(Param); + + // Get desktop + DUPL_RETURN Ret; + HDESK CurrentDesktop = nullptr; + CurrentDesktop = OpenInputDesktop(0, FALSE, GENERIC_ALL); + if (!CurrentDesktop) { + // We do not have access to the desktop so request a retry + SetEvent(TData->ExpectedErrorEvent); + Ret = DUPL_RETURN_ERROR_EXPECTED; + goto Exit; + } + + // Attach desktop to this thread + bool DesktopAttached; + DesktopAttached = SetThreadDesktop(CurrentDesktop) != 0; + CloseDesktop(CurrentDesktop); + CurrentDesktop = nullptr; + if (!DesktopAttached) { + // We do not have access to the desktop so request a retry + Ret = DUPL_RETURN_ERROR_EXPECTED; + goto Exit; + } + + // New display manager + DispMgr.InitD3D(&TData->DxRes); + + // Obtain handle to sync shared Surface + HRESULT hr; + hr = TData->DxRes.Device->OpenSharedResource(TData->TexSharedHandle, __uuidof(ID3D11Texture2D), + reinterpret_cast(&SharedSurf)); + if (FAILED(hr)) { + Ret = ProcessFailure(TData->DxRes.Device, L"Opening shared texture failed", L"Error", hr, SystemTransitionsExpectedErrors); + goto Exit; + } + + hr = SharedSurf->QueryInterface(__uuidof(IDXGIKeyedMutex), reinterpret_cast(&KeyMutex)); + if (FAILED(hr)) { + Ret = ProcessFailure(nullptr, L"Failed to get keyed mutex interface in spawned thread", L"Error", hr); + goto Exit; + } + + // Make duplication manager + Ret = DuplMgr.InitDupl(TData->DxRes.Device, TData->Output); + if (Ret != DUPL_RETURN_SUCCESS) { + goto Exit; + } + + // Get output description + DXGI_OUTPUT_DESC DesktopDesc; + RtlZeroMemory(&DesktopDesc, sizeof(DXGI_OUTPUT_DESC)); + DuplMgr.GetOutputDesc(&DesktopDesc); + + // Main duplication loop + bool WaitToProcessCurrentFrame; + WaitToProcessCurrentFrame = false; + FRAME_DATA CurrentData; + + while ((WaitForSingleObjectEx(TData->TerminateThreadsEvent, 0, FALSE) == WAIT_TIMEOUT)) { + if (!WaitToProcessCurrentFrame) { + // Get new frame from desktop duplication + bool TimeOut; + Ret = DuplMgr.GetFrame(&CurrentData, &TimeOut); + if (Ret != DUPL_RETURN_SUCCESS) { + // An error occurred getting the next frame drop out of loop which + // will check if it was expected or not + break; + } + + // Check for timeout + if (TimeOut) { + // No new frame at the moment + continue; + } + } + + static int tim = 0; + + if (tim == 0) { + tim = 1; + + ID3D11Texture2D* t2d = CurrentData.Frame; + ID3D11DeviceContext* ctx; + DuplMgr.m_Device->GetImmediateContext(&ctx); + //extractImageData(DuplMgr.m_DeskDupl, ctx, t2d); + } + + // We have a new frame so try and process it + // Try to acquire keyed mutex in order to access shared surface + hr = KeyMutex->AcquireSync(0, 1000); + if (hr == static_cast(WAIT_TIMEOUT)) { + // Can't use shared surface right now, try again later + WaitToProcessCurrentFrame = true; + continue; + } + else if (FAILED(hr)) { + // Generic unknown failure + Ret = ProcessFailure(TData->DxRes.Device, L"Unexpected error acquiring KeyMutex", L"Error", hr, SystemTransitionsExpectedErrors); + DuplMgr.DoneWithFrame(); + break; + } + + // We can now process the current frame + WaitToProcessCurrentFrame = false; + + // Get mouse info + Ret = DuplMgr.GetMouse(TData->PtrInfo, &(CurrentData.FrameInfo), TData->OffsetX, TData->OffsetY); + if (Ret != DUPL_RETURN_SUCCESS) { + DuplMgr.DoneWithFrame(); + KeyMutex->ReleaseSync(1); + break; + } + + // Process new frame + Ret = DispMgr.ProcessFrame(&CurrentData, SharedSurf, TData->OffsetX, TData->OffsetY, &DesktopDesc); + if (Ret != DUPL_RETURN_SUCCESS) { + DuplMgr.DoneWithFrame(); + KeyMutex->ReleaseSync(1); + break; + } + + // Release acquired keyed mutex + hr = KeyMutex->ReleaseSync(1); + if (FAILED(hr)) { + Ret = ProcessFailure(TData->DxRes.Device, L"Unexpected error releasing the keyed mutex", L"Error", hr, SystemTransitionsExpectedErrors); + DuplMgr.DoneWithFrame(); + break; + } + + // Release frame back to desktop duplication + Ret = DuplMgr.DoneWithFrame(); + if (Ret != DUPL_RETURN_SUCCESS) { + break; + } + } + +Exit: + if (Ret != DUPL_RETURN_SUCCESS) { + if (Ret == DUPL_RETURN_ERROR_EXPECTED) { + // The system is in a transition state so request the duplication be restarted + SetEvent(TData->ExpectedErrorEvent); + } + else { + // Unexpected error so exit the application + SetEvent(TData->UnexpectedErrorEvent); + } + } + + if (SharedSurf) { + SharedSurf->Release(); + SharedSurf = nullptr; + } + + if (KeyMutex) { + KeyMutex->Release(); + KeyMutex = nullptr; + } + + return 0; +} + +_Post_satisfies_(return != DUPL_RETURN_SUCCESS) +DUPL_RETURN ProcessFailure(_In_opt_ ID3D11Device * Device, _In_ LPCWSTR Str, _In_ LPCWSTR Title, HRESULT hr, _In_opt_z_ HRESULT * ExpectedErrors) { + HRESULT TranslatedHr; + + // On an error check if the DX device is lost + if (Device) { + HRESULT DeviceRemovedReason = Device->GetDeviceRemovedReason(); + + switch (DeviceRemovedReason) { + case DXGI_ERROR_DEVICE_REMOVED: + case DXGI_ERROR_DEVICE_RESET: + case static_cast(E_OUTOFMEMORY) : + { + // Our device has been stopped due to an external event on the GPU so map them all to + // device removed and continue processing the condition + TranslatedHr = DXGI_ERROR_DEVICE_REMOVED; + break; + } + + case S_OK: + { + // Device is not removed so use original error + TranslatedHr = hr; + break; + } + + default: + { + // Device is removed but not a error we want to remap + TranslatedHr = DeviceRemovedReason; + } + } + } + else { + TranslatedHr = hr; + } + + // Check if this error was expected or not + if (ExpectedErrors) { + HRESULT* CurrentResult = ExpectedErrors; + + while (*CurrentResult != S_OK) { + if (*(CurrentResult++) == TranslatedHr) { + return DUPL_RETURN_ERROR_EXPECTED; + } + } + } + + // Error was not expected so display the message box + DisplayMsg(Str, Title, TranslatedHr); + + return DUPL_RETURN_ERROR_UNEXPECTED; +} + +// +// Displays a message +// +void DisplayMsg(_In_ LPCWSTR Str, _In_ LPCWSTR Title, HRESULT hr) { + if (SUCCEEDED(hr)) { + MessageBoxW(nullptr, Str, Title, MB_OK); + return; + } + + const UINT StringLen = (UINT)(wcslen(Str) + sizeof(" with HRESULT 0x########.")); + wchar_t* OutStr = new wchar_t[StringLen]; + if (!OutStr) { + return; + } + + INT LenWritten = swprintf_s(OutStr, StringLen, L"%s with 0x%X.", Str, hr); + if (LenWritten != -1) { + MessageBoxW(nullptr, OutStr, Title, MB_OK); + } + + delete[] OutStr; +} diff --git a/DisplayManager.cpp b/DisplayManager.cpp new file mode 100644 index 0000000..98209a0 --- /dev/null +++ b/DisplayManager.cpp @@ -0,0 +1,478 @@ +// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF +// ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO +// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A +// PARTICULAR PURPOSE. +// +// Copyright (c) Microsoft Corporation. All rights reserved + +#include "DisplayManager.h" +using namespace DirectX; + +// +// Constructor NULLs out vars +// +DISPLAYMANAGER::DISPLAYMANAGER() : m_Device(nullptr), + m_DeviceContext(nullptr), + m_MoveSurf(nullptr), + m_VertexShader(nullptr), + m_PixelShader(nullptr), + m_InputLayout(nullptr), + m_RTV(nullptr), + m_SamplerLinear(nullptr), + m_DirtyVertexBufferAlloc(nullptr), + m_DirtyVertexBufferAllocSize(0) +{ +} + +// +// Destructor calls CleanRefs to destroy everything +// +DISPLAYMANAGER::~DISPLAYMANAGER() +{ + CleanRefs(); + + if (m_DirtyVertexBufferAlloc) + { + delete [] m_DirtyVertexBufferAlloc; + m_DirtyVertexBufferAlloc = nullptr; + } +} + +// +// Initialize D3D variables +// +void DISPLAYMANAGER::InitD3D(DX_RESOURCES* Data) +{ + m_Device = Data->Device; + m_DeviceContext = Data->Context; + m_VertexShader = Data->VertexShader; + m_PixelShader = Data->PixelShader; + m_InputLayout = Data->InputLayout; + m_SamplerLinear = Data->SamplerLinear; + + m_Device->AddRef(); + m_DeviceContext->AddRef(); + m_VertexShader->AddRef(); + m_PixelShader->AddRef(); + m_InputLayout->AddRef(); + m_SamplerLinear->AddRef(); +} + +// +// Process a given frame and its metadata +// +DUPL_RETURN DISPLAYMANAGER::ProcessFrame(_In_ FRAME_DATA* Data, _Inout_ ID3D11Texture2D* SharedSurf, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc) +{ + DUPL_RETURN Ret = DUPL_RETURN_SUCCESS; + + // Process dirties and moves + if (Data->FrameInfo.TotalMetadataBufferSize) + { + D3D11_TEXTURE2D_DESC Desc; + Data->Frame->GetDesc(&Desc); + + if (Data->MoveCount) + { + Ret = CopyMove(SharedSurf, reinterpret_cast(Data->MetaData), Data->MoveCount, OffsetX, OffsetY, DeskDesc, Desc.Width, Desc.Height); + if (Ret != DUPL_RETURN_SUCCESS) + { + return Ret; + } + } + + if (Data->DirtyCount) + { + Ret = CopyDirty(Data->Frame, SharedSurf, reinterpret_cast(Data->MetaData + (Data->MoveCount * sizeof(DXGI_OUTDUPL_MOVE_RECT))), Data->DirtyCount, OffsetX, OffsetY, DeskDesc); + } + } + + return Ret; +} + +// +// Returns D3D device being used +// +ID3D11Device* DISPLAYMANAGER::GetDevice() +{ + return m_Device; +} + +// +// Set appropriate source and destination rects for move rects +// +void DISPLAYMANAGER::SetMoveRect(_Out_ RECT* SrcRect, _Out_ RECT* DestRect, _In_ DXGI_OUTPUT_DESC* DeskDesc, _In_ DXGI_OUTDUPL_MOVE_RECT* MoveRect, INT TexWidth, INT TexHeight) +{ + switch (DeskDesc->Rotation) + { + case DXGI_MODE_ROTATION_UNSPECIFIED: + case DXGI_MODE_ROTATION_IDENTITY: + { + SrcRect->left = MoveRect->SourcePoint.x; + SrcRect->top = MoveRect->SourcePoint.y; + SrcRect->right = MoveRect->SourcePoint.x + MoveRect->DestinationRect.right - MoveRect->DestinationRect.left; + SrcRect->bottom = MoveRect->SourcePoint.y + MoveRect->DestinationRect.bottom - MoveRect->DestinationRect.top; + + *DestRect = MoveRect->DestinationRect; + break; + } + case DXGI_MODE_ROTATION_ROTATE90: + { + SrcRect->left = TexHeight - (MoveRect->SourcePoint.y + MoveRect->DestinationRect.bottom - MoveRect->DestinationRect.top); + SrcRect->top = MoveRect->SourcePoint.x; + SrcRect->right = TexHeight - MoveRect->SourcePoint.y; + SrcRect->bottom = MoveRect->SourcePoint.x + MoveRect->DestinationRect.right - MoveRect->DestinationRect.left; + + DestRect->left = TexHeight - MoveRect->DestinationRect.bottom; + DestRect->top = MoveRect->DestinationRect.left; + DestRect->right = TexHeight - MoveRect->DestinationRect.top; + DestRect->bottom = MoveRect->DestinationRect.right; + break; + } + case DXGI_MODE_ROTATION_ROTATE180: + { + SrcRect->left = TexWidth - (MoveRect->SourcePoint.x + MoveRect->DestinationRect.right - MoveRect->DestinationRect.left); + SrcRect->top = TexHeight - (MoveRect->SourcePoint.y + MoveRect->DestinationRect.bottom - MoveRect->DestinationRect.top); + SrcRect->right = TexWidth - MoveRect->SourcePoint.x; + SrcRect->bottom = TexHeight - MoveRect->SourcePoint.y; + + DestRect->left = TexWidth - MoveRect->DestinationRect.right; + DestRect->top = TexHeight - MoveRect->DestinationRect.bottom; + DestRect->right = TexWidth - MoveRect->DestinationRect.left; + DestRect->bottom = TexHeight - MoveRect->DestinationRect.top; + break; + } + case DXGI_MODE_ROTATION_ROTATE270: + { + SrcRect->left = MoveRect->SourcePoint.x; + SrcRect->top = TexWidth - (MoveRect->SourcePoint.x + MoveRect->DestinationRect.right - MoveRect->DestinationRect.left); + SrcRect->right = MoveRect->SourcePoint.y + MoveRect->DestinationRect.bottom - MoveRect->DestinationRect.top; + SrcRect->bottom = TexWidth - MoveRect->SourcePoint.x; + + DestRect->left = MoveRect->DestinationRect.top; + DestRect->top = TexWidth - MoveRect->DestinationRect.right; + DestRect->right = MoveRect->DestinationRect.bottom; + DestRect->bottom = TexWidth - MoveRect->DestinationRect.left; + break; + } + default: + { + RtlZeroMemory(DestRect, sizeof(RECT)); + RtlZeroMemory(SrcRect, sizeof(RECT)); + break; + } + } +} + +// +// Copy move rectangles +// +DUPL_RETURN DISPLAYMANAGER::CopyMove(_Inout_ ID3D11Texture2D* SharedSurf, _In_reads_(MoveCount) DXGI_OUTDUPL_MOVE_RECT* MoveBuffer, UINT MoveCount, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc, INT TexWidth, INT TexHeight) +{ + D3D11_TEXTURE2D_DESC FullDesc; + SharedSurf->GetDesc(&FullDesc); + + // Make new intermediate surface to copy into for moving + if (!m_MoveSurf) + { + D3D11_TEXTURE2D_DESC MoveDesc; + MoveDesc = FullDesc; + MoveDesc.Width = DeskDesc->DesktopCoordinates.right - DeskDesc->DesktopCoordinates.left; + MoveDesc.Height = DeskDesc->DesktopCoordinates.bottom - DeskDesc->DesktopCoordinates.top; + MoveDesc.BindFlags = D3D11_BIND_RENDER_TARGET; + MoveDesc.MiscFlags = 0; + HRESULT hr = m_Device->CreateTexture2D(&MoveDesc, nullptr, &m_MoveSurf); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to create staging texture for move rects", L"Error", hr, SystemTransitionsExpectedErrors); + } + } + + for (UINT i = 0; i < MoveCount; ++i) + { + RECT SrcRect; + RECT DestRect; + + SetMoveRect(&SrcRect, &DestRect, DeskDesc, &(MoveBuffer[i]), TexWidth, TexHeight); + + // Copy rect out of shared surface + D3D11_BOX Box; + Box.left = SrcRect.left + DeskDesc->DesktopCoordinates.left - OffsetX; + Box.top = SrcRect.top + DeskDesc->DesktopCoordinates.top - OffsetY; + Box.front = 0; + Box.right = SrcRect.right + DeskDesc->DesktopCoordinates.left - OffsetX; + Box.bottom = SrcRect.bottom + DeskDesc->DesktopCoordinates.top - OffsetY; + Box.back = 1; + m_DeviceContext->CopySubresourceRegion(m_MoveSurf, 0, SrcRect.left, SrcRect.top, 0, SharedSurf, 0, &Box); + + // Copy back to shared surface + Box.left = SrcRect.left; + Box.top = SrcRect.top; + Box.front = 0; + Box.right = SrcRect.right; + Box.bottom = SrcRect.bottom; + Box.back = 1; + m_DeviceContext->CopySubresourceRegion(SharedSurf, 0, DestRect.left + DeskDesc->DesktopCoordinates.left - OffsetX, DestRect.top + DeskDesc->DesktopCoordinates.top - OffsetY, 0, m_MoveSurf, 0, &Box); + } + + return DUPL_RETURN_SUCCESS; +} + +// +// Sets up vertices for dirty rects for rotated desktops +// +#pragma warning(push) +#pragma warning(disable:__WARNING_USING_UNINIT_VAR) // false positives in SetDirtyVert due to tool bug + +void DISPLAYMANAGER::SetDirtyVert(_Out_writes_(NUMVERTICES) VERTEX* Vertices, _In_ RECT* Dirty, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc, _In_ D3D11_TEXTURE2D_DESC* FullDesc, _In_ D3D11_TEXTURE2D_DESC* ThisDesc) +{ + INT CenterX = FullDesc->Width / 2; + INT CenterY = FullDesc->Height / 2; + + INT Width = DeskDesc->DesktopCoordinates.right - DeskDesc->DesktopCoordinates.left; + INT Height = DeskDesc->DesktopCoordinates.bottom - DeskDesc->DesktopCoordinates.top; + + // Rotation compensated destination rect + RECT DestDirty = *Dirty; + + // Set appropriate coordinates compensated for rotation + switch (DeskDesc->Rotation) + { + case DXGI_MODE_ROTATION_ROTATE90: + { + DestDirty.left = Width - Dirty->bottom; + DestDirty.top = Dirty->left; + DestDirty.right = Width - Dirty->top; + DestDirty.bottom = Dirty->right; + + Vertices[0].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); + Vertices[1].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); + Vertices[2].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); + Vertices[5].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); + break; + } + case DXGI_MODE_ROTATION_ROTATE180: + { + DestDirty.left = Width - Dirty->right; + DestDirty.top = Height - Dirty->bottom; + DestDirty.right = Width - Dirty->left; + DestDirty.bottom = Height - Dirty->top; + + Vertices[0].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); + Vertices[1].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); + Vertices[2].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); + Vertices[5].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); + break; + } + case DXGI_MODE_ROTATION_ROTATE270: + { + DestDirty.left = Dirty->top; + DestDirty.top = Height - Dirty->right; + DestDirty.right = Dirty->bottom; + DestDirty.bottom = Height - Dirty->left; + + Vertices[0].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); + Vertices[1].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); + Vertices[2].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); + Vertices[5].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); + break; + } + default: + assert(false); // drop through + case DXGI_MODE_ROTATION_UNSPECIFIED: + case DXGI_MODE_ROTATION_IDENTITY: + { + Vertices[0].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); + Vertices[1].TexCoord = XMFLOAT2(Dirty->left / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); + Vertices[2].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->bottom / static_cast(ThisDesc->Height)); + Vertices[5].TexCoord = XMFLOAT2(Dirty->right / static_cast(ThisDesc->Width), Dirty->top / static_cast(ThisDesc->Height)); + break; + } + } + + // Set positions + Vertices[0].Pos = XMFLOAT3((DestDirty.left + DeskDesc->DesktopCoordinates.left - OffsetX - CenterX) / static_cast(CenterX), + -1 * (DestDirty.bottom + DeskDesc->DesktopCoordinates.top - OffsetY - CenterY) / static_cast(CenterY), + 0.0f); + Vertices[1].Pos = XMFLOAT3((DestDirty.left + DeskDesc->DesktopCoordinates.left - OffsetX - CenterX) / static_cast(CenterX), + -1 * (DestDirty.top + DeskDesc->DesktopCoordinates.top - OffsetY - CenterY) / static_cast(CenterY), + 0.0f); + Vertices[2].Pos = XMFLOAT3((DestDirty.right + DeskDesc->DesktopCoordinates.left - OffsetX - CenterX) / static_cast(CenterX), + -1 * (DestDirty.bottom + DeskDesc->DesktopCoordinates.top - OffsetY - CenterY) / static_cast(CenterY), + 0.0f); + Vertices[3].Pos = Vertices[2].Pos; + Vertices[4].Pos = Vertices[1].Pos; + Vertices[5].Pos = XMFLOAT3((DestDirty.right + DeskDesc->DesktopCoordinates.left - OffsetX - CenterX) / static_cast(CenterX), + -1 * (DestDirty.top + DeskDesc->DesktopCoordinates.top - OffsetY - CenterY) / static_cast(CenterY), + 0.0f); + + Vertices[3].TexCoord = Vertices[2].TexCoord; + Vertices[4].TexCoord = Vertices[1].TexCoord; +} + +#pragma warning(pop) // re-enable __WARNING_USING_UNINIT_VAR + +// +// Copies dirty rectangles +// +DUPL_RETURN DISPLAYMANAGER::CopyDirty(_In_ ID3D11Texture2D* SrcSurface, _Inout_ ID3D11Texture2D* SharedSurf, _In_reads_(DirtyCount) RECT* DirtyBuffer, UINT DirtyCount, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc) +{ + HRESULT hr; + + D3D11_TEXTURE2D_DESC FullDesc; + SharedSurf->GetDesc(&FullDesc); + + D3D11_TEXTURE2D_DESC ThisDesc; + SrcSurface->GetDesc(&ThisDesc); + + if (!m_RTV) + { + hr = m_Device->CreateRenderTargetView(SharedSurf, nullptr, &m_RTV); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to create render target view for dirty rects", L"Error", hr, SystemTransitionsExpectedErrors); + } + } + + D3D11_SHADER_RESOURCE_VIEW_DESC ShaderDesc; + ShaderDesc.Format = ThisDesc.Format; + ShaderDesc.ViewDimension = D3D11_SRV_DIMENSION_TEXTURE2D; + ShaderDesc.Texture2D.MostDetailedMip = ThisDesc.MipLevels - 1; + ShaderDesc.Texture2D.MipLevels = ThisDesc.MipLevels; + + // Create new shader resource view + ID3D11ShaderResourceView* ShaderResource = nullptr; + hr = m_Device->CreateShaderResourceView(SrcSurface, &ShaderDesc, &ShaderResource); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to create shader resource view for dirty rects", L"Error", hr, SystemTransitionsExpectedErrors); + } + + FLOAT BlendFactor[4] = {0.f, 0.f, 0.f, 0.f}; + m_DeviceContext->OMSetBlendState(nullptr, BlendFactor, 0xFFFFFFFF); + m_DeviceContext->OMSetRenderTargets(1, &m_RTV, nullptr); + m_DeviceContext->VSSetShader(m_VertexShader, nullptr, 0); + m_DeviceContext->PSSetShader(m_PixelShader, nullptr, 0); + m_DeviceContext->PSSetShaderResources(0, 1, &ShaderResource); + m_DeviceContext->PSSetSamplers(0, 1, &m_SamplerLinear); + m_DeviceContext->IASetPrimitiveTopology(D3D11_PRIMITIVE_TOPOLOGY_TRIANGLELIST); + + // Create space for vertices for the dirty rects if the current space isn't large enough + UINT BytesNeeded = sizeof(VERTEX) * NUMVERTICES * DirtyCount; + if (BytesNeeded > m_DirtyVertexBufferAllocSize) + { + if (m_DirtyVertexBufferAlloc) + { + delete [] m_DirtyVertexBufferAlloc; + } + + m_DirtyVertexBufferAlloc = new (std::nothrow) BYTE[BytesNeeded]; + if (!m_DirtyVertexBufferAlloc) + { + m_DirtyVertexBufferAllocSize = 0; + return ProcessFailure(nullptr, L"Failed to allocate memory for dirty vertex buffer.", L"Error", E_OUTOFMEMORY); + } + + m_DirtyVertexBufferAllocSize = BytesNeeded; + } + + // Fill them in + VERTEX* DirtyVertex = reinterpret_cast(m_DirtyVertexBufferAlloc); + for (UINT i = 0; i < DirtyCount; ++i, DirtyVertex += NUMVERTICES) + { + SetDirtyVert(DirtyVertex, &(DirtyBuffer[i]), OffsetX, OffsetY, DeskDesc, &FullDesc, &ThisDesc); + } + + // Create vertex buffer + D3D11_BUFFER_DESC BufferDesc; + RtlZeroMemory(&BufferDesc, sizeof(BufferDesc)); + BufferDesc.Usage = D3D11_USAGE_DEFAULT; + BufferDesc.ByteWidth = BytesNeeded; + BufferDesc.BindFlags = D3D11_BIND_VERTEX_BUFFER; + BufferDesc.CPUAccessFlags = 0; + D3D11_SUBRESOURCE_DATA InitData; + RtlZeroMemory(&InitData, sizeof(InitData)); + InitData.pSysMem = m_DirtyVertexBufferAlloc; + + ID3D11Buffer* VertBuf = nullptr; + hr = m_Device->CreateBuffer(&BufferDesc, &InitData, &VertBuf); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to create vertex buffer in dirty rect processing", L"Error", hr, SystemTransitionsExpectedErrors); + } + UINT Stride = sizeof(VERTEX); + UINT Offset = 0; + m_DeviceContext->IASetVertexBuffers(0, 1, &VertBuf, &Stride, &Offset); + + D3D11_VIEWPORT VP; + VP.Width = static_cast(FullDesc.Width); + VP.Height = static_cast(FullDesc.Height); + VP.MinDepth = 0.0f; + VP.MaxDepth = 1.0f; + VP.TopLeftX = 0.0f; + VP.TopLeftY = 0.0f; + m_DeviceContext->RSSetViewports(1, &VP); + + m_DeviceContext->Draw(NUMVERTICES * DirtyCount, 0); + + VertBuf->Release(); + VertBuf = nullptr; + + ShaderResource->Release(); + ShaderResource = nullptr; + + return DUPL_RETURN_SUCCESS; +} + +// +// Clean all references +// +void DISPLAYMANAGER::CleanRefs() +{ + if (m_DeviceContext) + { + m_DeviceContext->Release(); + m_DeviceContext = nullptr; + } + + if (m_Device) + { + m_Device->Release(); + m_Device = nullptr; + } + + if (m_MoveSurf) + { + m_MoveSurf->Release(); + m_MoveSurf = nullptr; + } + + if (m_VertexShader) + { + m_VertexShader->Release(); + m_VertexShader = nullptr; + } + + if (m_PixelShader) + { + m_PixelShader->Release(); + m_PixelShader = nullptr; + } + + if (m_InputLayout) + { + m_InputLayout->Release(); + m_InputLayout = nullptr; + } + + if (m_SamplerLinear) + { + m_SamplerLinear->Release(); + m_SamplerLinear = nullptr; + } + + if (m_RTV) + { + m_RTV->Release(); + m_RTV = nullptr; + } +} diff --git a/DisplayManager.h b/DisplayManager.h new file mode 100644 index 0000000..f9bf69c --- /dev/null +++ b/DisplayManager.h @@ -0,0 +1,46 @@ +// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF +// ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO +// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A +// PARTICULAR PURPOSE. +// +// Copyright (c) Microsoft Corporation. All rights reserved + +#ifndef _DISPLAYMANAGER_H_ +#define _DISPLAYMANAGER_H_ + +#include "CommonTypes.h" + +// +// Handles the task of processing frames +// +class DISPLAYMANAGER +{ + public: + DISPLAYMANAGER(); + ~DISPLAYMANAGER(); + void InitD3D(DX_RESOURCES* Data); + ID3D11Device* GetDevice(); + DUPL_RETURN ProcessFrame(_In_ FRAME_DATA* Data, _Inout_ ID3D11Texture2D* SharedSurf, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc); + void CleanRefs(); + + private: + // methods + DUPL_RETURN CopyDirty(_In_ ID3D11Texture2D* SrcSurface, _Inout_ ID3D11Texture2D* SharedSurf, _In_reads_(DirtyCount) RECT* DirtyBuffer, UINT DirtyCount, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc); + DUPL_RETURN CopyMove(_Inout_ ID3D11Texture2D* SharedSurf, _In_reads_(MoveCount) DXGI_OUTDUPL_MOVE_RECT* MoveBuffer, UINT MoveCount, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc, INT TexWidth, INT TexHeight); + void SetDirtyVert(_Out_writes_(NUMVERTICES) VERTEX* Vertices, _In_ RECT* Dirty, INT OffsetX, INT OffsetY, _In_ DXGI_OUTPUT_DESC* DeskDesc, _In_ D3D11_TEXTURE2D_DESC* FullDesc, _In_ D3D11_TEXTURE2D_DESC* ThisDesc); + void SetMoveRect(_Out_ RECT* SrcRect, _Out_ RECT* DestRect, _In_ DXGI_OUTPUT_DESC* DeskDesc, _In_ DXGI_OUTDUPL_MOVE_RECT* MoveRect, INT TexWidth, INT TexHeight); + + // variables + ID3D11Device* m_Device; + ID3D11DeviceContext* m_DeviceContext; + ID3D11Texture2D* m_MoveSurf; + ID3D11VertexShader* m_VertexShader; + ID3D11PixelShader* m_PixelShader; + ID3D11InputLayout* m_InputLayout; + ID3D11RenderTargetView* m_RTV; + ID3D11SamplerState* m_SamplerLinear; + BYTE* m_DirtyVertexBufferAlloc; + UINT m_DirtyVertexBufferAllocSize; +}; + +#endif diff --git a/DuplicationManager.cpp b/DuplicationManager.cpp new file mode 100644 index 0000000..6dd40c3 --- /dev/null +++ b/DuplicationManager.cpp @@ -0,0 +1,421 @@ +// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF +// ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO +// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A +// PARTICULAR PURPOSE. +// +// Copyright (c) Microsoft Corporation. All rights reserved + +#include "DuplicationManager.h" + +#include +#include +#include +#include + +// +// Constructor sets up references / variables +// +DUPLICATIONMANAGER::DUPLICATIONMANAGER() : m_DeskDupl(nullptr), + m_AcquiredDesktopImage(nullptr), + m_MetaDataBuffer(nullptr), + m_MetaDataSize(0), + m_OutputNumber(0), + m_Device(nullptr) { + RtlZeroMemory(&m_OutputDesc, sizeof(m_OutputDesc)); +} + +// +// Destructor simply calls CleanRefs to destroy everything +// +DUPLICATIONMANAGER::~DUPLICATIONMANAGER() { + if (m_DeskDupl) { + m_DeskDupl->Release(); + m_DeskDupl = nullptr; + } + + if (m_AcquiredDesktopImage) { + m_AcquiredDesktopImage->Release(); + m_AcquiredDesktopImage = nullptr; + } + + if (m_MetaDataBuffer) { + delete[] m_MetaDataBuffer; + m_MetaDataBuffer = nullptr; + } + + if (m_Device) { + m_Device->Release(); + m_Device = nullptr; + } +} + +// +// Initialize duplication interfaces +// +DUPL_RETURN DUPLICATIONMANAGER::InitDupl(_In_ ID3D11Device* Device, UINT Output) { + m_OutputNumber = Output; + + // Take a reference on the device + m_Device = Device; + m_Device->AddRef(); + + // Get DXGI device + IDXGIDevice* DxgiDevice = nullptr; + HRESULT hr = m_Device->QueryInterface(__uuidof(IDXGIDevice), reinterpret_cast(&DxgiDevice)); + if (FAILED(hr)) { + return ProcessFailure(nullptr, L"Failed to QI for DXGI Device", L"Error", hr); + } + + // Get DXGI adapter + IDXGIAdapter* DxgiAdapter = nullptr; + hr = DxgiDevice->GetParent(__uuidof(IDXGIAdapter), reinterpret_cast(&DxgiAdapter)); + DxgiDevice->Release(); + DxgiDevice = nullptr; + if (FAILED(hr)) { + return ProcessFailure(m_Device, L"Failed to get parent DXGI Adapter", L"Error", hr, + SystemTransitionsExpectedErrors); + } + + // Get output + IDXGIOutput* DxgiOutput = nullptr; + hr = DxgiAdapter->EnumOutputs(Output, &DxgiOutput); + DxgiAdapter->Release(); + DxgiAdapter = nullptr; + if (FAILED(hr)) { + return ProcessFailure(m_Device, L"Failed to get specified output in DUPLICATIONMANAGER", L"Error", hr, + EnumOutputsExpectedErrors); + } + + DxgiOutput->GetDesc(&m_OutputDesc); + + // QI for Output 1 + IDXGIOutput1* DxgiOutput1 = nullptr; + hr = DxgiOutput->QueryInterface(__uuidof(DxgiOutput1), reinterpret_cast(&DxgiOutput1)); + DxgiOutput->Release(); + DxgiOutput = nullptr; + if (FAILED(hr)) { + return ProcessFailure(nullptr, L"Failed to QI for DxgiOutput1 in DUPLICATIONMANAGER", L"Error", hr); + } + + // Create desktop duplication + hr = DxgiOutput1->DuplicateOutput(m_Device, &m_DeskDupl); + DxgiOutput1->Release(); + DxgiOutput1 = nullptr; + if (FAILED(hr)) { + if (hr == DXGI_ERROR_NOT_CURRENTLY_AVAILABLE) { + MessageBoxW( + nullptr, + L"There is already the maximum number of applications using the Desktop Duplication API running, please close one of those applications and then try again.", + L"Error", MB_OK); + return DUPL_RETURN_ERROR_UNEXPECTED; + } + return ProcessFailure(m_Device, L"Failed to get duplicate output in DUPLICATIONMANAGER", L"Error", hr, + CreateDuplicationExpectedErrors); + } + + return DUPL_RETURN_SUCCESS; +} + +// +// Retrieves mouse info and write it into PtrInfo +// +DUPL_RETURN DUPLICATIONMANAGER::GetMouse(_Inout_ PTR_INFO* PtrInfo, _In_ DXGI_OUTDUPL_FRAME_INFO* FrameInfo, + INT OffsetX, INT OffsetY) { + // A non-zero mouse update timestamp indicates that there is a mouse position update and optionally a shape change + if (FrameInfo->LastMouseUpdateTime.QuadPart == 0) { + return DUPL_RETURN_SUCCESS; + } + + bool UpdatePosition = true; + + // Make sure we don't update pointer position wrongly + // If pointer is invisible, make sure we did not get an update from another output that the last time that said pointer + // was visible, if so, don't set it to invisible or update. + if (!FrameInfo->PointerPosition.Visible && (PtrInfo->WhoUpdatedPositionLast != m_OutputNumber)) { + UpdatePosition = false; + } + + // If two outputs both say they have a visible, only update if new update has newer timestamp + if (FrameInfo->PointerPosition.Visible && PtrInfo->Visible && (PtrInfo->WhoUpdatedPositionLast != m_OutputNumber) && + (PtrInfo->LastTimeStamp.QuadPart > FrameInfo->LastMouseUpdateTime.QuadPart)) { + UpdatePosition = false; + } + + // Update position + if (UpdatePosition) { + PtrInfo->Position.x = FrameInfo->PointerPosition.Position.x + m_OutputDesc.DesktopCoordinates.left - OffsetX; + PtrInfo->Position.y = FrameInfo->PointerPosition.Position.y + m_OutputDesc.DesktopCoordinates.top - OffsetY; + PtrInfo->WhoUpdatedPositionLast = m_OutputNumber; + PtrInfo->LastTimeStamp = FrameInfo->LastMouseUpdateTime; + PtrInfo->Visible = FrameInfo->PointerPosition.Visible != 0; + } + + // No new shape + if (FrameInfo->PointerShapeBufferSize == 0) { + return DUPL_RETURN_SUCCESS; + } + + // Old buffer too small + if (FrameInfo->PointerShapeBufferSize > PtrInfo->BufferSize) { + if (PtrInfo->PtrShapeBuffer) { + delete[] PtrInfo->PtrShapeBuffer; + PtrInfo->PtrShapeBuffer = nullptr; + } + PtrInfo->PtrShapeBuffer = new(std::nothrow) BYTE[FrameInfo->PointerShapeBufferSize]; + if (!PtrInfo->PtrShapeBuffer) { + PtrInfo->BufferSize = 0; + return ProcessFailure(nullptr, L"Failed to allocate memory for pointer shape in DUPLICATIONMANAGER", + L"Error", E_OUTOFMEMORY); + } + + // Update buffer size + PtrInfo->BufferSize = FrameInfo->PointerShapeBufferSize; + } + + // Get shape + UINT BufferSizeRequired; + HRESULT hr = m_DeskDupl->GetFramePointerShape(FrameInfo->PointerShapeBufferSize, + reinterpret_cast(PtrInfo->PtrShapeBuffer), &BufferSizeRequired, + &(PtrInfo->ShapeInfo)); + if (FAILED(hr)) { + delete[] PtrInfo->PtrShapeBuffer; + PtrInfo->PtrShapeBuffer = nullptr; + PtrInfo->BufferSize = 0; + return ProcessFailure(m_Device, L"Failed to get frame pointer shape in DUPLICATIONMANAGER", L"Error", hr, + FrameInfoExpectedErrors); + } + + return DUPL_RETURN_SUCCESS; +} + +int bmp_write(unsigned char* image, int imageWidth, int imageHeight, char* filename) { + unsigned char header[54] = { + 0x42, 0x4d, 0, 0, 0, 0, 0, 0, 0, 0, + 54, 0, 0, 0, 40, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 32, 0, + 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0 + }; + + long file_size = (long)imageWidth * (long)imageHeight * 4 + 54; + header[2] = (unsigned char)(file_size & 0x000000ff); + header[3] = (file_size >> 8) & 0x000000ff; + header[4] = (file_size >> 16) & 0x000000ff; + header[5] = (file_size >> 24) & 0x000000ff; + + long width = imageWidth; + header[18] = width & 0x000000ff; + header[19] = (width >> 8) & 0x000000ff; + header[20] = (width >> 16) & 0x000000ff; + header[21] = (width >> 24) & 0x000000ff; + + long height = imageHeight; + header[22] = height & 0x000000ff; + header[23] = (height >> 8) & 0x000000ff; + header[24] = (height >> 16) & 0x000000ff; + header[25] = (height >> 24) & 0x000000ff; + + char fname_bmp[128]; + sprintf(fname_bmp, "%s", filename); + + FILE* fp; + if (!(fp = fopen(fname_bmp, "wb"))) + return -1; + + fwrite(header, sizeof(unsigned char), 54, fp); + fwrite(image, sizeof(unsigned char), (size_t)(long)imageWidth * imageHeight * 4, fp); + + fclose(fp); + return 0; +} + +ffvideo* play = nullptr; +int pts = 0; +FILE* ff; + +void output(ffvideo* ctx) { + if (ff == nullptr) { + ff = fopen("a.h264", "wb"); //sps pps + fwrite(ctx->encoder_ctx->extradata, sizeof(uint8_t), ctx->encoder_ctx->extradata_size, ff); + } + + fwrite(ctx->dst_packet->data, sizeof(uint8_t), ctx->dst_packet->size, ff); + + std::cout << "ENCODE_SUCCESS: size = " << ctx->dst_packet->size << std::endl; +} + +void extract_pixel(ID3D11Device* m_Device, ID3D11Texture2D* m_AcquiredDesktopImage) { + + if (pts > 500) return; + if (pts == 500) { + fclose(ff); + exit(0); + } + + ID3D11DeviceContext* ctx; + m_Device->GetImmediateContext(&ctx); + + ID3D11Texture2D* copy_tex = nullptr; + + D3D11_TEXTURE2D_DESC desc; + m_AcquiredDesktopImage->GetDesc(&desc); + desc.MipLevels = 1; + desc.ArraySize = 1; + desc.Format = DXGI_FORMAT_B8G8R8A8_UNORM; + desc.Usage = D3D11_USAGE_STAGING; + desc.SampleDesc.Count = 1; + desc.SampleDesc.Quality = 0; + desc.BindFlags = 0; + desc.MiscFlags = 0; + desc.CPUAccessFlags = D3D11_CPU_ACCESS_READ; + int hr = m_Device->CreateTexture2D(&desc, nullptr, ©_tex); + if (FAILED(hr) || copy_tex == nullptr) { + return; + } + ctx->CopyResource(copy_tex, m_AcquiredDesktopImage); + + + D3D11_MAPPED_SUBRESOURCE resource; + ctx->Map(copy_tex, 0, D3D11_MAP_READ, 0, &resource); + + if (!pts) { + play = new ffvideo(); + play->info = { + 1920, 1080, AV_PIX_FMT_BGRA, + 1920 / 2, 1080 / 2, AV_PIX_FMT_YUV420P, + 30, 2 * 1024 * 1024, 30 + }; + play->initSws(); + play->initH264(); + } + + play->src_buffer = (uint8_t*)resource.pData; + for (int i = 0; i < 4; i++) + play->line_size[i] = resource.RowPitch; + play->process_data(pts, pts, output); + + ctx->Unmap(copy_tex, 0); + pts++; +} + +// +// Get next frame and write it into Data +// +_Success_(*Timeout == false && return == DUPL_RETURN_SUCCESS) + +DUPL_RETURN DUPLICATIONMANAGER::GetFrame(_Out_ FRAME_DATA* Data, _Out_ bool* Timeout) { + IDXGIResource* DesktopResource = nullptr; + DXGI_OUTDUPL_FRAME_INFO FrameInfo; + + // Get new frame + HRESULT hr = m_DeskDupl->AcquireNextFrame(500, &FrameInfo, &DesktopResource); + if (hr == DXGI_ERROR_WAIT_TIMEOUT) { + *Timeout = true; + return DUPL_RETURN_SUCCESS; + } + *Timeout = false; + + + if (FAILED(hr)) { + return ProcessFailure(m_Device, L"Failed to acquire next frame in DUPLICATIONMANAGER", L"Error", hr, + FrameInfoExpectedErrors); + } + + // If still holding old frame, destroy it + if (m_AcquiredDesktopImage) { + m_AcquiredDesktopImage->Release(); + m_AcquiredDesktopImage = nullptr; + } + + // QI for IDXGIResource + hr = DesktopResource->QueryInterface(__uuidof(ID3D11Texture2D), reinterpret_cast(&m_AcquiredDesktopImage)); + DesktopResource->Release(); + DesktopResource = nullptr; + if (FAILED(hr)) { + return ProcessFailure( + nullptr, L"Failed to QI for ID3D11Texture2D from acquired IDXGIResource in DUPLICATIONMANAGER", L"Error", + hr); + } + + static int tx = 0; + if (tx == 100) { } + extract_pixel(m_Device, m_AcquiredDesktopImage); + tx++; + + // Get metadata + if (FrameInfo.TotalMetadataBufferSize) { + // Old buffer too small + if (FrameInfo.TotalMetadataBufferSize > m_MetaDataSize) { + if (m_MetaDataBuffer) { + delete[] m_MetaDataBuffer; + m_MetaDataBuffer = nullptr; + } + m_MetaDataBuffer = new(std::nothrow) BYTE[FrameInfo.TotalMetadataBufferSize]; + if (!m_MetaDataBuffer) { + m_MetaDataSize = 0; + Data->MoveCount = 0; + Data->DirtyCount = 0; + return ProcessFailure(nullptr, L"Failed to allocate memory for metadata in DUPLICATIONMANAGER", + L"Error", E_OUTOFMEMORY); + } + m_MetaDataSize = FrameInfo.TotalMetadataBufferSize; + } + + UINT BufSize = FrameInfo.TotalMetadataBufferSize; + + // Get move rectangles + hr = m_DeskDupl->GetFrameMoveRects(BufSize, reinterpret_cast(m_MetaDataBuffer), + &BufSize); + if (FAILED(hr)) { + Data->MoveCount = 0; + Data->DirtyCount = 0; + return ProcessFailure(nullptr, L"Failed to get frame move rects in DUPLICATIONMANAGER", L"Error", hr, + FrameInfoExpectedErrors); + } + Data->MoveCount = BufSize / sizeof(DXGI_OUTDUPL_MOVE_RECT); + + BYTE* DirtyRects = m_MetaDataBuffer + BufSize; + BufSize = FrameInfo.TotalMetadataBufferSize - BufSize; + + // Get dirty rectangles + hr = m_DeskDupl->GetFrameDirtyRects(BufSize, reinterpret_cast(DirtyRects), &BufSize); + if (FAILED(hr)) { + Data->MoveCount = 0; + Data->DirtyCount = 0; + return ProcessFailure(nullptr, L"Failed to get frame dirty rects in DUPLICATIONMANAGER", L"Error", hr, + FrameInfoExpectedErrors); + } + Data->DirtyCount = BufSize / sizeof(RECT); + + Data->MetaData = m_MetaDataBuffer; + } + + Data->Frame = m_AcquiredDesktopImage; + Data->FrameInfo = FrameInfo; + + return DUPL_RETURN_SUCCESS; +} + +// +// Release frame +// +DUPL_RETURN DUPLICATIONMANAGER::DoneWithFrame() { + HRESULT hr = m_DeskDupl->ReleaseFrame(); + if (FAILED(hr)) { + return ProcessFailure(m_Device, L"Failed to release frame in DUPLICATIONMANAGER", L"Error", hr, + FrameInfoExpectedErrors); + } + + if (m_AcquiredDesktopImage) { + m_AcquiredDesktopImage->Release(); + m_AcquiredDesktopImage = nullptr; + } + + return DUPL_RETURN_SUCCESS; +} + +// +// Gets output desc into DescPtr +// +void DUPLICATIONMANAGER::GetOutputDesc(_Out_ DXGI_OUTPUT_DESC* DescPtr) { + *DescPtr = m_OutputDesc; +} diff --git a/DuplicationManager.h b/DuplicationManager.h new file mode 100644 index 0000000..f3f39c4 --- /dev/null +++ b/DuplicationManager.h @@ -0,0 +1,40 @@ +// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF +// ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO +// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A +// PARTICULAR PURPOSE. +// +// Copyright (c) Microsoft Corporation. All rights reserved + +#ifndef _DUPLICATIONMANAGER_H_ +#define _DUPLICATIONMANAGER_H_ + +#include "CommonTypes.h" +#include "ffvideo.h" + +// +// Handles the task of duplicating an output. +// +class DUPLICATIONMANAGER +{ + public: + DUPLICATIONMANAGER(); + ~DUPLICATIONMANAGER(); + _Success_(*Timeout == false && return == DUPL_RETURN_SUCCESS) DUPL_RETURN GetFrame(_Out_ FRAME_DATA* Data, _Out_ bool* Timeout); + DUPL_RETURN DoneWithFrame(); + DUPL_RETURN InitDupl(_In_ ID3D11Device* Device, UINT Output); + DUPL_RETURN GetMouse(_Inout_ PTR_INFO* PtrInfo, _In_ DXGI_OUTDUPL_FRAME_INFO* FrameInfo, INT OffsetX, INT OffsetY); + void GetOutputDesc(_Out_ DXGI_OUTPUT_DESC* DescPtr); + + //private: + + // vars + IDXGIOutputDuplication* m_DeskDupl; + ID3D11Texture2D* m_AcquiredDesktopImage; + _Field_size_bytes_(m_MetaDataSize) BYTE* m_MetaDataBuffer; + UINT m_MetaDataSize; + UINT m_OutputNumber; + DXGI_OUTPUT_DESC m_OutputDesc; + ID3D11Device* m_Device; +}; + +#endif diff --git a/OutputManager.cpp b/OutputManager.cpp new file mode 100644 index 0000000..fd2e781 --- /dev/null +++ b/OutputManager.cpp @@ -0,0 +1,1103 @@ +// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF +// ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO +// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A +// PARTICULAR PURPOSE. +// +// Copyright (c) Microsoft Corporation. All rights reserved + +#include "OutputManager.h" +using namespace DirectX; + +// +// Constructor NULLs out all pointers & sets appropriate var vals +// +OUTPUTMANAGER::OUTPUTMANAGER() : m_SwapChain(nullptr), + m_Device(nullptr), + m_Factory(nullptr), + m_DeviceContext(nullptr), + m_RTV(nullptr), + m_SamplerLinear(nullptr), + m_BlendState(nullptr), + m_VertexShader(nullptr), + m_PixelShader(nullptr), + m_InputLayout(nullptr), + m_SharedSurf(nullptr), + m_KeyMutex(nullptr), + m_WindowHandle(nullptr), + m_NeedsResize(false), + m_OcclusionCookie(0) +{ +} + +// +// Destructor which calls CleanRefs to release all references and memory. +// +OUTPUTMANAGER::~OUTPUTMANAGER() +{ + CleanRefs(); +} + +// +// Indicates that window has been resized. +// +void OUTPUTMANAGER::WindowResize() +{ + m_NeedsResize = true; +} + +// +// Initialize all state +// +DUPL_RETURN OUTPUTMANAGER::InitOutput(HWND Window, INT SingleOutput, _Out_ UINT* OutCount, _Out_ RECT* DeskBounds) +{ + HRESULT hr; + + // Store window handle + m_WindowHandle = Window; + + // Driver types supported + D3D_DRIVER_TYPE DriverTypes[] = + { + D3D_DRIVER_TYPE_HARDWARE, + D3D_DRIVER_TYPE_WARP, + D3D_DRIVER_TYPE_REFERENCE, + }; + UINT NumDriverTypes = ARRAYSIZE(DriverTypes); + + // Feature levels supported + D3D_FEATURE_LEVEL FeatureLevels[] = + { + D3D_FEATURE_LEVEL_11_0, + D3D_FEATURE_LEVEL_10_1, + D3D_FEATURE_LEVEL_10_0, + D3D_FEATURE_LEVEL_9_1 + }; + UINT NumFeatureLevels = ARRAYSIZE(FeatureLevels); + D3D_FEATURE_LEVEL FeatureLevel; + + // Create device + for (UINT DriverTypeIndex = 0; DriverTypeIndex < NumDriverTypes; ++DriverTypeIndex) + { + hr = D3D11CreateDevice(nullptr, DriverTypes[DriverTypeIndex], nullptr, 0, FeatureLevels, NumFeatureLevels, + D3D11_SDK_VERSION, &m_Device, &FeatureLevel, &m_DeviceContext); + if (SUCCEEDED(hr)) + { + // Device creation succeeded, no need to loop anymore + break; + } + } + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Device creation in OUTPUTMANAGER failed", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Get DXGI factory + IDXGIDevice* DxgiDevice = nullptr; + hr = m_Device->QueryInterface(__uuidof(IDXGIDevice), reinterpret_cast(&DxgiDevice)); + if (FAILED(hr)) + { + return ProcessFailure(nullptr, L"Failed to QI for DXGI Device", L"Error", hr, nullptr); + } + + IDXGIAdapter* DxgiAdapter = nullptr; + hr = DxgiDevice->GetParent(__uuidof(IDXGIAdapter), reinterpret_cast(&DxgiAdapter)); + DxgiDevice->Release(); + DxgiDevice = nullptr; + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to get parent DXGI Adapter", L"Error", hr, SystemTransitionsExpectedErrors); + } + + hr = DxgiAdapter->GetParent(__uuidof(IDXGIFactory2), reinterpret_cast(&m_Factory)); + DxgiAdapter->Release(); + DxgiAdapter = nullptr; + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to get parent DXGI Factory", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Register for occlusion status windows message + hr = m_Factory->RegisterOcclusionStatusWindow(Window, OCCLUSION_STATUS_MSG, &m_OcclusionCookie); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to register for occlusion message", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Get window size + RECT WindowRect; + GetClientRect(m_WindowHandle, &WindowRect); + UINT Width = WindowRect.right - WindowRect.left; + UINT Height = WindowRect.bottom - WindowRect.top; + + // Create swapchain for window + DXGI_SWAP_CHAIN_DESC1 SwapChainDesc; + RtlZeroMemory(&SwapChainDesc, sizeof(SwapChainDesc)); + + SwapChainDesc.SwapEffect = DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL; + SwapChainDesc.BufferCount = 2; + SwapChainDesc.Width = Width; + SwapChainDesc.Height = Height; + SwapChainDesc.Format = DXGI_FORMAT_B8G8R8A8_UNORM; + SwapChainDesc.BufferUsage = DXGI_USAGE_RENDER_TARGET_OUTPUT; + SwapChainDesc.SampleDesc.Count = 1; + SwapChainDesc.SampleDesc.Quality = 0; + hr = m_Factory->CreateSwapChainForHwnd(m_Device, Window, &SwapChainDesc, nullptr, nullptr, &m_SwapChain); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to create window swapchain", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Disable the ALT-ENTER shortcut for entering full-screen mode + hr = m_Factory->MakeWindowAssociation(Window, DXGI_MWA_NO_ALT_ENTER); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to make window association", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Create shared texture + DUPL_RETURN Return = CreateSharedSurf(SingleOutput, OutCount, DeskBounds); + if (Return != DUPL_RETURN_SUCCESS) + { + return Return; + } + + // Make new render target view + Return = MakeRTV(); + if (Return != DUPL_RETURN_SUCCESS) + { + return Return; + } + + // Set view port + SetViewPort(Width, Height); + + // Create the sample state + D3D11_SAMPLER_DESC SampDesc; + RtlZeroMemory(&SampDesc, sizeof(SampDesc)); + SampDesc.Filter = D3D11_FILTER_MIN_MAG_MIP_LINEAR; + SampDesc.AddressU = D3D11_TEXTURE_ADDRESS_CLAMP; + SampDesc.AddressV = D3D11_TEXTURE_ADDRESS_CLAMP; + SampDesc.AddressW = D3D11_TEXTURE_ADDRESS_CLAMP; + SampDesc.ComparisonFunc = D3D11_COMPARISON_NEVER; + SampDesc.MinLOD = 0; + SampDesc.MaxLOD = D3D11_FLOAT32_MAX; + hr = m_Device->CreateSamplerState(&SampDesc, &m_SamplerLinear); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to create sampler state in OUTPUTMANAGER", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Create the blend state + D3D11_BLEND_DESC BlendStateDesc; + BlendStateDesc.AlphaToCoverageEnable = FALSE; + BlendStateDesc.IndependentBlendEnable = FALSE; + BlendStateDesc.RenderTarget[0].BlendEnable = TRUE; + BlendStateDesc.RenderTarget[0].SrcBlend = D3D11_BLEND_SRC_ALPHA; + BlendStateDesc.RenderTarget[0].DestBlend = D3D11_BLEND_INV_SRC_ALPHA; + BlendStateDesc.RenderTarget[0].BlendOp = D3D11_BLEND_OP_ADD; + BlendStateDesc.RenderTarget[0].SrcBlendAlpha = D3D11_BLEND_ONE; + BlendStateDesc.RenderTarget[0].DestBlendAlpha = D3D11_BLEND_ZERO; + BlendStateDesc.RenderTarget[0].BlendOpAlpha = D3D11_BLEND_OP_ADD; + BlendStateDesc.RenderTarget[0].RenderTargetWriteMask = D3D11_COLOR_WRITE_ENABLE_ALL; + hr = m_Device->CreateBlendState(&BlendStateDesc, &m_BlendState); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to create blend state in OUTPUTMANAGER", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Initialize shaders + Return = InitShaders(); + if (Return != DUPL_RETURN_SUCCESS) + { + return Return; + } + + GetWindowRect(m_WindowHandle, &WindowRect); + MoveWindow(m_WindowHandle, WindowRect.left, WindowRect.top, (DeskBounds->right - DeskBounds->left) / 2, (DeskBounds->bottom - DeskBounds->top) / 2, TRUE); + + return Return; +} + +// +// Recreate shared texture +// +DUPL_RETURN OUTPUTMANAGER::CreateSharedSurf(INT SingleOutput, _Out_ UINT* OutCount, _Out_ RECT* DeskBounds) +{ + HRESULT hr; + + // Get DXGI resources + IDXGIDevice* DxgiDevice = nullptr; + hr = m_Device->QueryInterface(__uuidof(IDXGIDevice), reinterpret_cast(&DxgiDevice)); + if (FAILED(hr)) + { + return ProcessFailure(nullptr, L"Failed to QI for DXGI Device", L"Error", hr); + } + + IDXGIAdapter* DxgiAdapter = nullptr; + hr = DxgiDevice->GetParent(__uuidof(IDXGIAdapter), reinterpret_cast(&DxgiAdapter)); + DxgiDevice->Release(); + DxgiDevice = nullptr; + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to get parent DXGI Adapter", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Set initial values so that we always catch the right coordinates + DeskBounds->left = INT_MAX; + DeskBounds->right = INT_MIN; + DeskBounds->top = INT_MAX; + DeskBounds->bottom = INT_MIN; + + IDXGIOutput* DxgiOutput = nullptr; + + // Figure out right dimensions for full size desktop texture and # of outputs to duplicate + UINT OutputCount; + if (SingleOutput < 0) + { + hr = S_OK; + for (OutputCount = 0; SUCCEEDED(hr); ++OutputCount) + { + if (DxgiOutput) + { + DxgiOutput->Release(); + DxgiOutput = nullptr; + } + hr = DxgiAdapter->EnumOutputs(OutputCount, &DxgiOutput); + if (DxgiOutput && (hr != DXGI_ERROR_NOT_FOUND)) + { + DXGI_OUTPUT_DESC DesktopDesc; + DxgiOutput->GetDesc(&DesktopDesc); + + DeskBounds->left = min(DesktopDesc.DesktopCoordinates.left, DeskBounds->left); + DeskBounds->top = min(DesktopDesc.DesktopCoordinates.top, DeskBounds->top); + DeskBounds->right = max(DesktopDesc.DesktopCoordinates.right, DeskBounds->right); + DeskBounds->bottom = max(DesktopDesc.DesktopCoordinates.bottom, DeskBounds->bottom); + } + } + + --OutputCount; + } + else + { + hr = DxgiAdapter->EnumOutputs(SingleOutput, &DxgiOutput); + if (FAILED(hr)) + { + DxgiAdapter->Release(); + DxgiAdapter = nullptr; + return ProcessFailure(m_Device, L"Output specified to be duplicated does not exist", L"Error", hr); + } + DXGI_OUTPUT_DESC DesktopDesc; + DxgiOutput->GetDesc(&DesktopDesc); + *DeskBounds = DesktopDesc.DesktopCoordinates; + + DxgiOutput->Release(); + DxgiOutput = nullptr; + + OutputCount = 1; + } + + DxgiAdapter->Release(); + DxgiAdapter = nullptr; + + // Set passed in output count variable + *OutCount = OutputCount; + + if (OutputCount == 0) + { + // We could not find any outputs, the system must be in a transition so return expected error + // so we will attempt to recreate + return DUPL_RETURN_ERROR_EXPECTED; + } + + // Create shared texture for all duplication threads to draw into + D3D11_TEXTURE2D_DESC DeskTexD; + RtlZeroMemory(&DeskTexD, sizeof(D3D11_TEXTURE2D_DESC)); + DeskTexD.Width = DeskBounds->right - DeskBounds->left; + DeskTexD.Height = DeskBounds->bottom - DeskBounds->top; + DeskTexD.MipLevels = 1; + DeskTexD.ArraySize = 1; + DeskTexD.Format = DXGI_FORMAT_B8G8R8A8_UNORM; + DeskTexD.SampleDesc.Count = 1; + DeskTexD.Usage = D3D11_USAGE_DEFAULT; + DeskTexD.BindFlags = D3D11_BIND_RENDER_TARGET | D3D11_BIND_SHADER_RESOURCE; + DeskTexD.CPUAccessFlags = 0; + DeskTexD.MiscFlags = D3D11_RESOURCE_MISC_SHARED_KEYEDMUTEX; + + hr = m_Device->CreateTexture2D(&DeskTexD, nullptr, &m_SharedSurf); + if (FAILED(hr)) + { + if (OutputCount != 1) + { + // If we are duplicating the complete desktop we try to create a single texture to hold the + // complete desktop image and blit updates from the per output DDA interface. The GPU can + // always support a texture size of the maximum resolution of any single output but there is no + // guarantee that it can support a texture size of the desktop. + // The sample only use this large texture to display the desktop image in a single window using DX + // we could revert back to using GDI to update the window in this failure case. + return ProcessFailure(m_Device, L"Failed to create DirectX shared texture - we are attempting to create a texture the size of the complete desktop and this may be larger than the maximum texture size of your GPU. Please try again using the -output command line parameter to duplicate only 1 monitor or configure your computer to a single monitor configuration", L"Error", hr, SystemTransitionsExpectedErrors); + } + else + { + return ProcessFailure(m_Device, L"Failed to create shared texture", L"Error", hr, SystemTransitionsExpectedErrors); + } + } + + // Get keyed mutex + hr = m_SharedSurf->QueryInterface(__uuidof(IDXGIKeyedMutex), reinterpret_cast(&m_KeyMutex)); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to query for keyed mutex in OUTPUTMANAGER", L"Error", hr); + } + + return DUPL_RETURN_SUCCESS; +} + +// +// Present to the application window +// +DUPL_RETURN OUTPUTMANAGER::UpdateApplicationWindow(_In_ PTR_INFO* PointerInfo, _Inout_ bool* Occluded) +{ + // In a typical desktop duplication application there would be an application running on one system collecting the desktop images + // and another application running on a different system that receives the desktop images via a network and display the image. This + // sample contains both these aspects into a single application. + // This routine is the part of the sample that displays the desktop image onto the display + + // Try and acquire sync on common display buffer + HRESULT hr = m_KeyMutex->AcquireSync(1, 100); + if (hr == static_cast(WAIT_TIMEOUT)) + { + // Another thread has the keyed mutex so try again later + return DUPL_RETURN_SUCCESS; + } + else if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to acquire Keyed mutex in OUTPUTMANAGER", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Got mutex, so draw + DUPL_RETURN Ret = DrawFrame(); + if (Ret == DUPL_RETURN_SUCCESS) + { + // We have keyed mutex so we can access the mouse info + if (PointerInfo->Visible) + { + // Draw mouse into texture + Ret = DrawMouse(PointerInfo); + } + } + + // Release keyed mutex + hr = m_KeyMutex->ReleaseSync(0); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to Release Keyed mutex in OUTPUTMANAGER", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Present to window if all worked + if (Ret == DUPL_RETURN_SUCCESS) + { + // Present to window + hr = m_SwapChain->Present(1, 0); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to present", L"Error", hr, SystemTransitionsExpectedErrors); + } + else if (hr == DXGI_STATUS_OCCLUDED) + { + *Occluded = true; + } + } + + return Ret; +} + +// +// Returns shared handle +// +HANDLE OUTPUTMANAGER::GetSharedHandle() +{ + HANDLE Hnd = nullptr; + + // QI IDXGIResource interface to synchronized shared surface. + IDXGIResource* DXGIResource = nullptr; + HRESULT hr = m_SharedSurf->QueryInterface(__uuidof(IDXGIResource), reinterpret_cast(&DXGIResource)); + if (SUCCEEDED(hr)) + { + // Obtain handle to IDXGIResource object. + DXGIResource->GetSharedHandle(&Hnd); + DXGIResource->Release(); + DXGIResource = nullptr; + } + + return Hnd; +} + +// +// Draw frame into backbuffer +// +DUPL_RETURN OUTPUTMANAGER::DrawFrame() +{ + HRESULT hr; + + // If window was resized, resize swapchain + if (m_NeedsResize) + { + DUPL_RETURN Ret = ResizeSwapChain(); + if (Ret != DUPL_RETURN_SUCCESS) + { + return Ret; + } + m_NeedsResize = false; + } + + // Vertices for drawing whole texture + VERTEX Vertices[NUMVERTICES] = + { + {XMFLOAT3(-1.0f, -1.0f, 0), XMFLOAT2(0.0f, 1.0f)}, + {XMFLOAT3(-1.0f, 1.0f, 0), XMFLOAT2(0.0f, 0.0f)}, + {XMFLOAT3(1.0f, -1.0f, 0), XMFLOAT2(1.0f, 1.0f)}, + {XMFLOAT3(1.0f, -1.0f, 0), XMFLOAT2(1.0f, 1.0f)}, + {XMFLOAT3(-1.0f, 1.0f, 0), XMFLOAT2(0.0f, 0.0f)}, + {XMFLOAT3(1.0f, 1.0f, 0), XMFLOAT2(1.0f, 0.0f)}, + }; + + D3D11_TEXTURE2D_DESC FrameDesc; + m_SharedSurf->GetDesc(&FrameDesc); + + D3D11_SHADER_RESOURCE_VIEW_DESC ShaderDesc; + ShaderDesc.Format = FrameDesc.Format; + ShaderDesc.ViewDimension = D3D11_SRV_DIMENSION_TEXTURE2D; + ShaderDesc.Texture2D.MostDetailedMip = FrameDesc.MipLevels - 1; + ShaderDesc.Texture2D.MipLevels = FrameDesc.MipLevels; + + // Create new shader resource view + ID3D11ShaderResourceView* ShaderResource = nullptr; + hr = m_Device->CreateShaderResourceView(m_SharedSurf, &ShaderDesc, &ShaderResource); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to create shader resource when drawing a frame", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Set resources + UINT Stride = sizeof(VERTEX); + UINT Offset = 0; + FLOAT blendFactor[4] = {0.f, 0.f, 0.f, 0.f}; + m_DeviceContext->OMSetBlendState(nullptr, blendFactor, 0xffffffff); + m_DeviceContext->OMSetRenderTargets(1, &m_RTV, nullptr); + m_DeviceContext->VSSetShader(m_VertexShader, nullptr, 0); + m_DeviceContext->PSSetShader(m_PixelShader, nullptr, 0); + m_DeviceContext->PSSetShaderResources(0, 1, &ShaderResource); + m_DeviceContext->PSSetSamplers(0, 1, &m_SamplerLinear); + m_DeviceContext->IASetPrimitiveTopology(D3D11_PRIMITIVE_TOPOLOGY_TRIANGLELIST); + + D3D11_BUFFER_DESC BufferDesc; + RtlZeroMemory(&BufferDesc, sizeof(BufferDesc)); + BufferDesc.Usage = D3D11_USAGE_DEFAULT; + BufferDesc.ByteWidth = sizeof(VERTEX) * NUMVERTICES; + BufferDesc.BindFlags = D3D11_BIND_VERTEX_BUFFER; + BufferDesc.CPUAccessFlags = 0; + D3D11_SUBRESOURCE_DATA InitData; + RtlZeroMemory(&InitData, sizeof(InitData)); + InitData.pSysMem = Vertices; + + ID3D11Buffer* VertexBuffer = nullptr; + + // Create vertex buffer + hr = m_Device->CreateBuffer(&BufferDesc, &InitData, &VertexBuffer); + if (FAILED(hr)) + { + ShaderResource->Release(); + ShaderResource = nullptr; + return ProcessFailure(m_Device, L"Failed to create vertex buffer when drawing a frame", L"Error", hr, SystemTransitionsExpectedErrors); + } + m_DeviceContext->IASetVertexBuffers(0, 1, &VertexBuffer, &Stride, &Offset); + + // Draw textured quad onto render target + m_DeviceContext->Draw(NUMVERTICES, 0); + + VertexBuffer->Release(); + VertexBuffer = nullptr; + + // Release shader resource + ShaderResource->Release(); + ShaderResource = nullptr; + + return DUPL_RETURN_SUCCESS; +} + +// +// Process both masked and monochrome pointers +// +DUPL_RETURN OUTPUTMANAGER::ProcessMonoMask(bool IsMono, _Inout_ PTR_INFO* PtrInfo, _Out_ INT* PtrWidth, _Out_ INT* PtrHeight, _Out_ INT* PtrLeft, _Out_ INT* PtrTop, _Outptr_result_bytebuffer_(*PtrHeight * *PtrWidth * BPP) BYTE** InitBuffer, _Out_ D3D11_BOX* Box) +{ + // Desktop dimensions + D3D11_TEXTURE2D_DESC FullDesc; + m_SharedSurf->GetDesc(&FullDesc); + INT DesktopWidth = FullDesc.Width; + INT DesktopHeight = FullDesc.Height; + + // Pointer position + INT GivenLeft = PtrInfo->Position.x; + INT GivenTop = PtrInfo->Position.y; + + // Figure out if any adjustment is needed for out of bound positions + if (GivenLeft < 0) + { + *PtrWidth = GivenLeft + static_cast(PtrInfo->ShapeInfo.Width); + } + else if ((GivenLeft + static_cast(PtrInfo->ShapeInfo.Width)) > DesktopWidth) + { + *PtrWidth = DesktopWidth - GivenLeft; + } + else + { + *PtrWidth = static_cast(PtrInfo->ShapeInfo.Width); + } + + if (IsMono) + { + PtrInfo->ShapeInfo.Height = PtrInfo->ShapeInfo.Height / 2; + } + + if (GivenTop < 0) + { + *PtrHeight = GivenTop + static_cast(PtrInfo->ShapeInfo.Height); + } + else if ((GivenTop + static_cast(PtrInfo->ShapeInfo.Height)) > DesktopHeight) + { + *PtrHeight = DesktopHeight - GivenTop; + } + else + { + *PtrHeight = static_cast(PtrInfo->ShapeInfo.Height); + } + + if (IsMono) + { + PtrInfo->ShapeInfo.Height = PtrInfo->ShapeInfo.Height * 2; + } + + *PtrLeft = (GivenLeft < 0) ? 0 : GivenLeft; + *PtrTop = (GivenTop < 0) ? 0 : GivenTop; + + // Staging buffer/texture + D3D11_TEXTURE2D_DESC CopyBufferDesc; + CopyBufferDesc.Width = *PtrWidth; + CopyBufferDesc.Height = *PtrHeight; + CopyBufferDesc.MipLevels = 1; + CopyBufferDesc.ArraySize = 1; + CopyBufferDesc.Format = DXGI_FORMAT_B8G8R8A8_UNORM; + CopyBufferDesc.SampleDesc.Count = 1; + CopyBufferDesc.SampleDesc.Quality = 0; + CopyBufferDesc.Usage = D3D11_USAGE_STAGING; + CopyBufferDesc.BindFlags = 0; + CopyBufferDesc.CPUAccessFlags = D3D11_CPU_ACCESS_READ; + CopyBufferDesc.MiscFlags = 0; + + ID3D11Texture2D* CopyBuffer = nullptr; + HRESULT hr = m_Device->CreateTexture2D(&CopyBufferDesc, nullptr, &CopyBuffer); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed creating staging texture for pointer", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Copy needed part of desktop image + Box->left = *PtrLeft; + Box->top = *PtrTop; + Box->right = *PtrLeft + *PtrWidth; + Box->bottom = *PtrTop + *PtrHeight; + m_DeviceContext->CopySubresourceRegion(CopyBuffer, 0, 0, 0, 0, m_SharedSurf, 0, Box); + + // QI for IDXGISurface + IDXGISurface* CopySurface = nullptr; + hr = CopyBuffer->QueryInterface(__uuidof(IDXGISurface), (void **)&CopySurface); + CopyBuffer->Release(); + CopyBuffer = nullptr; + if (FAILED(hr)) + { + return ProcessFailure(nullptr, L"Failed to QI staging texture into IDXGISurface for pointer", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Map pixels + DXGI_MAPPED_RECT MappedSurface; + hr = CopySurface->Map(&MappedSurface, DXGI_MAP_READ); + if (FAILED(hr)) + { + CopySurface->Release(); + CopySurface = nullptr; + return ProcessFailure(m_Device, L"Failed to map surface for pointer", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // New mouseshape buffer + *InitBuffer = new (std::nothrow) BYTE[*PtrWidth * *PtrHeight * BPP]; + if (!(*InitBuffer)) + { + return ProcessFailure(nullptr, L"Failed to allocate memory for new mouse shape buffer.", L"Error", E_OUTOFMEMORY); + } + + UINT* InitBuffer32 = reinterpret_cast(*InitBuffer); + UINT* Desktop32 = reinterpret_cast(MappedSurface.pBits); + UINT DesktopPitchInPixels = MappedSurface.Pitch / sizeof(UINT); + + // What to skip (pixel offset) + UINT SkipX = (GivenLeft < 0) ? (-1 * GivenLeft) : (0); + UINT SkipY = (GivenTop < 0) ? (-1 * GivenTop) : (0); + + if (IsMono) + { + for (INT Row = 0; Row < *PtrHeight; ++Row) + { + // Set mask + BYTE Mask = 0x80; + Mask = Mask >> (SkipX % 8); + for (INT Col = 0; Col < *PtrWidth; ++Col) + { + // Get masks using appropriate offsets + BYTE AndMask = PtrInfo->PtrShapeBuffer[((Col + SkipX) / 8) + ((Row + SkipY) * (PtrInfo->ShapeInfo.Pitch))] & Mask; + BYTE XorMask = PtrInfo->PtrShapeBuffer[((Col + SkipX) / 8) + ((Row + SkipY + (PtrInfo->ShapeInfo.Height / 2)) * (PtrInfo->ShapeInfo.Pitch))] & Mask; + UINT AndMask32 = (AndMask) ? 0xFFFFFFFF : 0xFF000000; + UINT XorMask32 = (XorMask) ? 0x00FFFFFF : 0x00000000; + + // Set new pixel + InitBuffer32[(Row * *PtrWidth) + Col] = (Desktop32[(Row * DesktopPitchInPixels) + Col] & AndMask32) ^ XorMask32; + + // Adjust mask + if (Mask == 0x01) + { + Mask = 0x80; + } + else + { + Mask = Mask >> 1; + } + } + } + } + else + { + UINT* Buffer32 = reinterpret_cast(PtrInfo->PtrShapeBuffer); + + // Iterate through pixels + for (INT Row = 0; Row < *PtrHeight; ++Row) + { + for (INT Col = 0; Col < *PtrWidth; ++Col) + { + // Set up mask + UINT MaskVal = 0xFF000000 & Buffer32[(Col + SkipX) + ((Row + SkipY) * (PtrInfo->ShapeInfo.Pitch / sizeof(UINT)))]; + if (MaskVal) + { + // Mask was 0xFF + InitBuffer32[(Row * *PtrWidth) + Col] = (Desktop32[(Row * DesktopPitchInPixels) + Col] ^ Buffer32[(Col + SkipX) + ((Row + SkipY) * (PtrInfo->ShapeInfo.Pitch / sizeof(UINT)))]) | 0xFF000000; + } + else + { + // Mask was 0x00 + InitBuffer32[(Row * *PtrWidth) + Col] = Buffer32[(Col + SkipX) + ((Row + SkipY) * (PtrInfo->ShapeInfo.Pitch / sizeof(UINT)))] | 0xFF000000; + } + } + } + } + + // Done with resource + hr = CopySurface->Unmap(); + CopySurface->Release(); + CopySurface = nullptr; + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to unmap surface for pointer", L"Error", hr, SystemTransitionsExpectedErrors); + } + + return DUPL_RETURN_SUCCESS; +} + +// +// Draw mouse provided in buffer to backbuffer +// +DUPL_RETURN OUTPUTMANAGER::DrawMouse(_In_ PTR_INFO* PtrInfo) +{ + // Vars to be used + ID3D11Texture2D* MouseTex = nullptr; + ID3D11ShaderResourceView* ShaderRes = nullptr; + ID3D11Buffer* VertexBufferMouse = nullptr; + D3D11_SUBRESOURCE_DATA InitData; + D3D11_TEXTURE2D_DESC Desc; + D3D11_SHADER_RESOURCE_VIEW_DESC SDesc; + + // Position will be changed based on mouse position + VERTEX Vertices[NUMVERTICES] = + { + {XMFLOAT3(-1.0f, -1.0f, 0), XMFLOAT2(0.0f, 1.0f)}, + {XMFLOAT3(-1.0f, 1.0f, 0), XMFLOAT2(0.0f, 0.0f)}, + {XMFLOAT3(1.0f, -1.0f, 0), XMFLOAT2(1.0f, 1.0f)}, + {XMFLOAT3(1.0f, -1.0f, 0), XMFLOAT2(1.0f, 1.0f)}, + {XMFLOAT3(-1.0f, 1.0f, 0), XMFLOAT2(0.0f, 0.0f)}, + {XMFLOAT3(1.0f, 1.0f, 0), XMFLOAT2(1.0f, 0.0f)}, + }; + + D3D11_TEXTURE2D_DESC FullDesc; + m_SharedSurf->GetDesc(&FullDesc); + INT DesktopWidth = FullDesc.Width; + INT DesktopHeight = FullDesc.Height; + + // Center of desktop dimensions + INT CenterX = (DesktopWidth / 2); + INT CenterY = (DesktopHeight / 2); + + // Clipping adjusted coordinates / dimensions + INT PtrWidth = 0; + INT PtrHeight = 0; + INT PtrLeft = 0; + INT PtrTop = 0; + + // Buffer used if necessary (in case of monochrome or masked pointer) + BYTE* InitBuffer = nullptr; + + // Used for copying pixels + D3D11_BOX Box; + Box.front = 0; + Box.back = 1; + + Desc.MipLevels = 1; + Desc.ArraySize = 1; + Desc.Format = DXGI_FORMAT_B8G8R8A8_UNORM; + Desc.SampleDesc.Count = 1; + Desc.SampleDesc.Quality = 0; + Desc.Usage = D3D11_USAGE_DEFAULT; + Desc.BindFlags = D3D11_BIND_SHADER_RESOURCE; + Desc.CPUAccessFlags = 0; + Desc.MiscFlags = 0; + + // Set shader resource properties + SDesc.Format = Desc.Format; + SDesc.ViewDimension = D3D11_SRV_DIMENSION_TEXTURE2D; + SDesc.Texture2D.MostDetailedMip = Desc.MipLevels - 1; + SDesc.Texture2D.MipLevels = Desc.MipLevels; + + switch (PtrInfo->ShapeInfo.Type) + { + case DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR: + { + PtrLeft = PtrInfo->Position.x; + PtrTop = PtrInfo->Position.y; + + PtrWidth = static_cast(PtrInfo->ShapeInfo.Width); + PtrHeight = static_cast(PtrInfo->ShapeInfo.Height); + + break; + } + + case DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MONOCHROME: + { + ProcessMonoMask(true, PtrInfo, &PtrWidth, &PtrHeight, &PtrLeft, &PtrTop, &InitBuffer, &Box); + break; + } + + case DXGI_OUTDUPL_POINTER_SHAPE_TYPE_MASKED_COLOR: + { + ProcessMonoMask(false, PtrInfo, &PtrWidth, &PtrHeight, &PtrLeft, &PtrTop, &InitBuffer, &Box); + break; + } + + default: + break; + } + + // VERTEX creation + Vertices[0].Pos.x = (PtrLeft - CenterX) / (FLOAT)CenterX; + Vertices[0].Pos.y = -1 * ((PtrTop + PtrHeight) - CenterY) / (FLOAT)CenterY; + Vertices[1].Pos.x = (PtrLeft - CenterX) / (FLOAT)CenterX; + Vertices[1].Pos.y = -1 * (PtrTop - CenterY) / (FLOAT)CenterY; + Vertices[2].Pos.x = ((PtrLeft + PtrWidth) - CenterX) / (FLOAT)CenterX; + Vertices[2].Pos.y = -1 * ((PtrTop + PtrHeight) - CenterY) / (FLOAT)CenterY; + Vertices[3].Pos.x = Vertices[2].Pos.x; + Vertices[3].Pos.y = Vertices[2].Pos.y; + Vertices[4].Pos.x = Vertices[1].Pos.x; + Vertices[4].Pos.y = Vertices[1].Pos.y; + Vertices[5].Pos.x = ((PtrLeft + PtrWidth) - CenterX) / (FLOAT)CenterX; + Vertices[5].Pos.y = -1 * (PtrTop - CenterY) / (FLOAT)CenterY; + + // Set texture properties + Desc.Width = PtrWidth; + Desc.Height = PtrHeight; + + // Set up init data + InitData.pSysMem = (PtrInfo->ShapeInfo.Type == DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR) ? PtrInfo->PtrShapeBuffer : InitBuffer; + InitData.SysMemPitch = (PtrInfo->ShapeInfo.Type == DXGI_OUTDUPL_POINTER_SHAPE_TYPE_COLOR) ? PtrInfo->ShapeInfo.Pitch : PtrWidth * BPP; + InitData.SysMemSlicePitch = 0; + + // Create mouseshape as texture + HRESULT hr = m_Device->CreateTexture2D(&Desc, &InitData, &MouseTex); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to create mouse pointer texture", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Create shader resource from texture + hr = m_Device->CreateShaderResourceView(MouseTex, &SDesc, &ShaderRes); + if (FAILED(hr)) + { + MouseTex->Release(); + MouseTex = nullptr; + return ProcessFailure(m_Device, L"Failed to create shader resource from mouse pointer texture", L"Error", hr, SystemTransitionsExpectedErrors); + } + + D3D11_BUFFER_DESC BDesc; + ZeroMemory(&BDesc, sizeof(D3D11_BUFFER_DESC)); + BDesc.Usage = D3D11_USAGE_DEFAULT; + BDesc.ByteWidth = sizeof(VERTEX) * NUMVERTICES; + BDesc.BindFlags = D3D11_BIND_VERTEX_BUFFER; + BDesc.CPUAccessFlags = 0; + + ZeroMemory(&InitData, sizeof(D3D11_SUBRESOURCE_DATA)); + InitData.pSysMem = Vertices; + + // Create vertex buffer + hr = m_Device->CreateBuffer(&BDesc, &InitData, &VertexBufferMouse); + if (FAILED(hr)) + { + ShaderRes->Release(); + ShaderRes = nullptr; + MouseTex->Release(); + MouseTex = nullptr; + return ProcessFailure(m_Device, L"Failed to create mouse pointer vertex buffer in OutputManager", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Set resources + FLOAT BlendFactor[4] = {0.f, 0.f, 0.f, 0.f}; + UINT Stride = sizeof(VERTEX); + UINT Offset = 0; + m_DeviceContext->IASetVertexBuffers(0, 1, &VertexBufferMouse, &Stride, &Offset); + m_DeviceContext->OMSetBlendState(m_BlendState, BlendFactor, 0xFFFFFFFF); + m_DeviceContext->OMSetRenderTargets(1, &m_RTV, nullptr); + m_DeviceContext->VSSetShader(m_VertexShader, nullptr, 0); + m_DeviceContext->PSSetShader(m_PixelShader, nullptr, 0); + m_DeviceContext->PSSetShaderResources(0, 1, &ShaderRes); + m_DeviceContext->PSSetSamplers(0, 1, &m_SamplerLinear); + + // Draw + m_DeviceContext->Draw(NUMVERTICES, 0); + + // Clean + if (VertexBufferMouse) + { + VertexBufferMouse->Release(); + VertexBufferMouse = nullptr; + } + if (ShaderRes) + { + ShaderRes->Release(); + ShaderRes = nullptr; + } + if (MouseTex) + { + MouseTex->Release(); + MouseTex = nullptr; + } + if (InitBuffer) + { + delete [] InitBuffer; + InitBuffer = nullptr; + } + + return DUPL_RETURN_SUCCESS; +} + +// +// Initialize shaders for drawing to screen +// +DUPL_RETURN OUTPUTMANAGER::InitShaders() +{ + HRESULT hr; + + UINT Size = ARRAYSIZE(g_VS); + hr = m_Device->CreateVertexShader(g_VS, Size, nullptr, &m_VertexShader); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to create vertex shader in OUTPUTMANAGER", L"Error", hr, SystemTransitionsExpectedErrors); + } + + D3D11_INPUT_ELEMENT_DESC Layout[] = + { + {"POSITION", 0, DXGI_FORMAT_R32G32B32_FLOAT, 0, 0, D3D11_INPUT_PER_VERTEX_DATA, 0}, + {"TEXCOORD", 0, DXGI_FORMAT_R32G32_FLOAT, 0, 12, D3D11_INPUT_PER_VERTEX_DATA, 0} + }; + UINT NumElements = ARRAYSIZE(Layout); + hr = m_Device->CreateInputLayout(Layout, NumElements, g_VS, Size, &m_InputLayout); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to create input layout in OUTPUTMANAGER", L"Error", hr, SystemTransitionsExpectedErrors); + } + m_DeviceContext->IASetInputLayout(m_InputLayout); + + Size = ARRAYSIZE(g_PS); + hr = m_Device->CreatePixelShader(g_PS, Size, nullptr, &m_PixelShader); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to create pixel shader in OUTPUTMANAGER", L"Error", hr, SystemTransitionsExpectedErrors); + } + + return DUPL_RETURN_SUCCESS; +} + +// +// Reset render target view +// +DUPL_RETURN OUTPUTMANAGER::MakeRTV() +{ + // Get backbuffer + ID3D11Texture2D* BackBuffer = nullptr; + HRESULT hr = m_SwapChain->GetBuffer(0, __uuidof(ID3D11Texture2D), reinterpret_cast(&BackBuffer)); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to get backbuffer for making render target view in OUTPUTMANAGER", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Create a render target view + hr = m_Device->CreateRenderTargetView(BackBuffer, nullptr, &m_RTV); + BackBuffer->Release(); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to create render target view in OUTPUTMANAGER", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Set new render target + m_DeviceContext->OMSetRenderTargets(1, &m_RTV, nullptr); + + return DUPL_RETURN_SUCCESS; +} + +// +// Set new viewport +// +void OUTPUTMANAGER::SetViewPort(UINT Width, UINT Height) +{ + D3D11_VIEWPORT VP; + VP.Width = static_cast(Width); + VP.Height = static_cast(Height); + VP.MinDepth = 0.0f; + VP.MaxDepth = 1.0f; + VP.TopLeftX = 0; + VP.TopLeftY = 0; + m_DeviceContext->RSSetViewports(1, &VP); +} + +// +// Resize swapchain +// +DUPL_RETURN OUTPUTMANAGER::ResizeSwapChain() +{ + if (m_RTV) + { + m_RTV->Release(); + m_RTV = nullptr; + } + + RECT WindowRect; + GetClientRect(m_WindowHandle, &WindowRect); + UINT Width = WindowRect.right - WindowRect.left; + UINT Height = WindowRect.bottom - WindowRect.top; + + // Resize swapchain + DXGI_SWAP_CHAIN_DESC SwapChainDesc; + m_SwapChain->GetDesc(&SwapChainDesc); + HRESULT hr = m_SwapChain->ResizeBuffers(SwapChainDesc.BufferCount, Width, Height, SwapChainDesc.BufferDesc.Format, SwapChainDesc.Flags); + if (FAILED(hr)) + { + return ProcessFailure(m_Device, L"Failed to resize swapchain buffers in OUTPUTMANAGER", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Make new render target view + DUPL_RETURN Ret = MakeRTV(); + if (Ret != DUPL_RETURN_SUCCESS) + { + return Ret; + } + + // Set new viewport + SetViewPort(Width, Height); + + return Ret; +} + +// +// Releases all references +// +void OUTPUTMANAGER::CleanRefs() +{ + if (m_VertexShader) + { + m_VertexShader->Release(); + m_VertexShader = nullptr; + } + + if (m_PixelShader) + { + m_PixelShader->Release(); + m_PixelShader = nullptr; + } + + if (m_InputLayout) + { + m_InputLayout->Release(); + m_InputLayout = nullptr; + } + + if (m_RTV) + { + m_RTV->Release(); + m_RTV = nullptr; + } + + if (m_SamplerLinear) + { + m_SamplerLinear->Release(); + m_SamplerLinear = nullptr; + } + + if (m_BlendState) + { + m_BlendState->Release(); + m_BlendState = nullptr; + } + + if (m_DeviceContext) + { + m_DeviceContext->Release(); + m_DeviceContext = nullptr; + } + + if (m_Device) + { + m_Device->Release(); + m_Device = nullptr; + } + + if (m_SwapChain) + { + m_SwapChain->Release(); + m_SwapChain = nullptr; + } + + if (m_SharedSurf) + { + m_SharedSurf->Release(); + m_SharedSurf = nullptr; + } + + if (m_KeyMutex) + { + m_KeyMutex->Release(); + m_KeyMutex = nullptr; + } + + if (m_Factory) + { + if (m_OcclusionCookie) + { + m_Factory->UnregisterOcclusionStatus(m_OcclusionCookie); + m_OcclusionCookie = 0; + } + m_Factory->Release(); + m_Factory = nullptr; + } +} diff --git a/OutputManager.h b/OutputManager.h new file mode 100644 index 0000000..cd16e5f --- /dev/null +++ b/OutputManager.h @@ -0,0 +1,61 @@ +// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF +// ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO +// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A +// PARTICULAR PURPOSE. +// +// Copyright (c) Microsoft Corporation. All rights reserved + +#ifndef _OUTPUTMANAGER_H_ +#define _OUTPUTMANAGER_H_ + +#include + +#include "CommonTypes.h" +#include "warning.h" + +// +// Handles the task of drawing into a window. +// Has the functionality to draw the mouse given a mouse shape buffer and position +// +class OUTPUTMANAGER +{ + public: + OUTPUTMANAGER(); + ~OUTPUTMANAGER(); + DUPL_RETURN InitOutput(HWND Window, INT SingleOutput, _Out_ UINT* OutCount, _Out_ RECT* DeskBounds); + DUPL_RETURN UpdateApplicationWindow(_In_ PTR_INFO* PointerInfo, _Inout_ bool* Occluded); + void CleanRefs(); + HANDLE GetSharedHandle(); + void WindowResize(); + + private: + // Methods + DUPL_RETURN ProcessMonoMask(bool IsMono, _Inout_ PTR_INFO* PtrInfo, _Out_ INT* PtrWidth, _Out_ INT* PtrHeight, _Out_ INT* PtrLeft, _Out_ INT* PtrTop, _Outptr_result_bytebuffer_(*PtrHeight * *PtrWidth * BPP) BYTE** InitBuffer, _Out_ D3D11_BOX* Box); + DUPL_RETURN MakeRTV(); + void SetViewPort(UINT Width, UINT Height); + DUPL_RETURN InitShaders(); + DUPL_RETURN InitGeometry(); + DUPL_RETURN CreateSharedSurf(INT SingleOutput, _Out_ UINT* OutCount, _Out_ RECT* DeskBounds); + DUPL_RETURN DrawFrame(); + DUPL_RETURN DrawMouse(_In_ PTR_INFO* PtrInfo); + DUPL_RETURN ResizeSwapChain(); + + // Vars + IDXGISwapChain1* m_SwapChain; + ID3D11Device* m_Device; + IDXGIFactory2* m_Factory; + ID3D11DeviceContext* m_DeviceContext; + ID3D11RenderTargetView* m_RTV; + ID3D11SamplerState* m_SamplerLinear; + ID3D11BlendState* m_BlendState; + ID3D11VertexShader* m_VertexShader; + ID3D11PixelShader* m_PixelShader; + ID3D11InputLayout* m_InputLayout; + ID3D11Texture2D* m_SharedSurf; + IDXGIKeyedMutex* m_KeyMutex; + HWND m_WindowHandle; + bool m_NeedsResize; + DWORD m_OcclusionCookie; +}; + +#endif diff --git a/PixelShader.h b/PixelShader.h new file mode 100644 index 0000000..da22352 --- /dev/null +++ b/PixelShader.h @@ -0,0 +1,2545 @@ +#if 0 +// +// Generated by Microsoft (R) HLSL Shader Compiler 10.1 +// +// +// Resource Bindings: +// +// Name Type Format Dim HLSL Bind Count +// ------------------------------ ---------- ------- ----------- -------------- ------ +// samLinear sampler NA NA s0 1 +// tx texture float4 2d t0 1 +// +// +// +// Input signature: +// +// Name Index Mask Register SysValue Format Used +// -------------------- ----- ------ -------- -------- ------- ------ +// SV_POSITION 0 xyzw 0 POS float +// TEXCOORD 0 xy 1 NONE float xy +// +// +// Output signature: +// +// Name Index Mask Register SysValue Format Used +// -------------------- ----- ------ -------- -------- ------- ------ +// SV_Target 0 xyzw 0 TARGET float xyzw +// +// +// Sampler/Resource to DX9 shader sampler mappings: +// +// Target Sampler Source Sampler Source Resource +// -------------- --------------- ---------------- +// s0 s0 t0 +// +// +// Level9 shader bytecode: +// + ps_2_0 + dcl t0.xy // input<4,5> + dcl_2d s0 + +#line 23 "D:\VSProject\_DXGI\PixelShader.hlsl" + texld r0, t0, s0 // ::PS<0,1,2,3> + mov oC0, r0 // ::PS<0,1,2,3> + +// approximately 2 instruction slots used (1 texture, 1 arithmetic) +ps_4_0 +dcl_sampler s0, mode_default +dcl_resource_texture2d (float,float,float,float) t0 +dcl_input_ps linear v1.xy +dcl_output o0.xyzw +// +// Initial variable locations: +// v0.x <- input.Pos.x; v0.y <- input.Pos.y; v0.z <- input.Pos.z; v0.w <- input.Pos.w; +// v1.x <- input.Tex.x; v1.y <- input.Tex.y; +// o0.x <- .x; o0.y <- .y; o0.z <- .z; o0.w <- .w +// +#line 23 "D:\VSProject\_DXGI\PixelShader.hlsl" +sample o0.xyzw, v1.xyxx, t0.xyzw, s0 +ret +// Approximately 2 instruction slots used +#endif + +const BYTE g_PS[] = +{ + 68, 88, 66, 67, 184, 173, + 97, 246, 216, 63, 121, 231, + 186, 81, 148, 194, 105, 213, + 19, 130, 1, 0, 0, 0, + 16, 58, 0, 0, 7, 0, + 0, 0, 60, 0, 0, 0, + 248, 1, 0, 0, 100, 2, + 0, 0, 108, 56, 0, 0, + 232, 56, 0, 0, 132, 57, + 0, 0, 220, 57, 0, 0, + 65, 111, 110, 57, 180, 1, + 0, 0, 180, 1, 0, 0, + 0, 2, 255, 255, 140, 1, + 0, 0, 40, 0, 0, 0, + 0, 0, 40, 0, 0, 0, + 40, 0, 0, 0, 40, 0, + 1, 0, 36, 0, 0, 0, + 40, 0, 0, 0, 0, 0, + 0, 2, 255, 255, 254, 255, + 83, 0, 68, 66, 85, 71, + 40, 0, 0, 0, 32, 1, + 0, 0, 0, 0, 0, 0, + 1, 0, 0, 0, 76, 0, + 0, 0, 4, 0, 0, 0, + 80, 0, 0, 0, 2, 0, + 0, 0, 248, 0, 0, 0, + 112, 0, 0, 0, 68, 58, + 92, 86, 83, 80, 114, 111, + 106, 101, 99, 116, 92, 95, + 68, 88, 71, 73, 92, 80, + 105, 120, 101, 108, 83, 104, + 97, 100, 101, 114, 46, 104, + 108, 115, 108, 0, 40, 0, + 0, 0, 0, 0, 255, 255, + 84, 1, 0, 0, 0, 0, + 255, 255, 96, 1, 0, 0, + 23, 0, 0, 0, 108, 1, + 0, 0, 21, 0, 0, 0, + 124, 1, 0, 0, 80, 83, + 0, 171, 1, 0, 3, 0, + 1, 0, 4, 0, 1, 0, + 0, 0, 0, 0, 0, 0, + 2, 0, 0, 0, 0, 0, + 1, 0, 2, 0, 3, 0, + 3, 0, 0, 0, 0, 0, + 1, 0, 2, 0, 3, 0, + 105, 110, 112, 117, 116, 0, + 80, 111, 115, 0, 171, 171, + 1, 0, 3, 0, 1, 0, + 4, 0, 1, 0, 0, 0, + 0, 0, 0, 0, 84, 101, + 120, 0, 1, 0, 3, 0, + 1, 0, 2, 0, 1, 0, + 0, 0, 0, 0, 0, 0, + 162, 0, 0, 0, 168, 0, + 0, 0, 184, 0, 0, 0, + 188, 0, 0, 0, 5, 0, + 0, 0, 1, 0, 6, 0, + 1, 0, 2, 0, 204, 0, + 0, 0, 0, 0, 0, 0, + 4, 0, 5, 0, 255, 255, + 255, 255, 0, 0, 0, 0, + 112, 0, 0, 0, 116, 0, + 0, 0, 2, 0, 0, 0, + 132, 0, 0, 0, 112, 0, + 0, 0, 156, 0, 0, 0, + 220, 0, 0, 0, 1, 0, + 0, 0, 236, 0, 0, 0, + 77, 105, 99, 114, 111, 115, + 111, 102, 116, 32, 40, 82, + 41, 32, 72, 76, 83, 76, + 32, 83, 104, 97, 100, 101, + 114, 32, 67, 111, 109, 112, + 105, 108, 101, 114, 32, 49, + 48, 46, 49, 0, 31, 0, + 0, 2, 0, 0, 0, 128, + 0, 0, 3, 176, 31, 0, + 0, 2, 0, 0, 0, 144, + 0, 8, 15, 160, 66, 0, + 0, 3, 0, 0, 15, 128, + 0, 0, 228, 176, 0, 8, + 228, 160, 1, 0, 0, 2, + 0, 8, 15, 128, 0, 0, + 228, 128, 255, 255, 0, 0, + 83, 72, 68, 82, 100, 0, + 0, 0, 64, 0, 0, 0, + 25, 0, 0, 0, 90, 0, + 0, 3, 0, 96, 16, 0, + 0, 0, 0, 0, 88, 24, + 0, 4, 0, 112, 16, 0, + 0, 0, 0, 0, 85, 85, + 0, 0, 98, 16, 0, 3, + 50, 16, 16, 0, 1, 0, + 0, 0, 101, 0, 0, 3, + 242, 32, 16, 0, 0, 0, + 0, 0, 69, 0, 0, 9, + 242, 32, 16, 0, 0, 0, + 0, 0, 70, 16, 16, 0, + 1, 0, 0, 0, 70, 126, + 16, 0, 0, 0, 0, 0, + 0, 96, 16, 0, 0, 0, + 0, 0, 62, 0, 0, 1, + 83, 80, 68, 66, 0, 54, + 0, 0, 77, 105, 99, 114, + 111, 115, 111, 102, 116, 32, + 67, 47, 67, 43, 43, 32, + 77, 83, 70, 32, 55, 46, + 48, 48, 13, 10, 26, 68, + 83, 0, 0, 0, 0, 2, + 0, 0, 2, 0, 0, 0, + 27, 0, 0, 0, 140, 0, + 0, 0, 0, 0, 0, 0, + 24, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 192, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 56, 0, 0, 254, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 5, 0, 0, 0, + 32, 0, 0, 0, 60, 0, + 0, 0, 0, 0, 0, 0, + 255, 255, 255, 255, 0, 0, + 0, 0, 6, 0, 0, 0, + 5, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 3, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 148, 46, 49, 1, 206, 86, + 50, 96, 1, 0, 0, 0, + 111, 244, 231, 83, 204, 95, + 223, 72, 183, 13, 216, 255, + 17, 84, 173, 235, 0, 0, + 0, 0, 0, 0, 0, 0, + 1, 0, 0, 0, 1, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 220, 81, 51, 1, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 115, 116, 101, 114, + 40, 32, 115, 48, 32, 41, + 59, 10, 10, 115, 116, 114, + 117, 99, 116, 32, 80, 83, + 95, 73, 78, 80, 85, 84, + 10, 123, 10, 32, 32, 32, + 32, 102, 108, 111, 97, 116, + 52, 32, 80, 111, 115, 32, + 58, 32, 83, 86, 95, 80, + 79, 83, 73, 84, 73, 79, + 78, 59, 10, 32, 32, 32, + 32, 102, 108, 111, 97, 116, + 50, 32, 84, 101, 120, 32, + 58, 32, 84, 69, 88, 67, + 79, 79, 82, 68, 59, 10, + 125, 59, 10, 10, 47, 47, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 10, 47, 47, 32, + 80, 105, 120, 101, 108, 32, + 83, 104, 97, 100, 101, 114, + 10, 47, 47, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 10, + 102, 108, 111, 97, 116, 52, + 32, 80, 83, 40, 80, 83, + 95, 73, 78, 80, 85, 84, + 32, 105, 110, 112, 117, 116, + 41, 32, 58, 32, 83, 86, + 95, 84, 97, 114, 103, 101, + 116, 10, 123, 10, 32, 32, + 32, 32, 114, 101, 116, 117, + 114, 110, 32, 116, 120, 46, + 83, 97, 109, 112, 108, 101, + 40, 32, 115, 97, 109, 76, + 105, 110, 101, 97, 114, 44, + 32, 105, 110, 112, 117, 116, + 46, 84, 101, 120, 32, 41, + 59, 10, 125, 0, 7, 0, + 0, 0, 1, 0, 0, 0, + 37, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 74, 0, + 0, 0, 38, 0, 0, 0, + 4, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 198, 90, + 0, 0, 117, 131, 1, 0, + 156, 39, 3, 0, 162, 202, + 1, 0, 38, 247, 2, 0, + 65, 36, 1, 0, 39, 82, + 3, 0, 151, 219, 1, 0, + 217, 42, 2, 0, 21, 230, + 0, 0, 221, 119, 0, 0, + 73, 20, 1, 0, 153, 189, + 3, 0, 0, 16, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 47, 47, 32, 84, 72, 73, + 83, 32, 67, 79, 68, 69, + 32, 65, 78, 68, 32, 73, + 78, 70, 79, 82, 77, 65, + 84, 73, 79, 78, 32, 73, + 83, 32, 80, 82, 79, 86, + 73, 68, 69, 68, 32, 34, + 65, 83, 32, 73, 83, 34, + 32, 87, 73, 84, 72, 79, + 85, 84, 32, 87, 65, 82, + 82, 65, 78, 84, 89, 32, + 79, 70, 10, 47, 47, 32, + 65, 78, 89, 32, 75, 73, + 78, 68, 44, 32, 69, 73, + 84, 72, 69, 82, 32, 69, + 88, 80, 82, 69, 83, 83, + 69, 68, 32, 79, 82, 32, + 73, 77, 80, 76, 73, 69, + 68, 44, 32, 73, 78, 67, + 76, 85, 68, 73, 78, 71, + 32, 66, 85, 84, 32, 78, + 79, 84, 32, 76, 73, 77, + 73, 84, 69, 68, 32, 84, + 79, 10, 47, 47, 32, 84, + 72, 69, 32, 73, 77, 80, + 76, 73, 69, 68, 32, 87, + 65, 82, 82, 65, 78, 84, + 73, 69, 83, 32, 79, 70, + 32, 77, 69, 82, 67, 72, + 65, 78, 84, 65, 66, 73, + 76, 73, 84, 89, 32, 65, + 78, 68, 47, 79, 82, 32, + 70, 73, 84, 78, 69, 83, + 83, 32, 70, 79, 82, 32, + 65, 10, 47, 47, 32, 80, + 65, 82, 84, 73, 67, 85, + 76, 65, 82, 32, 80, 85, + 82, 80, 79, 83, 69, 46, + 10, 47, 47, 10, 47, 47, + 32, 67, 111, 112, 121, 114, + 105, 103, 104, 116, 32, 40, + 99, 41, 32, 77, 105, 99, + 114, 111, 115, 111, 102, 116, + 32, 67, 111, 114, 112, 111, + 114, 97, 116, 105, 111, 110, + 46, 32, 65, 108, 108, 32, + 114, 105, 103, 104, 116, 115, + 32, 114, 101, 115, 101, 114, + 118, 101, 100, 10, 47, 47, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 10, 10, + 84, 101, 120, 116, 117, 114, + 101, 50, 68, 32, 116, 120, + 32, 58, 32, 114, 101, 103, + 105, 115, 116, 101, 114, 40, + 32, 116, 48, 32, 41, 59, + 10, 83, 97, 109, 112, 108, + 101, 114, 83, 116, 97, 116, + 101, 32, 115, 97, 109, 76, + 105, 110, 101, 97, 114, 32, + 58, 32, 114, 101, 103, 105, + 115, 116, 101, 114, 40, 32, + 115, 48, 32, 41, 59, 10, + 10, 115, 116, 114, 117, 99, + 116, 32, 80, 83, 95, 73, + 78, 80, 85, 84, 10, 123, + 10, 32, 32, 32, 32, 102, + 108, 111, 97, 116, 52, 32, + 80, 111, 115, 32, 58, 32, + 83, 86, 95, 80, 79, 83, + 73, 84, 73, 79, 78, 59, + 10, 32, 32, 32, 32, 102, + 108, 111, 97, 116, 50, 32, + 84, 101, 120, 32, 58, 32, + 84, 69, 88, 67, 79, 79, + 82, 68, 59, 10, 125, 59, + 10, 10, 47, 47, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 10, 47, 47, 32, 80, 105, + 120, 101, 108, 32, 83, 104, + 97, 100, 101, 114, 10, 47, + 47, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 10, 102, 108, + 111, 97, 116, 52, 32, 80, + 83, 40, 80, 83, 95, 73, + 78, 80, 85, 84, 32, 105, + 110, 112, 117, 116, 41, 32, + 58, 32, 83, 86, 95, 84, + 97, 114, 103, 101, 116, 10, + 123, 10, 32, 32, 32, 32, + 114, 101, 116, 117, 114, 110, + 32, 116, 120, 46, 83, 97, + 109, 112, 108, 101, 40, 32, + 115, 97, 109, 76, 105, 110, + 101, 97, 114, 44, 32, 105, + 110, 112, 117, 116, 46, 84, + 101, 120, 32, 41, 59, 10, + 125, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 254, 239, + 254, 239, 1, 0, 0, 0, + 106, 3, 0, 0, 0, 68, + 58, 92, 86, 83, 80, 114, + 111, 106, 101, 99, 116, 92, + 95, 68, 88, 71, 73, 92, + 80, 105, 120, 101, 108, 83, + 104, 97, 100, 101, 114, 46, + 104, 108, 115, 108, 0, 0, + 100, 58, 92, 118, 115, 112, + 114, 111, 106, 101, 99, 116, + 92, 95, 100, 120, 103, 105, + 92, 112, 105, 120, 101, 108, + 115, 104, 97, 100, 101, 114, + 46, 104, 108, 115, 108, 0, + 47, 47, 32, 84, 72, 73, + 83, 32, 67, 79, 68, 69, + 32, 65, 78, 68, 32, 73, + 78, 70, 79, 82, 77, 65, + 84, 73, 79, 78, 32, 73, + 83, 32, 80, 82, 79, 86, + 73, 68, 69, 68, 32, 34, + 65, 83, 32, 73, 83, 34, + 32, 87, 73, 84, 72, 79, + 85, 84, 32, 87, 65, 82, + 82, 65, 78, 84, 89, 32, + 79, 70, 10, 47, 47, 32, + 65, 78, 89, 32, 75, 73, + 78, 68, 44, 32, 69, 73, + 84, 72, 69, 82, 32, 69, + 88, 80, 82, 69, 83, 83, + 69, 68, 32, 79, 82, 32, + 73, 77, 80, 76, 73, 69, + 68, 44, 32, 73, 78, 67, + 76, 85, 68, 73, 78, 71, + 32, 66, 85, 84, 32, 78, + 79, 84, 32, 76, 73, 77, + 73, 84, 69, 68, 32, 84, + 79, 10, 47, 47, 32, 84, + 72, 69, 32, 73, 77, 80, + 76, 73, 69, 68, 32, 87, + 65, 82, 82, 65, 78, 84, + 73, 69, 83, 32, 79, 70, + 32, 77, 69, 82, 67, 72, + 65, 78, 84, 65, 66, 73, + 76, 73, 84, 89, 32, 65, + 78, 68, 47, 79, 82, 32, + 70, 73, 84, 78, 69, 83, + 83, 32, 70, 79, 82, 32, + 65, 10, 47, 47, 32, 80, + 65, 82, 84, 73, 67, 85, + 76, 65, 82, 32, 80, 85, + 82, 80, 79, 83, 69, 46, + 10, 47, 47, 10, 47, 47, + 32, 67, 111, 112, 121, 114, + 105, 103, 104, 116, 32, 40, + 99, 41, 32, 77, 105, 99, + 114, 111, 115, 111, 102, 116, + 32, 67, 111, 114, 112, 111, + 114, 97, 116, 105, 111, 110, + 46, 32, 65, 108, 108, 32, + 114, 105, 103, 104, 116, 115, + 32, 114, 101, 115, 101, 114, + 118, 101, 100, 10, 47, 47, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 10, 10, + 84, 101, 120, 116, 117, 114, + 101, 50, 68, 32, 116, 120, + 32, 58, 32, 114, 101, 103, + 105, 115, 116, 101, 114, 40, + 32, 116, 48, 32, 41, 59, + 10, 83, 97, 109, 112, 108, + 101, 114, 83, 116, 97, 116, + 101, 32, 115, 97, 109, 76, + 105, 110, 101, 97, 114, 32, + 58, 32, 114, 101, 103, 105, + 27, 226, 48, 1, 128, 0, + 0, 0, 232, 80, 151, 247, + 79, 8, 215, 1, 1, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 1, 0, + 0, 0, 2, 0, 0, 0, + 1, 0, 0, 0, 1, 0, + 0, 0, 0, 0, 0, 0, + 38, 0, 0, 0, 40, 0, + 0, 0, 27, 226, 48, 1, + 146, 110, 151, 61, 31, 3, + 0, 0, 1, 0, 0, 0, + 37, 0, 0, 0, 38, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 4, 0, 0, 0, + 66, 0, 60, 17, 16, 1, + 0, 0, 0, 1, 10, 0, + 1, 0, 1, 0, 186, 71, + 10, 0, 1, 0, 1, 0, + 186, 71, 77, 105, 99, 114, + 111, 115, 111, 102, 116, 32, + 40, 82, 41, 32, 72, 76, + 83, 76, 32, 83, 104, 97, + 100, 101, 114, 32, 67, 111, + 109, 112, 105, 108, 101, 114, + 32, 49, 48, 46, 49, 0, + 0, 0, 62, 0, 61, 17, + 1, 104, 108, 115, 108, 70, + 108, 97, 103, 115, 0, 48, + 120, 53, 0, 104, 108, 115, + 108, 84, 97, 114, 103, 101, + 116, 0, 112, 115, 95, 52, + 95, 48, 95, 108, 101, 118, + 101, 108, 95, 57, 95, 49, + 0, 104, 108, 115, 108, 69, + 110, 116, 114, 121, 0, 80, + 83, 0, 0, 0, 0, 0, + 42, 0, 16, 17, 0, 0, + 0, 0, 16, 2, 0, 0, + 0, 0, 0, 0, 40, 0, + 0, 0, 0, 0, 0, 0, + 40, 0, 0, 0, 6, 16, + 0, 0, 60, 0, 0, 0, + 1, 0, 160, 80, 83, 0, + 0, 0, 46, 0, 62, 17, + 3, 16, 0, 0, 9, 0, + 105, 110, 112, 117, 116, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 22, 0, 80, 17, + 1, 0, 5, 0, 0, 0, + 4, 0, 60, 0, 0, 0, + 1, 0, 40, 0, 0, 0, + 0, 0, 22, 0, 80, 17, + 1, 0, 5, 0, 4, 0, + 4, 0, 60, 0, 0, 0, + 1, 0, 40, 0, 4, 0, + 0, 0, 22, 0, 80, 17, + 1, 0, 5, 0, 8, 0, + 4, 0, 60, 0, 0, 0, + 1, 0, 40, 0, 8, 0, + 0, 0, 22, 0, 80, 17, + 1, 0, 5, 0, 12, 0, + 4, 0, 60, 0, 0, 0, + 1, 0, 40, 0, 12, 0, + 0, 0, 22, 0, 80, 17, + 1, 0, 5, 0, 16, 0, + 4, 0, 60, 0, 0, 0, + 1, 0, 40, 0, 16, 0, + 0, 0, 22, 0, 80, 17, + 1, 0, 5, 0, 20, 0, + 4, 0, 60, 0, 0, 0, + 1, 0, 40, 0, 20, 0, + 0, 0, 58, 0, 62, 17, + 5, 16, 0, 0, 136, 0, + 60, 80, 83, 32, 114, 101, + 116, 117, 114, 110, 32, 118, + 97, 108, 117, 101, 62, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 22, 0, 80, 17, + 2, 0, 5, 0, 0, 0, + 4, 0, 60, 0, 0, 0, + 1, 0, 40, 0, 0, 0, + 0, 0, 22, 0, 80, 17, + 2, 0, 5, 0, 4, 0, + 4, 0, 60, 0, 0, 0, + 1, 0, 40, 0, 4, 0, + 0, 0, 22, 0, 80, 17, + 2, 0, 5, 0, 8, 0, + 4, 0, 60, 0, 0, 0, + 1, 0, 40, 0, 8, 0, + 0, 0, 22, 0, 80, 17, + 2, 0, 5, 0, 12, 0, + 4, 0, 60, 0, 0, 0, + 1, 0, 40, 0, 12, 0, + 0, 0, 2, 0, 6, 0, + 244, 0, 0, 0, 24, 0, + 0, 0, 1, 0, 0, 0, + 16, 1, 196, 128, 145, 243, + 242, 185, 197, 165, 232, 248, + 223, 88, 150, 208, 130, 41, + 0, 0, 242, 0, 0, 0, + 72, 0, 0, 0, 0, 0, + 0, 0, 1, 0, 1, 0, + 100, 0, 0, 0, 0, 0, + 0, 0, 4, 0, 0, 0, + 60, 0, 0, 0, 60, 0, + 0, 0, 23, 0, 0, 128, + 60, 0, 0, 0, 23, 0, + 0, 0, 96, 0, 0, 0, + 23, 0, 0, 128, 96, 0, + 0, 0, 23, 0, 0, 0, + 5, 0, 45, 0, 12, 0, + 44, 0, 5, 0, 45, 0, + 5, 0, 45, 0, 246, 0, + 0, 0, 4, 0, 0, 0, + 0, 0, 0, 0, 12, 0, + 0, 0, 0, 0, 0, 0, + 20, 0, 0, 0, 44, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 11, 202, 49, 1, 56, 0, + 0, 0, 0, 16, 0, 0, + 13, 16, 0, 0, 236, 0, + 0, 0, 10, 0, 255, 255, + 4, 0, 0, 0, 255, 255, + 3, 0, 0, 0, 0, 0, + 52, 0, 0, 0, 52, 0, + 0, 0, 8, 0, 0, 0, + 60, 0, 0, 0, 0, 0, + 0, 0, 22, 0, 27, 21, + 64, 0, 0, 0, 4, 0, + 0, 0, 16, 0, 102, 108, + 111, 97, 116, 52, 0, 243, + 242, 241, 22, 0, 27, 21, + 64, 0, 0, 0, 2, 0, + 0, 0, 8, 0, 102, 108, + 111, 97, 116, 50, 0, 243, + 242, 241, 34, 0, 3, 18, + 13, 21, 3, 0, 0, 16, + 0, 0, 0, 0, 80, 111, + 115, 0, 242, 241, 13, 21, + 3, 0, 1, 16, 0, 0, + 16, 0, 84, 101, 120, 0, + 242, 241, 30, 0, 5, 21, + 2, 0, 0, 0, 2, 16, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 24, 0, + 80, 83, 95, 73, 78, 80, + 85, 84, 0, 241, 10, 0, + 1, 18, 1, 0, 0, 0, + 3, 16, 0, 0, 10, 0, + 24, 21, 0, 16, 0, 0, + 1, 0, 1, 0, 14, 0, + 8, 16, 5, 16, 0, 0, + 23, 0, 1, 0, 4, 16, + 0, 0, 14, 0, 23, 21, + 0, 16, 0, 0, 3, 2, + 240, 2, 0, 0, 242, 241, + 10, 0, 24, 21, 7, 16, + 0, 0, 1, 0, 1, 0, + 10, 0, 24, 21, 8, 16, + 0, 0, 1, 0, 0, 2, + 14, 0, 23, 21, 0, 0, + 0, 0, 10, 2, 240, 2, + 0, 0, 242, 241, 10, 0, + 24, 21, 10, 16, 0, 0, + 1, 0, 1, 0, 10, 0, + 24, 21, 11, 16, 0, 0, + 1, 0, 0, 2, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 11, 202, 49, 1, + 56, 0, 0, 0, 0, 16, + 0, 0, 0, 16, 0, 0, + 0, 0, 0, 0, 11, 0, + 255, 255, 4, 0, 0, 0, + 255, 255, 3, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 68, 51, + 68, 83, 72, 68, 82, 0, + 100, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 32, 0, + 0, 96, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 255, 255, 255, 255, 26, 9, + 47, 241, 24, 0, 0, 0, + 16, 2, 0, 0, 45, 0, + 0, 0, 1, 0, 0, 0, + 1, 0, 0, 0, 1, 0, + 0, 0, 21, 0, 0, 0, + 1, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 1, 0, 0, 4, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 128, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 12, 0, 0, 0, + 24, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 18, 0, + 37, 17, 0, 0, 0, 0, + 136, 0, 0, 0, 1, 0, + 80, 83, 0, 0, 0, 0, + 22, 0, 81, 17, 9, 16, + 0, 0, 7, 0, 255, 255, + 255, 255, 0, 0, 255, 255, + 255, 255, 116, 120, 0, 0, + 30, 0, 81, 17, 12, 16, + 0, 0, 6, 0, 255, 255, + 255, 255, 255, 255, 0, 0, + 255, 255, 115, 97, 109, 76, + 105, 110, 101, 97, 114, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 16, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 255, 255, + 255, 255, 26, 9, 47, 241, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 255, 255, 255, 255, + 119, 9, 49, 1, 1, 0, + 0, 0, 13, 0, 0, 142, + 14, 0, 63, 92, 15, 0, + 0, 0, 72, 0, 0, 0, + 32, 0, 0, 0, 44, 0, + 0, 0, 48, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 22, 0, 0, 0, + 25, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 1, 0, + 0, 0, 0, 0, 0, 0, + 100, 0, 0, 0, 32, 0, + 0, 96, 0, 0, 173, 235, + 0, 0, 0, 0, 0, 0, + 0, 0, 2, 0, 9, 0, + 20, 2, 0, 0, 0, 0, + 0, 0, 124, 0, 0, 0, + 1, 0, 0, 0, 120, 75, + 39, 3, 0, 0, 0, 0, + 0, 0, 0, 0, 80, 83, + 0, 110, 111, 110, 101, 0, + 45, 186, 46, 241, 1, 0, + 0, 0, 0, 0, 0, 0, + 100, 0, 0, 0, 32, 0, + 0, 96, 0, 0, 173, 235, + 0, 0, 0, 0, 0, 0, + 0, 0, 2, 0, 2, 0, + 7, 0, 0, 0, 0, 0, + 1, 0, 255, 255, 255, 255, + 0, 0, 0, 0, 100, 0, + 0, 0, 8, 2, 0, 0, + 0, 0, 0, 0, 255, 255, + 255, 255, 0, 0, 0, 0, + 255, 255, 255, 255, 1, 0, + 1, 0, 0, 0, 1, 0, + 0, 0, 0, 0, 68, 58, + 92, 86, 83, 80, 114, 111, + 106, 101, 99, 116, 92, 95, + 68, 88, 71, 73, 92, 80, + 105, 120, 101, 108, 83, 104, + 97, 100, 101, 114, 46, 104, + 108, 115, 108, 0, 254, 239, + 254, 239, 1, 0, 0, 0, + 1, 0, 0, 0, 0, 1, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 12, 0, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 148, 46, + 49, 1, 206, 86, 50, 96, + 1, 0, 0, 0, 111, 244, + 231, 83, 204, 95, 223, 72, + 183, 13, 216, 255, 17, 84, + 173, 235, 81, 0, 0, 0, + 47, 76, 105, 110, 107, 73, + 110, 102, 111, 0, 47, 110, + 97, 109, 101, 115, 0, 47, + 115, 114, 99, 47, 104, 101, + 97, 100, 101, 114, 98, 108, + 111, 99, 107, 0, 47, 115, + 114, 99, 47, 102, 105, 108, + 101, 115, 47, 100, 58, 92, + 118, 115, 112, 114, 111, 106, + 101, 99, 116, 92, 95, 100, + 120, 103, 105, 92, 112, 105, + 120, 101, 108, 115, 104, 97, + 100, 101, 114, 46, 104, 108, + 115, 108, 0, 4, 0, 0, + 0, 6, 0, 0, 0, 1, + 0, 0, 0, 58, 0, 0, + 0, 0, 0, 0, 0, 17, + 0, 0, 0, 7, 0, 0, + 0, 10, 0, 0, 0, 6, + 0, 0, 0, 0, 0, 0, + 0, 5, 0, 0, 0, 34, + 0, 0, 0, 8, 0, 0, + 0, 0, 0, 0, 0, 220, + 81, 51, 1, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 16, 0, 0, 0, 32, 0, + 0, 0, 173, 0, 0, 0, + 36, 1, 0, 0, 51, 1, + 0, 0, 56, 0, 0, 0, + 0, 0, 0, 0, 154, 3, + 0, 0, 128, 0, 0, 0, + 31, 3, 0, 0, 160, 2, + 0, 0, 60, 0, 0, 0, + 0, 0, 0, 0, 40, 0, + 0, 0, 56, 2, 0, 0, + 44, 0, 0, 0, 76, 0, + 0, 0, 3, 0, 0, 0, + 22, 0, 0, 0, 14, 0, + 0, 0, 21, 0, 0, 0, + 15, 0, 0, 0, 10, 0, + 0, 0, 6, 0, 0, 0, + 11, 0, 0, 0, 8, 0, + 0, 0, 9, 0, 0, 0, + 12, 0, 0, 0, 13, 0, + 0, 0, 7, 0, 0, 0, + 16, 0, 0, 0, 17, 0, + 0, 0, 18, 0, 0, 0, + 20, 0, 0, 0, 19, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 23, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 83, 84, 65, 84, + 116, 0, 0, 0, 2, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 2, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 1, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 1, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 82, 68, 69, 70, 148, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 2, 0, + 0, 0, 28, 0, 0, 0, + 0, 4, 255, 255, 5, 1, + 0, 0, 105, 0, 0, 0, + 92, 0, 0, 0, 3, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 1, 0, 0, 0, 1, 0, + 0, 0, 102, 0, 0, 0, + 2, 0, 0, 0, 5, 0, + 0, 0, 4, 0, 0, 0, + 255, 255, 255, 255, 0, 0, + 0, 0, 1, 0, 0, 0, + 13, 0, 0, 0, 115, 97, + 109, 76, 105, 110, 101, 97, + 114, 0, 116, 120, 0, 77, + 105, 99, 114, 111, 115, 111, + 102, 116, 32, 40, 82, 41, + 32, 72, 76, 83, 76, 32, + 83, 104, 97, 100, 101, 114, + 32, 67, 111, 109, 112, 105, + 108, 101, 114, 32, 49, 48, + 46, 49, 0, 171, 171, 171, + 73, 83, 71, 78, 80, 0, + 0, 0, 2, 0, 0, 0, + 8, 0, 0, 0, 56, 0, + 0, 0, 0, 0, 0, 0, + 1, 0, 0, 0, 3, 0, + 0, 0, 0, 0, 0, 0, + 15, 0, 0, 0, 68, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 3, 0, + 0, 0, 1, 0, 0, 0, + 3, 3, 0, 0, 83, 86, + 95, 80, 79, 83, 73, 84, + 73, 79, 78, 0, 84, 69, + 88, 67, 79, 79, 82, 68, + 0, 171, 171, 171, 79, 83, + 71, 78, 44, 0, 0, 0, + 1, 0, 0, 0, 8, 0, + 0, 0, 32, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 3, 0, 0, 0, + 0, 0, 0, 0, 15, 0, + 0, 0, 83, 86, 95, 84, + 97, 114, 103, 101, 116, 0, + 171, 171 +}; diff --git a/PixelShader.hlsl b/PixelShader.hlsl new file mode 100644 index 0000000..db0067d --- /dev/null +++ b/PixelShader.hlsl @@ -0,0 +1,24 @@ +// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF +// ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO +// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A +// PARTICULAR PURPOSE. +// +// Copyright (c) Microsoft Corporation. All rights reserved +//---------------------------------------------------------------------- + +Texture2D tx : register( t0 ); +SamplerState samLinear : register( s0 ); + +struct PS_INPUT +{ + float4 Pos : SV_POSITION; + float2 Tex : TEXCOORD; +}; + +//-------------------------------------------------------------------------------------- +// Pixel Shader +//-------------------------------------------------------------------------------------- +float4 PS(PS_INPUT input) : SV_Target +{ + return tx.Sample( samLinear, input.Tex ); +} \ No newline at end of file diff --git a/ThreadManager.cpp b/ThreadManager.cpp new file mode 100644 index 0000000..0656cb1 --- /dev/null +++ b/ThreadManager.cpp @@ -0,0 +1,258 @@ +// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF +// ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO +// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A +// PARTICULAR PURPOSE. +// +// Copyright (c) Microsoft Corporation. All rights reserved + +#include "ThreadManager.h" + +DWORD WINAPI DDProc(_In_ void* Param); + +THREADMANAGER::THREADMANAGER() : m_ThreadCount(0), + m_ThreadHandles(nullptr), + m_ThreadData(nullptr) +{ + RtlZeroMemory(&m_PtrInfo, sizeof(m_PtrInfo)); +} + +THREADMANAGER::~THREADMANAGER() +{ + Clean(); +} + +// +// Clean up resources +// +void THREADMANAGER::Clean() +{ + if (m_PtrInfo.PtrShapeBuffer) + { + delete [] m_PtrInfo.PtrShapeBuffer; + m_PtrInfo.PtrShapeBuffer = nullptr; + } + RtlZeroMemory(&m_PtrInfo, sizeof(m_PtrInfo)); + + if (m_ThreadHandles) + { + for (UINT i = 0; i < m_ThreadCount; ++i) + { + if (m_ThreadHandles[i]) + { + CloseHandle(m_ThreadHandles[i]); + } + } + delete [] m_ThreadHandles; + m_ThreadHandles = nullptr; + } + + if (m_ThreadData) + { + for (UINT i = 0; i < m_ThreadCount; ++i) + { + CleanDx(&m_ThreadData[i].DxRes); + } + delete [] m_ThreadData; + m_ThreadData = nullptr; + } + + m_ThreadCount = 0; +} + +// +// Clean up DX_RESOURCES +// +void THREADMANAGER::CleanDx(_Inout_ DX_RESOURCES* Data) +{ + if (Data->Device) + { + Data->Device->Release(); + Data->Device = nullptr; + } + + if (Data->Context) + { + Data->Context->Release(); + Data->Context = nullptr; + } + + if (Data->VertexShader) + { + Data->VertexShader->Release(); + Data->VertexShader = nullptr; + } + + if (Data->PixelShader) + { + Data->PixelShader->Release(); + Data->PixelShader = nullptr; + } + + if (Data->InputLayout) + { + Data->InputLayout->Release(); + Data->InputLayout = nullptr; + } + + if (Data->SamplerLinear) + { + Data->SamplerLinear->Release(); + Data->SamplerLinear = nullptr; + } +} + +// +// Start up threads for DDA +// +DUPL_RETURN THREADMANAGER::Initialize(INT SingleOutput, UINT OutputCount, HANDLE UnexpectedErrorEvent, HANDLE ExpectedErrorEvent, HANDLE TerminateThreadsEvent, HANDLE SharedHandle, _In_ RECT* DesktopDim) +{ + m_ThreadCount = OutputCount; + m_ThreadHandles = new (std::nothrow) HANDLE[m_ThreadCount]; + m_ThreadData = new (std::nothrow) THREAD_DATA[m_ThreadCount]; + if (!m_ThreadHandles || !m_ThreadData) + { + return ProcessFailure(nullptr, L"Failed to allocate array for threads", L"Error", E_OUTOFMEMORY); + } + + // Create appropriate # of threads for duplication + DUPL_RETURN Ret = DUPL_RETURN_SUCCESS; + for (UINT i = 0; i < m_ThreadCount; ++i) + { + m_ThreadData[i].UnexpectedErrorEvent = UnexpectedErrorEvent; + m_ThreadData[i].ExpectedErrorEvent = ExpectedErrorEvent; + m_ThreadData[i].TerminateThreadsEvent = TerminateThreadsEvent; + m_ThreadData[i].Output = (SingleOutput < 0) ? i : SingleOutput; + m_ThreadData[i].TexSharedHandle = SharedHandle; + m_ThreadData[i].OffsetX = DesktopDim->left; + m_ThreadData[i].OffsetY = DesktopDim->top; + m_ThreadData[i].PtrInfo = &m_PtrInfo; + + RtlZeroMemory(&m_ThreadData[i].DxRes, sizeof(DX_RESOURCES)); + Ret = InitializeDx(&m_ThreadData[i].DxRes); + if (Ret != DUPL_RETURN_SUCCESS) + { + return Ret; + } + + DWORD ThreadId; + m_ThreadHandles[i] = CreateThread(nullptr, 0, DDProc, &m_ThreadData[i], 0, &ThreadId); + if (m_ThreadHandles[i] == nullptr) + { + return ProcessFailure(nullptr, L"Failed to create thread", L"Error", E_FAIL); + } + } + + return Ret; +} + +// +// Get DX_RESOURCES +// +DUPL_RETURN THREADMANAGER::InitializeDx(_Out_ DX_RESOURCES* Data) +{ + HRESULT hr = S_OK; + + // Driver types supported + D3D_DRIVER_TYPE DriverTypes[] = + { + D3D_DRIVER_TYPE_HARDWARE, + D3D_DRIVER_TYPE_WARP, + D3D_DRIVER_TYPE_REFERENCE, + }; + UINT NumDriverTypes = ARRAYSIZE(DriverTypes); + + // Feature levels supported + D3D_FEATURE_LEVEL FeatureLevels[] = + { + D3D_FEATURE_LEVEL_11_0, + D3D_FEATURE_LEVEL_10_1, + D3D_FEATURE_LEVEL_10_0, + D3D_FEATURE_LEVEL_9_1 + }; + UINT NumFeatureLevels = ARRAYSIZE(FeatureLevels); + + D3D_FEATURE_LEVEL FeatureLevel; + + // Create device + for (UINT DriverTypeIndex = 0; DriverTypeIndex < NumDriverTypes; ++DriverTypeIndex) + { + hr = D3D11CreateDevice(nullptr, DriverTypes[DriverTypeIndex], nullptr, 0, FeatureLevels, NumFeatureLevels, + D3D11_SDK_VERSION, &Data->Device, &FeatureLevel, &Data->Context); + if (SUCCEEDED(hr)) + { + // Device creation success, no need to loop anymore + break; + } + } + if (FAILED(hr)) + { + return ProcessFailure(nullptr, L"Failed to create device in InitializeDx", L"Error", hr); + } + + // VERTEX shader + UINT Size = ARRAYSIZE(g_VS); + hr = Data->Device->CreateVertexShader(g_VS, Size, nullptr, &Data->VertexShader); + if (FAILED(hr)) + { + return ProcessFailure(Data->Device, L"Failed to create vertex shader in InitializeDx", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Input layout + D3D11_INPUT_ELEMENT_DESC Layout[] = + { + {"POSITION", 0, DXGI_FORMAT_R32G32B32_FLOAT, 0, 0, D3D11_INPUT_PER_VERTEX_DATA, 0}, + {"TEXCOORD", 0, DXGI_FORMAT_R32G32_FLOAT, 0, 12, D3D11_INPUT_PER_VERTEX_DATA, 0} + }; + UINT NumElements = ARRAYSIZE(Layout); + hr = Data->Device->CreateInputLayout(Layout, NumElements, g_VS, Size, &Data->InputLayout); + if (FAILED(hr)) + { + return ProcessFailure(Data->Device, L"Failed to create input layout in InitializeDx", L"Error", hr, SystemTransitionsExpectedErrors); + } + Data->Context->IASetInputLayout(Data->InputLayout); + + // Pixel shader + Size = ARRAYSIZE(g_PS); + hr = Data->Device->CreatePixelShader(g_PS, Size, nullptr, &Data->PixelShader); + if (FAILED(hr)) + { + return ProcessFailure(Data->Device, L"Failed to create pixel shader in InitializeDx", L"Error", hr, SystemTransitionsExpectedErrors); + } + + // Set up sampler + D3D11_SAMPLER_DESC SampDesc; + RtlZeroMemory(&SampDesc, sizeof(SampDesc)); + SampDesc.Filter = D3D11_FILTER_MIN_MAG_MIP_LINEAR; + SampDesc.AddressU = D3D11_TEXTURE_ADDRESS_CLAMP; + SampDesc.AddressV = D3D11_TEXTURE_ADDRESS_CLAMP; + SampDesc.AddressW = D3D11_TEXTURE_ADDRESS_CLAMP; + SampDesc.ComparisonFunc = D3D11_COMPARISON_NEVER; + SampDesc.MinLOD = 0; + SampDesc.MaxLOD = D3D11_FLOAT32_MAX; + hr = Data->Device->CreateSamplerState(&SampDesc, &Data->SamplerLinear); + if (FAILED(hr)) + { + return ProcessFailure(Data->Device, L"Failed to create sampler state in InitializeDx", L"Error", hr, SystemTransitionsExpectedErrors); + } + + return DUPL_RETURN_SUCCESS; +} + +// +// Getter for the PTR_INFO structure +// +PTR_INFO* THREADMANAGER::GetPointerInfo() +{ + return &m_PtrInfo; +} + +// +// Waits infinitely for all spawned threads to terminate +// +void THREADMANAGER::WaitForThreadTermination() +{ + if (m_ThreadCount != 0) + { + WaitForMultipleObjectsEx(m_ThreadCount, m_ThreadHandles, TRUE, INFINITE, FALSE); + } +} diff --git a/ThreadManager.h b/ThreadManager.h new file mode 100644 index 0000000..9e4681a --- /dev/null +++ b/ThreadManager.h @@ -0,0 +1,33 @@ +// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF +// ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO +// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A +// PARTICULAR PURPOSE. +// +// Copyright (c) Microsoft Corporation. All rights reserved + +#ifndef _THREADMANAGER_H_ +#define _THREADMANAGER_H_ + +#include "CommonTypes.h" + +class THREADMANAGER +{ + public: + THREADMANAGER(); + ~THREADMANAGER(); + void Clean(); + DUPL_RETURN Initialize(INT SingleOutput, UINT OutputCount, HANDLE UnexpectedErrorEvent, HANDLE ExpectedErrorEvent, HANDLE TerminateThreadsEvent, HANDLE SharedHandle, _In_ RECT* DesktopDim); + PTR_INFO* GetPointerInfo(); + void WaitForThreadTermination(); + + private: + DUPL_RETURN InitializeDx(_Out_ DX_RESOURCES* Data); + void CleanDx(_Inout_ DX_RESOURCES* Data); + + PTR_INFO m_PtrInfo; + UINT m_ThreadCount; + _Field_size_(m_ThreadCount) HANDLE* m_ThreadHandles; + _Field_size_(m_ThreadCount) THREAD_DATA* m_ThreadData; +}; + +#endif diff --git a/VertexShader.h b/VertexShader.h new file mode 100644 index 0000000..9c83c6b --- /dev/null +++ b/VertexShader.h @@ -0,0 +1,2559 @@ +#if 0 +// +// Generated by Microsoft (R) HLSL Shader Compiler 10.1 +// +// +// +// Input signature: +// +// Name Index Mask Register SysValue Format Used +// -------------------- ----- ------ -------- -------- ------- ------ +// POSITION 0 xyzw 0 NONE float xyzw +// TEXCOORD 0 xy 1 NONE float xy +// +// +// Output signature: +// +// Name Index Mask Register SysValue Format Used +// -------------------- ----- ------ -------- -------- ------- ------ +// SV_POSITION 0 xyzw 0 POS float xyzw +// TEXCOORD 0 xy 1 NONE float xy +// +// +// Runtime generated constant mappings: +// +// Target Reg Constant Description +// ---------- -------------------------------------------------- +// c0 Vertex Shader position offset +// +// +// Level9 shader bytecode: +// + vs_2_0 + dcl_texcoord v0 // input<0,1,2,3> + dcl_texcoord1 v1 // input<4,5> + +#line 27 "D:\VSProject\_DXGI\VertexShader.hlsl" + mov r0.xy, v0 // ::VS<0,1> + mov r0.zw, v0 // ::VS<2,3> + mov oT0.xy, v1 // ::VS<4,5> + mul r1.xy, r0.w, c0 + add oPos.xy, r0, r1 // ::VS<0,1> + mov oPos.zw, r0 // ::VS<2,3> + +// approximately 6 instruction slots used +vs_4_0 +dcl_input v0.xyzw +dcl_input v1.xy +dcl_output_siv o0.xyzw, position +dcl_output o1.xy +// +// Initial variable locations: +// v0.x <- input.Pos.x; v0.y <- input.Pos.y; v0.z <- input.Pos.z; v0.w <- input.Pos.w; +// v1.x <- input.Tex.x; v1.y <- input.Tex.y; +// o1.x <- .Tex.x; o1.y <- .Tex.y; +// o0.x <- .Pos.x; o0.y <- .Pos.y; o0.z <- .Pos.z; o0.w <- .Pos.w +// +#line 27 "D:\VSProject\_DXGI\VertexShader.hlsl" +mov o0.xyzw, v0.xyzw +mov o1.xy, v1.xyxx +ret +// Approximately 3 instruction slots used +#endif + +const BYTE g_VS[] = +{ + 68, 88, 66, 67, 190, 223, + 46, 224, 109, 97, 87, 59, + 207, 21, 90, 21, 138, 12, + 71, 119, 1, 0, 0, 0, + 108, 58, 0, 0, 7, 0, + 0, 0, 60, 0, 0, 0, + 128, 2, 0, 0, 240, 2, + 0, 0, 248, 56, 0, 0, + 116, 57, 0, 0, 192, 57, + 0, 0, 20, 58, 0, 0, + 65, 111, 110, 57, 60, 2, + 0, 0, 60, 2, 0, 0, + 0, 2, 254, 255, 20, 2, + 0, 0, 40, 0, 0, 0, + 0, 0, 36, 0, 0, 0, + 36, 0, 0, 0, 36, 0, + 0, 0, 36, 0, 1, 0, + 36, 0, 0, 0, 0, 0, + 0, 2, 254, 255, 254, 255, + 104, 0, 68, 66, 85, 71, + 40, 0, 0, 0, 116, 1, + 0, 0, 0, 0, 0, 0, + 1, 0, 0, 0, 80, 0, + 0, 0, 8, 0, 0, 0, + 84, 0, 0, 0, 2, 0, + 0, 0, 76, 1, 0, 0, + 148, 0, 0, 0, 68, 58, + 92, 86, 83, 80, 114, 111, + 106, 101, 99, 116, 92, 95, + 68, 88, 71, 73, 92, 86, + 101, 114, 116, 101, 120, 83, + 104, 97, 100, 101, 114, 46, + 104, 108, 115, 108, 0, 171, + 171, 171, 40, 0, 0, 0, + 0, 0, 255, 255, 168, 1, + 0, 0, 0, 0, 255, 255, + 180, 1, 0, 0, 27, 0, + 0, 0, 192, 1, 0, 0, + 27, 0, 0, 0, 204, 1, + 0, 0, 27, 0, 0, 0, + 216, 1, 0, 0, 25, 0, + 0, 0, 228, 1, 0, 0, + 25, 0, 0, 0, 244, 1, + 0, 0, 25, 0, 0, 0, + 4, 2, 0, 0, 86, 83, + 0, 80, 111, 115, 0, 171, + 1, 0, 3, 0, 1, 0, + 4, 0, 1, 0, 0, 0, + 0, 0, 0, 0, 84, 101, + 120, 0, 1, 0, 3, 0, + 1, 0, 2, 0, 1, 0, + 0, 0, 0, 0, 0, 0, + 151, 0, 0, 0, 156, 0, + 0, 0, 172, 0, 0, 0, + 176, 0, 0, 0, 5, 0, + 0, 0, 1, 0, 6, 0, + 1, 0, 2, 0, 192, 0, + 0, 0, 2, 0, 0, 0, + 0, 0, 1, 0, 255, 255, + 255, 255, 3, 0, 0, 0, + 255, 255, 255, 255, 2, 0, + 3, 0, 4, 0, 0, 0, + 4, 0, 5, 0, 255, 255, + 255, 255, 6, 0, 0, 0, + 0, 0, 1, 0, 255, 255, + 255, 255, 7, 0, 0, 0, + 255, 255, 255, 255, 2, 0, + 3, 0, 105, 110, 112, 117, + 116, 0, 171, 171, 5, 0, + 0, 0, 1, 0, 6, 0, + 1, 0, 2, 0, 192, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 1, 0, 2, 0, + 3, 0, 1, 0, 0, 0, + 4, 0, 5, 0, 255, 255, + 255, 255, 0, 0, 0, 0, + 148, 0, 0, 0, 208, 0, + 0, 0, 5, 0, 0, 0, + 224, 0, 0, 0, 148, 0, + 0, 0, 28, 1, 0, 0, + 36, 1, 0, 0, 2, 0, + 0, 0, 52, 1, 0, 0, + 77, 105, 99, 114, 111, 115, + 111, 102, 116, 32, 40, 82, + 41, 32, 72, 76, 83, 76, + 32, 83, 104, 97, 100, 101, + 114, 32, 67, 111, 109, 112, + 105, 108, 101, 114, 32, 49, + 48, 46, 49, 0, 31, 0, + 0, 2, 5, 0, 0, 128, + 0, 0, 15, 144, 31, 0, + 0, 2, 5, 0, 1, 128, + 1, 0, 15, 144, 1, 0, + 0, 2, 0, 0, 3, 128, + 0, 0, 228, 144, 1, 0, + 0, 2, 0, 0, 12, 128, + 0, 0, 228, 144, 1, 0, + 0, 2, 0, 0, 3, 224, + 1, 0, 228, 144, 5, 0, + 0, 3, 1, 0, 3, 128, + 0, 0, 255, 128, 0, 0, + 228, 160, 2, 0, 0, 3, + 0, 0, 3, 192, 0, 0, + 228, 128, 1, 0, 228, 128, + 1, 0, 0, 2, 0, 0, + 12, 192, 0, 0, 228, 128, + 255, 255, 0, 0, 83, 72, + 68, 82, 104, 0, 0, 0, + 64, 0, 1, 0, 26, 0, + 0, 0, 95, 0, 0, 3, + 242, 16, 16, 0, 0, 0, + 0, 0, 95, 0, 0, 3, + 50, 16, 16, 0, 1, 0, + 0, 0, 103, 0, 0, 4, + 242, 32, 16, 0, 0, 0, + 0, 0, 1, 0, 0, 0, + 101, 0, 0, 3, 50, 32, + 16, 0, 1, 0, 0, 0, + 54, 0, 0, 5, 242, 32, + 16, 0, 0, 0, 0, 0, + 70, 30, 16, 0, 0, 0, + 0, 0, 54, 0, 0, 5, + 50, 32, 16, 0, 1, 0, + 0, 0, 70, 16, 16, 0, + 1, 0, 0, 0, 62, 0, + 0, 1, 83, 80, 68, 66, + 0, 54, 0, 0, 77, 105, + 99, 114, 111, 115, 111, 102, + 116, 32, 67, 47, 67, 43, + 43, 32, 77, 83, 70, 32, + 55, 46, 48, 48, 13, 10, + 26, 68, 83, 0, 0, 0, + 0, 2, 0, 0, 2, 0, + 0, 0, 27, 0, 0, 0, + 140, 0, 0, 0, 0, 0, + 0, 0, 24, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 192, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 56, 0, 0, 254, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 255, 5, 0, + 0, 0, 32, 0, 0, 0, + 60, 0, 0, 0, 0, 0, + 0, 0, 255, 255, 255, 255, + 0, 0, 0, 0, 6, 0, + 0, 0, 5, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 3, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 148, 46, 49, 1, + 206, 86, 50, 96, 1, 0, + 0, 0, 130, 3, 189, 93, + 106, 223, 197, 67, 172, 36, + 94, 225, 91, 193, 168, 184, + 0, 0, 0, 0, 0, 0, + 0, 0, 1, 0, 0, 0, + 1, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 220, 81, + 51, 1, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 120, 32, + 58, 32, 84, 69, 88, 67, + 79, 79, 82, 68, 59, 10, + 125, 59, 10, 10, 115, 116, + 114, 117, 99, 116, 32, 86, + 83, 95, 79, 85, 84, 80, + 85, 84, 10, 123, 10, 32, + 32, 32, 32, 102, 108, 111, + 97, 116, 52, 32, 80, 111, + 115, 32, 58, 32, 83, 86, + 95, 80, 79, 83, 73, 84, + 73, 79, 78, 59, 10, 32, + 32, 32, 32, 102, 108, 111, + 97, 116, 50, 32, 84, 101, + 120, 32, 58, 32, 84, 69, + 88, 67, 79, 79, 82, 68, + 59, 10, 125, 59, 10, 10, + 10, 47, 47, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 10, + 47, 47, 32, 86, 101, 114, + 116, 101, 120, 32, 83, 104, + 97, 100, 101, 114, 10, 47, + 47, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 10, 86, 83, + 95, 79, 85, 84, 80, 85, + 84, 32, 86, 83, 40, 86, + 83, 95, 73, 78, 80, 85, + 84, 32, 105, 110, 112, 117, + 116, 41, 10, 123, 10, 32, + 32, 32, 32, 114, 101, 116, + 117, 114, 110, 32, 105, 110, + 112, 117, 116, 59, 10, 125, + 0, 7, 0, 0, 0, 1, + 0, 0, 0, 38, 0, 0, + 0, 39, 0, 0, 0, 76, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 4, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 198, 90, 0, 0, 117, 131, + 1, 0, 156, 39, 3, 0, + 156, 202, 1, 0, 38, 247, + 2, 0, 69, 103, 0, 0, + 109, 24, 1, 0, 248, 34, + 2, 0, 0, 16, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 47, 47, 32, 84, + 72, 73, 83, 32, 67, 79, + 68, 69, 32, 65, 78, 68, + 32, 73, 78, 70, 79, 82, + 77, 65, 84, 73, 79, 78, + 32, 73, 83, 32, 80, 82, + 79, 86, 73, 68, 69, 68, + 32, 34, 65, 83, 32, 73, + 83, 34, 32, 87, 73, 84, + 72, 79, 85, 84, 32, 87, + 65, 82, 82, 65, 78, 84, + 89, 32, 79, 70, 10, 47, + 47, 32, 65, 78, 89, 32, + 75, 73, 78, 68, 44, 32, + 69, 73, 84, 72, 69, 82, + 32, 69, 88, 80, 82, 69, + 83, 83, 69, 68, 32, 79, + 82, 32, 73, 77, 80, 76, + 73, 69, 68, 44, 32, 73, + 78, 67, 76, 85, 68, 73, + 78, 71, 32, 66, 85, 84, + 32, 78, 79, 84, 32, 76, + 73, 77, 73, 84, 69, 68, + 32, 84, 79, 10, 47, 47, + 32, 84, 72, 69, 32, 73, + 77, 80, 76, 73, 69, 68, + 32, 87, 65, 82, 82, 65, + 78, 84, 73, 69, 83, 32, + 79, 70, 32, 77, 69, 82, + 67, 72, 65, 78, 84, 65, + 66, 73, 76, 73, 84, 89, + 32, 65, 78, 68, 47, 79, + 82, 32, 70, 73, 84, 78, + 69, 83, 83, 32, 70, 79, + 82, 32, 65, 10, 47, 47, + 32, 80, 65, 82, 84, 73, + 67, 85, 76, 65, 82, 32, + 80, 85, 82, 80, 79, 83, + 69, 46, 10, 47, 47, 10, + 47, 47, 32, 67, 111, 112, + 121, 114, 105, 103, 104, 116, + 32, 40, 99, 41, 32, 77, + 105, 99, 114, 111, 115, 111, + 102, 116, 32, 67, 111, 114, + 112, 111, 114, 97, 116, 105, + 111, 110, 46, 32, 65, 108, + 108, 32, 114, 105, 103, 104, + 116, 115, 32, 114, 101, 115, + 101, 114, 118, 101, 100, 10, + 47, 47, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 10, 10, 115, 116, 114, 117, + 99, 116, 32, 86, 83, 95, + 73, 78, 80, 85, 84, 10, + 123, 10, 32, 32, 32, 32, + 102, 108, 111, 97, 116, 52, + 32, 80, 111, 115, 32, 58, + 32, 80, 79, 83, 73, 84, + 73, 79, 78, 59, 10, 32, + 32, 32, 32, 102, 108, 111, + 97, 116, 50, 32, 84, 101, + 120, 32, 58, 32, 84, 69, + 88, 67, 79, 79, 82, 68, + 59, 10, 125, 59, 10, 10, + 115, 116, 114, 117, 99, 116, + 32, 86, 83, 95, 79, 85, + 84, 80, 85, 84, 10, 123, + 10, 32, 32, 32, 32, 102, + 108, 111, 97, 116, 52, 32, + 80, 111, 115, 32, 58, 32, + 83, 86, 95, 80, 79, 83, + 73, 84, 73, 79, 78, 59, + 10, 32, 32, 32, 32, 102, + 108, 111, 97, 116, 50, 32, + 84, 101, 120, 32, 58, 32, + 84, 69, 88, 67, 79, 79, + 82, 68, 59, 10, 125, 59, + 10, 10, 10, 47, 47, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 10, 47, 47, 32, 86, + 101, 114, 116, 101, 120, 32, + 83, 104, 97, 100, 101, 114, + 10, 47, 47, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 10, + 86, 83, 95, 79, 85, 84, + 80, 85, 84, 32, 86, 83, + 40, 86, 83, 95, 73, 78, + 80, 85, 84, 32, 105, 110, + 112, 117, 116, 41, 10, 123, + 10, 32, 32, 32, 32, 114, + 101, 116, 117, 114, 110, 32, + 105, 110, 112, 117, 116, 59, + 10, 125, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 254, 239, 254, 239, 1, 0, + 0, 0, 77, 3, 0, 0, + 0, 68, 58, 92, 86, 83, + 80, 114, 111, 106, 101, 99, + 116, 92, 95, 68, 88, 71, + 73, 92, 86, 101, 114, 116, + 101, 120, 83, 104, 97, 100, + 101, 114, 46, 104, 108, 115, + 108, 0, 0, 100, 58, 92, + 118, 115, 112, 114, 111, 106, + 101, 99, 116, 92, 95, 100, + 120, 103, 105, 92, 118, 101, + 114, 116, 101, 120, 115, 104, + 97, 100, 101, 114, 46, 104, + 108, 115, 108, 0, 47, 47, + 32, 84, 72, 73, 83, 32, + 67, 79, 68, 69, 32, 65, + 78, 68, 32, 73, 78, 70, + 79, 82, 77, 65, 84, 73, + 79, 78, 32, 73, 83, 32, + 80, 82, 79, 86, 73, 68, + 69, 68, 32, 34, 65, 83, + 32, 73, 83, 34, 32, 87, + 73, 84, 72, 79, 85, 84, + 32, 87, 65, 82, 82, 65, + 78, 84, 89, 32, 79, 70, + 10, 47, 47, 32, 65, 78, + 89, 32, 75, 73, 78, 68, + 44, 32, 69, 73, 84, 72, + 69, 82, 32, 69, 88, 80, + 82, 69, 83, 83, 69, 68, + 32, 79, 82, 32, 73, 77, + 80, 76, 73, 69, 68, 44, + 32, 73, 78, 67, 76, 85, + 68, 73, 78, 71, 32, 66, + 85, 84, 32, 78, 79, 84, + 32, 76, 73, 77, 73, 84, + 69, 68, 32, 84, 79, 10, + 47, 47, 32, 84, 72, 69, + 32, 73, 77, 80, 76, 73, + 69, 68, 32, 87, 65, 82, + 82, 65, 78, 84, 73, 69, + 83, 32, 79, 70, 32, 77, + 69, 82, 67, 72, 65, 78, + 84, 65, 66, 73, 76, 73, + 84, 89, 32, 65, 78, 68, + 47, 79, 82, 32, 70, 73, + 84, 78, 69, 83, 83, 32, + 70, 79, 82, 32, 65, 10, + 47, 47, 32, 80, 65, 82, + 84, 73, 67, 85, 76, 65, + 82, 32, 80, 85, 82, 80, + 79, 83, 69, 46, 10, 47, + 47, 10, 47, 47, 32, 67, + 111, 112, 121, 114, 105, 103, + 104, 116, 32, 40, 99, 41, + 32, 77, 105, 99, 114, 111, + 115, 111, 102, 116, 32, 67, + 111, 114, 112, 111, 114, 97, + 116, 105, 111, 110, 46, 32, + 65, 108, 108, 32, 114, 105, + 103, 104, 116, 115, 32, 114, + 101, 115, 101, 114, 118, 101, + 100, 10, 47, 47, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 45, 45, 45, 45, + 45, 45, 10, 10, 115, 116, + 114, 117, 99, 116, 32, 86, + 83, 95, 73, 78, 80, 85, + 84, 10, 123, 10, 32, 32, + 32, 32, 102, 108, 111, 97, + 116, 52, 32, 80, 111, 115, + 32, 58, 32, 80, 79, 83, + 73, 84, 73, 79, 78, 59, + 10, 32, 32, 32, 32, 102, + 108, 111, 97, 116, 50, 32, + 84, 101, 27, 226, 48, 1, + 128, 0, 0, 0, 86, 71, + 176, 247, 79, 8, 215, 1, + 1, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 1, 0, 0, 0, 2, 0, + 0, 0, 1, 0, 0, 0, + 2, 0, 0, 0, 0, 0, + 0, 0, 39, 0, 0, 0, + 40, 0, 0, 0, 27, 226, + 48, 1, 201, 78, 212, 238, + 0, 3, 0, 0, 1, 0, + 0, 0, 38, 0, 0, 0, + 39, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 4, 0, + 0, 0, 66, 0, 60, 17, + 16, 1, 0, 0, 0, 1, + 10, 0, 1, 0, 1, 0, + 186, 71, 10, 0, 1, 0, + 1, 0, 186, 71, 77, 105, + 99, 114, 111, 115, 111, 102, + 116, 32, 40, 82, 41, 32, + 72, 76, 83, 76, 32, 83, + 104, 97, 100, 101, 114, 32, + 67, 111, 109, 112, 105, 108, + 101, 114, 32, 49, 48, 46, + 49, 0, 0, 0, 62, 0, + 61, 17, 1, 104, 108, 115, + 108, 70, 108, 97, 103, 115, + 0, 48, 120, 53, 0, 104, + 108, 115, 108, 84, 97, 114, + 103, 101, 116, 0, 118, 115, + 95, 52, 95, 48, 95, 108, + 101, 118, 101, 108, 95, 57, + 95, 49, 0, 104, 108, 115, + 108, 69, 110, 116, 114, 121, + 0, 86, 83, 0, 0, 0, + 0, 0, 42, 0, 16, 17, + 0, 0, 0, 0, 64, 2, + 0, 0, 0, 0, 0, 0, + 44, 0, 0, 0, 0, 0, + 0, 0, 44, 0, 0, 0, + 7, 16, 0, 0, 60, 0, + 0, 0, 1, 0, 160, 86, + 83, 0, 0, 0, 46, 0, + 62, 17, 3, 16, 0, 0, + 9, 0, 105, 110, 112, 117, + 116, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 22, 0, + 80, 17, 1, 0, 5, 0, + 0, 0, 4, 0, 60, 0, + 0, 0, 1, 0, 44, 0, + 0, 0, 0, 0, 22, 0, + 80, 17, 1, 0, 5, 0, + 4, 0, 4, 0, 60, 0, + 0, 0, 1, 0, 44, 0, + 4, 0, 0, 0, 22, 0, + 80, 17, 1, 0, 5, 0, + 8, 0, 4, 0, 60, 0, + 0, 0, 1, 0, 44, 0, + 8, 0, 0, 0, 22, 0, + 80, 17, 1, 0, 5, 0, + 12, 0, 4, 0, 60, 0, + 0, 0, 1, 0, 44, 0, + 12, 0, 0, 0, 22, 0, + 80, 17, 1, 0, 5, 0, + 16, 0, 4, 0, 60, 0, + 0, 0, 1, 0, 44, 0, + 16, 0, 0, 0, 22, 0, + 80, 17, 1, 0, 5, 0, + 20, 0, 4, 0, 60, 0, + 0, 0, 1, 0, 44, 0, + 20, 0, 0, 0, 58, 0, + 62, 17, 6, 16, 0, 0, + 136, 0, 60, 86, 83, 32, + 114, 101, 116, 117, 114, 110, + 32, 118, 97, 108, 117, 101, + 62, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 22, 0, + 80, 17, 2, 0, 5, 0, + 16, 0, 4, 0, 60, 0, + 0, 0, 1, 0, 44, 0, + 16, 0, 0, 0, 22, 0, + 80, 17, 2, 0, 5, 0, + 20, 0, 4, 0, 60, 0, + 0, 0, 1, 0, 44, 0, + 20, 0, 0, 0, 22, 0, + 80, 17, 2, 0, 5, 0, + 0, 0, 4, 0, 60, 0, + 0, 0, 1, 0, 44, 0, + 0, 0, 0, 0, 22, 0, + 80, 17, 2, 0, 5, 0, + 4, 0, 4, 0, 60, 0, + 0, 0, 1, 0, 44, 0, + 4, 0, 0, 0, 22, 0, + 80, 17, 2, 0, 5, 0, + 8, 0, 4, 0, 60, 0, + 0, 0, 1, 0, 44, 0, + 8, 0, 0, 0, 22, 0, + 80, 17, 2, 0, 5, 0, + 12, 0, 4, 0, 60, 0, + 0, 0, 1, 0, 44, 0, + 12, 0, 0, 0, 2, 0, + 6, 0, 244, 0, 0, 0, + 24, 0, 0, 0, 1, 0, + 0, 0, 16, 1, 178, 37, + 188, 176, 111, 231, 80, 102, + 63, 86, 127, 87, 237, 16, + 162, 139, 0, 0, 242, 0, + 0, 0, 96, 0, 0, 0, + 0, 0, 0, 0, 1, 0, + 1, 0, 104, 0, 0, 0, + 0, 0, 0, 0, 6, 0, + 0, 0, 84, 0, 0, 0, + 60, 0, 0, 0, 27, 0, + 0, 128, 60, 0, 0, 0, + 27, 0, 0, 0, 80, 0, + 0, 0, 27, 0, 0, 128, + 80, 0, 0, 0, 27, 0, + 0, 0, 100, 0, 0, 0, + 27, 0, 0, 128, 100, 0, + 0, 0, 27, 0, 0, 0, + 5, 0, 17, 0, 5, 0, + 17, 0, 5, 0, 17, 0, + 5, 0, 17, 0, 5, 0, + 17, 0, 5, 0, 17, 0, + 246, 0, 0, 0, 4, 0, + 0, 0, 0, 0, 0, 0, + 4, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 11, 202, 49, 1, + 56, 0, 0, 0, 0, 16, + 0, 0, 8, 16, 0, 0, + 188, 0, 0, 0, 10, 0, + 255, 255, 4, 0, 0, 0, + 255, 255, 3, 0, 0, 0, + 0, 0, 32, 0, 0, 0, + 32, 0, 0, 0, 8, 0, + 0, 0, 40, 0, 0, 0, + 0, 0, 0, 0, 22, 0, + 27, 21, 64, 0, 0, 0, + 4, 0, 0, 0, 16, 0, + 102, 108, 111, 97, 116, 52, + 0, 243, 242, 241, 22, 0, + 27, 21, 64, 0, 0, 0, + 2, 0, 0, 0, 8, 0, + 102, 108, 111, 97, 116, 50, + 0, 243, 242, 241, 34, 0, + 3, 18, 13, 21, 3, 0, + 0, 16, 0, 0, 0, 0, + 80, 111, 115, 0, 242, 241, + 13, 21, 3, 0, 1, 16, + 0, 0, 16, 0, 84, 101, + 120, 0, 242, 241, 30, 0, + 5, 21, 2, 0, 0, 0, + 2, 16, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 24, 0, 86, 83, 95, 73, + 78, 80, 85, 84, 0, 241, + 10, 0, 1, 18, 1, 0, + 0, 0, 3, 16, 0, 0, + 30, 0, 5, 21, 2, 0, + 0, 0, 2, 16, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 24, 0, 86, 83, + 95, 79, 85, 84, 80, 85, + 84, 0, 10, 0, 24, 21, + 5, 16, 0, 0, 1, 0, + 1, 0, 14, 0, 8, 16, + 6, 16, 0, 0, 23, 0, + 1, 0, 4, 16, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 11, 202, + 49, 1, 56, 0, 0, 0, + 0, 16, 0, 0, 0, 16, + 0, 0, 0, 0, 0, 0, + 11, 0, 255, 255, 4, 0, + 0, 0, 255, 255, 3, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 68, 51, 68, 83, 72, 68, + 82, 0, 104, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 32, 0, 0, 96, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 255, 255, 255, 255, + 26, 9, 47, 241, 8, 0, + 0, 0, 8, 2, 0, 0, + 1, 0, 0, 0, 1, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 16, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 18, 0, 37, 17, 0, 0, + 0, 0, 136, 0, 0, 0, + 1, 0, 86, 83, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 255, 255, + 255, 255, 26, 9, 47, 241, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 16, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 255, 255, 255, 255, 26, 9, + 47, 241, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 255, 255, + 255, 255, 119, 9, 49, 1, + 1, 0, 0, 0, 13, 0, + 0, 142, 14, 0, 63, 92, + 15, 0, 0, 0, 72, 0, + 0, 0, 32, 0, 0, 0, + 44, 0, 0, 0, 52, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 22, 0, + 0, 0, 25, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 1, 0, 0, 0, 0, 0, + 0, 0, 104, 0, 0, 0, + 32, 0, 0, 96, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 2, 0, + 9, 0, 68, 2, 0, 0, + 0, 0, 0, 0, 148, 0, + 0, 0, 1, 0, 0, 0, + 232, 160, 46, 3, 0, 0, + 0, 0, 0, 0, 0, 0, + 86, 83, 0, 110, 111, 110, + 101, 0, 45, 186, 46, 241, + 1, 0, 0, 0, 0, 0, + 0, 0, 104, 0, 0, 0, + 32, 0, 0, 96, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 2, 0, + 2, 0, 7, 0, 0, 0, + 0, 0, 1, 0, 255, 255, + 255, 255, 0, 0, 0, 0, + 104, 0, 0, 0, 8, 2, + 0, 0, 0, 0, 0, 0, + 255, 255, 255, 255, 0, 0, + 0, 0, 255, 255, 255, 255, + 1, 0, 1, 0, 0, 0, + 1, 0, 0, 0, 0, 0, + 68, 58, 92, 86, 83, 80, + 114, 111, 106, 101, 99, 116, + 92, 95, 68, 88, 71, 73, + 92, 86, 101, 114, 116, 101, + 120, 83, 104, 97, 100, 101, + 114, 46, 104, 108, 115, 108, + 0, 0, 0, 0, 254, 239, + 254, 239, 1, 0, 0, 0, + 1, 0, 0, 0, 0, 1, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 12, 0, 255, + 255, 255, 255, 255, 255, 255, + 255, 255, 255, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 148, 46, 49, 1, 206, 86, + 50, 96, 1, 0, 0, 0, + 130, 3, 189, 93, 106, 223, + 197, 67, 172, 36, 94, 225, + 91, 193, 168, 184, 82, 0, + 0, 0, 47, 76, 105, 110, + 107, 73, 110, 102, 111, 0, + 47, 110, 97, 109, 101, 115, + 0, 47, 115, 114, 99, 47, + 104, 101, 97, 100, 101, 114, + 98, 108, 111, 99, 107, 0, + 47, 115, 114, 99, 47, 102, + 105, 108, 101, 115, 47, 100, + 58, 92, 118, 115, 112, 114, + 111, 106, 101, 99, 116, 92, + 95, 100, 120, 103, 105, 92, + 118, 101, 114, 116, 101, 120, + 115, 104, 97, 100, 101, 114, + 46, 104, 108, 115, 108, 0, + 4, 0, 0, 0, 6, 0, + 0, 0, 1, 0, 0, 0, + 30, 0, 0, 0, 0, 0, + 0, 0, 17, 0, 0, 0, + 7, 0, 0, 0, 34, 0, + 0, 0, 8, 0, 0, 0, + 10, 0, 0, 0, 6, 0, + 0, 0, 0, 0, 0, 0, + 5, 0, 0, 0, 0, 0, + 0, 0, 220, 81, 51, 1, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 16, 0, 0, 0, + 32, 0, 0, 0, 174, 0, + 0, 0, 244, 0, 0, 0, + 55, 1, 0, 0, 56, 0, + 0, 0, 0, 0, 0, 0, + 125, 3, 0, 0, 128, 0, + 0, 0, 0, 3, 0, 0, + 224, 2, 0, 0, 40, 0, + 0, 0, 0, 0, 0, 0, + 40, 0, 0, 0, 32, 2, + 0, 0, 44, 0, 0, 0, + 20, 0, 0, 0, 3, 0, + 0, 0, 22, 0, 0, 0, + 14, 0, 0, 0, 21, 0, + 0, 0, 15, 0, 0, 0, + 10, 0, 0, 0, 6, 0, + 0, 0, 11, 0, 0, 0, + 8, 0, 0, 0, 9, 0, + 0, 0, 12, 0, 0, 0, + 13, 0, 0, 0, 7, 0, + 0, 0, 16, 0, 0, 0, + 17, 0, 0, 0, 18, 0, + 0, 0, 20, 0, 0, 0, + 19, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 23, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 83, 84, + 65, 84, 116, 0, 0, 0, + 3, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 4, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 1, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 2, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 82, 68, 69, 70, + 68, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 28, 0, + 0, 0, 0, 4, 254, 255, + 5, 1, 0, 0, 28, 0, + 0, 0, 77, 105, 99, 114, + 111, 115, 111, 102, 116, 32, + 40, 82, 41, 32, 72, 76, + 83, 76, 32, 83, 104, 97, + 100, 101, 114, 32, 67, 111, + 109, 112, 105, 108, 101, 114, + 32, 49, 48, 46, 49, 0, + 73, 83, 71, 78, 76, 0, + 0, 0, 2, 0, 0, 0, + 8, 0, 0, 0, 56, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 3, 0, + 0, 0, 0, 0, 0, 0, + 15, 15, 0, 0, 65, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 3, 0, + 0, 0, 1, 0, 0, 0, + 3, 3, 0, 0, 80, 79, + 83, 73, 84, 73, 79, 78, + 0, 84, 69, 88, 67, 79, + 79, 82, 68, 0, 171, 171, + 79, 83, 71, 78, 80, 0, + 0, 0, 2, 0, 0, 0, + 8, 0, 0, 0, 56, 0, + 0, 0, 0, 0, 0, 0, + 1, 0, 0, 0, 3, 0, + 0, 0, 0, 0, 0, 0, + 15, 0, 0, 0, 68, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 3, 0, + 0, 0, 1, 0, 0, 0, + 3, 12, 0, 0, 83, 86, + 95, 80, 79, 83, 73, 84, + 73, 79, 78, 0, 84, 69, + 88, 67, 79, 79, 82, 68, + 0, 171, 171, 171 +}; diff --git a/VertexShader.hlsl b/VertexShader.hlsl new file mode 100644 index 0000000..95f9435 --- /dev/null +++ b/VertexShader.hlsl @@ -0,0 +1,28 @@ +// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF +// ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO +// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A +// PARTICULAR PURPOSE. +// +// Copyright (c) Microsoft Corporation. All rights reserved +//---------------------------------------------------------------------- + +struct VS_INPUT +{ + float4 Pos : POSITION; + float2 Tex : TEXCOORD; +}; + +struct VS_OUTPUT +{ + float4 Pos : SV_POSITION; + float2 Tex : TEXCOORD; +}; + + +//-------------------------------------------------------------------------------------- +// Vertex Shader +//-------------------------------------------------------------------------------------- +VS_OUTPUT VS(VS_INPUT input) +{ + return input; +} \ No newline at end of file diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avcodec-58.dll b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avcodec-58.dll new file mode 100644 index 0000000..5818cc9 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avcodec-58.dll differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avdevice-58.dll b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avdevice-58.dll new file mode 100644 index 0000000..50d3c06 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avdevice-58.dll differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avfilter-7.dll b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avfilter-7.dll new file mode 100644 index 0000000..064942d Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avfilter-7.dll differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avformat-58.dll b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avformat-58.dll new file mode 100644 index 0000000..0a91942 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avformat-58.dll differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avutil-56.dll b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avutil-56.dll new file mode 100644 index 0000000..96eac67 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/avutil-56.dll differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/ffmpeg.exe b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/ffmpeg.exe new file mode 100644 index 0000000..b3948d2 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/ffmpeg.exe differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/ffplay.exe b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/ffplay.exe new file mode 100644 index 0000000..aa91a78 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/ffplay.exe differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/ffprobe.exe b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/ffprobe.exe new file mode 100644 index 0000000..932eba1 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/ffprobe.exe differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/postproc-55.dll b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/postproc-55.dll new file mode 100644 index 0000000..c84de40 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/postproc-55.dll differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/swresample-3.dll b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/swresample-3.dll new file mode 100644 index 0000000..5b8faa5 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/swresample-3.dll differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/swscale-5.dll b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/swscale-5.dll new file mode 100644 index 0000000..7669110 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/bin/swscale-5.dll differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/developer.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/developer.html new file mode 100644 index 0000000..15dc0ae --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/developer.html @@ -0,0 +1,863 @@ + + + + + + + Developer Documentation + + + + + + +
+

+ Developer Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Notes for external developers

+ +

This document is mostly useful for internal FFmpeg developers. +External developers who need to use the API in their application should +refer to the API doxygen documentation in the public headers, and +check the examples in doc/examples and in the source code to +see how the public API is employed. +

+

You can use the FFmpeg libraries in your commercial program, but you +are encouraged to publish any patch you make. In this case the +best way to proceed is to send your patches to the ffmpeg-devel +mailing list following the guidelines illustrated in the remainder of +this document. +

+

For more detailed legal information about the use of FFmpeg in +external programs read the LICENSE file in the source tree and +consult https://ffmpeg.org/legal.html. +

+ +

2 Contributing

+ +

There are 2 ways by which code gets into FFmpeg: +

    +
  • Submitting patches to the ffmpeg-devel mailing list. + See Submitting patches for details. +
  • Directly committing changes to the main tree. +
+ +

Whichever way, changes should be reviewed by the maintainer of the code +before they are committed. And they should follow the Coding Rules. +The developer making the commit and the author are responsible for their changes +and should try to fix issues their commit causes. +

+ +

3 Coding Rules

+ + +

3.1 Code formatting conventions

+ +

There are the following guidelines regarding the indentation in files: +

+
    +
  • Indent size is 4. + +
  • The TAB character is forbidden outside of Makefiles as is any +form of trailing whitespace. Commits containing either will be +rejected by the git repository. + +
  • You should try to limit your code lines to 80 characters; however, do so if +and only if this improves readability. + +
  • K&R coding style is used. +
+

The presentation is one inspired by ’indent -i4 -kr -nut’. +

+

The main priority in FFmpeg is simplicity and small code size in order to +minimize the bug count. +

+ +

3.2 Comments

+

Use the JavaDoc/Doxygen format (see examples below) so that code documentation +can be generated automatically. All nontrivial functions should have a comment +above them explaining what the function does, even if it is just one sentence. +All structures and their member variables should be documented, too. +

+

Avoid Qt-style and similar Doxygen syntax with ! in it, i.e. replace +//! with /// and similar. Also @ syntax should be employed +for markup commands, i.e. use @param and not \param. +

+
+
/**
+ * @file
+ * MPEG codec.
+ * @author ...
+ */
+
+/**
+ * Summary sentence.
+ * more text ...
+ * ...
+ */
+typedef struct Foobar {
+    int var1; /**< var1 description */
+    int var2; ///< var2 description
+    /** var3 description */
+    int var3;
+} Foobar;
+
+/**
+ * Summary sentence.
+ * more text ...
+ * ...
+ * @param my_parameter description of my_parameter
+ * @return return value description
+ */
+int myfunc(int my_parameter)
+...
+
+ + +

3.3 C language features

+ +

FFmpeg is programmed in the ISO C90 language with a few additional +features from ISO C99, namely: +

+
    +
  • the ‘inline’ keyword; + +
  • ‘//’ comments; + +
  • designated struct initializers (‘struct s x = { .i = 17 };’); + +
  • compound literals (‘x = (struct s) { 17, 23 };’). + +
  • for loops with variable definition (‘for (int i = 0; i < 8; i++)’); + +
  • Variadic macros (‘#define ARRAY(nb, ...) (int[nb + 1]){ nb, __VA_ARGS__ }’); + +
  • Implementation defined behavior for signed integers is assumed to match the +expected behavior for two’s complement. Non representable values in integer +casts are binary truncated. Shift right of signed values uses sign extension. +
+ +

These features are supported by all compilers we care about, so we will not +accept patches to remove their use unless they absolutely do not impair +clarity and performance. +

+

All code must compile with recent versions of GCC and a number of other +currently supported compilers. To ensure compatibility, please do not use +additional C99 features or GCC extensions. Especially watch out for: +

+
    +
  • mixing statements and declarations; + +
  • ‘long long’ (use ‘int64_t’ instead); + +
  • ‘__attribute__’ not protected by ‘#ifdef __GNUC__’ or similar; + +
  • GCC statement expressions (‘(x = ({ int y = 4; y; })’). +
+ + +

3.4 Naming conventions

+

All names should be composed with underscores (_), not CamelCase. For example, +‘avfilter_get_video_buffer’ is an acceptable function name and +‘AVFilterGetVideo’ is not. The exception from this are type names, like +for example structs and enums; they should always be in CamelCase. +

+

There are the following conventions for naming variables and functions: +

+
    +
  • For local variables no prefix is required. + +
  • For file-scope variables and functions declared as static, no prefix +is required. + +
  • For variables and functions visible outside of file scope, but only used +internally by a library, an ff_ prefix should be used, +e.g. ‘ff_w64_demuxer’. + +
  • For variables and functions visible outside of file scope, used internally +across multiple libraries, use avpriv_ as prefix, for example, +‘avpriv_report_missing_feature’. + +
  • Each library has its own prefix for public symbols, in addition to the +commonly used av_ (avformat_ for libavformat, +avcodec_ for libavcodec, swr_ for libswresample, etc). +Check the existing code and choose names accordingly. +Note that some symbols without these prefixes are also exported for +retro-compatibility reasons. These exceptions are declared in the +lib<name>/lib<name>.v files. +
+ +

Furthermore, name space reserved for the system should not be invaded. +Identifiers ending in _t are reserved by +POSIX. +Also avoid names starting with __ or _ followed by an uppercase +letter as they are reserved by the C standard. Names starting with _ +are reserved at the file level and may not be used for externally visible +symbols. If in doubt, just avoid names starting with _ altogether. +

+ +

3.5 Miscellaneous conventions

+ +
    +
  • fprintf and printf are forbidden in libavformat and libavcodec, +please use av_log() instead. + +
  • Casts should be used only when necessary. Unneeded parentheses +should also be avoided if they don’t make the code easier to understand. +
+ + +

3.6 Editor configuration

+

In order to configure Vim to follow FFmpeg formatting conventions, paste +the following snippet into your .vimrc: +

+
" indentation rules for FFmpeg: 4 spaces, no tabs
+set expandtab
+set shiftwidth=4
+set softtabstop=4
+set cindent
+set cinoptions=(0
+" Allow tabs in Makefiles.
+autocmd FileType make,automake set noexpandtab shiftwidth=8 softtabstop=8
+" Trailing whitespace and tabs are forbidden, so highlight them.
+highlight ForbiddenWhitespace ctermbg=red guibg=red
+match ForbiddenWhitespace /\s\+$\|\t/
+" Do not highlight spaces at the end of line while typing on that line.
+autocmd InsertEnter * match ForbiddenWhitespace /\t\|\s\+\%#\@<!$/
+
+ +

For Emacs, add these roughly equivalent lines to your .emacs.d/init.el: +

+
(c-add-style "ffmpeg"
+             '("k&r"
+               (c-basic-offset . 4)
+               (indent-tabs-mode . nil)
+               (show-trailing-whitespace . t)
+               (c-offsets-alist
+                (statement-cont . (c-lineup-assignments +)))
+               )
+             )
+(setq c-default-style "ffmpeg")
+
+ + +

4 Development Policy

+ + +

4.1 Patches/Committing

+ +

Contributions should be licensed under the +LGPL 2.1, +including an "or any later version" clause, or, if you prefer +a gift-style license, the +ISC or +MIT license. +GPL 2 including +an "or any later version" clause is also acceptable, but LGPL is +preferred. +If you add a new file, give it a proper license header. Do not copy and +paste it from a random place, use an existing file as template. +

+ +

This means unfinished code which is enabled and breaks compilation, +or compiles but does not work/breaks the regression tests. Code which +is unfinished but disabled may be permitted under-circumstances, like +missing samples or an implementation with a small subset of features. +Always check the mailing list for any reviewers with issues and test +FATE before you push. +

+ +

The commit message should have a short first line in the form of +a ‘topic: short description’ as a header, separated by a newline +from the body consisting of an explanation of why the change is necessary. +If the commit fixes a known bug on the bug tracker, the commit message +should include its bug ID. Referring to the issue on the bug tracker does +not exempt you from writing an excerpt of the bug in the commit message. +

+ +

If it works for you, others, and passes FATE then it should be OK to commit +it, provided it fits the other committing criteria. You should not worry about +over-testing things. If your code has problems (portability, triggers +compiler bugs, unusual environment etc) they will be reported and eventually +fixed. +

+ +

They should be split them into self-contained pieces. Also do not forget +that if part B depends on part A, but A does not depend on B, then A can +and should be committed first and separate from B. Keeping changes well +split into self-contained parts makes reviewing and understanding them on +the commit log mailing list easier. This also helps in case of debugging +later on. +Also if you have doubts about splitting or not splitting, do not hesitate to +ask/discuss it on the developer mailing list. +

+ +

Do not commit changes to the build system (Makefiles, configure script) +which change behavior, defaults etc, without asking first. The same +applies to compiler warning fixes, trivial looking fixes and to code +maintained by other developers. We usually have a reason for doing things +the way we do. Send your changes as patches to the ffmpeg-devel mailing +list, and if the code maintainers say OK, you may commit. This does not +apply to files you wrote and/or maintain. +

+ +

We refuse source indentation and other cosmetic changes if they are mixed +with functional changes, such commits will be rejected and removed. Every +developer has his own indentation style, you should not change it. Of course +if you (re)write something, you can use your own style, even though we would +prefer if the indentation throughout FFmpeg was consistent (Many projects +force a given indentation style - we do not.). If you really need to make +indentation changes (try to avoid this), separate them strictly from real +changes. +

+

NOTE: If you had to put if(){ .. } over a large (> 5 lines) chunk of code, +then either do NOT change the indentation of the inner part within (do not +move it to the right)! or do so in a separate commit +

+ +

Always fill out the commit log message. Describe in a few lines what you +changed and why. You can refer to mailing list postings if you fix a +particular bug. Comments such as "fixed!" or "Changed it." are unacceptable. +Recommended format: +

+
+
area changed: Short 1 line description
+
+details describing what and why and giving references.
+
+ + +

Make sure the author of the commit is set correctly. (see git commit –author) +If you apply a patch, send an +answer to ffmpeg-devel (or wherever you got the patch from) saying that +you applied the patch. +

+ +

When applying patches that have been discussed (at length) on the mailing +list, reference the thread in the log message. +

+ +

Do NOT commit to code actively maintained by others without permission. +Send a patch to ffmpeg-devel. If no one answers within a reasonable +time-frame (12h for build failures and security fixes, 3 days small changes, +1 week for big patches) then commit your patch if you think it is OK. +Also note, the maintainer can simply ask for more time to review! +

+ +

4.2 Code

+ +

Do not change behavior of the programs (renaming options etc) or public +API or ABI without first discussing it on the ffmpeg-devel mailing list. +Do not remove widely used functionality or features (redundant code can be removed). +

+ +

Depending on the change, you may need to change the version integer. +Incrementing the first component means no backward compatibility to +previous versions (e.g. removal of a function from the public API). +Incrementing the second component means backward compatible change +(e.g. addition of a function to the public API or extension of an +existing data structure). +Incrementing the third component means a noteworthy binary compatible +change (e.g. encoder bug fix that matters for the decoder). The third +component always starts at 100 to distinguish FFmpeg from Libav. +

+ +

Compiler warnings indicate potential bugs or code with bad style. If a type of +warning always points to correct and clean code, that warning should +be disabled, not the code changed. +Thus the remaining warnings can either be bugs or correct code. +If it is a bug, the bug has to be fixed. If it is not, the code should +be changed to not generate a warning unless that causes a slowdown +or obfuscates the code. +

+ +

Never write to unallocated memory, never write over the end of arrays, +always check values read from some untrusted source before using them +as array index or other risky things. +

+ +

4.3 Documentation/Other

+ +

It is important to be subscribed to the +ffmpeg-devel +mailing list. Almost any non-trivial patch is to be sent there for review. +Other developers may have comments about your contribution. We expect you see +those comments, and to improve it if requested. (N.B. Experienced committers +have other channels, and may sometimes skip review for trivial fixes.) Also, +discussion here about bug fixes and FFmpeg improvements by other developers may +be helpful information for you. Finally, by being a list subscriber, your +contribution will be posted immediately to the list, without the moderation +hold which messages from non-subscribers experience. +

+

However, it is more important to the project that we receive your patch than +that you be subscribed to the ffmpeg-devel list. If you have a patch, and don’t +want to subscribe and discuss the patch, then please do send it to the list +anyway. +

+ +

Diffs of all commits are sent to the +ffmpeg-cvslog +mailing list. Some developers read this list to review all code base changes +from all sources. Subscribing to this list is not mandatory. +

+ +

Update the documentation if you change behavior or add features. If you are +unsure how best to do this, send a patch to ffmpeg-devel, the documentation +maintainer(s) will review and commit your stuff. +

+ +

Try to keep important discussions and requests (also) on the public +developer mailing list, so that all developers can benefit from them. +

+ +

Make sure that no parts of the codebase that you maintain are missing from the +MAINTAINERS file. If something that you want to maintain is missing add it with +your name after it. +If at some point you no longer want to maintain some code, then please help in +finding a new maintainer and also don’t forget to update the MAINTAINERS file. +

+

We think our rules are not too hard. If you have comments, contact us. +

+ +

5 Code of conduct

+ +

Be friendly and respectful towards others and third parties. +Treat others the way you yourself want to be treated. +

+

Be considerate. Not everyone shares the same viewpoint and priorities as you do. +Different opinions and interpretations help the project. +Looking at issues from a different perspective assists development. +

+

Do not assume malice for things that can be attributed to incompetence. Even if +it is malice, it’s rarely good to start with that as initial assumption. +

+

Stay friendly even if someone acts contrarily. Everyone has a bad day +once in a while. +If you yourself have a bad day or are angry then try to take a break and reply +once you are calm and without anger if you have to. +

+

Try to help other team members and cooperate if you can. +

+

The goal of software development is to create technical excellence, not for any +individual to be better and "win" against the others. Large software projects +are only possible and successful through teamwork. +

+

If someone struggles do not put them down. Give them a helping hand +instead and point them in the right direction. +

+

Finally, keep in mind the immortal words of Bill and Ted, +"Be excellent to each other." +

+ +

6 Submitting patches

+ +

First, read the Coding Rules above if you did not yet, in particular +the rules regarding patch submission. +

+

When you submit your patch, please use git format-patch or +git send-email. We cannot read other diffs :-). +

+

Also please do not submit a patch which contains several unrelated changes. +Split it into separate, self-contained pieces. This does not mean splitting +file by file. Instead, make the patch as small as possible while still +keeping it as a logical unit that contains an individual change, even +if it spans multiple files. This makes reviewing your patches much easier +for us and greatly increases your chances of getting your patch applied. +

+

Use the patcheck tool of FFmpeg to check your patch. +The tool is located in the tools directory. +

+

Run the Regression tests before submitting a patch in order to verify +it does not cause unexpected problems. +

+

It also helps quite a bit if you tell us what the patch does (for example +’replaces lrint by lrintf’), and why (for example ’*BSD isn’t C99 compliant +and has no lrint()’) +

+

Also please if you send several patches, send each patch as a separate mail, +do not attach several unrelated patches to the same mail. +

+

Patches should be posted to the +ffmpeg-devel +mailing list. Use git send-email when possible since it will properly +send patches without requiring extra care. If you cannot, then send patches +as base64-encoded attachments, so your patch is not trashed during +transmission. Also ensure the correct mime type is used +(text/x-diff or text/x-patch or at least text/plain) and that only one +patch is inline or attached per mail. +You can check https://patchwork.ffmpeg.org, if your patch does not show up, its mime type +likely was wrong. +

+

Your patch will be reviewed on the mailing list. You will likely be asked +to make some changes and are expected to send in an improved version that +incorporates the requests from the review. This process may go through +several iterations. Once your patch is deemed good enough, some developer +will pick it up and commit it to the official FFmpeg tree. +

+

Give us a few days to react. But if some time passes without reaction, +send a reminder by email. Your patch should eventually be dealt with. +

+ + +

7 New codecs or formats checklist

+ +
    +
  1. Did you use av_cold for codec initialization and close functions? + +
  2. Did you add a long_name under NULL_IF_CONFIG_SMALL to the AVCodec or +AVInputFormat/AVOutputFormat struct? + +
  3. Did you bump the minor version number (and reset the micro version +number) in libavcodec/version.h or libavformat/version.h? + +
  4. Did you register it in allcodecs.c or allformats.c? + +
  5. Did you add the AVCodecID to avcodec.h? +When adding new codec IDs, also add an entry to the codec descriptor +list in libavcodec/codec_desc.c. + +
  6. If it has a FourCC, did you add it to libavformat/riff.c, +even if it is only a decoder? + +
  7. Did you add a rule to compile the appropriate files in the Makefile? +Remember to do this even if you’re just adding a format to a file that is +already being compiled by some other rule, like a raw demuxer. + +
  8. Did you add an entry to the table of supported formats or codecs in +doc/general.texi? + +
  9. Did you add an entry in the Changelog? + +
  10. If it depends on a parser or a library, did you add that dependency in +configure? + +
  11. Did you git add the appropriate files before committing? + +
  12. Did you make sure it compiles standalone, i.e. with +configure --disable-everything --enable-decoder=foo +(or --enable-demuxer or whatever your component is)? +
+ + + +

8 Patch submission checklist

+ +
    +
  1. Does make fate pass with the patch applied? + +
  2. Was the patch generated with git format-patch or send-email? + +
  3. Did you sign-off your patch? (git commit -s) +See Sign your work for the meaning +of sign-off. + +
  4. Did you provide a clear git commit log message? + +
  5. Is the patch against latest FFmpeg git master branch? + +
  6. Are you subscribed to ffmpeg-devel? +(the list is subscribers only due to spam) + +
  7. Have you checked that the changes are minimal, so that the same cannot be +achieved with a smaller patch and/or simpler final code? + +
  8. If the change is to speed critical code, did you benchmark it? + +
  9. If you did any benchmarks, did you provide them in the mail? + +
  10. Have you checked that the patch does not introduce buffer overflows or +other security issues? + +
  11. Did you test your decoder or demuxer against damaged data? If no, see +tools/trasher, the noise bitstream filter, and +zzuf. Your decoder or demuxer +should not crash, end in a (near) infinite loop, or allocate ridiculous +amounts of memory when fed damaged data. + +
  12. Did you test your decoder or demuxer against sample files? +Samples may be obtained at https://samples.ffmpeg.org. + +
  13. Does the patch not mix functional and cosmetic changes? + +
  14. Did you add tabs or trailing whitespace to the code? Both are forbidden. + +
  15. Is the patch attached to the email you send? + +
  16. Is the mime type of the patch correct? It should be text/x-diff or +text/x-patch or at least text/plain and not application/octet-stream. + +
  17. If the patch fixes a bug, did you provide a verbose analysis of the bug? + +
  18. If the patch fixes a bug, did you provide enough information, including +a sample, so the bug can be reproduced and the fix can be verified? +Note please do not attach samples >100k to mails but rather provide a +URL, you can upload to https://streams.videolan.org/upload/. + +
  19. Did you provide a verbose summary about what the patch does change? + +
  20. Did you provide a verbose explanation why it changes things like it does? + +
  21. Did you provide a verbose summary of the user visible advantages and +disadvantages if the patch is applied? + +
  22. Did you provide an example so we can verify the new feature added by the +patch easily? + +
  23. If you added a new file, did you insert a license header? It should be +taken from FFmpeg, not randomly copied and pasted from somewhere else. + +
  24. You should maintain alphabetical order in alphabetically ordered lists as +long as doing so does not break API/ABI compatibility. + +
  25. Lines with similar content should be aligned vertically when doing so +improves readability. + +
  26. Consider adding a regression test for your code. + +
  27. If you added YASM code please check that things still work with –disable-yasm. + +
  28. Make sure you check the return values of function and return appropriate +error codes. Especially memory allocation functions like av_malloc() +are notoriously left unchecked, which is a serious problem. + +
  29. Test your code with valgrind and or Address Sanitizer to ensure it’s free +of leaks, out of array accesses, etc. +
+ + +

9 Patch review process

+ +

All patches posted to ffmpeg-devel will be reviewed, unless they contain a +clear note that the patch is not for the git master branch. +Reviews and comments will be posted as replies to the patch on the +mailing list. The patch submitter then has to take care of every comment, +that can be by resubmitting a changed patch or by discussion. Resubmitted +patches will themselves be reviewed like any other patch. If at some point +a patch passes review with no comments then it is approved, that can for +simple and small patches happen immediately while large patches will generally +have to be changed and reviewed many times before they are approved. +After a patch is approved it will be committed to the repository. +

+

We will review all submitted patches, but sometimes we are quite busy so +especially for large patches this can take several weeks. +

+

If you feel that the review process is too slow and you are willing to try to +take over maintainership of the area of code you change then just clone +git master and maintain the area of code there. We will merge each area from +where its best maintained. +

+

When resubmitting patches, please do not make any significant changes +not related to the comments received during review. Such patches will +be rejected. Instead, submit significant changes or new features as +separate patches. +

+

Everyone is welcome to review patches. Also if you are waiting for your patch +to be reviewed, please consider helping to review other patches, that is a great +way to get everyone’s patches reviewed sooner. +

+ +

10 Regression tests

+ +

Before submitting a patch (or committing to the repository), you should at least +test that you did not break anything. +

+

Running ’make fate’ accomplishes this, please see fate.html for details. +

+

[Of course, some patches may change the results of the regression tests. In +this case, the reference results of the regression tests shall be modified +accordingly]. +

+ +

10.1 Adding files to the fate-suite dataset

+ +

When there is no muxer or encoder available to generate test media for a +specific test then the media has to be included in the fate-suite. +First please make sure that the sample file is as small as possible to test the +respective decoder or demuxer sufficiently. Large files increase network +bandwidth and disk space requirements. +Once you have a working fate test and fate sample, provide in the commit +message or introductory message for the patch series that you post to +the ffmpeg-devel mailing list, a direct link to download the sample media. +

+ +

10.2 Visualizing Test Coverage

+ +

The FFmpeg build system allows visualizing the test coverage in an easy +manner with the coverage tools gcov/lcov. This involves +the following steps: +

+
    +
  1. Configure to compile with instrumentation enabled: + configure --toolchain=gcov. + +
  2. Run your test case, either manually or via FATE. This can be either + the full FATE regression suite, or any arbitrary invocation of any + front-end tool provided by FFmpeg, in any combination. + +
  3. Run make lcov to generate coverage data in HTML format. + +
  4. View lcov/index.html in your preferred HTML viewer. +
+ +

You can use the command make lcov-reset to reset the coverage +measurements. You will need to rerun make lcov after running a +new test. +

+ +

10.3 Using Valgrind

+ +

The configure script provides a shortcut for using valgrind to spot bugs +related to memory handling. Just add the option +--toolchain=valgrind-memcheck or --toolchain=valgrind-massif +to your configure line, and reasonable defaults will be set for running +FATE under the supervision of either the memcheck or the +massif tool of the valgrind suite. +

+

In case you need finer control over how valgrind is invoked, use the +--target-exec='valgrind <your_custom_valgrind_options> option in +your configure line instead. +

+ +

11 Release process

+ +

FFmpeg maintains a set of release branches, which are the +recommended deliverable for system integrators and distributors (such as +Linux distributions, etc.). At regular times, a release +manager prepares, tests and publishes tarballs on the +https://ffmpeg.org website. +

+

There are two kinds of releases: +

+
    +
  1. Major releases always include the latest and greatest +features and functionality. + +
  2. Point releases are cut from release branches, +which are named release/X, with X being the release +version number. +
+ +

Note that we promise to our users that shared libraries from any FFmpeg +release never break programs that have been compiled against +previous versions of the same release series in any case! +

+

However, from time to time, we do make API changes that require adaptations +in applications. Such changes are only allowed in (new) major releases and +require further steps such as bumping library version numbers and/or +adjustments to the symbol versioning file. Please discuss such changes +on the ffmpeg-devel mailing list in time to allow forward planning. +

+ +

11.1 Criteria for Point Releases

+ +

Changes that match the following criteria are valid candidates for +inclusion into a point release: +

+
    +
  1. Fixes a security issue, preferably identified by a CVE +number issued by http://cve.mitre.org/. + +
  2. Fixes a documented bug in https://trac.ffmpeg.org. + +
  3. Improves the included documentation. + +
  4. Retains both source code and binary compatibility with previous +point releases of the same release branch. +
+ +

The order for checking the rules is (1 OR 2 OR 3) AND 4. +

+ + +

11.2 Release Checklist

+ +

The release process involves the following steps: +

+
    +
  1. Ensure that the RELEASE file contains the version number for +the upcoming release. + +
  2. Add the release at https://trac.ffmpeg.org/admin/ticket/versions. + +
  3. Announce the intent to do a release to the mailing list. + +
  4. Make sure all relevant security fixes have been backported. See +https://ffmpeg.org/security.html. + +
  5. Ensure that the FATE regression suite still passes in the release +branch on at least i386 and amd64 +(cf. Regression tests). + +
  6. Prepare the release tarballs in bz2 and gz formats, and +supplementing files that contain gpg signatures + +
  7. Publish the tarballs at https://ffmpeg.org/releases. Create and +push an annotated tag in the form nX, with X +containing the version number. + +
  8. Propose and send a patch to the ffmpeg-devel mailing list +with a news entry for the website. + +
  9. Publish the news entry. + +
  10. Send an announcement to the mailing list. +
+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/faq.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/faq.html new file mode 100644 index 0000000..bc03e8e --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/faq.html @@ -0,0 +1,824 @@ + + + + + + + FFmpeg FAQ + + + + + + +
+

+ FFmpeg FAQ +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 General Questions

+ + +

1.1 Why doesn’t FFmpeg support feature [xyz]?

+ +

Because no one has taken on that task yet. FFmpeg development is +driven by the tasks that are important to the individual developers. +If there is a feature that is important to you, the best way to get +it implemented is to undertake the task yourself or sponsor a developer. +

+ +

1.2 FFmpeg does not support codec XXX. Can you include a Windows DLL loader to support it?

+ +

No. Windows DLLs are not portable, bloated and often slow. +Moreover FFmpeg strives to support all codecs natively. +A DLL loader is not conducive to that goal. +

+ +

1.3 I cannot read this file although this format seems to be supported by ffmpeg.

+ +

Even if ffmpeg can read the container format, it may not support all its +codecs. Please consult the supported codec list in the ffmpeg +documentation. +

+ +

1.4 Which codecs are supported by Windows?

+ +

Windows does not support standard formats like MPEG very well, unless you +install some additional codecs. +

+

The following list of video codecs should work on most Windows systems: +

+
msmpeg4v2
+

.avi/.asf +

+
msmpeg4
+

.asf only +

+
wmv1
+

.asf only +

+
wmv2
+

.asf only +

+
mpeg4
+

Only if you have some MPEG-4 codec like ffdshow or Xvid installed. +

+
mpeg1video
+

.mpg only +

+
+

Note, ASF files often have .wmv or .wma extensions in Windows. It should also +be mentioned that Microsoft claims a patent on the ASF format, and may sue +or threaten users who create ASF files with non-Microsoft software. It is +strongly advised to avoid ASF where possible. +

+

The following list of audio codecs should work on most Windows systems: +

+
adpcm_ima_wav
+
adpcm_ms
+
pcm_s16le
+

always +

+
libmp3lame
+

If some MP3 codec like LAME is installed. +

+
+ + + +

2 Compilation

+ + +

2.1 error: can't find a register in class 'GENERAL_REGS' while reloading 'asm'

+ +

This is a bug in gcc. Do not report it to us. Instead, please report it to +the gcc developers. Note that we will not add workarounds for gcc bugs. +

+

Also note that (some of) the gcc developers believe this is not a bug or +not a bug they should fix: +https://gcc.gnu.org/bugzilla/show_bug.cgi?id=11203. +Then again, some of them do not know the difference between an undecidable +problem and an NP-hard problem... +

+ +

2.2 I have installed this library with my distro’s package manager. Why does configure not see it?

+ +

Distributions usually split libraries in several packages. The main package +contains the files necessary to run programs using the library. The +development package contains the files necessary to build programs using the +library. Sometimes, docs and/or data are in a separate package too. +

+

To build FFmpeg, you need to install the development package. It is usually +called libfoo-dev or libfoo-devel. You can remove it after the +build is finished, but be sure to keep the main package. +

+ +

2.3 How do I make pkg-config find my libraries?

+ +

Somewhere along with your libraries, there is a .pc file (or several) +in a pkgconfig directory. You need to set environment variables to +point pkg-config to these files. +

+

If you need to add directories to pkg-config’s search list +(typical use case: library installed separately), add it to +$PKG_CONFIG_PATH: +

+
+
export PKG_CONFIG_PATH=/opt/x264/lib/pkgconfig:/opt/opus/lib/pkgconfig
+
+ +

If you need to replace pkg-config’s search list +(typical use case: cross-compiling), set it in +$PKG_CONFIG_LIBDIR: +

+
+
export PKG_CONFIG_LIBDIR=/home/me/cross/usr/lib/pkgconfig:/home/me/cross/usr/local/lib/pkgconfig
+
+ +

If you need to know the library’s internal dependencies (typical use: static +linking), add the --static option to pkg-config: +

+
+
./configure --pkg-config-flags=--static
+
+ + +

2.4 How do I use pkg-config when cross-compiling?

+ +

The best way is to install pkg-config in your cross-compilation +environment. It will automatically use the cross-compilation libraries. +

+

You can also use pkg-config from the host environment by +specifying explicitly --pkg-config=pkg-config to configure. +In that case, you must point pkg-config to the correct directories +using the PKG_CONFIG_LIBDIR, as explained in the previous entry. +

+

As an intermediate solution, you can place in your cross-compilation +environment a script that calls the host pkg-config with +PKG_CONFIG_LIBDIR set. That script can look like that: +

+
+
#!/bin/sh
+PKG_CONFIG_LIBDIR=/path/to/cross/lib/pkgconfig
+export PKG_CONFIG_LIBDIR
+exec /usr/bin/pkg-config "$@"
+
+ + +

3 Usage

+ + +

3.1 ffmpeg does not work; what is wrong?

+ +

Try a make distclean in the ffmpeg source directory before the build. +If this does not help see +(https://ffmpeg.org/bugreports.html). +

+ +

3.2 How do I encode single pictures into movies?

+ +

First, rename your pictures to follow a numerical sequence. +For example, img1.jpg, img2.jpg, img3.jpg,... +Then you may run: +

+
+
ffmpeg -f image2 -i img%d.jpg /tmp/a.mpg
+
+ +

Notice that ‘%d’ is replaced by the image number. +

+

img%03d.jpg means the sequence img001.jpg, img002.jpg, etc. +

+

Use the -start_number option to declare a starting number for +the sequence. This is useful if your sequence does not start with +img001.jpg but is still in a numerical order. The following +example will start with img100.jpg: +

+
+
ffmpeg -f image2 -start_number 100 -i img%d.jpg /tmp/a.mpg
+
+ +

If you have large number of pictures to rename, you can use the +following command to ease the burden. The command, using the bourne +shell syntax, symbolically links all files in the current directory +that match *jpg to the /tmp directory in the sequence of +img001.jpg, img002.jpg and so on. +

+
+
x=1; for i in *jpg; do counter=$(printf %03d $x); ln -s "$i" /tmp/img"$counter".jpg; x=$(($x+1)); done
+
+ +

If you want to sequence them by oldest modified first, substitute +$(ls -r -t *jpg) in place of *jpg. +

+

Then run: +

+
+
ffmpeg -f image2 -i /tmp/img%03d.jpg /tmp/a.mpg
+
+ +

The same logic is used for any image format that ffmpeg reads. +

+

You can also use cat to pipe images to ffmpeg: +

+
+
cat *.jpg | ffmpeg -f image2pipe -c:v mjpeg -i - output.mpg
+
+ + +

3.3 How do I encode movie to single pictures?

+ +

Use: +

+
+
ffmpeg -i movie.mpg movie%d.jpg
+
+ +

The movie.mpg used as input will be converted to +movie1.jpg, movie2.jpg, etc... +

+

Instead of relying on file format self-recognition, you may also use +

+
-c:v ppm
+
-c:v png
+
-c:v mjpeg
+
+

to force the encoding. +

+

Applying that to the previous example: +

+
ffmpeg -i movie.mpg -f image2 -c:v mjpeg menu%d.jpg
+
+ +

Beware that there is no "jpeg" codec. Use "mjpeg" instead. +

+ +

3.4 Why do I see a slight quality degradation with multithreaded MPEG* encoding?

+ +

For multithreaded MPEG* encoding, the encoded slices must be independent, +otherwise thread n would practically have to wait for n-1 to finish, so it’s +quite logical that there is a small reduction of quality. This is not a bug. +

+ +

3.5 How can I read from the standard input or write to the standard output?

+ +

Use - as file name. +

+ +

3.6 -f jpeg doesn’t work.

+ +

Try ’-f image2 test%d.jpg’. +

+ +

3.7 Why can I not change the frame rate?

+ +

Some codecs, like MPEG-1/2, only allow a small number of fixed frame rates. +Choose a different codec with the -c:v command line option. +

+ +

3.8 How do I encode Xvid or DivX video with ffmpeg?

+ +

Both Xvid and DivX (version 4+) are implementations of the ISO MPEG-4 +standard (note that there are many other coding formats that use this +same standard). Thus, use ’-c:v mpeg4’ to encode in these formats. The +default fourcc stored in an MPEG-4-coded file will be ’FMP4’. If you want +a different fourcc, use the ’-vtag’ option. E.g., ’-vtag xvid’ will +force the fourcc ’xvid’ to be stored as the video fourcc rather than the +default. +

+ +

3.9 Which are good parameters for encoding high quality MPEG-4?

+ +

’-mbd rd -flags +mv4+aic -trellis 2 -cmp 2 -subcmp 2 -g 300 -pass 1/2’, +things to try: ’-bf 2’, ’-mpv_flags qp_rd’, ’-mpv_flags mv0’, ’-mpv_flags skip_rd’. +

+ +

3.10 Which are good parameters for encoding high quality MPEG-1/MPEG-2?

+ +

’-mbd rd -trellis 2 -cmp 2 -subcmp 2 -g 100 -pass 1/2’ +but beware the ’-g 100’ might cause problems with some decoders. +Things to try: ’-bf 2’, ’-mpv_flags qp_rd’, ’-mpv_flags mv0’, ’-mpv_flags skip_rd’. +

+ +

3.11 Interlaced video looks very bad when encoded with ffmpeg, what is wrong?

+ +

You should use ’-flags +ilme+ildct’ and maybe ’-flags +alt’ for interlaced +material, and try ’-top 0/1’ if the result looks really messed-up. +

+ +

3.12 How can I read DirectShow files?

+ +

If you have built FFmpeg with ./configure --enable-avisynth +(only possible on MinGW/Cygwin platforms), +then you may use any file that DirectShow can read as input. +

+

Just create an "input.avs" text file with this single line ... +

+
DirectShowSource("C:\path to your file\yourfile.asf")
+
+

... and then feed that text file to ffmpeg: +

+
ffmpeg -i input.avs
+
+ +

For ANY other help on AviSynth, please visit the +AviSynth homepage. +

+ +

3.13 How can I join video files?

+ +

To "join" video files is quite ambiguous. The following list explains the +different kinds of "joining" and points out how those are addressed in +FFmpeg. To join video files may mean: +

+
    +
  • To put them one after the other: this is called to concatenate them +(in short: concat) and is addressed +in this very faq. + +
  • To put them together in the same file, to let the user choose between the +different versions (example: different audio languages): this is called to +multiplex them together (in short: mux), and is done by simply +invoking ffmpeg with several -i options. + +
  • For audio, to put all channels together in a single stream (example: two +mono streams into one stereo stream): this is sometimes called to +merge them, and can be done using the +amerge filter. + +
  • For audio, to play one on top of the other: this is called to mix +them, and can be done by first merging them into a single stream and then +using the pan filter to mix +the channels at will. + +
  • For video, to display both together, side by side or one on top of a part of +the other; it can be done using the +overlay video filter. + +
+ + +

3.14 How can I concatenate video files?

+ +

There are several solutions, depending on the exact circumstances. +

+ +

3.14.1 Concatenating using the concat filter

+ +

FFmpeg has a concat filter designed specifically for that, with examples in the +documentation. This operation is recommended if you need to re-encode. +

+ +

3.14.2 Concatenating using the concat demuxer

+ +

FFmpeg has a concat demuxer which you can use when you want to avoid a re-encode and +your format doesn’t support file level concatenation. +

+ +

3.14.3 Concatenating using the concat protocol (file level)

+ +

FFmpeg has a concat protocol designed specifically for that, with examples in the +documentation. +

+

A few multimedia containers (MPEG-1, MPEG-2 PS, DV) allow one to concatenate +video by merely concatenating the files containing them. +

+

Hence you may concatenate your multimedia files by first transcoding them to +these privileged formats, then using the humble cat command (or the +equally humble copy under Windows), and finally transcoding back to your +format of choice. +

+
+
ffmpeg -i input1.avi -qscale:v 1 intermediate1.mpg
+ffmpeg -i input2.avi -qscale:v 1 intermediate2.mpg
+cat intermediate1.mpg intermediate2.mpg > intermediate_all.mpg
+ffmpeg -i intermediate_all.mpg -qscale:v 2 output.avi
+
+ +

Additionally, you can use the concat protocol instead of cat or +copy which will avoid creation of a potentially huge intermediate file. +

+
+
ffmpeg -i input1.avi -qscale:v 1 intermediate1.mpg
+ffmpeg -i input2.avi -qscale:v 1 intermediate2.mpg
+ffmpeg -i concat:"intermediate1.mpg|intermediate2.mpg" -c copy intermediate_all.mpg
+ffmpeg -i intermediate_all.mpg -qscale:v 2 output.avi
+
+ +

Note that you may need to escape the character "|" which is special for many +shells. +

+

Another option is usage of named pipes, should your platform support it: +

+
+
mkfifo intermediate1.mpg
+mkfifo intermediate2.mpg
+ffmpeg -i input1.avi -qscale:v 1 -y intermediate1.mpg < /dev/null &
+ffmpeg -i input2.avi -qscale:v 1 -y intermediate2.mpg < /dev/null &
+cat intermediate1.mpg intermediate2.mpg |\
+ffmpeg -f mpeg -i - -c:v mpeg4 -c:a libmp3lame output.avi
+
+ + +

3.14.4 Concatenating using raw audio and video

+ +

Similarly, the yuv4mpegpipe format, and the raw video, raw audio codecs also +allow concatenation, and the transcoding step is almost lossless. +When using multiple yuv4mpegpipe(s), the first line needs to be discarded +from all but the first stream. This can be accomplished by piping through +tail as seen below. Note that when piping through tail you +must use command grouping, { ;}, to background properly. +

+

For example, let’s say we want to concatenate two FLV files into an +output.flv file: +

+
+
mkfifo temp1.a
+mkfifo temp1.v
+mkfifo temp2.a
+mkfifo temp2.v
+mkfifo all.a
+mkfifo all.v
+ffmpeg -i input1.flv -vn -f u16le -c:a pcm_s16le -ac 2 -ar 44100 - > temp1.a < /dev/null &
+ffmpeg -i input2.flv -vn -f u16le -c:a pcm_s16le -ac 2 -ar 44100 - > temp2.a < /dev/null &
+ffmpeg -i input1.flv -an -f yuv4mpegpipe - > temp1.v < /dev/null &
+{ ffmpeg -i input2.flv -an -f yuv4mpegpipe - < /dev/null | tail -n +2 > temp2.v ; } &
+cat temp1.a temp2.a > all.a &
+cat temp1.v temp2.v > all.v &
+ffmpeg -f u16le -c:a pcm_s16le -ac 2 -ar 44100 -i all.a \
+       -f yuv4mpegpipe -i all.v \
+       -y output.flv
+rm temp[12].[av] all.[av]
+
+ + +

3.15 Using -f lavfi, audio becomes mono for no apparent reason.

+ +

Use -dumpgraph - to find out exactly where the channel layout is +lost. +

+

Most likely, it is through auto-inserted aresample. Try to understand +why the converting filter was needed at that place. +

+

Just before the output is a likely place, as -f lavfi currently +only support packed S16. +

+

Then insert the correct aformat explicitly in the filtergraph, +specifying the exact format. +

+
+
aformat=sample_fmts=s16:channel_layouts=stereo
+
+ + +

3.16 Why does FFmpeg not see the subtitles in my VOB file?

+ +

VOB and a few other formats do not have a global header that describes +everything present in the file. Instead, applications are supposed to scan +the file to see what it contains. Since VOB files are frequently large, only +the beginning is scanned. If the subtitles happen only later in the file, +they will not be initially detected. +

+

Some applications, including the ffmpeg command-line tool, can only +work with streams that were detected during the initial scan; streams that +are detected later are ignored. +

+

The size of the initial scan is controlled by two options: probesize +(default ~5 Mo) and analyzeduration (default 5,000,000 µs = 5 s). For +the subtitle stream to be detected, both values must be large enough. +

+ +

3.17 Why was the ffmpeg -sameq option removed? What to use instead?

+ +

The -sameq option meant "same quantizer", and made sense only in a +very limited set of cases. Unfortunately, a lot of people mistook it for +"same quality" and used it in places where it did not make sense: it had +roughly the expected visible effect, but achieved it in a very inefficient +way. +

+

Each encoder has its own set of options to set the quality-vs-size balance, +use the options for the encoder you are using to set the quality level to a +point acceptable for your tastes. The most common options to do that are +-qscale and -qmax, but you should peruse the documentation +of the encoder you chose. +

+ +

3.18 I have a stretched video, why does scaling does not fix it?

+ +

A lot of video codecs and formats can store the aspect ratio of the +video: this is the ratio between the width and the height of either the full +image (DAR, display aspect ratio) or individual pixels (SAR, sample aspect +ratio). For example, EGA screens at resolution 640×350 had 4:3 DAR and 35:48 +SAR. +

+

Most still image processing work with square pixels, i.e. 1:1 SAR, but a lot +of video standards, especially from the analogic-numeric transition era, use +non-square pixels. +

+

Most processing filters in FFmpeg handle the aspect ratio to avoid +stretching the image: cropping adjusts the DAR to keep the SAR constant, +scaling adjusts the SAR to keep the DAR constant. +

+

If you want to stretch, or “unstretch”, the image, you need to override the +information with the +setdar or setsar filters. +

+

Do not forget to examine carefully the original video to check whether the +stretching comes from the image or from the aspect ratio information. +

+

For example, to fix a badly encoded EGA capture, use the following commands, +either the first one to upscale to square pixels or the second one to set +the correct aspect ratio or the third one to avoid transcoding (may not work +depending on the format / codec / player / phase of the moon): +

+
+
ffmpeg -i ega_screen.nut -vf scale=640:480,setsar=1 ega_screen_scaled.nut
+ffmpeg -i ega_screen.nut -vf setdar=4/3 ega_screen_anamorphic.nut
+ffmpeg -i ega_screen.nut -aspect 4/3 -c copy ega_screen_overridden.nut
+
+ + +

3.19 How do I run ffmpeg as a background task?

+ +

ffmpeg normally checks the console input, for entries like "q" to stop +and "?" to give help, while performing operations. ffmpeg does not have a way of +detecting when it is running as a background task. +When it checks the console input, that can cause the process running ffmpeg +in the background to suspend. +

+

To prevent those input checks, allowing ffmpeg to run as a background task, +use the -nostdin option +in the ffmpeg invocation. This is effective whether you run ffmpeg in a shell +or invoke ffmpeg in its own process via an operating system API. +

+

As an alternative, when you are running ffmpeg in a shell, you can redirect +standard input to /dev/null (on Linux and macOS) +or NUL (on Windows). You can do this redirect either +on the ffmpeg invocation, or from a shell script which calls ffmpeg. +

+

For example: +

+
+
ffmpeg -nostdin -i INPUT OUTPUT
+
+ +

or (on Linux, macOS, and other UNIX-like shells): +

+
+
ffmpeg -i INPUT OUTPUT </dev/null
+
+ +

or (on Windows): +

+
+
ffmpeg -i INPUT OUTPUT <NUL
+
+ + +

3.20 How do I prevent ffmpeg from suspending with a message like suspended (tty output)?

+ +

If you run ffmpeg in the background, you may find that its process suspends. +There may be a message like suspended (tty output). The question is how +to prevent the process from being suspended. +

+

For example: +

+
+
% ffmpeg -i INPUT OUTPUT &> ~/tmp/log.txt &
+[1] 93352
+%
+[1]  + suspended (tty output)  ffmpeg -i INPUT OUTPUT &>
+
+ +

The message "tty output" notwithstanding, the problem here is that +ffmpeg normally checks the console input when it runs. The operating system +detects this, and suspends the process until you can bring it to the +foreground and attend to it. +

+

The solution is to use the right techniques to tell ffmpeg not to consult +console input. You can use the +-nostdin option, +or redirect standard input with < /dev/null. +See FAQ +How do I run ffmpeg as a background task? +for details. +

+ +

4 Development

+ + +

4.1 Are there examples illustrating how to use the FFmpeg libraries, particularly libavcodec and libavformat?

+ +

Yes. Check the doc/examples directory in the source +repository, also available online at: +https://github.com/FFmpeg/FFmpeg/tree/master/doc/examples. +

+

Examples are also installed by default, usually in +$PREFIX/share/ffmpeg/examples. +

+

Also you may read the Developers Guide of the FFmpeg documentation. Alternatively, +examine the source code for one of the many open source projects that +already incorporate FFmpeg at (projects.html). +

+ +

4.2 Can you support my C compiler XXX?

+ +

It depends. If your compiler is C99-compliant, then patches to support +it are likely to be welcome if they do not pollute the source code +with #ifdefs related to the compiler. +

+ +

4.3 Is Microsoft Visual C++ supported?

+ +

Yes. Please see the Microsoft Visual C++ +section in the FFmpeg documentation. +

+ +

4.4 Can you add automake, libtool or autoconf support?

+ +

No. These tools are too bloated and they complicate the build. +

+ +

4.5 Why not rewrite FFmpeg in object-oriented C++?

+ +

FFmpeg is already organized in a highly modular manner and does not need to +be rewritten in a formal object language. Further, many of the developers +favor straight C; it works for them. For more arguments on this matter, +read "Programming Religion". +

+ +

4.6 Why are the ffmpeg programs devoid of debugging symbols?

+ +

The build process creates ffmpeg_g, ffplay_g, etc. which +contain full debug information. Those binaries are stripped to create +ffmpeg, ffplay, etc. If you need the debug information, use +the *_g versions. +

+ +

4.7 I do not like the LGPL, can I contribute code under the GPL instead?

+ +

Yes, as long as the code is optional and can easily and cleanly be placed +under #if CONFIG_GPL without breaking anything. So, for example, a new codec +or filter would be OK under GPL while a bug fix to LGPL code would not. +

+ +

4.8 I’m using FFmpeg from within my C application but the linker complains about missing symbols from the libraries themselves.

+ +

FFmpeg builds static libraries by default. In static libraries, dependencies +are not handled. That has two consequences. First, you must specify the +libraries in dependency order: -lavdevice must come before +-lavformat, -lavutil must come after everything else, etc. +Second, external libraries that are used in FFmpeg have to be specified too. +

+

An easy way to get the full list of required libraries in dependency order +is to use pkg-config. +

+
+
c99 -o program program.c $(pkg-config --cflags --libs libavformat libavcodec)
+
+ +

See doc/example/Makefile and doc/example/pc-uninstalled for +more details. +

+ +

4.9 I’m using FFmpeg from within my C++ application but the linker complains about missing symbols which seem to be available.

+ +

FFmpeg is a pure C project, so to use the libraries within your C++ application +you need to explicitly state that you are using a C library. You can do this by +encompassing your FFmpeg includes using extern "C". +

+

See http://www.parashift.com/c++-faq-lite/mixing-c-and-cpp.html#faq-32.3 +

+ +

4.10 I’m using libavutil from within my C++ application but the compiler complains about ’UINT64_C’ was not declared in this scope

+ +

FFmpeg is a pure C project using C99 math features, in order to enable C++ +to use them you have to append -D__STDC_CONSTANT_MACROS to your CXXFLAGS +

+ +

4.11 I have a file in memory / a API different from *open/*read/ libc how do I use it with libavformat?

+ +

You have to create a custom AVIOContext using avio_alloc_context, +see libavformat/aviobuf.c in FFmpeg and libmpdemux/demux_lavf.c in MPlayer or MPlayer2 sources. +

+ +

4.12 Where is the documentation about ffv1, msmpeg4, asv1, 4xm?

+ +

see https://www.ffmpeg.org/~michael/ +

+ +

4.13 How do I feed H.263-RTP (and other codecs in RTP) to libavcodec?

+ +

Even if peculiar since it is network oriented, RTP is a container like any +other. You have to demux RTP before feeding the payload to libavcodec. +In this specific case please look at RFC 4629 to see how it should be done. +

+ +

4.14 AVStream.r_frame_rate is wrong, it is much larger than the frame rate.

+ +

r_frame_rate is NOT the average frame rate, it is the smallest frame rate +that can accurately represent all timestamps. So no, it is not +wrong if it is larger than the average! +For example, if you have mixed 25 and 30 fps content, then r_frame_rate +will be 150 (it is the least common multiple). +If you are looking for the average frame rate, see AVStream.avg_frame_rate. +

+ +

4.15 Why is make fate not running all tests?

+ +

Make sure you have the fate-suite samples and the SAMPLES Make variable +or FATE_SAMPLES environment variable or the --samples +configure option is set to the right path. +

+ +

4.16 Why is make fate not finding the samples?

+ +

Do you happen to have a ~ character in the samples path to indicate a +home directory? The value is used in ways where the shell cannot expand it, +causing FATE to not find files. Just replace ~ by the full path. +

+ +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/fate.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/fate.html new file mode 100644 index 0000000..22aa586 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/fate.html @@ -0,0 +1,331 @@ + + + + + + + FFmpeg Automated Testing Environment + + + + + + +
+

+ FFmpeg Automated Testing Environment +

+
+
+ + + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Introduction

+ +

FATE is an extended regression suite on the client-side and a means +for results aggregation and presentation on the server-side. +

+

The first part of this document explains how you can use FATE from +your FFmpeg source directory to test your ffmpeg binary. The second +part describes how you can run FATE to submit the results to FFmpeg’s +FATE server. +

+

In any way you can have a look at the publicly viewable FATE results +by visiting this website: +

+

http://fate.ffmpeg.org/ +

+

This is especially recommended for all people contributing source +code to FFmpeg, as it can be seen if some test on some platform broke +with their recent contribution. This usually happens on the platforms +the developers could not test on. +

+

The second part of this document describes how you can run FATE to +submit your results to FFmpeg’s FATE server. If you want to submit your +results be sure to check that your combination of CPU, OS and compiler +is not already listed on the above mentioned website. +

+

In the third part you can find a comprehensive listing of FATE makefile +targets and variables. +

+ + +

2 Using FATE from your FFmpeg source directory

+ +

If you want to run FATE on your machine you need to have the samples +in place. You can get the samples via the build target fate-rsync. +Use this command from the top-level source directory: +

+
+
make fate-rsync SAMPLES=fate-suite/
+make fate       SAMPLES=fate-suite/
+
+ +

The above commands set the samples location by passing a makefile +variable via command line. It is also possible to set the samples +location at source configuration time by invoking configure with +--samples=<path to the samples directory>. Afterwards you can +invoke the makefile targets without setting the SAMPLES makefile +variable. This is illustrated by the following commands: +

+
+
./configure --samples=fate-suite/
+make fate-rsync
+make fate
+
+ +

Yet another way to tell FATE about the location of the sample +directory is by making sure the environment variable FATE_SAMPLES +contains the path to your samples directory. This can be achieved +by e.g. putting that variable in your shell profile or by setting +it in your interactive session. +

+
+
FATE_SAMPLES=fate-suite/ make fate
+
+ +
+

Do not put a ’~’ character in the samples path to indicate a home +directory. Because of shell nuances, this will cause FATE to fail. +

+

To use a custom wrapper to run the test, pass --target-exec to +configure or set the TARGET_EXEC Make variable. +

+ + +

3 Submitting the results to the FFmpeg result aggregation server

+ +

To submit your results to the server you should run fate through the +shell script tests/fate.sh from the FFmpeg sources. This script needs +to be invoked with a configuration file as its first argument. +

+
+
tests/fate.sh /path/to/fate_config
+
+ +

A configuration file template with comments describing the individual +configuration variables can be found at doc/fate_config.sh.template. +

+

The mentioned configuration template is also available here: +

slot=                                    # some unique identifier
+repo=git://source.ffmpeg.org/ffmpeg.git  # the source repository
+#branch=release/2.6                       # the branch to test
+samples=                                 # path to samples directory
+workdir=                                 # directory in which to do all the work
+#fate_recv="ssh -T fate@fate.ffmpeg.org" # command to submit report
+comment=                                 # optional description
+build_only=     # set to "yes" for a compile-only instance that skips tests
+ignore_tests=
+
+# the following are optional and map to configure options
+arch=
+cpu=
+cross_prefix=
+as=
+cc=
+ld=
+target_os=
+sysroot=
+target_exec=
+target_path=
+target_samples=
+extra_cflags=
+extra_ldflags=
+extra_libs=
+extra_conf=     # extra configure options not covered above
+
+#make=          # name of GNU make if not 'make'
+makeopts=       # extra options passed to 'make'
+#makeopts_fate= # extra options passed to 'make' when running tests,
+                # defaulting to makeopts above if this is not set
+#tar=           # command to create a tar archive from its arguments on stdout,
+                # defaults to 'tar c'
+
+

Create a configuration that suits your needs, based on the configuration +template. The slot configuration variable can be any string that is not +yet used, but it is suggested that you name it adhering to the following +pattern ‘arch-os-compiler-compiler version’. The +configuration file itself will be sourced in a shell script, therefore all +shell features may be used. This enables you to setup the environment as you +need it for your build. +

+

For your first test runs the fate_recv variable should be empty or +commented out. This will run everything as normal except that it will omit +the submission of the results to the server. The following files should be +present in $workdir as specified in the configuration file: +

+
    +
  • configure.log +
  • compile.log +
  • test.log +
  • report +
  • version +
+ +

When you have everything working properly you can create an SSH key pair +and send the public key to the FATE server administrator who can be contacted +at the email address fate-admin@ffmpeg.org. +

+

Configure your SSH client to use public key authentication with that key +when connecting to the FATE server. Also do not forget to check the identity +of the server and to accept its host key. This can usually be achieved by +running your SSH client manually and killing it after you accepted the key. +The FATE server’s fingerprint is: +

+
+
‘RSA’
+

d3:f1:83:97:a4:75:2b:a6:fb:d6:e8:aa:81:93:97:51 +

+
‘ECDSA’
+

76:9f:68:32:04:1e:d5:d4:ec:47:3f:dc:fc:18:17:86 +

+
+ +

If you have problems connecting to the FATE server, it may help to try out +the ssh command with one or more -v options. You should +get detailed output concerning your SSH configuration and the authentication +process. +

+

The only thing left is to automate the execution of the fate.sh script and +the synchronisation of the samples directory. +

+ +

4 Uploading new samples to the fate suite

+ +

If you need a sample uploaded send a mail to samples-request. +

+

This is for developers who have an account on the fate suite server. +If you upload new samples, please make sure they are as small as possible, +space on each client, network bandwidth and so on benefit from smaller test cases. +Also keep in mind older checkouts use existing sample files, that means in +practice generally do not replace, remove or overwrite files as it likely would +break older checkouts or releases. +Also all needed samples for a commit should be uploaded, ideally 24 +hours, before the push. +If you need an account for frequently uploading samples or you wish to help +others by doing that send a mail to ffmpeg-devel. +

+
+
#First update your local samples copy:
+rsync -vauL --chmod=Dg+s,Duo+x,ug+rw,o+r,o-w,+X fate-suite.ffmpeg.org:/home/samples/fate-suite/ ~/fate-suite
+
+#Then do a dry run checking what would be uploaded:
+rsync -vanL --no-g --chmod=Dg+s,Duo+x,ug+rw,o+r,o-w,+X ~/fate-suite/ fate-suite.ffmpeg.org:/home/samples/fate-suite
+
+#Upload the files:
+rsync -vaL  --no-g --chmod=Dg+s,Duo+x,ug+rw,o+r,o-w,+X ~/fate-suite/ fate-suite.ffmpeg.org:/home/samples/fate-suite
+
+ + + +

5 FATE makefile targets and variables

+ + +

5.1 Makefile targets

+ +
+
fate-rsync
+

Download/synchronize sample files to the configured samples directory. +

+
+
fate-list
+

Will list all fate/regression test targets. +

+
+
fate
+

Run the FATE test suite (requires the fate-suite dataset). +

+
+ + +

5.2 Makefile variables

+ +
+
V
+

Verbosity level, can be set to 0, 1 or 2. +

    +
  • 0: show just the test arguments +
  • 1: show just the command used in the test +
  • 2: show everything +
+ +
+
SAMPLES
+

Specify or override the path to the FATE samples at make time, it has a +meaning only while running the regression tests. +

+
+
THREADS
+

Specify how many threads to use while running regression tests, it is +quite useful to detect thread-related regressions. +

+
+
THREAD_TYPE
+

Specify which threading strategy test, either ‘slice’ or ‘frame’, +by default ‘slice+frame’ +

+
+
CPUFLAGS
+

Specify CPU flags. +

+
+
TARGET_EXEC
+

Specify or override the wrapper used to run the tests. +The TARGET_EXEC option provides a way to run FATE wrapped in +valgrind, qemu-user or wine or on remote targets +through ssh. +

+
+
GEN
+

Set to ‘1’ to generate the missing or mismatched references. +

+
+
HWACCEL
+

Specify which hardware acceleration to use while running regression tests, +by default ‘none’ is used. +

+
+
KEEP
+

Set to ‘1’ to keep temp files generated by fate test(s) when test is successful. +Default is ‘0’, which removes these files. Files are always kept when a test +fails. +

+
+
+ + +

5.3 Examples

+ +
+
make V=1 SAMPLES=/var/fate/samples THREADS=2 CPUFLAGS=mmx fate
+
+ +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-all.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-all.html new file mode 100644 index 0000000..baabb66 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-all.html @@ -0,0 +1,50392 @@ + + + + + + + ffmpeg Documentation + + + + + + +
+

+ ffmpeg Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Synopsis

+ +

ffmpeg [global_options] {[input_file_options] -i input_url} ... {[output_file_options] output_url} ... +

+ +

2 Description

+ +

ffmpeg is a very fast video and audio converter that can also grab from +a live audio/video source. It can also convert between arbitrary sample +rates and resize video on the fly with a high quality polyphase filter. +

+

ffmpeg reads from an arbitrary number of input "files" (which can be regular +files, pipes, network streams, grabbing devices, etc.), specified by the +-i option, and writes to an arbitrary number of output "files", which are +specified by a plain output url. Anything found on the command line which +cannot be interpreted as an option is considered to be an output url. +

+

Each input or output url can, in principle, contain any number of streams of +different types (video/audio/subtitle/attachment/data). The allowed number and/or +types of streams may be limited by the container format. Selecting which +streams from which inputs will go into which output is either done automatically +or with the -map option (see the Stream selection chapter). +

+

To refer to input files in options, you must use their indices (0-based). E.g. +the first input file is 0, the second is 1, etc. Similarly, streams +within a file are referred to by their indices. E.g. 2:3 refers to the +fourth stream in the third input file. Also see the Stream specifiers chapter. +

+

As a general rule, options are applied to the next specified +file. Therefore, order is important, and you can have the same +option on the command line multiple times. Each occurrence is +then applied to the next input or output file. +Exceptions from this rule are the global options (e.g. verbosity level), +which should be specified first. +

+

Do not mix input and output files – first specify all input files, then all +output files. Also do not mix options which belong to different files. All +options apply ONLY to the next input or output file and are reset between files. +

+
    +
  • To set the video bitrate of the output file to 64 kbit/s: +
    +
    ffmpeg -i input.avi -b:v 64k -bufsize 64k output.avi
+
    + +
  • To force the frame rate of the output file to 24 fps: +
    +
    ffmpeg -i input.avi -r 24 output.avi
+
    + +
  • To force the frame rate of the input file (valid for raw formats only) +to 1 fps and the frame rate of the output file to 24 fps: +
    +
    ffmpeg -r 1 -i input.m2v -r 24 output.avi
+
    +
+ +

The format option may be needed for raw input files. +

+ + +

3 Detailed description

+ +

The transcoding process in ffmpeg for each output can be described by +the following diagram: +

+
 _______              ______________
+|       |            |              |
+| input |  demuxer   | encoded data |   decoder
+| file  | ---------> | packets      | -----+
+|_______|            |______________|      |
+                                           v
+                                       _________
+                                      |         |
+                                      | decoded |
+                                      | frames  |
+                                      |_________|
+ ________             ______________       |
+|        |           |              |      |
+| output | <-------- | encoded data | <----+
+| file   |   muxer   | packets      |   encoder
+|________|           |______________|
+
+
+
+

ffmpeg calls the libavformat library (containing demuxers) to read +input files and get packets containing encoded data from them. When there are +multiple input files, ffmpeg tries to keep them synchronized by +tracking lowest timestamp on any active input stream. +

+

Encoded packets are then passed to the decoder (unless streamcopy is selected +for the stream, see further for a description). The decoder produces +uncompressed frames (raw video/PCM audio/...) which can be processed further by +filtering (see next section). After filtering, the frames are passed to the +encoder, which encodes them and outputs encoded packets. Finally those are +passed to the muxer, which writes the encoded packets to the output file. +

+ +

3.1 Filtering

+

Before encoding, ffmpeg can process raw audio and video frames using +filters from the libavfilter library. Several chained filters form a filter +graph. ffmpeg distinguishes between two types of filtergraphs: +simple and complex. +

+ +

3.1.1 Simple filtergraphs

+

Simple filtergraphs are those that have exactly one input and output, both of +the same type. In the above diagram they can be represented by simply inserting +an additional step between decoding and encoding: +

+
 _________                        ______________
+|         |                      |              |
+| decoded |                      | encoded data |
+| frames  |\                   _ | packets      |
+|_________| \                  /||______________|
+             \   __________   /
+  simple     _\||          | /  encoder
+  filtergraph   | filtered |/
+                | frames   |
+                |__________|
+
+
+

Simple filtergraphs are configured with the per-stream -filter option +(with -vf and -af aliases for video and audio respectively). +A simple filtergraph for video can look for example like this: +

+
 _______        _____________        _______        ________
+|       |      |             |      |       |      |        |
+| input | ---> | deinterlace | ---> | scale | ---> | output |
+|_______|      |_____________|      |_______|      |________|
+
+
+

Note that some filters change frame properties but not frame contents. E.g. the +fps filter in the example above changes number of frames, but does not +touch the frame contents. Another example is the setpts filter, which +only sets timestamps and otherwise passes the frames unchanged. +

+ +

3.1.2 Complex filtergraphs

+

Complex filtergraphs are those which cannot be described as simply a linear +processing chain applied to one stream. This is the case, for example, when the graph has +more than one input and/or output, or when output stream type is different from +input. They can be represented with the following diagram: +

+
 _________
+|         |
+| input 0 |\                    __________
+|_________| \                  |          |
+             \   _________    /| output 0 |
+              \ |         |  / |__________|
+ _________     \| complex | /
+|         |     |         |/
+| input 1 |---->| filter  |\
+|_________|     |         | \   __________
+               /| graph   |  \ |          |
+              / |         |   \| output 1 |
+ _________   /  |_________|    |__________|
+|         | /
+| input 2 |/
+|_________|
+
+
+

Complex filtergraphs are configured with the -filter_complex option. +Note that this option is global, since a complex filtergraph, by its nature, +cannot be unambiguously associated with a single stream or file. +

+

The -lavfi option is equivalent to -filter_complex. +

+

A trivial example of a complex filtergraph is the overlay filter, which +has two video inputs and one video output, containing one video overlaid on top +of the other. Its audio counterpart is the amix filter. +

+ +

3.2 Stream copy

+

Stream copy is a mode selected by supplying the copy parameter to the +-codec option. It makes ffmpeg omit the decoding and encoding +step for the specified stream, so it does only demuxing and muxing. It is useful +for changing the container format or modifying container-level metadata. The +diagram above will, in this case, simplify to this: +

+
 _______              ______________            ________
+|       |            |              |          |        |
+| input |  demuxer   | encoded data |  muxer   | output |
+| file  | ---------> | packets      | -------> | file   |
+|_______|            |______________|          |________|
+
+
+

Since there is no decoding or encoding, it is very fast and there is no quality +loss. However, it might not work in some cases because of many factors. Applying +filters is obviously also impossible, since filters work on uncompressed data. +

+ + +

4 Stream selection

+ +

ffmpeg provides the -map option for manual control of stream selection in each +output file. Users can skip -map and let ffmpeg perform automatic stream selection as +described below. The -vn / -an / -sn / -dn options can be used to skip inclusion of +video, audio, subtitle and data streams respectively, whether manually mapped or automatically +selected, except for those streams which are outputs of complex filtergraphs. +

+ +

4.1 Description

+

The sub-sections that follow describe the various rules that are involved in stream selection. +The examples that follow next show how these rules are applied in practice. +

+

While every effort is made to accurately reflect the behavior of the program, FFmpeg is under +continuous development and the code may have changed since the time of this writing. +

+ +

4.1.1 Automatic stream selection

+ +

In the absence of any map options for a particular output file, ffmpeg inspects the output +format to check which type of streams can be included in it, viz. video, audio and/or +subtitles. For each acceptable stream type, ffmpeg will pick one stream, when available, +from among all the inputs. +

+

It will select that stream based upon the following criteria: +

    +
  • for video, it is the stream with the highest resolution, +
  • for audio, it is the stream with the most channels, +
  • for subtitles, it is the first subtitle stream found but there’s a caveat. +The output format’s default subtitle encoder can be either text-based or image-based, +and only a subtitle stream of the same type will be chosen. +
+ +

In the case where several streams of the same type rate equally, the stream with the lowest +index is chosen. +

+

Data or attachment streams are not automatically selected and can only be included +using -map. +

+

4.1.2 Manual stream selection

+ +

When -map is used, only user-mapped streams are included in that output file, +with one possible exception for filtergraph outputs described below. +

+ +

4.1.3 Complex filtergraphs

+ +

If there are any complex filtergraph output streams with unlabeled pads, they will be added +to the first output file. This will lead to a fatal error if the stream type is not supported +by the output format. In the absence of the map option, the inclusion of these streams leads +to the automatic stream selection of their types being skipped. If map options are present, +these filtergraph streams are included in addition to the mapped streams. +

+

Complex filtergraph output streams with labeled pads must be mapped once and exactly once. +

+ +

4.1.4 Stream handling

+ +

Stream handling is independent of stream selection, with an exception for subtitles described +below. Stream handling is set via the -codec option addressed to streams within a +specific output file. In particular, codec options are applied by ffmpeg after the +stream selection process and thus do not influence the latter. If no -codec option is +specified for a stream type, ffmpeg will select the default encoder registered by the output +file muxer. +

+

An exception exists for subtitles. If a subtitle encoder is specified for an output file, the +first subtitle stream found of any type, text or image, will be included. ffmpeg does not validate +if the specified encoder can convert the selected stream or if the converted stream is acceptable +within the output format. This applies generally as well: when the user sets an encoder manually, +the stream selection process cannot check if the encoded stream can be muxed into the output file. +If it cannot, ffmpeg will abort and all output files will fail to be processed. +

+ +

4.2 Examples

+ +

The following examples illustrate the behavior, quirks and limitations of ffmpeg’s stream +selection methods. +

+

They assume the following three input files. +

+
+input file 'A.avi'
+      stream 0: video 640x360
+      stream 1: audio 2 channels
+
+input file 'B.mp4'
+      stream 0: video 1920x1080
+      stream 1: audio 2 channels
+      stream 2: subtitles (text)
+      stream 3: audio 5.1 channels
+      stream 4: subtitles (text)
+
+input file 'C.mkv'
+      stream 0: video 1280x720
+      stream 1: audio 2 channels
+      stream 2: subtitles (image)
+
+ +
+
ffmpeg -i A.avi -i B.mp4 out1.mkv out2.wav -map 1:a -c:a copy out3.mov
+
+

There are three output files specified, and for the first two, no -map options +are set, so ffmpeg will select streams for these two files automatically. +

+

out1.mkv is a Matroska container file and accepts video, audio and subtitle streams, +so ffmpeg will try to select one of each type.
+For video, it will select stream 0 from B.mp4, which has the highest +resolution among all the input video streams.
+For audio, it will select stream 3 from B.mp4, since it has the greatest +number of channels.
+For subtitles, it will select stream 2 from B.mp4, which is the first subtitle +stream from among A.avi and B.mp4. +

+

out2.wav accepts only audio streams, so only stream 3 from B.mp4 is +selected. +

+

For out3.mov, since a -map option is set, no automatic stream selection will +occur. The -map 1:a option will select all audio streams from the second input +B.mp4. No other streams will be included in this output file. +

+

For the first two outputs, all included streams will be transcoded. The encoders chosen will +be the default ones registered by each output format, which may not match the codec of the +selected input streams. +

+

For the third output, codec option for audio streams has been set +to copy, so no decoding-filtering-encoding operations will occur, or can occur. +Packets of selected streams shall be conveyed from the input file and muxed within the output +file. +

+ +
+
ffmpeg -i C.mkv out1.mkv -c:s dvdsub -an out2.mkv
+
+

Although out1.mkv is a Matroska container file which accepts subtitle streams, only a +video and audio stream shall be selected. The subtitle stream of C.mkv is image-based +and the default subtitle encoder of the Matroska muxer is text-based, so a transcode operation +for the subtitles is expected to fail and hence the stream isn’t selected. However, in +out2.mkv, a subtitle encoder is specified in the command and so, the subtitle stream is +selected, in addition to the video stream. The presence of -an disables audio stream +selection for out2.mkv. +

+ +
+
ffmpeg -i A.avi -i C.mkv -i B.mp4 -filter_complex "overlay" out1.mp4 out2.srt
+
+

A filtergraph is setup here using the -filter_complex option and consists of a single +video filter. The overlay filter requires exactly two video inputs, but none are +specified, so the first two available video streams are used, those of A.avi and +C.mkv. The output pad of the filter has no label and so is sent to the first output file +out1.mp4. Due to this, automatic selection of the video stream is skipped, which would +have selected the stream in B.mp4. The audio stream with most channels viz. stream 3 +in B.mp4, is chosen automatically. No subtitle stream is chosen however, since the MP4 +format has no default subtitle encoder registered, and the user hasn’t specified a subtitle encoder. +

+

The 2nd output file, out2.srt, only accepts text-based subtitle streams. So, even though +the first subtitle stream available belongs to C.mkv, it is image-based and hence skipped. +The selected stream, stream 2 in B.mp4, is the first text-based subtitle stream. +

+ +
+
ffmpeg -i A.avi -i B.mp4 -i C.mkv -filter_complex "[1:v]hue=s=0[outv];overlay;aresample" \
+       -map '[outv]' -an        out1.mp4 \
+                                out2.mkv \
+       -map '[outv]' -map 1:a:0 out3.mkv
+
+ +

The above command will fail, as the output pad labelled [outv] has been mapped twice. +None of the output files shall be processed. +

+
+
ffmpeg -i A.avi -i B.mp4 -i C.mkv -filter_complex "[1:v]hue=s=0[outv];overlay;aresample" \
+       -an        out1.mp4 \
+                  out2.mkv \
+       -map 1:a:0 out3.mkv
+
+ +

This command above will also fail as the hue filter output has a label, [outv], +and hasn’t been mapped anywhere. +

+

The command should be modified as follows, +

+
ffmpeg -i A.avi -i B.mp4 -i C.mkv -filter_complex "[1:v]hue=s=0,split=2[outv1][outv2];overlay;aresample" \
+        -map '[outv1]' -an        out1.mp4 \
+                                  out2.mkv \
+        -map '[outv2]' -map 1:a:0 out3.mkv
+
+

The video stream from B.mp4 is sent to the hue filter, whose output is cloned once using +the split filter, and both outputs labelled. Then a copy each is mapped to the first and third +output files. +

+

The overlay filter, requiring two video inputs, uses the first two unused video streams. Those +are the streams from A.avi and C.mkv. The overlay output isn’t labelled, so it is +sent to the first output file out1.mp4, regardless of the presence of the -map option. +

+

The aresample filter is sent the first unused audio stream, that of A.avi. Since this filter +output is also unlabelled, it too is mapped to the first output file. The presence of -an +only suppresses automatic or manual stream selection of audio streams, not outputs sent from +filtergraphs. Both these mapped streams shall be ordered before the mapped stream in out1.mp4. +

+

The video, audio and subtitle streams mapped to out2.mkv are entirely determined by +automatic stream selection. +

+

out3.mkv consists of the cloned video output from the hue filter and the first audio +stream from B.mp4. +
+

+ + +

5 Options

+ +

All the numerical options, if not specified otherwise, accept a string +representing a number as input, which may be followed by one of the SI +unit prefixes, for example: ’K’, ’M’, or ’G’. +

+

If ’i’ is appended to the SI unit prefix, the complete prefix will be +interpreted as a unit prefix for binary multiples, which are based on +powers of 1024 instead of powers of 1000. Appending ’B’ to the SI unit +prefix multiplies the value by 8. This allows using, for example: +’KB’, ’MiB’, ’G’ and ’B’ as number suffixes. +

+

Options which do not take arguments are boolean options, and set the +corresponding value to true. They can be set to false by prefixing +the option name with "no". For example using "-nofoo" +will set the boolean option with name "foo" to false. +

+ +

5.1 Stream specifiers

+

Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers +are used to precisely specify which stream(s) a given option belongs to. +

+

A stream specifier is a string generally appended to the option name and +separated from it by a colon. E.g. -codec:a:1 ac3 contains the +a:1 stream specifier, which matches the second audio stream. Therefore, it +would select the ac3 codec for the second audio stream. +

+

A stream specifier can match several streams, so that the option is applied to all +of them. E.g. the stream specifier in -b:a 128k matches all audio +streams. +

+

An empty stream specifier matches all streams. For example, -codec copy +or -codec: copy would copy all the streams without reencoding. +

+

Possible forms of stream specifiers are: +

+
stream_index
+

Matches the stream with this index. E.g. -threads:1 4 would set the +thread count for the second stream to 4. If stream_index is used as an +additional stream specifier (see below), then it selects stream number +stream_index from the matching streams. Stream numbering is based on the +order of the streams as detected by libavformat except when a program ID is +also specified. In this case it is based on the ordering of the streams in the +program. +

+
stream_type[:additional_stream_specifier]
+

stream_type is one of following: ’v’ or ’V’ for video, ’a’ for audio, ’s’ +for subtitle, ’d’ for data, and ’t’ for attachments. ’v’ matches all video +streams, ’V’ only matches video streams which are not attached pictures, video +thumbnails or cover arts. If additional_stream_specifier is used, then +it matches streams which both have this type and match the +additional_stream_specifier. Otherwise, it matches all streams of the +specified type. +

+
p:program_id[:additional_stream_specifier]
+

Matches streams which are in the program with the id program_id. If +additional_stream_specifier is used, then it matches streams which both +are part of the program and match the additional_stream_specifier. +

+
+
#stream_id or i:stream_id
+

Match the stream by stream id (e.g. PID in MPEG-TS container). +

+
m:key[:value]
+

Matches streams with the metadata tag key having the specified value. If +value is not given, matches streams that contain the given tag with any +value. +

+
u
+

Matches streams with usable configuration, the codec must be defined and the +essential information such as video dimension or audio sample rate must be present. +

+

Note that in ffmpeg, matching by metadata will only work properly for +input files. +

+
+ + +

5.2 Generic options

+ +

These options are shared amongst the ff* tools. +

+
+
-L
+

Show license. +

+
+
-h, -?, -help, --help [arg]
+

Show help. An optional parameter may be specified to print help about a specific +item. If no argument is specified, only basic (non advanced) tool +options are shown. +

+

Possible values of arg are: +

+
long
+

Print advanced tool options in addition to the basic tool options. +

+
+
full
+

Print complete list of options, including shared and private options +for encoders, decoders, demuxers, muxers, filters, etc. +

+
+
decoder=decoder_name
+

Print detailed information about the decoder named decoder_name. Use the +-decoders option to get a list of all decoders. +

+
+
encoder=encoder_name
+

Print detailed information about the encoder named encoder_name. Use the +-encoders option to get a list of all encoders. +

+
+
demuxer=demuxer_name
+

Print detailed information about the demuxer named demuxer_name. Use the +-formats option to get a list of all demuxers and muxers. +

+
+
muxer=muxer_name
+

Print detailed information about the muxer named muxer_name. Use the +-formats option to get a list of all muxers and demuxers. +

+
+
filter=filter_name
+

Print detailed information about the filter name filter_name. Use the +-filters option to get a list of all filters. +

+
+
bsf=bitstream_filter_name
+

Print detailed information about the bitstream filter name bitstream_filter_name. +Use the -bsfs option to get a list of all bitstream filters. +

+
+ +
+
-version
+

Show version. +

+
+
-formats
+

Show available formats (including devices). +

+
+
-demuxers
+

Show available demuxers. +

+
+
-muxers
+

Show available muxers. +

+
+
-devices
+

Show available devices. +

+
+
-codecs
+

Show all codecs known to libavcodec. +

+

Note that the term ’codec’ is used throughout this documentation as a shortcut +for what is more correctly called a media bitstream format. +

+
+
-decoders
+

Show available decoders. +

+
+
-encoders
+

Show all available encoders. +

+
+
-bsfs
+

Show available bitstream filters. +

+
+
-protocols
+

Show available protocols. +

+
+
-filters
+

Show available libavfilter filters. +

+
+
-pix_fmts
+

Show available pixel formats. +

+
+
-sample_fmts
+

Show available sample formats. +

+
+
-layouts
+

Show channel names and standard channel layouts. +

+
+
-colors
+

Show recognized color names. +

+
+
-sources device[,opt1=val1[,opt2=val2]...]
+

Show autodetected sources of the input device. +Some devices may provide system-dependent source names that cannot be autodetected. +The returned list cannot be assumed to be always complete. +

+
ffmpeg -sources pulse,server=192.168.0.4
+
+ +
+
-sinks device[,opt1=val1[,opt2=val2]...]
+

Show autodetected sinks of the output device. +Some devices may provide system-dependent sink names that cannot be autodetected. +The returned list cannot be assumed to be always complete. +

+
ffmpeg -sinks pulse,server=192.168.0.4
+
+ +
+
-loglevel [flags+]loglevel | -v [flags+]loglevel
+

Set logging level and flags used by the library. +

+

The optional flags prefix can consist of the following values: +

+
‘repeat’
+

Indicates that repeated log output should not be compressed to the first line +and the "Last message repeated n times" line will be omitted. +

+
‘level’
+

Indicates that log output should add a [level] prefix to each message +line. This can be used as an alternative to log coloring, e.g. when dumping the +log to file. +

+
+

Flags can also be used alone by adding a ’+’/’-’ prefix to set/reset a single +flag without affecting other flags or changing loglevel. When +setting both flags and loglevel, a ’+’ separator is expected +between the last flags value and before loglevel. +

+

loglevel is a string or a number containing one of the following values: +

+
‘quiet, -8’
+

Show nothing at all; be silent. +

+
‘panic, 0’
+

Only show fatal errors which could lead the process to crash, such as +an assertion failure. This is not currently used for anything. +

+
‘fatal, 8’
+

Only show fatal errors. These are errors after which the process absolutely +cannot continue. +

+
‘error, 16’
+

Show all errors, including ones which can be recovered from. +

+
‘warning, 24’
+

Show all warnings and errors. Any message related to possibly +incorrect or unexpected events will be shown. +

+
‘info, 32’
+

Show informative messages during processing. This is in addition to +warnings and errors. This is the default value. +

+
‘verbose, 40’
+

Same as info, except more verbose. +

+
‘debug, 48’
+

Show everything, including debugging information. +

+
‘trace, 56’
+
+ +

For example to enable repeated log output, add the level prefix, and set +loglevel to verbose: +

+
ffmpeg -loglevel repeat+level+verbose -i input output
+
+

Another example that enables repeated log output without affecting current +state of level prefix flag or loglevel: +

+
ffmpeg [...] -loglevel +repeat
+
+ +

By default the program logs to stderr. If coloring is supported by the +terminal, colors are used to mark errors and warnings. Log coloring +can be disabled setting the environment variable +AV_LOG_FORCE_NOCOLOR, or can be forced setting +the environment variable AV_LOG_FORCE_COLOR. +

+
+
-report
+

Dump full command line and log output to a file named +program-YYYYMMDD-HHMMSS.log in the current +directory. +This file can be useful for bug reports. +It also implies -loglevel debug. +

+

Setting the environment variable FFREPORT to any value has the +same effect. If the value is a ’:’-separated key=value sequence, these +options will affect the report; option values must be escaped if they +contain special characters or the options delimiter ’:’ (see the +“Quoting and escaping” section in the ffmpeg-utils manual). +

+

The following options are recognized: +

+
file
+

set the file name to use for the report; %p is expanded to the name +of the program, %t is expanded to a timestamp, %% is expanded +to a plain % +

+
level
+

set the log verbosity level using a numerical value (see -loglevel). +

+
+ +

For example, to output a report to a file named ffreport.log +using a log level of 32 (alias for log level info): +

+
+
FFREPORT=file=ffreport.log:level=32 ffmpeg -i input output
+
+ +

Errors in parsing the environment variable are not fatal, and will not +appear in the report. +

+
+
-hide_banner
+

Suppress printing banner. +

+

All FFmpeg tools will normally show a copyright notice, build options +and library versions. This option can be used to suppress printing +this information. +

+
+
-cpuflags flags (global)
+

Allows setting and clearing cpu flags. This option is intended +for testing. Do not use it unless you know what you’re doing. +

+
ffmpeg -cpuflags -sse+mmx ...
+ffmpeg -cpuflags mmx ...
+ffmpeg -cpuflags 0 ...
+
+

Possible flags for this option are: +

+
‘x86’
+
+
‘mmx’
+
‘mmxext’
+
‘sse’
+
‘sse2’
+
‘sse2slow’
+
‘sse3’
+
‘sse3slow’
+
‘ssse3’
+
‘atom’
+
‘sse4.1’
+
‘sse4.2’
+
‘avx’
+
‘avx2’
+
‘xop’
+
‘fma3’
+
‘fma4’
+
‘3dnow’
+
‘3dnowext’
+
‘bmi1’
+
‘bmi2’
+
‘cmov’
+
+
+
‘ARM’
+
+
‘armv5te’
+
‘armv6’
+
‘armv6t2’
+
‘vfp’
+
‘vfpv3’
+
‘neon’
+
‘setend’
+
+
+
‘AArch64’
+
+
‘armv8’
+
‘vfp’
+
‘neon’
+
+
+
‘PowerPC’
+
+
‘altivec’
+
+
+
‘Specific Processors’
+
+
‘pentium2’
+
‘pentium3’
+
‘pentium4’
+
‘k6’
+
‘k62’
+
‘athlon’
+
‘athlonxp’
+
‘k8’
+
+
+
+
+
+ + +

5.3 AVOptions

+ +

These options are provided directly by the libavformat, libavdevice and +libavcodec libraries. To see the list of available AVOptions, use the +-help option. They are separated into two categories: +

+
generic
+

These options can be set for any container, codec or device. Generic options +are listed under AVFormatContext options for containers/devices and under +AVCodecContext options for codecs. +

+
private
+

These options are specific to the given container, device or codec. Private +options are listed under their corresponding containers/devices/codecs. +

+
+ +

For example to write an ID3v2.3 header instead of a default ID3v2.4 to +an MP3 file, use the id3v2_version private option of the MP3 +muxer: +

+
ffmpeg -i input.flac -id3v2_version 3 out.mp3
+
+ +

All codec AVOptions are per-stream, and thus a stream specifier +should be attached to them: +

+
ffmpeg -i multichannel.mxf -map 0:v:0 -map 0:a:0 -map 0:a:0 -c:a:0 ac3 -b:a:0 640k -ac:a:1 2 -c:a:1 aac -b:2 128k out.mp4
+
+ +

In the above example, a multichannel audio stream is mapped twice for output. +The first instance is encoded with codec ac3 and bitrate 640k. +The second instance is downmixed to 2 channels and encoded with codec aac. A bitrate of 128k is specified for it using +absolute index of the output stream. +

+

Note: the -nooption syntax cannot be used for boolean +AVOptions, use -option 0/-option 1. +

+

Note: the old undocumented way of specifying per-stream AVOptions by +prepending v/a/s to the options name is now obsolete and will be +removed soon. +

+ +

5.4 Main options

+ +
+
-f fmt (input/output)
+

Force input or output file format. The format is normally auto detected for input +files and guessed from the file extension for output files, so this option is not +needed in most cases. +

+
+
-i url (input)
+

input file url +

+
+
-y (global)
+

Overwrite output files without asking. +

+
+
-n (global)
+

Do not overwrite output files, and exit immediately if a specified +output file already exists. +

+
+
-stream_loop number (input)
+

Set number of times input stream shall be looped. Loop 0 means no loop, +loop -1 means infinite loop. +

+
+
-c[:stream_specifier] codec (input/output,per-stream)
+
-codec[:stream_specifier] codec (input/output,per-stream)
+

Select an encoder (when used before an output file) or a decoder (when used +before an input file) for one or more streams. codec is the name of a +decoder/encoder or a special value copy (output only) to indicate that +the stream is not to be re-encoded. +

+

For example +

+
ffmpeg -i INPUT -map 0 -c:v libx264 -c:a copy OUTPUT
+
+

encodes all video streams with libx264 and copies all audio streams. +

+

For each stream, the last matching c option is applied, so +

+
ffmpeg -i INPUT -map 0 -c copy -c:v:1 libx264 -c:a:137 libvorbis OUTPUT
+
+

will copy all the streams except the second video, which will be encoded with +libx264, and the 138th audio, which will be encoded with libvorbis. +

+
+
-t duration (input/output)
+

When used as an input option (before -i), limit the duration of +data read from the input file. +

+

When used as an output option (before an output url), stop writing the +output after its duration reaches duration. +

+

duration must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+

-to and -t are mutually exclusive and -t has priority. +

+
+
-to position (input/output)
+

Stop writing the output or reading the input at position. +position must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+

-to and -t are mutually exclusive and -t has priority. +

+
+
-fs limit_size (output)
+

Set the file size limit, expressed in bytes. No further chunk of bytes is written +after the limit is exceeded. The size of the output file is slightly more than the +requested file size. +

+
+
-ss position (input/output)
+

When used as an input option (before -i), seeks in this input file to +position. Note that in most formats it is not possible to seek exactly, +so ffmpeg will seek to the closest seek point before position. +When transcoding and -accurate_seek is enabled (the default), this +extra segment between the seek point and position will be decoded and +discarded. When doing stream copy or when -noaccurate_seek is used, it +will be preserved. +

+

When used as an output option (before an output url), decodes but discards +input until the timestamps reach position. +

+

position must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+
+
-sseof position (input)
+
+

Like the -ss option but relative to the "end of file". That is negative +values are earlier in the file, 0 is at EOF. +

+
+
-itsoffset offset (input)
+

Set the input time offset. +

+

offset must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+

The offset is added to the timestamps of the input files. Specifying +a positive offset means that the corresponding streams are delayed by +the time duration specified in offset. +

+
+
-itsscale scale (input,per-stream)
+

Rescale input timestamps. scale should be a floating point number. +

+
+
-timestamp date (output)
+

Set the recording timestamp in the container. +

+

date must be a date specification, +see (ffmpeg-utils)the Date section in the ffmpeg-utils(1) manual. +

+
+
-metadata[:metadata_specifier] key=value (output,per-metadata)
+

Set a metadata key/value pair. +

+

An optional metadata_specifier may be given to set metadata +on streams, chapters or programs. See -map_metadata +documentation for details. +

+

This option overrides metadata set with -map_metadata. It is +also possible to delete metadata by using an empty value. +

+

For example, for setting the title in the output file: +

+
ffmpeg -i in.avi -metadata title="my title" out.flv
+
+ +

To set the language of the first audio stream: +

+
ffmpeg -i INPUT -metadata:s:a:0 language=eng OUTPUT
+
+ +
+
-disposition[:stream_specifier] value (output,per-stream)
+

Sets the disposition for a stream. +

+

This option overrides the disposition copied from the input stream. It is also +possible to delete the disposition by setting it to 0. +

+

The following dispositions are recognized: +

+
default
+
dub
+
original
+
comment
+
lyrics
+
karaoke
+
forced
+
hearing_impaired
+
visual_impaired
+
clean_effects
+
attached_pic
+
captions
+
descriptions
+
dependent
+
metadata
+
+ +

For example, to make the second audio stream the default stream: +

+
ffmpeg -i in.mkv -c copy -disposition:a:1 default out.mkv
+
+ +

To make the second subtitle stream the default stream and remove the default +disposition from the first subtitle stream: +

+
ffmpeg -i in.mkv -c copy -disposition:s:0 0 -disposition:s:1 default out.mkv
+
+ +

To add an embedded cover/thumbnail: +

+
ffmpeg -i in.mp4 -i IMAGE -map 0 -map 1 -c copy -c:v:1 png -disposition:v:1 attached_pic out.mp4
+
+ +

Not all muxers support embedded thumbnails, and those who do, only support a few formats, like JPEG or PNG. +

+
+
-program [title=title:][program_num=program_num:]st=stream[:st=stream...] (output)
+
+

Creates a program with the specified title, program_num and adds the specified +stream(s) to it. +

+
+
-target type (output)
+

Specify target file type (vcd, svcd, dvd, dv, +dv50). type may be prefixed with pal-, ntsc- or +film- to use the corresponding standard. All the format options +(bitrate, codecs, buffer sizes) are then set automatically. You can just type: +

+
+
ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
+
+ +

Nevertheless you can specify additional options as long as you know +they do not conflict with the standard, as in: +

+
+
ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
+
+ +
+
-dn (input/output)
+

As an input option, blocks all data streams of a file from being filtered or +being automatically selected or mapped for any output. See -discard +option to disable streams individually. +

+

As an output option, disables data recording i.e. automatic selection or +mapping of any data stream. For full manual control see the -map +option. +

+
+
-dframes number (output)
+

Set the number of data frames to output. This is an obsolete alias for +-frames:d, which you should use instead. +

+
+
-frames[:stream_specifier] framecount (output,per-stream)
+

Stop writing to the stream after framecount frames. +

+
+
-q[:stream_specifier] q (output,per-stream)
+
-qscale[:stream_specifier] q (output,per-stream)
+

Use fixed quality scale (VBR). The meaning of q/qscale is +codec-dependent. +If qscale is used without a stream_specifier then it applies only +to the video stream, this is to maintain compatibility with previous behavior +and as specifying the same codec specific value to 2 different codecs that is +audio and video generally is not what is intended when no stream_specifier is +used. +

+
+
-filter[:stream_specifier] filtergraph (output,per-stream)
+

Create the filtergraph specified by filtergraph and use it to +filter the stream. +

+

filtergraph is a description of the filtergraph to apply to +the stream, and must have a single input and a single output of the +same type of the stream. In the filtergraph, the input is associated +to the label in, and the output to the label out. See +the ffmpeg-filters manual for more information about the filtergraph +syntax. +

+

See the -filter_complex option if you +want to create filtergraphs with multiple inputs and/or outputs. +

+
+
-filter_script[:stream_specifier] filename (output,per-stream)
+

This option is similar to -filter, the only difference is that its +argument is the name of the file from which a filtergraph description is to be +read. +

+
+
-filter_threads nb_threads (global)
+

Defines how many threads are used to process a filter pipeline. Each pipeline +will produce a thread pool with this many threads available for parallel processing. +The default is the number of available CPUs. +

+
+
-pre[:stream_specifier] preset_name (output,per-stream)
+

Specify the preset for matching stream(s). +

+
+
-stats (global)
+

Print encoding progress/statistics. It is on by default, to explicitly +disable it you need to specify -nostats. +

+
+
-progress url (global)
+

Send program-friendly progress information to url. +

+

Progress information is written approximately every second and at the end of +the encoding process. It is made of "key=value" lines. key +consists of only alphanumeric characters. The last key of a sequence of +progress information is always "progress". +

+
+
-stdin
+

Enable interaction on standard input. On by default unless standard input is +used as an input. To explicitly disable interaction you need to specify +-nostdin. +

+

Disabling interaction on standard input is useful, for example, if +ffmpeg is in the background process group. Roughly the same result can +be achieved with ffmpeg ... < /dev/null but it requires a +shell. +

+
+
-debug_ts (global)
+

Print timestamp information. It is off by default. This option is +mostly useful for testing and debugging purposes, and the output +format may change from one version to another, so it should not be +employed by portable scripts. +

+

See also the option -fdebug ts. +

+
+
-attach filename (output)
+

Add an attachment to the output file. This is supported by a few formats +like Matroska for e.g. fonts used in rendering subtitles. Attachments +are implemented as a specific type of stream, so this option will add +a new stream to the file. It is then possible to use per-stream options +on this stream in the usual way. Attachment streams created with this +option will be created after all the other streams (i.e. those created +with -map or automatic mappings). +

+

Note that for Matroska you also have to set the mimetype metadata tag: +

+
ffmpeg -i INPUT -attach DejaVuSans.ttf -metadata:s:2 mimetype=application/x-truetype-font out.mkv
+
+

(assuming that the attachment stream will be third in the output file). +

+
+
-dump_attachment[:stream_specifier] filename (input,per-stream)
+

Extract the matching attachment stream into a file named filename. If +filename is empty, then the value of the filename metadata tag +will be used. +

+

E.g. to extract the first attachment to a file named ’out.ttf’: +

+
ffmpeg -dump_attachment:t:0 out.ttf -i INPUT
+
+

To extract all attachments to files determined by the filename tag: +

+
ffmpeg -dump_attachment:t "" -i INPUT
+
+ +

Technical note – attachments are implemented as codec extradata, so this +option can actually be used to extract extradata from any stream, not just +attachments. +

+
+
-noautorotate
+

Disable automatically rotating video based on file metadata. +

+
+
+ + +

5.5 Video Options

+ +
+
-vframes number (output)
+

Set the number of video frames to output. This is an obsolete alias for +-frames:v, which you should use instead. +

+
-r[:stream_specifier] fps (input/output,per-stream)
+

Set frame rate (Hz value, fraction or abbreviation). +

+

As an input option, ignore any timestamps stored in the file and instead +generate timestamps assuming constant frame rate fps. +This is not the same as the -framerate option used for some input formats +like image2 or v4l2 (it used to be the same in older versions of FFmpeg). +If in doubt use -framerate instead of the input option -r. +

+

As an output option, duplicate or drop input frames to achieve constant output +frame rate fps. +

+
+
-s[:stream_specifier] size (input/output,per-stream)
+

Set frame size. +

+

As an input option, this is a shortcut for the video_size private +option, recognized by some demuxers for which the frame size is either not +stored in the file or is configurable – e.g. raw video or video grabbers. +

+

As an output option, this inserts the scale video filter to the +end of the corresponding filtergraph. Please use the scale filter +directly to insert it at the beginning or some other place. +

+

The format is ‘wxh’ (default - same as source). +

+
+
-aspect[:stream_specifier] aspect (output,per-stream)
+

Set the video display aspect ratio specified by aspect. +

+

aspect can be a floating point number string, or a string of the +form num:den, where num and den are the +numerator and denominator of the aspect ratio. For example "4:3", +"16:9", "1.3333", and "1.7777" are valid argument values. +

+

If used together with -vcodec copy, it will affect the aspect ratio +stored at container level, but not the aspect ratio stored in encoded +frames, if it exists. +

+
+
-vn (input/output)
+

As an input option, blocks all video streams of a file from being filtered or +being automatically selected or mapped for any output. See -discard +option to disable streams individually. +

+

As an output option, disables video recording i.e. automatic selection or +mapping of any video stream. For full manual control see the -map +option. +

+
+
-vcodec codec (output)
+

Set the video codec. This is an alias for -codec:v. +

+
+
-pass[:stream_specifier] n (output,per-stream)
+

Select the pass number (1 or 2). It is used to do two-pass +video encoding. The statistics of the video are recorded in the first +pass into a log file (see also the option -passlogfile), +and in the second pass that log file is used to generate the video +at the exact requested bitrate. +On pass 1, you may just deactivate audio and set output to null, +examples for Windows and Unix: +

+
ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y NUL
+ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y /dev/null
+
+ +
+
-passlogfile[:stream_specifier] prefix (output,per-stream)
+

Set two-pass log file name prefix to prefix, the default file name +prefix is “ffmpeg2pass”. The complete file name will be +PREFIX-N.log, where N is a number specific to the output +stream +

+
+
-vf filtergraph (output)
+

Create the filtergraph specified by filtergraph and use it to +filter the stream. +

+

This is an alias for -filter:v, see the -filter option. +

+
+ + +

5.6 Advanced Video options

+ +
+
-pix_fmt[:stream_specifier] format (input/output,per-stream)
+

Set pixel format. Use -pix_fmts to show all the supported +pixel formats. +If the selected pixel format can not be selected, ffmpeg will print a +warning and select the best pixel format supported by the encoder. +If pix_fmt is prefixed by a +, ffmpeg will exit with an error +if the requested pixel format can not be selected, and automatic conversions +inside filtergraphs are disabled. +If pix_fmt is a single +, ffmpeg selects the same pixel format +as the input (or graph output) and automatic conversions are disabled. +

+
+
-sws_flags flags (input/output)
+

Set SwScaler flags. +

+
+
-rc_override[:stream_specifier] override (output,per-stream)
+

Rate control override for specific intervals, formatted as "int,int,int" +list separated with slashes. Two first values are the beginning and +end frame numbers, last one is quantizer to use if positive, or quality +factor if negative. +

+
+
-ilme
+

Force interlacing support in encoder (MPEG-2 and MPEG-4 only). +Use this option if your input file is interlaced and you want +to keep the interlaced format for minimum losses. +The alternative is to deinterlace the input stream with +-deinterlace, but deinterlacing introduces losses. +

+
-psnr
+

Calculate PSNR of compressed frames. +

+
-vstats
+

Dump video coding statistics to vstats_HHMMSS.log. +

+
-vstats_file file
+

Dump video coding statistics to file. +

+
-vstats_version file
+

Specifies which version of the vstats format to use. Default is 2. +

+

version = 1 : +

+

frame= %5d q= %2.1f PSNR= %6.2f f_size= %6d s_size= %8.0fkB time= %0.3f br= %7.1fkbits/s avg_br= %7.1fkbits/s +

+

version > 1: +

+

out= %2d st= %2d frame= %5d q= %2.1f PSNR= %6.2f f_size= %6d s_size= %8.0fkB time= %0.3f br= %7.1fkbits/s avg_br= %7.1fkbits/s +

+
-top[:stream_specifier] n (output,per-stream)
+

top=1/bottom=0/auto=-1 field first +

+
-dc precision
+

Intra_dc_precision. +

+
-vtag fourcc/tag (output)
+

Force video tag/fourcc. This is an alias for -tag:v. +

+
-qphist (global)
+

Show QP histogram +

+
-vbsf bitstream_filter
+

Deprecated see -bsf +

+
+
-force_key_frames[:stream_specifier] time[,time...] (output,per-stream)
+
-force_key_frames[:stream_specifier] expr:expr (output,per-stream)
+
-force_key_frames[:stream_specifier] source (output,per-stream)
+
+

force_key_frames can take arguments of the following form: +

+
+
time[,time...]
+

If the argument consists of timestamps, ffmpeg will round the specified times to the nearest +output timestamp as per the encoder time base and force a keyframe at the first frame having +timestamp equal or greater than the computed timestamp. Note that if the encoder time base is too +coarse, then the keyframes may be forced on frames with timestamps lower than the specified time. +The default encoder time base is the inverse of the output framerate but may be set otherwise +via -enc_time_base. +

+

If one of the times is "chapters[delta]", it is expanded into +the time of the beginning of all chapters in the file, shifted by +delta, expressed as a time in seconds. +This option can be useful to ensure that a seek point is present at a +chapter mark or any other designated place in the output file. +

+

For example, to insert a key frame at 5 minutes, plus key frames 0.1 second +before the beginning of every chapter: +

+
-force_key_frames 0:05:00,chapters-0.1
+
+ +
+
expr:expr
+

If the argument is prefixed with expr:, the string expr +is interpreted like an expression and is evaluated for each frame. A +key frame is forced in case the evaluation is non-zero. +

+

The expression in expr can contain the following constants: +

+
n
+

the number of current processed frame, starting from 0 +

+
n_forced
+

the number of forced frames +

+
prev_forced_n
+

the number of the previous forced frame, it is NAN when no +keyframe was forced yet +

+
prev_forced_t
+

the time of the previous forced frame, it is NAN when no +keyframe was forced yet +

+
t
+

the time of the current processed frame +

+
+ +

For example to force a key frame every 5 seconds, you can specify: +

+
-force_key_frames expr:gte(t,n_forced*5)
+
+ +

To force a key frame 5 seconds after the time of the last forced one, +starting from second 13: +

+
-force_key_frames expr:if(isnan(prev_forced_t),gte(t,13),gte(t,prev_forced_t+5))
+
+ +
+
source
+

If the argument is source, ffmpeg will force a key frame if +the current frame being encoded is marked as a key frame in its source. +

+
+
+ +

Note that forcing too many keyframes is very harmful for the lookahead +algorithms of certain encoders: using fixed-GOP options or similar +would be more efficient. +

+
+
-copyinkf[:stream_specifier] (output,per-stream)
+

When doing stream copy, copy also non-key frames found at the +beginning. +

+
+
-init_hw_device type[=name][:device[,key=value...]]
+

Initialise a new hardware device of type type called name, using the +given device parameters. +If no name is specified it will receive a default name of the form "type%d". +

+

The meaning of device and the following arguments depends on the +device type: +

+
cuda
+

device is the number of the CUDA device. +

+
+
dxva2
+

device is the number of the Direct3D 9 display adapter. +

+
+
vaapi
+

device is either an X11 display name or a DRM render node. +If not specified, it will attempt to open the default X11 display ($DISPLAY) +and then the first DRM render node (/dev/dri/renderD128). +

+
+
vdpau
+

device is an X11 display name. +If not specified, it will attempt to open the default X11 display ($DISPLAY). +

+
+
qsv
+

device selects a value in ‘MFX_IMPL_*’. Allowed values are: +

+
auto
+
sw
+
hw
+
auto_any
+
hw_any
+
hw2
+
hw3
+
hw4
+
+

If not specified, ‘auto_any’ is used. +(Note that it may be easier to achieve the desired result for QSV by creating the +platform-appropriate subdevice (‘dxva2’ or ‘vaapi’) and then deriving a +QSV device from that.) +

+
+
opencl
+

device selects the platform and device as platform_index.device_index. +

+

The set of devices can also be filtered using the key-value pairs to find only +devices matching particular platform or device strings. +

+

The strings usable as filters are: +

+
platform_profile
+
platform_version
+
platform_name
+
platform_vendor
+
platform_extensions
+
device_name
+
device_vendor
+
driver_version
+
device_version
+
device_profile
+
device_extensions
+
device_type
+
+ +

The indices and filters must together uniquely select a device. +

+

Examples: +

+
-init_hw_device opencl:0.1
+

Choose the second device on the first platform. +

+
+
-init_hw_device opencl:,device_name=Foo9000
+

Choose the device with a name containing the string Foo9000. +

+
+
-init_hw_device opencl:1,device_type=gpu,device_extensions=cl_khr_fp16
+

Choose the GPU device on the second platform supporting the cl_khr_fp16 +extension. +

+
+ +
+
vulkan
+

If device is an integer, it selects the device by its index in a +system-dependent list of devices. If device is any other string, it +selects the first device with a name containing that string as a substring. +

+

The following options are recognized: +

+
debug
+

If set to 1, enables the validation layer, if installed. +

+
linear_images
+

If set to 1, images allocated by the hwcontext will be linear and locally mappable. +

+
instance_extensions
+

A plus separated list of additional instance extensions to enable. +

+
device_extensions
+

A plus separated list of additional device extensions to enable. +

+
+ +

Examples: +

+
-init_hw_device vulkan:1
+

Choose the second device on the system. +

+
+
-init_hw_device vulkan:RADV
+

Choose the first device with a name containing the string RADV. +

+
+
-init_hw_device vulkan:0,instance_extensions=VK_KHR_wayland_surface+VK_KHR_xcb_surface
+

Choose the first device and enable the Wayland and XCB instance extensions. +

+
+ +
+
+ +
+
-init_hw_device type[=name]@source
+

Initialise a new hardware device of type type called name, +deriving it from the existing device with the name source. +

+
+
-init_hw_device list
+

List all hardware device types supported in this build of ffmpeg. +

+
+
-filter_hw_device name
+

Pass the hardware device called name to all filters in any filter graph. +This can be used to set the device to upload to with the hwupload filter, +or the device to map to with the hwmap filter. Other filters may also +make use of this parameter when they require a hardware device. Note that this +is typically only required when the input is not already in hardware frames - +when it is, filters will derive the device they require from the context of the +frames they receive as input. +

+

This is a global setting, so all filters will receive the same device. +

+
+
-hwaccel[:stream_specifier] hwaccel (input,per-stream)
+

Use hardware acceleration to decode the matching stream(s). The allowed values +of hwaccel are: +

+
none
+

Do not use any hardware acceleration (the default). +

+
+
auto
+

Automatically select the hardware acceleration method. +

+
+
vdpau
+

Use VDPAU (Video Decode and Presentation API for Unix) hardware acceleration. +

+
+
dxva2
+

Use DXVA2 (DirectX Video Acceleration) hardware acceleration. +

+
+
vaapi
+

Use VAAPI (Video Acceleration API) hardware acceleration. +

+
+
qsv
+

Use the Intel QuickSync Video acceleration for video transcoding. +

+

Unlike most other values, this option does not enable accelerated decoding (that +is used automatically whenever a qsv decoder is selected), but accelerated +transcoding, without copying the frames into the system memory. +

+

For it to work, both the decoder and the encoder must support QSV acceleration +and no filters must be used. +

+
+ +

This option has no effect if the selected hwaccel is not available or not +supported by the chosen decoder. +

+

Note that most acceleration methods are intended for playback and will not be +faster than software decoding on modern CPUs. Additionally, ffmpeg +will usually need to copy the decoded frames from the GPU memory into the system +memory, resulting in further performance loss. This option is thus mainly +useful for testing. +

+
+
-hwaccel_device[:stream_specifier] hwaccel_device (input,per-stream)
+

Select a device to use for hardware acceleration. +

+

This option only makes sense when the -hwaccel option is also specified. +It can either refer to an existing device created with -init_hw_device +by name, or it can create a new device as if +‘-init_hw_device’ type:hwaccel_device +were called immediately before. +

+
+
-hwaccels
+

List all hardware acceleration methods supported in this build of ffmpeg. +

+
+
+ + +

5.7 Audio Options

+ +
+
-aframes number (output)
+

Set the number of audio frames to output. This is an obsolete alias for +-frames:a, which you should use instead. +

+
-ar[:stream_specifier] freq (input/output,per-stream)
+

Set the audio sampling frequency. For output streams it is set by +default to the frequency of the corresponding input stream. For input +streams this option only makes sense for audio grabbing devices and raw +demuxers and is mapped to the corresponding demuxer options. +

+
-aq q (output)
+

Set the audio quality (codec-specific, VBR). This is an alias for -q:a. +

+
-ac[:stream_specifier] channels (input/output,per-stream)
+

Set the number of audio channels. For output streams it is set by +default to the number of input audio channels. For input streams +this option only makes sense for audio grabbing devices and raw demuxers +and is mapped to the corresponding demuxer options. +

+
-an (input/output)
+

As an input option, blocks all audio streams of a file from being filtered or +being automatically selected or mapped for any output. See -discard +option to disable streams individually. +

+

As an output option, disables audio recording i.e. automatic selection or +mapping of any audio stream. For full manual control see the -map +option. +

+
-acodec codec (input/output)
+

Set the audio codec. This is an alias for -codec:a. +

+
-sample_fmt[:stream_specifier] sample_fmt (output,per-stream)
+

Set the audio sample format. Use -sample_fmts to get a list +of supported sample formats. +

+
+
-af filtergraph (output)
+

Create the filtergraph specified by filtergraph and use it to +filter the stream. +

+

This is an alias for -filter:a, see the -filter option. +

+
+ + +

5.8 Advanced Audio options

+ +
+
-atag fourcc/tag (output)
+

Force audio tag/fourcc. This is an alias for -tag:a. +

+
-absf bitstream_filter
+

Deprecated, see -bsf +

+
-guess_layout_max channels (input,per-stream)
+

If some input channel layout is not known, try to guess only if it +corresponds to at most the specified number of channels. For example, 2 +tells to ffmpeg to recognize 1 channel as mono and 2 channels as +stereo but not 6 channels as 5.1. The default is to always try to guess. Use +0 to disable all guessing. +

+
+ + +

5.9 Subtitle options

+ +
+
-scodec codec (input/output)
+

Set the subtitle codec. This is an alias for -codec:s. +

+
-sn (input/output)
+

As an input option, blocks all subtitle streams of a file from being filtered or +being automatically selected or mapped for any output. See -discard +option to disable streams individually. +

+

As an output option, disables subtitle recording i.e. automatic selection or +mapping of any subtitle stream. For full manual control see the -map +option. +

+
-sbsf bitstream_filter
+

Deprecated, see -bsf +

+
+ + +

5.10 Advanced Subtitle options

+ +
+
-fix_sub_duration
+

Fix subtitles durations. For each subtitle, wait for the next packet in the +same stream and adjust the duration of the first to avoid overlap. This is +necessary with some subtitles codecs, especially DVB subtitles, because the +duration in the original packet is only a rough estimate and the end is +actually marked by an empty subtitle frame. Failing to use this option when +necessary can result in exaggerated durations or muxing failures due to +non-monotonic timestamps. +

+

Note that this option will delay the output of all data until the next +subtitle packet is decoded: it may increase memory consumption and latency a +lot. +

+
+
-canvas_size size
+

Set the size of the canvas used to render subtitles. +

+
+
+ + +

5.11 Advanced options

+ +
+
-map [-]input_file_id[:stream_specifier][?][,sync_file_id[:stream_specifier]] | [linklabel] (output)
+
+

Designate one or more input streams as a source for the output file. Each input +stream is identified by the input file index input_file_id and +the input stream index input_stream_id within the input +file. Both indices start at 0. If specified, +sync_file_id:stream_specifier sets which input stream +is used as a presentation sync reference. +

+

The first -map option on the command line specifies the +source for output stream 0, the second -map option specifies +the source for output stream 1, etc. +

+

A - character before the stream identifier creates a "negative" mapping. +It disables matching streams from already created mappings. +

+

A trailing ? after the stream index will allow the map to be +optional: if the map matches no streams the map will be ignored instead +of failing. Note the map will still fail if an invalid input file index +is used; such as if the map refers to a non-existent input. +

+

An alternative [linklabel] form will map outputs from complex filter +graphs (see the -filter_complex option) to the output file. +linklabel must correspond to a defined output link label in the graph. +

+

For example, to map ALL streams from the first input file to output +

+
ffmpeg -i INPUT -map 0 output
+
+ +

For example, if you have two audio streams in the first input file, +these streams are identified by "0:0" and "0:1". You can use +-map to select which streams to place in an output file. For +example: +

+
ffmpeg -i INPUT -map 0:1 out.wav
+
+

will map the input stream in INPUT identified by "0:1" to +the (single) output stream in out.wav. +

+

For example, to select the stream with index 2 from input file +a.mov (specified by the identifier "0:2"), and stream with +index 6 from input b.mov (specified by the identifier "1:6"), +and copy them to the output file out.mov: +

+
ffmpeg -i a.mov -i b.mov -c copy -map 0:2 -map 1:6 out.mov
+
+ +

To select all video and the third audio stream from an input file: +

+
ffmpeg -i INPUT -map 0:v -map 0:a:2 OUTPUT
+
+ +

To map all the streams except the second audio, use negative mappings +

+
ffmpeg -i INPUT -map 0 -map -0:a:1 OUTPUT
+
+ +

To map the video and audio streams from the first input, and using the +trailing ?, ignore the audio mapping if no audio streams exist in +the first input: +

+
ffmpeg -i INPUT -map 0:v -map 0:a? OUTPUT
+
+ +

To pick the English audio stream: +

+
ffmpeg -i INPUT -map 0:m:language:eng OUTPUT
+
+ +

Note that using this option disables the default mappings for this output file. +

+
+
-ignore_unknown
+

Ignore input streams with unknown type instead of failing if copying +such streams is attempted. +

+
+
-copy_unknown
+

Allow input streams with unknown type to be copied instead of failing if copying +such streams is attempted. +

+
+
-map_channel [input_file_id.stream_specifier.channel_id|-1][?][:output_file_id.stream_specifier]
+

Map an audio channel from a given input to an output. If +output_file_id.stream_specifier is not set, the audio channel will +be mapped on all the audio streams. +

+

Using "-1" instead of +input_file_id.stream_specifier.channel_id will map a muted +channel. +

+

A trailing ? will allow the map_channel to be +optional: if the map_channel matches no channel the map_channel will be ignored instead +of failing. +

+

For example, assuming INPUT is a stereo audio file, you can switch the +two audio channels with the following command: +

+
ffmpeg -i INPUT -map_channel 0.0.1 -map_channel 0.0.0 OUTPUT
+
+ +

If you want to mute the first channel and keep the second: +

+
ffmpeg -i INPUT -map_channel -1 -map_channel 0.0.1 OUTPUT
+
+ +

The order of the "-map_channel" option specifies the order of the channels in +the output stream. The output channel layout is guessed from the number of +channels mapped (mono if one "-map_channel", stereo if two, etc.). Using "-ac" +in combination of "-map_channel" makes the channel gain levels to be updated if +input and output channel layouts don’t match (for instance two "-map_channel" +options and "-ac 6"). +

+

You can also extract each channel of an input to specific outputs; the following +command extracts two channels of the INPUT audio stream (file 0, stream 0) +to the respective OUTPUT_CH0 and OUTPUT_CH1 outputs: +

+
ffmpeg -i INPUT -map_channel 0.0.0 OUTPUT_CH0 -map_channel 0.0.1 OUTPUT_CH1
+
+ +

The following example splits the channels of a stereo input into two separate +streams, which are put into the same output file: +

+
ffmpeg -i stereo.wav -map 0:0 -map 0:0 -map_channel 0.0.0:0.0 -map_channel 0.0.1:0.1 -y out.ogg
+
+ +

Note that currently each output stream can only contain channels from a single +input stream; you can’t for example use "-map_channel" to pick multiple input +audio channels contained in different streams (from the same or different files) +and merge them into a single output stream. It is therefore not currently +possible, for example, to turn two separate mono streams into a single stereo +stream. However splitting a stereo stream into two single channel mono streams +is possible. +

+

If you need this feature, a possible workaround is to use the amerge +filter. For example, if you need to merge a media (here input.mkv) with 2 +mono audio streams into one single stereo channel audio stream (and keep the +video stream), you can use the following command: +

+
ffmpeg -i input.mkv -filter_complex "[0:1] [0:2] amerge" -c:a pcm_s16le -c:v copy output.mkv
+
+ +

To map the first two audio channels from the first input, and using the +trailing ?, ignore the audio channel mapping if the first input is +mono instead of stereo: +

+
ffmpeg -i INPUT -map_channel 0.0.0 -map_channel 0.0.1? OUTPUT
+
+ +
+
-map_metadata[:metadata_spec_out] infile[:metadata_spec_in] (output,per-metadata)
+

Set metadata information of the next output file from infile. Note that +those are file indices (zero-based), not filenames. +Optional metadata_spec_in/out parameters specify, which metadata to copy. +A metadata specifier can have the following forms: +

+
g
+

global metadata, i.e. metadata that applies to the whole file +

+
+
s[:stream_spec]
+

per-stream metadata. stream_spec is a stream specifier as described +in the Stream specifiers chapter. In an input metadata specifier, the first +matching stream is copied from. In an output metadata specifier, all matching +streams are copied to. +

+
+
c:chapter_index
+

per-chapter metadata. chapter_index is the zero-based chapter index. +

+
+
p:program_index
+

per-program metadata. program_index is the zero-based program index. +

+
+

If metadata specifier is omitted, it defaults to global. +

+

By default, global metadata is copied from the first input file, +per-stream and per-chapter metadata is copied along with streams/chapters. These +default mappings are disabled by creating any mapping of the relevant type. A negative +file index can be used to create a dummy mapping that just disables automatic copying. +

+

For example to copy metadata from the first stream of the input file to global metadata +of the output file: +

+
ffmpeg -i in.ogg -map_metadata 0:s:0 out.mp3
+
+ +

To do the reverse, i.e. copy global metadata to all audio streams: +

+
ffmpeg -i in.mkv -map_metadata:s:a 0:g out.mkv
+
+

Note that simple 0 would work as well in this example, since global +metadata is assumed by default. +

+
+
-map_chapters input_file_index (output)
+

Copy chapters from input file with index input_file_index to the next +output file. If no chapter mapping is specified, then chapters are copied from +the first input file with at least one chapter. Use a negative file index to +disable any chapter copying. +

+
+
-benchmark (global)
+

Show benchmarking information at the end of an encode. +Shows real, system and user time used and maximum memory consumption. +Maximum memory consumption is not supported on all systems, +it will usually display as 0 if not supported. +

+
-benchmark_all (global)
+

Show benchmarking information during the encode. +Shows real, system and user time used in various steps (audio/video encode/decode). +

+
-timelimit duration (global)
+

Exit after ffmpeg has been running for duration seconds in CPU user time. +

+
-dump (global)
+

Dump each input packet to stderr. +

+
-hex (global)
+

When dumping packets, also dump the payload. +

+
-re (input)
+

Read input at native frame rate. Mainly used to simulate a grab device, +or live input stream (e.g. when reading from a file). Should not be used +with actual grab devices or live input streams (where it can cause packet +loss). +By default ffmpeg attempts to read the input(s) as fast as possible. +This option will slow down the reading of the input(s) to the native frame rate +of the input(s). It is useful for real-time output (e.g. live streaming). +

+
-vsync parameter
+

Video sync method. +For compatibility reasons old values can be specified as numbers. +Newly added values will have to be specified as strings always. +

+
+
0, passthrough
+

Each frame is passed with its timestamp from the demuxer to the muxer. +

+
1, cfr
+

Frames will be duplicated and dropped to achieve exactly the requested +constant frame rate. +

+
2, vfr
+

Frames are passed through with their timestamp or dropped so as to +prevent 2 frames from having the same timestamp. +

+
drop
+

As passthrough but destroys all timestamps, making the muxer generate +fresh timestamps based on frame-rate. +

+
-1, auto
+

Chooses between 1 and 2 depending on muxer capabilities. This is the +default method. +

+
+ +

Note that the timestamps may be further modified by the muxer, after this. +For example, in the case that the format option avoid_negative_ts +is enabled. +

+

With -map you can select from which stream the timestamps should be +taken. You can leave either video or audio unchanged and sync the +remaining stream(s) to the unchanged one. +

+
+
-frame_drop_threshold parameter
+

Frame drop threshold, which specifies how much behind video frames can +be before they are dropped. In frame rate units, so 1.0 is one frame. +The default is -1.1. One possible usecase is to avoid framedrops in case +of noisy timestamps or to increase frame drop precision in case of exact +timestamps. +

+
+
-async samples_per_second
+

Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps, +the parameter is the maximum samples per second by which the audio is changed. +-async 1 is a special case where only the start of the audio stream is corrected +without any later correction. +

+

Note that the timestamps may be further modified by the muxer, after this. +For example, in the case that the format option avoid_negative_ts +is enabled. +

+

This option has been deprecated. Use the aresample audio filter instead. +

+
+
-copyts
+

Do not process input timestamps, but keep their values without trying +to sanitize them. In particular, do not remove the initial start time +offset value. +

+

Note that, depending on the vsync option or on specific muxer +processing (e.g. in case the format option avoid_negative_ts +is enabled) the output timestamps may mismatch with the input +timestamps even when this option is selected. +

+
+
-start_at_zero
+

When used with copyts, shift input timestamps so they start at zero. +

+

This means that using e.g. -ss 50 will make output timestamps start at +50 seconds, regardless of what timestamp the input file started at. +

+
+
-copytb mode
+

Specify how to set the encoder timebase when stream copying. mode is an +integer numeric value, and can assume one of the following values: +

+
+
1
+

Use the demuxer timebase. +

+

The time base is copied to the output encoder from the corresponding input +demuxer. This is sometimes required to avoid non monotonically increasing +timestamps when copying video streams with variable frame rate. +

+
+
0
+

Use the decoder timebase. +

+

The time base is copied to the output encoder from the corresponding input +decoder. +

+
+
-1
+

Try to make the choice automatically, in order to generate a sane output. +

+
+ +

Default value is -1. +

+
+
-enc_time_base[:stream_specifier] timebase (output,per-stream)
+

Set the encoder timebase. timebase is a floating point number, +and can assume one of the following values: +

+
+
0
+

Assign a default value according to the media type. +

+

For video - use 1/framerate, for audio - use 1/samplerate. +

+
+
-1
+

Use the input stream timebase when possible. +

+

If an input stream is not available, the default timebase will be used. +

+
+
>0
+

Use the provided number as the timebase. +

+

This field can be provided as a ratio of two integers (e.g. 1:24, 1:48000) +or as a floating point number (e.g. 0.04166, 2.0833e-5) +

+
+ +

Default value is 0. +

+
+
-bitexact (input/output)
+

Enable bitexact mode for (de)muxer and (de/en)coder +

+
-shortest (output)
+

Finish encoding when the shortest input stream ends. +

+
-dts_delta_threshold
+

Timestamp discontinuity delta threshold. +

+
-dts_error_threshold seconds
+

Timestamp error delta threshold. This threshold use to discard crazy/damaged +timestamps and the default is 30 hours which is arbitrarily picked and quite +conservative. +

+
-muxdelay seconds (output)
+

Set the maximum demux-decode delay. +

+
-muxpreload seconds (output)
+

Set the initial demux-decode delay. +

+
-streamid output-stream-index:new-value (output)
+

Assign a new stream-id value to an output stream. This option should be +specified prior to the output filename to which it applies. +For the situation where multiple output files exist, a streamid +may be reassigned to a different value. +

+

For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for +an output mpegts file: +

+
ffmpeg -i inurl -streamid 0:33 -streamid 1:36 out.ts
+
+ +
+
-bsf[:stream_specifier] bitstream_filters (output,per-stream)
+

Set bitstream filters for matching streams. bitstream_filters is +a comma-separated list of bitstream filters. Use the -bsfs option +to get the list of bitstream filters. +

+
ffmpeg -i h264.mp4 -c:v copy -bsf:v h264_mp4toannexb -an out.h264
+
+
+
ffmpeg -i file.mov -an -vn -bsf:s mov2textsub -c:s copy -f rawvideo sub.txt
+
+ +
+
-tag[:stream_specifier] codec_tag (input/output,per-stream)
+

Force a tag/fourcc for matching streams. +

+
+
-timecode hh:mm:ssSEPff
+

Specify Timecode for writing. SEP is ’:’ for non drop timecode and ’;’ +(or ’.’) for drop. +

+
ffmpeg -i input.mpg -timecode 01:02:03.04 -r 30000/1001 -s ntsc output.mpg
+
+ +
+
-filter_complex filtergraph (global)
+

Define a complex filtergraph, i.e. one with arbitrary number of inputs and/or +outputs. For simple graphs – those with one input and one output of the same +type – see the -filter options. filtergraph is a description of +the filtergraph, as described in the “Filtergraph syntax” section of the +ffmpeg-filters manual. +

+

Input link labels must refer to input streams using the +[file_index:stream_specifier] syntax (i.e. the same as -map +uses). If stream_specifier matches multiple streams, the first one will be +used. An unlabeled input will be connected to the first unused input stream of +the matching type. +

+

Output link labels are referred to with -map. Unlabeled outputs are +added to the first output file. +

+

Note that with this option it is possible to use only lavfi sources without +normal input files. +

+

For example, to overlay an image over video +

+
ffmpeg -i video.mkv -i image.png -filter_complex '[0:v][1:v]overlay[out]' -map
+'[out]' out.mkv
+
+

Here [0:v] refers to the first video stream in the first input file, +which is linked to the first (main) input of the overlay filter. Similarly the +first video stream in the second input is linked to the second (overlay) input +of overlay. +

+

Assuming there is only one video stream in each input file, we can omit input +labels, so the above is equivalent to +

+
ffmpeg -i video.mkv -i image.png -filter_complex 'overlay[out]' -map
+'[out]' out.mkv
+
+ +

Furthermore we can omit the output label and the single output from the filter +graph will be added to the output file automatically, so we can simply write +

+
ffmpeg -i video.mkv -i image.png -filter_complex 'overlay' out.mkv
+
+ +

To generate 5 seconds of pure red video using lavfi color source: +

+
ffmpeg -filter_complex 'color=c=red' -t 5 out.mkv
+
+ +
+
-filter_complex_threads nb_threads (global)
+

Defines how many threads are used to process a filter_complex graph. +Similar to filter_threads but used for -filter_complex graphs only. +The default is the number of available CPUs. +

+
+
-lavfi filtergraph (global)
+

Define a complex filtergraph, i.e. one with arbitrary number of inputs and/or +outputs. Equivalent to -filter_complex. +

+
+
-filter_complex_script filename (global)
+

This option is similar to -filter_complex, the only difference is that +its argument is the name of the file from which a complex filtergraph +description is to be read. +

+
+
-accurate_seek (input)
+

This option enables or disables accurate seeking in input files with the +-ss option. It is enabled by default, so seeking is accurate when +transcoding. Use -noaccurate_seek to disable it, which may be useful +e.g. when copying some streams and transcoding the others. +

+
+
-seek_timestamp (input)
+

This option enables or disables seeking by timestamp in input files with the +-ss option. It is disabled by default. If enabled, the argument +to the -ss option is considered an actual timestamp, and is not +offset by the start time of the file. This matters only for files which do +not start from timestamp 0, such as transport streams. +

+
+
-thread_queue_size size (input)
+

This option sets the maximum number of queued packets when reading from the +file or device. With low latency / high rate live streams, packets may be +discarded if they are not read in a timely manner; raising this value can +avoid it. +

+
+
-sdp_file file (global)
+

Print sdp information for an output stream to file. +This allows dumping sdp information when at least one output isn’t an +rtp stream. (Requires at least one of the output formats to be rtp). +

+
+
-discard (input)
+

Allows discarding specific streams or frames from streams. +Any input stream can be fully discarded, using value all whereas +selective discarding of frames from a stream occurs at the demuxer +and is not supported by all demuxers. +

+
+
none
+

Discard no frame. +

+
+
default
+

Default, which discards no frames. +

+
+
noref
+

Discard all non-reference frames. +

+
+
bidir
+

Discard all bidirectional frames. +

+
+
nokey
+

Discard all frames excepts keyframes. +

+
+
all
+

Discard all frames. +

+
+ +
+
-abort_on flags (global)
+

Stop and abort on various conditions. The following flags are available: +

+
+
empty_output
+

No packets were passed to the muxer, the output is empty. +

+
empty_output_stream
+

No packets were passed to the muxer in some of the output streams. +

+
+ +
+
-xerror (global)
+

Stop and exit on error +

+
+
-max_muxing_queue_size packets (output,per-stream)
+

When transcoding audio and/or video streams, ffmpeg will not begin writing into +the output until it has one packet for each such stream. While waiting for that +to happen, packets for other streams are buffered. This option sets the size of +this buffer, in packets, for the matching output stream. +

+

The default value of this option should be high enough for most uses, so only +touch this option if you are sure that you need it. +

+
+
+ +

As a special exception, you can use a bitmap subtitle stream as input: it +will be converted into a video with the same size as the largest video in +the file, or 720x576 if no video is present. Note that this is an +experimental and temporary solution. It will be removed once libavfilter has +proper support for subtitles. +

+

For example, to hardcode subtitles on top of a DVB-T recording stored in +MPEG-TS format, delaying the subtitles by 1 second: +

+
ffmpeg -i input.ts -filter_complex \
+  '[#0x2ef] setpts=PTS+1/TB [sub] ; [#0x2d0] [sub] overlay' \
+  -sn -map '#0x2dc' output.mkv
+
+

(0x2d0, 0x2dc and 0x2ef are the MPEG-TS PIDs of respectively the video, +audio and subtitles streams; 0:0, 0:3 and 0:7 would have worked too) +

+ +

5.12 Preset files

+

A preset file contains a sequence of option=value pairs, +one for each line, specifying a sequence of options which would be +awkward to specify on the command line. Lines starting with the hash +(’#’) character are ignored and are used to provide comments. Check +the presets directory in the FFmpeg source tree for examples. +

+

There are two types of preset files: ffpreset and avpreset files. +

+ +

5.12.1 ffpreset files

+

ffpreset files are specified with the vpre, apre, +spre, and fpre options. The fpre option takes the +filename of the preset instead of a preset name as input and can be +used for any kind of codec. For the vpre, apre, and +spre options, the options specified in a preset file are +applied to the currently selected codec of the same type as the preset +option. +

+

The argument passed to the vpre, apre, and spre +preset options identifies the preset file to use according to the +following rules: +

+

First ffmpeg searches for a file named arg.ffpreset in the +directories $FFMPEG_DATADIR (if set), and $HOME/.ffmpeg, and in +the datadir defined at configuration time (usually PREFIX/share/ffmpeg) +or in a ffpresets folder along the executable on win32, +in that order. For example, if the argument is libvpx-1080p, it will +search for the file libvpx-1080p.ffpreset. +

+

If no such file is found, then ffmpeg will search for a file named +codec_name-arg.ffpreset in the above-mentioned +directories, where codec_name is the name of the codec to which +the preset file options will be applied. For example, if you select +the video codec with -vcodec libvpx and use -vpre 1080p, +then it will search for the file libvpx-1080p.ffpreset. +

+ +

5.12.2 avpreset files

+

avpreset files are specified with the pre option. They work similar to +ffpreset files, but they only allow encoder- specific options. Therefore, an +option=value pair specifying an encoder cannot be used. +

+

When the pre option is specified, ffmpeg will look for files with the +suffix .avpreset in the directories $AVCONV_DATADIR (if set), and +$HOME/.avconv, and in the datadir defined at configuration time (usually +PREFIX/share/ffmpeg), in that order. +

+

First ffmpeg searches for a file named codec_name-arg.avpreset in +the above-mentioned directories, where codec_name is the name of the codec +to which the preset file options will be applied. For example, if you select the +video codec with -vcodec libvpx and use -pre 1080p, then it will +search for the file libvpx-1080p.avpreset. +

+

If no such file is found, then ffmpeg will search for a file named +arg.avpreset in the same directories. +

+ + +

6 Examples

+ + +

6.1 Video and Audio grabbing

+ +

If you specify the input format and device then ffmpeg can grab video +and audio directly. +

+
+
ffmpeg -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
+
+ +

Or with an ALSA audio source (mono input, card id 1) instead of OSS: +

+
ffmpeg -f alsa -ac 1 -i hw:1 -f video4linux2 -i /dev/video0 /tmp/out.mpg
+
+ +

Note that you must activate the right video source and channel before +launching ffmpeg with any TV viewer such as +xawtv by Gerd Knorr. You also +have to set the audio recording levels correctly with a +standard mixer. +

+ +

6.2 X11 grabbing

+ +

Grab the X11 display with ffmpeg via +

+
+
ffmpeg -f x11grab -video_size cif -framerate 25 -i :0.0 /tmp/out.mpg
+
+ +

0.0 is display.screen number of your X11 server, same as +the DISPLAY environment variable. +

+
+
ffmpeg -f x11grab -video_size cif -framerate 25 -i :0.0+10,20 /tmp/out.mpg
+
+ +

0.0 is display.screen number of your X11 server, same as the DISPLAY environment +variable. 10 is the x-offset and 20 the y-offset for the grabbing. +

+ +

6.3 Video and Audio file format conversion

+ +

Any supported file format and protocol can serve as input to ffmpeg: +

+

Examples: +

    +
  • You can use YUV files as input: + +
    +
    ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
+
    + +

    It will use the files: +

    +
    /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
+/tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
+
    + +

    The Y files use twice the resolution of the U and V files. They are +raw files, without header. They can be generated by all decent video +decoders. You must specify the size of the image with the -s option +if ffmpeg cannot guess it. +

    +
  • You can input from a raw YUV420P file: + +
    +
    ffmpeg -i /tmp/test.yuv /tmp/out.avi
+
    + +

    test.yuv is a file containing raw YUV planar data. Each frame is composed +of the Y plane followed by the U and V planes at half vertical and +horizontal resolution. +

    +
  • You can output to a raw YUV420P file: + +
    +
    ffmpeg -i mydivx.avi hugefile.yuv
+
    + +
  • You can set several input files and output files: + +
    +
    ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
+
    + +

    Converts the audio file a.wav and the raw YUV video file a.yuv +to MPEG file a.mpg. +

    +
  • You can also do audio and video conversions at the same time: + +
    +
    ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
+
    + +

    Converts a.wav to MPEG audio at 22050 Hz sample rate. +

    +
  • You can encode to several formats at the same time and define a +mapping from input stream to output streams: + +
    +
    ffmpeg -i /tmp/a.wav -map 0:a -b:a 64k /tmp/a.mp2 -map 0:a -b:a 128k /tmp/b.mp2
+
    + +

    Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. ’-map +file:index’ specifies which input stream is used for each output +stream, in the order of the definition of output streams. +

    +
  • You can transcode decrypted VOBs: + +
    +
    ffmpeg -i snatch_1.vob -f avi -c:v mpeg4 -b:v 800k -g 300 -bf 2 -c:a libmp3lame -b:a 128k snatch.avi
+
    + +

    This is a typical DVD ripping example; the input is a VOB file, the +output an AVI file with MPEG-4 video and MP3 audio. Note that in this +command we use B-frames so the MPEG-4 stream is DivX5 compatible, and +GOP size is 300 which means one intra frame every 10 seconds for 29.97fps +input video. Furthermore, the audio stream is MP3-encoded so you need +to enable LAME support by passing --enable-libmp3lame to configure. +The mapping is particularly useful for DVD transcoding +to get the desired audio language. +

    +

    NOTE: To see the supported input formats, use ffmpeg -demuxers. +

    +
  • You can extract images from a video, or create a video from many images: + +

    For extracting images from a video: +

    +
    ffmpeg -i foo.avi -r 1 -s WxH -f image2 foo-%03d.jpeg
+
    + +

    This will extract one video frame per second from the video and will +output them in files named foo-001.jpeg, foo-002.jpeg, +etc. Images will be rescaled to fit the new WxH values. +

    +

    If you want to extract just a limited number of frames, you can use the +above command in combination with the -frames:v or -t option, +or in combination with -ss to start extracting from a certain point in time. +

    +

    For creating a video from many images: +

    +
    ffmpeg -f image2 -framerate 12 -i foo-%03d.jpeg -s WxH foo.avi
+
    + +

    The syntax foo-%03d.jpeg specifies to use a decimal number +composed of three digits padded with zeroes to express the sequence +number. It is the same syntax supported by the C printf function, but +only formats accepting a normal integer are suitable. +

    +

    When importing an image sequence, -i also supports expanding +shell-like wildcard patterns (globbing) internally, by selecting the +image2-specific -pattern_type glob option. +

    +

    For example, for creating a video from filenames matching the glob pattern +foo-*.jpeg: +

    +
    ffmpeg -f image2 -pattern_type glob -framerate 12 -i 'foo-*.jpeg' -s WxH foo.avi
+
    + +
  • You can put many streams of the same type in the output: + +
    +
    ffmpeg -i test1.avi -i test2.avi -map 1:1 -map 1:0 -map 0:1 -map 0:0 -c copy -y test12.nut
+
    + +

    The resulting output file test12.nut will contain the first four streams +from the input files in reverse order. +

    +
  • To force CBR video output: +
    +
    ffmpeg -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
+
    + +
  • The four options lmin, lmax, mblmin and mblmax use ’lambda’ units, +but you may use the QP2LAMBDA constant to easily convert from ’q’ units: +
    +
    ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
+
    + +
+ + +

7 Syntax

+ +

This section documents the syntax and formats employed by the FFmpeg +libraries and tools. +

+ +

7.1 Quoting and escaping

+ +

FFmpeg adopts the following quoting and escaping mechanism, unless +explicitly specified. The following rules are applied: +

+
    +
  • ‘'’ and ‘\’ are special characters (respectively used for +quoting and escaping). In addition to them, there might be other +special characters depending on the specific syntax where the escaping +and quoting are employed. + +
  • A special character is escaped by prefixing it with a ‘\’. + +
  • All characters enclosed between ‘''’ are included literally in the +parsed string. The quote character ‘'’ itself cannot be quoted, +so you may need to close the quote and escape it. + +
  • Leading and trailing whitespaces, unless escaped or quoted, are +removed from the parsed string. +
+ +

Note that you may need to add a second level of escaping when using +the command line or a script, which depends on the syntax of the +adopted shell language. +

+

The function av_get_token defined in +libavutil/avstring.h can be used to parse a token quoted or +escaped according to the rules defined above. +

+

The tool tools/ffescape in the FFmpeg source tree can be used +to automatically quote or escape a string in a script. +

+ +

7.1.1 Examples

+ +
    +
  • Escape the string Crime d'Amour containing the ' special +character: +
    +
    Crime d\'Amour
+
    + +
  • The string above contains a quote, so the ' needs to be escaped +when quoting it: +
    +
    'Crime d'\''Amour'
+
    + +
  • Include leading or trailing whitespaces using quoting: +
    +
    '  this string starts and ends with whitespaces  '
+
    + +
  • Escaping and quoting can be mixed together: +
    +
    ' The string '\'string\'' is a string '
+
    + +
  • To include a literal ‘\’ you can use either escaping or quoting: +
    +
    'c:\foo' can be written as c:\\foo
+
    +
+ + +

7.2 Date

+ +

The accepted syntax is: +

+
[(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH:MM:SS[.m...]]])|(HHMMSS[.m...]]]))[Z]
+now
+
+ +

If the value is "now" it takes the current time. +

+

Time is local time unless Z is appended, in which case it is +interpreted as UTC. +If the year-month-day part is not specified it takes the current +year-month-day. +

+ +

7.3 Time duration

+ +

There are two accepted syntaxes for expressing time duration. +

+
+
[-][HH:]MM:SS[.m...]
+
+ +

HH expresses the number of hours, MM the number of minutes +for a maximum of 2 digits, and SS the number of seconds for a +maximum of 2 digits. The m at the end expresses decimal value for +SS. +

+

or +

+
+
[-]S+[.m...]
+
+ +

S expresses the number of seconds, with the optional decimal part +m. +

+

In both expressions, the optional ‘-’ indicates negative duration. +

+ +

7.3.1 Examples

+ +

The following examples are all valid time duration: +

+
+
‘55’
+

55 seconds +

+
+
‘0.2’
+

0.2 seconds +

+
+
‘200ms’
+

200 milliseconds, that’s 0.2s +

+
+
‘200000us’
+

200000 microseconds, that’s 0.2s +

+
+
‘12:03:45’
+

12 hours, 03 minutes and 45 seconds +

+
+
‘23.189’
+

23.189 seconds +

+
+ + +

7.4 Video size

+

Specify the size of the sourced video, it may be a string of the form +widthxheight, or the name of a size abbreviation. +

+

The following abbreviations are recognized: +

+
‘ntsc’
+

720x480 +

+
‘pal’
+

720x576 +

+
‘qntsc’
+

352x240 +

+
‘qpal’
+

352x288 +

+
‘sntsc’
+

640x480 +

+
‘spal’
+

768x576 +

+
‘film’
+

352x240 +

+
‘ntsc-film’
+

352x240 +

+
‘sqcif’
+

128x96 +

+
‘qcif’
+

176x144 +

+
‘cif’
+

352x288 +

+
‘4cif’
+

704x576 +

+
‘16cif’
+

1408x1152 +

+
‘qqvga’
+

160x120 +

+
‘qvga’
+

320x240 +

+
‘vga’
+

640x480 +

+
‘svga’
+

800x600 +

+
‘xga’
+

1024x768 +

+
‘uxga’
+

1600x1200 +

+
‘qxga’
+

2048x1536 +

+
‘sxga’
+

1280x1024 +

+
‘qsxga’
+

2560x2048 +

+
‘hsxga’
+

5120x4096 +

+
‘wvga’
+

852x480 +

+
‘wxga’
+

1366x768 +

+
‘wsxga’
+

1600x1024 +

+
‘wuxga’
+

1920x1200 +

+
‘woxga’
+

2560x1600 +

+
‘wqsxga’
+

3200x2048 +

+
‘wquxga’
+

3840x2400 +

+
‘whsxga’
+

6400x4096 +

+
‘whuxga’
+

7680x4800 +

+
‘cga’
+

320x200 +

+
‘ega’
+

640x350 +

+
‘hd480’
+

852x480 +

+
‘hd720’
+

1280x720 +

+
‘hd1080’
+

1920x1080 +

+
‘2k’
+

2048x1080 +

+
‘2kflat’
+

1998x1080 +

+
‘2kscope’
+

2048x858 +

+
‘4k’
+

4096x2160 +

+
‘4kflat’
+

3996x2160 +

+
‘4kscope’
+

4096x1716 +

+
‘nhd’
+

640x360 +

+
‘hqvga’
+

240x160 +

+
‘wqvga’
+

400x240 +

+
‘fwqvga’
+

432x240 +

+
‘hvga’
+

480x320 +

+
‘qhd’
+

960x540 +

+
‘2kdci’
+

2048x1080 +

+
‘4kdci’
+

4096x2160 +

+
‘uhd2160’
+

3840x2160 +

+
‘uhd4320’
+

7680x4320 +

+
+ + +

7.5 Video rate

+ +

Specify the frame rate of a video, expressed as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a float +number or a valid video frame rate abbreviation. +

+

The following abbreviations are recognized: +

+
‘ntsc’
+

30000/1001 +

+
‘pal’
+

25/1 +

+
‘qntsc’
+

30000/1001 +

+
‘qpal’
+

25/1 +

+
‘sntsc’
+

30000/1001 +

+
‘spal’
+

25/1 +

+
‘film’
+

24/1 +

+
‘ntsc-film’
+

24000/1001 +

+
+ + +

7.6 Ratio

+ +

A ratio can be expressed as an expression, or in the form +numerator:denominator. +

+

Note that a ratio with infinite (1/0) or negative value is +considered valid, so you should check on the returned value if you +want to exclude those values. +

+

The undefined value can be expressed using the "0:0" string. +

+ +

7.7 Color

+ +

It can be the name of a color as defined below (case insensitive match) or a +[0x|#]RRGGBB[AA] sequence, possibly followed by @ and a string +representing the alpha component. +

+

The alpha component may be a string composed by "0x" followed by an +hexadecimal number or a decimal number between 0.0 and 1.0, which +represents the opacity value (‘0x00’ or ‘0.0’ means completely +transparent, ‘0xff’ or ‘1.0’ completely opaque). If the alpha +component is not specified then ‘0xff’ is assumed. +

+

The string ‘random’ will result in a random color. +

+

The following names of colors are recognized: +

+
‘AliceBlue’
+

0xF0F8FF +

+
‘AntiqueWhite’
+

0xFAEBD7 +

+
‘Aqua’
+

0x00FFFF +

+
‘Aquamarine’
+

0x7FFFD4 +

+
‘Azure’
+

0xF0FFFF +

+
‘Beige’
+

0xF5F5DC +

+
‘Bisque’
+

0xFFE4C4 +

+
‘Black’
+

0x000000 +

+
‘BlanchedAlmond’
+

0xFFEBCD +

+
‘Blue’
+

0x0000FF +

+
‘BlueViolet’
+

0x8A2BE2 +

+
‘Brown’
+

0xA52A2A +

+
‘BurlyWood’
+

0xDEB887 +

+
‘CadetBlue’
+

0x5F9EA0 +

+
‘Chartreuse’
+

0x7FFF00 +

+
‘Chocolate’
+

0xD2691E +

+
‘Coral’
+

0xFF7F50 +

+
‘CornflowerBlue’
+

0x6495ED +

+
‘Cornsilk’
+

0xFFF8DC +

+
‘Crimson’
+

0xDC143C +

+
‘Cyan’
+

0x00FFFF +

+
‘DarkBlue’
+

0x00008B +

+
‘DarkCyan’
+

0x008B8B +

+
‘DarkGoldenRod’
+

0xB8860B +

+
‘DarkGray’
+

0xA9A9A9 +

+
‘DarkGreen’
+

0x006400 +

+
‘DarkKhaki’
+

0xBDB76B +

+
‘DarkMagenta’
+

0x8B008B +

+
‘DarkOliveGreen’
+

0x556B2F +

+
‘Darkorange’
+

0xFF8C00 +

+
‘DarkOrchid’
+

0x9932CC +

+
‘DarkRed’
+

0x8B0000 +

+
‘DarkSalmon’
+

0xE9967A +

+
‘DarkSeaGreen’
+

0x8FBC8F +

+
‘DarkSlateBlue’
+

0x483D8B +

+
‘DarkSlateGray’
+

0x2F4F4F +

+
‘DarkTurquoise’
+

0x00CED1 +

+
‘DarkViolet’
+

0x9400D3 +

+
‘DeepPink’
+

0xFF1493 +

+
‘DeepSkyBlue’
+

0x00BFFF +

+
‘DimGray’
+

0x696969 +

+
‘DodgerBlue’
+

0x1E90FF +

+
‘FireBrick’
+

0xB22222 +

+
‘FloralWhite’
+

0xFFFAF0 +

+
‘ForestGreen’
+

0x228B22 +

+
‘Fuchsia’
+

0xFF00FF +

+
‘Gainsboro’
+

0xDCDCDC +

+
‘GhostWhite’
+

0xF8F8FF +

+
‘Gold’
+

0xFFD700 +

+
‘GoldenRod’
+

0xDAA520 +

+
‘Gray’
+

0x808080 +

+
‘Green’
+

0x008000 +

+
‘GreenYellow’
+

0xADFF2F +

+
‘HoneyDew’
+

0xF0FFF0 +

+
‘HotPink’
+

0xFF69B4 +

+
‘IndianRed’
+

0xCD5C5C +

+
‘Indigo’
+

0x4B0082 +

+
‘Ivory’
+

0xFFFFF0 +

+
‘Khaki’
+

0xF0E68C +

+
‘Lavender’
+

0xE6E6FA +

+
‘LavenderBlush’
+

0xFFF0F5 +

+
‘LawnGreen’
+

0x7CFC00 +

+
‘LemonChiffon’
+

0xFFFACD +

+
‘LightBlue’
+

0xADD8E6 +

+
‘LightCoral’
+

0xF08080 +

+
‘LightCyan’
+

0xE0FFFF +

+
‘LightGoldenRodYellow’
+

0xFAFAD2 +

+
‘LightGreen’
+

0x90EE90 +

+
‘LightGrey’
+

0xD3D3D3 +

+
‘LightPink’
+

0xFFB6C1 +

+
‘LightSalmon’
+

0xFFA07A +

+
‘LightSeaGreen’
+

0x20B2AA +

+
‘LightSkyBlue’
+

0x87CEFA +

+
‘LightSlateGray’
+

0x778899 +

+
‘LightSteelBlue’
+

0xB0C4DE +

+
‘LightYellow’
+

0xFFFFE0 +

+
‘Lime’
+

0x00FF00 +

+
‘LimeGreen’
+

0x32CD32 +

+
‘Linen’
+

0xFAF0E6 +

+
‘Magenta’
+

0xFF00FF +

+
‘Maroon’
+

0x800000 +

+
‘MediumAquaMarine’
+

0x66CDAA +

+
‘MediumBlue’
+

0x0000CD +

+
‘MediumOrchid’
+

0xBA55D3 +

+
‘MediumPurple’
+

0x9370D8 +

+
‘MediumSeaGreen’
+

0x3CB371 +

+
‘MediumSlateBlue’
+

0x7B68EE +

+
‘MediumSpringGreen’
+

0x00FA9A +

+
‘MediumTurquoise’
+

0x48D1CC +

+
‘MediumVioletRed’
+

0xC71585 +

+
‘MidnightBlue’
+

0x191970 +

+
‘MintCream’
+

0xF5FFFA +

+
‘MistyRose’
+

0xFFE4E1 +

+
‘Moccasin’
+

0xFFE4B5 +

+
‘NavajoWhite’
+

0xFFDEAD +

+
‘Navy’
+

0x000080 +

+
‘OldLace’
+

0xFDF5E6 +

+
‘Olive’
+

0x808000 +

+
‘OliveDrab’
+

0x6B8E23 +

+
‘Orange’
+

0xFFA500 +

+
‘OrangeRed’
+

0xFF4500 +

+
‘Orchid’
+

0xDA70D6 +

+
‘PaleGoldenRod’
+

0xEEE8AA +

+
‘PaleGreen’
+

0x98FB98 +

+
‘PaleTurquoise’
+

0xAFEEEE +

+
‘PaleVioletRed’
+

0xD87093 +

+
‘PapayaWhip’
+

0xFFEFD5 +

+
‘PeachPuff’
+

0xFFDAB9 +

+
‘Peru’
+

0xCD853F +

+
‘Pink’
+

0xFFC0CB +

+
‘Plum’
+

0xDDA0DD +

+
‘PowderBlue’
+

0xB0E0E6 +

+
‘Purple’
+

0x800080 +

+
‘Red’
+

0xFF0000 +

+
‘RosyBrown’
+

0xBC8F8F +

+
‘RoyalBlue’
+

0x4169E1 +

+
‘SaddleBrown’
+

0x8B4513 +

+
‘Salmon’
+

0xFA8072 +

+
‘SandyBrown’
+

0xF4A460 +

+
‘SeaGreen’
+

0x2E8B57 +

+
‘SeaShell’
+

0xFFF5EE +

+
‘Sienna’
+

0xA0522D +

+
‘Silver’
+

0xC0C0C0 +

+
‘SkyBlue’
+

0x87CEEB +

+
‘SlateBlue’
+

0x6A5ACD +

+
‘SlateGray’
+

0x708090 +

+
‘Snow’
+

0xFFFAFA +

+
‘SpringGreen’
+

0x00FF7F +

+
‘SteelBlue’
+

0x4682B4 +

+
‘Tan’
+

0xD2B48C +

+
‘Teal’
+

0x008080 +

+
‘Thistle’
+

0xD8BFD8 +

+
‘Tomato’
+

0xFF6347 +

+
‘Turquoise’
+

0x40E0D0 +

+
‘Violet’
+

0xEE82EE +

+
‘Wheat’
+

0xF5DEB3 +

+
‘White’
+

0xFFFFFF +

+
‘WhiteSmoke’
+

0xF5F5F5 +

+
‘Yellow’
+

0xFFFF00 +

+
‘YellowGreen’
+

0x9ACD32 +

+
+ + +

7.8 Channel Layout

+ +

A channel layout specifies the spatial disposition of the channels in +a multi-channel audio stream. To specify a channel layout, FFmpeg +makes use of a special syntax. +

+

Individual channels are identified by an id, as given by the table +below: +

+
‘FL’
+

front left +

+
‘FR’
+

front right +

+
‘FC’
+

front center +

+
‘LFE’
+

low frequency +

+
‘BL’
+

back left +

+
‘BR’
+

back right +

+
‘FLC’
+

front left-of-center +

+
‘FRC’
+

front right-of-center +

+
‘BC’
+

back center +

+
‘SL’
+

side left +

+
‘SR’
+

side right +

+
‘TC’
+

top center +

+
‘TFL’
+

top front left +

+
‘TFC’
+

top front center +

+
‘TFR’
+

top front right +

+
‘TBL’
+

top back left +

+
‘TBC’
+

top back center +

+
‘TBR’
+

top back right +

+
‘DL’
+

downmix left +

+
‘DR’
+

downmix right +

+
‘WL’
+

wide left +

+
‘WR’
+

wide right +

+
‘SDL’
+

surround direct left +

+
‘SDR’
+

surround direct right +

+
‘LFE2’
+

low frequency 2 +

+
+ +

Standard channel layout compositions can be specified by using the +following identifiers: +

+
‘mono’
+

FC +

+
‘stereo’
+

FL+FR +

+
‘2.1’
+

FL+FR+LFE +

+
‘3.0’
+

FL+FR+FC +

+
‘3.0(back)’
+

FL+FR+BC +

+
‘4.0’
+

FL+FR+FC+BC +

+
‘quad’
+

FL+FR+BL+BR +

+
‘quad(side)’
+

FL+FR+SL+SR +

+
‘3.1’
+

FL+FR+FC+LFE +

+
‘5.0’
+

FL+FR+FC+BL+BR +

+
‘5.0(side)’
+

FL+FR+FC+SL+SR +

+
‘4.1’
+

FL+FR+FC+LFE+BC +

+
‘5.1’
+

FL+FR+FC+LFE+BL+BR +

+
‘5.1(side)’
+

FL+FR+FC+LFE+SL+SR +

+
‘6.0’
+

FL+FR+FC+BC+SL+SR +

+
‘6.0(front)’
+

FL+FR+FLC+FRC+SL+SR +

+
‘hexagonal’
+

FL+FR+FC+BL+BR+BC +

+
‘6.1’
+

FL+FR+FC+LFE+BC+SL+SR +

+
‘6.1’
+

FL+FR+FC+LFE+BL+BR+BC +

+
‘6.1(front)’
+

FL+FR+LFE+FLC+FRC+SL+SR +

+
‘7.0’
+

FL+FR+FC+BL+BR+SL+SR +

+
‘7.0(front)’
+

FL+FR+FC+FLC+FRC+SL+SR +

+
‘7.1’
+

FL+FR+FC+LFE+BL+BR+SL+SR +

+
‘7.1(wide)’
+

FL+FR+FC+LFE+BL+BR+FLC+FRC +

+
‘7.1(wide-side)’
+

FL+FR+FC+LFE+FLC+FRC+SL+SR +

+
‘octagonal’
+

FL+FR+FC+BL+BR+BC+SL+SR +

+
‘hexadecagonal’
+

FL+FR+FC+BL+BR+BC+SL+SR+WL+WR+TBL+TBR+TBC+TFC+TFL+TFR +

+
‘downmix’
+

DL+DR +

+
+ +

A custom channel layout can be specified as a sequence of terms, separated by +’+’ or ’|’. Each term can be: +

    +
  • the name of a standard channel layout (e.g. ‘mono’, +‘stereo’, ‘4.0’, ‘quad’, ‘5.0’, etc.) + +
  • the name of a single channel (e.g. ‘FL’, ‘FR’, ‘FC’, ‘LFE’, etc.) + +
  • a number of channels, in decimal, followed by ’c’, yielding the default channel +layout for that number of channels (see the function +av_get_default_channel_layout). Note that not all channel counts have a +default layout. + +
  • a number of channels, in decimal, followed by ’C’, yielding an unknown channel +layout with the specified number of channels. Note that not all channel layout +specification strings support unknown channel layouts. + +
  • a channel layout mask, in hexadecimal starting with "0x" (see the +AV_CH_* macros in libavutil/channel_layout.h. +
+ +

Before libavutil version 53 the trailing character "c" to specify a number of +channels was optional, but now it is required, while a channel layout mask can +also be specified as a decimal number (if and only if not followed by "c" or "C"). +

+

See also the function av_get_channel_layout defined in +libavutil/channel_layout.h. +

+ +

8 Expression Evaluation

+ +

When evaluating an arithmetic expression, FFmpeg uses an internal +formula evaluator, implemented through the libavutil/eval.h +interface. +

+

An expression may contain unary, binary operators, constants, and +functions. +

+

Two expressions expr1 and expr2 can be combined to form +another expression "expr1;expr2". +expr1 and expr2 are evaluated in turn, and the new +expression evaluates to the value of expr2. +

+

The following binary operators are available: +, -, +*, /, ^. +

+

The following unary operators are available: +, -. +

+

The following functions are available: +

+
abs(x)
+

Compute absolute value of x. +

+
+
acos(x)
+

Compute arccosine of x. +

+
+
asin(x)
+

Compute arcsine of x. +

+
+
atan(x)
+

Compute arctangent of x. +

+
+
atan2(x, y)
+

Compute principal value of the arc tangent of y/x. +

+
+
between(x, min, max)
+

Return 1 if x is greater than or equal to min and lesser than or +equal to max, 0 otherwise. +

+
+
bitand(x, y)
+
bitor(x, y)
+

Compute bitwise and/or operation on x and y. +

+

The results of the evaluation of x and y are converted to +integers before executing the bitwise operation. +

+

Note that both the conversion to integer and the conversion back to +floating point can lose precision. Beware of unexpected results for +large numbers (usually 2^53 and larger). +

+
+
ceil(expr)
+

Round the value of expression expr upwards to the nearest +integer. For example, "ceil(1.5)" is "2.0". +

+
+
clip(x, min, max)
+

Return the value of x clipped between min and max. +

+
+
cos(x)
+

Compute cosine of x. +

+
+
cosh(x)
+

Compute hyperbolic cosine of x. +

+
+
eq(x, y)
+

Return 1 if x and y are equivalent, 0 otherwise. +

+
+
exp(x)
+

Compute exponential of x (with base e, the Euler’s number). +

+
+
floor(expr)
+

Round the value of expression expr downwards to the nearest +integer. For example, "floor(-1.5)" is "-2.0". +

+
+
gauss(x)
+

Compute Gauss function of x, corresponding to +exp(-x*x/2) / sqrt(2*PI). +

+
+
gcd(x, y)
+

Return the greatest common divisor of x and y. If both x and +y are 0 or either or both are less than zero then behavior is undefined. +

+
+
gt(x, y)
+

Return 1 if x is greater than y, 0 otherwise. +

+
+
gte(x, y)
+

Return 1 if x is greater than or equal to y, 0 otherwise. +

+
+
hypot(x, y)
+

This function is similar to the C function with the same name; it returns +"sqrt(x*x + y*y)", the length of the hypotenuse of a +right triangle with sides of length x and y, or the distance of the +point (x, y) from the origin. +

+
+
if(x, y)
+

Evaluate x, and if the result is non-zero return the result of +the evaluation of y, return 0 otherwise. +

+
+
if(x, y, z)
+

Evaluate x, and if the result is non-zero return the evaluation +result of y, otherwise the evaluation result of z. +

+
+
ifnot(x, y)
+

Evaluate x, and if the result is zero return the result of the +evaluation of y, return 0 otherwise. +

+
+
ifnot(x, y, z)
+

Evaluate x, and if the result is zero return the evaluation +result of y, otherwise the evaluation result of z. +

+
+
isinf(x)
+

Return 1.0 if x is +/-INFINITY, 0.0 otherwise. +

+
+
isnan(x)
+

Return 1.0 if x is NAN, 0.0 otherwise. +

+
+
ld(var)
+

Load the value of the internal variable with number +var, which was previously stored with st(var, expr). +The function returns the loaded value. +

+
+
lerp(x, y, z)
+

Return linear interpolation between x and y by amount of z. +

+
+
log(x)
+

Compute natural logarithm of x. +

+
+
lt(x, y)
+

Return 1 if x is lesser than y, 0 otherwise. +

+
+
lte(x, y)
+

Return 1 if x is lesser than or equal to y, 0 otherwise. +

+
+
max(x, y)
+

Return the maximum between x and y. +

+
+
min(x, y)
+

Return the minimum between x and y. +

+
+
mod(x, y)
+

Compute the remainder of division of x by y. +

+
+
not(expr)
+

Return 1.0 if expr is zero, 0.0 otherwise. +

+
+
pow(x, y)
+

Compute the power of x elevated y, it is equivalent to +"(x)^(y)". +

+
+
print(t)
+
print(t, l)
+

Print the value of expression t with loglevel l. If +l is not specified then a default log level is used. +Returns the value of the expression printed. +

+

Prints t with loglevel l +

+
+
random(x)
+

Return a pseudo random value between 0.0 and 1.0. x is the index of the +internal variable which will be used to save the seed/state. +

+
+
root(expr, max)
+

Find an input value for which the function represented by expr +with argument ld(0) is 0 in the interval 0..max. +

+

The expression in expr must denote a continuous function or the +result is undefined. +

+

ld(0) is used to represent the function input value, which means +that the given expression will be evaluated multiple times with +various input values that the expression can access through +ld(0). When the expression evaluates to 0 then the +corresponding input value will be returned. +

+
+
round(expr)
+

Round the value of expression expr to the nearest integer. For example, "round(1.5)" is "2.0". +

+
+
sgn(x)
+

Compute sign of x. +

+
+
sin(x)
+

Compute sine of x. +

+
+
sinh(x)
+

Compute hyperbolic sine of x. +

+
+
sqrt(expr)
+

Compute the square root of expr. This is equivalent to +"(expr)^.5". +

+
+
squish(x)
+

Compute expression 1/(1 + exp(4*x)). +

+
+
st(var, expr)
+

Store the value of the expression expr in an internal +variable. var specifies the number of the variable where to +store the value, and it is a value ranging from 0 to 9. The function +returns the value stored in the internal variable. +Note, Variables are currently not shared between expressions. +

+
+
tan(x)
+

Compute tangent of x. +

+
+
tanh(x)
+

Compute hyperbolic tangent of x. +

+
+
taylor(expr, x)
+
taylor(expr, x, id)
+

Evaluate a Taylor series at x, given an expression representing +the ld(id)-th derivative of a function at 0. +

+

When the series does not converge the result is undefined. +

+

ld(id) is used to represent the derivative order in expr, +which means that the given expression will be evaluated multiple times +with various input values that the expression can access through +ld(id). If id is not specified then 0 is assumed. +

+

Note, when you have the derivatives at y instead of 0, +taylor(expr, x-y) can be used. +

+
+
time(0)
+

Return the current (wallclock) time in seconds. +

+
+
trunc(expr)
+

Round the value of expression expr towards zero to the nearest +integer. For example, "trunc(-1.5)" is "-1.0". +

+
+
while(cond, expr)
+

Evaluate expression expr while the expression cond is +non-zero, and returns the value of the last expr evaluation, or +NAN if cond was always false. +

+
+ +

The following constants are available: +

+
PI
+

area of the unit disc, approximately 3.14 +

+
E
+

exp(1) (Euler’s number), approximately 2.718 +

+
PHI
+

golden ratio (1+sqrt(5))/2, approximately 1.618 +

+
+ +

Assuming that an expression is considered "true" if it has a non-zero +value, note that: +

+

* works like AND +

+

+ works like OR +

+

For example the construct: +

+
if (A AND B) then C
+
+

is equivalent to: +

+
if(A*B, C)
+
+ +

In your C code, you can extend the list of unary and binary functions, +and define recognized constants, so that they are available for your +expressions. +

+

The evaluator also recognizes the International System unit prefixes. +If ’i’ is appended after the prefix, binary prefixes are used, which +are based on powers of 1024 instead of powers of 1000. +The ’B’ postfix multiplies the value by 8, and can be appended after a +unit prefix or used alone. This allows using for example ’KB’, ’MiB’, +’G’ and ’B’ as number postfix. +

+

The list of available International System prefixes follows, with +indication of the corresponding powers of 10 and of 2. +

+
y
+

10^-24 / 2^-80 +

+
z
+

10^-21 / 2^-70 +

+
a
+

10^-18 / 2^-60 +

+
f
+

10^-15 / 2^-50 +

+
p
+

10^-12 / 2^-40 +

+
n
+

10^-9 / 2^-30 +

+
u
+

10^-6 / 2^-20 +

+
m
+

10^-3 / 2^-10 +

+
c
+

10^-2 +

+
d
+

10^-1 +

+
h
+

10^2 +

+
k
+

10^3 / 2^10 +

+
K
+

10^3 / 2^10 +

+
M
+

10^6 / 2^20 +

+
G
+

10^9 / 2^30 +

+
T
+

10^12 / 2^40 +

+
P
+

10^15 / 2^40 +

+
E
+

10^18 / 2^50 +

+
Z
+

10^21 / 2^60 +

+
Y
+

10^24 / 2^70 +

+
+ + +

9 Codec Options

+ +

libavcodec provides some generic global options, which can be set on +all the encoders and decoders. In addition each codec may support +so-called private options, which are specific for a given codec. +

+

Sometimes, a global option may only affect a specific kind of codec, +and may be nonsensical or ignored by another, so you need to be aware +of the meaning of the specified options. Also some options are +meant only for decoding or encoding. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the +AVCodecContext options or using the libavutil/opt.h API +for programmatic use. +

+

The list of supported options follow: +

+
+
b integer (encoding,audio,video)
+

Set bitrate in bits/s. Default value is 200K. +

+
+
ab integer (encoding,audio)
+

Set audio bitrate (in bits/s). Default value is 128K. +

+
+
bt integer (encoding,video)
+

Set video bitrate tolerance (in bits/s). In 1-pass mode, bitrate +tolerance specifies how far ratecontrol is willing to deviate from the +target average bitrate value. This is not related to min/max +bitrate. Lowering tolerance too much has an adverse effect on quality. +

+
+
flags flags (decoding/encoding,audio,video,subtitles)
+

Set generic flags. +

+

Possible values: +

+
‘mv4’
+

Use four motion vector by macroblock (mpeg4). +

+
‘qpel’
+

Use 1/4 pel motion compensation. +

+
‘loop’
+

Use loop filter. +

+
‘qscale’
+

Use fixed qscale. +

+
‘pass1’
+

Use internal 2pass ratecontrol in first pass mode. +

+
‘pass2’
+

Use internal 2pass ratecontrol in second pass mode. +

+
‘gray’
+

Only decode/encode grayscale. +

+
‘emu_edge’
+

Do not draw edges. +

+
‘psnr’
+

Set error[?] variables during encoding. +

+
‘truncated’
+

Input bitstream might be randomly truncated. +

+
‘drop_changed’
+

Don’t output frames whose parameters differ from first decoded frame in stream. +Error AVERROR_INPUT_CHANGED is returned when a frame is dropped. +

+
+
‘ildct’
+

Use interlaced DCT. +

+
‘low_delay’
+

Force low delay. +

+
‘global_header’
+

Place global headers in extradata instead of every keyframe. +

+
‘bitexact’
+

Only write platform-, build- and time-independent data. (except (I)DCT). +This ensures that file and data checksums are reproducible and match between +platforms. Its primary use is for regression testing. +

+
‘aic’
+

Apply H263 advanced intra coding / mpeg4 ac prediction. +

+
‘cbp’
+

Deprecated, use mpegvideo private options instead. +

+
‘qprd’
+

Deprecated, use mpegvideo private options instead. +

+
‘ilme’
+

Apply interlaced motion estimation. +

+
‘cgop’
+

Use closed gop. +

+
‘output_corrupt’
+

Output even potentially corrupted frames. +

+
+ +
+
me_method integer (encoding,video)
+

Set motion estimation method. +

+

Possible values: +

+
‘zero’
+

zero motion estimation (fastest) +

+
‘full’
+

full motion estimation (slowest) +

+
‘epzs’
+

EPZS motion estimation (default) +

+
‘esa’
+

esa motion estimation (alias for full) +

+
‘tesa’
+

tesa motion estimation +

+
‘dia’
+

dia motion estimation (alias for epzs) +

+
‘log’
+

log motion estimation +

+
‘phods’
+

phods motion estimation +

+
‘x1’
+

X1 motion estimation +

+
‘hex’
+

hex motion estimation +

+
‘umh’
+

umh motion estimation +

+
‘iter’
+

iter motion estimation +

+
+ +
+
extradata_size integer
+

Set extradata size. +

+
+
time_base rational number
+

Set codec time base. +

+

It is the fundamental unit of time (in seconds) in terms of which +frame timestamps are represented. For fixed-fps content, timebase +should be 1 / frame_rate and timestamp increments should be +identically 1. +

+
+
g integer (encoding,video)
+

Set the group of picture (GOP) size. Default value is 12. +

+
+
ar integer (decoding/encoding,audio)
+

Set audio sampling rate (in Hz). +

+
+
ac integer (decoding/encoding,audio)
+

Set number of audio channels. +

+
+
cutoff integer (encoding,audio)
+

Set cutoff bandwidth. (Supported only by selected encoders, see +their respective documentation sections.) +

+
+
frame_size integer (encoding,audio)
+

Set audio frame size. +

+

Each submitted frame except the last must contain exactly frame_size +samples per channel. May be 0 when the codec has +CODEC_CAP_VARIABLE_FRAME_SIZE set, in that case the frame size is not +restricted. It is set by some decoders to indicate constant frame +size. +

+
+
frame_number integer
+

Set the frame number. +

+
+
delay integer
+
qcomp float (encoding,video)
+

Set video quantizer scale compression (VBR). It is used as a constant +in the ratecontrol equation. Recommended range for default rc_eq: +0.0-1.0. +

+
+
qblur float (encoding,video)
+

Set video quantizer scale blur (VBR). +

+
+
qmin integer (encoding,video)
+

Set min video quantizer scale (VBR). Must be included between -1 and +69, default value is 2. +

+
+
qmax integer (encoding,video)
+

Set max video quantizer scale (VBR). Must be included between -1 and +1024, default value is 31. +

+
+
qdiff integer (encoding,video)
+

Set max difference between the quantizer scale (VBR). +

+
+
bf integer (encoding,video)
+

Set max number of B frames between non-B-frames. +

+

Must be an integer between -1 and 16. 0 means that B-frames are +disabled. If a value of -1 is used, it will choose an automatic value +depending on the encoder. +

+

Default value is 0. +

+
+
b_qfactor float (encoding,video)
+

Set qp factor between P and B frames. +

+
+
rc_strategy integer (encoding,video)
+

Set ratecontrol method. +

+
+
b_strategy integer (encoding,video)
+

Set strategy to choose between I/P/B-frames. +

+
+
ps integer (encoding,video)
+

Set RTP payload size in bytes. +

+
+
mv_bits integer
+
header_bits integer
+
i_tex_bits integer
+
p_tex_bits integer
+
i_count integer
+
p_count integer
+
skip_count integer
+
misc_bits integer
+
frame_bits integer
+
codec_tag integer
+
bug flags (decoding,video)
+

Workaround not auto detected encoder bugs. +

+

Possible values: +

+
‘autodetect’
+
‘old_msmpeg4’
+

some old lavc generated msmpeg4v3 files (no autodetection) +

+
‘xvid_ilace’
+

Xvid interlacing bug (autodetected if fourcc==XVIX) +

+
‘ump4’
+

(autodetected if fourcc==UMP4) +

+
‘no_padding’
+

padding bug (autodetected) +

+
‘amv’
+
‘ac_vlc’
+

illegal vlc bug (autodetected per fourcc) +

+
‘qpel_chroma’
+
‘std_qpel’
+

old standard qpel (autodetected per fourcc/version) +

+
‘qpel_chroma2’
+
‘direct_blocksize’
+

direct-qpel-blocksize bug (autodetected per fourcc/version) +

+
‘edge’
+

edge padding bug (autodetected per fourcc/version) +

+
‘hpel_chroma’
+
‘dc_clip’
+
‘ms’
+

Workaround various bugs in microsoft broken decoders. +

+
‘trunc’
+

trancated frames +

+
+ +
+
lelim integer (encoding,video)
+

Set single coefficient elimination threshold for luminance (negative +values also consider DC coefficient). +

+
+
celim integer (encoding,video)
+

Set single coefficient elimination threshold for chrominance (negative +values also consider dc coefficient) +

+
+
strict integer (decoding/encoding,audio,video)
+

Specify how strictly to follow the standards. +

+

Possible values: +

+
‘very’
+

strictly conform to an older more strict version of the spec or reference software +

+
‘strict’
+

strictly conform to all the things in the spec no matter what consequences +

+
‘normal’
+
‘unofficial’
+

allow unofficial extensions +

+
‘experimental’
+

allow non standardized experimental things, experimental +(unfinished/work in progress/not well tested) decoders and encoders. +Note: experimental decoders can pose a security risk, do not use this for +decoding untrusted input. +

+
+ +
+
b_qoffset float (encoding,video)
+

Set QP offset between P and B frames. +

+
+
err_detect flags (decoding,audio,video)
+

Set error detection flags. +

+

Possible values: +

+
‘crccheck’
+

verify embedded CRCs +

+
‘bitstream’
+

detect bitstream specification deviations +

+
‘buffer’
+

detect improper bitstream length +

+
‘explode’
+

abort decoding on minor error detection +

+
‘ignore_err’
+

ignore decoding errors, and continue decoding. +This is useful if you want to analyze the content of a video and thus want +everything to be decoded no matter what. This option will not result in a video +that is pleasing to watch in case of errors. +

+
‘careful’
+

consider things that violate the spec and have not been seen in the wild as errors +

+
‘compliant’
+

consider all spec non compliancies as errors +

+
‘aggressive’
+

consider things that a sane encoder should not do as an error +

+
+ +
+
has_b_frames integer
+
block_align integer
+
mpeg_quant integer (encoding,video)
+

Use MPEG quantizers instead of H.263. +

+
+
qsquish float (encoding,video)
+

How to keep quantizer between qmin and qmax (0 = clip, 1 = use +differentiable function). +

+
+
rc_qmod_amp float (encoding,video)
+

Set experimental quantizer modulation. +

+
+
rc_qmod_freq integer (encoding,video)
+

Set experimental quantizer modulation. +

+
+
rc_override_count integer
+
rc_eq string (encoding,video)
+

Set rate control equation. When computing the expression, besides the +standard functions defined in the section ’Expression Evaluation’, the +following functions are available: bits2qp(bits), qp2bits(qp). Also +the following constants are available: iTex pTex tex mv fCode iCount +mcVar var isI isP isB avgQP qComp avgIITex avgPITex avgPPTex avgBPTex +avgTex. +

+
+
maxrate integer (encoding,audio,video)
+

Set max bitrate tolerance (in bits/s). Requires bufsize to be set. +

+
+
minrate integer (encoding,audio,video)
+

Set min bitrate tolerance (in bits/s). Most useful in setting up a CBR +encode. It is of little use elsewise. +

+
+
bufsize integer (encoding,audio,video)
+

Set ratecontrol buffer size (in bits). +

+
+
rc_buf_aggressivity float (encoding,video)
+

Currently useless. +

+
+
i_qfactor float (encoding,video)
+

Set QP factor between P and I frames. +

+
+
i_qoffset float (encoding,video)
+

Set QP offset between P and I frames. +

+
+
rc_init_cplx float (encoding,video)
+

Set initial complexity for 1-pass encoding. +

+
+
dct integer (encoding,video)
+

Set DCT algorithm. +

+

Possible values: +

+
‘auto’
+

autoselect a good one (default) +

+
‘fastint’
+

fast integer +

+
‘int’
+

accurate integer +

+
‘mmx’
+
‘altivec’
+
‘faan’
+

floating point AAN DCT +

+
+ +
+
lumi_mask float (encoding,video)
+

Compress bright areas stronger than medium ones. +

+
+
tcplx_mask float (encoding,video)
+

Set temporal complexity masking. +

+
+
scplx_mask float (encoding,video)
+

Set spatial complexity masking. +

+
+
p_mask float (encoding,video)
+

Set inter masking. +

+
+
dark_mask float (encoding,video)
+

Compress dark areas stronger than medium ones. +

+
+
idct integer (decoding/encoding,video)
+

Select IDCT implementation. +

+

Possible values: +

+
‘auto’
+
‘int’
+
‘simple’
+
‘simplemmx’
+
‘simpleauto’
+

Automatically pick a IDCT compatible with the simple one +

+
+
‘arm’
+
‘altivec’
+
‘sh4’
+
‘simplearm’
+
‘simplearmv5te’
+
‘simplearmv6’
+
‘simpleneon’
+
‘simplealpha’
+
‘ipp’
+
‘xvidmmx’
+
‘faani’
+

floating point AAN IDCT +

+
+ +
+
slice_count integer
+
ec flags (decoding,video)
+

Set error concealment strategy. +

+

Possible values: +

+
‘guess_mvs’
+

iterative motion vector (MV) search (slow) +

+
‘deblock’
+

use strong deblock filter for damaged MBs +

+
‘favor_inter’
+

favor predicting from the previous frame instead of the current +

+
+ +
+
bits_per_coded_sample integer
+
pred integer (encoding,video)
+

Set prediction method. +

+

Possible values: +

+
‘left’
+
‘plane’
+
‘median’
+
+ +
+
aspect rational number (encoding,video)
+

Set sample aspect ratio. +

+
+
sar rational number (encoding,video)
+

Set sample aspect ratio. Alias to aspect. +

+
+
debug flags (decoding/encoding,audio,video,subtitles)
+

Print specific debug info. +

+

Possible values: +

+
‘pict’
+

picture info +

+
‘rc’
+

rate control +

+
‘bitstream’
+
‘mb_type’
+

macroblock (MB) type +

+
‘qp’
+

per-block quantization parameter (QP) +

+
‘dct_coeff’
+
‘green_metadata’
+

display complexity metadata for the upcoming frame, GoP or for a given duration. +

+
+
‘skip’
+
‘startcode’
+
‘er’
+

error recognition +

+
‘mmco’
+

memory management control operations (H.264) +

+
‘bugs’
+
‘buffers’
+

picture buffer allocations +

+
‘thread_ops’
+

threading operations +

+
‘nomc’
+

skip motion compensation +

+
+ +
+
cmp integer (encoding,video)
+

Set full pel me compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
subcmp integer (encoding,video)
+

Set sub pel me compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
mbcmp integer (encoding,video)
+

Set macroblock compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
ildctcmp integer (encoding,video)
+

Set interlaced dct compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
dia_size integer (encoding,video)
+

Set diamond type & size for motion estimation. +

+
‘(1024, INT_MAX)’
+

full motion estimation(slowest) +

+
‘(768, 1024]’
+

umh motion estimation +

+
‘(512, 768]’
+

hex motion estimation +

+
‘(256, 512]’
+

l2s diamond motion estimation +

+
‘[2,256]’
+

var diamond motion estimation +

+
‘(-1, 2)’
+

small diamond motion estimation +

+
‘-1’
+

funny diamond motion estimation +

+
‘(INT_MIN, -1)’
+

sab diamond motion estimation +

+
+ +
+
last_pred integer (encoding,video)
+

Set amount of motion predictors from the previous frame. +

+
+
preme integer (encoding,video)
+

Set pre motion estimation. +

+
+
precmp integer (encoding,video)
+

Set pre motion estimation compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
pre_dia_size integer (encoding,video)
+

Set diamond type & size for motion estimation pre-pass. +

+
+
subq integer (encoding,video)
+

Set sub pel motion estimation quality. +

+
+
dtg_active_format integer
+
me_range integer (encoding,video)
+

Set limit motion vectors range (1023 for DivX player). +

+
+
ibias integer (encoding,video)
+

Set intra quant bias. +

+
+
pbias integer (encoding,video)
+

Set inter quant bias. +

+
+
color_table_id integer
+
global_quality integer (encoding,audio,video)
+
coder integer (encoding,video)
+
+

Possible values: +

+
‘vlc’
+

variable length coder / huffman coder +

+
‘ac’
+

arithmetic coder +

+
‘raw’
+

raw (no encoding) +

+
‘rle’
+

run-length coder +

+
‘deflate’
+

deflate-based coder +

+
+ +
+
context integer (encoding,video)
+

Set context model. +

+
+
slice_flags integer
+
mbd integer (encoding,video)
+

Set macroblock decision algorithm (high quality mode). +

+

Possible values: +

+
‘simple’
+

use mbcmp (default) +

+
‘bits’
+

use fewest bits +

+
‘rd’
+

use best rate distortion +

+
+ +
+
stream_codec_tag integer
+
sc_threshold integer (encoding,video)
+

Set scene change threshold. +

+
+
lmin integer (encoding,video)
+

Set min lagrange factor (VBR). +

+
+
lmax integer (encoding,video)
+

Set max lagrange factor (VBR). +

+
+
nr integer (encoding,video)
+

Set noise reduction. +

+
+
rc_init_occupancy integer (encoding,video)
+

Set number of bits which should be loaded into the rc buffer before +decoding starts. +

+
+
flags2 flags (decoding/encoding,audio,video,subtitles)
+
+

Possible values: +

+
‘fast’
+

Allow non spec compliant speedup tricks. +

+
‘noout’
+

Skip bitstream encoding. +

+
‘ignorecrop’
+

Ignore cropping information from sps. +

+
‘local_header’
+

Place global headers at every keyframe instead of in extradata. +

+
‘chunks’
+

Frame data might be split into multiple chunks. +

+
‘showall’
+

Show all frames before the first keyframe. +

+
‘export_mvs’
+

Export motion vectors into frame side-data (see AV_FRAME_DATA_MOTION_VECTORS) +for codecs that support it. See also doc/examples/export_mvs.c. +

+
‘skip_manual’
+

Do not skip samples and export skip information as frame side data. +

+
‘ass_ro_flush_noop’
+

Do not reset ASS ReadOrder field on flush. +

+
+ +
+
export_side_data flags (decoding/encoding,audio,video,subtitles)
+
+

Possible values: +

+
‘mvs’
+

Export motion vectors into frame side-data (see AV_FRAME_DATA_MOTION_VECTORS) +for codecs that support it. See also doc/examples/export_mvs.c. +

+
‘prft’
+

Export encoder Producer Reference Time into packet side-data (see AV_PKT_DATA_PRFT) +for codecs that support it. +

+
+ +
+
error integer (encoding,video)
+
qns integer (encoding,video)
+

Deprecated, use mpegvideo private options instead. +

+
+
threads integer (decoding/encoding,video)
+

Set the number of threads to be used, in case the selected codec +implementation supports multi-threading. +

+

Possible values: +

+
‘auto, 0’
+

automatically select the number of threads to set +

+
+ +

Default value is ‘auto’. +

+
+
me_threshold integer (encoding,video)
+

Set motion estimation threshold. +

+
+
mb_threshold integer (encoding,video)
+

Set macroblock threshold. +

+
+
dc integer (encoding,video)
+

Set intra_dc_precision. +

+
+
nssew integer (encoding,video)
+

Set nsse weight. +

+
+
skip_top integer (decoding,video)
+

Set number of macroblock rows at the top which are skipped. +

+
+
skip_bottom integer (decoding,video)
+

Set number of macroblock rows at the bottom which are skipped. +

+
+
profile integer (encoding,audio,video)
+
+

Set encoder codec profile. Default value is ‘unknown’. Encoder specific +profiles are documented in the relevant encoder documentation. +

+
+
level integer (encoding,audio,video)
+
+

Possible values: +

+
‘unknown’
+
+ +
+
lowres integer (decoding,audio,video)
+

Decode at 1= 1/2, 2=1/4, 3=1/8 resolutions. +

+
+
skip_threshold integer (encoding,video)
+

Set frame skip threshold. +

+
+
skip_factor integer (encoding,video)
+

Set frame skip factor. +

+
+
skip_exp integer (encoding,video)
+

Set frame skip exponent. +Negative values behave identical to the corresponding positive ones, except +that the score is normalized. +Positive values exist primarily for compatibility reasons and are not so useful. +

+
+
skipcmp integer (encoding,video)
+

Set frame skip compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
border_mask float (encoding,video)
+

Increase the quantizer for macroblocks close to borders. +

+
+
mblmin integer (encoding,video)
+

Set min macroblock lagrange factor (VBR). +

+
+
mblmax integer (encoding,video)
+

Set max macroblock lagrange factor (VBR). +

+
+
mepc integer (encoding,video)
+

Set motion estimation bitrate penalty compensation (1.0 = 256). +

+
+
skip_loop_filter integer (decoding,video)
+
skip_idct integer (decoding,video)
+
skip_frame integer (decoding,video)
+
+

Make decoder discard processing depending on the frame type selected +by the option value. +

+

skip_loop_filter skips frame loop filtering, skip_idct +skips frame IDCT/dequantization, skip_frame skips decoding. +

+

Possible values: +

+
‘none’
+

Discard no frame. +

+
+
‘default’
+

Discard useless frames like 0-sized frames. +

+
+
‘noref’
+

Discard all non-reference frames. +

+
+
‘bidir’
+

Discard all bidirectional frames. +

+
+
‘nokey’
+

Discard all frames excepts keyframes. +

+
+
‘nointra’
+

Discard all frames except I frames. +

+
+
‘all’
+

Discard all frames. +

+
+ +

Default value is ‘default’. +

+
+
bidir_refine integer (encoding,video)
+

Refine the two motion vectors used in bidirectional macroblocks. +

+
+
brd_scale integer (encoding,video)
+

Downscale frames for dynamic B-frame decision. +

+
+
keyint_min integer (encoding,video)
+

Set minimum interval between IDR-frames. +

+
+
refs integer (encoding,video)
+

Set reference frames to consider for motion compensation. +

+
+
chromaoffset integer (encoding,video)
+

Set chroma qp offset from luma. +

+
+
trellis integer (encoding,audio,video)
+

Set rate-distortion optimal quantization. +

+
+
mv0_threshold integer (encoding,video)
+
b_sensitivity integer (encoding,video)
+

Adjust sensitivity of b_frame_strategy 1. +

+
+
compression_level integer (encoding,audio,video)
+
min_prediction_order integer (encoding,audio)
+
max_prediction_order integer (encoding,audio)
+
timecode_frame_start integer (encoding,video)
+

Set GOP timecode frame start number, in non drop frame format. +

+
+
request_channels integer (decoding,audio)
+

Set desired number of audio channels. +

+
+
bits_per_raw_sample integer
+
channel_layout integer (decoding/encoding,audio)
+
+

Possible values: +

+
request_channel_layout integer (decoding,audio)
+
+

Possible values: +

+
rc_max_vbv_use float (encoding,video)
+
rc_min_vbv_use float (encoding,video)
+
ticks_per_frame integer (decoding/encoding,audio,video)
+
color_primaries integer (decoding/encoding,video)
+

Possible values: +

+
‘bt709’
+

BT.709 +

+
‘bt470m’
+

BT.470 M +

+
‘bt470bg’
+

BT.470 BG +

+
‘smpte170m’
+

SMPTE 170 M +

+
‘smpte240m’
+

SMPTE 240 M +

+
‘film’
+

Film +

+
‘bt2020’
+

BT.2020 +

+
‘smpte428’
+
‘smpte428_1’
+

SMPTE ST 428-1 +

+
‘smpte431’
+

SMPTE 431-2 +

+
‘smpte432’
+

SMPTE 432-1 +

+
‘jedec-p22’
+

JEDEC P22 +

+
+ +
+
color_trc integer (decoding/encoding,video)
+

Possible values: +

+
‘bt709’
+

BT.709 +

+
‘gamma22’
+

BT.470 M +

+
‘gamma28’
+

BT.470 BG +

+
‘smpte170m’
+

SMPTE 170 M +

+
‘smpte240m’
+

SMPTE 240 M +

+
‘linear’
+

Linear +

+
‘log’
+
‘log100’
+

Log +

+
‘log_sqrt’
+
‘log316’
+

Log square root +

+
‘iec61966_2_4’
+
‘iec61966-2-4’
+

IEC 61966-2-4 +

+
‘bt1361’
+
‘bt1361e’
+

BT.1361 +

+
‘iec61966_2_1’
+
‘iec61966-2-1’
+

IEC 61966-2-1 +

+
‘bt2020_10’
+
‘bt2020_10bit’
+

BT.2020 - 10 bit +

+
‘bt2020_12’
+
‘bt2020_12bit’
+

BT.2020 - 12 bit +

+
‘smpte2084’
+

SMPTE ST 2084 +

+
‘smpte428’
+
‘smpte428_1’
+

SMPTE ST 428-1 +

+
‘arib-std-b67’
+

ARIB STD-B67 +

+
+ +
+
colorspace integer (decoding/encoding,video)
+

Possible values: +

+
‘rgb’
+

RGB +

+
‘bt709’
+

BT.709 +

+
‘fcc’
+

FCC +

+
‘bt470bg’
+

BT.470 BG +

+
‘smpte170m’
+

SMPTE 170 M +

+
‘smpte240m’
+

SMPTE 240 M +

+
‘ycocg’
+

YCOCG +

+
‘bt2020nc’
+
‘bt2020_ncl’
+

BT.2020 NCL +

+
‘bt2020c’
+
‘bt2020_cl’
+

BT.2020 CL +

+
‘smpte2085’
+

SMPTE 2085 +

+
+ +
+
color_range integer (decoding/encoding,video)
+

If used as input parameter, it serves as a hint to the decoder, which +color_range the input has. +Possible values: +

+
‘tv’
+
‘mpeg’
+

MPEG (219*2^(n-8)) +

+
‘pc’
+
‘jpeg’
+

JPEG (2^n-1) +

+
+ +
+
chroma_sample_location integer (decoding/encoding,video)
+

Possible values: +

+
‘left’
+
‘center’
+
‘topleft’
+
‘top’
+
‘bottomleft’
+
‘bottom’
+
+ +
+
log_level_offset integer
+

Set the log level offset. +

+
+
slices integer (encoding,video)
+

Number of slices, used in parallelized encoding. +

+
+
thread_type flags (decoding/encoding,video)
+

Select which multithreading methods to use. +

+

Use of ‘frame’ will increase decoding delay by one frame per +thread, so clients which cannot provide future frames should not use +it. +

+

Possible values: +

+
‘slice’
+

Decode more than one part of a single frame at once. +

+

Multithreading using slices works only when the video was encoded with +slices. +

+
+
‘frame’
+

Decode more than one frame at once. +

+
+ +

Default value is ‘slice+frame’. +

+
+
audio_service_type integer (encoding,audio)
+

Set audio service type. +

+

Possible values: +

+
‘ma’
+

Main Audio Service +

+
‘ef’
+

Effects +

+
‘vi’
+

Visually Impaired +

+
‘hi’
+

Hearing Impaired +

+
‘di’
+

Dialogue +

+
‘co’
+

Commentary +

+
‘em’
+

Emergency +

+
‘vo’
+

Voice Over +

+
‘ka’
+

Karaoke +

+
+ +
+
request_sample_fmt sample_fmt (decoding,audio)
+

Set sample format audio decoders should prefer. Default value is +none. +

+
+
pkt_timebase rational number
+
sub_charenc encoding (decoding,subtitles)
+

Set the input subtitles character encoding. +

+
+
field_order field_order (video)
+

Set/override the field order of the video. +Possible values: +

+
‘progressive’
+

Progressive video +

+
‘tt’
+

Interlaced video, top field coded and displayed first +

+
‘bb’
+

Interlaced video, bottom field coded and displayed first +

+
‘tb’
+

Interlaced video, top coded first, bottom displayed first +

+
‘bt’
+

Interlaced video, bottom coded first, top displayed first +

+
+ +
+
skip_alpha bool (decoding,video)
+

Set to 1 to disable processing alpha (transparency). This works like the +‘gray’ flag in the flags option which skips chroma information +instead of alpha. Default is 0. +

+
+
codec_whitelist list (input)
+

"," separated list of allowed decoders. By default all are allowed. +

+
+
dump_separator string (input)
+

Separator used to separate the fields printed on the command line about the +Stream parameters. +For example, to separate the fields with newlines and indentation: +

+
ffprobe -dump_separator "
+                          "  -i ~/videos/matrixbench_mpeg2.mpg
+
+ +
+
max_pixels integer (decoding/encoding,video)
+

Maximum number of pixels per image. This value can be used to avoid out of +memory failures due to large images. +

+
+
apply_cropping bool (decoding,video)
+

Enable cropping if cropping parameters are multiples of the required +alignment for the left and top parameters. If the alignment is not met the +cropping will be partially applied to maintain alignment. +Default is 1 (enabled). +Note: The required alignment depends on if AV_CODEC_FLAG_UNALIGNED is set and the +CPU. AV_CODEC_FLAG_UNALIGNED cannot be changed from the command line. Also hardware +decoders will not apply left/top Cropping. +

+ +
+
+ + + +

10 Decoders

+ +

Decoders are configured elements in FFmpeg which allow the decoding of +multimedia streams. +

+

When you configure your FFmpeg build, all the supported native decoders +are enabled by default. Decoders requiring an external library must be enabled +manually via the corresponding --enable-lib option. You can list all +available decoders using the configure option --list-decoders. +

+

You can disable all the decoders with the configure option +--disable-decoders and selectively enable / disable single decoders +with the options --enable-decoder=DECODER / +--disable-decoder=DECODER. +

+

The option -decoders of the ff* tools will display the list of +enabled decoders. +

+ + +

11 Video Decoders

+ +

A description of some of the currently available video decoders +follows. +

+ +

11.1 rawvideo

+ +

Raw video decoder. +

+

This decoder decodes rawvideo streams. +

+ +

11.1.1 Options

+ +
+
top top_field_first
+

Specify the assumed field type of the input video. +

+
-1
+

the video is assumed to be progressive (default) +

+
0
+

bottom-field-first is assumed +

+
1
+

top-field-first is assumed +

+
+ +
+
+ + +

11.2 libdav1d

+ +

dav1d AV1 decoder. +

+

libdav1d allows libavcodec to decode the AOMedia Video 1 (AV1) codec. +Requires the presence of the libdav1d headers and library during configuration. +You need to explicitly configure the build with --enable-libdav1d. +

+ +

11.2.1 Options

+ +

The following options are supported by the libdav1d wrapper. +

+
+
framethreads
+

Set amount of frame threads to use during decoding. The default value is 0 (autodetect). +

+
+
tilethreads
+

Set amount of tile threads to use during decoding. The default value is 0 (autodetect). +

+
+
filmgrain
+

Apply film grain to the decoded video if present in the bitstream. Defaults to the +internal default of the library. +

+
+
oppoint
+

Select an operating point of a scalable AV1 bitstream (0 - 31). Defaults to the +internal default of the library. +

+
+
alllayers
+

Output all spatial layers of a scalable AV1 bitstream. The default value is false. +

+
+
+ + +

11.3 libdavs2

+ +

AVS2-P2/IEEE1857.4 video decoder wrapper. +

+

This decoder allows libavcodec to decode AVS2 streams with davs2 library. +

+ + +

12 Audio Decoders

+ +

A description of some of the currently available audio decoders +follows. +

+ +

12.1 ac3

+ +

AC-3 audio decoder. +

+

This decoder implements part of ATSC A/52:2010 and ETSI TS 102 366, as well as +the undocumented RealAudio 3 (a.k.a. dnet). +

+ +

12.1.1 AC-3 Decoder Options

+ +
+
-drc_scale value
+

Dynamic Range Scale Factor. The factor to apply to dynamic range values +from the AC-3 stream. This factor is applied exponentially. +There are 3 notable scale factor ranges: +

+
drc_scale == 0
+

DRC disabled. Produces full range audio. +

+
0 < drc_scale <= 1
+

DRC enabled. Applies a fraction of the stream DRC value. +Audio reproduction is between full range and full compression. +

+
drc_scale > 1
+

DRC enabled. Applies drc_scale asymmetrically. +Loud sounds are fully compressed. Soft sounds are enhanced. +

+
+ +
+
+ + +

12.2 flac

+ +

FLAC audio decoder. +

+

This decoder aims to implement the complete FLAC specification from Xiph. +

+ +

12.2.1 FLAC Decoder options

+ +
+
-use_buggy_lpc
+

The lavc FLAC encoder used to produce buggy streams with high lpc values +(like the default value). This option makes it possible to decode such streams +correctly by using lavc’s old buggy lpc logic for decoding. +

+
+
+ + +

12.3 ffwavesynth

+ +

Internal wave synthesizer. +

+

This decoder generates wave patterns according to predefined sequences. Its +use is purely internal and the format of the data it accepts is not publicly +documented. +

+ +

12.4 libcelt

+ +

libcelt decoder wrapper. +

+

libcelt allows libavcodec to decode the Xiph CELT ultra-low delay audio codec. +Requires the presence of the libcelt headers and library during configuration. +You need to explicitly configure the build with --enable-libcelt. +

+ +

12.5 libgsm

+ +

libgsm decoder wrapper. +

+

libgsm allows libavcodec to decode the GSM full rate audio codec. Requires +the presence of the libgsm headers and library during configuration. You need +to explicitly configure the build with --enable-libgsm. +

+

This decoder supports both the ordinary GSM and the Microsoft variant. +

+ +

12.6 libilbc

+ +

libilbc decoder wrapper. +

+

libilbc allows libavcodec to decode the Internet Low Bitrate Codec (iLBC) +audio codec. Requires the presence of the libilbc headers and library during +configuration. You need to explicitly configure the build with +--enable-libilbc. +

+ +

12.6.1 Options

+ +

The following option is supported by the libilbc wrapper. +

+
+
enhance
+
+

Enable the enhancement of the decoded audio when set to 1. The default +value is 0 (disabled). +

+
+
+ + +

12.7 libopencore-amrnb

+ +

libopencore-amrnb decoder wrapper. +

+

libopencore-amrnb allows libavcodec to decode the Adaptive Multi-Rate +Narrowband audio codec. Using it requires the presence of the +libopencore-amrnb headers and library during configuration. You need to +explicitly configure the build with --enable-libopencore-amrnb. +

+

An FFmpeg native decoder for AMR-NB exists, so users can decode AMR-NB +without this library. +

+ +

12.8 libopencore-amrwb

+ +

libopencore-amrwb decoder wrapper. +

+

libopencore-amrwb allows libavcodec to decode the Adaptive Multi-Rate +Wideband audio codec. Using it requires the presence of the +libopencore-amrwb headers and library during configuration. You need to +explicitly configure the build with --enable-libopencore-amrwb. +

+

An FFmpeg native decoder for AMR-WB exists, so users can decode AMR-WB +without this library. +

+ +

12.9 libopus

+ +

libopus decoder wrapper. +

+

libopus allows libavcodec to decode the Opus Interactive Audio Codec. +Requires the presence of the libopus headers and library during +configuration. You need to explicitly configure the build with +--enable-libopus. +

+

An FFmpeg native decoder for Opus exists, so users can decode Opus +without this library. +

+ + +

13 Subtitles Decoders

+ + +

13.1 libaribb24

+ +

ARIB STD-B24 caption decoder. +

+

Implements profiles A and C of the ARIB STD-B24 standard. +

+ +

13.1.1 libaribb24 Decoder Options

+ +
+
-aribb24-base-path path
+

Sets the base path for the libaribb24 library. This is utilized for reading of +configuration files (for custom unicode conversions), and for dumping of +non-text symbols as images under that location. +

+

Unset by default. +

+
+
-aribb24-skip-ruby-text boolean
+

Tells the decoder wrapper to skip text blocks that contain half-height ruby +text. +

+

Enabled by default. +

+
+
+ + +

13.2 dvbsub

+ + +

13.2.1 Options

+ +
+
compute_clut
+
+
-1
+

Compute clut if no matching CLUT is in the stream. +

+
0
+

Never compute CLUT +

+
1
+

Always compute CLUT and override the one provided in the stream. +

+
+
+
dvb_substream
+

Selects the dvb substream, or all substreams if -1 which is default. +

+
+
+ + +

13.3 dvdsub

+ +

This codec decodes the bitmap subtitles used in DVDs; the same subtitles can +also be found in VobSub file pairs and in some Matroska files. +

+ +

13.3.1 Options

+ +
+
palette
+

Specify the global palette used by the bitmaps. When stored in VobSub, the +palette is normally specified in the index file; in Matroska, the palette is +stored in the codec extra-data in the same format as in VobSub. In DVDs, the +palette is stored in the IFO file, and therefore not available when reading +from dumped VOB files. +

+

The format for this option is a string containing 16 24-bits hexadecimal +numbers (without 0x prefix) separated by commas, for example 0d00ee, +ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1, +7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b. +

+
+
ifo_palette
+

Specify the IFO file from which the global palette is obtained. +(experimental) +

+
+
forced_subs_only
+

Only decode subtitle entries marked as forced. Some titles have forced +and non-forced subtitles in the same track. Setting this flag to 1 +will only keep the forced subtitles. Default value is 0. +

+
+ + +

13.4 libzvbi-teletext

+ +

Libzvbi allows libavcodec to decode DVB teletext pages and DVB teletext +subtitles. Requires the presence of the libzvbi headers and library during +configuration. You need to explicitly configure the build with +--enable-libzvbi. +

+ +

13.4.1 Options

+ +
+
txt_page
+

List of teletext page numbers to decode. Pages that do not match the specified +list are dropped. You may use the special * string to match all pages, +or subtitle to match all subtitle pages. +Default value is *. +

+
txt_default_region
+

Set default character set used for decoding, a value between 0 and 87 (see +ETS 300 706, Section 15, Table 32). Default value is -1, which does not +override the libzvbi default. This option is needed for some legacy level 1.0 +transmissions which cannot signal the proper charset. +

+
txt_chop_top
+

Discards the top teletext line. Default value is 1. +

+
txt_format
+

Specifies the format of the decoded subtitles. +

+
bitmap
+

The default format, you should use this for teletext pages, because certain +graphics and colors cannot be expressed in simple text or even ASS. +

+
text
+

Simple text based output without formatting. +

+
ass
+

Formatted ASS output, subtitle pages and teletext pages are returned in +different styles, subtitle pages are stripped down to text, but an effort is +made to keep the text alignment and the formatting. +

+
+
+
txt_left
+

X offset of generated bitmaps, default is 0. +

+
txt_top
+

Y offset of generated bitmaps, default is 0. +

+
txt_chop_spaces
+

Chops leading and trailing spaces and removes empty lines from the generated +text. This option is useful for teletext based subtitles where empty spaces may +be present at the start or at the end of the lines or empty lines may be +present between the subtitle lines because of double-sized teletext characters. +Default value is 1. +

+
txt_duration
+

Sets the display duration of the decoded teletext pages or subtitles in +milliseconds. Default value is -1 which means infinity or until the next +subtitle event comes. +

+
txt_transparent
+

Force transparent background of the generated teletext bitmaps. Default value +is 0 which means an opaque background. +

+
txt_opacity
+

Sets the opacity (0-255) of the teletext background. If +txt_transparent is not set, it only affects characters between a start +box and an end box, typically subtitles. Default value is 0 if +txt_transparent is set, 255 otherwise. +

+
+
+ + +

14 Encoders

+ +

Encoders are configured elements in FFmpeg which allow the encoding of +multimedia streams. +

+

When you configure your FFmpeg build, all the supported native encoders +are enabled by default. Encoders requiring an external library must be enabled +manually via the corresponding --enable-lib option. You can list all +available encoders using the configure option --list-encoders. +

+

You can disable all the encoders with the configure option +--disable-encoders and selectively enable / disable single encoders +with the options --enable-encoder=ENCODER / +--disable-encoder=ENCODER. +

+

The option -encoders of the ff* tools will display the list of +enabled encoders. +

+ + +

15 Audio Encoders

+ +

A description of some of the currently available audio encoders +follows. +

+ +

15.1 aac

+ +

Advanced Audio Coding (AAC) encoder. +

+

This encoder is the default AAC encoder, natively implemented into FFmpeg. +

+ +

15.1.1 Options

+ +
+
b
+

Set bit rate in bits/s. Setting this automatically activates constant bit rate +(CBR) mode. If this option is unspecified it is set to 128kbps. +

+
+
q
+

Set quality for variable bit rate (VBR) mode. This option is valid only using +the ffmpeg command-line tool. For library interface users, use +global_quality. +

+
+
cutoff
+

Set cutoff frequency. If unspecified will allow the encoder to dynamically +adjust the cutoff to improve clarity on low bitrates. +

+
+
aac_coder
+

Set AAC encoder coding method. Possible values: +

+
+
‘twoloop’
+

Two loop searching (TLS) method. +

+

This method first sets quantizers depending on band thresholds and then tries +to find an optimal combination by adding or subtracting a specific value from +all quantizers and adjusting some individual quantizer a little. Will tune +itself based on whether aac_is, aac_ms and aac_pns +are enabled. +

+
+
‘anmr’
+

Average noise to mask ratio (ANMR) trellis-based solution. +

+

This is an experimental coder which currently produces a lower quality, is more +unstable and is slower than the default twoloop coder but has potential. +Currently has no support for the aac_is or aac_pns options. +Not currently recommended. +

+
+
‘fast’
+

Constant quantizer method. +

+

Uses a cheaper version of twoloop algorithm that doesn’t try to do as many +clever adjustments. Worse with low bitrates (less than 64kbps), but is better +and much faster at higher bitrates. +This is the default choice for a coder +

+
+
+ +
+
aac_ms
+

Sets mid/side coding mode. The default value of "auto" will automatically use +M/S with bands which will benefit from such coding. Can be forced for all bands +using the value "enable", which is mainly useful for debugging or disabled using +"disable". +

+
+
aac_is
+

Sets intensity stereo coding tool usage. By default, it’s enabled and will +automatically toggle IS for similar pairs of stereo bands if it’s beneficial. +Can be disabled for debugging by setting the value to "disable". +

+
+
aac_pns
+

Uses perceptual noise substitution to replace low entropy high frequency bands +with imperceptible white noise during the decoding process. By default, it’s +enabled, but can be disabled for debugging purposes by using "disable". +

+
+
aac_tns
+

Enables the use of a multitap FIR filter which spans through the high frequency +bands to hide quantization noise during the encoding process and is reverted +by the decoder. As well as decreasing unpleasant artifacts in the high range +this also reduces the entropy in the high bands and allows for more bits to +be used by the mid-low bands. By default it’s enabled but can be disabled for +debugging by setting the option to "disable". +

+
+
aac_ltp
+

Enables the use of the long term prediction extension which increases coding +efficiency in very low bandwidth situations such as encoding of voice or +solo piano music by extending constant harmonic peaks in bands throughout +frames. This option is implied by profile:a aac_low and is incompatible with +aac_pred. Use in conjunction with -ar to decrease the samplerate. +

+
+
aac_pred
+

Enables the use of a more traditional style of prediction where the spectral +coefficients transmitted are replaced by the difference of the current +coefficients minus the previous "predicted" coefficients. In theory and sometimes +in practice this can improve quality for low to mid bitrate audio. +This option implies the aac_main profile and is incompatible with aac_ltp. +

+
+
profile
+

Sets the encoding profile, possible values: +

+
+
‘aac_low’
+

The default, AAC "Low-complexity" profile. Is the most compatible and produces +decent quality. +

+
+
‘mpeg2_aac_low’
+

Equivalent to -profile:a aac_low -aac_pns 0. PNS was introduced with the +MPEG4 specifications. +

+
+
‘aac_ltp’
+

Long term prediction profile, is enabled by and will enable the aac_ltp +option. Introduced in MPEG4. +

+
+
‘aac_main’
+

Main-type prediction profile, is enabled by and will enable the aac_pred +option. Introduced in MPEG2. +

+
+
+

If this option is unspecified it is set to ‘aac_low’. +

+
+ + +

15.2 ac3 and ac3_fixed

+ +

AC-3 audio encoders. +

+

These encoders implement part of ATSC A/52:2010 and ETSI TS 102 366, as well as +the undocumented RealAudio 3 (a.k.a. dnet). +

+

The ac3 encoder uses floating-point math, while the ac3_fixed +encoder only uses fixed-point integer math. This does not mean that one is +always faster, just that one or the other may be better suited to a +particular system. The floating-point encoder will generally produce better +quality audio for a given bitrate. The ac3_fixed encoder is not the +default codec for any of the output formats, so it must be specified explicitly +using the option -acodec ac3_fixed in order to use it. +

+ +

15.2.1 AC-3 Metadata

+ +

The AC-3 metadata options are used to set parameters that describe the audio, +but in most cases do not affect the audio encoding itself. Some of the options +do directly affect or influence the decoding and playback of the resulting +bitstream, while others are just for informational purposes. A few of the +options will add bits to the output stream that could otherwise be used for +audio data, and will thus affect the quality of the output. Those will be +indicated accordingly with a note in the option list below. +

+

These parameters are described in detail in several publicly-available +documents. +

+ + +

15.2.1.1 Metadata Control Options

+ +
+
-per_frame_metadata boolean
+

Allow Per-Frame Metadata. Specifies if the encoder should check for changing +metadata for each frame. +

+
0
+

The metadata values set at initialization will be used for every frame in the +stream. (default) +

+
1
+

Metadata values can be changed before encoding each frame. +

+
+ +
+
+ + +

15.2.1.2 Downmix Levels

+ +
+
-center_mixlev level
+

Center Mix Level. The amount of gain the decoder should apply to the center +channel when downmixing to stereo. This field will only be written to the +bitstream if a center channel is present. The value is specified as a scale +factor. There are 3 valid values: +

+
0.707
+

Apply -3dB gain +

+
0.595
+

Apply -4.5dB gain (default) +

+
0.500
+

Apply -6dB gain +

+
+ +
+
-surround_mixlev level
+

Surround Mix Level. The amount of gain the decoder should apply to the surround +channel(s) when downmixing to stereo. This field will only be written to the +bitstream if one or more surround channels are present. The value is specified +as a scale factor. There are 3 valid values: +

+
0.707
+

Apply -3dB gain +

+
0.500
+

Apply -6dB gain (default) +

+
0.000
+

Silence Surround Channel(s) +

+
+ +
+
+ + +

15.2.1.3 Audio Production Information

+

Audio Production Information is optional information describing the mixing +environment. Either none or both of the fields are written to the bitstream. +

+
+
-mixing_level number
+

Mixing Level. Specifies peak sound pressure level (SPL) in the production +environment when the mix was mastered. Valid values are 80 to 111, or -1 for +unknown or not indicated. The default value is -1, but that value cannot be +used if the Audio Production Information is written to the bitstream. Therefore, +if the room_type option is not the default value, the mixing_level +option must not be -1. +

+
+
-room_type type
+

Room Type. Describes the equalization used during the final mixing session at +the studio or on the dubbing stage. A large room is a dubbing stage with the +industry standard X-curve equalization; a small room has flat equalization. +This field will not be written to the bitstream if both the mixing_level +option and the room_type option have the default values. +

+
0
+
notindicated
+

Not Indicated (default) +

+
1
+
large
+

Large Room +

+
2
+
small
+

Small Room +

+
+ +
+
+ + +

15.2.1.4 Other Metadata Options

+ +
+
-copyright boolean
+

Copyright Indicator. Specifies whether a copyright exists for this audio. +

+
0
+
off
+

No Copyright Exists (default) +

+
1
+
on
+

Copyright Exists +

+
+ +
+
-dialnorm value
+

Dialogue Normalization. Indicates how far the average dialogue level of the +program is below digital 100% full scale (0 dBFS). This parameter determines a +level shift during audio reproduction that sets the average volume of the +dialogue to a preset level. The goal is to match volume level between program +sources. A value of -31dB will result in no volume level change, relative to +the source volume, during audio reproduction. Valid values are whole numbers in +the range -31 to -1, with -31 being the default. +

+
+
-dsur_mode mode
+

Dolby Surround Mode. Specifies whether the stereo signal uses Dolby Surround +(Pro Logic). This field will only be written to the bitstream if the audio +stream is stereo. Using this option does NOT mean the encoder will actually +apply Dolby Surround processing. +

+
0
+
notindicated
+

Not Indicated (default) +

+
1
+
off
+

Not Dolby Surround Encoded +

+
2
+
on
+

Dolby Surround Encoded +

+
+ +
+
-original boolean
+

Original Bit Stream Indicator. Specifies whether this audio is from the +original source and not a copy. +

+
0
+
off
+

Not Original Source +

+
1
+
on
+

Original Source (default) +

+
+ +
+
+ + +

15.2.2 Extended Bitstream Information

+

The extended bitstream options are part of the Alternate Bit Stream Syntax as +specified in Annex D of the A/52:2010 standard. It is grouped into 2 parts. +If any one parameter in a group is specified, all values in that group will be +written to the bitstream. Default values are used for those that are written +but have not been specified. If the mixing levels are written, the decoder +will use these values instead of the ones specified in the center_mixlev +and surround_mixlev options if it supports the Alternate Bit Stream +Syntax. +

+ +

15.2.2.1 Extended Bitstream Information - Part 1

+ +
+
-dmix_mode mode
+

Preferred Stereo Downmix Mode. Allows the user to select either Lt/Rt +(Dolby Surround) or Lo/Ro (normal stereo) as the preferred stereo downmix mode. +

+
0
+
notindicated
+

Not Indicated (default) +

+
1
+
ltrt
+

Lt/Rt Downmix Preferred +

+
2
+
loro
+

Lo/Ro Downmix Preferred +

+
+ +
+
-ltrt_cmixlev level
+

Lt/Rt Center Mix Level. The amount of gain the decoder should apply to the +center channel when downmixing to stereo in Lt/Rt mode. +

+
1.414
+

Apply +3dB gain +

+
1.189
+

Apply +1.5dB gain +

+
1.000
+

Apply 0dB gain +

+
0.841
+

Apply -1.5dB gain +

+
0.707
+

Apply -3.0dB gain +

+
0.595
+

Apply -4.5dB gain (default) +

+
0.500
+

Apply -6.0dB gain +

+
0.000
+

Silence Center Channel +

+
+ +
+
-ltrt_surmixlev level
+

Lt/Rt Surround Mix Level. The amount of gain the decoder should apply to the +surround channel(s) when downmixing to stereo in Lt/Rt mode. +

+
0.841
+

Apply -1.5dB gain +

+
0.707
+

Apply -3.0dB gain +

+
0.595
+

Apply -4.5dB gain +

+
0.500
+

Apply -6.0dB gain (default) +

+
0.000
+

Silence Surround Channel(s) +

+
+ +
+
-loro_cmixlev level
+

Lo/Ro Center Mix Level. The amount of gain the decoder should apply to the +center channel when downmixing to stereo in Lo/Ro mode. +

+
1.414
+

Apply +3dB gain +

+
1.189
+

Apply +1.5dB gain +

+
1.000
+

Apply 0dB gain +

+
0.841
+

Apply -1.5dB gain +

+
0.707
+

Apply -3.0dB gain +

+
0.595
+

Apply -4.5dB gain (default) +

+
0.500
+

Apply -6.0dB gain +

+
0.000
+

Silence Center Channel +

+
+ +
+
-loro_surmixlev level
+

Lo/Ro Surround Mix Level. The amount of gain the decoder should apply to the +surround channel(s) when downmixing to stereo in Lo/Ro mode. +

+
0.841
+

Apply -1.5dB gain +

+
0.707
+

Apply -3.0dB gain +

+
0.595
+

Apply -4.5dB gain +

+
0.500
+

Apply -6.0dB gain (default) +

+
0.000
+

Silence Surround Channel(s) +

+
+ +
+
+ + +

15.2.2.2 Extended Bitstream Information - Part 2

+ +
+
-dsurex_mode mode
+

Dolby Surround EX Mode. Indicates whether the stream uses Dolby Surround EX +(7.1 matrixed to 5.1). Using this option does NOT mean the encoder will actually +apply Dolby Surround EX processing. +

+
0
+
notindicated
+

Not Indicated (default) +

+
1
+
on
+

Dolby Surround EX Off +

+
2
+
off
+

Dolby Surround EX On +

+
+ +
+
-dheadphone_mode mode
+

Dolby Headphone Mode. Indicates whether the stream uses Dolby Headphone +encoding (multi-channel matrixed to 2.0 for use with headphones). Using this +option does NOT mean the encoder will actually apply Dolby Headphone +processing. +

+
0
+
notindicated
+

Not Indicated (default) +

+
1
+
on
+

Dolby Headphone Off +

+
2
+
off
+

Dolby Headphone On +

+
+ +
+
-ad_conv_type type
+

A/D Converter Type. Indicates whether the audio has passed through HDCD A/D +conversion. +

+
0
+
standard
+

Standard A/D Converter (default) +

+
1
+
hdcd
+

HDCD A/D Converter +

+
+ +
+
+ + +

15.2.3 Other AC-3 Encoding Options

+ +
+
-stereo_rematrixing boolean
+

Stereo Rematrixing. Enables/Disables use of rematrixing for stereo input. This +is an optional AC-3 feature that increases quality by selectively encoding +the left/right channels as mid/side. This option is enabled by default, and it +is highly recommended that it be left as enabled except for testing purposes. +

+
+
cutoff frequency
+

Set lowpass cutoff frequency. If unspecified, the encoder selects a default +determined by various other encoding parameters. +

+
+
+ + +

15.2.4 Floating-Point-Only AC-3 Encoding Options

+ +

These options are only valid for the floating-point encoder and do not exist +for the fixed-point encoder due to the corresponding features not being +implemented in fixed-point. +

+
+
-channel_coupling boolean
+

Enables/Disables use of channel coupling, which is an optional AC-3 feature +that increases quality by combining high frequency information from multiple +channels into a single channel. The per-channel high frequency information is +sent with less accuracy in both the frequency and time domains. This allows +more bits to be used for lower frequencies while preserving enough information +to reconstruct the high frequencies. This option is enabled by default for the +floating-point encoder and should generally be left as enabled except for +testing purposes or to increase encoding speed. +

+
-1
+
auto
+

Selected by Encoder (default) +

+
0
+
off
+

Disable Channel Coupling +

+
1
+
on
+

Enable Channel Coupling +

+
+ +
+
-cpl_start_band number
+

Coupling Start Band. Sets the channel coupling start band, from 1 to 15. If a +value higher than the bandwidth is used, it will be reduced to 1 less than the +coupling end band. If auto is used, the start band will be determined by +the encoder based on the bit rate, sample rate, and channel layout. This option +has no effect if channel coupling is disabled. +

+
-1
+
auto
+

Selected by Encoder (default) +

+
+ +
+
+ + +

15.3 flac

+ +

FLAC (Free Lossless Audio Codec) Encoder +

+ +

15.3.1 Options

+ +

The following options are supported by FFmpeg’s flac encoder. +

+
+
compression_level
+

Sets the compression level, which chooses defaults for many other options +if they are not set explicitly. Valid values are from 0 to 12, 5 is the +default. +

+
+
frame_size
+

Sets the size of the frames in samples per channel. +

+
+
lpc_coeff_precision
+

Sets the LPC coefficient precision, valid values are from 1 to 15, 15 is the +default. +

+
+
lpc_type
+

Sets the first stage LPC algorithm +

+
‘none’
+

LPC is not used +

+
+
‘fixed’
+

fixed LPC coefficients +

+
+
‘levinson’
+
‘cholesky’
+
+ +
+
lpc_passes
+

Number of passes to use for Cholesky factorization during LPC analysis +

+
+
min_partition_order
+

The minimum partition order +

+
+
max_partition_order
+

The maximum partition order +

+
+
prediction_order_method
+
+
‘estimation’
+
‘2level’
+
‘4level’
+
‘8level’
+
‘search’
+

Bruteforce search +

+
‘log’
+
+ +
+
ch_mode
+

Channel mode +

+
‘auto’
+

The mode is chosen automatically for each frame +

+
‘indep’
+

Channels are independently coded +

+
‘left_side’
+
‘right_side’
+
‘mid_side’
+
+ +
+
exact_rice_parameters
+

Chooses if rice parameters are calculated exactly or approximately. +if set to 1 then they are chosen exactly, which slows the code down slightly and +improves compression slightly. +

+
+
multi_dim_quant
+

Multi Dimensional Quantization. If set to 1 then a 2nd stage LPC algorithm is +applied after the first stage to finetune the coefficients. This is quite slow +and slightly improves compression. +

+
+
+ + +

15.4 opus

+ +

Opus encoder. +

+

This is a native FFmpeg encoder for the Opus format. Currently its in development and +only implements the CELT part of the codec. Its quality is usually worse and at best +is equal to the libopus encoder. +

+ +

15.4.1 Options

+ +
+
b
+

Set bit rate in bits/s. If unspecified it uses the number of channels and the layout +to make a good guess. +

+
+
opus_delay
+

Sets the maximum delay in milliseconds. Lower delays than 20ms will very quickly +decrease quality. +

+
+ + +

15.5 libfdk_aac

+ +

libfdk-aac AAC (Advanced Audio Coding) encoder wrapper. +

+

The libfdk-aac library is based on the Fraunhofer FDK AAC code from +the Android project. +

+

Requires the presence of the libfdk-aac headers and library during +configuration. You need to explicitly configure the build with +--enable-libfdk-aac. The library is also incompatible with GPL, +so if you allow the use of GPL, you should configure with +--enable-gpl --enable-nonfree --enable-libfdk-aac. +

+

This encoder has support for the AAC-HE profiles. +

+

VBR encoding, enabled through the vbr or flags ++qscale options, is experimental and only works with some +combinations of parameters. +

+

Support for encoding 7.1 audio is only available with libfdk-aac 0.1.3 or +higher. +

+

For more information see the fdk-aac project at +http://sourceforge.net/p/opencore-amr/fdk-aac/. +

+ +

15.5.1 Options

+ +

The following options are mapped on the shared FFmpeg codec options. +

+
+
b
+

Set bit rate in bits/s. If the bitrate is not explicitly specified, it +is automatically set to a suitable value depending on the selected +profile. +

+

In case VBR mode is enabled the option is ignored. +

+
+
ar
+

Set audio sampling rate (in Hz). +

+
+
channels
+

Set the number of audio channels. +

+
+
flags +qscale
+

Enable fixed quality, VBR (Variable Bit Rate) mode. +Note that VBR is implicitly enabled when the vbr value is +positive. +

+
+
cutoff
+

Set cutoff frequency. If not specified (or explicitly set to 0) it +will use a value automatically computed by the library. Default value +is 0. +

+
+
profile
+

Set audio profile. +

+

The following profiles are recognized: +

+
‘aac_low’
+

Low Complexity AAC (LC) +

+
+
‘aac_he’
+

High Efficiency AAC (HE-AAC) +

+
+
‘aac_he_v2’
+

High Efficiency AAC version 2 (HE-AACv2) +

+
+
‘aac_ld’
+

Low Delay AAC (LD) +

+
+
‘aac_eld’
+

Enhanced Low Delay AAC (ELD) +

+
+ +

If not specified it is set to ‘aac_low’. +

+
+ +

The following are private options of the libfdk_aac encoder. +

+
+
afterburner
+

Enable afterburner feature if set to 1, disabled if set to 0. This +improves the quality but also the required processing power. +

+

Default value is 1. +

+
+
eld_sbr
+

Enable SBR (Spectral Band Replication) for ELD if set to 1, disabled +if set to 0. +

+

Default value is 0. +

+
+
eld_v2
+

Enable ELDv2 (LD-MPS extension for ELD stereo signals) for ELDv2 if set to 1, +disabled if set to 0. +

+

Note that option is available when fdk-aac version (AACENCODER_LIB_VL0.AACENCODER_LIB_VL1.AACENCODER_LIB_VL2) > (4.0.0). +

+

Default value is 0. +

+
+
signaling
+

Set SBR/PS signaling style. +

+

It can assume one of the following values: +

+
‘default’
+

choose signaling implicitly (explicit hierarchical by default, +implicit if global header is disabled) +

+
+
‘implicit’
+

implicit backwards compatible signaling +

+
+
‘explicit_sbr’
+

explicit SBR, implicit PS signaling +

+
+
‘explicit_hierarchical’
+

explicit hierarchical signaling +

+
+ +

Default value is ‘default’. +

+
+
latm
+

Output LATM/LOAS encapsulated data if set to 1, disabled if set to 0. +

+

Default value is 0. +

+
+
header_period
+

Set StreamMuxConfig and PCE repetition period (in frames) for sending +in-band configuration buffers within LATM/LOAS transport layer. +

+

Must be a 16-bits non-negative integer. +

+

Default value is 0. +

+
+
vbr
+

Set VBR mode, from 1 to 5. 1 is lowest quality (though still pretty +good) and 5 is highest quality. A value of 0 will disable VBR, and CBR +(Constant Bit Rate) is enabled. +

+

Currently only the ‘aac_low’ profile supports VBR encoding. +

+

VBR modes 1-5 correspond to roughly the following average bit rates: +

+
+
‘1’
+

32 kbps/channel +

+
‘2’
+

40 kbps/channel +

+
‘3’
+

48-56 kbps/channel +

+
‘4’
+

64 kbps/channel +

+
‘5’
+

about 80-96 kbps/channel +

+
+ +

Default value is 0. +

+
+ + +

15.5.2 Examples

+ +
    +
  • Use ffmpeg to convert an audio file to VBR AAC in an M4A (MP4) +container: +
    +
    ffmpeg -i input.wav -codec:a libfdk_aac -vbr 3 output.m4a
+
    + +
  • Use ffmpeg to convert an audio file to CBR 64k kbps AAC, using the +High-Efficiency AAC profile: +
    +
    ffmpeg -i input.wav -c:a libfdk_aac -profile:a aac_he -b:a 64k output.m4a
+
    +
+ + +

15.6 libmp3lame

+ +

LAME (Lame Ain’t an MP3 Encoder) MP3 encoder wrapper. +

+

Requires the presence of the libmp3lame headers and library during +configuration. You need to explicitly configure the build with +--enable-libmp3lame. +

+

See libshine for a fixed-point MP3 encoder, although with a +lower quality. +

+ +

15.6.1 Options

+ +

The following options are supported by the libmp3lame wrapper. The +lame-equivalent of the options are listed in parentheses. +

+
+
b (-b)
+

Set bitrate expressed in bits/s for CBR or ABR. LAME bitrate is +expressed in kilobits/s. +

+
+
q (-V)
+

Set constant quality setting for VBR. This option is valid only +using the ffmpeg command-line tool. For library interface +users, use global_quality. +

+
+
compression_level (-q)
+

Set algorithm quality. Valid arguments are integers in the 0-9 range, +with 0 meaning highest quality but slowest, and 9 meaning fastest +while producing the worst quality. +

+
+
cutoff (--lowpass)
+

Set lowpass cutoff frequency. If unspecified, the encoder dynamically +adjusts the cutoff. +

+
+
reservoir
+

Enable use of bit reservoir when set to 1. Default value is 1. LAME +has this enabled by default, but can be overridden by use +--nores option. +

+
+
joint_stereo (-m j)
+

Enable the encoder to use (on a frame by frame basis) either L/R +stereo or mid/side stereo. Default value is 1. +

+
+
abr (--abr)
+

Enable the encoder to use ABR when set to 1. The lame +--abr sets the target bitrate, while this options only +tells FFmpeg to use ABR still relies on b to set bitrate. +

+
+
+ + +

15.7 libopencore-amrnb

+ +

OpenCORE Adaptive Multi-Rate Narrowband encoder. +

+

Requires the presence of the libopencore-amrnb headers and library during +configuration. You need to explicitly configure the build with +--enable-libopencore-amrnb --enable-version3. +

+

This is a mono-only encoder. Officially it only supports 8000Hz sample rate, +but you can override it by setting strict to ‘unofficial’ or +lower. +

+ +

15.7.1 Options

+ +
+
b
+

Set bitrate in bits per second. Only the following bitrates are supported, +otherwise libavcodec will round to the nearest valid bitrate. +

+
+
4750
+
5150
+
5900
+
6700
+
7400
+
7950
+
10200
+
12200
+
+ +
+
dtx
+

Allow discontinuous transmission (generate comfort noise) when set to 1. The +default value is 0 (disabled). +

+
+
+ + +

15.8 libopus

+ +

libopus Opus Interactive Audio Codec encoder wrapper. +

+

Requires the presence of the libopus headers and library during +configuration. You need to explicitly configure the build with +--enable-libopus. +

+ +

15.8.1 Option Mapping

+ +

Most libopus options are modelled after the opusenc utility from +opus-tools. The following is an option mapping chart describing options +supported by the libopus wrapper, and their opusenc-equivalent +in parentheses. +

+
+
b (bitrate)
+

Set the bit rate in bits/s. FFmpeg’s b option is +expressed in bits/s, while opusenc’s bitrate in +kilobits/s. +

+
+
vbr (vbr, hard-cbr, and cvbr)
+

Set VBR mode. The FFmpeg vbr option has the following +valid arguments, with the opusenc equivalent options +in parentheses: +

+
+
‘off (hard-cbr)’
+

Use constant bit rate encoding. +

+
+
‘on (vbr)’
+

Use variable bit rate encoding (the default). +

+
+
‘constrained (cvbr)’
+

Use constrained variable bit rate encoding. +

+
+ +
+
compression_level (comp)
+

Set encoding algorithm complexity. Valid options are integers in +the 0-10 range. 0 gives the fastest encodes but lower quality, while 10 +gives the highest quality but slowest encoding. The default is 10. +

+
+
frame_duration (framesize)
+

Set maximum frame size, or duration of a frame in milliseconds. The +argument must be exactly the following: 2.5, 5, 10, 20, 40, 60. Smaller +frame sizes achieve lower latency but less quality at a given bitrate. +Sizes greater than 20ms are only interesting at fairly low bitrates. +The default is 20ms. +

+
+
packet_loss (expect-loss)
+

Set expected packet loss percentage. The default is 0. +

+
+
application (N.A.)
+

Set intended application type. Valid options are listed below: +

+
+
‘voip’
+

Favor improved speech intelligibility. +

+
‘audio’
+

Favor faithfulness to the input (the default). +

+
‘lowdelay’
+

Restrict to only the lowest delay modes. +

+
+ +
+
cutoff (N.A.)
+

Set cutoff bandwidth in Hz. The argument must be exactly one of the +following: 4000, 6000, 8000, 12000, or 20000, corresponding to +narrowband, mediumband, wideband, super wideband, and fullband +respectively. The default is 0 (cutoff disabled). +

+
+
mapping_family (mapping_family)
+

Set channel mapping family to be used by the encoder. The default value of -1 +uses mapping family 0 for mono and stereo inputs, and mapping family 1 +otherwise. The default also disables the surround masking and LFE bandwidth +optimzations in libopus, and requires that the input contains 8 channels or +fewer. +

+

Other values include 0 for mono and stereo, 1 for surround sound with masking +and LFE bandwidth optimizations, and 255 for independent streams with an +unspecified channel layout. +

+
+
apply_phase_inv (N.A.) (requires libopus >= 1.2)
+

If set to 0, disables the use of phase inversion for intensity stereo, +improving the quality of mono downmixes, but slightly reducing normal stereo +quality. The default is 1 (phase inversion enabled). +

+
+
+ + +

15.9 libshine

+ +

Shine Fixed-Point MP3 encoder wrapper. +

+

Shine is a fixed-point MP3 encoder. It has a far better performance on +platforms without an FPU, e.g. armel CPUs, and some phones and tablets. +However, as it is more targeted on performance than quality, it is not on par +with LAME and other production-grade encoders quality-wise. Also, according to +the project’s homepage, this encoder may not be free of bugs as the code was +written a long time ago and the project was dead for at least 5 years. +

+

This encoder only supports stereo and mono input. This is also CBR-only. +

+

The original project (last updated in early 2007) is at +http://sourceforge.net/projects/libshine-fxp/. We only support the +updated fork by the Savonet/Liquidsoap project at https://github.com/savonet/shine. +

+

Requires the presence of the libshine headers and library during +configuration. You need to explicitly configure the build with +--enable-libshine. +

+

See also libmp3lame. +

+ +

15.9.1 Options

+ +

The following options are supported by the libshine wrapper. The +shineenc-equivalent of the options are listed in parentheses. +

+
+
b (-b)
+

Set bitrate expressed in bits/s for CBR. shineenc -b option +is expressed in kilobits/s. +

+
+
+ + +

15.10 libtwolame

+ +

TwoLAME MP2 encoder wrapper. +

+

Requires the presence of the libtwolame headers and library during +configuration. You need to explicitly configure the build with +--enable-libtwolame. +

+ +

15.10.1 Options

+ +

The following options are supported by the libtwolame wrapper. The +twolame-equivalent options follow the FFmpeg ones and are in +parentheses. +

+
+
b (-b)
+

Set bitrate expressed in bits/s for CBR. twolame b +option is expressed in kilobits/s. Default value is 128k. +

+
+
q (-V)
+

Set quality for experimental VBR support. Maximum value range is +from -50 to 50, useful range is from -10 to 10. The higher the +value, the better the quality. This option is valid only using the +ffmpeg command-line tool. For library interface users, +use global_quality. +

+
+
mode (--mode)
+

Set the mode of the resulting audio. Possible values: +

+
+
‘auto’
+

Choose mode automatically based on the input. This is the default. +

+
‘stereo’
+

Stereo +

+
‘joint_stereo’
+

Joint stereo +

+
‘dual_channel’
+

Dual channel +

+
‘mono’
+

Mono +

+
+ +
+
psymodel (--psyc-mode)
+

Set psychoacoustic model to use in encoding. The argument must be +an integer between -1 and 4, inclusive. The higher the value, the +better the quality. The default value is 3. +

+
+
energy_levels (--energy)
+

Enable energy levels extensions when set to 1. The default value is +0 (disabled). +

+
+
error_protection (--protect)
+

Enable CRC error protection when set to 1. The default value is 0 +(disabled). +

+
+
copyright (--copyright)
+

Set MPEG audio copyright flag when set to 1. The default value is 0 +(disabled). +

+
+
original (--original)
+

Set MPEG audio original flag when set to 1. The default value is 0 +(disabled). +

+
+
+ + +

15.11 libvo-amrwbenc

+ +

VisualOn Adaptive Multi-Rate Wideband encoder. +

+

Requires the presence of the libvo-amrwbenc headers and library during +configuration. You need to explicitly configure the build with +--enable-libvo-amrwbenc --enable-version3. +

+

This is a mono-only encoder. Officially it only supports 16000Hz sample +rate, but you can override it by setting strict to +‘unofficial’ or lower. +

+ +

15.11.1 Options

+ +
+
b
+

Set bitrate in bits/s. Only the following bitrates are supported, otherwise +libavcodec will round to the nearest valid bitrate. +

+
+
‘6600’
+
‘8850’
+
‘12650’
+
‘14250’
+
‘15850’
+
‘18250’
+
‘19850’
+
‘23050’
+
‘23850’
+
+ +
+
dtx
+

Allow discontinuous transmission (generate comfort noise) when set to 1. The +default value is 0 (disabled). +

+
+
+ + +

15.12 libvorbis

+ +

libvorbis encoder wrapper. +

+

Requires the presence of the libvorbisenc headers and library during +configuration. You need to explicitly configure the build with +--enable-libvorbis. +

+ +

15.12.1 Options

+ +

The following options are supported by the libvorbis wrapper. The +oggenc-equivalent of the options are listed in parentheses. +

+

To get a more accurate and extensive documentation of the libvorbis +options, consult the libvorbisenc’s and oggenc’s documentations. +See http://xiph.org/vorbis/, +http://wiki.xiph.org/Vorbis-tools, and oggenc(1). +

+
+
b (-b)
+

Set bitrate expressed in bits/s for ABR. oggenc -b is +expressed in kilobits/s. +

+
+
q (-q)
+

Set constant quality setting for VBR. The value should be a float +number in the range of -1.0 to 10.0. The higher the value, the better +the quality. The default value is ‘3.0’. +

+

This option is valid only using the ffmpeg command-line tool. +For library interface users, use global_quality. +

+
+
cutoff (--advanced-encode-option lowpass_frequency=N)
+

Set cutoff bandwidth in Hz, a value of 0 disables cutoff. oggenc’s +related option is expressed in kHz. The default value is ‘0’ (cutoff +disabled). +

+
+
minrate (-m)
+

Set minimum bitrate expressed in bits/s. oggenc -m is +expressed in kilobits/s. +

+
+
maxrate (-M)
+

Set maximum bitrate expressed in bits/s. oggenc -M is +expressed in kilobits/s. This only has effect on ABR mode. +

+
+
iblock (--advanced-encode-option impulse_noisetune=N)
+

Set noise floor bias for impulse blocks. The value is a float number from +-15.0 to 0.0. A negative bias instructs the encoder to pay special attention +to the crispness of transients in the encoded audio. The tradeoff for better +transient response is a higher bitrate. +

+
+
+ + +

15.13 libwavpack

+ +

A wrapper providing WavPack encoding through libwavpack. +

+

Only lossless mode using 32-bit integer samples is supported currently. +

+

Requires the presence of the libwavpack headers and library during +configuration. You need to explicitly configure the build with +--enable-libwavpack. +

+

Note that a libavcodec-native encoder for the WavPack codec exists so users can +encode audios with this codec without using this encoder. See wavpackenc. +

+ +

15.13.1 Options

+ +

wavpack command line utility’s corresponding options are listed in +parentheses, if any. +

+
+
frame_size (--blocksize)
+

Default is 32768. +

+
+
compression_level
+

Set speed vs. compression tradeoff. Acceptable arguments are listed below: +

+
+
‘0 (-f)’
+

Fast mode. +

+
+
‘1’
+

Normal (default) settings. +

+
+
‘2 (-h)’
+

High quality. +

+
+
‘3 (-hh)’
+

Very high quality. +

+
+
‘4-8 (-hh -xEXTRAPROC)’
+

Same as ‘3’, but with extra processing enabled. +

+

‘4’ is the same as -x2 and ‘8’ is the same as -x6. +

+
+
+
+
+ + +

15.14 mjpeg

+ +

Motion JPEG encoder. +

+ +

15.14.1 Options

+ +
+
huffman
+

Set the huffman encoding strategy. Possible values: +

+
+
‘default’
+

Use the default huffman tables. This is the default strategy. +

+
+
‘optimal’
+

Compute and use optimal huffman tables. +

+
+
+
+
+ + +

15.15 wavpack

+ +

WavPack lossless audio encoder. +

+

This is a libavcodec-native WavPack encoder. There is also an encoder based on +libwavpack, but there is virtually no reason to use that encoder. +

+

See also libwavpack. +

+ +

15.15.1 Options

+ +

The equivalent options for wavpack command line utility are listed in +parentheses. +

+ +

15.15.1.1 Shared options

+ +

The following shared options are effective for this encoder. Only special notes +about this particular encoder will be documented here. For the general meaning +of the options, see the Codec Options chapter. +

+
+
frame_size (--blocksize)
+

For this encoder, the range for this option is between 128 and 131072. Default +is automatically decided based on sample rate and number of channel. +

+

For the complete formula of calculating default, see +libavcodec/wavpackenc.c. +

+
+
compression_level (-f, -h, -hh, and -x)
+

This option’s syntax is consistent with libwavpack’s. +

+
+ + +

15.15.1.2 Private options

+ +
+
joint_stereo (-j)
+

Set whether to enable joint stereo. Valid values are: +

+
+
‘on (1)’
+

Force mid/side audio encoding. +

+
‘off (0)’
+

Force left/right audio encoding. +

+
‘auto’
+

Let the encoder decide automatically. +

+
+ +
+
optimize_mono
+

Set whether to enable optimization for mono. This option is only effective for +non-mono streams. Available values: +

+
+
‘on’
+

enabled +

+
‘off’
+

disabled +

+
+ +
+
+ + + +

16 Video Encoders

+ +

A description of some of the currently available video encoders +follows. +

+ +

16.1 Hap

+ +

Vidvox Hap video encoder. +

+ +

16.1.1 Options

+ +
+
format integer
+

Specifies the Hap format to encode. +

+
+
hap
+
hap_alpha
+
hap_q
+
+ +

Default value is hap. +

+
+
chunks integer
+

Specifies the number of chunks to split frames into, between 1 and 64. This +permits multithreaded decoding of large frames, potentially at the cost of +data-rate. The encoder may modify this value to divide frames evenly. +

+

Default value is 1. +

+
+
compressor integer
+

Specifies the second-stage compressor to use. If set to none, +chunks will be limited to 1, as chunked uncompressed frames offer no +benefit. +

+
+
none
+
snappy
+
+ +

Default value is snappy. +

+
+
+ + +

16.2 jpeg2000

+ +

The native jpeg 2000 encoder is lossy by default, the -q:v +option can be used to set the encoding quality. Lossless encoding +can be selected with -pred 1. +

+ +

16.2.1 Options

+ +
+
format
+

Can be set to either j2k or jp2 (the default) that +makes it possible to store non-rgb pix_fmts. +

+
+
+ + +

16.3 librav1e

+ +

rav1e AV1 encoder wrapper. +

+

Requires the presence of the rav1e headers and library during configuration. +You need to explicitly configure the build with --enable-librav1e. +

+ +

16.3.1 Options

+ +
+
qmax
+

Sets the maximum quantizer to use when using bitrate mode. +

+
+
qmin
+

Sets the minimum quantizer to use when using bitrate mode. +

+
+
qp
+

Uses quantizer mode to encode at the given quantizer (0-255). +

+
+
speed
+

Selects the speed preset (0-10) to encode with. +

+
+
tiles
+

Selects how many tiles to encode with. +

+
+
tile-rows
+

Selects how many rows of tiles to encode with. +

+
+
tile-columns
+

Selects how many columns of tiles to encode with. +

+
+
rav1e-params
+

Set rav1e options using a list of key=value pairs separated +by ":". See rav1e --help for a list of options. +

+

For example to specify librav1e encoding options with -rav1e-params: +

+
+
ffmpeg -i input -c:v librav1e -b:v 500K -rav1e-params speed=5:low_latency=true output.mp4
+
+ +
+
+ + +

16.4 libaom-av1

+ +

libaom AV1 encoder wrapper. +

+

Requires the presence of the libaom headers and library during +configuration. You need to explicitly configure the build with +--enable-libaom. +

+ +

16.4.1 Options

+ +

The wrapper supports the following standard libavcodec options: +

+
+
b
+

Set bitrate target in bits/second. By default this will use +variable-bitrate mode. If maxrate and minrate are +also set to the same value then it will use constant-bitrate mode, +otherwise if crf is set as well then it will use +constrained-quality mode. +

+
+
g keyint_min
+

Set key frame placement. The GOP size sets the maximum distance between +key frames; if zero the output stream will be intra-only. The minimum +distance is ignored unless it is the same as the GOP size, in which case +key frames will always appear at a fixed interval. Not set by default, +so without this option the library has completely free choice about +where to place key frames. +

+
+
qmin qmax
+

Set minimum/maximum quantisation values. Valid range is from 0 to 63 +(warning: this does not match the quantiser values actually used by AV1 +- divide by four to map real quantiser values to this range). Defaults +to min/max (no constraint). +

+
+
minrate maxrate bufsize rc_init_occupancy
+

Set rate control buffering parameters. Not used if not set - defaults +to unconstrained variable bitrate. +

+
+
threads
+

Set the number of threads to use while encoding. This may require the +tiles or row-mt options to also be set to actually +use the specified number of threads fully. Defaults to the number of +hardware threads supported by the host machine. +

+
+
profile
+

Set the encoding profile. Defaults to using the profile which matches +the bit depth and chroma subsampling of the input. +

+
+
+ +

The wrapper also has some specific options: +

+
+
cpu-used
+

Set the quality/encoding speed tradeoff. Valid range is from 0 to 8, +higher numbers indicating greater speed and lower quality. The default +value is 1, which will be slow and high quality. +

+
+
auto-alt-ref
+

Enable use of alternate reference frames. Defaults to the internal +default of the library. +

+
+
arnr-max-frames (frames)
+

Set altref noise reduction max frame count. Default is -1. +

+
+
arnr-strength (strength)
+

Set altref noise reduction filter strength. Range is -1 to 6. Default is -1. +

+
+
aq-mode (aq-mode)
+

Set adaptive quantization mode. Possible values: +

+
+
‘none (0)’
+

Disabled. +

+
+
‘variance (1)’
+

Variance-based. +

+
+
‘complexity (2)’
+

Complexity-based. +

+
+
‘cyclic (3)’
+

Cyclic refresh. +

+
+ +
+
tune (tune)
+

Set the distortion metric the encoder is tuned with. Default is psnr. +

+
+
‘psnr (0)’
+
‘ssim (1)’
+
+ +
+
lag-in-frames
+

Set the maximum number of frames which the encoder may keep in flight +at any one time for lookahead purposes. Defaults to the internal +default of the library. +

+
+
error-resilience
+

Enable error resilience features: +

+
default
+

Improve resilience against losses of whole frames. +

+
+

Not enabled by default. +

+
+
crf
+

Set the quality/size tradeoff for constant-quality (no bitrate target) +and constrained-quality (with maximum bitrate target) modes. Valid +range is 0 to 63, higher numbers indicating lower quality and smaller +output size. Only used if set; by default only the bitrate target is +used. +

+
+
static-thresh
+

Set a change threshold on blocks below which they will be skipped by +the encoder. Defined in arbitrary units as a nonnegative integer, +defaulting to zero (no blocks are skipped). +

+
+
drop-threshold
+

Set a threshold for dropping frames when close to rate control bounds. +Defined as a percentage of the target buffer - when the rate control +buffer falls below this percentage, frames will be dropped until it +has refilled above the threshold. Defaults to zero (no frames are +dropped). +

+
+
denoise-noise-level (level)
+

Amount of noise to be removed for grain synthesis. Grain synthesis is disabled if +this option is not set or set to 0. +

+
+
denoise-block-size (pixels)
+

Block size used for denoising for grain synthesis. If not set, AV1 codec +uses the default value of 32. +

+
+
undershoot-pct (pct)
+

Set datarate undershoot (min) percentage of the target bitrate. Range is -1 to 100. +Default is -1. +

+
+
overshoot-pct (pct)
+

Set datarate overshoot (max) percentage of the target bitrate. Range is -1 to 1000. +Default is -1. +

+
+
minsection-pct (pct)
+

Minimum percentage variation of the GOP bitrate from the target bitrate. If minsection-pct +is not set, the libaomenc wrapper computes it as follows: (minrate * 100 / bitrate). +Range is -1 to 100. Default is -1 (unset). +

+
+
maxsection-pct (pct)
+

Maximum percentage variation of the GOP bitrate from the target bitrate. If maxsection-pct +is not set, the libaomenc wrapper computes it as follows: (maxrate * 100 / bitrate). +Range is -1 to 5000. Default is -1 (unset). +

+
+
frame-parallel (boolean)
+

Enable frame parallel decodability features. Default is true. +

+
+
tiles
+

Set the number of tiles to encode the input video with, as columns x +rows. Larger numbers allow greater parallelism in both encoding and +decoding, but may decrease coding efficiency. Defaults to the minimum +number of tiles required by the size of the input video (this is 1x1 +(that is, a single tile) for sizes up to and including 4K). +

+
+
tile-columns tile-rows
+

Set the number of tiles as log2 of the number of tile rows and columns. +Provided for compatibility with libvpx/VP9. +

+
+
row-mt (Requires libaom >= 1.0.0-759-g90a15f4f2)
+

Enable row based multi-threading. Disabled by default. +

+
+
enable-cdef (boolean)
+

Enable Constrained Directional Enhancement Filter. The libaom-av1 +encoder enables CDEF by default. +

+
+
enable-restoration (boolean)
+

Enable Loop Restoration Filter. Default is true for libaom-av1. +

+
+
enable-global-motion (boolean)
+

Enable the use of global motion for block prediction. Default is true. +

+
+
enable-intrabc (boolean)
+

Enable block copy mode for intra block prediction. This mode is +useful for screen content. Default is true. +

+
+
+ + +

16.5 libkvazaar

+ +

Kvazaar H.265/HEVC encoder. +

+

Requires the presence of the libkvazaar headers and library during +configuration. You need to explicitly configure the build with +--enable-libkvazaar. +

+ +

16.5.1 Options

+ +
+
b
+

Set target video bitrate in bit/s and enable rate control. +

+
+
kvazaar-params
+

Set kvazaar parameters as a list of name=value pairs separated +by commas (,). See kvazaar documentation for a list of options. +

+
+
+ + +

16.6 libopenh264

+ +

Cisco libopenh264 H.264/MPEG-4 AVC encoder wrapper. +

+

This encoder requires the presence of the libopenh264 headers and +library during configuration. You need to explicitly configure the +build with --enable-libopenh264. The library is detected using +pkg-config. +

+

For more information about the library see +http://www.openh264.org. +

+ +

16.6.1 Options

+ +

The following FFmpeg global options affect the configurations of the +libopenh264 encoder. +

+
+
b
+

Set the bitrate (as a number of bits per second). +

+
+
g
+

Set the GOP size. +

+
+
maxrate
+

Set the max bitrate (as a number of bits per second). +

+
+
flags +global_header
+

Set global header in the bitstream. +

+
+
slices
+

Set the number of slices, used in parallelized encoding. Default value +is 0. This is only used when slice_mode is set to +‘fixed’. +

+
+
slice_mode
+

Set slice mode. Can assume one of the following possible values: +

+
+
‘fixed’
+

a fixed number of slices +

+
‘rowmb’
+

one slice per row of macroblocks +

+
‘auto’
+

automatic number of slices according to number of threads +

+
‘dyn’
+

dynamic slicing +

+
+ +

Default value is ‘auto’. +

+
+
loopfilter
+

Enable loop filter, if set to 1 (automatically enabled). To disable +set a value of 0. +

+
+
profile
+

Set profile restrictions. If set to the value of ‘main’ enable +CABAC (set the SEncParamExt.iEntropyCodingModeFlag flag to 1). +

+
+
max_nal_size
+

Set maximum NAL size in bytes. +

+
+
allow_skip_frames
+

Allow skipping frames to hit the target bitrate if set to 1. +

+
+ + +

16.7 libtheora

+ +

libtheora Theora encoder wrapper. +

+

Requires the presence of the libtheora headers and library during +configuration. You need to explicitly configure the build with +--enable-libtheora. +

+

For more information about the libtheora project see +http://www.theora.org/. +

+ +

16.7.1 Options

+ +

The following global options are mapped to internal libtheora options +which affect the quality and the bitrate of the encoded stream. +

+
+
b
+

Set the video bitrate in bit/s for CBR (Constant Bit Rate) mode. In +case VBR (Variable Bit Rate) mode is enabled this option is ignored. +

+
+
flags
+

Used to enable constant quality mode (VBR) encoding through the +qscale flag, and to enable the pass1 and pass2 +modes. +

+
+
g
+

Set the GOP size. +

+
+
global_quality
+

Set the global quality as an integer in lambda units. +

+

Only relevant when VBR mode is enabled with flags +qscale. The +value is converted to QP units by dividing it by FF_QP2LAMBDA, +clipped in the [0 - 10] range, and then multiplied by 6.3 to get a +value in the native libtheora range [0-63]. A higher value corresponds +to a higher quality. +

+
+
q
+

Enable VBR mode when set to a non-negative value, and set constant +quality value as a double floating point value in QP units. +

+

The value is clipped in the [0-10] range, and then multiplied by 6.3 +to get a value in the native libtheora range [0-63]. +

+

This option is valid only using the ffmpeg command-line +tool. For library interface users, use global_quality. +

+
+ + +

16.7.2 Examples

+ +
    +
  • Set maximum constant quality (VBR) encoding with ffmpeg: +
    +
    ffmpeg -i INPUT -codec:v libtheora -q:v 10 OUTPUT.ogg
+
    + +
  • Use ffmpeg to convert a CBR 1000 kbps Theora video stream: +
    +
    ffmpeg -i INPUT -codec:v libtheora -b:v 1000k OUTPUT.ogg
+
    +
+ + +

16.8 libvpx

+ +

VP8/VP9 format supported through libvpx. +

+

Requires the presence of the libvpx headers and library during configuration. +You need to explicitly configure the build with --enable-libvpx. +

+ +

16.8.1 Options

+ +

The following options are supported by the libvpx wrapper. The +vpxenc-equivalent options or values are listed in parentheses +for easy migration. +

+

To reduce the duplication of documentation, only the private options +and some others requiring special attention are documented here. For +the documentation of the undocumented generic options, see +the Codec Options chapter. +

+

To get more documentation of the libvpx options, invoke the command +ffmpeg -h encoder=libvpx, ffmpeg -h encoder=libvpx-vp9 or +vpxenc --help. Further information is available in the libvpx API +documentation. +

+
+
b (target-bitrate)
+

Set bitrate in bits/s. Note that FFmpeg’s b option is +expressed in bits/s, while vpxenc’s target-bitrate is in +kilobits/s. +

+
+
g (kf-max-dist)
+
keyint_min (kf-min-dist)
+
qmin (min-q)
+
qmax (max-q)
+
bufsize (buf-sz, buf-optimal-sz)
+

Set ratecontrol buffer size (in bits). Note vpxenc’s options are +specified in milliseconds, the libvpx wrapper converts this value as follows: +buf-sz = bufsize * 1000 / bitrate, +buf-optimal-sz = bufsize * 1000 / bitrate * 5 / 6. +

+
+
rc_init_occupancy (buf-initial-sz)
+

Set number of bits which should be loaded into the rc buffer before decoding +starts. Note vpxenc’s option is specified in milliseconds, the libvpx +wrapper converts this value as follows: +rc_init_occupancy * 1000 / bitrate. +

+
+
undershoot-pct
+

Set datarate undershoot (min) percentage of the target bitrate. +

+
+
overshoot-pct
+

Set datarate overshoot (max) percentage of the target bitrate. +

+
+
skip_threshold (drop-frame)
+
qcomp (bias-pct)
+
maxrate (maxsection-pct)
+

Set GOP max bitrate in bits/s. Note vpxenc’s option is specified as a +percentage of the target bitrate, the libvpx wrapper converts this value as +follows: (maxrate * 100 / bitrate). +

+
+
minrate (minsection-pct)
+

Set GOP min bitrate in bits/s. Note vpxenc’s option is specified as a +percentage of the target bitrate, the libvpx wrapper converts this value as +follows: (minrate * 100 / bitrate). +

+
+
minrate, maxrate, b end-usage=cbr
+

(minrate == maxrate == bitrate). +

+
+
crf (end-usage=cq, cq-level)
+
tune (tune)
+
+
‘psnr (psnr)’
+
‘ssim (ssim)’
+
+ +
+
quality, deadline (deadline)
+
+
‘best’
+

Use best quality deadline. Poorly named and quite slow, this option should be +avoided as it may give worse quality output than good. +

+
‘good’
+

Use good quality deadline. This is a good trade-off between speed and quality +when used with the cpu-used option. +

+
‘realtime’
+

Use realtime quality deadline. +

+
+ +
+
speed, cpu-used (cpu-used)
+

Set quality/speed ratio modifier. Higher values speed up the encode at the cost +of quality. +

+
+
nr (noise-sensitivity)
+
static-thresh
+

Set a change threshold on blocks below which they will be skipped by the +encoder. +

+
+
slices (token-parts)
+

Note that FFmpeg’s slices option gives the total number of partitions, +while vpxenc’s token-parts is given as +log2(partitions). +

+
+
max-intra-rate
+

Set maximum I-frame bitrate as a percentage of the target bitrate. A value of 0 +means unlimited. +

+
+
force_key_frames
+

VPX_EFLAG_FORCE_KF +

+
+
Alternate reference frame related
+
+
auto-alt-ref
+

Enable use of alternate reference frames (2-pass only). +Values greater than 1 enable multi-layer alternate reference frames (VP9 only). +

+
arnr-maxframes
+

Set altref noise reduction max frame count. +

+
arnr-type
+

Set altref noise reduction filter type: backward, forward, centered. +

+
arnr-strength
+

Set altref noise reduction filter strength. +

+
rc-lookahead, lag-in-frames (lag-in-frames)
+

Set number of frames to look ahead for frametype and ratecontrol. +

+
+ +
+
error-resilient
+

Enable error resiliency features. +

+
+
sharpness integer
+

Increase sharpness at the expense of lower PSNR. +The valid range is [0, 7]. +

+
+
ts-parameters
+

Sets the temporal scalability configuration using a :-separated list of +key=value pairs. For example, to specify temporal scalability parameters +with ffmpeg: +

+
ffmpeg -i INPUT -c:v libvpx -ts-parameters ts_number_layers=3:\
+ts_target_bitrate=250,500,1000:ts_rate_decimator=4,2,1:\
+ts_periodicity=4:ts_layer_id=0,2,1,2:ts_layering_mode=3 OUTPUT
+
+

Below is a brief explanation of each of the parameters, please +refer to struct vpx_codec_enc_cfg in vpx/vpx_encoder.h for more +details. +

+
ts_number_layers
+

Number of temporal coding layers. +

+
ts_target_bitrate
+

Target bitrate for each temporal layer (in kbps). +(bitrate should be inclusive of the lower temporal layer). +

+
ts_rate_decimator
+

Frame rate decimation factor for each temporal layer. +

+
ts_periodicity
+

Length of the sequence defining frame temporal layer membership. +

+
ts_layer_id
+

Template defining the membership of frames to temporal layers. +

+
ts_layering_mode
+

(optional) Selecting the temporal structure from a set of pre-defined temporal layering modes. +Currently supports the following options. +

+
0
+

No temporal layering flags are provided internally, +relies on flags being passed in using metadata field in AVFrame +with following keys. +

+
vp8-flags
+

Sets the flags passed into the encoder to indicate the referencing scheme for +the current frame. +Refer to function vpx_codec_encode in vpx/vpx_encoder.h for more +details. +

+
temporal_id
+

Explicitly sets the temporal id of the current frame to encode. +

+
+
+
2
+

Two temporal layers. 0-1... +

+
3
+

Three temporal layers. 0-2-1-2...; with single reference frame. +

+
4
+

Same as option "3", except there is a dependency between +the two temporal layer 2 frames within the temporal period. +

+
+
+
+ +
+
VP9-specific options
+
+
lossless
+

Enable lossless mode. +

+
tile-columns
+

Set number of tile columns to use. Note this is given as +log2(tile_columns). For example, 8 tile columns would be requested by +setting the tile-columns option to 3. +

+
tile-rows
+

Set number of tile rows to use. Note this is given as log2(tile_rows). +For example, 4 tile rows would be requested by setting the tile-rows +option to 2. +

+
frame-parallel
+

Enable frame parallel decodability features. +

+
aq-mode
+

Set adaptive quantization mode (0: off (default), 1: variance 2: complexity, 3: +cyclic refresh, 4: equator360). +

+
colorspace color-space
+

Set input color space. The VP9 bitstream supports signaling the following +colorspaces: +

+
‘rgb’ sRGB
+
‘bt709’ bt709
+
‘unspecified’ unknown
+
‘bt470bg’ bt601
+
‘smpte170m’ smpte170
+
‘smpte240m’ smpte240
+
‘bt2020_ncl’ bt2020
+
+
+
row-mt boolean
+

Enable row based multi-threading. +

+
tune-content
+

Set content type: default (0), screen (1), film (2). +

+
corpus-complexity
+

Corpus VBR mode is a variant of standard VBR where the complexity distribution +midpoint is passed in rather than calculated for a specific clip or chunk. +

+

The valid range is [0, 10000]. 0 (default) uses standard VBR. +

+
enable-tpl boolean
+

Enable temporal dependency model. +

+
+ +
+
+ +

For more information about libvpx see: +http://www.webmproject.org/ +

+ +

16.9 libwebp

+ +

libwebp WebP Image encoder wrapper +

+

libwebp is Google’s official encoder for WebP images. It can encode in either +lossy or lossless mode. Lossy images are essentially a wrapper around a VP8 +frame. Lossless images are a separate codec developed by Google. +

+ +

16.9.1 Pixel Format

+ +

Currently, libwebp only supports YUV420 for lossy and RGB for lossless due +to limitations of the format and libwebp. Alpha is supported for either mode. +Because of API limitations, if RGB is passed in when encoding lossy or YUV is +passed in for encoding lossless, the pixel format will automatically be +converted using functions from libwebp. This is not ideal and is done only for +convenience. +

+ +

16.9.2 Options

+ +
+
-lossless boolean
+

Enables/Disables use of lossless mode. Default is 0. +

+
+
-compression_level integer
+

For lossy, this is a quality/speed tradeoff. Higher values give better quality +for a given size at the cost of increased encoding time. For lossless, this is +a size/speed tradeoff. Higher values give smaller size at the cost of increased +encoding time. More specifically, it controls the number of extra algorithms +and compression tools used, and varies the combination of these tools. This +maps to the method option in libwebp. The valid range is 0 to 6. +Default is 4. +

+
+
-qscale float
+

For lossy encoding, this controls image quality, 0 to 100. For lossless +encoding, this controls the effort and time spent at compressing more. The +default value is 75. Note that for usage via libavcodec, this option is called +global_quality and must be multiplied by FF_QP2LAMBDA. +

+
+
-preset type
+

Configuration preset. This does some automatic settings based on the general +type of the image. +

+
none
+

Do not use a preset. +

+
default
+

Use the encoder default. +

+
picture
+

Digital picture, like portrait, inner shot +

+
photo
+

Outdoor photograph, with natural lighting +

+
drawing
+

Hand or line drawing, with high-contrast details +

+
icon
+

Small-sized colorful images +

+
text
+

Text-like +

+
+ +
+
+ + +

16.10 libx264, libx264rgb

+ +

x264 H.264/MPEG-4 AVC encoder wrapper. +

+

This encoder requires the presence of the libx264 headers and library +during configuration. You need to explicitly configure the build with +--enable-libx264. +

+

libx264 supports an impressive number of features, including 8x8 and +4x4 adaptive spatial transform, adaptive B-frame placement, CAVLC/CABAC +entropy coding, interlacing (MBAFF), lossless mode, psy optimizations +for detail retention (adaptive quantization, psy-RD, psy-trellis). +

+

Many libx264 encoder options are mapped to FFmpeg global codec +options, while unique encoder options are provided through private +options. Additionally the x264opts and x264-params +private options allows one to pass a list of key=value tuples as accepted +by the libx264 x264_param_parse function. +

+

The x264 project website is at +http://www.videolan.org/developers/x264.html. +

+

The libx264rgb encoder is the same as libx264, except it accepts packed RGB +pixel formats as input instead of YUV. +

+ +

16.10.1 Supported Pixel Formats

+ +

x264 supports 8- to 10-bit color spaces. The exact bit depth is controlled at +x264’s configure time. FFmpeg only supports one bit depth in one particular +build. In other words, it is not possible to build one FFmpeg with multiple +versions of x264 with different bit depths. +

+ +

16.10.2 Options

+ +

The following options are supported by the libx264 wrapper. The +x264-equivalent options or values are listed in parentheses +for easy migration. +

+

To reduce the duplication of documentation, only the private options +and some others requiring special attention are documented here. For +the documentation of the undocumented generic options, see +the Codec Options chapter. +

+

To get a more accurate and extensive documentation of the libx264 +options, invoke the command x264 --fullhelp or consult +the libx264 documentation. +

+
+
b (bitrate)
+

Set bitrate in bits/s. Note that FFmpeg’s b option is +expressed in bits/s, while x264’s bitrate is in +kilobits/s. +

+
+
bf (bframes)
+
g (keyint)
+
qmin (qpmin)
+

Minimum quantizer scale. +

+
+
qmax (qpmax)
+

Maximum quantizer scale. +

+
+
qdiff (qpstep)
+

Maximum difference between quantizer scales. +

+
+
qblur (qblur)
+

Quantizer curve blur +

+
+
qcomp (qcomp)
+

Quantizer curve compression factor +

+
+
refs (ref)
+

Number of reference frames each P-frame can use. The range is from 0-16. +

+
+
sc_threshold (scenecut)
+

Sets the threshold for the scene change detection. +

+
+
trellis (trellis)
+

Performs Trellis quantization to increase efficiency. Enabled by default. +

+
+
nr (nr)
+
me_range (merange)
+

Maximum range of the motion search in pixels. +

+
+
me_method (me)
+

Set motion estimation method. Possible values in the decreasing order +of speed: +

+
+
‘dia (dia)’
+
‘epzs (dia)’
+

Diamond search with radius 1 (fastest). ‘epzs’ is an alias for +‘dia’. +

+
‘hex (hex)’
+

Hexagonal search with radius 2. +

+
‘umh (umh)’
+

Uneven multi-hexagon search. +

+
‘esa (esa)’
+

Exhaustive search. +

+
‘tesa (tesa)’
+

Hadamard exhaustive search (slowest). +

+
+ +
+
forced-idr
+

Normally, when forcing a I-frame type, the encoder can select any type +of I-frame. This option forces it to choose an IDR-frame. +

+
+
subq (subme)
+

Sub-pixel motion estimation method. +

+
+
b_strategy (b-adapt)
+

Adaptive B-frame placement decision algorithm. Use only on first-pass. +

+
+
keyint_min (min-keyint)
+

Minimum GOP size. +

+
+
coder
+

Set entropy encoder. Possible values: +

+
+
‘ac’
+

Enable CABAC. +

+
+
‘vlc’
+

Enable CAVLC and disable CABAC. It generates the same effect as +x264’s --no-cabac option. +

+
+ +
+
cmp
+

Set full pixel motion estimation comparison algorithm. Possible values: +

+
+
‘chroma’
+

Enable chroma in motion estimation. +

+
+
‘sad’
+

Ignore chroma in motion estimation. It generates the same effect as +x264’s --no-chroma-me option. +

+
+ +
+
threads (threads)
+

Number of encoding threads. +

+
+
thread_type
+

Set multithreading technique. Possible values: +

+
+
‘slice’
+

Slice-based multithreading. It generates the same effect as +x264’s --sliced-threads option. +

+
‘frame’
+

Frame-based multithreading. +

+
+ +
+
flags
+

Set encoding flags. It can be used to disable closed GOP and enable +open GOP by setting it to -cgop. The result is similar to +the behavior of x264’s --open-gop option. +

+
+
rc_init_occupancy (vbv-init)
+
preset (preset)
+

Set the encoding preset. +

+
+
tune (tune)
+

Set tuning of the encoding params. +

+
+
profile (profile)
+

Set profile restrictions. +

+
+
fastfirstpass
+

Enable fast settings when encoding first pass, when set to 1. When set +to 0, it has the same effect of x264’s +--slow-firstpass option. +

+
+
crf (crf)
+

Set the quality for constant quality mode. +

+
+
crf_max (crf-max)
+

In CRF mode, prevents VBV from lowering quality beyond this point. +

+
+
qp (qp)
+

Set constant quantization rate control method parameter. +

+
+
aq-mode (aq-mode)
+

Set AQ method. Possible values: +

+
+
‘none (0)’
+

Disabled. +

+
+
‘variance (1)’
+

Variance AQ (complexity mask). +

+
+
‘autovariance (2)’
+

Auto-variance AQ (experimental). +

+
+ +
+
aq-strength (aq-strength)
+

Set AQ strength, reduce blocking and blurring in flat and textured areas. +

+
+
psy
+

Use psychovisual optimizations when set to 1. When set to 0, it has the +same effect as x264’s --no-psy option. +

+
+
psy-rd (psy-rd)
+

Set strength of psychovisual optimization, in +psy-rd:psy-trellis format. +

+
+
rc-lookahead (rc-lookahead)
+

Set number of frames to look ahead for frametype and ratecontrol. +

+
+
weightb
+

Enable weighted prediction for B-frames when set to 1. When set to 0, +it has the same effect as x264’s --no-weightb option. +

+
+
weightp (weightp)
+

Set weighted prediction method for P-frames. Possible values: +

+
+
‘none (0)’
+

Disabled +

+
‘simple (1)’
+

Enable only weighted refs +

+
‘smart (2)’
+

Enable both weighted refs and duplicates +

+
+ +
+
ssim (ssim)
+

Enable calculation and printing SSIM stats after the encoding. +

+
+
intra-refresh (intra-refresh)
+

Enable the use of Periodic Intra Refresh instead of IDR frames when set +to 1. +

+
+
avcintra-class (class)
+

Configure the encoder to generate AVC-Intra. +Valid values are 50,100 and 200 +

+
+
bluray-compat (bluray-compat)
+

Configure the encoder to be compatible with the bluray standard. +It is a shorthand for setting "bluray-compat=1 force-cfr=1". +

+
+
b-bias (b-bias)
+

Set the influence on how often B-frames are used. +

+
+
b-pyramid (b-pyramid)
+

Set method for keeping of some B-frames as references. Possible values: +

+
+
‘none (none)’
+

Disabled. +

+
‘strict (strict)’
+

Strictly hierarchical pyramid. +

+
‘normal (normal)’
+

Non-strict (not Blu-ray compatible). +

+
+ +
+
mixed-refs
+

Enable the use of one reference per partition, as opposed to one +reference per macroblock when set to 1. When set to 0, it has the +same effect as x264’s --no-mixed-refs option. +

+
+
8x8dct
+

Enable adaptive spatial transform (high profile 8x8 transform) +when set to 1. When set to 0, it has the same effect as +x264’s --no-8x8dct option. +

+
+
fast-pskip
+

Enable early SKIP detection on P-frames when set to 1. When set +to 0, it has the same effect as x264’s +--no-fast-pskip option. +

+
+
aud (aud)
+

Enable use of access unit delimiters when set to 1. +

+
+
mbtree
+

Enable use macroblock tree ratecontrol when set to 1. When set +to 0, it has the same effect as x264’s +--no-mbtree option. +

+
+
deblock (deblock)
+

Set loop filter parameters, in alpha:beta form. +

+
+
cplxblur (cplxblur)
+

Set fluctuations reduction in QP (before curve compression). +

+
+
partitions (partitions)
+

Set partitions to consider as a comma-separated list of. Possible +values in the list: +

+
+
‘p8x8’
+

8x8 P-frame partition. +

+
‘p4x4’
+

4x4 P-frame partition. +

+
‘b8x8’
+

4x4 B-frame partition. +

+
‘i8x8’
+

8x8 I-frame partition. +

+
‘i4x4’
+

4x4 I-frame partition. +(Enabling ‘p4x4’ requires ‘p8x8’ to be enabled. Enabling +‘i8x8’ requires adaptive spatial transform (8x8dct +option) to be enabled.) +

+
‘none (none)’
+

Do not consider any partitions. +

+
‘all (all)’
+

Consider every partition. +

+
+ +
+
direct-pred (direct)
+

Set direct MV prediction mode. Possible values: +

+
+
‘none (none)’
+

Disable MV prediction. +

+
‘spatial (spatial)’
+

Enable spatial predicting. +

+
‘temporal (temporal)’
+

Enable temporal predicting. +

+
‘auto (auto)’
+

Automatically decided. +

+
+ +
+
slice-max-size (slice-max-size)
+

Set the limit of the size of each slice in bytes. If not specified +but RTP payload size (ps) is specified, that is used. +

+
+
stats (stats)
+

Set the file name for multi-pass stats. +

+
+
nal-hrd (nal-hrd)
+

Set signal HRD information (requires vbv-bufsize to be set). +Possible values: +

+
+
‘none (none)’
+

Disable HRD information signaling. +

+
‘vbr (vbr)’
+

Variable bit rate. +

+
‘cbr (cbr)’
+

Constant bit rate (not allowed in MP4 container). +

+
+ +
+
x264opts (N.A.)
+

Set any x264 option, see x264 --fullhelp for a list. +

+

Argument is a list of key=value couples separated by +":". In filter and psy-rd options that use ":" as a separator +themselves, use "," instead. They accept it as well since long ago but this +is kept undocumented for some reason. +

+

For example to specify libx264 encoding options with ffmpeg: +

+
ffmpeg -i foo.mpg -c:v libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
+
+ +
+
a53cc boolean
+

Import closed captions (which must be ATSC compatible format) into output. +Only the mpeg2 and h264 decoders provide these. Default is 1 (on). +

+
+
x264-params (N.A.)
+

Override the x264 configuration using a :-separated list of key=value +parameters. +

+

This option is functionally the same as the x264opts, but is +duplicated for compatibility with the Libav fork. +

+

For example to specify libx264 encoding options with ffmpeg: +

+
ffmpeg -i INPUT -c:v libx264 -x264-params level=30:bframes=0:weightp=0:\
+cabac=0:ref=1:vbv-maxrate=768:vbv-bufsize=2000:analyse=all:me=umh:\
+no-fast-pskip=1:subq=6:8x8dct=0:trellis=0 OUTPUT
+
+
+
+ +

Encoding ffpresets for common usages are provided so they can be used with the +general presets system (e.g. passing the pre option). +

+ +

16.11 libx265

+ +

x265 H.265/HEVC encoder wrapper. +

+

This encoder requires the presence of the libx265 headers and library +during configuration. You need to explicitly configure the build with +--enable-libx265. +

+ +

16.11.1 Options

+ +
+
b
+

Sets target video bitrate. +

+
+
bf
+
g
+

Set the GOP size. +

+
+
keyint_min
+

Minimum GOP size. +

+
+
refs
+

Number of reference frames each P-frame can use. The range is from 1-16. +

+
+
preset
+

Set the x265 preset. +

+
+
tune
+

Set the x265 tune parameter. +

+
+
profile
+

Set profile restrictions. +

+
+
crf
+

Set the quality for constant quality mode. +

+
+
qp
+

Set constant quantization rate control method parameter. +

+
+
qmin
+

Minimum quantizer scale. +

+
+
qmax
+

Maximum quantizer scale. +

+
+
qdiff
+

Maximum difference between quantizer scales. +

+
+
qblur
+

Quantizer curve blur +

+
+
qcomp
+

Quantizer curve compression factor +

+
+
i_qfactor
+
b_qfactor
+
forced-idr
+

Normally, when forcing a I-frame type, the encoder can select any type +of I-frame. This option forces it to choose an IDR-frame. +

+
+
x265-params
+

Set x265 options using a list of key=value couples separated +by ":". See x265 --help for a list of options. +

+

For example to specify libx265 encoding options with -x265-params: +

+
+
ffmpeg -i input -c:v libx265 -x265-params crf=26:psy-rd=1 output.mp4
+
+
+
+ + +

16.12 libxavs2

+ +

xavs2 AVS2-P2/IEEE1857.4 encoder wrapper. +

+

This encoder requires the presence of the libxavs2 headers and library +during configuration. You need to explicitly configure the build with +--enable-libxavs2. +

+

The following standard libavcodec options are used: +

    +
  • b / bit_rate +
  • g / gop_size +
  • bf / max_b_frames +
+ +

The encoder also has its own specific options: +

+

16.12.1 Options

+ +
+
lcu_row_threads
+

Set the number of parallel threads for rows from 1 to 8 (default 5). +

+
+
initial_qp
+

Set the xavs2 quantization parameter from 1 to 63 (default 34). This is +used to set the initial qp for the first frame. +

+
+
qp
+

Set the xavs2 quantization parameter from 1 to 63 (default 34). This is +used to set the qp value under constant-QP mode. +

+
+
max_qp
+

Set the max qp for rate control from 1 to 63 (default 55). +

+
+
min_qp
+

Set the min qp for rate control from 1 to 63 (default 20). +

+
+
speed_level
+

Set the Speed level from 0 to 9 (default 0). Higher is better but slower. +

+
+
log_level
+

Set the log level from -1 to 3 (default 0). -1: none, 0: error, +1: warning, 2: info, 3: debug. +

+
+
xavs2-params
+

Set xavs2 options using a list of key=value couples separated +by ":". +

+

For example to specify libxavs2 encoding options with -xavs2-params: +

+
+
ffmpeg -i input -c:v libxavs2 -xavs2-params RdoqLevel=0 output.avs2
+
+
+
+ + +

16.13 libxvid

+ +

Xvid MPEG-4 Part 2 encoder wrapper. +

+

This encoder requires the presence of the libxvidcore headers and library +during configuration. You need to explicitly configure the build with +--enable-libxvid --enable-gpl. +

+

The native mpeg4 encoder supports the MPEG-4 Part 2 format, so +users can encode to this format without this library. +

+ +

16.13.1 Options

+ +

The following options are supported by the libxvid wrapper. Some of +the following options are listed but are not documented, and +correspond to shared codec options. See the Codec +Options chapter for their documentation. The other shared options +which are not listed have no effect for the libxvid encoder. +

+
+
b
+
g
+
qmin
+
qmax
+
mpeg_quant
+
threads
+
bf
+
b_qfactor
+
b_qoffset
+
flags
+

Set specific encoding flags. Possible values: +

+
+
‘mv4’
+

Use four motion vector by macroblock. +

+
+
‘aic’
+

Enable high quality AC prediction. +

+
+
‘gray’
+

Only encode grayscale. +

+
+
‘gmc’
+

Enable the use of global motion compensation (GMC). +

+
+
‘qpel’
+

Enable quarter-pixel motion compensation. +

+
+
‘cgop’
+

Enable closed GOP. +

+
+
‘global_header’
+

Place global headers in extradata instead of every keyframe. +

+
+
+ +
+
trellis
+
me_method
+

Set motion estimation method. Possible values in decreasing order of +speed and increasing order of quality: +

+
+
‘zero’
+

Use no motion estimation (default). +

+
+
‘phods’
+
‘x1’
+
‘log’
+

Enable advanced diamond zonal search for 16x16 blocks and half-pixel +refinement for 16x16 blocks. ‘x1’ and ‘log’ are aliases for +‘phods’. +

+
+
‘epzs’
+

Enable all of the things described above, plus advanced diamond zonal +search for 8x8 blocks, half-pixel refinement for 8x8 blocks, and motion +estimation on chroma planes. +

+
+
‘full’
+

Enable all of the things described above, plus extended 16x16 and 8x8 +blocks search. +

+
+ +
+
mbd
+

Set macroblock decision algorithm. Possible values in the increasing +order of quality: +

+
+
‘simple’
+

Use macroblock comparing function algorithm (default). +

+
+
‘bits’
+

Enable rate distortion-based half pixel and quarter pixel refinement for +16x16 blocks. +

+
+
‘rd’
+

Enable all of the things described above, plus rate distortion-based +half pixel and quarter pixel refinement for 8x8 blocks, and rate +distortion-based search using square pattern. +

+
+ +
+
lumi_aq
+

Enable lumi masking adaptive quantization when set to 1. Default is 0 +(disabled). +

+
+
variance_aq
+

Enable variance adaptive quantization when set to 1. Default is 0 +(disabled). +

+

When combined with lumi_aq, the resulting quality will not +be better than any of the two specified individually. In other +words, the resulting quality will be the worse one of the two +effects. +

+
+
ssim
+

Set structural similarity (SSIM) displaying method. Possible values: +

+
+
‘off’
+

Disable displaying of SSIM information. +

+
+
‘avg’
+

Output average SSIM at the end of encoding to stdout. The format of +showing the average SSIM is: +

+
+
Average SSIM: %f
+
+ +

For users who are not familiar with C, %f means a float number, or +a decimal (e.g. 0.939232). +

+
+
‘frame’
+

Output both per-frame SSIM data during encoding and average SSIM at +the end of encoding to stdout. The format of per-frame information +is: +

+
+
       SSIM: avg: %1.3f min: %1.3f max: %1.3f
+
+ +

For users who are not familiar with C, %1.3f means a float number +rounded to 3 digits after the dot (e.g. 0.932). +

+
+
+ +
+
ssim_acc
+

Set SSIM accuracy. Valid options are integers within the range of +0-4, while 0 gives the most accurate result and 4 computes the +fastest. +

+
+
+ + +

16.14 MediaFoundation

+ +

This provides wrappers to encoders (both audio and video) in the +MediaFoundation framework. It can access both SW and HW encoders. +Video encoders can take input in either of nv12 or yuv420p form +(some encoders support both, some support only either - in practice, +nv12 is the safer choice, especially among HW encoders). +

+ +

16.15 mpeg2

+ +

MPEG-2 video encoder. +

+ +

16.15.1 Options

+ +
+
profile integer
+

Select the mpeg2 profile to encode: +

+
+
‘422’
+
‘main’
+
‘ss’
+

Spatially Scalable +

+
‘snr’
+

SNR Scalable +

+
‘high’
+
‘simple’
+
+ +
+
seq_disp_ext integer
+

Specifies if the encoder should write a sequence_display_extension to the +output. +

+
-1
+
auto
+

Decide automatically to write it or not (this is the default) by checking if +the data to be written is different from the default or unspecified values. +

+
0
+
never
+

Never write it. +

+
1
+
always
+

Always write it. +

+
+
+
video_format integer
+

Specifies the video_format written into the sequence display extension +indicating the source of the video pictures. The default is ‘unspecified’, +can be ‘component’, ‘pal’, ‘ntsc’, ‘secam’ or ‘mac’. +For maximum compatibility, use ‘component’. +

+
a53cc boolean
+

Import closed captions (which must be ATSC compatible format) into output. +Default is 1 (on). +

+
+ + +

16.16 png

+ +

PNG image encoder. +

+ +

16.16.1 Private options

+ +
+
dpi integer
+

Set physical density of pixels, in dots per inch, unset by default +

+
dpm integer
+

Set physical density of pixels, in dots per meter, unset by default +

+
+ + +

16.17 ProRes

+ +

Apple ProRes encoder. +

+

FFmpeg contains 2 ProRes encoders, the prores-aw and prores-ks encoder. +The used encoder can be chosen with the -vcodec option. +

+ +

16.17.1 Private Options for prores-ks

+ +
+
profile integer
+

Select the ProRes profile to encode +

+
‘proxy’
+
‘lt’
+
‘standard’
+
‘hq’
+
‘4444’
+
‘4444xq’
+
+ +
+
quant_mat integer
+

Select quantization matrix. +

+
‘auto’
+
‘default’
+
‘proxy’
+
‘lt’
+
‘standard’
+
‘hq’
+
+

If set to auto, the matrix matching the profile will be picked. +If not set, the matrix providing the highest quality, default, will be +picked. +

+
+
bits_per_mb integer
+

How many bits to allot for coding one macroblock. Different profiles use +between 200 and 2400 bits per macroblock, the maximum is 8000. +

+
+
mbs_per_slice integer
+

Number of macroblocks in each slice (1-8); the default value (8) +should be good in almost all situations. +

+
+
vendor string
+

Override the 4-byte vendor ID. +A custom vendor ID like apl0 would claim the stream was produced by +the Apple encoder. +

+
+
alpha_bits integer
+

Specify number of bits for alpha component. +Possible values are 0, 8 and 16. +Use 0 to disable alpha plane coding. +

+
+
+ + +

16.17.2 Speed considerations

+ +

In the default mode of operation the encoder has to honor frame constraints +(i.e. not produce frames with size bigger than requested) while still making +output picture as good as possible. +A frame containing a lot of small details is harder to compress and the encoder +would spend more time searching for appropriate quantizers for each slice. +

+

Setting a higher bits_per_mb limit will improve the speed. +

+

For the fastest encoding speed set the qscale parameter (4 is the +recommended value) and do not set a size constraint. +

+ +

16.18 QSV encoders

+ +

The family of Intel QuickSync Video encoders (MPEG-2, H.264, HEVC, JPEG/MJPEG and VP9) +

+

The ratecontrol method is selected as follows: +

+
    +
  • When global_quality is specified, a quality-based mode is used. +Specifically this means either +
      +
    • - CQP - constant quantizer scale, when the qscale codec flag is +also set (the -qscale ffmpeg option). + +
    • - LA_ICQ - intelligent constant quality with lookahead, when the +look_ahead option is also set. + +
    • - ICQ – intelligent constant quality otherwise. +
    + +
  • Otherwise, a bitrate-based mode is used. For all of those, you should specify at +least the desired average bitrate with the b option. +
      +
    • - LA - VBR with lookahead, when the look_ahead option is specified. + +
    • - VCM - video conferencing mode, when the vcm option is set. + +
    • - CBR - constant bitrate, when maxrate is specified and equal to +the average bitrate. + +
    • - VBR - variable bitrate, when maxrate is specified, but is higher +than the average bitrate. + +
    • - AVBR - average VBR mode, when maxrate is not specified. This mode +is further configured by the avbr_accuracy and +avbr_convergence options. +
    +
+ +

Note that depending on your system, a different mode than the one you specified +may be selected by the encoder. Set the verbosity level to verbose or +higher to see the actual settings used by the QSV runtime. +

+

Additional libavcodec global options are mapped to MSDK options as follows: +

+
    +
  • g/gop_size -> GopPicSize + +
  • bf/max_b_frames+1 -> GopRefDist + +
  • rc_init_occupancy/rc_initial_buffer_occupancy -> +InitialDelayInKB + +
  • slices -> NumSlice + +
  • refs -> NumRefFrame + +
  • b_strategy/b_frame_strategy -> BRefType + +
  • cgop/CLOSED_GOP codec flag -> GopOptFlag + +
  • For the CQP mode, the i_qfactor/i_qoffset and +b_qfactor/b_qoffset set the difference between QPP and QPI, +and QPP and QPB respectively. + +
  • Setting the coder option to the value vlc will make the H.264 +encoder use CAVLC instead of CABAC. + +
+ + +

16.19 snow

+ + +

16.19.1 Options

+ +
+
iterative_dia_size
+

dia size for the iterative motion estimation +

+
+ + +

16.20 VAAPI encoders

+ +

Wrappers for hardware encoders accessible via VAAPI. +

+

These encoders only accept input in VAAPI hardware surfaces. If you have input +in software frames, use the hwupload filter to upload them to the GPU. +

+

The following standard libavcodec options are used: +

    +
  • g / gop_size +
  • bf / max_b_frames +
  • profile + +

    If not set, this will be determined automatically from the format of the input +frames and the profiles supported by the driver. +

  • level +
  • b / bit_rate +
  • maxrate / rc_max_rate +
  • bufsize / rc_buffer_size +
  • rc_init_occupancy / rc_initial_buffer_occupancy +
  • compression_level + +

    Speed / quality tradeoff: higher values are faster / worse quality. +

  • q / global_quality + +

    Size / quality tradeoff: higher values are smaller / worse quality. +

  • qmin +
  • qmax +
  • i_qfactor / i_quant_factor +
  • i_qoffset / i_quant_offset +
  • b_qfactor / b_quant_factor +
  • b_qoffset / b_quant_offset +
  • slices +
+ +

All encoders support the following options: +

+
low_power
+

Some drivers/platforms offer a second encoder for some codecs intended to use +less power than the default encoder; setting this option will attempt to use +that encoder. Note that it may support a reduced feature set, so some other +options may not be available in this mode. +

+
+
idr_interval
+

Set the number of normal intra frames between full-refresh (IDR) frames in +open-GOP mode. The intra frames are still IRAPs, but will not include global +headers and may have non-decodable leading pictures. +

+
+
b_depth
+

Set the B-frame reference depth. When set to one (the default), all B-frames +will refer only to P- or I-frames. When set to greater values multiple layers +of B-frames will be present, frames in each layer only referring to frames in +higher layers. +

+
+
rc_mode
+

Set the rate control mode to use. A given driver may only support a subset of +modes. +

+

Possible modes: +

+
auto
+

Choose the mode automatically based on driver support and the other options. +This is the default. +

+
CQP
+

Constant-quality. +

+
CBR
+

Constant-bitrate. +

+
VBR
+

Variable-bitrate. +

+
ICQ
+

Intelligent constant-quality. +

+
QVBR
+

Quality-defined variable-bitrate. +

+
AVBR
+

Average variable bitrate. +

+
+ +
+
+ +

Each encoder also has its own specific options: +

+
h264_vaapi
+

profile sets the value of profile_idc and the constraint_set*_flags. +level sets the value of level_idc. +

+
+
coder
+

Set entropy encoder (default is cabac). Possible values: +

+
+
‘ac’
+
‘cabac’
+

Use CABAC. +

+
+
‘vlc’
+
‘cavlc’
+

Use CAVLC. +

+
+ +
+
aud
+

Include access unit delimiters in the stream (not included by default). +

+
+
sei
+

Set SEI message types to include. +Some combination of the following values: +

+
‘identifier’
+

Include a user_data_unregistered message containing information about +the encoder. +

+
‘timing’
+

Include picture timing parameters (buffering_period and +pic_timing messages). +

+
‘recovery_point’
+

Include recovery points where appropriate (recovery_point messages). +

+
+ +
+
+ +
+
hevc_vaapi
+

profile and level set the values of +general_profile_idc and general_level_idc respectively. +

+
+
aud
+

Include access unit delimiters in the stream (not included by default). +

+
+
tier
+

Set general_tier_flag. This may affect the level chosen for the stream +if it is not explicitly specified. +

+
+
sei
+

Set SEI message types to include. +Some combination of the following values: +

+
‘hdr’
+

Include HDR metadata if the input frames have it +(mastering_display_colour_volume and content_light_level +messages). +

+
+ +
+
+ +
+
mjpeg_vaapi
+

Only baseline DCT encoding is supported. The encoder always uses the standard +quantisation and huffman tables - global_quality scales the standard +quantisation table (range 1-100). +

+

For YUV, 4:2:0, 4:2:2 and 4:4:4 subsampling modes are supported. RGB is also +supported, and will create an RGB JPEG. +

+
+
jfif
+

Include JFIF header in each frame (not included by default). +

+
huffman
+

Include standard huffman tables (on by default). Turning this off will save +a few hundred bytes in each output frame, but may lose compatibility with some +JPEG decoders which don’t fully handle MJPEG. +

+
+ +
+
mpeg2_vaapi
+

profile and level set the value of profile_and_level_indication. +

+
+
vp8_vaapi
+

B-frames are not supported. +

+

global_quality sets the q_idx used for non-key frames (range 0-127). +

+
+
loop_filter_level
+
loop_filter_sharpness
+

Manually set the loop filter parameters. +

+
+ +
+
vp9_vaapi
+

global_quality sets the q_idx used for P-frames (range 0-255). +

+
+
loop_filter_level
+
loop_filter_sharpness
+

Manually set the loop filter parameters. +

+
+ +

B-frames are supported, but the output stream is always in encode order rather than display +order. If B-frames are enabled, it may be necessary to use the vp9_raw_reorder +bitstream filter to modify the output stream to display frames in the correct order. +

+

Only normal frames are produced - the vp9_superframe bitstream filter may be +required to produce a stream usable with all decoders. +

+
+
+ + +

16.21 vc2

+ +

SMPTE VC-2 (previously BBC Dirac Pro). This codec was primarily aimed at +professional broadcasting but since it supports yuv420, yuv422 and yuv444 at +8 (limited range or full range), 10 or 12 bits, this makes it suitable for +other tasks which require low overhead and low compression (like screen +recording). +

+ +

16.21.1 Options

+ +
+
b
+

Sets target video bitrate. Usually that’s around 1:6 of the uncompressed +video bitrate (e.g. for 1920x1080 50fps yuv422p10 that’s around 400Mbps). Higher +values (close to the uncompressed bitrate) turn on lossless compression mode. +

+
+
field_order
+

Enables field coding when set (e.g. to tt - top field first) for interlaced +inputs. Should increase compression with interlaced content as it splits the +fields and encodes each separately. +

+
+
wavelet_depth
+

Sets the total amount of wavelet transforms to apply, between 1 and 5 (default). +Lower values reduce compression and quality. Less capable decoders may not be +able to handle values of wavelet_depth over 3. +

+
+
wavelet_type
+

Sets the transform type. Currently only 5_3 (LeGall) and 9_7 +(Deslauriers-Dubuc) +are implemented, with 9_7 being the one with better compression and thus +is the default. +

+
+
slice_width
+
slice_height
+

Sets the slice size for each slice. Larger values result in better compression. +For compatibility with other more limited decoders use slice_width of +32 and slice_height of 8. +

+
+
tolerance
+

Sets the undershoot tolerance of the rate control system in percent. This is +to prevent an expensive search from being run. +

+
+
qm
+

Sets the quantization matrix preset to use by default or when wavelet_depth +is set to 5 +

    +
  • - default +Uses the default quantization matrix from the specifications, extended with +values for the fifth level. This provides a good balance between keeping detail +and omitting artifacts. + +
  • - flat +Use a completely zeroed out quantization matrix. This increases PSNR but might +reduce perception. Use in bogus benchmarks. + +
  • - color +Reduces detail but attempts to preserve color at extremely low bitrates. +
+ +
+
+ + + +

17 Subtitles Encoders

+ + +

17.1 dvdsub

+ +

This codec encodes the bitmap subtitle format that is used in DVDs. +Typically they are stored in VOBSUB file pairs (*.idx + *.sub), +and they can also be used in Matroska files. +

+ +

17.1.1 Options

+ +
+
palette
+

Specify the global palette used by the bitmaps. +

+

The format for this option is a string containing 16 24-bits hexadecimal +numbers (without 0x prefix) separated by commas, for example 0d00ee, +ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1, +7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b. +

+
+
even_rows_fix
+

When set to 1, enable a work-around that makes the number of pixel rows +even in all subtitles. This fixes a problem with some players that +cut off the bottom row if the number is odd. The work-around just adds +a fully transparent row if needed. The overhead is low, typically +one byte per subtitle on average. +

+

By default, this work-around is disabled. +

+
+ + +

18 Bitstream Filters

+ +

When you configure your FFmpeg build, all the supported bitstream +filters are enabled by default. You can list all available ones using +the configure option --list-bsfs. +

+

You can disable all the bitstream filters using the configure option +--disable-bsfs, and selectively enable any bitstream filter using +the option --enable-bsf=BSF, or you can disable a particular +bitstream filter using the option --disable-bsf=BSF. +

+

The option -bsfs of the ff* tools will display the list of +all the supported bitstream filters included in your build. +

+

The ff* tools have a -bsf option applied per stream, taking a +comma-separated list of filters, whose parameters follow the filter +name after a ’=’. +

+
+
ffmpeg -i INPUT -c:v copy -bsf:v filter1[=opt1=str1:opt2=str2][,filter2] OUTPUT
+
+ +

Below is a description of the currently available bitstream filters, +with their parameters, if any. +

+ +

18.1 aac_adtstoasc

+ +

Convert MPEG-2/4 AAC ADTS to an MPEG-4 Audio Specific Configuration +bitstream. +

+

This filter creates an MPEG-4 AudioSpecificConfig from an MPEG-2/4 +ADTS header and removes the ADTS header. +

+

This filter is required for example when copying an AAC stream from a +raw ADTS AAC or an MPEG-TS container to MP4A-LATM, to an FLV file, or +to MOV/MP4 files and related formats such as 3GP or M4A. Please note +that it is auto-inserted for MP4A-LATM and MOV/MP4 and related formats. +

+ +

18.2 av1_metadata

+ +

Modify metadata embedded in an AV1 stream. +

+
+
td
+

Insert or remove temporal delimiter OBUs in all temporal units of the +stream. +

+
+
‘insert’
+

Insert a TD at the beginning of every TU which does not already have one. +

+
‘remove’
+

Remove the TD from the beginning of every TU which has one. +

+
+ +
+
color_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the color description fields in the stream (see AV1 section 6.4.2). +

+
+
color_range
+

Set the color range in the stream (see AV1 section 6.4.2; note that +this cannot be set for streams using BT.709 primaries, sRGB transfer +characteristic and identity (RGB) matrix coefficients). +

+
‘tv’
+

Limited range. +

+
‘pc’
+

Full range. +

+
+ +
+
chroma_sample_position
+

Set the chroma sample location in the stream (see AV1 section 6.4.2). +This can only be set for 4:2:0 streams. +

+
+
‘vertical’
+

Left position (matching the default in MPEG-2 and H.264). +

+
‘colocated’
+

Top-left position. +

+
+ +
+
tick_rate
+

Set the tick rate (num_units_in_display_tick / time_scale) in +the timing info in the sequence header. +

+
num_ticks_per_picture
+

Set the number of ticks in each picture, to indicate that the stream +has a fixed framerate. Ignored if tick_rate is not also set. +

+
+
delete_padding
+

Deletes Padding OBUs. +

+
+
+ + +

18.3 chomp

+ +

Remove zero padding at the end of a packet. +

+ +

18.4 dca_core

+ +

Extract the core from a DCA/DTS stream, dropping extensions such as +DTS-HD. +

+ +

18.5 dump_extra

+ +

Add extradata to the beginning of the filtered packets except when +said packets already exactly begin with the extradata that is intended +to be added. +

+
+
freq
+

The additional argument specifies which packets should be filtered. +It accepts the values: +

+
‘k’
+
‘keyframe’
+

add extradata to all key packets +

+
+
‘e’
+
‘all’
+

add extradata to all packets +

+
+
+
+ +

If not specified it is assumed ‘k’. +

+

For example the following ffmpeg command forces a global +header (thus disabling individual packet headers) in the H.264 packets +generated by the libx264 encoder, but corrects them by adding +the header stored in extradata to the key packets: +

+
ffmpeg -i INPUT -map 0 -flags:v +global_header -c:v libx264 -bsf:v dump_extra out.ts
+
+ + +

18.6 eac3_core

+ +

Extract the core from a E-AC-3 stream, dropping extra channels. +

+ +

18.7 extract_extradata

+ +

Extract the in-band extradata. +

+

Certain codecs allow the long-term headers (e.g. MPEG-2 sequence headers, +or H.264/HEVC (VPS/)SPS/PPS) to be transmitted either "in-band" (i.e. as a part +of the bitstream containing the coded frames) or "out of band" (e.g. on the +container level). This latter form is called "extradata" in FFmpeg terminology. +

+

This bitstream filter detects the in-band headers and makes them available as +extradata. +

+
+
remove
+

When this option is enabled, the long-term headers are removed from the +bitstream after extraction. +

+
+ + +

18.8 filter_units

+ +

Remove units with types in or not in a given set from the stream. +

+
+
pass_types
+

List of unit types or ranges of unit types to pass through while removing +all others. This is specified as a ’|’-separated list of unit type values +or ranges of values with ’-’. +

+
+
remove_types
+

Identical to pass_types, except the units in the given set +removed and all others passed through. +

+
+ +

Extradata is unchanged by this transformation, but note that if the stream +contains inline parameter sets then the output may be unusable if they are +removed. +

+

For example, to remove all non-VCL NAL units from an H.264 stream: +

+
ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=pass_types=1-5' OUTPUT
+
+ +

To remove all AUDs, SEI and filler from an H.265 stream: +

+
ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=remove_types=35|38-40' OUTPUT
+
+ + +

18.9 hapqa_extract

+ +

Extract Rgb or Alpha part of an HAPQA file, without recompression, in order to create an HAPQ or an HAPAlphaOnly file. +

+
+
texture
+

Specifies the texture to keep. +

+
+
color
+
alpha
+
+ +
+
+ +

Convert HAPQA to HAPQ +

+
ffmpeg -i hapqa_inputfile.mov -c copy -bsf:v hapqa_extract=texture=color -tag:v HapY -metadata:s:v:0 encoder="HAPQ" hapq_file.mov
+
+ +

Convert HAPQA to HAPAlphaOnly +

+
ffmpeg -i hapqa_inputfile.mov -c copy -bsf:v hapqa_extract=texture=alpha -tag:v HapA -metadata:s:v:0 encoder="HAPAlpha Only" hapalphaonly_file.mov
+
+ + +

18.10 h264_metadata

+ +

Modify metadata embedded in an H.264 stream. +

+
+
aud
+

Insert or remove AUD NAL units in all access units of the stream. +

+
+
‘insert’
+
‘remove’
+
+ +
+
sample_aspect_ratio
+

Set the sample aspect ratio of the stream in the VUI parameters. +

+
+
overscan_appropriate_flag
+

Set whether the stream is suitable for display using overscan +or not (see H.264 section E.2.1). +

+
+
video_format
+
video_full_range_flag
+

Set the video format in the stream (see H.264 section E.2.1 and +table E-2). +

+
+
colour_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the colour description in the stream (see H.264 section E.2.1 +and tables E-3, E-4 and E-5). +

+
+
chroma_sample_loc_type
+

Set the chroma sample location in the stream (see H.264 section +E.2.1 and figure E-1). +

+
+
tick_rate
+

Set the tick rate (num_units_in_tick / time_scale) in the VUI +parameters. This is the smallest time unit representable in the +stream, and in many cases represents the field rate of the stream +(double the frame rate). +

+
fixed_frame_rate_flag
+

Set whether the stream has fixed framerate - typically this indicates +that the framerate is exactly half the tick rate, but the exact +meaning is dependent on interlacing and the picture structure (see +H.264 section E.2.1 and table E-6). +

+
+
crop_left
+
crop_right
+
crop_top
+
crop_bottom
+

Set the frame cropping offsets in the SPS. These values will replace +the current ones if the stream is already cropped. +

+

These fields are set in pixels. Note that some sizes may not be +representable if the chroma is subsampled or the stream is interlaced +(see H.264 section 7.4.2.1.1). +

+
+
sei_user_data
+

Insert a string as SEI unregistered user data. The argument must +be of the form UUID+string, where the UUID is as hex digits +possibly separated by hyphens, and the string can be anything. +

+

For example, ‘086f3693-b7b3-4f2c-9653-21492feee5b8+hello’ will +insert the string “hello” associated with the given UUID. +

+
+
delete_filler
+

Deletes both filler NAL units and filler SEI messages. +

+
+
level
+

Set the level in the SPS. Refer to H.264 section A.3 and tables A-1 +to A-5. +

+

The argument must be the name of a level (for example, ‘4.2’), a +level_idc value (for example, ‘42’), or the special name ‘auto’ +indicating that the filter should attempt to guess the level from the +input stream properties. +

+
+
+ + +

18.11 h264_mp4toannexb

+ +

Convert an H.264 bitstream from length prefixed mode to start code +prefixed mode (as defined in the Annex B of the ITU-T H.264 +specification). +

+

This is required by some streaming formats, typically the MPEG-2 +transport stream format (muxer mpegts). +

+

For example to remux an MP4 file containing an H.264 stream to mpegts +format with ffmpeg, you can use the command: +

+
+
ffmpeg -i INPUT.mp4 -codec copy -bsf:v h264_mp4toannexb OUTPUT.ts
+
+ +

Please note that this filter is auto-inserted for MPEG-TS (muxer +mpegts) and raw H.264 (muxer h264) output formats. +

+ +

18.12 h264_redundant_pps

+ +

This applies a specific fixup to some Blu-ray streams which contain +redundant PPSs modifying irrelevant parameters of the stream which +confuse other transformations which require correct extradata. +

+

A new single global PPS is created, and all of the redundant PPSs +within the stream are removed. +

+ +

18.13 hevc_metadata

+ +

Modify metadata embedded in an HEVC stream. +

+
+
aud
+

Insert or remove AUD NAL units in all access units of the stream. +

+
+
‘insert’
+
‘remove’
+
+ +
+
sample_aspect_ratio
+

Set the sample aspect ratio in the stream in the VUI parameters. +

+
+
video_format
+
video_full_range_flag
+

Set the video format in the stream (see H.265 section E.3.1 and +table E.2). +

+
+
colour_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the colour description in the stream (see H.265 section E.3.1 +and tables E.3, E.4 and E.5). +

+
+
chroma_sample_loc_type
+

Set the chroma sample location in the stream (see H.265 section +E.3.1 and figure E.1). +

+
+
tick_rate
+

Set the tick rate in the VPS and VUI parameters (num_units_in_tick / +time_scale). Combined with num_ticks_poc_diff_one, this can +set a constant framerate in the stream. Note that it is likely to be +overridden by container parameters when the stream is in a container. +

+
+
num_ticks_poc_diff_one
+

Set poc_proportional_to_timing_flag in VPS and VUI and use this value +to set num_ticks_poc_diff_one_minus1 (see H.265 sections 7.4.3.1 and +E.3.1). Ignored if tick_rate is not also set. +

+
+
crop_left
+
crop_right
+
crop_top
+
crop_bottom
+

Set the conformance window cropping offsets in the SPS. These values +will replace the current ones if the stream is already cropped. +

+

These fields are set in pixels. Note that some sizes may not be +representable if the chroma is subsampled (H.265 section 7.4.3.2.1). +

+
+
level
+

Set the level in the VPS and SPS. See H.265 section A.4 and tables +A.6 and A.7. +

+

The argument must be the name of a level (for example, ‘5.1’), a +general_level_idc value (for example, ‘153’ for level 5.1), +or the special name ‘auto’ indicating that the filter should +attempt to guess the level from the input stream properties. +

+
+
+ + +

18.14 hevc_mp4toannexb

+ +

Convert an HEVC/H.265 bitstream from length prefixed mode to start code +prefixed mode (as defined in the Annex B of the ITU-T H.265 +specification). +

+

This is required by some streaming formats, typically the MPEG-2 +transport stream format (muxer mpegts). +

+

For example to remux an MP4 file containing an HEVC stream to mpegts +format with ffmpeg, you can use the command: +

+
+
ffmpeg -i INPUT.mp4 -codec copy -bsf:v hevc_mp4toannexb OUTPUT.ts
+
+ +

Please note that this filter is auto-inserted for MPEG-TS (muxer +mpegts) and raw HEVC/H.265 (muxer h265 or +hevc) output formats. +

+ +

18.15 imxdump

+ +

Modifies the bitstream to fit in MOV and to be usable by the Final Cut +Pro decoder. This filter only applies to the mpeg2video codec, and is +likely not needed for Final Cut Pro 7 and newer with the appropriate +-tag:v. +

+

For example, to remux 30 MB/sec NTSC IMX to MOV: +

+
+
ffmpeg -i input.mxf -c copy -bsf:v imxdump -tag:v mx3n output.mov
+
+ + +

18.16 mjpeg2jpeg

+ +

Convert MJPEG/AVI1 packets to full JPEG/JFIF packets. +

+

MJPEG is a video codec wherein each video frame is essentially a +JPEG image. The individual frames can be extracted without loss, +e.g. by +

+
+
ffmpeg -i ../some_mjpeg.avi -c:v copy frames_%d.jpg
+
+ +

Unfortunately, these chunks are incomplete JPEG images, because +they lack the DHT segment required for decoding. Quoting from +http://www.digitalpreservation.gov/formats/fdd/fdd000063.shtml: +

+

Avery Lee, writing in the rec.video.desktop newsgroup in 2001, +commented that "MJPEG, or at least the MJPEG in AVIs having the +MJPG fourcc, is restricted JPEG with a fixed – and *omitted* – +Huffman table. The JPEG must be YCbCr colorspace, it must be 4:2:2, +and it must use basic Huffman encoding, not arithmetic or +progressive. . . . You can indeed extract the MJPEG frames and +decode them with a regular JPEG decoder, but you have to prepend +the DHT segment to them, or else the decoder won’t have any idea +how to decompress the data. The exact table necessary is given in +the OpenDML spec." +

+

This bitstream filter patches the header of frames extracted from an MJPEG +stream (carrying the AVI1 header ID and lacking a DHT segment) to +produce fully qualified JPEG images. +

+
+
ffmpeg -i mjpeg-movie.avi -c:v copy -bsf:v mjpeg2jpeg frame_%d.jpg
+exiftran -i -9 frame*.jpg
+ffmpeg -i frame_%d.jpg -c:v copy rotated.avi
+
+ + +

18.17 mjpegadump

+ +

Add an MJPEG A header to the bitstream, to enable decoding by +Quicktime. +

+ +

18.18 mov2textsub

+ +

Extract a representable text file from MOV subtitles, stripping the +metadata header from each subtitle packet. +

+

See also the text2movsub filter. +

+ +

18.19 mp3decomp

+ +

Decompress non-standard compressed MP3 audio headers. +

+ +

18.20 mpeg2_metadata

+ +

Modify metadata embedded in an MPEG-2 stream. +

+
+
display_aspect_ratio
+

Set the display aspect ratio in the stream. +

+

The following fixed values are supported: +

+
4/3
+
16/9
+
221/100
+
+

Any other value will result in square pixels being signalled instead +(see H.262 section 6.3.3 and table 6-3). +

+
+
frame_rate
+

Set the frame rate in the stream. This is constructed from a table +of known values combined with a small multiplier and divisor - if +the supplied value is not exactly representable, the nearest +representable value will be used instead (see H.262 section 6.3.3 +and table 6-4). +

+
+
video_format
+

Set the video format in the stream (see H.262 section 6.3.6 and +table 6-6). +

+
+
colour_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the colour description in the stream (see H.262 section 6.3.6 +and tables 6-7, 6-8 and 6-9). +

+
+
+ + +

18.21 mpeg4_unpack_bframes

+ +

Unpack DivX-style packed B-frames. +

+

DivX-style packed B-frames are not valid MPEG-4 and were only a +workaround for the broken Video for Windows subsystem. +They use more space, can cause minor AV sync issues, require more +CPU power to decode (unless the player has some decoded picture queue +to compensate the 2,0,2,0 frame per packet style) and cause +trouble if copied into a standard container like mp4 or mpeg-ps/ts, +because MPEG-4 decoders may not be able to decode them, since they are +not valid MPEG-4. +

+

For example to fix an AVI file containing an MPEG-4 stream with +DivX-style packed B-frames using ffmpeg, you can use the command: +

+
+
ffmpeg -i INPUT.avi -codec copy -bsf:v mpeg4_unpack_bframes OUTPUT.avi
+
+ + +

18.22 noise

+ +

Damages the contents of packets or simply drops them without damaging the +container. Can be used for fuzzing or testing error resilience/concealment. +

+

Parameters: +

+
amount
+

A numeral string, whose value is related to how often output bytes will +be modified. Therefore, values below or equal to 0 are forbidden, and +the lower the more frequent bytes will be modified, with 1 meaning +every byte is modified. +

+
dropamount
+

A numeral string, whose value is related to how often packets will be dropped. +Therefore, values below or equal to 0 are forbidden, and the lower the more +frequent packets will be dropped, with 1 meaning every packet is dropped. +

+
+ +

The following example applies the modification to every byte but does not drop +any packets. +

+
ffmpeg -i INPUT -c copy -bsf noise[=1] output.mkv
+
+ + +

18.23 null

+

This bitstream filter passes the packets through unchanged. +

+ +

18.24 pcm_rechunk

+ +

Repacketize PCM audio to a fixed number of samples per packet or a fixed packet +rate per second. This is similar to the (ffmpeg-filters)asetnsamples audio +filter but works on audio packets instead of audio frames. +

+
+
nb_out_samples, n
+

Set the number of samples per each output audio packet. The number is intended +as the number of samples per each channel. Default value is 1024. +

+
+
pad, p
+

If set to 1, the filter will pad the last audio packet with silence, so that it +will contain the same number of samples (or roughly the same number of samples, +see frame_rate) as the previous ones. Default value is 1. +

+
+
frame_rate, r
+

This option makes the filter output a fixed number of packets per second instead +of a fixed number of samples per packet. If the audio sample rate is not +divisible by the frame rate then the number of samples will not be constant but +will vary slightly so that each packet will start as close to the frame +boundary as possible. Using this option has precedence over nb_out_samples. +

+
+ +

You can generate the well known 1602-1601-1602-1601-1602 pattern of 48kHz audio +for NTSC frame rate using the frame_rate option. +

+
ffmpeg -f lavfi -i sine=r=48000:d=1 -c pcm_s16le -bsf pcm_rechunk=r=30000/1001 -f framecrc -
+
+ + +

18.25 prores_metadata

+ +

Modify color property metadata embedded in prores stream. +

+
+
color_primaries
+

Set the color primaries. +Available values are: +

+
+
‘auto’
+

Keep the same color primaries property (default). +

+
+
‘unknown’
+
‘bt709’
+
‘bt470bg’
+

BT601 625 +

+
+
‘smpte170m’
+

BT601 525 +

+
+
‘bt2020’
+
‘smpte431’
+

DCI P3 +

+
+
‘smpte432’
+

P3 D65 +

+
+
+ +
+
transfer_characteristics
+

Set the color transfer. +Available values are: +

+
+
‘auto’
+

Keep the same transfer characteristics property (default). +

+
+
‘unknown’
+
‘bt709’
+

BT 601, BT 709, BT 2020 +

+
‘smpte2084’
+

SMPTE ST 2084 +

+
‘arib-std-b67’
+

ARIB STD-B67 +

+
+ + +
+
matrix_coefficients
+

Set the matrix coefficient. +Available values are: +

+
+
‘auto’
+

Keep the same colorspace property (default). +

+
+
‘unknown’
+
‘bt709’
+
‘smpte170m’
+

BT 601 +

+
+
‘bt2020nc’
+
+
+
+ +

Set Rec709 colorspace for each frame of the file +

+
ffmpeg -i INPUT -c copy -bsf:v prores_metadata=color_primaries=bt709:color_trc=bt709:colorspace=bt709 output.mov
+
+ +

Set Hybrid Log-Gamma parameters for each frame of the file +

+
ffmpeg -i INPUT -c copy -bsf:v prores_metadata=color_primaries=bt2020:color_trc=arib-std-b67:colorspace=bt2020nc output.mov
+
+ + +

18.26 remove_extra

+ +

Remove extradata from packets. +

+

It accepts the following parameter: +

+
freq
+

Set which frame types to remove extradata from. +

+
+
‘k’
+

Remove extradata from non-keyframes only. +

+
+
‘keyframe’
+

Remove extradata from keyframes only. +

+
+
‘e, all’
+

Remove extradata from all frames. +

+
+
+
+
+ + +

18.27 text2movsub

+ +

Convert text subtitles to MOV subtitles (as used by the mov_text +codec) with metadata headers. +

+

See also the mov2textsub filter. +

+ +

18.28 trace_headers

+ +

Log trace output containing all syntax elements in the coded stream +headers (everything above the level of individual coded blocks). +This can be useful for debugging low-level stream issues. +

+

Supports AV1, H.264, H.265, (M)JPEG, MPEG-2 and VP9, but depending +on the build only a subset of these may be available. +

+ +

18.29 truehd_core

+ +

Extract the core from a TrueHD stream, dropping ATMOS data. +

+ +

18.30 vp9_metadata

+ +

Modify metadata embedded in a VP9 stream. +

+
+
color_space
+

Set the color space value in the frame header. Note that any frame +set to RGB will be implicitly set to PC range and that RGB is +incompatible with profiles 0 and 2. +

+
‘unknown’
+
‘bt601’
+
‘bt709’
+
‘smpte170’
+
‘smpte240’
+
‘bt2020’
+
‘rgb’
+
+ +
+
color_range
+

Set the color range value in the frame header. Note that any value +imposed by the color space will take precedence over this value. +

+
‘tv’
+
‘pc’
+
+
+
+ + +

18.31 vp9_superframe

+ +

Merge VP9 invisible (alt-ref) frames back into VP9 superframes. This +fixes merging of split/segmented VP9 streams where the alt-ref frame +was split from its visible counterpart. +

+ +

18.32 vp9_superframe_split

+ +

Split VP9 superframes into single frames. +

+ +

18.33 vp9_raw_reorder

+ +

Given a VP9 stream with correct timestamps but possibly out of order, +insert additional show-existing-frame packets to correct the ordering. +

+ +

19 Format Options

+ +

The libavformat library provides some generic global options, which +can be set on all the muxers and demuxers. In addition each muxer or +demuxer may support so-called private options, which are specific for +that component. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the +AVFormatContext options or using the libavutil/opt.h API +for programmatic use. +

+

The list of supported options follows: +

+
+
avioflags flags (input/output)
+

Possible values: +

+
‘direct’
+

Reduce buffering. +

+
+ +
+
probesize integer (input)
+

Set probing size in bytes, i.e. the size of the data to analyze to get +stream information. A higher value will enable detecting more +information in case it is dispersed into the stream, but will increase +latency. Must be an integer not lesser than 32. It is 5000000 by default. +

+
+
max_probe_packets integer (input)
+

Set the maximum number of buffered packets when probing a codec. +Default is 2500 packets. +

+
+
packetsize integer (output)
+

Set packet size. +

+
+
fflags flags
+

Set format flags. Some are implemented for a limited number of formats. +

+

Possible values for input files: +

+
‘discardcorrupt’
+

Discard corrupted packets. +

+
‘fastseek’
+

Enable fast, but inaccurate seeks for some formats. +

+
‘genpts’
+

Generate missing PTS if DTS is present. +

+
‘igndts’
+

Ignore DTS if PTS is set. Inert when nofillin is set. +

+
‘ignidx’
+

Ignore index. +

+
‘keepside (deprecated,inert)’
+
‘nobuffer’
+

Reduce the latency introduced by buffering during initial input streams analysis. +

+
‘nofillin’
+

Do not fill in missing values in packet fields that can be exactly calculated. +

+
‘noparse’
+

Disable AVParsers, this needs +nofillin too. +

+
‘sortdts’
+

Try to interleave output packets by DTS. At present, available only for AVIs with an index. +

+
+ +

Possible values for output files: +

+
‘autobsf’
+

Automatically apply bitstream filters as required by the output format. Enabled by default. +

+
‘bitexact’
+

Only write platform-, build- and time-independent data. +This ensures that file and data checksums are reproducible and match between +platforms. Its primary use is for regression testing. +

+
‘flush_packets’
+

Write out packets immediately. +

+
‘latm (deprecated,inert)’
+
‘shortest’
+

Stop muxing at the end of the shortest stream. +It may be needed to increase max_interleave_delta to avoid flushing the longer +streams before EOF. +

+
+ +
+
seek2any integer (input)
+

Allow seeking to non-keyframes on demuxer level when supported if set to 1. +Default is 0. +

+
+
analyzeduration integer (input)
+

Specify how many microseconds are analyzed to probe the input. A +higher value will enable detecting more accurate information, but will +increase latency. It defaults to 5,000,000 microseconds = 5 seconds. +

+
+
cryptokey hexadecimal string (input)
+

Set decryption key. +

+
+
indexmem integer (input)
+

Set max memory used for timestamp index (per stream). +

+
+
rtbufsize integer (input)
+

Set max memory used for buffering real-time frames. +

+
+
fdebug flags (input/output)
+

Print specific debug info. +

+

Possible values: +

+
‘ts’
+
+ +
+
max_delay integer (input/output)
+

Set maximum muxing or demuxing delay in microseconds. +

+
+
fpsprobesize integer (input)
+

Set number of frames used to probe fps. +

+
+
audio_preload integer (output)
+

Set microseconds by which audio packets should be interleaved earlier. +

+
+
chunk_duration integer (output)
+

Set microseconds for each chunk. +

+
+
chunk_size integer (output)
+

Set size in bytes for each chunk. +

+
+
err_detect, f_err_detect flags (input)
+

Set error detection flags. f_err_detect is deprecated and +should be used only via the ffmpeg tool. +

+

Possible values: +

+
‘crccheck’
+

Verify embedded CRCs. +

+
‘bitstream’
+

Detect bitstream specification deviations. +

+
‘buffer’
+

Detect improper bitstream length. +

+
‘explode’
+

Abort decoding on minor error detection. +

+
‘careful’
+

Consider things that violate the spec and have not been seen in the +wild as errors. +

+
‘compliant’
+

Consider all spec non compliancies as errors. +

+
‘aggressive’
+

Consider things that a sane encoder should not do as an error. +

+
+ +
+
max_interleave_delta integer (output)
+

Set maximum buffering duration for interleaving. The duration is +expressed in microseconds, and defaults to 10000000 (10 seconds). +

+

To ensure all the streams are interleaved correctly, libavformat will +wait until it has at least one packet for each stream before actually +writing any packets to the output file. When some streams are +"sparse" (i.e. there are large gaps between successive packets), this +can result in excessive buffering. +

+

This field specifies the maximum difference between the timestamps of the +first and the last packet in the muxing queue, above which libavformat +will output a packet regardless of whether it has queued a packet for all +the streams. +

+

If set to 0, libavformat will continue buffering packets until it has +a packet for each stream, regardless of the maximum timestamp +difference between the buffered packets. +

+
+
use_wallclock_as_timestamps integer (input)
+

Use wallclock as timestamps if set to 1. Default is 0. +

+
+
avoid_negative_ts integer (output)
+
+

Possible values: +

+
‘make_non_negative’
+

Shift timestamps to make them non-negative. +Also note that this affects only leading negative timestamps, and not +non-monotonic negative timestamps. +

+
‘make_zero’
+

Shift timestamps so that the first timestamp is 0. +

+
‘auto (default)’
+

Enables shifting when required by the target format. +

+
‘disabled’
+

Disables shifting of timestamp. +

+
+ +

When shifting is enabled, all output timestamps are shifted by the +same amount. Audio, video, and subtitles desynching and relative +timestamp differences are preserved compared to how they would have +been without shifting. +

+
+
skip_initial_bytes integer (input)
+

Set number of bytes to skip before reading header and frames if set to 1. +Default is 0. +

+
+
correct_ts_overflow integer (input)
+

Correct single timestamp overflows if set to 1. Default is 1. +

+
+
flush_packets integer (output)
+

Flush the underlying I/O stream after each packet. Default is -1 (auto), which +means that the underlying protocol will decide, 1 enables it, and has the +effect of reducing the latency, 0 disables it and may increase IO throughput in +some cases. +

+
+
output_ts_offset offset (output)
+

Set the output time offset. +

+

offset must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+

The offset is added by the muxer to the output timestamps. +

+

Specifying a positive offset means that the corresponding streams are +delayed bt the time duration specified in offset. Default value +is 0 (meaning that no offset is applied). +

+
+
format_whitelist list (input)
+

"," separated list of allowed demuxers. By default all are allowed. +

+
+
dump_separator string (input)
+

Separator used to separate the fields printed on the command line about the +Stream parameters. +For example, to separate the fields with newlines and indentation: +

+
ffprobe -dump_separator "
+                          "  -i ~/videos/matrixbench_mpeg2.mpg
+
+ +
+
max_streams integer (input)
+

Specifies the maximum number of streams. This can be used to reject files that +would require too many resources due to a large number of streams. +

+
+
skip_estimate_duration_from_pts bool (input)
+

Skip estimation of input duration when calculated using PTS. +At present, applicable for MPEG-PS and MPEG-TS. +

+
+
strict, f_strict integer (input/output)
+

Specify how strictly to follow the standards. f_strict is deprecated and +should be used only via the ffmpeg tool. +

+

Possible values: +

+
‘very’
+

strictly conform to an older more strict version of the spec or reference software +

+
‘strict’
+

strictly conform to all the things in the spec no matter what consequences +

+
‘normal’
+
‘unofficial’
+

allow unofficial extensions +

+
‘experimental’
+

allow non standardized experimental things, experimental +(unfinished/work in progress/not well tested) decoders and encoders. +Note: experimental decoders can pose a security risk, do not use this for +decoding untrusted input. +

+
+ +
+
+ + + +

19.1 Format stream specifiers

+ +

Format stream specifiers allow selection of one or more streams that +match specific properties. +

+

The exact semantics of stream specifiers is defined by the +avformat_match_stream_specifier() function declared in the +libavformat/avformat.h header and documented in the +(ffmpeg)Stream specifiers section in the ffmpeg(1) manual. +

+ +

20 Demuxers

+ +

Demuxers are configured elements in FFmpeg that can read the +multimedia streams from a particular type of file. +

+

When you configure your FFmpeg build, all the supported demuxers +are enabled by default. You can list all available ones using the +configure option --list-demuxers. +

+

You can disable all the demuxers using the configure option +--disable-demuxers, and selectively enable a single demuxer with +the option --enable-demuxer=DEMUXER, or disable it +with the option --disable-demuxer=DEMUXER. +

+

The option -demuxers of the ff* tools will display the list of +enabled demuxers. Use -formats to view a combined list of +enabled demuxers and muxers. +

+

The description of some of the currently available demuxers follows. +

+ +

20.1 aa

+ +

Audible Format 2, 3, and 4 demuxer. +

+

This demuxer is used to demux Audible Format 2, 3, and 4 (.aa) files. +

+ +

20.2 apng

+ +

Animated Portable Network Graphics demuxer. +

+

This demuxer is used to demux APNG files. +All headers, but the PNG signature, up to (but not including) the first +fcTL chunk are transmitted as extradata. +Frames are then split as being all the chunks between two fcTL ones, or +between the last fcTL and IEND chunks. +

+
+
-ignore_loop bool
+

Ignore the loop variable in the file if set. +

+
-max_fps int
+

Maximum framerate in frames per second (0 for no limit). +

+
-default_fps int
+

Default framerate in frames per second when none is specified in the file +(0 meaning as fast as possible). +

+
+ + +

20.3 asf

+ +

Advanced Systems Format demuxer. +

+

This demuxer is used to demux ASF files and MMS network streams. +

+
+
-no_resync_search bool
+

Do not try to resynchronize by looking for a certain optional start code. +

+
+ + +

20.4 concat

+ +

Virtual concatenation script demuxer. +

+

This demuxer reads a list of files and other directives from a text file and +demuxes them one after the other, as if all their packets had been muxed +together. +

+

The timestamps in the files are adjusted so that the first file starts at 0 +and each next file starts where the previous one finishes. Note that it is +done globally and may cause gaps if all streams do not have exactly the same +length. +

+

All files must have the same streams (same codecs, same time base, etc.). +

+

The duration of each file is used to adjust the timestamps of the next file: +if the duration is incorrect (because it was computed using the bit-rate or +because the file is truncated, for example), it can cause artifacts. The +duration directive can be used to override the duration stored in +each file. +

+ +

20.4.1 Syntax

+ +

The script is a text file in extended-ASCII, with one directive per line. +Empty lines, leading spaces and lines starting with ’#’ are ignored. The +following directive is recognized: +

+
+
file path
+

Path to a file to read; special characters and spaces must be escaped with +backslash or single quotes. +

+

All subsequent file-related directives apply to that file. +

+
+
ffconcat version 1.0
+

Identify the script type and version. It also sets the safe option +to 1 if it was -1. +

+

To make FFmpeg recognize the format automatically, this directive must +appear exactly as is (no extra space or byte-order-mark) on the very first +line of the script. +

+
+
duration dur
+

Duration of the file. This information can be specified from the file; +specifying it here may be more efficient or help if the information from the +file is not available or accurate. +

+

If the duration is set for all files, then it is possible to seek in the +whole concatenated video. +

+
+
inpoint timestamp
+

In point of the file. When the demuxer opens the file it instantly seeks to the +specified timestamp. Seeking is done so that all streams can be presented +successfully at In point. +

+

This directive works best with intra frame codecs, because for non-intra frame +ones you will usually get extra packets before the actual In point and the +decoded content will most likely contain frames before In point too. +

+

For each file, packets before the file In point will have timestamps less than +the calculated start timestamp of the file (negative in case of the first +file), and the duration of the files (if not specified by the duration +directive) will be reduced based on their specified In point. +

+

Because of potential packets before the specified In point, packet timestamps +may overlap between two concatenated files. +

+
+
outpoint timestamp
+

Out point of the file. When the demuxer reaches the specified decoding +timestamp in any of the streams, it handles it as an end of file condition and +skips the current and all the remaining packets from all streams. +

+

Out point is exclusive, which means that the demuxer will not output packets +with a decoding timestamp greater or equal to Out point. +

+

This directive works best with intra frame codecs and formats where all streams +are tightly interleaved. For non-intra frame codecs you will usually get +additional packets with presentation timestamp after Out point therefore the +decoded content will most likely contain frames after Out point too. If your +streams are not tightly interleaved you may not get all the packets from all +streams before Out point and you may only will be able to decode the earliest +stream until Out point. +

+

The duration of the files (if not specified by the duration +directive) will be reduced based on their specified Out point. +

+
+
file_packet_metadata key=value
+

Metadata of the packets of the file. The specified metadata will be set for +each file packet. You can specify this directive multiple times to add multiple +metadata entries. +

+
+
stream
+

Introduce a stream in the virtual file. +All subsequent stream-related directives apply to the last introduced +stream. +Some streams properties must be set in order to allow identifying the +matching streams in the subfiles. +If no streams are defined in the script, the streams from the first file are +copied. +

+
+
exact_stream_id id
+

Set the id of the stream. +If this directive is given, the string with the corresponding id in the +subfiles will be used. +This is especially useful for MPEG-PS (VOB) files, where the order of the +streams is not reliable. +

+
+
+ + +

20.4.2 Options

+ +

This demuxer accepts the following option: +

+
+
safe
+

If set to 1, reject unsafe file paths. A file path is considered safe if it +does not contain a protocol specification and is relative and all components +only contain characters from the portable character set (letters, digits, +period, underscore and hyphen) and have no period at the beginning of a +component. +

+

If set to 0, any file name is accepted. +

+

The default is 1. +

+

-1 is equivalent to 1 if the format was automatically +probed and 0 otherwise. +

+
+
auto_convert
+

If set to 1, try to perform automatic conversions on packet data to make the +streams concatenable. +The default is 1. +

+

Currently, the only conversion is adding the h264_mp4toannexb bitstream +filter to H.264 streams in MP4 format. This is necessary in particular if +there are resolution changes. +

+
+
segment_time_metadata
+

If set to 1, every packet will contain the lavf.concat.start_time and the +lavf.concat.duration packet metadata values which are the start_time and +the duration of the respective file segments in the concatenated output +expressed in microseconds. The duration metadata is only set if it is known +based on the concat file. +The default is 0. +

+
+
+ + +

20.4.3 Examples

+ +
    +
  • Use absolute filenames and include some comments: +
    +
    # my first filename
+file /mnt/share/file-1.wav
+# my second filename including whitespace
+file '/mnt/share/file 2.wav'
+# my third filename including whitespace plus single quote
+file '/mnt/share/file 3'\''.wav'
+
    + +
  • Allow for input format auto-probing, use safe filenames and set the duration of +the first file: +
    +
    ffconcat version 1.0
+
+file file-1.wav
+duration 20.0
+
+file subdir/file-2.wav
+
    +
+ + +

20.5 dash

+ +

Dynamic Adaptive Streaming over HTTP demuxer. +

+

This demuxer presents all AVStreams found in the manifest. +By setting the discard flags on AVStreams the caller can decide +which streams to actually receive. +Each stream mirrors the id and bandwidth properties from the +<Representation> as metadata keys named "id" and "variant_bitrate" respectively. +

+ +

20.6 flv, live_flv

+ +

Adobe Flash Video Format demuxer. +

+

This demuxer is used to demux FLV files and RTMP network streams. In case of live network streams, if you force format, you may use live_flv option instead of flv to survive timestamp discontinuities. +

+
+
ffmpeg -f flv -i myfile.flv ...
+ffmpeg -f live_flv -i rtmp://<any.server>/anything/key ....
+
+ + +
+
-flv_metadata bool
+

Allocate the streams according to the onMetaData array content. +

+
+
-flv_ignore_prevtag bool
+

Ignore the size of previous tag value. +

+
+
-flv_full_metadata bool
+

Output all context of the onMetadata. +

+
+ + +

20.7 gif

+ +

Animated GIF demuxer. +

+

It accepts the following options: +

+
+
min_delay
+

Set the minimum valid delay between frames in hundredths of seconds. +Range is 0 to 6000. Default value is 2. +

+
+
max_gif_delay
+

Set the maximum valid delay between frames in hundredth of seconds. +Range is 0 to 65535. Default value is 65535 (nearly eleven minutes), +the maximum value allowed by the specification. +

+
+
default_delay
+

Set the default delay between frames in hundredths of seconds. +Range is 0 to 6000. Default value is 10. +

+
+
ignore_loop
+

GIF files can contain information to loop a certain number of times (or +infinitely). If ignore_loop is set to 1, then the loop setting +from the input will be ignored and looping will not occur. If set to 0, +then looping will occur and will cycle the number of times according to +the GIF. Default value is 1. +

+
+ +

For example, with the overlay filter, place an infinitely looping GIF +over another video: +

+
ffmpeg -i input.mp4 -ignore_loop 0 -i input.gif -filter_complex overlay=shortest=1 out.mkv
+
+ +

Note that in the above example the shortest option for overlay filter is +used to end the output video at the length of the shortest input file, +which in this case is input.mp4 as the GIF in this example loops +infinitely. +

+ +

20.8 hls

+ +

HLS demuxer +

+

Apple HTTP Live Streaming demuxer. +

+

This demuxer presents all AVStreams from all variant streams. +The id field is set to the bitrate variant index number. By setting +the discard flags on AVStreams (by pressing ’a’ or ’v’ in ffplay), +the caller can decide which variant streams to actually receive. +The total bitrate of the variant that the stream belongs to is +available in a metadata key named "variant_bitrate". +

+

It accepts the following options: +

+
+
live_start_index
+

segment index to start live streams at (negative values are from the end). +

+
+
allowed_extensions
+

’,’ separated list of file extensions that hls is allowed to access. +

+
+
max_reload
+

Maximum number of times a insufficient list is attempted to be reloaded. +Default value is 1000. +

+
+
m3u8_hold_counters
+

The maximum number of times to load m3u8 when it refreshes without new segments. +Default value is 1000. +

+
+
http_persistent
+

Use persistent HTTP connections. Applicable only for HTTP streams. +Enabled by default. +

+
+
http_multiple
+

Use multiple HTTP connections for downloading HTTP segments. +Enabled by default for HTTP/1.1 servers. +

+
+
http_seekable
+

Use HTTP partial requests for downloading HTTP segments. +0 = disable, 1 = enable, -1 = auto, Default is auto. +

+
+ + +

20.9 image2

+ +

Image file demuxer. +

+

This demuxer reads from a list of image files specified by a pattern. +The syntax and meaning of the pattern is specified by the +option pattern_type. +

+

The pattern may contain a suffix which is used to automatically +determine the format of the images contained in the files. +

+

The size, the pixel format, and the format of each image must be the +same for all the files in the sequence. +

+

This demuxer accepts the following options: +

+
framerate
+

Set the frame rate for the video stream. It defaults to 25. +

+
loop
+

If set to 1, loop over the input. Default value is 0. +

+
pattern_type
+

Select the pattern type used to interpret the provided filename. +

+

pattern_type accepts one of the following values. +

+
none
+

Disable pattern matching, therefore the video will only contain the specified +image. You should use this option if you do not want to create sequences from +multiple images and your filenames may contain special pattern characters. +

+
sequence
+

Select a sequence pattern type, used to specify a sequence of files +indexed by sequential numbers. +

+

A sequence pattern may contain the string "%d" or "%0Nd", which +specifies the position of the characters representing a sequential +number in each filename matched by the pattern. If the form +"%d0Nd" is used, the string representing the number in each +filename is 0-padded and N is the total number of 0-padded +digits representing the number. The literal character ’%’ can be +specified in the pattern with the string "%%". +

+

If the sequence pattern contains "%d" or "%0Nd", the first filename of +the file list specified by the pattern must contain a number +inclusively contained between start_number and +start_number+start_number_range-1, and all the following +numbers must be sequential. +

+

For example the pattern "img-%03d.bmp" will match a sequence of +filenames of the form img-001.bmp, img-002.bmp, ..., +img-010.bmp, etc.; the pattern "i%%m%%g-%d.jpg" will match a +sequence of filenames of the form i%m%g-1.jpg, +i%m%g-2.jpg, ..., i%m%g-10.jpg, etc. +

+

Note that the pattern must not necessarily contain "%d" or +"%0Nd", for example to convert a single image file +img.jpeg you can employ the command: +

+
ffmpeg -i img.jpeg img.png
+
+ +
+
glob
+

Select a glob wildcard pattern type. +

+

The pattern is interpreted like a glob() pattern. This is only +selectable if libavformat was compiled with globbing support. +

+
+
glob_sequence (deprecated, will be removed)
+

Select a mixed glob wildcard/sequence pattern. +

+

If your version of libavformat was compiled with globbing support, and +the provided pattern contains at least one glob meta character among +%*?[]{} that is preceded by an unescaped "%", the pattern is +interpreted like a glob() pattern, otherwise it is interpreted +like a sequence pattern. +

+

All glob special characters %*?[]{} must be prefixed +with "%". To escape a literal "%" you shall use "%%". +

+

For example the pattern foo-%*.jpeg will match all the +filenames prefixed by "foo-" and terminating with ".jpeg", and +foo-%?%?%?.jpeg will match all the filenames prefixed with +"foo-", followed by a sequence of three characters, and terminating +with ".jpeg". +

+

This pattern type is deprecated in favor of glob and +sequence. +

+
+ +

Default value is glob_sequence. +

+
pixel_format
+

Set the pixel format of the images to read. If not specified the pixel +format is guessed from the first image file in the sequence. +

+
start_number
+

Set the index of the file matched by the image file pattern to start +to read from. Default value is 0. +

+
start_number_range
+

Set the index interval range to check when looking for the first image +file in the sequence, starting from start_number. Default value +is 5. +

+
ts_from_file
+

If set to 1, will set frame timestamp to modification time of image file. Note +that monotonity of timestamps is not provided: images go in the same order as +without this option. Default value is 0. +If set to 2, will set frame timestamp to the modification time of the image file in +nanosecond precision. +

+
video_size
+

Set the video size of the images to read. If not specified the video +size is guessed from the first image file in the sequence. +

+
export_path_metadata
+

If set to 1, will add two extra fields to the metadata found in input, making them +also available for other filters (see drawtext filter for examples). Default +value is 0. The extra fields are described below: +

+
lavf.image2dec.source_path
+

Corresponds to the full path to the input file being read. +

+
lavf.image2dec.source_basename
+

Corresponds to the name of the file being read. +

+
+ +
+
+ + +

20.9.1 Examples

+ +
    +
  • Use ffmpeg for creating a video from the images in the file +sequence img-001.jpeg, img-002.jpeg, ..., assuming an +input frame rate of 10 frames per second: +
    +
    ffmpeg -framerate 10 -i 'img-%03d.jpeg' out.mkv
+
    + +
  • As above, but start by reading from a file with index 100 in the sequence: +
    +
    ffmpeg -framerate 10 -start_number 100 -i 'img-%03d.jpeg' out.mkv
+
    + +
  • Read images matching the "*.png" glob pattern , that is all the files +terminating with the ".png" suffix: +
    +
    ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
+
    +
+ + +

20.10 libgme

+ +

The Game Music Emu library is a collection of video game music file emulators. +

+

See https://bitbucket.org/mpyne/game-music-emu/overview for more information. +

+

It accepts the following options: +

+
+
track_index
+

Set the index of which track to demux. The demuxer can only export one track. +Track indexes start at 0. Default is to pick the first track. Number of tracks +is exported as tracks metadata entry. +

+
+
sample_rate
+

Set the sampling rate of the exported track. Range is 1000 to 999999. Default is 44100. +

+
+
max_size (bytes)
+

The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size, +which in turn, acts as a ceiling for the size of files that can be read. +Default is 50 MiB. +

+
+
+ + +

20.11 libmodplug

+ +

ModPlug based module demuxer +

+

See https://github.com/Konstanty/libmodplug +

+

It will export one 2-channel 16-bit 44.1 kHz audio stream. +Optionally, a pal8 16-color video stream can be exported with or without printed metadata. +

+

It accepts the following options: +

+
+
noise_reduction
+

Apply a simple low-pass filter. Can be 1 (on) or 0 (off). Default is 0. +

+
+
reverb_depth
+

Set amount of reverb. Range 0-100. Default is 0. +

+
+
reverb_delay
+

Set delay in ms, clamped to 40-250 ms. Default is 0. +

+
+
bass_amount
+

Apply bass expansion a.k.a. XBass or megabass. Range is 0 (quiet) to 100 (loud). Default is 0. +

+
+
bass_range
+

Set cutoff i.e. upper-bound for bass frequencies. Range is 10-100 Hz. Default is 0. +

+
+
surround_depth
+

Apply a Dolby Pro-Logic surround effect. Range is 0 (quiet) to 100 (heavy). Default is 0. +

+
+
surround_delay
+

Set surround delay in ms, clamped to 5-40 ms. Default is 0. +

+
+
max_size
+

The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size, +which in turn, acts as a ceiling for the size of files that can be read. Range is 0 to 100 MiB. +0 removes buffer size limit (not recommended). Default is 5 MiB. +

+
+
video_stream_expr
+

String which is evaluated using the eval API to assign colors to the generated video stream. +Variables which can be used are x, y, w, h, t, speed, +tempo, order, pattern and row. +

+
+
video_stream
+

Generate video stream. Can be 1 (on) or 0 (off). Default is 0. +

+
+
video_stream_w
+

Set video frame width in ’chars’ where one char indicates 8 pixels. Range is 20-512. Default is 30. +

+
+
video_stream_h
+

Set video frame height in ’chars’ where one char indicates 8 pixels. Range is 20-512. Default is 30. +

+
+
video_stream_ptxt
+

Print metadata on video stream. Includes speed, tempo, order, pattern, +row and ts (time in ms). Can be 1 (on) or 0 (off). Default is 1. +

+
+
+ + +

20.12 libopenmpt

+ +

libopenmpt based module demuxer +

+

See https://lib.openmpt.org/libopenmpt/ for more information. +

+

Some files have multiple subsongs (tracks) this can be set with the subsong +option. +

+

It accepts the following options: +

+
+
subsong
+

Set the subsong index. This can be either ’all’, ’auto’, or the index of the +subsong. Subsong indexes start at 0. The default is ’auto’. +

+

The default value is to let libopenmpt choose. +

+
+
layout
+

Set the channel layout. Valid values are 1, 2, and 4 channel layouts. +The default value is STEREO. +

+
+
sample_rate
+

Set the sample rate for libopenmpt to output. +Range is from 1000 to INT_MAX. The value default is 48000. +

+
+ + +

20.13 mov/mp4/3gp

+ +

Demuxer for Quicktime File Format & ISO/IEC Base Media File Format (ISO/IEC 14496-12 or MPEG-4 Part 12, ISO/IEC 15444-12 or JPEG 2000 Part 12). +

+

Registered extensions: mov, mp4, m4a, 3gp, 3g2, mj2, psp, m4b, ism, ismv, isma, f4v +

+ +

20.13.1 Options

+ +

This demuxer accepts the following options: +

+
enable_drefs
+

Enable loading of external tracks, disabled by default. +Enabling this can theoretically leak information in some use cases. +

+
+
use_absolute_path
+

Allows loading of external tracks via absolute paths, disabled by default. +Enabling this poses a security risk. It should only be enabled if the source +is known to be non-malicious. +

+
+
seek_streams_individually
+

When seeking, identify the closest point in each stream individually and demux packets in +that stream from identified point. This can lead to a different sequence of packets compared +to demuxing linearly from the beginning. Default is true. +

+
+
ignore_editlist
+

Ignore any edit list atoms. The demuxer, by default, modifies the stream index to reflect the +timeline described by the edit list. Default is false. +

+
+
advanced_editlist
+

Modify the stream index to reflect the timeline described by the edit list. ignore_editlist +must be set to false for this option to be effective. +If both ignore_editlist and this option are set to false, then only the +start of the stream index is modified to reflect initial dwell time or starting timestamp +described by the edit list. Default is true. +

+
+
ignore_chapters
+

Don’t parse chapters. This includes GoPro ’HiLight’ tags/moments. Note that chapters are +only parsed when input is seekable. Default is false. +

+
+
use_mfra_for
+

For seekable fragmented input, set fragment’s starting timestamp from media fragment random access box, if present. +

+

Following options are available: +

+
‘auto’
+

Auto-detect whether to set mfra timestamps as PTS or DTS (default) +

+
+
‘dts’
+

Set mfra timestamps as DTS +

+
+
‘pts’
+

Set mfra timestamps as PTS +

+
+
‘0’
+

Don’t use mfra box to set timestamps +

+
+ +
+
export_all
+

Export unrecognized boxes within the udta box as metadata entries. The first four +characters of the box type are set as the key. Default is false. +

+
+
export_xmp
+

Export entire contents of XMP_ box and uuid box as a string with key xmp. Note that +if export_all is set and this option isn’t, the contents of XMP_ box are still exported +but with key XMP_. Default is false. +

+
+
activation_bytes
+

4-byte key required to decrypt Audible AAX and AAX+ files. See Audible AAX subsection below. +

+
+
audible_fixed_key
+

Fixed key used for handling Audible AAX/AAX+ files. It has been pre-set so should not be necessary to +specify. +

+
+
decryption_key
+

16-byte key, in hex, to decrypt files encrypted using ISO Common Encryption (CENC/AES-128 CTR; ISO/IEC 23001-7). +

+
+ + +

20.13.2 Audible AAX

+ +

Audible AAX files are encrypted M4B files, and they can be decrypted by specifying a 4 byte activation secret. +

+
ffmpeg -activation_bytes 1CEB00DA -i test.aax -vn -c:a copy output.mp4
+
+ + +

20.14 mpegts

+ +

MPEG-2 transport stream demuxer. +

+

This demuxer accepts the following options: +

+
resync_size
+

Set size limit for looking up a new synchronization. Default value is +65536. +

+
+
skip_unknown_pmt
+

Skip PMTs for programs not defined in the PAT. Default value is 0. +

+
+
fix_teletext_pts
+

Override teletext packet PTS and DTS values with the timestamps calculated +from the PCR of the first program which the teletext stream is part of and is +not discarded. Default value is 1, set this option to 0 if you want your +teletext packet PTS and DTS values untouched. +

+
+
ts_packetsize
+

Output option carrying the raw packet size in bytes. +Show the detected raw packet size, cannot be set by the user. +

+
+
scan_all_pmts
+

Scan and combine all PMTs. The value is an integer with value from -1 +to 1 (-1 means automatic setting, 1 means enabled, 0 means +disabled). Default value is -1. +

+
+
merge_pmt_versions
+

Re-use existing streams when a PMT’s version is updated and elementary +streams move to different PIDs. Default value is 0. +

+
+ + +

20.15 mpjpeg

+ +

MJPEG encapsulated in multi-part MIME demuxer. +

+

This demuxer allows reading of MJPEG, where each frame is represented as a part of +multipart/x-mixed-replace stream. +

+
strict_mime_boundary
+

Default implementation applies a relaxed standard to multi-part MIME boundary detection, +to prevent regression with numerous existing endpoints not generating a proper MIME +MJPEG stream. Turning this option on by setting it to 1 will result in a stricter check +of the boundary value. +

+
+ + +

20.16 rawvideo

+ +

Raw video demuxer. +

+

This demuxer allows one to read raw video data. Since there is no header +specifying the assumed video parameters, the user must specify them +in order to be able to decode the data correctly. +

+

This demuxer accepts the following options: +

+
framerate
+

Set input video frame rate. Default value is 25. +

+
+
pixel_format
+

Set the input video pixel format. Default value is yuv420p. +

+
+
video_size
+

Set the input video size. This value must be specified explicitly. +

+
+ +

For example to read a rawvideo file input.raw with +ffplay, assuming a pixel format of rgb24, a video +size of 320x240, and a frame rate of 10 images per second, use +the command: +

+
ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
+
+ + +

20.17 sbg

+ +

SBaGen script demuxer. +

+

This demuxer reads the script language used by SBaGen +http://uazu.net/sbagen/ to generate binaural beats sessions. A SBG +script looks like that: +

+
-SE
+a: 300-2.5/3 440+4.5/0
+b: 300-2.5/0 440+4.5/3
+off: -
+NOW      == a
++0:07:00 == b
++0:14:00 == a
++0:21:00 == b
++0:30:00    off
+
+ +

A SBG script can mix absolute and relative timestamps. If the script uses +either only absolute timestamps (including the script start time) or only +relative ones, then its layout is fixed, and the conversion is +straightforward. On the other hand, if the script mixes both kind of +timestamps, then the NOW reference for relative timestamps will be +taken from the current time of day at the time the script is read, and the +script layout will be frozen according to that reference. That means that if +the script is directly played, the actual times will match the absolute +timestamps up to the sound controller’s clock accuracy, but if the user +somehow pauses the playback or seeks, all times will be shifted accordingly. +

+ +

20.18 tedcaptions

+ +

JSON captions used for TED Talks. +

+

TED does not provide links to the captions, but they can be guessed from the +page. The file tools/bookmarklets.html from the FFmpeg source tree +contains a bookmarklet to expose them. +

+

This demuxer accepts the following option: +

+
start_time
+

Set the start time of the TED talk, in milliseconds. The default is 15000 +(15s). It is used to sync the captions with the downloadable videos, because +they include a 15s intro. +

+
+ +

Example: convert the captions to a format most players understand: +

+
ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
+
+ + +

20.19 vapoursynth

+ +

Vapoursynth wrapper. +

+

Due to security concerns, Vapoursynth scripts will not +be autodetected so the input format has to be forced. For ff* CLI tools, +add -f vapoursynth before the input -i yourscript.vpy. +

+

This demuxer accepts the following option: +

+
max_script_size
+

The demuxer buffers the entire script into memory. Adjust this value to set the maximum buffer size, +which in turn, acts as a ceiling for the size of scripts that can be read. +Default is 1 MiB. +

+
+ + +

21 Muxers

+ +

Muxers are configured elements in FFmpeg which allow writing +multimedia streams to a particular type of file. +

+

When you configure your FFmpeg build, all the supported muxers +are enabled by default. You can list all available muxers using the +configure option --list-muxers. +

+

You can disable all the muxers with the configure option +--disable-muxers and selectively enable / disable single muxers +with the options --enable-muxer=MUXER / +--disable-muxer=MUXER. +

+

The option -muxers of the ff* tools will display the list of +enabled muxers. Use -formats to view a combined list of +enabled demuxers and muxers. +

+

A description of some of the currently available muxers follows. +

+ +

21.1 aiff

+ +

Audio Interchange File Format muxer. +

+ +

21.1.1 Options

+ +

It accepts the following options: +

+
+
write_id3v2
+

Enable ID3v2 tags writing when set to 1. Default is 0 (disabled). +

+
+
id3v2_version
+

Select ID3v2 version to write. Currently only version 3 and 4 (aka. +ID3v2.3 and ID3v2.4) are supported. The default is version 4. +

+
+
+ + +

21.2 asf

+ +

Advanced Systems Format muxer. +

+

Note that Windows Media Audio (wma) and Windows Media Video (wmv) use this +muxer too. +

+ +

21.2.1 Options

+ +

It accepts the following options: +

+
+
packet_size
+

Set the muxer packet size. By tuning this setting you may reduce data +fragmentation or muxer overhead depending on your source. Default value is +3200, minimum is 100, maximum is 64k. +

+
+
+ + +

21.3 avi

+ +

Audio Video Interleaved muxer. +

+ +

21.3.1 Options

+ +

It accepts the following options: +

+
+
reserve_index_space
+

Reserve the specified amount of bytes for the OpenDML master index of each +stream within the file header. By default additional master indexes are +embedded within the data packets if there is no space left in the first master +index and are linked together as a chain of indexes. This index structure can +cause problems for some use cases, e.g. third-party software strictly relying +on the OpenDML index specification or when file seeking is slow. Reserving +enough index space in the file header avoids these problems. +

+

The required index space depends on the output file size and should be about 16 +bytes per gigabyte. When this option is omitted or set to zero the necessary +index space is guessed. +

+
+
write_channel_mask
+

Write the channel layout mask into the audio stream header. +

+

This option is enabled by default. Disabling the channel mask can be useful in +specific scenarios, e.g. when merging multiple audio streams into one for +compatibility with software that only supports a single audio stream in AVI +(see (ffmpeg-filters)the "amerge" section in the ffmpeg-filters manual). +

+
+
+ + +

21.4 chromaprint

+ +

Chromaprint fingerprinter. +

+

This muxer feeds audio data to the Chromaprint library, +which generates a fingerprint for the provided audio data. See https://acoustid.org/chromaprint +

+

It takes a single signed native-endian 16-bit raw audio stream of at most 2 channels. +

+ +

21.4.1 Options

+ +
+
silence_threshold
+

Threshold for detecting silence. Range is from -1 to 32767, where -1 disables +silence detection. Silence detection can only be used with version 3 of the +algorithm. +Silence detection must be disabled for use with the AcoustID service. Default is -1. +

+
+
algorithm
+

Version of algorithm to fingerprint with. Range is 0 to 4. +Version 3 enables silence detection. Default is 1. +

+
+
fp_format
+

Format to output the fingerprint as. Accepts the following options: +

+
‘raw’
+

Binary raw fingerprint +

+
+
‘compressed’
+

Binary compressed fingerprint +

+
+
‘base64’
+

Base64 compressed fingerprint (default) +

+
+
+ +
+
+ + +

21.5 crc

+ +

CRC (Cyclic Redundancy Check) testing format. +

+

This muxer computes and prints the Adler-32 CRC of all the input audio +and video frames. By default audio frames are converted to signed +16-bit raw audio and video frames to raw video before computing the +CRC. +

+

The output of the muxer consists of a single line of the form: +CRC=0xCRC, where CRC is a hexadecimal number 0-padded to +8 digits containing the CRC for all the decoded input frames. +

+

See also the framecrc muxer. +

+ +

21.5.1 Examples

+ +

For example to compute the CRC of the input, and store it in the file +out.crc: +

+
ffmpeg -i INPUT -f crc out.crc
+
+ +

You can print the CRC to stdout with the command: +

+
ffmpeg -i INPUT -f crc -
+
+ +

You can select the output format of each frame with ffmpeg by +specifying the audio and video codec and format. For example to +compute the CRC of the input audio converted to PCM unsigned 8-bit +and the input video converted to MPEG-2 video, use the command: +

+
ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
+
+ + +

21.6 flv

+ +

Adobe Flash Video Format muxer. +

+

This muxer accepts the following options: +

+
+
flvflags flags
+

Possible values: +

+
+
‘aac_seq_header_detect’
+

Place AAC sequence header based on audio stream data. +

+
+
‘no_sequence_end’
+

Disable sequence end tag. +

+
+
‘no_metadata’
+

Disable metadata tag. +

+
+
‘no_duration_filesize’
+

Disable duration and filesize in metadata when they are equal to zero +at the end of stream. (Be used to non-seekable living stream). +

+
+
‘add_keyframe_index’
+

Used to facilitate seeking; particularly for HTTP pseudo streaming. +

+
+
+
+ + +

21.7 dash

+ +

Dynamic Adaptive Streaming over HTTP (DASH) muxer that creates segments +and manifest files according to the MPEG-DASH standard ISO/IEC 23009-1:2014. +

+

For more information see: +

+ + +

It creates a MPD manifest file and segment files for each stream. +

+

The segment filename might contain pre-defined identifiers used with SegmentTemplate +as defined in section 5.3.9.4.4 of the standard. Available identifiers are "$RepresentationID$", +"$Number$", "$Bandwidth$" and "$Time$". +In addition to the standard identifiers, an ffmpeg-specific "$ext$" identifier is also supported. +When specified ffmpeg will replace $ext$ in the file name with muxing format’s extensions such as mp4, webm etc., +

+
+
ffmpeg -re -i <input> -map 0 -map 0 -c:a libfdk_aac -c:v libx264 \
+-b:v:0 800k -b:v:1 300k -s:v:1 320x170 -profile:v:1 baseline \
+-profile:v:0 main -bf 1 -keyint_min 120 -g 120 -sc_threshold 0 \
+-b_strategy 0 -ar:a:1 22050 -use_timeline 1 -use_template 1 \
+-window_size 5 -adaptation_sets "id=0,streams=v id=1,streams=a" \
+-f dash /path/to/out.mpd
+
+ +
+
min_seg_duration microseconds
+

This is a deprecated option to set the segment length in microseconds, use seg_duration instead. +

+
seg_duration duration
+

Set the segment length in seconds (fractional value can be set). The value is +treated as average segment duration when use_template is enabled and +

+
frag_duration duration
+

Set the length in seconds of fragments within segments (fractional value can be set). +

+
frag_type type
+

Set the type of interval for fragmentation. +

+
window_size size
+

Set the maximum number of segments kept in the manifest. +

+
extra_window_size size
+

Set the maximum number of segments kept outside of the manifest before removing from disk. +

+
remove_at_exit remove
+

Enable (1) or disable (0) removal of all segments when finished. +

+
use_template template
+

Enable (1) or disable (0) use of SegmentTemplate instead of SegmentList. +

+
use_timeline timeline
+

Enable (1) or disable (0) use of SegmentTimeline in SegmentTemplate. +

+
single_file single_file
+

Enable (1) or disable (0) storing all segments in one file, accessed using byte ranges. +

+
single_file_name file_name
+

DASH-templated name to be used for baseURL. Implies single_file set to "1". In the template, "$ext$" is replaced with the file name extension specific for the segment format. +

+
init_seg_name init_name
+

DASH-templated name to used for the initialization segment. Default is "init-stream$RepresentationID$.$ext$". "$ext$" is replaced with the file name extension specific for the segment format. +

+
media_seg_name segment_name
+

DASH-templated name to used for the media segments. Default is "chunk-stream$RepresentationID$-$Number%05d$.$ext$". "$ext$" is replaced with the file name extension specific for the segment format. +

+
utc_timing_url utc_url
+

URL of the page that will return the UTC timestamp in ISO format. Example: "https://time.akamai.com/?iso" +

+
method method
+

Use the given HTTP method to create output files. Generally set to PUT or POST. +

+
http_user_agent user_agent
+

Override User-Agent field in HTTP header. Applicable only for HTTP output. +

+
http_persistent http_persistent
+

Use persistent HTTP connections. Applicable only for HTTP output. +

+
hls_playlist hls_playlist
+

Generate HLS playlist files as well. The master playlist is generated with the filename master.m3u8. +One media playlist file is generated for each stream with filenames media_0.m3u8, media_1.m3u8, etc. +

+
streaming streaming
+

Enable (1) or disable (0) chunk streaming mode of output. In chunk streaming +mode, each frame will be a moof fragment which forms a chunk. +

+
adaptation_sets adaptation_sets
+

Assign streams to AdaptationSets. Syntax is "id=x,streams=a,b,c id=y,streams=d,e" with x and y being the IDs +of the adaptation sets and a,b,c,d and e are the indices of the mapped streams. +

+

To map all video (or audio) streams to an AdaptationSet, "v" (or "a") can be used as stream identifier instead of IDs. +

+

When no assignment is defined, this defaults to an AdaptationSet for each stream. +

+

Optional syntax is "id=x,seg_duration=x,frag_duration=x,frag_type=type,descriptor=descriptor_string,streams=a,b,c id=y,seg_duration=y,frag_type=type,streams=d,e" and so on, +descriptor is useful to the scheme defined by ISO/IEC 23009-1:2014/Amd.2:2015. +For example, -adaptation_sets "id=0,descriptor=<SupplementalProperty schemeIdUri=\"urn:mpeg:dash:srd:2014\" value=\"0,0,0,1,1,2,2\"/>,streams=v". +Please note that descriptor string should be a self-closing xml tag. +seg_duration, frag_duration and frag_type override the global option values for each adaptation set. +For example, -adaptation_sets "id=0,seg_duration=2,frag_duration=1,frag_type=duration,streams=v id=1,seg_duration=2,frag_type=none,streams=a" +type_id marks an adaptation set as containing streams meant to be used for Trick Mode for the referenced adaptation set. +For example, -adaptation_sets "id=0,seg_duration=2,frag_type=none,streams=0 id=1,seg_duration=10,frag_type=none,trick_id=0,streams=1" +

+
timeout timeout
+

Set timeout for socket I/O operations. Applicable only for HTTP output. +

+
index_correction index_correction
+

Enable (1) or Disable (0) segment index correction logic. Applicable only when +use_template is enabled and use_timeline is disabled. +

+

When enabled, the logic monitors the flow of segment indexes. If a streams’s +segment index value is not at the expected real time position, then the logic +corrects that index value. +

+

Typically this logic is needed in live streaming use cases. The network bandwidth +fluctuations are common during long run streaming. Each fluctuation can cause +the segment indexes fall behind the expected real time position. +

+
format_options options_list
+

Set container format (mp4/webm) options using a : separated list of +key=value parameters. Values containing : special characters must be +escaped. +

+
+
global_sidx global_sidx
+

Write global SIDX atom. Applicable only for single file, mp4 output, non-streaming mode. +

+
+
dash_segment_type dash_segment_type
+

Possible values: +

+
auto
+

If this flag is set, the dash segment files format will be selected based on the stream codec. This is the default mode. +

+
+
mp4
+

If this flag is set, the dash segment files will be in in ISOBMFF format. +

+
+
webm
+

If this flag is set, the dash segment files will be in in WebM format. +

+
+ +
+
ignore_io_errors ignore_io_errors
+

Ignore IO errors during open and write. Useful for long-duration runs with network output. +

+
+
lhls lhls
+

Enable Low-latency HLS(LHLS). Adds #EXT-X-PREFETCH tag with current segment’s URI. +Apple doesn’t have an official spec for LHLS. Meanwhile hls.js player folks are +trying to standardize a open LHLS spec. The draft spec is available in https://github.com/video-dev/hlsjs-rfcs/blob/lhls-spec/proposals/0001-lhls.md +This option will also try to comply with the above open spec, till Apple’s spec officially supports it. +Applicable only when streaming and hls_playlist options are enabled. +This is an experimental feature. +

+
+
ldash ldash
+

Enable Low-latency Dash by constraining the presence and values of some elements. +

+
+
master_m3u8_publish_rate master_m3u8_publish_rate
+

Publish master playlist repeatedly every after specified number of segment intervals. +

+
+
write_prft write_prft
+

Write Producer Reference Time elements on supported streams. This also enables writing +prft boxes in the underlying muxer. Applicable only when the utc_url option is enabled. +It’s set to auto by default, in which case the muxer will attempt to enable it only in modes +that require it. +

+
+
mpd_profile mpd_profile
+

Set one or more manifest profiles. +

+
+
http_opts http_opts
+

A :-separated list of key=value options to pass to the underlying HTTP +protocol. Applicable only for HTTP output. +

+
+
target_latency target_latency
+

Set an intended target latency in seconds (fractional value can be set) for serving. Applicable only when streaming and write_prft options are enabled. +This is an informative fields clients can use to measure the latency of the service. +

+
+
min_playback_rate min_playback_rate
+

Set the minimum playback rate indicated as appropriate for the purposes of automatically +adjusting playback latency and buffer occupancy during normal playback by clients. +

+
+
max_playback_rate max_playback_rate
+

Set the maximum playback rate indicated as appropriate for the purposes of automatically +adjusting playback latency and buffer occupancy during normal playback by clients. +

+
+
+ + +

21.8 framecrc

+ +

Per-packet CRC (Cyclic Redundancy Check) testing format. +

+

This muxer computes and prints the Adler-32 CRC for each audio +and video packet. By default audio frames are converted to signed +16-bit raw audio and video frames to raw video before computing the +CRC. +

+

The output of the muxer consists of a line for each audio and video +packet of the form: +

+
stream_index, packet_dts, packet_pts, packet_duration, packet_size, 0xCRC
+
+ +

CRC is a hexadecimal number 0-padded to 8 digits containing the +CRC of the packet. +

+ +

21.8.1 Examples

+ +

For example to compute the CRC of the audio and video frames in +INPUT, converted to raw audio and video packets, and store it +in the file out.crc: +

+
ffmpeg -i INPUT -f framecrc out.crc
+
+ +

To print the information to stdout, use the command: +

+
ffmpeg -i INPUT -f framecrc -
+
+ +

With ffmpeg, you can select the output format to which the +audio and video frames are encoded before computing the CRC for each +packet by specifying the audio and video codec. For example, to +compute the CRC of each decoded input audio frame converted to PCM +unsigned 8-bit and of each decoded input video frame converted to +MPEG-2 video, use the command: +

+
ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
+
+ +

See also the crc muxer. +

+ +

21.9 framehash

+ +

Per-packet hash testing format. +

+

This muxer computes and prints a cryptographic hash for each audio +and video packet. This can be used for packet-by-packet equality +checks without having to individually do a binary comparison on each. +

+

By default audio frames are converted to signed 16-bit raw audio and +video frames to raw video before computing the hash, but the output +of explicit conversions to other codecs can also be used. It uses the +SHA-256 cryptographic hash function by default, but supports several +other algorithms. +

+

The output of the muxer consists of a line for each audio and video +packet of the form: +

+
stream_index, packet_dts, packet_pts, packet_duration, packet_size, hash
+
+ +

hash is a hexadecimal number representing the computed hash +for the packet. +

+
+
hash algorithm
+

Use the cryptographic hash function specified by the string algorithm. +Supported values include MD5, murmur3, RIPEMD128, +RIPEMD160, RIPEMD256, RIPEMD320, SHA160, +SHA224, SHA256 (default), SHA512/224, SHA512/256, +SHA384, SHA512, CRC32 and adler32. +

+
+
+ + +

21.9.1 Examples

+ +

To compute the SHA-256 hash of the audio and video frames in INPUT, +converted to raw audio and video packets, and store it in the file +out.sha256: +

+
ffmpeg -i INPUT -f framehash out.sha256
+
+ +

To print the information to stdout, using the MD5 hash function, use +the command: +

+
ffmpeg -i INPUT -f framehash -hash md5 -
+
+ +

See also the hash muxer. +

+ +

21.10 framemd5

+ +

Per-packet MD5 testing format. +

+

This is a variant of the framehash muxer. Unlike that muxer, +it defaults to using the MD5 hash function. +

+ +

21.10.1 Examples

+ +

To compute the MD5 hash of the audio and video frames in INPUT, +converted to raw audio and video packets, and store it in the file +out.md5: +

+
ffmpeg -i INPUT -f framemd5 out.md5
+
+ +

To print the information to stdout, use the command: +

+
ffmpeg -i INPUT -f framemd5 -
+
+ +

See also the framehash and md5 muxers. +

+ +

21.11 gif

+ +

Animated GIF muxer. +

+

It accepts the following options: +

+
+
loop
+

Set the number of times to loop the output. Use -1 for no loop, 0 +for looping indefinitely (default). +

+
+
final_delay
+

Force the delay (expressed in centiseconds) after the last frame. Each frame +ends with a delay until the next frame. The default is -1, which is a +special value to tell the muxer to re-use the previous delay. In case of a +loop, you might want to customize this value to mark a pause for instance. +

+
+ +

For example, to encode a gif looping 10 times, with a 5 seconds delay between +the loops: +

+
ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
+
+ +

Note 1: if you wish to extract the frames into separate GIF files, you need to +force the image2 muxer: +

+
ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
+
+ +

Note 2: the GIF format has a very large time base: the delay between two frames +can therefore not be smaller than one centi second. +

+ +

21.12 hash

+ +

Hash testing format. +

+

This muxer computes and prints a cryptographic hash of all the input +audio and video frames. This can be used for equality checks without +having to do a complete binary comparison. +

+

By default audio frames are converted to signed 16-bit raw audio and +video frames to raw video before computing the hash, but the output +of explicit conversions to other codecs can also be used. Timestamps +are ignored. It uses the SHA-256 cryptographic hash function by default, +but supports several other algorithms. +

+

The output of the muxer consists of a single line of the form: +algo=hash, where algo is a short string representing +the hash function used, and hash is a hexadecimal number +representing the computed hash. +

+
+
hash algorithm
+

Use the cryptographic hash function specified by the string algorithm. +Supported values include MD5, murmur3, RIPEMD128, +RIPEMD160, RIPEMD256, RIPEMD320, SHA160, +SHA224, SHA256 (default), SHA512/224, SHA512/256, +SHA384, SHA512, CRC32 and adler32. +

+
+
+ + +

21.12.1 Examples

+ +

To compute the SHA-256 hash of the input converted to raw audio and +video, and store it in the file out.sha256: +

+
ffmpeg -i INPUT -f hash out.sha256
+
+ +

To print an MD5 hash to stdout use the command: +

+
ffmpeg -i INPUT -f hash -hash md5 -
+
+ +

See also the framehash muxer. +

+ +

21.13 hls

+ +

Apple HTTP Live Streaming muxer that segments MPEG-TS according to +the HTTP Live Streaming (HLS) specification. +

+

It creates a playlist file, and one or more segment files. The output filename +specifies the playlist filename. +

+

By default, the muxer creates a file for each segment produced. These files +have the same name as the playlist, followed by a sequential number and a +.ts extension. +

+

Make sure to require a closed GOP when encoding and to set the GOP +size to fit your segment time constraint. +

+

For example, to convert an input file with ffmpeg: +

+
ffmpeg -i in.mkv -c:v h264 -flags +cgop -g 30 -hls_time 1 out.m3u8
+
+

This example will produce the playlist, out.m3u8, and segment files: +out0.ts, out1.ts, out2.ts, etc. +

+

See also the segment muxer, which provides a more generic and +flexible implementation of a segmenter, and can be used to perform HLS +segmentation. +

+ +

21.13.1 Options

+ +

This muxer supports the following options: +

+
+
hls_init_time seconds
+

Set the initial target segment length in seconds. Default value is 0. +Segment will be cut on the next key frame after this time has passed on the first m3u8 list. +After the initial playlist is filled ffmpeg will cut segments +at duration equal to hls_time +

+
+
hls_time seconds
+

Set the target segment length in seconds. Default value is 2. +Segment will be cut on the next key frame after this time has passed. +

+
+
hls_list_size size
+

Set the maximum number of playlist entries. If set to 0 the list file +will contain all the segments. Default value is 5. +

+
+
hls_delete_threshold size
+

Set the number of unreferenced segments to keep on disk before hls_flags delete_segments +deletes them. Increase this to allow continue clients to download segments which +were recently referenced in the playlist. Default value is 1, meaning segments older than +hls_list_size+1 will be deleted. +

+
+
hls_ts_options options_list
+

Set output format options using a :-separated list of key=value +parameters. Values containing : special characters must be +escaped. +

+
+
hls_wrap wrap
+

This is a deprecated option, you can use hls_list_size +and hls_flags delete_segments instead it +

+

This option is useful to avoid to fill the disk with many segment +files, and limits the maximum number of segment files written to disk +to wrap. +

+ +
+
hls_start_number_source
+

Start the playlist sequence number (#EXT-X-MEDIA-SEQUENCE) according to the specified source. +Unless hls_flags single_file is set, it also specifies source of starting sequence numbers of +segment and subtitle filenames. In any case, if hls_flags append_list +is set and read playlist sequence number is greater than the specified start sequence number, +then that value will be used as start value. +

+

It accepts the following values: +

+
+
generic (default)
+

Set the starting sequence numbers according to start_number option value. +

+
+
epoch
+

The start number will be the seconds since epoch (1970-01-01 00:00:00) +

+
+
epoch_us
+

The start number will be the microseconds since epoch (1970-01-01 00:00:00) +

+
+
datetime
+

The start number will be based on the current date/time as YYYYmmddHHMMSS. e.g. 20161231235759. +

+
+
+ +
+
start_number number
+

Start the playlist sequence number (#EXT-X-MEDIA-SEQUENCE) from the specified number +when hls_start_number_source value is generic. (This is the default case.) +Unless hls_flags single_file is set, it also specifies starting sequence numbers of segment and subtitle filenames. +Default value is 0. +

+
+
hls_allow_cache allowcache
+

Explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments. +

+
+
hls_base_url baseurl
+

Append baseurl to every entry in the playlist. +Useful to generate playlists with absolute paths. +

+

Note that the playlist sequence number must be unique for each segment +and it is not to be confused with the segment filename sequence number +which can be cyclic, for example if the wrap option is +specified. +

+
+
hls_segment_filename filename
+

Set the segment filename. Unless hls_flags single_file is set, +filename is used as a string format with the segment number: +

+
ffmpeg -i in.nut -hls_segment_filename 'file%03d.ts' out.m3u8
+
+

This example will produce the playlist, out.m3u8, and segment files: +file000.ts, file001.ts, file002.ts, etc. +

+

filename may contain full path or relative path specification, +but only the file name part without any path info will be contained in the m3u8 segment list. +Should a relative path be specified, the path of the created segment +files will be relative to the current working directory. +When strftime_mkdir is set, the whole expanded value of filename will be written into the m3u8 segment list. +

+

When var_stream_map is set with two or more variant streams, the +filename pattern must contain the string "%v", this string specifies +the position of variant stream index in the generated segment file names. +

+
ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
+  -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
+  -hls_segment_filename 'file_%v_%03d.ts' out_%v.m3u8
+
+

This example will produce the playlists segment file sets: +file_0_000.ts, file_0_001.ts, file_0_002.ts, etc. and +file_1_000.ts, file_1_001.ts, file_1_002.ts, etc. +

+

The string "%v" may be present in the filename or in the last directory name +containing the file, but only in one of them. (Additionally, %v may appear multiple times in the last +sub-directory or filename.) If the string %v is present in the directory name, then +sub-directories are created after expanding the directory name pattern. This +enables creation of segments corresponding to different variant streams in +subdirectories. +

+
ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
+  -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
+  -hls_segment_filename 'vs%v/file_%03d.ts' vs%v/out.m3u8
+
+

This example will produce the playlists segment file sets: +vs0/file_000.ts, vs0/file_001.ts, vs0/file_002.ts, etc. and +vs1/file_000.ts, vs1/file_001.ts, vs1/file_002.ts, etc. +

+
+
use_localtime
+

Same as strftime option, will be deprecated. +

+
+
strftime
+

Use strftime() on filename to expand the segment filename with localtime. +The segment number is also available in this mode, but to use it, you need to specify second_level_segment_index +hls_flag and %%d will be the specifier. +

+
ffmpeg -i in.nut -strftime 1 -hls_segment_filename 'file-%Y%m%d-%s.ts' out.m3u8
+
+

This example will produce the playlist, out.m3u8, and segment files: +file-20160215-1455569023.ts, file-20160215-1455569024.ts, etc. +Note: On some systems/environments, the %s specifier is not available. See + strftime() documentation. +

+
ffmpeg -i in.nut -strftime 1 -hls_flags second_level_segment_index -hls_segment_filename 'file-%Y%m%d-%%04d.ts' out.m3u8
+
+

This example will produce the playlist, out.m3u8, and segment files: +file-20160215-0001.ts, file-20160215-0002.ts, etc. +

+
+
use_localtime_mkdir
+

Same as strftime_mkdir option, will be deprecated . +

+
+
strftime_mkdir
+

Used together with -strftime_mkdir, it will create all subdirectories which +is expanded in filename. +

+
ffmpeg -i in.nut -strftime 1 -strftime_mkdir 1 -hls_segment_filename '%Y%m%d/file-%Y%m%d-%s.ts' out.m3u8
+
+

This example will create a directory 201560215 (if it does not exist), and then +produce the playlist, out.m3u8, and segment files: +20160215/file-20160215-1455569023.ts, 20160215/file-20160215-1455569024.ts, etc. +

+
+
ffmpeg -i in.nut -strftime 1 -strftime_mkdir 1 -hls_segment_filename '%Y/%m/%d/file-%Y%m%d-%s.ts' out.m3u8
+
+

This example will create a directory hierarchy 2016/02/15 (if any of them do not exist), and then +produce the playlist, out.m3u8, and segment files: +2016/02/15/file-20160215-1455569023.ts, 2016/02/15/file-20160215-1455569024.ts, etc. +

+ +
+
hls_key_info_file key_info_file
+

Use the information in key_info_file for segment encryption. The first +line of key_info_file specifies the key URI written to the playlist. The +key URL is used to access the encryption key during playback. The second line +specifies the path to the key file used to obtain the key during the encryption +process. The key file is read as a single packed array of 16 octets in binary +format. The optional third line specifies the initialization vector (IV) as a +hexadecimal string to be used instead of the segment sequence number (default) +for encryption. Changes to key_info_file will result in segment +encryption with the new key/IV and an entry in the playlist for the new key +URI/IV if hls_flags periodic_rekey is enabled. +

+

Key info file format: +

+
key URI
+key file path
+IV (optional)
+
+ +

Example key URIs: +

+
http://server/file.key
+/path/to/file.key
+file.key
+
+ +

Example key file paths: +

+
file.key
+/path/to/file.key
+
+ +

Example IV: +

+
0123456789ABCDEF0123456789ABCDEF
+
+ +

Key info file example: +

+
http://server/file.key
+/path/to/file.key
+0123456789ABCDEF0123456789ABCDEF
+
+ +

Example shell script: +

+
#!/bin/sh
+BASE_URL=${1:-'.'}
+openssl rand 16 > file.key
+echo $BASE_URL/file.key > file.keyinfo
+echo file.key >> file.keyinfo
+echo $(openssl rand -hex 16) >> file.keyinfo
+ffmpeg -f lavfi -re -i testsrc -c:v h264 -hls_flags delete_segments \
+  -hls_key_info_file file.keyinfo out.m3u8
+
+ +
+
-hls_enc enc
+

Enable (1) or disable (0) the AES128 encryption. +When enabled every segment generated is encrypted and the encryption key +is saved as playlist name.key. +

+
+
-hls_enc_key key
+

Hex-coded 16byte key to encrypt the segments, by default it +is randomly generated. +

+
+
-hls_enc_key_url keyurl
+

If set, keyurl is prepended instead of baseurl to the key filename +in the playlist. +

+
+
-hls_enc_iv iv
+

Hex-coded 16byte initialization vector for every segment instead +of the autogenerated ones. +

+
+
hls_segment_type flags
+

Possible values: +

+
+
‘mpegts’
+

Output segment files in MPEG-2 Transport Stream format. This is +compatible with all HLS versions. +

+
+
‘fmp4’
+

Output segment files in fragmented MP4 format, similar to MPEG-DASH. +fmp4 files may be used in HLS version 7 and above. +

+
+
+ +
+
hls_fmp4_init_filename filename
+

Set filename to the fragment files header file, default filename is init.mp4. +

+
+
hls_fmp4_init_resend
+

Resend init file after m3u8 file refresh every time, default is 0. +

+

When var_stream_map is set with two or more variant streams, the +filename pattern must contain the string "%v", this string specifies +the position of variant stream index in the generated init file names. +The string "%v" may be present in the filename or in the last directory name +containing the file. If the string is present in the directory name, then +sub-directories are created after expanding the directory name pattern. This +enables creation of init files corresponding to different variant streams in +subdirectories. +

+
+
hls_flags flags
+

Possible values: +

+
+
‘single_file’
+

If this flag is set, the muxer will store all segments in a single MPEG-TS +file, and will use byte ranges in the playlist. HLS playlists generated with +this way will have the version number 4. +For example: +

+
ffmpeg -i in.nut -hls_flags single_file out.m3u8
+
+

Will produce the playlist, out.m3u8, and a single segment file, +out.ts. +

+
+
‘delete_segments’
+

Segment files removed from the playlist are deleted after a period of time +equal to the duration of the segment plus the duration of the playlist. +

+
+
‘append_list’
+

Append new segments into the end of old segment list, +and remove the #EXT-X-ENDLIST from the old segment list. +

+
+
‘round_durations’
+

Round the duration info in the playlist file segment info to integer +values, instead of using floating point. +

+
+
‘discont_start’
+

Add the #EXT-X-DISCONTINUITY tag to the playlist, before the +first segment’s information. +

+
+
‘omit_endlist’
+

Do not append the EXT-X-ENDLIST tag at the end of the playlist. +

+
+
‘periodic_rekey’
+

The file specified by hls_key_info_file will be checked periodically and +detect updates to the encryption info. Be sure to replace this file atomically, +including the file containing the AES encryption key. +

+
+
‘independent_segments’
+

Add the #EXT-X-INDEPENDENT-SEGMENTS to playlists that has video segments +and when all the segments of that playlist are guaranteed to start with a Key frame. +

+
+
‘iframes_only’
+

Add the #EXT-X-I-FRAMES-ONLY to playlists that has video segments +and can play only I-frames in the #EXT-X-BYTERANGE mode. +

+
+
‘split_by_time’
+

Allow segments to start on frames other than keyframes. This improves +behavior on some players when the time between keyframes is inconsistent, +but may make things worse on others, and can cause some oddities during +seeking. This flag should be used with the hls_time option. +

+
+
‘program_date_time’
+

Generate EXT-X-PROGRAM-DATE-TIME tags. +

+
+
‘second_level_segment_index’
+

Makes it possible to use segment indexes as %%d in hls_segment_filename expression +besides date/time values when strftime is on. +To get fixed width numbers with trailing zeroes, %%0xd format is available where x is the required width. +

+
+
‘second_level_segment_size’
+

Makes it possible to use segment sizes (counted in bytes) as %%s in hls_segment_filename +expression besides date/time values when strftime is on. +To get fixed width numbers with trailing zeroes, %%0xs format is available where x is the required width. +

+
+
‘second_level_segment_duration’
+

Makes it possible to use segment duration (calculated in microseconds) as %%t in hls_segment_filename +expression besides date/time values when strftime is on. +To get fixed width numbers with trailing zeroes, %%0xt format is available where x is the required width. +

+
+
ffmpeg -i sample.mpeg \
+   -f hls -hls_time 3 -hls_list_size 5 \
+   -hls_flags second_level_segment_index+second_level_segment_size+second_level_segment_duration \
+   -strftime 1 -strftime_mkdir 1 -hls_segment_filename "segment_%Y%m%d%H%M%S_%%04d_%%08s_%%013t.ts" stream.m3u8
+
+

This will produce segments like this: +segment_20170102194334_0003_00122200_0000003000000.ts, segment_20170102194334_0004_00120072_0000003000000.ts etc. +

+
+
‘temp_file’
+

Write segment data to filename.tmp and rename to filename only once the segment is complete. A webserver +serving up segments can be configured to reject requests to *.tmp to prevent access to in-progress segments +before they have been added to the m3u8 playlist. This flag also affects how m3u8 playlist files are created. +If this flag is set, all playlist files will written into temporary file and renamed after they are complete, similarly as segments are handled. +But playlists with file protocol and with type (hls_playlist_type) other than vod +are always written into temporary file regardless of this flag. Master playlist files (master_pl_name), if any, with file protocol, +are always written into temporary file regardless of this flag if master_pl_publish_rate value is other than zero. +

+
+
+ +
+
hls_playlist_type event
+

Emit #EXT-X-PLAYLIST-TYPE:EVENT in the m3u8 header. Forces +hls_list_size to 0; the playlist can only be appended to. +

+
+
hls_playlist_type vod
+

Emit #EXT-X-PLAYLIST-TYPE:VOD in the m3u8 header. Forces +hls_list_size to 0; the playlist must not change. +

+
+
method
+

Use the given HTTP method to create the hls files. +

+
ffmpeg -re -i in.ts -f hls -method PUT http://example.com/live/out.m3u8
+
+

This example will upload all the mpegts segment files to the HTTP +server using the HTTP PUT method, and update the m3u8 files every +refresh times using the same method. +Note that the HTTP server must support the given method for uploading +files. +

+
+
http_user_agent
+

Override User-Agent field in HTTP header. Applicable only for HTTP output. +

+
+
var_stream_map
+

Map string which specifies how to group the audio, video and subtitle streams +into different variant streams. The variant stream groups are separated +by space. +Expected string format is like this "a:0,v:0 a:1,v:1 ....". Here a:, v:, s: are +the keys to specify audio, video and subtitle streams respectively. +Allowed values are 0 to 9 (limited just based on practical usage). +

+

When there are two or more variant streams, the output filename pattern must +contain the string "%v", this string specifies the position of variant stream +index in the output media playlist filenames. The string "%v" may be present in +the filename or in the last directory name containing the file. If the string is +present in the directory name, then sub-directories are created after expanding +the directory name pattern. This enables creation of variant streams in +subdirectories. +

+
+
ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
+  -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
+  http://example.com/live/out_%v.m3u8
+
+

This example creates two hls variant streams. The first variant stream will +contain video stream of bitrate 1000k and audio stream of bitrate 64k and the +second variant stream will contain video stream of bitrate 256k and audio +stream of bitrate 32k. Here, two media playlist with file names out_0.m3u8 and +out_1.m3u8 will be created. If you want something meaningful text instead of indexes +in result names, you may specify names for each or some of the variants +as in the following example. +

+ +
+
ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
+  -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0,name:my_hd v:1,a:1,name:my_sd" \
+  http://example.com/live/out_%v.m3u8
+
+ +

This example creates two hls variant streams as in the previous one. +But here, the two media playlist with file names out_my_hd.m3u8 and +out_my_sd.m3u8 will be created. +

+
+
ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k \
+  -map 0:v -map 0:a -map 0:v -f hls -var_stream_map "v:0 a:0 v:1" \
+  http://example.com/live/out_%v.m3u8
+
+

This example creates three hls variant streams. The first variant stream will +be a video only stream with video bitrate 1000k, the second variant stream will +be an audio only stream with bitrate 64k and the third variant stream will be a +video only stream with bitrate 256k. Here, three media playlist with file names +out_0.m3u8, out_1.m3u8 and out_2.m3u8 will be created. +

+
ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
+  -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
+  http://example.com/live/vs_%v/out.m3u8
+
+

This example creates the variant streams in subdirectories. Here, the first +media playlist is created at http://example.com/live/vs_0/out.m3u8 and +the second one at http://example.com/live/vs_1/out.m3u8. +

+
ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k -b:v:1 3000k  \
+  -map 0:a -map 0:a -map 0:v -map 0:v -f hls \
+  -var_stream_map "a:0,agroup:aud_low a:1,agroup:aud_high v:0,agroup:aud_low v:1,agroup:aud_high" \
+  -master_pl_name master.m3u8 \
+  http://example.com/live/out_%v.m3u8
+
+

This example creates two audio only and two video only variant streams. In +addition to the #EXT-X-STREAM-INF tag for each variant stream in the master +playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams +and they are mapped to the two video only variant streams with audio group names +’aud_low’ and ’aud_high’. +

+

By default, a single hls variant containing all the encoded streams is created. +

+
+
ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k \
+  -map 0:a -map 0:a -map 0:v -f hls \
+  -var_stream_map "a:0,agroup:aud_low,default:yes a:1,agroup:aud_low v:0,agroup:aud_low" \
+  -master_pl_name master.m3u8 \
+  http://example.com/live/out_%v.m3u8
+
+

This example creates two audio only and one video only variant streams. In +addition to the #EXT-X-STREAM-INF tag for each variant stream in the master +playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams +and they are mapped to the one video only variant streams with audio group name +’aud_low’, and the audio group have default stat is NO or YES. +

+

By default, a single hls variant containing all the encoded streams is created. +

+
+
ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k \
+  -map 0:a -map 0:a -map 0:v -f hls \
+  -var_stream_map "a:0,agroup:aud_low,default:yes,language:ENG a:1,agroup:aud_low,language:CHN v:0,agroup:aud_low" \
+  -master_pl_name master.m3u8 \
+  http://example.com/live/out_%v.m3u8
+
+

This example creates two audio only and one video only variant streams. In +addition to the #EXT-X-STREAM-INF tag for each variant stream in the master +playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams +and they are mapped to the one video only variant streams with audio group name +’aud_low’, and the audio group have default stat is NO or YES, and one audio +have and language is named ENG, the other audio language is named CHN. +

+

By default, a single hls variant containing all the encoded streams is created. +

+
+
ffmpeg -y -i input_with_subtitle.mkv \
+ -b:v:0 5250k -c:v h264 -pix_fmt yuv420p -profile:v main -level 4.1 \
+ -b:a:0 256k \
+ -c:s webvtt -c:a mp2 -ar 48000 -ac 2 -map 0:v -map 0:a:0 -map 0:s:0 \
+ -f hls -var_stream_map "v:0,a:0,s:0,sgroup:subtitle" \
+ -master_pl_name master.m3u8 -t 300 -hls_time 10 -hls_init_time 4 -hls_list_size \
+ 10 -master_pl_publish_rate 10  -hls_flags \
+ delete_segments+discont_start+split_by_time ./tmp/video.m3u8
+
+ +

This example adds #EXT-X-MEDIA tag with TYPE=SUBTITLES in +the master playlist with webvtt subtitle group name ’subtitle’. Please make sure +the input file has one text subtitle stream at least. +

+
+
cc_stream_map
+

Map string which specifies different closed captions groups and their +attributes. The closed captions stream groups are separated by space. +Expected string format is like this +"ccgroup:<group name>,instreamid:<INSTREAM-ID>,language:<language code> ....". +’ccgroup’ and ’instreamid’ are mandatory attributes. ’language’ is an optional +attribute. +The closed captions groups configured using this option are mapped to different +variant streams by providing the same ’ccgroup’ name in the +var_stream_map string. If var_stream_map is not set, then the +first available ccgroup in cc_stream_map is mapped to the output variant +stream. The examples for these two use cases are given below. +

+
+
ffmpeg -re -i in.ts -b:v 1000k -b:a 64k -a53cc 1 -f hls \
+  -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en" \
+  -master_pl_name master.m3u8 \
+  http://example.com/live/out.m3u8
+
+

This example adds #EXT-X-MEDIA tag with TYPE=CLOSED-CAPTIONS in +the master playlist with group name ’cc’, language ’en’ (english) and +INSTREAM-ID ’CC1’. Also, it adds CLOSED-CAPTIONS attribute with group +name ’cc’ for the output variant stream. +

+
ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
+  -a53cc:0 1 -a53cc:1 1\
+  -map 0:v -map 0:a -map 0:v -map 0:a -f hls \
+  -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en ccgroup:cc,instreamid:CC2,language:sp" \
+  -var_stream_map "v:0,a:0,ccgroup:cc v:1,a:1,ccgroup:cc" \
+  -master_pl_name master.m3u8 \
+  http://example.com/live/out_%v.m3u8
+
+

This example adds two #EXT-X-MEDIA tags with TYPE=CLOSED-CAPTIONS in +the master playlist for the INSTREAM-IDs ’CC1’ and ’CC2’. Also, it adds +CLOSED-CAPTIONS attribute with group name ’cc’ for the two output variant +streams. +

+
+
master_pl_name
+

Create HLS master playlist with the given name. +

+
+
ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 http://example.com/live/out.m3u8
+
+

This example creates HLS master playlist with name master.m3u8 and it is +published at http://example.com/live/ +

+
+
master_pl_publish_rate
+

Publish master play list repeatedly every after specified number of segment intervals. +

+
+
ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 \
+-hls_time 2 -master_pl_publish_rate 30 http://example.com/live/out.m3u8
+
+ +

This example creates HLS master playlist with name master.m3u8 and keep +publishing it repeatedly every after 30 segments i.e. every after 60s. +

+
+
http_persistent
+

Use persistent HTTP connections. Applicable only for HTTP output. +

+
+
timeout
+

Set timeout for socket I/O operations. Applicable only for HTTP output. +

+
+
-ignore_io_errors
+

Ignore IO errors during open, write and delete. Useful for long-duration runs with network output. +

+
+
headers
+

Set custom HTTP headers, can override built in default headers. Applicable only for HTTP output. +

+
+
+ + +

21.14 ico

+ +

ICO file muxer. +

+

Microsoft’s icon file format (ICO) has some strict limitations that should be noted: +

+
    +
  • Size cannot exceed 256 pixels in any dimension + +
  • Only BMP and PNG images can be stored + +
  • If a BMP image is used, it must be one of the following pixel formats: +
    +
    BMP Bit Depth      FFmpeg Pixel Format
+1bit               pal8
+4bit               pal8
+8bit               pal8
+16bit              rgb555le
+24bit              bgr24
+32bit              bgra
+
    + +
  • If a BMP image is used, it must use the BITMAPINFOHEADER DIB header + +
  • If a PNG image is used, it must use the rgba pixel format +
+ + +

21.15 image2

+ +

Image file muxer. +

+

The image file muxer writes video frames to image files. +

+

The output filenames are specified by a pattern, which can be used to +produce sequentially numbered series of files. +The pattern may contain the string "%d" or "%0Nd", this string +specifies the position of the characters representing a numbering in +the filenames. If the form "%0Nd" is used, the string +representing the number in each filename is 0-padded to N +digits. The literal character ’%’ can be specified in the pattern with +the string "%%". +

+

If the pattern contains "%d" or "%0Nd", the first filename of +the file list specified will contain the number 1, all the following +numbers will be sequential. +

+

The pattern may contain a suffix which is used to automatically +determine the format of the image files to write. +

+

For example the pattern "img-%03d.bmp" will specify a sequence of +filenames of the form img-001.bmp, img-002.bmp, ..., +img-010.bmp, etc. +The pattern "img%%-%d.jpg" will specify a sequence of filenames of the +form img%-1.jpg, img%-2.jpg, ..., img%-10.jpg, +etc. +

+

The image muxer supports the .Y.U.V image file format. This format is +special in that that each image frame consists of three files, for +each of the YUV420P components. To read or write this image file format, +specify the name of the ’.Y’ file. The muxer will automatically open the +’.U’ and ’.V’ files as required. +

+ +

21.15.1 Options

+ +
+
frame_pts
+

If set to 1, expand the filename with pts from pkt->pts. +Default value is 0. +

+
+
start_number
+

Start the sequence from the specified number. Default value is 1. +

+
+
update
+

If set to 1, the filename will always be interpreted as just a +filename, not a pattern, and the corresponding file will be continuously +overwritten with new images. Default value is 0. +

+
+
strftime
+

If set to 1, expand the filename with date and time information from +strftime(). Default value is 0. +

+
+
protocol_opts options_list
+

Set protocol options as a :-separated list of key=value parameters. Values +containing the : special character must be escaped. +

+
+
+ + +

21.15.2 Examples

+ +

The following example shows how to use ffmpeg for creating a +sequence of files img-001.jpeg, img-002.jpeg, ..., +taking one image every second from the input video: +

+
ffmpeg -i in.avi -vsync cfr -r 1 -f image2 'img-%03d.jpeg'
+
+ +

Note that with ffmpeg, if the format is not specified with the +-f option and the output filename specifies an image file +format, the image2 muxer is automatically selected, so the previous +command can be written as: +

+
ffmpeg -i in.avi -vsync cfr -r 1 'img-%03d.jpeg'
+
+ +

Note also that the pattern must not necessarily contain "%d" or +"%0Nd", for example to create a single image file +img.jpeg from the start of the input video you can employ the command: +

+
ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
+
+ +

The strftime option allows you to expand the filename with +date and time information. Check the documentation of +the strftime() function for the syntax. +

+

For example to generate image files from the strftime() +"%Y-%m-%d_%H-%M-%S" pattern, the following ffmpeg command +can be used: +

+
ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
+
+ +

You can set the file name with current frame’s PTS: +

+
ffmpeg -f v4l2 -r 1 -i /dev/video0 -copyts -f image2 -frame_pts true %d.jpg"
+
+ +

A more complex example is to publish contents of your desktop directly to a +WebDAV server every second: +

+
ffmpeg -f x11grab -framerate 1 -i :0.0 -q:v 6 -update 1 -protocol_opts method=PUT http://example.com/desktop.jpg
+
+ + +

21.16 matroska

+ +

Matroska container muxer. +

+

This muxer implements the matroska and webm container specs. +

+ +

21.16.1 Metadata

+ +

The recognized metadata settings in this muxer are: +

+
+
title
+

Set title name provided to a single track. This gets mapped to +the FileDescription element for a stream written as attachment. +

+
+
language
+

Specify the language of the track in the Matroska languages form. +

+

The language can be either the 3 letters bibliographic ISO-639-2 (ISO +639-2/B) form (like "fre" for French), or a language code mixed with a +country code for specialities in languages (like "fre-ca" for Canadian +French). +

+
+
stereo_mode
+

Set stereo 3D video layout of two views in a single video track. +

+

The following values are recognized: +

+
‘mono’
+

video is not stereo +

+
‘left_right’
+

Both views are arranged side by side, Left-eye view is on the left +

+
‘bottom_top’
+

Both views are arranged in top-bottom orientation, Left-eye view is at bottom +

+
‘top_bottom’
+

Both views are arranged in top-bottom orientation, Left-eye view is on top +

+
‘checkerboard_rl’
+

Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first +

+
‘checkerboard_lr’
+

Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first +

+
‘row_interleaved_rl’
+

Each view is constituted by a row based interleaving, Right-eye view is first row +

+
‘row_interleaved_lr’
+

Each view is constituted by a row based interleaving, Left-eye view is first row +

+
‘col_interleaved_rl’
+

Both views are arranged in a column based interleaving manner, Right-eye view is first column +

+
‘col_interleaved_lr’
+

Both views are arranged in a column based interleaving manner, Left-eye view is first column +

+
‘anaglyph_cyan_red’
+

All frames are in anaglyph format viewable through red-cyan filters +

+
‘right_left’
+

Both views are arranged side by side, Right-eye view is on the left +

+
‘anaglyph_green_magenta’
+

All frames are in anaglyph format viewable through green-magenta filters +

+
‘block_lr’
+

Both eyes laced in one Block, Left-eye view is first +

+
‘block_rl’
+

Both eyes laced in one Block, Right-eye view is first +

+
+
+
+ +

For example a 3D WebM clip can be created using the following command line: +

+
ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
+
+ + +

21.16.2 Options

+ +

This muxer supports the following options: +

+
+
reserve_index_space
+

By default, this muxer writes the index for seeking (called cues in Matroska +terms) at the end of the file, because it cannot know in advance how much space +to leave for the index at the beginning of the file. However for some use cases +– e.g. streaming where seeking is possible but slow – it is useful to put the +index at the beginning of the file. +

+

If this option is set to a non-zero value, the muxer will reserve a given amount +of space in the file header and then try to write the cues there when the muxing +finishes. If the reserved space does not suffice, no Cues will be written, the +file will be finalized and writing the trailer will return an error. +A safe size for most use cases should be about 50kB per hour of video. +

+

Note that cues are only written if the output is seekable and this option will +have no effect if it is not. +

+
default_mode
+

This option controls how the FlagDefault of the output tracks will be set. +It influences which tracks players should play by default. The default mode +is ‘infer’. +

+
‘infer’
+

In this mode, for each type of track (audio, video or subtitle), if there is +a track with disposition default of this type, then the first such track +(i.e. the one with the lowest index) will be marked as default; if no such +track exists, the first track of this type will be marked as default instead +(if existing). This ensures that the default flag is set in a sensible way even +if the input originated from containers that lack the concept of default tracks. +

+
‘infer_no_subs’
+

This mode is the same as infer except that if no subtitle track with +disposition default exists, no subtitle track will be marked as default. +

+
‘passthrough’
+

In this mode the FlagDefault is set if and only if the AV_DISPOSITION_DEFAULT +flag is set in the disposition of the corresponding stream. +

+
+
+
+ + +

21.17 md5

+ +

MD5 testing format. +

+

This is a variant of the hash muxer. Unlike that muxer, it +defaults to using the MD5 hash function. +

+ +

21.17.1 Examples

+ +

To compute the MD5 hash of the input converted to raw +audio and video, and store it in the file out.md5: +

+
ffmpeg -i INPUT -f md5 out.md5
+
+ +

You can print the MD5 to stdout with the command: +

+
ffmpeg -i INPUT -f md5 -
+
+ +

See also the hash and framemd5 muxers. +

+ +

21.18 mov, mp4, ismv

+ +

MOV/MP4/ISMV (Smooth Streaming) muxer. +

+

The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4 +file has all the metadata about all packets stored in one location +(written at the end of the file, it can be moved to the start for +better playback by adding faststart to the movflags, or +using the qt-faststart tool). A fragmented +file consists of a number of fragments, where packets and metadata +about these packets are stored together. Writing a fragmented +file has the advantage that the file is decodable even if the +writing is interrupted (while a normal MOV/MP4 is undecodable if +it is not properly finished), and it requires less memory when writing +very long files (since writing normal MOV/MP4 files stores info about +every single packet in memory until the file is closed). The downside +is that it is less compatible with other applications. +

+ +

21.18.1 Options

+ +

Fragmentation is enabled by setting one of the AVOptions that define +how to cut the file into fragments: +

+
+
-moov_size bytes
+

Reserves space for the moov atom at the beginning of the file instead of placing the +moov atom at the end. If the space reserved is insufficient, muxing will fail. +

+
-movflags frag_keyframe
+

Start a new fragment at each video keyframe. +

+
-frag_duration duration
+

Create fragments that are duration microseconds long. +

+
-frag_size size
+

Create fragments that contain up to size bytes of payload data. +

+
-movflags frag_custom
+

Allow the caller to manually choose when to cut fragments, by +calling av_write_frame(ctx, NULL) to write a fragment with +the packets written so far. (This is only useful with other +applications integrating libavformat, not from ffmpeg.) +

+
-min_frag_duration duration
+

Don’t create fragments that are shorter than duration microseconds long. +

+
+ +

If more than one condition is specified, fragments are cut when +one of the specified conditions is fulfilled. The exception to this is +-min_frag_duration, which has to be fulfilled for any of the other +conditions to apply. +

+

Additionally, the way the output file is written can be adjusted +through a few other options: +

+
+
-movflags empty_moov
+

Write an initial moov atom directly at the start of the file, without +describing any samples in it. Generally, an mdat/moov pair is written +at the start of the file, as a normal MOV/MP4 file, containing only +a short portion of the file. With this option set, there is no initial +mdat atom, and the moov atom only describes the tracks but has +a zero duration. +

+

This option is implicitly set when writing ismv (Smooth Streaming) files. +

+
-movflags separate_moof
+

Write a separate moof (movie fragment) atom for each track. Normally, +packets for all tracks are written in a moof atom (which is slightly +more efficient), but with this option set, the muxer writes one moof/mdat +pair for each track, making it easier to separate tracks. +

+

This option is implicitly set when writing ismv (Smooth Streaming) files. +

+
-movflags skip_sidx
+

Skip writing of sidx atom. When bitrate overhead due to sidx atom is high, +this option could be used for cases where sidx atom is not mandatory. +When global_sidx flag is enabled, this option will be ignored. +

+
-movflags faststart
+

Run a second pass moving the index (moov atom) to the beginning of the file. +This operation can take a while, and will not work in various situations such +as fragmented output, thus it is not enabled by default. +

+
-movflags rtphint
+

Add RTP hinting tracks to the output file. +

+
-movflags disable_chpl
+

Disable Nero chapter markers (chpl atom). Normally, both Nero chapters +and a QuickTime chapter track are written to the file. With this option +set, only the QuickTime chapter track will be written. Nero chapters can +cause failures when the file is reprocessed with certain tagging programs, like +mp3Tag 2.61a and iTunes 11.3, most likely other versions are affected as well. +

+
-movflags omit_tfhd_offset
+

Do not write any absolute base_data_offset in tfhd atoms. This avoids +tying fragments to absolute byte positions in the file/streams. +

+
-movflags default_base_moof
+

Similarly to the omit_tfhd_offset, this flag avoids writing the +absolute base_data_offset field in tfhd atoms, but does so by using +the new default-base-is-moof flag instead. This flag is new from +14496-12:2012. This may make the fragments easier to parse in certain +circumstances (avoiding basing track fragment location calculations +on the implicit end of the previous track fragment). +

+
-write_tmcd
+

Specify on to force writing a timecode track, off to disable it +and auto to write a timecode track only for mov and mp4 output (default). +

+
-movflags negative_cts_offsets
+

Enables utilization of version 1 of the CTTS box, in which the CTS offsets can +be negative. This enables the initial sample to have DTS/CTS of zero, and +reduces the need for edit lists for some cases such as video tracks with +B-frames. Additionally, eases conformance with the DASH-IF interoperability +guidelines. +

+

This option is implicitly set when writing ismv (Smooth Streaming) files. +

+
-write_prft
+

Write producer time reference box (PRFT) with a specified time source for the +NTP field in the PRFT box. Set value as ‘wallclock’ to specify timesource +as wallclock time and ‘pts’ to specify timesource as input packets’ PTS +values. +

+

Setting value to ‘pts’ is applicable only for a live encoding use case, +where PTS values are set as as wallclock time at the source. For example, an +encoding use case with decklink capture source where video_pts and +audio_pts are set to ‘abs_wallclock’. +

+
+ + +

21.18.2 Example

+ +

Smooth Streaming content can be pushed in real time to a publishing +point on IIS with this muxer. Example: +

+
ffmpeg -re <normal input/transcoding options> -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
+
+ + +

21.19 mp3

+ +

The MP3 muxer writes a raw MP3 stream with the following optional features: +

    +
  • An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and +2.4 are supported, the id3v2_version private option controls which one is +used (3 or 4). Setting id3v2_version to 0 disables the ID3v2 header +completely. + +

    The muxer supports writing attached pictures (APIC frames) to the ID3v2 header. +The pictures are supplied to the muxer in form of a video stream with a single +packet. There can be any number of those streams, each will correspond to a +single APIC frame. The stream metadata tags title and comment map +to APIC description and picture type respectively. See +http://id3.org/id3v2.4.0-frames for allowed picture types. +

    +

    Note that the APIC frames must be written at the beginning, so the muxer will +buffer the audio frames until it gets all the pictures. It is therefore advised +to provide the pictures as soon as possible to avoid excessive buffering. +

    +
  • A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by +default, but will be written only if the output is seekable. The +write_xing private option can be used to disable it. The frame contains +various information that may be useful to the decoder, like the audio duration +or encoder delay. + +
  • A legacy ID3v1 tag at the end of the file (disabled by default). It may be +enabled with the write_id3v1 private option, but as its capabilities are +very limited, its usage is not recommended. +
+ +

Examples: +

+

Write an mp3 with an ID3v2.3 header and an ID3v1 footer: +

+
ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
+
+ +

To attach a picture to an mp3 file select both the audio and the picture stream +with map: +

+
ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
+-metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
+
+ +

Write a "clean" MP3 without any extra features: +

+
ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
+
+ + +

21.20 mpegts

+ +

MPEG transport stream muxer. +

+

This muxer implements ISO 13818-1 and part of ETSI EN 300 468. +

+

The recognized metadata settings in mpegts muxer are service_provider +and service_name. If they are not set the default for +service_provider is ‘FFmpeg’ and the default for +service_name is ‘Service01’. +

+ +

21.20.1 Options

+ +

The muxer options are: +

+
+
mpegts_transport_stream_id integer
+

Set the ‘transport_stream_id’. This identifies a transponder in DVB. +Default is 0x0001. +

+
+
mpegts_original_network_id integer
+

Set the ‘original_network_id’. This is unique identifier of a +network in DVB. Its main use is in the unique identification of a service +through the path ‘Original_Network_ID, Transport_Stream_ID’. Default +is 0x0001. +

+
+
mpegts_service_id integer
+

Set the ‘service_id’, also known as program in DVB. Default is +0x0001. +

+
+
mpegts_service_type integer
+

Set the program ‘service_type’. Default is digital_tv. +Accepts the following options: +

+
‘hex_value’
+

Any hexadecimal value between 0x01 and 0xff as defined in +ETSI 300 468. +

+
‘digital_tv’
+

Digital TV service. +

+
‘digital_radio’
+

Digital Radio service. +

+
‘teletext’
+

Teletext service. +

+
‘advanced_codec_digital_radio’
+

Advanced Codec Digital Radio service. +

+
‘mpeg2_digital_hdtv’
+

MPEG2 Digital HDTV service. +

+
‘advanced_codec_digital_sdtv’
+

Advanced Codec Digital SDTV service. +

+
‘advanced_codec_digital_hdtv’
+

Advanced Codec Digital HDTV service. +

+
+ +
+
mpegts_pmt_start_pid integer
+

Set the first PID for PMTs. Default is 0x1000, minimum is 0x0020, +maximum is 0x1ffa. This option has no effect in m2ts mode where the PMT +PID is fixed 0x0100. +

+
+
mpegts_start_pid integer
+

Set the first PID for elementary streams. Default is 0x0100, minimum is +0x0020, maximum is 0x1ffa. This option has no effect in m2ts mode +where the elementary stream PIDs are fixed. +

+
+
mpegts_m2ts_mode boolean
+

Enable m2ts mode if set to 1. Default value is -1 which +disables m2ts mode. +

+
+
muxrate integer
+

Set a constant muxrate. Default is VBR. +

+
+
pes_payload_size integer
+

Set minimum PES packet payload in bytes. Default is 2930. +

+
+
mpegts_flags flags
+

Set mpegts flags. Accepts the following options: +

+
‘resend_headers’
+

Reemit PAT/PMT before writing the next packet. +

+
‘latm’
+

Use LATM packetization for AAC. +

+
‘pat_pmt_at_frames’
+

Reemit PAT and PMT at each video frame. +

+
‘system_b’
+

Conform to System B (DVB) instead of System A (ATSC). +

+
‘initial_discontinuity’
+

Mark the initial packet of each stream as discontinuity. +

+
+ +
+
mpegts_copyts boolean
+

Preserve original timestamps, if value is set to 1. Default value +is -1, which results in shifting timestamps so that they start from 0. +

+
+
omit_video_pes_length boolean
+

Omit the PES packet length for video packets. Default is 1 (true). +

+
+
pcr_period integer
+

Override the default PCR retransmission time in milliseconds. Default is +-1 which means that the PCR interval will be determined automatically: +20 ms is used for CBR streams, the highest multiple of the frame duration which +is less than 100 ms is used for VBR streams. +

+
+
pat_period duration
+

Maximum time in seconds between PAT/PMT tables. Default is 0.1. +

+
+
sdt_period duration
+

Maximum time in seconds between SDT tables. Default is 0.5. +

+
+
tables_version integer
+

Set PAT, PMT and SDT version (default 0, valid values are from 0 to 31, inclusively). +This option allows updating stream structure so that standard consumer may +detect the change. To do so, reopen output AVFormatContext (in case of API +usage) or restart ffmpeg instance, cyclically changing +tables_version value: +

+
+
ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
+ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
+...
+ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
+ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
+ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
+...
+
+
+
+ + +

21.20.2 Example

+ +
+
ffmpeg -i file.mpg -c copy \
+     -mpegts_original_network_id 0x1122 \
+     -mpegts_transport_stream_id 0x3344 \
+     -mpegts_service_id 0x5566 \
+     -mpegts_pmt_start_pid 0x1500 \
+     -mpegts_start_pid 0x150 \
+     -metadata service_provider="Some provider" \
+     -metadata service_name="Some Channel" \
+     out.ts
+
+ + +

21.21 mxf, mxf_d10, mxf_opatom

+ +

MXF muxer. +

+ +

21.21.1 Options

+ +

The muxer options are: +

+
+
store_user_comments bool
+

Set if user comments should be stored if available or never. +IRT D-10 does not allow user comments. The default is thus to write them for +mxf and mxf_opatom but not for mxf_d10 +

+
+ + +

21.22 null

+ +

Null muxer. +

+

This muxer does not generate any output file, it is mainly useful for +testing or benchmarking purposes. +

+

For example to benchmark decoding with ffmpeg you can use the +command: +

+
ffmpeg -benchmark -i INPUT -f null out.null
+
+ +

Note that the above command does not read or write the out.null +file, but specifying the output file is required by the ffmpeg +syntax. +

+

Alternatively you can write the command as: +

+
ffmpeg -benchmark -i INPUT -f null -
+
+ + +

21.23 nut

+ +
+
-syncpoints flags
+

Change the syncpoint usage in nut: +

+
default use the normal low-overhead seeking aids.
+
none do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
+

Use of this option is not recommended, as the resulting files are very damage + sensitive and seeking is not possible. Also in general the overhead from + syncpoints is negligible. Note, -write_index 0 can be used to disable + all growing data tables, allowing to mux endless streams with limited memory + and without these disadvantages. +

+
timestamped extend the syncpoint with a wallclock field.
+
+

The none and timestamped flags are experimental. +

+
-write_index bool
+

Write index at the end, the default is to write an index. +

+
+ +
+
ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
+
+ + +

21.24 ogg

+ +

Ogg container muxer. +

+
+
-page_duration duration
+

Preferred page duration, in microseconds. The muxer will attempt to create +pages that are approximately duration microseconds long. This allows the +user to compromise between seek granularity and container overhead. The default +is 1 second. A value of 0 will fill all segments, making pages as large as +possible. A value of 1 will effectively use 1 packet-per-page in most +situations, giving a small seek granularity at the cost of additional container +overhead. +

+
-serial_offset value
+

Serial value from which to set the streams serial number. +Setting it to different and sufficiently large values ensures that the produced +ogg files can be safely chained. +

+
+
+ + +

21.25 segment, stream_segment, ssegment

+ +

Basic stream segmenter. +

+

This muxer outputs streams to a number of separate files of nearly +fixed duration. Output filename pattern can be set in a fashion +similar to image2, or by using a strftime template if +the strftime option is enabled. +

+

stream_segment is a variant of the muxer used to write to +streaming output formats, i.e. which do not require global headers, +and is recommended for outputting e.g. to MPEG transport stream segments. +ssegment is a shorter alias for stream_segment. +

+

Every segment starts with a keyframe of the selected reference stream, +which is set through the reference_stream option. +

+

Note that if you want accurate splitting for a video file, you need to +make the input key frames correspond to the exact splitting times +expected by the segmenter, or the segment muxer will start the new +segment with the key frame found next after the specified start +time. +

+

The segment muxer works best with a single constant frame rate video. +

+

Optionally it can generate a list of the created segments, by setting +the option segment_list. The list type is specified by the +segment_list_type option. The entry filenames in the segment +list are set by default to the basename of the corresponding segment +files. +

+

See also the hls muxer, which provides a more specific +implementation for HLS segmentation. +

+ +

21.25.1 Options

+ +

The segment muxer supports the following options: +

+
+
increment_tc 1|0
+

if set to 1, increment timecode between each segment +If this is selected, the input need to have +a timecode in the first video stream. Default value is +0. +

+
+
reference_stream specifier
+

Set the reference stream, as specified by the string specifier. +If specifier is set to auto, the reference is chosen +automatically. Otherwise it must be a stream specifier (see the “Stream +specifiers” chapter in the ffmpeg manual) which specifies the +reference stream. The default value is auto. +

+
+
segment_format format
+

Override the inner container format, by default it is guessed by the filename +extension. +

+
+
segment_format_options options_list
+

Set output format options using a :-separated list of key=value +parameters. Values containing the : special character must be +escaped. +

+
+
segment_list name
+

Generate also a listfile named name. If not specified no +listfile is generated. +

+
+
segment_list_flags flags
+

Set flags affecting the segment list generation. +

+

It currently supports the following flags: +

+
‘cache’
+

Allow caching (only affects M3U8 list files). +

+
+
‘live’
+

Allow live-friendly file generation. +

+
+ +
+
segment_list_size size
+

Update the list file so that it contains at most size +segments. If 0 the list file will contain all the segments. Default +value is 0. +

+
+
segment_list_entry_prefix prefix
+

Prepend prefix to each entry. Useful to generate absolute paths. +By default no prefix is applied. +

+
+
segment_list_type type
+

Select the listing format. +

+

The following values are recognized: +

+
‘flat’
+

Generate a flat list for the created segments, one segment per line. +

+
+
‘csv, ext’
+

Generate a list for the created segments, one segment per line, +each line matching the format (comma-separated values): +

+
segment_filename,segment_start_time,segment_end_time
+
+ +

segment_filename is the name of the output file generated by the +muxer according to the provided pattern. CSV escaping (according to +RFC4180) is applied if required. +

+

segment_start_time and segment_end_time specify +the segment start and end time expressed in seconds. +

+

A list file with the suffix ".csv" or ".ext" will +auto-select this format. +

+

‘ext’ is deprecated in favor or ‘csv’. +

+
+
‘ffconcat’
+

Generate an ffconcat file for the created segments. The resulting file +can be read using the FFmpeg concat demuxer. +

+

A list file with the suffix ".ffcat" or ".ffconcat" will +auto-select this format. +

+
+
‘m3u8’
+

Generate an extended M3U8 file, version 3, compliant with +http://tools.ietf.org/id/draft-pantos-http-live-streaming. +

+

A list file with the suffix ".m3u8" will auto-select this format. +

+
+ +

If not specified the type is guessed from the list file name suffix. +

+
+
segment_time time
+

Set segment duration to time, the value must be a duration +specification. Default value is "2". See also the +segment_times option. +

+

Note that splitting may not be accurate, unless you force the +reference stream key-frames at the given time. See the introductory +notice and the examples below. +

+
+
segment_atclocktime 1|0
+

If set to "1" split at regular clock time intervals starting from 00:00 +o’clock. The time value specified in segment_time is +used for setting the length of the splitting interval. +

+

For example with segment_time set to "900" this makes it possible +to create files at 12:00 o’clock, 12:15, 12:30, etc. +

+

Default value is "0". +

+
+
segment_clocktime_offset duration
+

Delay the segment splitting times with the specified duration when using +segment_atclocktime. +

+

For example with segment_time set to "900" and +segment_clocktime_offset set to "300" this makes it possible to +create files at 12:05, 12:20, 12:35, etc. +

+

Default value is "0". +

+
+
segment_clocktime_wrap_duration duration
+

Force the segmenter to only start a new segment if a packet reaches the muxer +within the specified duration after the segmenting clock time. This way you +can make the segmenter more resilient to backward local time jumps, such as +leap seconds or transition to standard time from daylight savings time. +

+

Default is the maximum possible duration which means starting a new segment +regardless of the elapsed time since the last clock time. +

+
+
segment_time_delta delta
+

Specify the accuracy time when selecting the start time for a +segment, expressed as a duration specification. Default value is "0". +

+

When delta is specified a key-frame will start a new segment if its +PTS satisfies the relation: +

+
PTS >= start_time - time_delta
+
+ +

This option is useful when splitting video content, which is always +split at GOP boundaries, in case a key frame is found just before the +specified split time. +

+

In particular may be used in combination with the ffmpeg option +force_key_frames. The key frame times specified by +force_key_frames may not be set accurately because of rounding +issues, with the consequence that a key frame time may result set just +before the specified time. For constant frame rate videos a value of +1/(2*frame_rate) should address the worst case mismatch between +the specified time and the time set by force_key_frames. +

+
+
segment_times times
+

Specify a list of split points. times contains a list of comma +separated duration specifications, in increasing order. See also +the segment_time option. +

+
+
segment_frames frames
+

Specify a list of split video frame numbers. frames contains a +list of comma separated integer numbers, in increasing order. +

+

This option specifies to start a new segment whenever a reference +stream key frame is found and the sequential number (starting from 0) +of the frame is greater or equal to the next value in the list. +

+
+
segment_wrap limit
+

Wrap around segment index once it reaches limit. +

+
+
segment_start_number number
+

Set the sequence number of the first segment. Defaults to 0. +

+
+
strftime 1|0
+

Use the strftime function to define the name of the new +segments to write. If this is selected, the output segment name must +contain a strftime function template. Default value is +0. +

+
+
break_non_keyframes 1|0
+

If enabled, allow segments to start on frames other than keyframes. This +improves behavior on some players when the time between keyframes is +inconsistent, but may make things worse on others, and can cause some oddities +during seeking. Defaults to 0. +

+
+
reset_timestamps 1|0
+

Reset timestamps at the beginning of each segment, so that each segment +will start with near-zero timestamps. It is meant to ease the playback +of the generated segments. May not work with some combinations of +muxers/codecs. It is set to 0 by default. +

+
+
initial_offset offset
+

Specify timestamp offset to apply to the output packet timestamps. The +argument must be a time duration specification, and defaults to 0. +

+
+
write_empty_segments 1|0
+

If enabled, write an empty segment if there are no packets during the period a +segment would usually span. Otherwise, the segment will be filled with the next +packet written. Defaults to 0. +

+
+ +

Make sure to require a closed GOP when encoding and to set the GOP +size to fit your segment time constraint. +

+ +

21.25.2 Examples

+ +
    +
  • Remux the content of file in.mkv to a list of segments +out-000.nut, out-001.nut, etc., and write the list of +generated segments to out.list: +
    +
    ffmpeg -i in.mkv -codec hevc -flags +cgop -g 60 -map 0 -f segment -segment_list out.list out%03d.nut
+
    + +
  • Segment input and set output format options for the output segments: +
    +
    ffmpeg -i in.mkv -f segment -segment_time 10 -segment_format_options movflags=+faststart out%03d.mp4
+
    + +
  • Segment the input file according to the split points specified by the +segment_times option: +
    +
    ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 out%03d.nut
+
    + +
  • Use the ffmpeg force_key_frames +option to force key frames in the input at the specified location, together +with the segment option segment_time_delta to account for +possible roundings operated when setting key frame times. +
    +
    ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
+-f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
+
    +

    In order to force key frames on the input file, transcoding is +required. +

    +
  • Segment the input file by splitting the input file according to the +frame numbers sequence specified with the segment_frames option: +
    +
    ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
+
    + +
  • Convert the in.mkv to TS segments using the libx264 +and aac encoders: +
    +
    ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a aac -f ssegment -segment_list out.list out%03d.ts
+
    + +
  • Segment the input file, and create an M3U8 live playlist (can be used +as live HLS source): +
    +
    ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
+-segment_list_flags +live -segment_time 10 out%03d.mkv
+
    +
+ + +

21.26 smoothstreaming

+ +

Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server. +

+
+
window_size
+

Specify the number of fragments kept in the manifest. Default 0 (keep all). +

+
+
extra_window_size
+

Specify the number of fragments kept outside of the manifest before removing from disk. Default 5. +

+
+
lookahead_count
+

Specify the number of lookahead fragments. Default 2. +

+
+
min_frag_duration
+

Specify the minimum fragment duration (in microseconds). Default 5000000. +

+
+
remove_at_exit
+

Specify whether to remove all fragments when finished. Default 0 (do not remove). +

+
+
+ + +

21.27 streamhash

+ +

Per stream hash testing format. +

+

This muxer computes and prints a cryptographic hash of all the input frames, +on a per-stream basis. This can be used for equality checks without having +to do a complete binary comparison. +

+

By default audio frames are converted to signed 16-bit raw audio and +video frames to raw video before computing the hash, but the output +of explicit conversions to other codecs can also be used. Timestamps +are ignored. It uses the SHA-256 cryptographic hash function by default, +but supports several other algorithms. +

+

The output of the muxer consists of one line per stream of the form: +streamindex,streamtype,algo=hash, where +streamindex is the index of the mapped stream, streamtype is a +single character indicating the type of stream, algo is a short string +representing the hash function used, and hash is a hexadecimal number +representing the computed hash. +

+
+
hash algorithm
+

Use the cryptographic hash function specified by the string algorithm. +Supported values include MD5, murmur3, RIPEMD128, +RIPEMD160, RIPEMD256, RIPEMD320, SHA160, +SHA224, SHA256 (default), SHA512/224, SHA512/256, +SHA384, SHA512, CRC32 and adler32. +

+
+
+ + +

21.27.1 Examples

+ +

To compute the SHA-256 hash of the input converted to raw audio and +video, and store it in the file out.sha256: +

+
ffmpeg -i INPUT -f streamhash out.sha256
+
+ +

To print an MD5 hash to stdout use the command: +

+
ffmpeg -i INPUT -f streamhash -hash md5 -
+
+ +

See also the hash and framehash muxers. +

+ +

21.28 fifo

+ +

The fifo pseudo-muxer allows the separation of encoding and muxing by using +first-in-first-out queue and running the actual muxer in a separate thread. This +is especially useful in combination with the tee muxer and can be used to +send data to several destinations with different reliability/writing speed/latency. +

+

API users should be aware that callback functions (interrupt_callback, +io_open and io_close) used within its AVFormatContext must be thread-safe. +

+

The behavior of the fifo muxer if the queue fills up or if the output fails is +selectable, +

+
    +
  • output can be transparently restarted with configurable delay between retries +based on real time or time of the processed stream. + +
  • encoding can be blocked during temporary failure, or continue transparently +dropping packets in case fifo queue fills up. + +
+ +
+
fifo_format
+

Specify the format name. Useful if it cannot be guessed from the +output name suffix. +

+
+
queue_size
+

Specify size of the queue (number of packets). Default value is 60. +

+
+
format_opts
+

Specify format options for the underlying muxer. Muxer options can be specified +as a list of key=value pairs separated by ’:’. +

+
+
drop_pkts_on_overflow bool
+

If set to 1 (true), in case the fifo queue fills up, packets will be dropped +rather than blocking the encoder. This makes it possible to continue streaming without +delaying the input, at the cost of omitting part of the stream. By default +this option is set to 0 (false), so in such cases the encoder will be blocked +until the muxer processes some of the packets and none of them is lost. +

+
+
attempt_recovery bool
+

If failure occurs, attempt to recover the output. This is especially useful +when used with network output, since it makes it possible to restart streaming transparently. +By default this option is set to 0 (false). +

+
+
max_recovery_attempts
+

Sets maximum number of successive unsuccessful recovery attempts after which +the output fails permanently. By default this option is set to 0 (unlimited). +

+
+
recovery_wait_time duration
+

Waiting time before the next recovery attempt after previous unsuccessful +recovery attempt. Default value is 5 seconds. +

+
+
recovery_wait_streamtime bool
+

If set to 0 (false), the real time is used when waiting for the recovery +attempt (i.e. the recovery will be attempted after at least +recovery_wait_time seconds). +If set to 1 (true), the time of the processed stream is taken into account +instead (i.e. the recovery will be attempted after at least recovery_wait_time +seconds of the stream is omitted). +By default, this option is set to 0 (false). +

+
+
recover_any_error bool
+

If set to 1 (true), recovery will be attempted regardless of type of the error +causing the failure. By default this option is set to 0 (false) and in case of +certain (usually permanent) errors the recovery is not attempted even when +attempt_recovery is set to 1. +

+
+
restart_with_keyframe bool
+

Specify whether to wait for the keyframe after recovering from +queue overflow or failure. This option is set to 0 (false) by default. +

+
+
+ + +

21.28.1 Examples

+ +
    +
  • Stream something to rtmp server, continue processing the stream at real-time +rate even in case of temporary failure (network outage) and attempt to recover +streaming every second indefinitely. +
    +
    ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format flv -map 0:v -map 0:a
+  -drop_pkts_on_overflow 1 -attempt_recovery 1 -recovery_wait_time 1 rtmp://example.com/live/stream_name
+
    + +
+ + +

21.29 tee

+ +

The tee muxer can be used to write the same data to several outputs, such as files or streams. +It can be used, for example, to stream a video over a network and save it to disk at the same time. +

+

It is different from specifying several outputs to the ffmpeg +command-line tool. With the tee muxer, the audio and video data will be encoded only once. +With conventional multiple outputs, multiple encoding operations in parallel are initiated, +which can be a very expensive process. The tee muxer is not useful when using the libavformat API +directly because it is then possible to feed the same packets to several muxers directly. +

+

Since the tee muxer does not represent any particular output format, ffmpeg cannot auto-select +output streams. So all streams intended for output must be specified using -map. See +the examples below. +

+

Some encoders may need different options depending on the output format; +the auto-detection of this can not work with the tee muxer, so they need to be explicitly specified. +The main example is the global_header flag. +

+

The slave outputs are specified in the file name given to the muxer, +separated by ’|’. If any of the slave name contains the ’|’ separator, +leading or trailing spaces or any special character, those must be +escaped (see (ffmpeg-utils)the "Quoting and escaping" +section in the ffmpeg-utils(1) manual). +

+ +

21.29.1 Options

+ +
+
use_fifo bool
+

If set to 1, slave outputs will be processed in separate threads using the fifo +muxer. This allows to compensate for different speed/latency/reliability of +outputs and setup transparent recovery. By default this feature is turned off. +

+
+
fifo_options
+

Options to pass to fifo pseudo-muxer instances. See fifo. +

+
+
+ +

Muxer options can be specified for each slave by prepending them as a list of +key=value pairs separated by ’:’, between square brackets. If +the options values contain a special character or the ’:’ separator, they +must be escaped; note that this is a second level escaping. +

+

The following special options are also recognized: +

+
f
+

Specify the format name. Required if it cannot be guessed from the +output URL. +

+
+
bsfs[/spec]
+

Specify a list of bitstream filters to apply to the specified +output. +

+

It is possible to specify to which streams a given bitstream filter +applies, by appending a stream specifier to the option separated by +/. spec must be a stream specifier (see Format stream specifiers). +

+

If the stream specifier is not specified, the bitstream filters will be +applied to all streams in the output. This will cause that output operation +to fail if the output contains streams to which the bitstream filter cannot +be applied e.g. h264_mp4toannexb being applied to an output containing an audio stream. +

+

Options for a bitstream filter must be specified in the form of opt=value. +

+

Several bitstream filters can be specified, separated by ",". +

+
+
use_fifo bool
+

This allows to override tee muxer use_fifo option for individual slave muxer. +

+
+
fifo_options
+

This allows to override tee muxer fifo_options for individual slave muxer. +See fifo. +

+
+
select
+

Select the streams that should be mapped to the slave output, +specified by a stream specifier. If not specified, this defaults to +all the mapped streams. This will cause that output operation to fail +if the output format does not accept all mapped streams. +

+

You may use multiple stream specifiers separated by commas (,) e.g.: a:0,v +

+
+
onfail
+

Specify behaviour on output failure. This can be set to either abort (which is +default) or ignore. abort will cause whole process to fail in case of failure +on this slave output. ignore will ignore failure on this output, so other outputs +will continue without being affected. +

+
+ + +

21.29.2 Examples

+ +
    +
  • Encode something and both archive it in a WebM file and stream it +as MPEG-TS over UDP: +
    +
    ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
+  "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
+
    + +
  • As above, but continue streaming even if output to local file fails +(for example local drive fills up): +
    +
    ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
+  "[onfail=ignore]archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
+
    + +
  • Use ffmpeg to encode the input, and send the output +to three different destinations. The dump_extra bitstream +filter is used to add extradata information to all the output video +keyframes packets, as requested by the MPEG-TS format. The select +option is applied to out.aac in order to make it contain only +audio packets. +
    +
    ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
+       -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
+
    + +
  • As above, but select only stream a:1 for the audio output. Note +that a second level escaping must be performed, as ":" is a special +character used to separate options. +
    +
    ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
+       -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
+
    +
+ + +

21.30 webm_dash_manifest

+ +

WebM DASH Manifest muxer. +

+

This muxer implements the WebM DASH Manifest specification to generate the DASH +manifest XML. It also supports manifest generation for DASH live streams. +

+

For more information see: +

+ + + +

21.30.1 Options

+ +

This muxer supports the following options: +

+
+
adaptation_sets
+

This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the +unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding +audio and video streams. Any number of adaptation sets can be added using this option. +

+
+
live
+

Set this to 1 to create a live stream DASH Manifest. Default: 0. +

+
+
chunk_start_index
+

Start index of the first chunk. This will go in the ‘startNumber’ attribute +of the ‘SegmentTemplate’ element in the manifest. Default: 0. +

+
+
chunk_duration_ms
+

Duration of each chunk in milliseconds. This will go in the ‘duration’ +attribute of the ‘SegmentTemplate’ element in the manifest. Default: 1000. +

+
+
utc_timing_url
+

URL of the page that will return the UTC timestamp in ISO format. This will go +in the ‘value’ attribute of the ‘UTCTiming’ element in the manifest. +Default: None. +

+
+
time_shift_buffer_depth
+

Smallest time (in seconds) shifting buffer for which any Representation is +guaranteed to be available. This will go in the ‘timeShiftBufferDepth’ +attribute of the ‘MPD’ element. Default: 60. +

+
+
minimum_update_period
+

Minimum update period (in seconds) of the manifest. This will go in the +‘minimumUpdatePeriod’ attribute of the ‘MPD’ element. Default: 0. +

+
+
+ + +

21.30.2 Example

+
+
ffmpeg -f webm_dash_manifest -i video1.webm \
+       -f webm_dash_manifest -i video2.webm \
+       -f webm_dash_manifest -i audio1.webm \
+       -f webm_dash_manifest -i audio2.webm \
+       -map 0 -map 1 -map 2 -map 3 \
+       -c copy \
+       -f webm_dash_manifest \
+       -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \
+       manifest.xml
+
+ + +

21.31 webm_chunk

+ +

WebM Live Chunk Muxer. +

+

This muxer writes out WebM headers and chunks as separate files which can be +consumed by clients that support WebM Live streams via DASH. +

+ +

21.31.1 Options

+ +

This muxer supports the following options: +

+
+
chunk_start_index
+

Index of the first chunk (defaults to 0). +

+
+
header
+

Filename of the header where the initialization data will be written. +

+
+
audio_chunk_duration
+

Duration of each audio chunk in milliseconds (defaults to 5000). +

+
+ + +

21.31.2 Example

+
+
ffmpeg -f v4l2 -i /dev/video0 \
+       -f alsa -i hw:0 \
+       -map 0:0 \
+       -c:v libvpx-vp9 \
+       -s 640x360 -keyint_min 30 -g 30 \
+       -f webm_chunk \
+       -header webm_live_video_360.hdr \
+       -chunk_start_index 1 \
+       webm_live_video_360_%d.chk \
+       -map 1:0 \
+       -c:a libvorbis \
+       -b:a 128k \
+       -f webm_chunk \
+       -header webm_live_audio_128.hdr \
+       -chunk_start_index 1 \
+       -audio_chunk_duration 1000 \
+       webm_live_audio_128_%d.chk
+
+ + +

22 Metadata

+ +

FFmpeg is able to dump metadata from media files into a simple UTF-8-encoded +INI-like text file and then load it back using the metadata muxer/demuxer. +

+

The file format is as follows: +

    +
  1. A file consists of a header and a number of metadata tags divided into sections, +each on its own line. + +
  2. The header is a ‘;FFMETADATA’ string, followed by a version number (now 1). + +
  3. Metadata tags are of the form ‘key=value’ + +
  4. Immediately after header follows global metadata + +
  5. After global metadata there may be sections with per-stream/per-chapter +metadata. + +
  6. A section starts with the section name in uppercase (i.e. STREAM or CHAPTER) in +brackets (‘[’, ‘]’) and ends with next section or end of file. + +
  7. At the beginning of a chapter section there may be an optional timebase to be +used for start/end values. It must be in form +‘TIMEBASE=num/den’, where num and den are +integers. If the timebase is missing then start/end times are assumed to +be in nanoseconds. + +

    Next a chapter section must contain chapter start and end times in form +‘START=num’, ‘END=num’, where num is a positive +integer. +

    +
  8. Empty lines and lines starting with ‘;’ or ‘#’ are ignored. + +
  9. Metadata keys or values containing special characters (‘=’, ‘;’, +‘#’, ‘\’ and a newline) must be escaped with a backslash ‘\’. + +
  10. Note that whitespace in metadata (e.g. ‘foo = bar’) is considered to be +a part of the tag (in the example above key is ‘foo ’, value is +‘ bar’). +
+ +

A ffmetadata file might look like this: +

+
;FFMETADATA1
+title=bike\\shed
+;this is a comment
+artist=FFmpeg troll team
+
+[CHAPTER]
+TIMEBASE=1/1000
+START=0
+#chapter ends at 0:01:00
+END=60000
+title=chapter \#1
+[STREAM]
+title=multi\
+line
+
+ +

By using the ffmetadata muxer and demuxer it is possible to extract +metadata from an input file to an ffmetadata file, and then transcode +the file into an output file with the edited ffmetadata file. +

+

Extracting an ffmetadata file with ffmpeg goes as follows: +

+
ffmpeg -i INPUT -f ffmetadata FFMETADATAFILE
+
+ +

Reinserting edited metadata information from the FFMETADATAFILE file can +be done as: +

+
ffmpeg -i INPUT -i FFMETADATAFILE -map_metadata 1 -codec copy OUTPUT
+
+ + +

23 Protocol Options

+ +

The libavformat library provides some generic global options, which +can be set on all the protocols. In addition each protocol may support +so-called private options, which are specific for that component. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the +AVFormatContext options or using the libavutil/opt.h API +for programmatic use. +

+

The list of supported options follows: +

+
+
protocol_whitelist list (input)
+

Set a ","-separated list of allowed protocols. "ALL" matches all protocols. Protocols +prefixed by "-" are disabled. +All protocols are allowed by default but protocols used by an another +protocol (nested protocols) are restricted to a per protocol subset. +

+
+ + + +

24 Protocols

+ +

Protocols are configured elements in FFmpeg that enable access to +resources that require specific protocols. +

+

When you configure your FFmpeg build, all the supported protocols are +enabled by default. You can list all available ones using the +configure option "–list-protocols". +

+

You can disable all the protocols using the configure option +"–disable-protocols", and selectively enable a protocol using the +option "–enable-protocol=PROTOCOL", or you can disable a +particular protocol using the option +"–disable-protocol=PROTOCOL". +

+

The option "-protocols" of the ff* tools will display the list of +supported protocols. +

+

All protocols accept the following options: +

+
+
rw_timeout
+

Maximum time to wait for (network) read/write operations to complete, +in microseconds. +

+
+ +

A description of the currently available protocols follows. +

+ +

24.1 amqp

+ +

Advanced Message Queueing Protocol (AMQP) version 0-9-1 is a broker based +publish-subscribe communication protocol. +

+

FFmpeg must be compiled with –enable-librabbitmq to support AMQP. A separate +AMQP broker must also be run. An example open-source AMQP broker is RabbitMQ. +

+

After starting the broker, an FFmpeg client may stream data to the broker using +the command: +

+
+
ffmpeg -re -i input -f mpegts amqp://[[user]:[password]@]hostname[:port]
+
+ +

Where hostname and port (default is 5672) is the address of the broker. The +client may also set a user/password for authentication. The default for both +fields is "guest". +

+

Muliple subscribers may stream from the broker using the command: +

+
ffplay amqp://[[user]:[password]@]hostname[:port]
+
+ +

In RabbitMQ all data published to the broker flows through a specific exchange, +and each subscribing client has an assigned queue/buffer. When a packet arrives +at an exchange, it may be copied to a client’s queue depending on the exchange +and routing_key fields. +

+

The following options are supported: +

+
+
exchange
+

Sets the exchange to use on the broker. RabbitMQ has several predefined +exchanges: "amq.direct" is the default exchange, where the publisher and +subscriber must have a matching routing_key; "amq.fanout" is the same as a +broadcast operation (i.e. the data is forwarded to all queues on the fanout +exchange independent of the routing_key); and "amq.topic" is similar to +"amq.direct", but allows for more complex pattern matching (refer to the RabbitMQ +documentation). +

+
+
routing_key
+

Sets the routing key. The default value is "amqp". The routing key is used on +the "amq.direct" and "amq.topic" exchanges to decide whether packets are written +to the queue of a subscriber. +

+
+
pkt_size
+

Maximum size of each packet sent/received to the broker. Default is 131072. +Minimum is 4096 and max is any large value (representable by an int). When +receiving packets, this sets an internal buffer size in FFmpeg. It should be +equal to or greater than the size of the published packets to the broker. Otherwise +the received message may be truncated causing decoding errors. +

+
+
connection_timeout
+

The timeout in seconds during the initial connection to the broker. The +default value is rw_timeout, or 5 seconds if rw_timeout is not set. +

+
+
+ + +

24.2 async

+ +

Asynchronous data filling wrapper for input stream. +

+

Fill data in a background thread, to decouple I/O operation from demux thread. +

+
+
async:URL
+async:http://host/resource
+async:cache:http://host/resource
+
+ + +

24.3 bluray

+ +

Read BluRay playlist. +

+

The accepted options are: +

+
angle
+

BluRay angle +

+
+
chapter
+

Start chapter (1...N) +

+
+
playlist
+

Playlist to read (BDMV/PLAYLIST/?????.mpls) +

+
+
+ +

Examples: +

+

Read longest playlist from BluRay mounted to /mnt/bluray: +

+
bluray:/mnt/bluray
+
+ +

Read angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapter 2: +

+
-playlist 4 -angle 2 -chapter 2 bluray:/mnt/bluray
+
+ + +

24.4 cache

+ +

Caching wrapper for input stream. +

+

Cache the input stream to temporary file. It brings seeking capability to live streams. +

+
+
cache:URL
+
+ + +

24.5 concat

+ +

Physical concatenation protocol. +

+

Read and seek from many resources in sequence as if they were +a unique resource. +

+

A URL accepted by this protocol has the syntax: +

+
concat:URL1|URL2|...|URLN
+
+ +

where URL1, URL2, ..., URLN are the urls of the +resource to be concatenated, each one possibly specifying a distinct +protocol. +

+

For example to read a sequence of files split1.mpeg, +split2.mpeg, split3.mpeg with ffplay use the +command: +

+
ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
+
+ +

Note that you may need to escape the character "|" which is special for +many shells. +

+ +

24.6 crypto

+ +

AES-encrypted stream reading protocol. +

+

The accepted options are: +

+
key
+

Set the AES decryption key binary block from given hexadecimal representation. +

+
+
iv
+

Set the AES decryption initialization vector binary block from given hexadecimal representation. +

+
+ +

Accepted URL formats: +

+
crypto:URL
+crypto+URL
+
+ + +

24.7 data

+ +

Data in-line in the URI. See http://en.wikipedia.org/wiki/Data_URI_scheme. +

+

For example, to convert a GIF file given inline with ffmpeg: +

+
ffmpeg -i "data:image/gif;base64,R0lGODdhCAAIAMIEAAAAAAAA//8AAP//AP///////////////ywAAAAACAAIAAADF0gEDLojDgdGiJdJqUX02iB4E8Q9jUMkADs=" smiley.png
+
+ + +

24.8 file

+ +

File access protocol. +

+

Read from or write to a file. +

+

A file URL can have the form: +

+
file:filename
+
+ +

where filename is the path of the file to read. +

+

An URL that does not have a protocol prefix will be assumed to be a +file URL. Depending on the build, an URL that looks like a Windows +path with the drive letter at the beginning will also be assumed to be +a file URL (usually not the case in builds for unix-like systems). +

+

For example to read from a file input.mpeg with ffmpeg +use the command: +

+
ffmpeg -i file:input.mpeg output.mpeg
+
+ +

This protocol accepts the following options: +

+
+
truncate
+

Truncate existing files on write, if set to 1. A value of 0 prevents +truncating. Default value is 1. +

+
+
blocksize
+

Set I/O operation maximum block size, in bytes. Default value is +INT_MAX, which results in not limiting the requested block size. +Setting this value reasonably low improves user termination request reaction +time, which is valuable for files on slow medium. +

+
+
follow
+

If set to 1, the protocol will retry reading at the end of the file, allowing +reading files that still are being written. In order for this to terminate, +you either need to use the rw_timeout option, or use the interrupt callback +(for API users). +

+
+
seekable
+

Controls if seekability is advertised on the file. 0 means non-seekable, -1 +means auto (seekable for normal files, non-seekable for named pipes). +

+

Many demuxers handle seekable and non-seekable resources differently, +overriding this might speed up opening certain files at the cost of losing some +features (e.g. accurate seeking). +

+
+ + +

24.9 ftp

+ +

FTP (File Transfer Protocol). +

+

Read from or write to remote resources using FTP protocol. +

+

Following syntax is required. +

+
ftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg
+
+ +

This protocol accepts the following options. +

+
+
timeout
+

Set timeout in microseconds of socket I/O operations used by the underlying low level +operation. By default it is set to -1, which means that the timeout is +not specified. +

+
+
ftp-user
+

Set a user to be used for authenticating to the FTP server. This is overridden by the +user in the FTP URL. +

+
+
ftp-password
+

Set a password to be used for authenticating to the FTP server. This is overridden by +the password in the FTP URL, or by ftp-anonymous-password if no user is set. +

+
+
ftp-anonymous-password
+

Password used when login as anonymous user. Typically an e-mail address +should be used. +

+
+
ftp-write-seekable
+

Control seekability of connection during encoding. If set to 1 the +resource is supposed to be seekable, if set to 0 it is assumed not +to be seekable. Default value is 0. +

+
+ +

NOTE: Protocol can be used as output, but it is recommended to not do +it, unless special care is taken (tests, customized server configuration +etc.). Different FTP servers behave in different way during seek +operation. ff* tools may produce incomplete content due to server limitations. +

+ +

24.10 gopher

+ +

Gopher protocol. +

+ +

24.11 hls

+ +

Read Apple HTTP Live Streaming compliant segmented stream as +a uniform one. The M3U8 playlists describing the segments can be +remote HTTP resources or local files, accessed using the standard +file protocol. +The nested protocol is declared by specifying +"+proto" after the hls URI scheme name, where proto +is either "file" or "http". +

+
+
hls+http://host/path/to/remote/resource.m3u8
+hls+file://path/to/local/resource.m3u8
+
+ +

Using this protocol is discouraged - the hls demuxer should work +just as well (if not, please report the issues) and is more complete. +To use the hls demuxer instead, simply use the direct URLs to the +m3u8 files. +

+ +

24.12 http

+ +

HTTP (Hyper Text Transfer Protocol). +

+

This protocol accepts the following options: +

+
+
seekable
+

Control seekability of connection. If set to 1 the resource is +supposed to be seekable, if set to 0 it is assumed not to be seekable, +if set to -1 it will try to autodetect if it is seekable. Default +value is -1. +

+
+
chunked_post
+

If set to 1 use chunked Transfer-Encoding for posts, default is 1. +

+
+
content_type
+

Set a specific content type for the POST messages or for listen mode. +

+
+
http_proxy
+

set HTTP proxy to tunnel through e.g. http://example.com:1234 +

+
+
headers
+

Set custom HTTP headers, can override built in default headers. The +value must be a string encoding the headers. +

+
+
multiple_requests
+

Use persistent connections if set to 1, default is 0. +

+
+
post_data
+

Set custom HTTP post data. +

+
+
referer
+

Set the Referer header. Include ’Referer: URL’ header in HTTP request. +

+
+
user_agent
+

Override the User-Agent header. If not specified the protocol will use a +string describing the libavformat build. ("Lavf/<version>") +

+
+
user-agent
+

This is a deprecated option, you can use user_agent instead it. +

+
+
timeout
+

Set timeout in microseconds of socket I/O operations used by the underlying low level +operation. By default it is set to -1, which means that the timeout is +not specified. +

+
+
reconnect_at_eof
+

If set then eof is treated like an error and causes reconnection, this is useful +for live / endless streams. +

+
+
reconnect_streamed
+

If set then even streamed/non seekable streams will be reconnected on errors. +

+
+
reconnect_delay_max
+

Sets the maximum delay in seconds after which to give up reconnecting +

+
+
mime_type
+

Export the MIME type. +

+
+
http_version
+

Exports the HTTP response version number. Usually "1.0" or "1.1". +

+
+
icy
+

If set to 1 request ICY (SHOUTcast) metadata from the server. If the server +supports this, the metadata has to be retrieved by the application by reading +the icy_metadata_headers and icy_metadata_packet options. +The default is 1. +

+
+
icy_metadata_headers
+

If the server supports ICY metadata, this contains the ICY-specific HTTP reply +headers, separated by newline characters. +

+
+
icy_metadata_packet
+

If the server supports ICY metadata, and icy was set to 1, this +contains the last non-empty metadata packet sent by the server. It should be +polled in regular intervals by applications interested in mid-stream metadata +updates. +

+
+
cookies
+

Set the cookies to be sent in future requests. The format of each cookie is the +same as the value of a Set-Cookie HTTP response field. Multiple cookies can be +delimited by a newline character. +

+
+
offset
+

Set initial byte offset. +

+
+
end_offset
+

Try to limit the request to bytes preceding this offset. +

+
+
method
+

When used as a client option it sets the HTTP method for the request. +

+

When used as a server option it sets the HTTP method that is going to be +expected from the client(s). +If the expected and the received HTTP method do not match the client will +be given a Bad Request response. +When unset the HTTP method is not checked for now. This will be replaced by +autodetection in the future. +

+
+
listen
+

If set to 1 enables experimental HTTP server. This can be used to send data when +used as an output option, or read data from a client with HTTP POST when used as +an input option. +If set to 2 enables experimental multi-client HTTP server. This is not yet implemented +in ffmpeg.c and thus must not be used as a command line option. +

+
# Server side (sending):
+ffmpeg -i somefile.ogg -c copy -listen 1 -f ogg http://server:port
+
+# Client side (receiving):
+ffmpeg -i http://server:port -c copy somefile.ogg
+
+# Client can also be done with wget:
+wget http://server:port -O somefile.ogg
+
+# Server side (receiving):
+ffmpeg -listen 1 -i http://server:port -c copy somefile.ogg
+
+# Client side (sending):
+ffmpeg -i somefile.ogg -chunked_post 0 -c copy -f ogg http://server:port
+
+# Client can also be done with wget:
+wget --post-file=somefile.ogg http://server:port
+
+ +
+
send_expect_100
+

Send an Expect: 100-continue header for POST. If set to 1 it will send, if set +to 0 it won’t, if set to -1 it will try to send if it is applicable. Default +value is -1. +

+
+
+ + +

24.12.1 HTTP Cookies

+ +

Some HTTP requests will be denied unless cookie values are passed in with the +request. The cookies option allows these cookies to be specified. At +the very least, each cookie must specify a value along with a path and domain. +HTTP requests that match both the domain and path will automatically include the +cookie value in the HTTP Cookie header field. Multiple cookies can be delimited +by a newline. +

+

The required syntax to play a stream specifying a cookie is: +

+
ffplay -cookies "nlqptid=nltid=tsn; path=/; domain=somedomain.com;" http://somedomain.com/somestream.m3u8
+
+ + +

24.13 Icecast

+ +

Icecast protocol (stream to Icecast servers) +

+

This protocol accepts the following options: +

+
+
ice_genre
+

Set the stream genre. +

+
+
ice_name
+

Set the stream name. +

+
+
ice_description
+

Set the stream description. +

+
+
ice_url
+

Set the stream website URL. +

+
+
ice_public
+

Set if the stream should be public. +The default is 0 (not public). +

+
+
user_agent
+

Override the User-Agent header. If not specified a string of the form +"Lavf/<version>" will be used. +

+
+
password
+

Set the Icecast mountpoint password. +

+
+
content_type
+

Set the stream content type. This must be set if it is different from +audio/mpeg. +

+
+
legacy_icecast
+

This enables support for Icecast versions < 2.4.0, that do not support the +HTTP PUT method but the SOURCE method. +

+
+
+ +
+
icecast://[username[:password]@]server:port/mountpoint
+
+ + +

24.14 mmst

+ +

MMS (Microsoft Media Server) protocol over TCP. +

+ +

24.15 mmsh

+ +

MMS (Microsoft Media Server) protocol over HTTP. +

+

The required syntax is: +

+
mmsh://server[:port][/app][/playpath]
+
+ + +

24.16 md5

+ +

MD5 output protocol. +

+

Computes the MD5 hash of the data to be written, and on close writes +this to the designated output or stdout if none is specified. It can +be used to test muxers without writing an actual file. +

+

Some examples follow. +

+
# Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
+ffmpeg -i input.flv -f avi -y md5:output.avi.md5
+
+# Write the MD5 hash of the encoded AVI file to stdout.
+ffmpeg -i input.flv -f avi -y md5:
+
+ +

Note that some formats (typically MOV) require the output protocol to +be seekable, so they will fail with the MD5 output protocol. +

+ +

24.17 pipe

+ +

UNIX pipe access protocol. +

+

Read and write from UNIX pipes. +

+

The accepted syntax is: +

+
pipe:[number]
+
+ +

number is the number corresponding to the file descriptor of the +pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr). If number +is not specified, by default the stdout file descriptor will be used +for writing, stdin for reading. +

+

For example to read from stdin with ffmpeg: +

+
cat test.wav | ffmpeg -i pipe:0
+# ...this is the same as...
+cat test.wav | ffmpeg -i pipe:
+
+ +

For writing to stdout with ffmpeg: +

+
ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
+# ...this is the same as...
+ffmpeg -i test.wav -f avi pipe: | cat > test.avi
+
+ +

This protocol accepts the following options: +

+
+
blocksize
+

Set I/O operation maximum block size, in bytes. Default value is +INT_MAX, which results in not limiting the requested block size. +Setting this value reasonably low improves user termination request reaction +time, which is valuable if data transmission is slow. +

+
+ +

Note that some formats (typically MOV), require the output protocol to +be seekable, so they will fail with the pipe output protocol. +

+ +

24.18 prompeg

+ +

Pro-MPEG Code of Practice #3 Release 2 FEC protocol. +

+

The Pro-MPEG CoP#3 FEC is a 2D parity-check forward error correction mechanism +for MPEG-2 Transport Streams sent over RTP. +

+

This protocol must be used in conjunction with the rtp_mpegts muxer and +the rtp protocol. +

+

The required syntax is: +

+
-f rtp_mpegts -fec prompeg=option=val... rtp://hostname:port
+
+ +

The destination UDP ports are port + 2 for the column FEC stream +and port + 4 for the row FEC stream. +

+

This protocol accepts the following options: +

+
l=n
+

The number of columns (4-20, LxD <= 100) +

+
+
d=n
+

The number of rows (4-20, LxD <= 100) +

+
+
+ +

Example usage: +

+
+
-f rtp_mpegts -fec prompeg=l=8:d=4 rtp://hostname:port
+
+ + +

24.19 rtmp

+ +

Real-Time Messaging Protocol. +

+

The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia +content across a TCP/IP network. +

+

The required syntax is: +

+
rtmp://[username:password@]server[:port][/app][/instance][/playpath]
+
+ +

The accepted parameters are: +

+
username
+

An optional username (mostly for publishing). +

+
+
password
+

An optional password (mostly for publishing). +

+
+
server
+

The address of the RTMP server. +

+
+
port
+

The number of the TCP port to use (by default is 1935). +

+
+
app
+

It is the name of the application to access. It usually corresponds to +the path where the application is installed on the RTMP server +(e.g. /ondemand/, /flash/live/, etc.). You can override +the value parsed from the URI through the rtmp_app option, too. +

+
+
playpath
+

It is the path or name of the resource to play with reference to the +application specified in app, may be prefixed by "mp4:". You +can override the value parsed from the URI through the rtmp_playpath +option, too. +

+
+
listen
+

Act as a server, listening for an incoming connection. +

+
+
timeout
+

Maximum time to wait for the incoming connection. Implies listen. +

+
+ +

Additionally, the following parameters can be set via command line options +(or in code via AVOptions): +

+
rtmp_app
+

Name of application to connect on the RTMP server. This option +overrides the parameter specified in the URI. +

+
+
rtmp_buffer
+

Set the client buffer time in milliseconds. The default is 3000. +

+
+
rtmp_conn
+

Extra arbitrary AMF connection parameters, parsed from a string, +e.g. like B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0. +Each value is prefixed by a single character denoting the type, +B for Boolean, N for number, S for string, O for object, or Z for null, +followed by a colon. For Booleans the data must be either 0 or 1 for +FALSE or TRUE, respectively. Likewise for Objects the data must be 0 or +1 to end or begin an object, respectively. Data items in subobjects may +be named, by prefixing the type with ’N’ and specifying the name before +the value (i.e. NB:myFlag:1). This option may be used multiple +times to construct arbitrary AMF sequences. +

+
+
rtmp_flashver
+

Version of the Flash plugin used to run the SWF player. The default +is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible; +<libavformat version>).) +

+
+
rtmp_flush_interval
+

Number of packets flushed in the same request (RTMPT only). The default +is 10. +

+
+
rtmp_live
+

Specify that the media is a live stream. No resuming or seeking in +live streams is possible. The default value is any, which means the +subscriber first tries to play the live stream specified in the +playpath. If a live stream of that name is not found, it plays the +recorded stream. The other possible values are live and +recorded. +

+
+
rtmp_pageurl
+

URL of the web page in which the media was embedded. By default no +value will be sent. +

+
+
rtmp_playpath
+

Stream identifier to play or to publish. This option overrides the +parameter specified in the URI. +

+
+
rtmp_subscribe
+

Name of live stream to subscribe to. By default no value will be sent. +It is only sent if the option is specified or if rtmp_live +is set to live. +

+
+
rtmp_swfhash
+

SHA256 hash of the decompressed SWF file (32 bytes). +

+
+
rtmp_swfsize
+

Size of the decompressed SWF file, required for SWFVerification. +

+
+
rtmp_swfurl
+

URL of the SWF player for the media. By default no value will be sent. +

+
+
rtmp_swfverify
+

URL to player swf file, compute hash/size automatically. +

+
+
rtmp_tcurl
+

URL of the target stream. Defaults to proto://host[:port]/app. +

+
+
+ +

For example to read with ffplay a multimedia resource named +"sample" from the application "vod" from an RTMP server "myserver": +

+
ffplay rtmp://myserver/vod/sample
+
+ +

To publish to a password protected server, passing the playpath and +app names separately: +

+
ffmpeg -re -i <input> -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@myserver/
+
+ + +

24.20 rtmpe

+ +

Encrypted Real-Time Messaging Protocol. +

+

The Encrypted Real-Time Messaging Protocol (RTMPE) is used for +streaming multimedia content within standard cryptographic primitives, +consisting of Diffie-Hellman key exchange and HMACSHA256, generating +a pair of RC4 keys. +

+ +

24.21 rtmps

+ +

Real-Time Messaging Protocol over a secure SSL connection. +

+

The Real-Time Messaging Protocol (RTMPS) is used for streaming +multimedia content across an encrypted connection. +

+ +

24.22 rtmpt

+ +

Real-Time Messaging Protocol tunneled through HTTP. +

+

The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used +for streaming multimedia content within HTTP requests to traverse +firewalls. +

+ +

24.23 rtmpte

+ +

Encrypted Real-Time Messaging Protocol tunneled through HTTP. +

+

The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE) +is used for streaming multimedia content within HTTP requests to traverse +firewalls. +

+ +

24.24 rtmpts

+ +

Real-Time Messaging Protocol tunneled through HTTPS. +

+

The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used +for streaming multimedia content within HTTPS requests to traverse +firewalls. +

+ +

24.25 libsmbclient

+ +

libsmbclient permits one to manipulate CIFS/SMB network resources. +

+

Following syntax is required. +

+
+
smb://[[domain:]user[:password@]]server[/share[/path[/file]]]
+
+ +

This protocol accepts the following options. +

+
+
timeout
+

Set timeout in milliseconds of socket I/O operations used by the underlying +low level operation. By default it is set to -1, which means that the timeout +is not specified. +

+
+
truncate
+

Truncate existing files on write, if set to 1. A value of 0 prevents +truncating. Default value is 1. +

+
+
workgroup
+

Set the workgroup used for making connections. By default workgroup is not specified. +

+
+
+ +

For more information see: http://www.samba.org/. +

+ +

24.26 libssh

+ +

Secure File Transfer Protocol via libssh +

+

Read from or write to remote resources using SFTP protocol. +

+

Following syntax is required. +

+
+
sftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg
+
+ +

This protocol accepts the following options. +

+
+
timeout
+

Set timeout of socket I/O operations used by the underlying low level +operation. By default it is set to -1, which means that the timeout +is not specified. +

+
+
truncate
+

Truncate existing files on write, if set to 1. A value of 0 prevents +truncating. Default value is 1. +

+
+
private_key
+

Specify the path of the file containing private key to use during authorization. +By default libssh searches for keys in the ~/.ssh/ directory. +

+
+
+ +

Example: Play a file stored on remote server. +

+
+
ffplay sftp://user:password@server_address:22/home/user/resource.mpeg
+
+ + +

24.27 librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte

+ +

Real-Time Messaging Protocol and its variants supported through +librtmp. +

+

Requires the presence of the librtmp headers and library during +configuration. You need to explicitly configure the build with +"–enable-librtmp". If enabled this will replace the native RTMP +protocol. +

+

This protocol provides most client functions and a few server +functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT), +encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled +variants of these encrypted types (RTMPTE, RTMPTS). +

+

The required syntax is: +

+
rtmp_proto://server[:port][/app][/playpath] options
+
+ +

where rtmp_proto is one of the strings "rtmp", "rtmpt", "rtmpe", +"rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and +server, port, app and playpath have the same +meaning as specified for the RTMP native protocol. +options contains a list of space-separated options of the form +key=val. +

+

See the librtmp manual page (man 3 librtmp) for more information. +

+

For example, to stream a file in real-time to an RTMP server using +ffmpeg: +

+
ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
+
+ +

To play the same stream using ffplay: +

+
ffplay "rtmp://myserver/live/mystream live=1"
+
+ + +

24.28 rtp

+ +

Real-time Transport Protocol. +

+

The required syntax for an RTP URL is: +rtp://hostname[:port][?option=val...] +

+

port specifies the RTP port to use. +

+

The following URL options are supported: +

+
+
ttl=n
+

Set the TTL (Time-To-Live) value (for multicast only). +

+
+
rtcpport=n
+

Set the remote RTCP port to n. +

+
+
localrtpport=n
+

Set the local RTP port to n. +

+
+
localrtcpport=n'
+

Set the local RTCP port to n. +

+
+
pkt_size=n
+

Set max packet size (in bytes) to n. +

+
+
connect=0|1
+

Do a connect() on the UDP socket (if set to 1) or not (if set +to 0). +

+
+
sources=ip[,ip]
+

List allowed source IP addresses. +

+
+
block=ip[,ip]
+

List disallowed (blocked) source IP addresses. +

+
+
write_to_source=0|1
+

Send packets to the source address of the latest received packet (if +set to 1) or to a default remote address (if set to 0). +

+
+
localport=n
+

Set the local RTP port to n. +

+

This is a deprecated option. Instead, localrtpport should be +used. +

+
+
+ +

Important notes: +

+
    +
  1. If rtcpport is not set the RTCP port will be set to the RTP +port value plus 1. + +
  2. If localrtpport (the local RTP port) is not set any available +port will be used for the local RTP and RTCP ports. + +
  3. If localrtcpport (the local RTCP port) is not set it will be +set to the local RTP port value plus 1. +
+ + +

24.29 rtsp

+ +

Real-Time Streaming Protocol. +

+

RTSP is not technically a protocol handler in libavformat, it is a demuxer +and muxer. The demuxer supports both normal RTSP (with data transferred +over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with +data transferred over RDT). +

+

The muxer can be used to send a stream using RTSP ANNOUNCE to a server +supporting it (currently Darwin Streaming Server and Mischa Spiegelmock’s +RTSP server). +

+

The required syntax for a RTSP url is: +

+
rtsp://hostname[:port]/path
+
+ +

Options can be set on the ffmpeg/ffplay command +line, or set in code via AVOptions or in +avformat_open_input. +

+

The following options are supported. +

+
+
initial_pause
+

Do not start playing the stream immediately if set to 1. Default value +is 0. +

+
+
rtsp_transport
+

Set RTSP transport protocols. +

+

It accepts the following values: +

+
‘udp’
+

Use UDP as lower transport protocol. +

+
+
‘tcp’
+

Use TCP (interleaving within the RTSP control channel) as lower +transport protocol. +

+
+
‘udp_multicast’
+

Use UDP multicast as lower transport protocol. +

+
+
‘http’
+

Use HTTP tunneling as lower transport protocol, which is useful for +passing proxies. +

+
+ +

Multiple lower transport protocols may be specified, in that case they are +tried one at a time (if the setup of one fails, the next one is tried). +For the muxer, only the ‘tcp’ and ‘udp’ options are supported. +

+
+
rtsp_flags
+

Set RTSP flags. +

+

The following values are accepted: +

+
‘filter_src’
+

Accept packets only from negotiated peer address and port. +

+
‘listen’
+

Act as a server, listening for an incoming connection. +

+
‘prefer_tcp’
+

Try TCP for RTP transport first, if TCP is available as RTSP RTP transport. +

+
+ +

Default value is ‘none’. +

+
+
allowed_media_types
+

Set media types to accept from the server. +

+

The following flags are accepted: +

+
‘video’
+
‘audio’
+
‘data’
+
+ +

By default it accepts all media types. +

+
+
min_port
+

Set minimum local UDP port. Default value is 5000. +

+
+
max_port
+

Set maximum local UDP port. Default value is 65000. +

+
+
timeout
+

Set maximum timeout (in seconds) to wait for incoming connections. +

+

A value of -1 means infinite (default). This option implies the +rtsp_flags set to ‘listen’. +

+
+
reorder_queue_size
+

Set number of packets to buffer for handling of reordered packets. +

+
+
stimeout
+

Set socket TCP I/O timeout in microseconds. +

+
+
user-agent
+

Override User-Agent header. If not specified, it defaults to the +libavformat identifier string. +

+
+ +

When receiving data over UDP, the demuxer tries to reorder received packets +(since they may arrive out of order, or packets may get lost totally). This +can be disabled by setting the maximum demuxing delay to zero (via +the max_delay field of AVFormatContext). +

+

When watching multi-bitrate Real-RTSP streams with ffplay, the +streams to display can be chosen with -vst n and +-ast n for video and audio respectively, and can be switched +on the fly by pressing v and a. +

+ +

24.29.1 Examples

+ +

The following examples all make use of the ffplay and +ffmpeg tools. +

+
    +
  • Watch a stream over UDP, with a max reordering delay of 0.5 seconds: +
    +
    ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
+
    + +
  • Watch a stream tunneled over HTTP: +
    +
    ffplay -rtsp_transport http rtsp://server/video.mp4
+
    + +
  • Send a stream in realtime to a RTSP server, for others to watch: +
    +
    ffmpeg -re -i input -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
+
    + +
  • Receive a stream in realtime: +
    +
    ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp output
+
    +
+ + +

24.30 sap

+ +

Session Announcement Protocol (RFC 2974). This is not technically a +protocol handler in libavformat, it is a muxer and demuxer. +It is used for signalling of RTP streams, by announcing the SDP for the +streams regularly on a separate port. +

+ +

24.30.1 Muxer

+ +

The syntax for a SAP url given to the muxer is: +

+
sap://destination[:port][?options]
+
+ +

The RTP packets are sent to destination on port port, +or to port 5004 if no port is specified. +options is a &-separated list. The following options +are supported: +

+
+
announce_addr=address
+

Specify the destination IP address for sending the announcements to. +If omitted, the announcements are sent to the commonly used SAP +announcement multicast address 224.2.127.254 (sap.mcast.net), or +ff0e::2:7ffe if destination is an IPv6 address. +

+
+
announce_port=port
+

Specify the port to send the announcements on, defaults to +9875 if not specified. +

+
+
ttl=ttl
+

Specify the time to live value for the announcements and RTP packets, +defaults to 255. +

+
+
same_port=0|1
+

If set to 1, send all RTP streams on the same port pair. If zero (the +default), all streams are sent on unique ports, with each stream on a +port 2 numbers higher than the previous. +VLC/Live555 requires this to be set to 1, to be able to receive the stream. +The RTP stack in libavformat for receiving requires all streams to be sent +on unique ports. +

+
+ +

Example command lines follow. +

+

To broadcast a stream on the local subnet, for watching in VLC: +

+
+
ffmpeg -re -i input -f sap sap://224.0.0.255?same_port=1
+
+ +

Similarly, for watching in ffplay: +

+
+
ffmpeg -re -i input -f sap sap://224.0.0.255
+
+ +

And for watching in ffplay, over IPv6: +

+
+
ffmpeg -re -i input -f sap sap://[ff0e::1:2:3:4]
+
+ + +

24.30.2 Demuxer

+ +

The syntax for a SAP url given to the demuxer is: +

+
sap://[address][:port]
+
+ +

address is the multicast address to listen for announcements on, +if omitted, the default 224.2.127.254 (sap.mcast.net) is used. port +is the port that is listened on, 9875 if omitted. +

+

The demuxers listens for announcements on the given address and port. +Once an announcement is received, it tries to receive that particular stream. +

+

Example command lines follow. +

+

To play back the first stream announced on the normal SAP multicast address: +

+
+
ffplay sap://
+
+ +

To play back the first stream announced on one the default IPv6 SAP multicast address: +

+
+
ffplay sap://[ff0e::2:7ffe]
+
+ + +

24.31 sctp

+ +

Stream Control Transmission Protocol. +

+

The accepted URL syntax is: +

+
sctp://host:port[?options]
+
+ +

The protocol accepts the following options: +

+
listen
+

If set to any value, listen for an incoming connection. Outgoing connection is done by default. +

+
+
max_streams
+

Set the maximum number of streams. By default no limit is set. +

+
+ + +

24.32 srt

+ +

Haivision Secure Reliable Transport Protocol via libsrt. +

+

The supported syntax for a SRT URL is: +

+
srt://hostname:port[?options]
+
+ +

options contains a list of &-separated options of the form +key=val. +

+

or +

+
+
options srt://hostname:port
+
+ +

options contains a list of ’-key val’ +options. +

+

This protocol accepts the following options. +

+
+
connect_timeout=milliseconds
+

Connection timeout; SRT cannot connect for RTT > 1500 msec +(2 handshake exchanges) with the default connect timeout of +3 seconds. This option applies to the caller and rendezvous +connection modes. The connect timeout is 10 times the value +set for the rendezvous mode (which can be used as a +workaround for this connection problem with earlier versions). +

+
+
ffs=bytes
+

Flight Flag Size (Window Size), in bytes. FFS is actually an +internal parameter and you should set it to not less than +recv_buffer_size and mss. The default value +is relatively large, therefore unless you set a very large receiver buffer, +you do not need to change this option. Default value is 25600. +

+
+
inputbw=bytes/seconds
+

Sender nominal input rate, in bytes per seconds. Used along with +oheadbw, when maxbw is set to relative (0), to +calculate maximum sending rate when recovery packets are sent +along with the main media stream: +inputbw * (100 + oheadbw) / 100 +if inputbw is not set while maxbw is set to +relative (0), the actual input rate is evaluated inside +the library. Default value is 0. +

+
+
iptos=tos
+

IP Type of Service. Applies to sender only. Default value is 0xB8. +

+
+
ipttl=ttl
+

IP Time To Live. Applies to sender only. Default value is 64. +

+
+
latency=microseconds
+

Timestamp-based Packet Delivery Delay. +Used to absorb bursts of missed packet retransmissions. +This flag sets both rcvlatency and peerlatency +to the same value. Note that prior to version 1.3.0 +this is the only flag to set the latency, however +this is effectively equivalent to setting peerlatency, +when side is sender and rcvlatency +when side is receiver, and the bidirectional stream +sending is not supported. +

+
+
listen_timeout=microseconds
+

Set socket listen timeout. +

+
+
maxbw=bytes/seconds
+

Maximum sending bandwidth, in bytes per seconds. +-1 infinite (CSRTCC limit is 30mbps) +0 relative to input rate (see inputbw) +>0 absolute limit value +Default value is 0 (relative) +

+
+
mode=caller|listener|rendezvous
+

Connection mode. +caller opens client connection. +listener starts server to listen for incoming connections. +rendezvous use Rendez-Vous connection mode. +Default value is caller. +

+
+
mss=bytes
+

Maximum Segment Size, in bytes. Used for buffer allocation +and rate calculation using a packet counter assuming fully +filled packets. The smallest MSS between the peers is +used. This is 1500 by default in the overall internet. +This is the maximum size of the UDP packet and can be +only decreased, unless you have some unusual dedicated +network settings. Default value is 1500. +

+
+
nakreport=1|0
+

If set to 1, Receiver will send ‘UMSG_LOSSREPORT‘ messages +periodically until a lost packet is retransmitted or +intentionally dropped. Default value is 1. +

+
+
oheadbw=percents
+

Recovery bandwidth overhead above input rate, in percents. +See inputbw. Default value is 25%. +

+
+
passphrase=string
+

HaiCrypt Encryption/Decryption Passphrase string, length +from 10 to 79 characters. The passphrase is the shared +secret between the sender and the receiver. It is used +to generate the Key Encrypting Key using PBKDF2 +(Password-Based Key Derivation Function). It is used +only if pbkeylen is non-zero. It is used on +the receiver only if the received data is encrypted. +The configured passphrase cannot be recovered (write-only). +

+
+
enforced_encryption=1|0
+

If true, both connection parties must have the same password +set (including empty, that is, with no encryption). If the +password doesn’t match or only one side is unencrypted, +the connection is rejected. Default is true. +

+
+
kmrefreshrate=packets
+

The number of packets to be transmitted after which the +encryption key is switched to a new key. Default is -1. +-1 means auto (0x1000000 in srt library). The range for +this option is integers in the 0 - INT_MAX. +

+
+
kmpreannounce=packets
+

The interval between when a new encryption key is sent and +when switchover occurs. This value also applies to the +subsequent interval between when switchover occurs and +when the old encryption key is decommissioned. Default is -1. +-1 means auto (0x1000 in srt library). The range for +this option is integers in the 0 - INT_MAX. +

+
+
payload_size=bytes
+

Sets the maximum declared size of a packet transferred +during the single call to the sending function in Live +mode. Use 0 if this value isn’t used (which is default in +file mode). +Default is -1 (automatic), which typically means MPEG-TS; +if you are going to use SRT +to send any different kind of payload, such as, for example, +wrapping a live stream in very small frames, then you can +use a bigger maximum frame size, though not greater than +1456 bytes. +

+
+
pkt_size=bytes
+

Alias for ‘payload_size’. +

+
+
peerlatency=microseconds
+

The latency value (as described in rcvlatency) that is +set by the sender side as a minimum value for the receiver. +

+
+
pbkeylen=bytes
+

Sender encryption key length, in bytes. +Only can be set to 0, 16, 24 and 32. +Enable sender encryption if not 0. +Not required on receiver (set to 0), +key size obtained from sender in HaiCrypt handshake. +Default value is 0. +

+
+
rcvlatency=microseconds
+

The time that should elapse since the moment when the +packet was sent and the moment when it’s delivered to +the receiver application in the receiving function. +This time should be a buffer time large enough to cover +the time spent for sending, unexpectedly extended RTT +time, and the time needed to retransmit the lost UDP +packet. The effective latency value will be the maximum +of this options’ value and the value of peerlatency +set by the peer side. Before version 1.3.0 this option +is only available as latency. +

+
+
recv_buffer_size=bytes
+

Set UDP receive buffer size, expressed in bytes. +

+
+
send_buffer_size=bytes
+

Set UDP send buffer size, expressed in bytes. +

+
+
timeout=microseconds
+

Set raise error timeouts for read, write and connect operations. Note that the +SRT library has internal timeouts which can be controlled separately, the +value set here is only a cap on those. +

+
+
tlpktdrop=1|0
+

Too-late Packet Drop. When enabled on receiver, it skips +missing packets that have not been delivered in time and +delivers the following packets to the application when +their time-to-play has come. It also sends a fake ACK to +the sender. When enabled on sender and enabled on the +receiving peer, the sender drops the older packets that +have no chance of being delivered in time. It was +automatically enabled in the sender if the receiver +supports it. +

+
+
sndbuf=bytes
+

Set send buffer size, expressed in bytes. +

+
+
rcvbuf=bytes
+

Set receive buffer size, expressed in bytes. +

+

Receive buffer must not be greater than ffs. +

+
+
lossmaxttl=packets
+

The value up to which the Reorder Tolerance may grow. When +Reorder Tolerance is > 0, then packet loss report is delayed +until that number of packets come in. Reorder Tolerance +increases every time a "belated" packet has come, but it +wasn’t due to retransmission (that is, when UDP packets tend +to come out of order), with the difference between the latest +sequence and this packet’s sequence, and not more than the +value of this option. By default it’s 0, which means that this +mechanism is turned off, and the loss report is always sent +immediately upon experiencing a "gap" in sequences. +

+
+
minversion
+

The minimum SRT version that is required from the peer. A connection +to a peer that does not satisfy the minimum version requirement +will be rejected. +

+

The version format in hex is 0xXXYYZZ for x.y.z in human readable +form. +

+
+
streamid=string
+

A string limited to 512 characters that can be set on the socket prior +to connecting. This stream ID will be able to be retrieved by the +listener side from the socket that is returned from srt_accept and +was connected by a socket with that set stream ID. SRT does not enforce +any special interpretation of the contents of this string. +This option doesn’t make sense in Rendezvous connection; the result +might be that simply one side will override the value from the other +side and it’s the matter of luck which one would win +

+
+
smoother=live|file
+

The type of Smoother used for the transmission for that socket, which +is responsible for the transmission and congestion control. The Smoother +type must be exactly the same on both connecting parties, otherwise +the connection is rejected. +

+
+
messageapi=1|0
+

When set, this socket uses the Message API, otherwise it uses Buffer +API. Note that in live mode (see transtype) there’s only +message API available. In File mode you can chose to use one of two modes: +

+

Stream API (default, when this option is false). In this mode you may +send as many data as you wish with one sending instruction, or even use +dedicated functions that read directly from a file. The internal facility +will take care of any speed and congestion control. When receiving, you +can also receive as many data as desired, the data not extracted will be +waiting for the next call. There is no boundary between data portions in +the Stream mode. +

+

Message API. In this mode your single sending instruction passes exactly +one piece of data that has boundaries (a message). Contrary to Live mode, +this message may span across multiple UDP packets and the only size +limitation is that it shall fit as a whole in the sending buffer. The +receiver shall use as large buffer as necessary to receive the message, +otherwise the message will not be given up. When the message is not +complete (not all packets received or there was a packet loss) it will +not be given up. +

+
+
transtype=live|file
+

Sets the transmission type for the socket, in particular, setting this +option sets multiple other parameters to their default values as required +for a particular transmission type. +

+

live: Set options as for live transmission. In this mode, you should +send by one sending instruction only so many data that fit in one UDP packet, +and limited to the value defined first in payload_size (1316 is +default in this mode). There is no speed control in this mode, only the +bandwidth control, if configured, in order to not exceed the bandwidth with +the overhead transmission (retransmitted and control packets). +

+

file: Set options as for non-live transmission. See messageapi +for further explanations +

+
+
linger=seconds
+

The number of seconds that the socket waits for unsent data when closing. +Default is -1. -1 means auto (off with 0 seconds in live mode, on with 180 +seconds in file mode). The range for this option is integers in the +0 - INT_MAX. +

+
+
+ +

For more information see: https://github.com/Haivision/srt. +

+ +

24.33 srtp

+ +

Secure Real-time Transport Protocol. +

+

The accepted options are: +

+
srtp_in_suite
+
srtp_out_suite
+

Select input and output encoding suites. +

+

Supported values: +

+
‘AES_CM_128_HMAC_SHA1_80’
+
‘SRTP_AES128_CM_HMAC_SHA1_80’
+
‘AES_CM_128_HMAC_SHA1_32’
+
‘SRTP_AES128_CM_HMAC_SHA1_32’
+
+ +
+
srtp_in_params
+
srtp_out_params
+

Set input and output encoding parameters, which are expressed by a +base64-encoded representation of a binary block. The first 16 bytes of +this binary block are used as master key, the following 14 bytes are +used as master salt. +

+
+ + +

24.34 subfile

+ +

Virtually extract a segment of a file or another stream. +The underlying stream must be seekable. +

+

Accepted options: +

+
start
+

Start offset of the extracted segment, in bytes. +

+
end
+

End offset of the extracted segment, in bytes. +If set to 0, extract till end of file. +

+
+ +

Examples: +

+

Extract a chapter from a DVD VOB file (start and end sectors obtained +externally and multiplied by 2048): +

+
subfile,,start,153391104,end,268142592,,:/media/dvd/VIDEO_TS/VTS_08_1.VOB
+
+ +

Play an AVI file directly from a TAR archive: +

+
subfile,,start,183241728,end,366490624,,:archive.tar
+
+ +

Play a MPEG-TS file from start offset till end: +

+
subfile,,start,32815239,end,0,,:video.ts
+
+ + +

24.35 tee

+ +

Writes the output to multiple protocols. The individual outputs are separated +by | +

+
+
tee:file://path/to/local/this.avi|file://path/to/local/that.avi
+
+ + +

24.36 tcp

+ +

Transmission Control Protocol. +

+

The required syntax for a TCP url is: +

+
tcp://hostname:port[?options]
+
+ +

options contains a list of &-separated options of the form +key=val. +

+

The list of supported options follows. +

+
+
listen=1|0
+

Listen for an incoming connection. Default value is 0. +

+
+
timeout=microseconds
+

Set raise error timeout, expressed in microseconds. +

+

This option is only relevant in read mode: if no data arrived in more +than this time interval, raise error. +

+
+
listen_timeout=milliseconds
+

Set listen timeout, expressed in milliseconds. +

+
+
recv_buffer_size=bytes
+

Set receive buffer size, expressed bytes. +

+
+
send_buffer_size=bytes
+

Set send buffer size, expressed bytes. +

+
+
tcp_nodelay=1|0
+

Set TCP_NODELAY to disable Nagle’s algorithm. Default value is 0. +

+
+
tcp_mss=bytes
+

Set maximum segment size for outgoing TCP packets, expressed in bytes. +

+
+ +

The following example shows how to setup a listening TCP connection +with ffmpeg, which is then accessed with ffplay: +

+
ffmpeg -i input -f format tcp://hostname:port?listen
+ffplay tcp://hostname:port
+
+ + +

24.37 tls

+ +

Transport Layer Security (TLS) / Secure Sockets Layer (SSL) +

+

The required syntax for a TLS/SSL url is: +

+
tls://hostname:port[?options]
+
+ +

The following parameters can be set via command line options +(or in code via AVOptions): +

+
+
ca_file, cafile=filename
+

A file containing certificate authority (CA) root certificates to treat +as trusted. If the linked TLS library contains a default this might not +need to be specified for verification to work, but not all libraries and +setups have defaults built in. +The file must be in OpenSSL PEM format. +

+
+
tls_verify=1|0
+

If enabled, try to verify the peer that we are communicating with. +Note, if using OpenSSL, this currently only makes sure that the +peer certificate is signed by one of the root certificates in the CA +database, but it does not validate that the certificate actually +matches the host name we are trying to connect to. (With other backends, +the host name is validated as well.) +

+

This is disabled by default since it requires a CA database to be +provided by the caller in many cases. +

+
+
cert_file, cert=filename
+

A file containing a certificate to use in the handshake with the peer. +(When operating as server, in listen mode, this is more often required +by the peer, while client certificates only are mandated in certain +setups.) +

+
+
key_file, key=filename
+

A file containing the private key for the certificate. +

+
+
listen=1|0
+

If enabled, listen for connections on the provided port, and assume +the server role in the handshake instead of the client role. +

+
+
+ +

Example command lines: +

+

To create a TLS/SSL server that serves an input stream. +

+
+
ffmpeg -i input -f format tls://hostname:port?listen&cert=server.crt&key=server.key
+
+ +

To play back a stream from the TLS/SSL server using ffplay: +

+
+
ffplay tls://hostname:port
+
+ + +

24.38 udp

+ +

User Datagram Protocol. +

+

The required syntax for an UDP URL is: +

+
udp://hostname:port[?options]
+
+ +

options contains a list of &-separated options of the form key=val. +

+

In case threading is enabled on the system, a circular buffer is used +to store the incoming data, which allows one to reduce loss of data due to +UDP socket buffer overruns. The fifo_size and +overrun_nonfatal options are related to this buffer. +

+

The list of supported options follows. +

+
+
buffer_size=size
+

Set the UDP maximum socket buffer size in bytes. This is used to set either +the receive or send buffer size, depending on what the socket is used for. +Default is 32 KB for output, 384 KB for input. See also fifo_size. +

+
+
bitrate=bitrate
+

If set to nonzero, the output will have the specified constant bitrate if the +input has enough packets to sustain it. +

+
+
burst_bits=bits
+

When using bitrate this specifies the maximum number of bits in +packet bursts. +

+
+
localport=port
+

Override the local UDP port to bind with. +

+
+
localaddr=addr
+

Local IP address of a network interface used for sending packets or joining +multicast groups. +

+
+
pkt_size=size
+

Set the size in bytes of UDP packets. +

+
+
reuse=1|0
+

Explicitly allow or disallow reusing UDP sockets. +

+
+
ttl=ttl
+

Set the time to live value (for multicast only). +

+
+
connect=1|0
+

Initialize the UDP socket with connect(). In this case, the +destination address can’t be changed with ff_udp_set_remote_url later. +If the destination address isn’t known at the start, this option can +be specified in ff_udp_set_remote_url, too. +This allows finding out the source address for the packets with getsockname, +and makes writes return with AVERROR(ECONNREFUSED) if "destination +unreachable" is received. +For receiving, this gives the benefit of only receiving packets from +the specified peer address/port. +

+
+
sources=address[,address]
+

Only receive packets sent from the specified addresses. In case of multicast, +also subscribe to multicast traffic coming from these addresses only. +

+
+
block=address[,address]
+

Ignore packets sent from the specified addresses. In case of multicast, also +exclude the source addresses in the multicast subscription. +

+
+
fifo_size=units
+

Set the UDP receiving circular buffer size, expressed as a number of +packets with size of 188 bytes. If not specified defaults to 7*4096. +

+
+
overrun_nonfatal=1|0
+

Survive in case of UDP receiving circular buffer overrun. Default +value is 0. +

+
+
timeout=microseconds
+

Set raise error timeout, expressed in microseconds. +

+

This option is only relevant in read mode: if no data arrived in more +than this time interval, raise error. +

+
+
broadcast=1|0
+

Explicitly allow or disallow UDP broadcasting. +

+

Note that broadcasting may not work properly on networks having +a broadcast storm protection. +

+
+ + +

24.38.1 Examples

+ +
    +
  • Use ffmpeg to stream over UDP to a remote endpoint: +
    +
    ffmpeg -i input -f format udp://hostname:port
+
    + +
  • Use ffmpeg to stream in mpegts format over UDP using 188 +sized UDP packets, using a large input buffer: +
    +
    ffmpeg -i input -f mpegts udp://hostname:port?pkt_size=188&buffer_size=65535
+
    + +
  • Use ffmpeg to receive over UDP from a remote endpoint: +
    +
    ffmpeg -i udp://[multicast-address]:port ...
+
    +
+ + +

24.39 unix

+ +

Unix local socket +

+

The required syntax for a Unix socket URL is: +

+
+
unix://filepath
+
+ +

The following parameters can be set via command line options +(or in code via AVOptions): +

+
+
timeout
+

Timeout in ms. +

+
listen
+

Create the Unix socket in listening mode. +

+
+ + +

24.40 zmq

+ +

ZeroMQ asynchronous messaging using the libzmq library. +

+

This library supports unicast streaming to multiple clients without relying on +an external server. +

+

The required syntax for streaming or connecting to a stream is: +

+
zmq:tcp://ip-address:port
+
+ +

Example: +Create a localhost stream on port 5555: +

+
ffmpeg -re -i input -f mpegts zmq:tcp://127.0.0.1:5555
+
+ +

Multiple clients may connect to the stream using: +

+
ffplay zmq:tcp://127.0.0.1:5555
+
+ +

Streaming to multiple clients is implemented using a ZeroMQ Pub-Sub pattern. +The server side binds to a port and publishes data. Clients connect to the +server (via IP address/port) and subscribe to the stream. The order in which +the server and client start generally does not matter. +

+

ffmpeg must be compiled with the –enable-libzmq option to support +this protocol. +

+

Options can be set on the ffmpeg/ffplay command +line. The following options are supported: +

+
+
pkt_size
+

Forces the maximum packet size for sending/receiving data. The default value is +131,072 bytes. On the server side, this sets the maximum size of sent packets +via ZeroMQ. On the clients, it sets an internal buffer size for receiving +packets. Note that pkt_size on the clients should be equal to or greater than +pkt_size on the server. Otherwise the received message may be truncated causing +decoding errors. +

+
+
+ + + +

25 Device Options

+ +

The libavdevice library provides the same interface as +libavformat. Namely, an input device is considered like a demuxer, and +an output device like a muxer, and the interface and generic device +options are the same provided by libavformat (see the ffmpeg-formats +manual). +

+

In addition each input or output device may support so-called private +options, which are specific for that component. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the device +AVFormatContext options or using the libavutil/opt.h API +for programmatic use. +

+ + +

26 Input Devices

+ +

Input devices are configured elements in FFmpeg which enable accessing +the data coming from a multimedia device attached to your system. +

+

When you configure your FFmpeg build, all the supported input devices +are enabled by default. You can list all available ones using the +configure option "–list-indevs". +

+

You can disable all the input devices using the configure option +"–disable-indevs", and selectively enable an input device using the +option "–enable-indev=INDEV", or you can disable a particular +input device using the option "–disable-indev=INDEV". +

+

The option "-devices" of the ff* tools will display the list of +supported input devices. +

+

A description of the currently available input devices follows. +

+ +

26.1 alsa

+ +

ALSA (Advanced Linux Sound Architecture) input device. +

+

To enable this input device during configuration you need libasound +installed on your system. +

+

This device allows capturing from an ALSA device. The name of the +device to capture has to be an ALSA card identifier. +

+

An ALSA identifier has the syntax: +

+
hw:CARD[,DEV[,SUBDEV]]
+
+ +

where the DEV and SUBDEV components are optional. +

+

The three arguments (in order: CARD,DEV,SUBDEV) +specify card number or identifier, device number and subdevice number +(-1 means any). +

+

To see the list of cards currently recognized by your system check the +files /proc/asound/cards and /proc/asound/devices. +

+

For example to capture with ffmpeg from an ALSA device with +card id 0, you may run the command: +

+
ffmpeg -f alsa -i hw:0 alsaout.wav
+
+ +

For more information see: +http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html +

+ +

26.1.1 Options

+ +
+
sample_rate
+

Set the sample rate in Hz. Default is 48000. +

+
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

26.2 android_camera

+ +

Android camera input device. +

+

This input devices uses the Android Camera2 NDK API which is +available on devices with API level 24+. The availability of +android_camera is autodetected during configuration. +

+

This device allows capturing from all cameras on an Android device, +which are integrated into the Camera2 NDK API. +

+

The available cameras are enumerated internally and can be selected +with the camera_index parameter. The input file string is +discarded. +

+

Generally the back facing camera has index 0 while the front facing +camera has index 1. +

+ +

26.2.1 Options

+ +
+
video_size
+

Set the video size given as a string such as 640x480 or hd720. +Falls back to the first available configuration reported by +Android if requested video size is not available or by default. +

+
+
framerate
+

Set the video framerate. +Falls back to the first available configuration reported by +Android if requested framerate is not available or by default (-1). +

+
+
camera_index
+

Set the index of the camera to use. Default is 0. +

+
+
input_queue_size
+

Set the maximum number of frames to buffer. Default is 5. +

+
+
+ + +

26.3 avfoundation

+ +

AVFoundation input device. +

+

AVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX >= 10.7 as well as on iOS. +

+

The input filename has to be given in the following syntax: +

+
-i "[[VIDEO]:[AUDIO]]"
+
+

The first entry selects the video input while the latter selects the audio input. +The stream has to be specified by the device name or the device index as shown by the device list. +Alternatively, the video and/or audio input device can be chosen by index using the + + -video_device_index <INDEX> + +and/or + + -audio_device_index <INDEX> + +, overriding any +device name or index given in the input filename. +

+

All available devices can be enumerated by using -list_devices true, listing +all device names and corresponding indices. +

+

There are two device name aliases: +

+
default
+

Select the AVFoundation default device of the corresponding type. +

+
+
none
+

Do not record the corresponding media type. +This is equivalent to specifying an empty device name or index. +

+
+
+ + +

26.3.1 Options

+ +

AVFoundation supports the following options: +

+
+
-list_devices <TRUE|FALSE>
+

If set to true, a list of all available input devices is given showing all +device names and indices. +

+
+
-video_device_index <INDEX>
+

Specify the video device by its index. Overrides anything given in the input filename. +

+
+
-audio_device_index <INDEX>
+

Specify the audio device by its index. Overrides anything given in the input filename. +

+
+
-pixel_format <FORMAT>
+

Request the video device to use a specific pixel format. +If the specified format is not supported, a list of available formats is given +and the first one in this list is used instead. Available pixel formats are: +monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0, + bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10, + yuv420p, nv12, yuyv422, gray +

+
+
-framerate
+

Set the grabbing frame rate. Default is ntsc, corresponding to a +frame rate of 30000/1001. +

+
+
-video_size
+

Set the video frame size. +

+
+
-capture_cursor
+

Capture the mouse pointer. Default is 0. +

+
+
-capture_mouse_clicks
+

Capture the screen mouse clicks. Default is 0. +

+
+
-capture_raw_data
+

Capture the raw device data. Default is 0. +Using this option may result in receiving the underlying data delivered to the AVFoundation framework. E.g. for muxed devices that sends raw DV data to the framework (like tape-based camcorders), setting this option to false results in extracted video frames captured in the designated pixel format only. Setting this option to true results in receiving the raw DV stream untouched. +

+
+ + +

26.3.2 Examples

+ +
    +
  • Print the list of AVFoundation supported devices and exit: +
    +
    $ ffmpeg -f avfoundation -list_devices true -i ""
+
    + +
  • Record video from video device 0 and audio from audio device 0 into out.avi: +
    +
    $ ffmpeg -f avfoundation -i "0:0" out.avi
+
    + +
  • Record video from video device 2 and audio from audio device 1 into out.avi: +
    +
    $ ffmpeg -f avfoundation -video_device_index 2 -i ":1" out.avi
+
    + +
  • Record video from the system default video device using the pixel format bgr0 and do not record any audio into out.avi: +
    +
    $ ffmpeg -f avfoundation -pixel_format bgr0 -i "default:none" out.avi
+
    + +
  • Record raw DV data from a suitable input device and write the output into out.dv: +
    +
    $ ffmpeg -f avfoundation -capture_raw_data true -i "zr100:none" out.dv
+
    + + +
+ + +

26.4 bktr

+ +

BSD video input device. +

+ +

26.4.1 Options

+ +
+
framerate
+

Set the frame rate. +

+
+
video_size
+

Set the video frame size. Default is vga. +

+
+
standard
+
+

Available values are: +

+
‘pal’
+
‘ntsc’
+
‘secam’
+
‘paln’
+
‘palm’
+
‘ntscj’
+
+ +
+
+ + +

26.5 decklink

+ +

The decklink input device provides capture capabilities for Blackmagic +DeckLink devices. +

+

To enable this input device, you need the Blackmagic DeckLink SDK and you +need to configure with the appropriate --extra-cflags +and --extra-ldflags. +On Windows, you need to run the IDL files through widl. +

+

DeckLink is very picky about the formats it supports. Pixel format of the +input can be set with raw_format. +Framerate and video size must be determined for your device with +-list_formats 1. Audio sample rate is always 48 kHz and the number +of channels can be 2, 8 or 16. Note that all audio channels are bundled in one single +audio track. +

+ +

26.5.1 Options

+ +
+
list_devices
+

If set to true, print a list of devices and exit. +Defaults to false. This option is deprecated, please use the +-sources option of ffmpeg to list the available input devices. +

+
+
list_formats
+

If set to true, print a list of supported formats and exit. +Defaults to false. +

+
+
format_code <FourCC>
+

This sets the input video format to the format given by the FourCC. To see +the supported values of your device(s) use list_formats. +Note that there is a FourCC 'pal ' that can also be used +as pal (3 letters). +Default behavior is autodetection of the input video format, if the hardware +supports it. +

+
+
raw_format
+

Set the pixel format of the captured video. +Available values are: +

+
‘uyvy422’
+
‘yuv422p10’
+
‘argb’
+
‘bgra’
+
‘rgb10’
+
+ +
+
teletext_lines
+

If set to nonzero, an additional teletext stream will be captured from the +vertical ancillary data. Both SD PAL (576i) and HD (1080i or 1080p) +sources are supported. In case of HD sources, OP47 packets are decoded. +

+

This option is a bitmask of the SD PAL VBI lines captured, specifically lines 6 +to 22, and lines 318 to 335. Line 6 is the LSB in the mask. Selected lines +which do not contain teletext information will be ignored. You can use the +special all constant to select all possible lines, or +standard to skip lines 6, 318 and 319, which are not compatible with +all receivers. +

+

For SD sources, ffmpeg needs to be compiled with --enable-libzvbi. For +HD sources, on older (pre-4K) DeckLink card models you have to capture in 10 +bit mode. +

+
+
channels
+

Defines number of audio channels to capture. Must be ‘2’, ‘8’ or ‘16’. +Defaults to ‘2’. +

+
+
duplex_mode
+

Sets the decklink device duplex mode. Must be ‘unset’, ‘half’ or ‘full’. +Defaults to ‘unset’. +

+
+
timecode_format
+

Timecode type to include in the frame and video stream metadata. Must be +‘none’, ‘rp188vitc’, ‘rp188vitc2’, ‘rp188ltc’, +‘rp188any’, ‘vitc’, ‘vitc2’, or ‘serial’. Defaults to +‘none’ (not included). +

+
+
video_input
+

Sets the video input source. Must be ‘unset’, ‘sdi’, ‘hdmi’, +‘optical_sdi’, ‘component’, ‘composite’ or ‘s_video’. +Defaults to ‘unset’. +

+
+
audio_input
+

Sets the audio input source. Must be ‘unset’, ‘embedded’, +‘aes_ebu’, ‘analog’, ‘analog_xlr’, ‘analog_rca’ or +‘microphone’. Defaults to ‘unset’. +

+
+
video_pts
+

Sets the video packet timestamp source. Must be ‘video’, ‘audio’, +‘reference’, ‘wallclock’ or ‘abs_wallclock’. +Defaults to ‘video’. +

+
+
audio_pts
+

Sets the audio packet timestamp source. Must be ‘video’, ‘audio’, +‘reference’, ‘wallclock’ or ‘abs_wallclock’. +Defaults to ‘audio’. +

+
+
draw_bars
+

If set to ‘true’, color bars are drawn in the event of a signal loss. +Defaults to ‘true’. +

+
+
queue_size
+

Sets maximum input buffer size in bytes. If the buffering reaches this value, +incoming frames will be dropped. +Defaults to ‘1073741824’. +

+
+
audio_depth
+

Sets the audio sample bit depth. Must be ‘16’ or ‘32’. +Defaults to ‘16’. +

+
+
decklink_copyts
+

If set to true, timestamps are forwarded as they are without removing +the initial offset. +Defaults to false. +

+
+
timestamp_align
+

Capture start time alignment in seconds. If set to nonzero, input frames are +dropped till the system timestamp aligns with configured value. +Alignment difference of up to one frame duration is tolerated. +This is useful for maintaining input synchronization across N different +hardware devices deployed for ’N-way’ redundancy. The system time of different +hardware devices should be synchronized with protocols such as NTP or PTP, +before using this option. +Note that this method is not foolproof. In some border cases input +synchronization may not happen due to thread scheduling jitters in the OS. +Either sync could go wrong by 1 frame or in a rarer case +timestamp_align seconds. +Defaults to ‘0’. +

+
+
wait_for_tc (bool)
+

Drop frames till a frame with timecode is received. Sometimes serial timecode +isn’t received with the first input frame. If that happens, the stored stream +timecode will be inaccurate. If this option is set to true, input frames +are dropped till a frame with timecode is received. +Option timecode_format must be specified. +Defaults to false. +

+
+
+ + +

26.5.2 Examples

+ +
    +
  • List input devices: +
    +
    ffmpeg -sources decklink
+
    + +
  • List supported formats: +
    +
    ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
+
    + +
  • Capture video clip at 1080i50: +
    +
    ffmpeg -format_code Hi50 -f decklink -i 'Intensity Pro' -c:a copy -c:v copy output.avi
+
    + +
  • Capture video clip at 1080i50 10 bit: +
    +
    ffmpeg -raw_format yuv422p10 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi
+
    + +
  • Capture video clip at 1080i50 with 16 audio channels: +
    +
    ffmpeg -channels 16 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi
+
    + +
+ + +

26.6 dshow

+ +

Windows DirectShow input device. +

+

DirectShow support is enabled when FFmpeg is built with the mingw-w64 project. +Currently only audio and video devices are supported. +

+

Multiple devices may be opened as separate inputs, but they may also be +opened on the same input, which should improve synchronism between them. +

+

The input name should be in the format: +

+
+
TYPE=NAME[:TYPE=NAME]
+
+ +

where TYPE can be either audio or video, +and NAME is the device’s name or alternative name.. +

+ +

26.6.1 Options

+ +

If no options are specified, the device’s defaults are used. +If the device does not support the requested options, it will +fail to open. +

+
+
video_size
+

Set the video size in the captured video. +

+
+
framerate
+

Set the frame rate in the captured video. +

+
+
sample_rate
+

Set the sample rate (in Hz) of the captured audio. +

+
+
sample_size
+

Set the sample size (in bits) of the captured audio. +

+
+
channels
+

Set the number of channels in the captured audio. +

+
+
list_devices
+

If set to true, print a list of devices and exit. +

+
+
list_options
+

If set to true, print a list of selected device’s options +and exit. +

+
+
video_device_number
+

Set video device number for devices with the same name (starts at 0, +defaults to 0). +

+
+
audio_device_number
+

Set audio device number for devices with the same name (starts at 0, +defaults to 0). +

+
+
pixel_format
+

Select pixel format to be used by DirectShow. This may only be set when +the video codec is not set or set to rawvideo. +

+
+
audio_buffer_size
+

Set audio device buffer size in milliseconds (which can directly +impact latency, depending on the device). +Defaults to using the audio device’s +default buffer size (typically some multiple of 500ms). +Setting this value too low can degrade performance. +See also +http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx +

+
+
video_pin_name
+

Select video capture pin to use by name or alternative name. +

+
+
audio_pin_name
+

Select audio capture pin to use by name or alternative name. +

+
+
crossbar_video_input_pin_number
+

Select video input pin number for crossbar device. This will be +routed to the crossbar device’s Video Decoder output pin. +Note that changing this value can affect future invocations +(sets a new default) until system reboot occurs. +

+
+
crossbar_audio_input_pin_number
+

Select audio input pin number for crossbar device. This will be +routed to the crossbar device’s Audio Decoder output pin. +Note that changing this value can affect future invocations +(sets a new default) until system reboot occurs. +

+
+
show_video_device_dialog
+

If set to true, before capture starts, popup a display dialog +to the end user, allowing them to change video filter properties +and configurations manually. +Note that for crossbar devices, adjusting values in this dialog +may be needed at times to toggle between PAL (25 fps) and NTSC (29.97) +input frame rates, sizes, interlacing, etc. Changing these values can +enable different scan rates/frame rates and avoiding green bars at +the bottom, flickering scan lines, etc. +Note that with some devices, changing these properties can also affect future +invocations (sets new defaults) until system reboot occurs. +

+
+
show_audio_device_dialog
+

If set to true, before capture starts, popup a display dialog +to the end user, allowing them to change audio filter properties +and configurations manually. +

+
+
show_video_crossbar_connection_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify crossbar pin routings, when it opens a video device. +

+
+
show_audio_crossbar_connection_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify crossbar pin routings, when it opens an audio device. +

+
+
show_analog_tv_tuner_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify TV channels and frequencies. +

+
+
show_analog_tv_tuner_audio_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify TV audio (like mono vs. stereo, Language A,B or C). +

+
+
audio_device_load
+

Load an audio capture filter device from file instead of searching +it by name. It may load additional parameters too, if the filter +supports the serialization of its properties to. +To use this an audio capture source has to be specified, but it can +be anything even fake one. +

+
+
audio_device_save
+

Save the currently used audio capture filter device and its +parameters (if the filter supports it) to a file. +If a file with the same name exists it will be overwritten. +

+
+
video_device_load
+

Load a video capture filter device from file instead of searching +it by name. It may load additional parameters too, if the filter +supports the serialization of its properties to. +To use this a video capture source has to be specified, but it can +be anything even fake one. +

+
+
video_device_save
+

Save the currently used video capture filter device and its +parameters (if the filter supports it) to a file. +If a file with the same name exists it will be overwritten. +

+
+
+ + +

26.6.2 Examples

+ +
    +
  • Print the list of DirectShow supported devices and exit: +
    +
    $ ffmpeg -list_devices true -f dshow -i dummy
+
    + +
  • Open video device Camera: +
    +
    $ ffmpeg -f dshow -i video="Camera"
+
    + +
  • Open second video device with name Camera: +
    +
    $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
+
    + +
  • Open video device Camera and audio device Microphone: +
    +
    $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
+
    + +
  • Print the list of supported options in selected device and exit: +
    +
    $ ffmpeg -list_options true -f dshow -i video="Camera"
+
    + +
  • Specify pin names to capture by name or alternative name, specify alternative device name: +
    +
    $ ffmpeg -f dshow -audio_pin_name "Audio Out" -video_pin_name 2 -i video=video="@device_pnp_\\?\pci#ven_1a0a&dev_6200&subsys_62021461&rev_01#4&e2c7dd6&0&00e1#{65e8773d-8f56-11d0-a3b9-00a0c9223196}\{ca465100-deb0-4d59-818f-8c477184adf6}":audio="Microphone"
+
    + +
  • Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup: +
    +
    $ ffmpeg -f dshow -show_video_device_dialog true -crossbar_video_input_pin_number 0
+     -crossbar_audio_input_pin_number 3 -i video="AVerMedia BDA Analog Capture":audio="AVerMedia BDA Analog Capture"
+
    + +
+ + +

26.7 fbdev

+ +

Linux framebuffer input device. +

+

The Linux framebuffer is a graphic hardware-independent abstraction +layer to show graphics on a computer monitor, typically on the +console. It is accessed through a file device node, usually +/dev/fb0. +

+

For more detailed information read the file +Documentation/fb/framebuffer.txt included in the Linux source tree. +

+

See also http://linux-fbdev.sourceforge.net/, and fbset(1). +

+

To record from the framebuffer device /dev/fb0 with +ffmpeg: +

+
ffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi
+
+ +

You can take a single screenshot image with the command: +

+
ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
+
+ + +

26.7.1 Options

+ +
+
framerate
+

Set the frame rate. Default is 25. +

+
+
+ + +

26.8 gdigrab

+ +

Win32 GDI-based screen capture device. +

+

This device allows you to capture a region of the display on Windows. +

+

There are two options for the input filename: +

+
desktop
+
+

or +

+
title=window_title
+
+ +

The first option will capture the entire desktop, or a fixed region of the +desktop. The second option will instead capture the contents of a single +window, regardless of its position on the screen. +

+

For example, to grab the entire desktop using ffmpeg: +

+
ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
+
+ +

Grab a 640x480 region at position 10,20: +

+
ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
+
+ +

Grab the contents of the window named "Calculator" +

+
ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
+
+ + +

26.8.1 Options

+ +
+
draw_mouse
+

Specify whether to draw the mouse pointer. Use the value 0 to +not draw the pointer. Default value is 1. +

+
+
framerate
+

Set the grabbing frame rate. Default value is ntsc, +corresponding to a frame rate of 30000/1001. +

+
+
show_region
+

Show grabbed region on screen. +

+

If show_region is specified with 1, then the grabbing +region will be indicated on screen. With this option, it is easy to +know what is being grabbed if only a portion of the screen is grabbed. +

+

Note that show_region is incompatible with grabbing the contents +of a single window. +

+

For example: +

+
ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
+
+ +
+
video_size
+

Set the video frame size. The default is to capture the full screen if desktop is selected, or the full window size if title=window_title is selected. +

+
+
offset_x
+

When capturing a region with video_size, set the distance from the left edge of the screen or desktop. +

+

Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned to the left of your primary monitor, you will need to use a negative offset_x value to move the region to that monitor. +

+
+
offset_y
+

When capturing a region with video_size, set the distance from the top edge of the screen or desktop. +

+

Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned above your primary monitor, you will need to use a negative offset_y value to move the region to that monitor. +

+
+
+ + +

26.9 iec61883

+ +

FireWire DV/HDV input device using libiec61883. +

+

To enable this input device, you need libiec61883, libraw1394 and +libavc1394 installed on your system. Use the configure option +--enable-libiec61883 to compile with the device enabled. +

+

The iec61883 capture device supports capturing from a video device +connected via IEEE1394 (FireWire), using libiec61883 and the new Linux +FireWire stack (juju). This is the default DV/HDV input method in Linux +Kernel 2.6.37 and later, since the old FireWire stack was removed. +

+

Specify the FireWire port to be used as input file, or "auto" +to choose the first port connected. +

+ +

26.9.1 Options

+ +
+
dvtype
+

Override autodetection of DV/HDV. This should only be used if auto +detection does not work, or if usage of a different device type +should be prohibited. Treating a DV device as HDV (or vice versa) will +not work and result in undefined behavior. +The values auto, dv and hdv are supported. +

+
+
dvbuffer
+

Set maximum size of buffer for incoming data, in frames. For DV, this +is an exact value. For HDV, it is not frame exact, since HDV does +not have a fixed frame size. +

+
+
dvguid
+

Select the capture device by specifying its GUID. Capturing will only +be performed from the specified device and fails if no device with the +given GUID is found. This is useful to select the input if multiple +devices are connected at the same time. +Look at /sys/bus/firewire/devices to find out the GUIDs. +

+
+
+ + +

26.9.2 Examples

+ +
    +
  • Grab and show the input of a FireWire DV/HDV device. +
    +
    ffplay -f iec61883 -i auto
+
    + +
  • Grab and record the input of a FireWire DV/HDV device, +using a packet buffer of 100000 packets if the source is HDV. +
    +
    ffmpeg -f iec61883 -i auto -dvbuffer 100000 out.mpg
+
    + +
+ + +

26.10 jack

+ +

JACK input device. +

+

To enable this input device during configuration you need libjack +installed on your system. +

+

A JACK input device creates one or more JACK writable clients, one for +each audio channel, with name client_name:input_N, where +client_name is the name provided by the application, and N +is a number which identifies the channel. +Each writable client will send the acquired data to the FFmpeg input +device. +

+

Once you have created one or more JACK readable clients, you need to +connect them to one or more JACK writable clients. +

+

To connect or disconnect JACK clients you can use the jack_connect +and jack_disconnect programs, or do it through a graphical interface, +for example with qjackctl. +

+

To list the JACK clients and their properties you can invoke the command +jack_lsp. +

+

Follows an example which shows how to capture a JACK readable client +with ffmpeg. +

+
# Create a JACK writable client with name "ffmpeg".
+$ ffmpeg -f jack -i ffmpeg -y out.wav
+
+# Start the sample jack_metro readable client.
+$ jack_metro -b 120 -d 0.2 -f 4000
+
+# List the current JACK clients.
+$ jack_lsp -c
+system:capture_1
+system:capture_2
+system:playback_1
+system:playback_2
+ffmpeg:input_1
+metro:120_bpm
+
+# Connect metro to the ffmpeg writable client.
+$ jack_connect metro:120_bpm ffmpeg:input_1
+
+ +

For more information read: +http://jackaudio.org/ +

+ +

26.10.1 Options

+ +
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

26.11 kmsgrab

+ +

KMS video input device. +

+

Captures the KMS scanout framebuffer associated with a specified CRTC or plane as a +DRM object that can be passed to other hardware functions. +

+

Requires either DRM master or CAP_SYS_ADMIN to run. +

+

If you don’t understand what all of that means, you probably don’t want this. Look at +x11grab instead. +

+ +

26.11.1 Options

+ +
+
device
+

DRM device to capture on. Defaults to /dev/dri/card0. +

+
+
format
+

Pixel format of the framebuffer. Defaults to bgr0. +

+
+
format_modifier
+

Format modifier to signal on output frames. This is necessary to import correctly into +some APIs, but can’t be autodetected. See the libdrm documentation for possible values. +

+
+
crtc_id
+

KMS CRTC ID to define the capture source. The first active plane on the given CRTC +will be used. +

+
+
plane_id
+

KMS plane ID to define the capture source. Defaults to the first active plane found if +neither crtc_id nor plane_id are specified. +

+
+
framerate
+

Framerate to capture at. This is not synchronised to any page flipping or framebuffer +changes - it just defines the interval at which the framebuffer is sampled. Sampling +faster than the framebuffer update rate will generate independent frames with the same +content. Defaults to 30. +

+
+
+ + +

26.11.2 Examples

+ +
    +
  • Capture from the first active plane, download the result to normal frames and encode. +This will only work if the framebuffer is both linear and mappable - if not, the result +may be scrambled or fail to download. +
    +
    ffmpeg -f kmsgrab -i - -vf 'hwdownload,format=bgr0' output.mp4
+
    + +
  • Capture from CRTC ID 42 at 60fps, map the result to VAAPI, convert to NV12 and encode as H.264. +
    +
    ffmpeg -crtc_id 42 -framerate 60 -f kmsgrab -i - -vf 'hwmap=derive_device=vaapi,scale_vaapi=w=1920:h=1080:format=nv12' -c:v h264_vaapi output.mp4
+
    + +
  • To capture only part of a plane the output can be cropped - this can be used to capture +a single window, as long as it has a known absolute position and size. For example, to +capture and encode the middle quarter of a 1920x1080 plane: +
    +
    ffmpeg -f kmsgrab -i - -vf 'hwmap=derive_device=vaapi,crop=960:540:480:270,scale_vaapi=960:540:nv12' -c:v h264_vaapi output.mp4
+
    + +
+ + +

26.12 lavfi

+ +

Libavfilter input virtual device. +

+

This input device reads data from the open output pads of a libavfilter +filtergraph. +

+

For each filtergraph open output, the input device will create a +corresponding stream which is mapped to the generated output. Currently +only video data is supported. The filtergraph is specified through the +option graph. +

+ +

26.12.1 Options

+ +
+
graph
+

Specify the filtergraph to use as input. Each video open output must be +labelled by a unique string of the form "outN", where N is a +number starting from 0 corresponding to the mapped input stream +generated by the device. +The first unlabelled output is automatically assigned to the "out0" +label, but all the others need to be specified explicitly. +

+

The suffix "+subcc" can be appended to the output label to create an extra +stream with the closed captions packets attached to that output +(experimental; only for EIA-608 / CEA-708 for now). +The subcc streams are created after all the normal streams, in the order of +the corresponding stream. +For example, if there is "out19+subcc", "out7+subcc" and up to "out42", the +stream #43 is subcc for stream #7 and stream #44 is subcc for stream #19. +

+

If not specified defaults to the filename specified for the input +device. +

+
+
graph_file
+

Set the filename of the filtergraph to be read and sent to the other +filters. Syntax of the filtergraph is the same as the one specified by +the option graph. +

+
+
dumpgraph
+

Dump graph to stderr. +

+
+
+ + +

26.12.2 Examples

+ +
    +
  • Create a color video stream and play it back with ffplay: +
    +
    ffplay -f lavfi -graph "color=c=pink [out0]" dummy
+
    + +
  • As the previous example, but use filename for specifying the graph +description, and omit the "out0" label: +
    +
    ffplay -f lavfi color=c=pink
+
    + +
  • Create three different video test filtered sources and play them: +
    +
    ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
+
    + +
  • Read an audio stream from a file using the amovie source and play it +back with ffplay: +
    +
    ffplay -f lavfi "amovie=test.wav"
+
    + +
  • Read an audio stream and a video stream and play it back with +ffplay: +
    +
    ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
+
    + +
  • Dump decoded frames to images and closed captions to a file (experimental): +
    +
    ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
+
    + +
+ + +

26.13 libcdio

+ +

Audio-CD input device based on libcdio. +

+

To enable this input device during configuration you need libcdio +installed on your system. It requires the configure option +--enable-libcdio. +

+

This device allows playing and grabbing from an Audio-CD. +

+

For example to copy with ffmpeg the entire Audio-CD in /dev/sr0, +you may run the command: +

+
ffmpeg -f libcdio -i /dev/sr0 cd.wav
+
+ + +

26.13.1 Options

+
+
speed
+

Set drive reading speed. Default value is 0. +

+

The speed is specified CD-ROM speed units. The speed is set through +the libcdio cdio_cddap_speed_set function. On many CD-ROM +drives, specifying a value too large will result in using the fastest +speed. +

+
+
paranoia_mode
+

Set paranoia recovery mode flags. It accepts one of the following values: +

+
+
‘disable’
+
‘verify’
+
‘overlap’
+
‘neverskip’
+
‘full’
+
+ +

Default value is ‘disable’. +

+

For more information about the available recovery modes, consult the +paranoia project documentation. +

+
+ + +

26.14 libdc1394

+ +

IIDC1394 input device, based on libdc1394 and libraw1394. +

+

Requires the configure option --enable-libdc1394. +

+ +

26.14.1 Options

+
+
framerate
+

Set the frame rate. Default is ntsc, corresponding to a frame +rate of 30000/1001. +

+
+
pixel_format
+

Select the pixel format. Default is uyvy422. +

+
+
video_size
+

Set the video size given as a string such as 640x480 or hd720. +Default is qvga. +

+
+ + +

26.15 openal

+ +

The OpenAL input device provides audio capture on all systems with a +working OpenAL 1.1 implementation. +

+

To enable this input device during configuration, you need OpenAL +headers and libraries installed on your system, and need to configure +FFmpeg with --enable-openal. +

+

OpenAL headers and libraries should be provided as part of your OpenAL +implementation, or as an additional download (an SDK). Depending on your +installation you may need to specify additional flags via the +--extra-cflags and --extra-ldflags for allowing the build +system to locate the OpenAL headers and libraries. +

+

An incomplete list of OpenAL implementations follows: +

+
+
Creative
+

The official Windows implementation, providing hardware acceleration +with supported devices and software fallback. +See http://openal.org/. +

+
OpenAL Soft
+

Portable, open source (LGPL) software implementation. Includes +backends for the most common sound APIs on the Windows, Linux, +Solaris, and BSD operating systems. +See http://kcat.strangesoft.net/openal.html. +

+
Apple
+

OpenAL is part of Core Audio, the official Mac OS X Audio interface. +See http://developer.apple.com/technologies/mac/audio-and-video.html +

+
+ +

This device allows one to capture from an audio input device handled +through OpenAL. +

+

You need to specify the name of the device to capture in the provided +filename. If the empty string is provided, the device will +automatically select the default device. You can get the list of the +supported devices by using the option list_devices. +

+ +

26.15.1 Options

+ +
+
channels
+

Set the number of channels in the captured audio. Only the values +1 (monaural) and 2 (stereo) are currently supported. +Defaults to 2. +

+
+
sample_size
+

Set the sample size (in bits) of the captured audio. Only the values +8 and 16 are currently supported. Defaults to +16. +

+
+
sample_rate
+

Set the sample rate (in Hz) of the captured audio. +Defaults to 44.1k. +

+
+
list_devices
+

If set to true, print a list of devices and exit. +Defaults to false. +

+
+
+ + +

26.15.2 Examples

+ +

Print the list of OpenAL supported devices and exit: +

+
$ ffmpeg -list_devices true -f openal -i dummy out.ogg
+
+ +

Capture from the OpenAL device DR-BT101 via PulseAudio: +

+
$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
+
+ +

Capture from the default device (note the empty string ” as filename): +

+
$ ffmpeg -f openal -i '' out.ogg
+
+ +

Capture from two devices simultaneously, writing to two different files, +within the same ffmpeg command: +

+
$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
+
+

Note: not all OpenAL implementations support multiple simultaneous capture - +try the latest OpenAL Soft if the above does not work. +

+ +

26.16 oss

+ +

Open Sound System input device. +

+

The filename to provide to the input device is the device node +representing the OSS input device, and is usually set to +/dev/dsp. +

+

For example to grab from /dev/dsp using ffmpeg use the +command: +

+
ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
+
+ +

For more information about OSS see: +http://manuals.opensound.com/usersguide/dsp.html +

+ +

26.16.1 Options

+ +
+
sample_rate
+

Set the sample rate in Hz. Default is 48000. +

+
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

26.17 pulse

+ +

PulseAudio input device. +

+

To enable this output device you need to configure FFmpeg with --enable-libpulse. +

+

The filename to provide to the input device is a source device or the +string "default" +

+

To list the PulseAudio source devices and their properties you can invoke +the command pactl list sources. +

+

More information about PulseAudio can be found on http://www.pulseaudio.org. +

+ +

26.17.1 Options

+
+
server
+

Connect to a specific PulseAudio server, specified by an IP address. +Default server is used when not provided. +

+
+
name
+

Specify the application name PulseAudio will use when showing active clients, +by default it is the LIBAVFORMAT_IDENT string. +

+
+
stream_name
+

Specify the stream name PulseAudio will use when showing active streams, +by default it is "record". +

+
+
sample_rate
+

Specify the samplerate in Hz, by default 48kHz is used. +

+
+
channels
+

Specify the channels in use, by default 2 (stereo) is set. +

+
+
frame_size
+

Specify the number of bytes per frame, by default it is set to 1024. +

+
+
fragment_size
+

Specify the minimal buffering fragment in PulseAudio, it will affect the +audio latency. By default it is unset. +

+
+
wallclock
+

Set the initial PTS using the current time. Default is 1. +

+
+
+ + +

26.17.2 Examples

+

Record a stream from default device: +

+
ffmpeg -f pulse -i default /tmp/pulse.wav
+
+ + +

26.18 sndio

+ +

sndio input device. +

+

To enable this input device during configuration you need libsndio +installed on your system. +

+

The filename to provide to the input device is the device node +representing the sndio input device, and is usually set to +/dev/audio0. +

+

For example to grab from /dev/audio0 using ffmpeg use the +command: +

+
ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
+
+ + +

26.18.1 Options

+ +
+
sample_rate
+

Set the sample rate in Hz. Default is 48000. +

+
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

26.19 video4linux2, v4l2

+ +

Video4Linux2 input video device. +

+

"v4l2" can be used as alias for "video4linux2". +

+

If FFmpeg is built with v4l-utils support (by using the +--enable-libv4l2 configure option), it is possible to use it with the +-use_libv4l2 input device option. +

+

The name of the device to grab is a file device node, usually Linux +systems tend to automatically create such nodes when the device +(e.g. an USB webcam) is plugged into the system, and has a name of the +kind /dev/videoN, where N is a number associated to +the device. +

+

Video4Linux2 devices usually support a limited set of +widthxheight sizes and frame rates. You can check which are +supported using -list_formats all for Video4Linux2 devices. +Some devices, like TV cards, support one or more standards. It is possible +to list all the supported standards using -list_standards all. +

+

The time base for the timestamps is 1 microsecond. Depending on the kernel +version and configuration, the timestamps may be derived from the real time +clock (origin at the Unix Epoch) or the monotonic clock (origin usually at +boot time, unaffected by NTP or manual changes to the clock). The +-timestamps abs or -ts abs option can be used to force +conversion into the real time clock. +

+

Some usage examples of the video4linux2 device with ffmpeg +and ffplay: +

    +
  • List supported formats for a video4linux2 device: +
    +
    ffplay -f video4linux2 -list_formats all /dev/video0
+
    + +
  • Grab and show the input of a video4linux2 device: +
    +
    ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
+
    + +
  • Grab and record the input of a video4linux2 device, leave the +frame rate and size as previously set: +
    +
    ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
+
    +
+ +

For more information about Video4Linux, check http://linuxtv.org/. +

+ +

26.19.1 Options

+ +
+
standard
+

Set the standard. Must be the name of a supported standard. To get a +list of the supported standards, use the list_standards +option. +

+
+
channel
+

Set the input channel number. Default to -1, which means using the +previously selected channel. +

+
+
video_size
+

Set the video frame size. The argument must be a string in the form +WIDTHxHEIGHT or a valid size abbreviation. +

+
+
pixel_format
+

Select the pixel format (only valid for raw video input). +

+
+
input_format
+

Set the preferred pixel format (for raw video) or a codec name. +This option allows one to select the input format, when several are +available. +

+
+
framerate
+

Set the preferred video frame rate. +

+
+
list_formats
+

List available formats (supported pixel formats, codecs, and frame +sizes) and exit. +

+

Available values are: +

+
‘all’
+

Show all available (compressed and non-compressed) formats. +

+
+
‘raw’
+

Show only raw video (non-compressed) formats. +

+
+
‘compressed’
+

Show only compressed formats. +

+
+ +
+
list_standards
+

List supported standards and exit. +

+

Available values are: +

+
‘all’
+

Show all supported standards. +

+
+ +
+
timestamps, ts
+

Set type of timestamps for grabbed frames. +

+

Available values are: +

+
‘default’
+

Use timestamps from the kernel. +

+
+
‘abs’
+

Use absolute timestamps (wall clock). +

+
+
‘mono2abs’
+

Force conversion from monotonic to absolute timestamps. +

+
+ +

Default value is default. +

+
+
use_libv4l2
+

Use libv4l2 (v4l-utils) conversion functions. Default is 0. +

+
+
+ + +

26.20 vfwcap

+ +

VfW (Video for Windows) capture input device. +

+

The filename passed as input is the capture driver number, ranging from +0 to 9. You may use "list" as filename to print a list of drivers. Any +other filename will be interpreted as device number 0. +

+ +

26.20.1 Options

+ +
+
video_size
+

Set the video frame size. +

+
+
framerate
+

Set the grabbing frame rate. Default value is ntsc, +corresponding to a frame rate of 30000/1001. +

+
+
+ + +

26.21 x11grab

+ +

X11 video input device. +

+

To enable this input device during configuration you need libxcb +installed on your system. It will be automatically detected during +configuration. +

+

This device allows one to capture a region of an X11 display. +

+

The filename passed as input has the syntax: +

+
[hostname]:display_number.screen_number[+x_offset,y_offset]
+
+ +

hostname:display_number.screen_number specifies the +X11 display name of the screen to grab from. hostname can be +omitted, and defaults to "localhost". The environment variable +DISPLAY contains the default display name. +

+

x_offset and y_offset specify the offsets of the grabbed +area with respect to the top-left border of the X11 screen. They +default to 0. +

+

Check the X11 documentation (e.g. man X) for more detailed +information. +

+

Use the xdpyinfo program for getting basic information about +the properties of your X11 display (e.g. grep for "name" or +"dimensions"). +

+

For example to grab from :0.0 using ffmpeg: +

+
ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +

Grab at position 10,20: +

+
ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
+
+ + +

26.21.1 Options

+ +
+
draw_mouse
+

Specify whether to draw the mouse pointer. A value of 0 specifies +not to draw the pointer. Default value is 1. +

+
+
follow_mouse
+

Make the grabbed area follow the mouse. The argument can be +centered or a number of pixels PIXELS. +

+

When it is specified with "centered", the grabbing region follows the mouse +pointer and keeps the pointer at the center of region; otherwise, the region +follows only when the mouse pointer reaches within PIXELS (greater than +zero) to the edge of region. +

+

For example: +

+
ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +

To follow only when the mouse pointer reaches within 100 pixels to edge: +

+
ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +
+
framerate
+

Set the grabbing frame rate. Default value is ntsc, +corresponding to a frame rate of 30000/1001. +

+
+
show_region
+

Show grabbed region on screen. +

+

If show_region is specified with 1, then the grabbing +region will be indicated on screen. With this option, it is easy to +know what is being grabbed if only a portion of the screen is grabbed. +

+
+
region_border
+

Set the region border thickness if -show_region 1 is used. +Range is 1 to 128 and default is 3 (XCB-based x11grab only). +

+

For example: +

+
ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
+
+ +

With follow_mouse: +

+
ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +
+
video_size
+

Set the video frame size. Default is the full desktop. +

+
+
grab_x
+
grab_y
+

Set the grabbing region coordinates. They are expressed as offset from +the top left corner of the X11 window and correspond to the +x_offset and y_offset parameters in the device name. The +default value for both options is 0. +

+
+ + +

27 Output Devices

+ +

Output devices are configured elements in FFmpeg that can write +multimedia data to an output device attached to your system. +

+

When you configure your FFmpeg build, all the supported output devices +are enabled by default. You can list all available ones using the +configure option "–list-outdevs". +

+

You can disable all the output devices using the configure option +"–disable-outdevs", and selectively enable an output device using the +option "–enable-outdev=OUTDEV", or you can disable a particular +input device using the option "–disable-outdev=OUTDEV". +

+

The option "-devices" of the ff* tools will display the list of +enabled output devices. +

+

A description of the currently available output devices follows. +

+ +

27.1 alsa

+ +

ALSA (Advanced Linux Sound Architecture) output device. +

+ +

27.1.1 Examples

+ +
    +
  • Play a file on default ALSA device: +
    +
    ffmpeg -i INPUT -f alsa default
+
    + +
  • Play a file on soundcard 1, audio device 7: +
    +
    ffmpeg -i INPUT -f alsa hw:1,7
+
    +
+ + +

27.2 caca

+ +

CACA output device. +

+

This output device allows one to show a video stream in CACA window. +Only one CACA window is allowed per application, so you can +have only one instance of this output device in an application. +

+

To enable this output device you need to configure FFmpeg with +--enable-libcaca. +libcaca is a graphics library that outputs text instead of pixels. +

+

For more information about libcaca, check: +http://caca.zoy.org/wiki/libcaca +

+ +

27.2.1 Options

+ +
+
window_title
+

Set the CACA window title, if not specified default to the filename +specified for the output device. +

+
+
window_size
+

Set the CACA window size, can be a string of the form +widthxheight or a video size abbreviation. +If not specified it defaults to the size of the input video. +

+
+
driver
+

Set display driver. +

+
+
algorithm
+

Set dithering algorithm. Dithering is necessary +because the picture being rendered has usually far more colours than +the available palette. +The accepted values are listed with -list_dither algorithms. +

+
+
antialias
+

Set antialias method. Antialiasing smoothens the rendered +image and avoids the commonly seen staircase effect. +The accepted values are listed with -list_dither antialiases. +

+
+
charset
+

Set which characters are going to be used when rendering text. +The accepted values are listed with -list_dither charsets. +

+
+
color
+

Set color to be used when rendering text. +The accepted values are listed with -list_dither colors. +

+
+
list_drivers
+

If set to true, print a list of available drivers and exit. +

+
+
list_dither
+

List available dither options related to the argument. +The argument must be one of algorithms, antialiases, +charsets, colors. +

+
+ + +

27.2.2 Examples

+ +
    +
  • The following command shows the ffmpeg output is an +CACA window, forcing its size to 80x25: +
    +
    ffmpeg -i INPUT -c:v rawvideo -pix_fmt rgb24 -window_size 80x25 -f caca -
+
    + +
  • Show the list of available drivers and exit: +
    +
    ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_drivers true -
+
    + +
  • Show the list of available dither colors and exit: +
    +
    ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_dither colors -
+
    +
+ + +

27.3 decklink

+ +

The decklink output device provides playback capabilities for Blackmagic +DeckLink devices. +

+

To enable this output device, you need the Blackmagic DeckLink SDK and you +need to configure with the appropriate --extra-cflags +and --extra-ldflags. +On Windows, you need to run the IDL files through widl. +

+

DeckLink is very picky about the formats it supports. Pixel format is always +uyvy422, framerate, field order and video size must be determined for your +device with -list_formats 1. Audio sample rate is always 48 kHz. +

+ +

27.3.1 Options

+ +
+
list_devices
+

If set to true, print a list of devices and exit. +Defaults to false. This option is deprecated, please use the +-sinks option of ffmpeg to list the available output devices. +

+
+
list_formats
+

If set to true, print a list of supported formats and exit. +Defaults to false. +

+
+
preroll
+

Amount of time to preroll video in seconds. +Defaults to 0.5. +

+
+
duplex_mode
+

Sets the decklink device duplex mode. Must be ‘unset’, ‘half’ or ‘full’. +Defaults to ‘unset’. +

+
+
timing_offset
+

Sets the genlock timing pixel offset on the used output. +Defaults to ‘unset’. +

+
+
+ + +

27.3.2 Examples

+ +
    +
  • List output devices: +
    +
    ffmpeg -sinks decklink
+
    + +
  • List supported formats: +
    +
    ffmpeg -i test.avi -f decklink -list_formats 1 'DeckLink Mini Monitor'
+
    + +
  • Play video clip: +
    +
    ffmpeg -i test.avi -f decklink -pix_fmt uyvy422 'DeckLink Mini Monitor'
+
    + +
  • Play video clip with non-standard framerate or video size: +
    +
    ffmpeg -i test.avi -f decklink -pix_fmt uyvy422 -s 720x486 -r 24000/1001 'DeckLink Mini Monitor'
+
    + +
+ + +

27.4 fbdev

+ +

Linux framebuffer output device. +

+

The Linux framebuffer is a graphic hardware-independent abstraction +layer to show graphics on a computer monitor, typically on the +console. It is accessed through a file device node, usually +/dev/fb0. +

+

For more detailed information read the file +Documentation/fb/framebuffer.txt included in the Linux source tree. +

+ +

27.4.1 Options

+
+
xoffset
+
yoffset
+

Set x/y coordinate of top left corner. Default is 0. +

+
+ + +

27.4.2 Examples

+

Play a file on framebuffer device /dev/fb0. +Required pixel format depends on current framebuffer settings. +

+
ffmpeg -re -i INPUT -c:v rawvideo -pix_fmt bgra -f fbdev /dev/fb0
+
+ +

See also http://linux-fbdev.sourceforge.net/, and fbset(1). +

+ +

27.5 opengl

+

OpenGL output device. +

+

To enable this output device you need to configure FFmpeg with --enable-opengl. +

+

This output device allows one to render to OpenGL context. +Context may be provided by application or default SDL window is created. +

+

When device renders to external context, application must implement handlers for following messages: +AV_DEV_TO_APP_CREATE_WINDOW_BUFFER - create OpenGL context on current thread. +AV_DEV_TO_APP_PREPARE_WINDOW_BUFFER - make OpenGL context current. +AV_DEV_TO_APP_DISPLAY_WINDOW_BUFFER - swap buffers. +AV_DEV_TO_APP_DESTROY_WINDOW_BUFFER - destroy OpenGL context. +Application is also required to inform a device about current resolution by sending AV_APP_TO_DEV_WINDOW_SIZE message. +

+ +

27.5.1 Options

+
+
background
+

Set background color. Black is a default. +

+
no_window
+

Disables default SDL window when set to non-zero value. +Application must provide OpenGL context and both window_size_cb and window_swap_buffers_cb callbacks when set. +

+
window_title
+

Set the SDL window title, if not specified default to the filename specified for the output device. +Ignored when no_window is set. +

+
window_size
+

Set preferred window size, can be a string of the form widthxheight or a video size abbreviation. +If not specified it defaults to the size of the input video, downscaled according to the aspect ratio. +Mostly usable when no_window is not set. +

+
+
+ + +

27.5.2 Examples

+

Play a file on SDL window using OpenGL rendering: +

+
ffmpeg  -i INPUT -f opengl "window title"
+
+ + +

27.6 oss

+ +

OSS (Open Sound System) output device. +

+ +

27.7 pulse

+ +

PulseAudio output device. +

+

To enable this output device you need to configure FFmpeg with --enable-libpulse. +

+

More information about PulseAudio can be found on http://www.pulseaudio.org +

+ +

27.7.1 Options

+
+
server
+

Connect to a specific PulseAudio server, specified by an IP address. +Default server is used when not provided. +

+
+
name
+

Specify the application name PulseAudio will use when showing active clients, +by default it is the LIBAVFORMAT_IDENT string. +

+
+
stream_name
+

Specify the stream name PulseAudio will use when showing active streams, +by default it is set to the specified output name. +

+
+
device
+

Specify the device to use. Default device is used when not provided. +List of output devices can be obtained with command pactl list sinks. +

+
+
buffer_size
+
buffer_duration
+

Control the size and duration of the PulseAudio buffer. A small buffer +gives more control, but requires more frequent updates. +

+

buffer_size specifies size in bytes while +buffer_duration specifies duration in milliseconds. +

+

When both options are provided then the highest value is used +(duration is recalculated to bytes using stream parameters). If they +are set to 0 (which is default), the device will use the default +PulseAudio duration value. By default PulseAudio set buffer duration +to around 2 seconds. +

+
+
prebuf
+

Specify pre-buffering size in bytes. The server does not start with +playback before at least prebuf bytes are available in the +buffer. By default this option is initialized to the same value as +buffer_size or buffer_duration (whichever is bigger). +

+
+
minreq
+

Specify minimum request size in bytes. The server does not request less +than minreq bytes from the client, instead waits until the buffer +is free enough to request more bytes at once. It is recommended to not set +this option, which will initialize this to a value that is deemed sensible +by the server. +

+
+
+ + +

27.7.2 Examples

+

Play a file on default device on default server: +

+
ffmpeg  -i INPUT -f pulse "stream name"
+
+ + +

27.8 sdl

+ +

SDL (Simple DirectMedia Layer) output device. +

+

"sdl2" can be used as alias for "sdl". +

+

This output device allows one to show a video stream in an SDL +window. Only one SDL window is allowed per application, so you can +have only one instance of this output device in an application. +

+

To enable this output device you need libsdl installed on your system +when configuring your build. +

+

For more information about SDL, check: +http://www.libsdl.org/ +

+ +

27.8.1 Options

+ +
+
window_title
+

Set the SDL window title, if not specified default to the filename +specified for the output device. +

+
+
icon_title
+

Set the name of the iconified SDL window, if not specified it is set +to the same value of window_title. +

+
+
window_size
+

Set the SDL window size, can be a string of the form +widthxheight or a video size abbreviation. +If not specified it defaults to the size of the input video, +downscaled according to the aspect ratio. +

+
+
window_x
+
window_y
+

Set the position of the window on the screen. +

+
+
window_fullscreen
+

Set fullscreen mode when non-zero value is provided. +Default value is zero. +

+
+
window_enable_quit
+

Enable quit action (using window button or keyboard key) +when non-zero value is provided. +Default value is 1 (enable quit action) +

+
+ + +

27.8.2 Interactive commands

+ +

The window created by the device can be controlled through the +following interactive commands. +

+
+
q, ESC
+

Quit the device immediately. +

+
+ + +

27.8.3 Examples

+ +

The following command shows the ffmpeg output is an +SDL window, forcing its size to the qcif format: +

+
ffmpeg -i INPUT -c:v rawvideo -pix_fmt yuv420p -window_size qcif -f sdl "SDL output"
+
+ + +

27.9 sndio

+ +

sndio audio output device. +

+ +

27.10 v4l2

+ +

Video4Linux2 output device. +

+ +

27.11 xv

+ +

XV (XVideo) output device. +

+

This output device allows one to show a video stream in a X Window System +window. +

+ +

27.11.1 Options

+ +
+
display_name
+

Specify the hardware display name, which determines the display and +communications domain to be used. +

+

The display name or DISPLAY environment variable can be a string in +the format hostname[:number[.screen_number]]. +

+

hostname specifies the name of the host machine on which the +display is physically attached. number specifies the number of +the display server on that host machine. screen_number specifies +the screen to be used on that server. +

+

If unspecified, it defaults to the value of the DISPLAY environment +variable. +

+

For example, dual-headed:0.1 would specify screen 1 of display +0 on the machine named “dual-headed”. +

+

Check the X11 specification for more detailed information about the +display name format. +

+
+
window_id
+

When set to non-zero value then device doesn’t create new window, +but uses existing one with provided window_id. By default +this options is set to zero and device creates its own window. +

+
+
window_size
+

Set the created window size, can be a string of the form +widthxheight or a video size abbreviation. If not +specified it defaults to the size of the input video. +Ignored when window_id is set. +

+
+
window_x
+
window_y
+

Set the X and Y window offsets for the created window. They are both +set to 0 by default. The values may be ignored by the window manager. +Ignored when window_id is set. +

+
+
window_title
+

Set the window title, if not specified default to the filename +specified for the output device. Ignored when window_id is set. +

+
+ +

For more information about XVideo see http://www.x.org/. +

+ +

27.11.2 Examples

+ +
    +
  • Decode, display and encode video input with ffmpeg at the +same time: +
    +
    ffmpeg -i INPUT OUTPUT -f xv display
+
    + +
  • Decode and display the input video to multiple X11 windows: +
    +
    ffmpeg -i INPUT -f xv normal -vf negate -f xv negated
+
    +
+ + +

28 Resampler Options

+ +

The audio resampler supports the following named options. +

+

Options may be set by specifying -option value in the +FFmpeg tools, option=value for the aresample filter, +by setting the value explicitly in the +SwrContext options or using the libavutil/opt.h API for +programmatic use. +

+
+
ich, in_channel_count
+

Set the number of input channels. Default value is 0. Setting this +value is not mandatory if the corresponding channel layout +in_channel_layout is set. +

+
+
och, out_channel_count
+

Set the number of output channels. Default value is 0. Setting this +value is not mandatory if the corresponding channel layout +out_channel_layout is set. +

+
+
uch, used_channel_count
+

Set the number of used input channels. Default value is 0. This option is +only used for special remapping. +

+
+
isr, in_sample_rate
+

Set the input sample rate. Default value is 0. +

+
+
osr, out_sample_rate
+

Set the output sample rate. Default value is 0. +

+
+
isf, in_sample_fmt
+

Specify the input sample format. It is set by default to none. +

+
+
osf, out_sample_fmt
+

Specify the output sample format. It is set by default to none. +

+
+
tsf, internal_sample_fmt
+

Set the internal sample format. Default value is none. +This will automatically be chosen when it is not explicitly set. +

+
+
icl, in_channel_layout
+
ocl, out_channel_layout
+

Set the input/output channel layout. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+
clev, center_mix_level
+

Set the center mix level. It is a value expressed in deciBel, and must be +in the interval [-32,32]. +

+
+
slev, surround_mix_level
+

Set the surround mix level. It is a value expressed in deciBel, and must +be in the interval [-32,32]. +

+
+
lfe_mix_level
+

Set LFE mix into non LFE level. It is used when there is a LFE input but no +LFE output. It is a value expressed in deciBel, and must +be in the interval [-32,32]. +

+
+
rmvol, rematrix_volume
+

Set rematrix volume. Default value is 1.0. +

+
+
rematrix_maxval
+

Set maximum output value for rematrixing. +This can be used to prevent clipping vs. preventing volume reduction. +A value of 1.0 prevents clipping. +

+
+
flags, swr_flags
+

Set flags used by the converter. Default value is 0. +

+

It supports the following individual flags: +

+
res
+

force resampling, this flag forces resampling to be used even when the +input and output sample rates match. +

+
+ +
+
dither_scale
+

Set the dither scale. Default value is 1. +

+
+
dither_method
+

Set dither method. Default value is 0. +

+

Supported values: +

+
‘rectangular’
+

select rectangular dither +

+
‘triangular’
+

select triangular dither +

+
‘triangular_hp’
+

select triangular dither with high pass +

+
‘lipshitz’
+

select Lipshitz noise shaping dither. +

+
‘shibata’
+

select Shibata noise shaping dither. +

+
‘low_shibata’
+

select low Shibata noise shaping dither. +

+
‘high_shibata’
+

select high Shibata noise shaping dither. +

+
‘f_weighted’
+

select f-weighted noise shaping dither +

+
‘modified_e_weighted’
+

select modified-e-weighted noise shaping dither +

+
‘improved_e_weighted’
+

select improved-e-weighted noise shaping dither +

+
+
+ +
+
resampler
+

Set resampling engine. Default value is swr. +

+

Supported values: +

+
‘swr’
+

select the native SW Resampler; filter options precision and cheby are not +applicable in this case. +

+
‘soxr’
+

select the SoX Resampler (where available); compensation, and filter options +filter_size, phase_shift, exact_rational, filter_type & kaiser_beta, are not +applicable in this case. +

+
+ +
+
filter_size
+

For swr only, set resampling filter size, default value is 32. +

+
+
phase_shift
+

For swr only, set resampling phase shift, default value is 10, and must be in +the interval [0,30]. +

+
+
linear_interp
+

Use linear interpolation when enabled (the default). Disable it if you want +to preserve speed instead of quality when exact_rational fails. +

+
+
exact_rational
+

For swr only, when enabled, try to use exact phase_count based on input and +output sample rate. However, if it is larger than 1 << phase_shift, +the phase_count will be 1 << phase_shift as fallback. Default is enabled. +

+
+
cutoff
+

Set cutoff frequency (swr: 6dB point; soxr: 0dB point) ratio; must be a float +value between 0 and 1. Default value is 0.97 with swr, and 0.91 with soxr +(which, with a sample-rate of 44100, preserves the entire audio band to 20kHz). +

+
+
precision
+

For soxr only, the precision in bits to which the resampled signal will be +calculated. The default value of 20 (which, with suitable dithering, is +appropriate for a destination bit-depth of 16) gives SoX’s ’High Quality’; a +value of 28 gives SoX’s ’Very High Quality’. +

+
+
cheby
+

For soxr only, selects passband rolloff none (Chebyshev) & higher-precision +approximation for ’irrational’ ratios. Default value is 0. +

+
+
async
+

For swr only, simple 1 parameter audio sync to timestamps using stretching, +squeezing, filling and trimming. Setting this to 1 will enable filling and +trimming, larger values represent the maximum amount in samples that the data +may be stretched or squeezed for each second. +Default value is 0, thus no compensation is applied to make the samples match +the audio timestamps. +

+
+
first_pts
+

For swr only, assume the first pts should be this value. The time unit is 1 / sample rate. +This allows for padding/trimming at the start of stream. By default, no +assumption is made about the first frame’s expected pts, so no padding or +trimming is done. For example, this could be set to 0 to pad the beginning with +silence if an audio stream starts after the video stream or to trim any samples +with a negative pts due to encoder delay. +

+
+
min_comp
+

For swr only, set the minimum difference between timestamps and audio data (in +seconds) to trigger stretching/squeezing/filling or trimming of the +data to make it match the timestamps. The default is that +stretching/squeezing/filling and trimming is disabled +(min_comp = FLT_MAX). +

+
+
min_hard_comp
+

For swr only, set the minimum difference between timestamps and audio data (in +seconds) to trigger adding/dropping samples to make it match the +timestamps. This option effectively is a threshold to select between +hard (trim/fill) and soft (squeeze/stretch) compensation. Note that +all compensation is by default disabled through min_comp. +The default is 0.1. +

+
+
comp_duration
+

For swr only, set duration (in seconds) over which data is stretched/squeezed +to make it match the timestamps. Must be a non-negative double float value, +default value is 1.0. +

+
+
max_soft_comp
+

For swr only, set maximum factor by which data is stretched/squeezed to make it +match the timestamps. Must be a non-negative double float value, default value +is 0. +

+
+
matrix_encoding
+

Select matrixed stereo encoding. +

+

It accepts the following values: +

+
‘none’
+

select none +

+
‘dolby’
+

select Dolby +

+
‘dplii’
+

select Dolby Pro Logic II +

+
+ +

Default value is none. +

+
+
filter_type
+

For swr only, select resampling filter type. This only affects resampling +operations. +

+

It accepts the following values: +

+
‘cubic’
+

select cubic +

+
‘blackman_nuttall’
+

select Blackman Nuttall windowed sinc +

+
‘kaiser’
+

select Kaiser windowed sinc +

+
+ +
+
kaiser_beta
+

For swr only, set Kaiser window beta value. Must be a double float value in the +interval [2,16], default value is 9. +

+
+
output_sample_bits
+

For swr only, set number of used output sample bits for dithering. Must be an integer in the +interval [0,64], default value is 0, which means it’s not used. +

+
+
+ + +

29 Scaler Options

+ +

The video scaler supports the following named options. +

+

Options may be set by specifying -option value in the +FFmpeg tools, with a few API-only exceptions noted below. +For programmatic use, they can be set explicitly in the +SwsContext options or through the libavutil/opt.h API. +

+
+
+
+
sws_flags
+

Set the scaler flags. This is also used to set the scaling +algorithm. Only a single algorithm should be selected. Default +value is ‘bicubic’. +

+

It accepts the following values: +

+
‘fast_bilinear’
+

Select fast bilinear scaling algorithm. +

+
+
‘bilinear’
+

Select bilinear scaling algorithm. +

+
+
‘bicubic’
+

Select bicubic scaling algorithm. +

+
+
‘experimental’
+

Select experimental scaling algorithm. +

+
+
‘neighbor’
+

Select nearest neighbor rescaling algorithm. +

+
+
‘area’
+

Select averaging area rescaling algorithm. +

+
+
‘bicublin’
+

Select bicubic scaling algorithm for the luma component, bilinear for +chroma components. +

+
+
‘gauss’
+

Select Gaussian rescaling algorithm. +

+
+
‘sinc’
+

Select sinc rescaling algorithm. +

+
+
‘lanczos’
+

Select Lanczos rescaling algorithm. The default width (alpha) is 3 and can be +changed by setting param0. +

+
+
‘spline’
+

Select natural bicubic spline rescaling algorithm. +

+
+
‘print_info’
+

Enable printing/debug logging. +

+
+
‘accurate_rnd’
+

Enable accurate rounding. +

+
+
‘full_chroma_int’
+

Enable full chroma interpolation. +

+
+
‘full_chroma_inp’
+

Select full chroma input. +

+
+
‘bitexact’
+

Enable bitexact output. +

+
+ +
+
srcw (API only)
+

Set source width. +

+
+
srch (API only)
+

Set source height. +

+
+
dstw (API only)
+

Set destination width. +

+
+
dsth (API only)
+

Set destination height. +

+
+
src_format (API only)
+

Set source pixel format (must be expressed as an integer). +

+
+
dst_format (API only)
+

Set destination pixel format (must be expressed as an integer). +

+
+
src_range (boolean)
+

If value is set to 1, indicates source is full range. Default value is +0, which indicates source is limited range. +

+
+
dst_range (boolean)
+

If value is set to 1, enable full range for destination. Default value +is 0, which enables limited range. +

+
+
param0, param1
+

Set scaling algorithm parameters. The specified values are specific of +some scaling algorithms and ignored by others. The specified values +are floating point number values. +

+
+
sws_dither
+

Set the dithering algorithm. Accepts one of the following +values. Default value is ‘auto’. +

+
+
‘auto’
+

automatic choice +

+
+
‘none’
+

no dithering +

+
+
‘bayer’
+

bayer dither +

+
+
‘ed’
+

error diffusion dither +

+
+
‘a_dither’
+

arithmetic dither, based using addition +

+
+
‘x_dither’
+

arithmetic dither, based using xor (more random/less apparent patterning that +a_dither). +

+
+
+ +
+
alphablend
+

Set the alpha blending to use when the input has alpha but the output does not. +Default value is ‘none’. +

+
+
‘uniform_color’
+

Blend onto a uniform background color +

+
+
‘checkerboard’
+

Blend onto a checkerboard +

+
+
‘none’
+

No blending +

+
+
+ +
+
+ + +

30 Filtering Introduction

+ +

Filtering in FFmpeg is enabled through the libavfilter library. +

+

In libavfilter, a filter can have multiple inputs and multiple +outputs. +To illustrate the sorts of things that are possible, we consider the +following filtergraph. +

+
                [main]
+input --> split ---------------------> overlay --> output
+            |                             ^
+            |[tmp]                  [flip]|
+            +-----> crop --> vflip -------+
+
+

This filtergraph splits the input stream in two streams, then sends one +stream through the crop filter and the vflip filter, before merging it +back with the other stream by overlaying it on top. You can use the +following command to achieve this: +

+
+
ffmpeg -i INPUT -vf "split [main][tmp]; [tmp] crop=iw:ih/2:0:0, vflip [flip]; [main][flip] overlay=0:H/2" OUTPUT
+
+ +

The result will be that the top half of the video is mirrored +onto the bottom half of the output video. +

+

Filters in the same linear chain are separated by commas, and distinct +linear chains of filters are separated by semicolons. In our example, +crop,vflip are in one linear chain, split and +overlay are separately in another. The points where the linear +chains join are labelled by names enclosed in square brackets. In the +example, the split filter generates two outputs that are associated to +the labels [main] and [tmp]. +

+

The stream sent to the second output of split, labelled as +[tmp], is processed through the crop filter, which crops +away the lower half part of the video, and then vertically flipped. The +overlay filter takes in input the first unchanged output of the +split filter (which was labelled as [main]), and overlay on its +lower half the output generated by the crop,vflip filterchain. +

+

Some filters take in input a list of parameters: they are specified +after the filter name and an equal sign, and are separated from each other +by a colon. +

+

There exist so-called source filters that do not have an +audio/video input, and sink filters that will not have audio/video +output. +

+ + +

31 graph2dot

+ +

The graph2dot program included in the FFmpeg tools +directory can be used to parse a filtergraph description and issue a +corresponding textual representation in the dot language. +

+

Invoke the command: +

+
graph2dot -h
+
+ +

to see how to use graph2dot. +

+

You can then pass the dot description to the dot program (from +the graphviz suite of programs) and obtain a graphical representation +of the filtergraph. +

+

For example the sequence of commands: +

+
echo GRAPH_DESCRIPTION | \
+tools/graph2dot -o graph.tmp && \
+dot -Tpng graph.tmp -o graph.png && \
+display graph.png
+
+ +

can be used to create and display an image representing the graph +described by the GRAPH_DESCRIPTION string. Note that this string must be +a complete self-contained graph, with its inputs and outputs explicitly defined. +For example if your command line is of the form: +

+
ffmpeg -i infile -vf scale=640:360 outfile
+
+

your GRAPH_DESCRIPTION string will need to be of the form: +

+
nullsrc,scale=640:360,nullsink
+
+

you may also need to set the nullsrc parameters and add a format +filter in order to simulate a specific input file. +

+ + +

32 Filtergraph description

+ +

A filtergraph is a directed graph of connected filters. It can contain +cycles, and there can be multiple links between a pair of +filters. Each link has one input pad on one side connecting it to one +filter from which it takes its input, and one output pad on the other +side connecting it to one filter accepting its output. +

+

Each filter in a filtergraph is an instance of a filter class +registered in the application, which defines the features and the +number of input and output pads of the filter. +

+

A filter with no input pads is called a "source", and a filter with no +output pads is called a "sink". +

+ +

32.1 Filtergraph syntax

+ +

A filtergraph has a textual representation, which is recognized by the +-filter/-vf/-af and +-filter_complex options in ffmpeg and +-vf/-af in ffplay, and by the +avfilter_graph_parse_ptr() function defined in +libavfilter/avfilter.h. +

+

A filterchain consists of a sequence of connected filters, each one +connected to the previous one in the sequence. A filterchain is +represented by a list of ","-separated filter descriptions. +

+

A filtergraph consists of a sequence of filterchains. A sequence of +filterchains is represented by a list of ";"-separated filterchain +descriptions. +

+

A filter is represented by a string of the form: +[in_link_1]...[in_link_N]filter_name@id=arguments[out_link_1]...[out_link_M] +

+

filter_name is the name of the filter class of which the +described filter is an instance of, and has to be the name of one of +the filter classes registered in the program optionally followed by "@id". +The name of the filter class is optionally followed by a string +"=arguments". +

+

arguments is a string which contains the parameters used to +initialize the filter instance. It may have one of two forms: +

    +
  • A ’:’-separated list of key=value pairs. + +
  • A ’:’-separated list of value. In this case, the keys are assumed to be +the option names in the order they are declared. E.g. the fade filter +declares three options in this order – type, start_frame and +nb_frames. Then the parameter list in:0:30 means that the value +in is assigned to the option type, 0 to +start_frame and 30 to nb_frames. + +
  • A ’:’-separated list of mixed direct value and long key=value +pairs. The direct value must precede the key=value pairs, and +follow the same constraints order of the previous point. The following +key=value pairs can be set in any preferred order. + +
+ +

If the option value itself is a list of items (e.g. the format filter +takes a list of pixel formats), the items in the list are usually separated by +‘|’. +

+

The list of arguments can be quoted using the character ‘'’ as initial +and ending mark, and the character ‘\’ for escaping the characters +within the quoted text; otherwise the argument string is considered +terminated when the next special character (belonging to the set +‘[]=;,’) is encountered. +

+

The name and arguments of the filter are optionally preceded and +followed by a list of link labels. +A link label allows one to name a link and associate it to a filter output +or input pad. The preceding labels in_link_1 +... in_link_N, are associated to the filter input pads, +the following labels out_link_1 ... out_link_M, are +associated to the output pads. +

+

When two link labels with the same name are found in the +filtergraph, a link between the corresponding input and output pad is +created. +

+

If an output pad is not labelled, it is linked by default to the first +unlabelled input pad of the next filter in the filterchain. +For example in the filterchain +

+
nullsrc, split[L1], [L2]overlay, nullsink
+
+

the split filter instance has two output pads, and the overlay filter +instance two input pads. The first output pad of split is labelled +"L1", the first input pad of overlay is labelled "L2", and the second +output pad of split is linked to the second input pad of overlay, +which are both unlabelled. +

+

In a filter description, if the input label of the first filter is not +specified, "in" is assumed; if the output label of the last filter is not +specified, "out" is assumed. +

+

In a complete filterchain all the unlabelled filter input and output +pads must be connected. A filtergraph is considered valid if all the +filter input and output pads of all the filterchains are connected. +

+

Libavfilter will automatically insert scale filters where format +conversion is required. It is possible to specify swscale flags +for those automatically inserted scalers by prepending +sws_flags=flags; +to the filtergraph description. +

+

Here is a BNF description of the filtergraph syntax: +

+
NAME             ::= sequence of alphanumeric characters and '_'
+FILTER_NAME      ::= NAME["@"NAME]
+LINKLABEL        ::= "[" NAME "]"
+LINKLABELS       ::= LINKLABEL [LINKLABELS]
+FILTER_ARGUMENTS ::= sequence of chars (possibly quoted)
+FILTER           ::= [LINKLABELS] FILTER_NAME ["=" FILTER_ARGUMENTS] [LINKLABELS]
+FILTERCHAIN      ::= FILTER [,FILTERCHAIN]
+FILTERGRAPH      ::= [sws_flags=flags;] FILTERCHAIN [;FILTERGRAPH]
+
+ + +

32.2 Notes on filtergraph escaping

+ +

Filtergraph description composition entails several levels of +escaping. See (ffmpeg-utils)the "Quoting and escaping" +section in the ffmpeg-utils(1) manual for more +information about the employed escaping procedure. +

+

A first level escaping affects the content of each filter option +value, which may contain the special character : used to +separate values, or one of the escaping characters \'. +

+

A second level escaping affects the whole filter description, which +may contain the escaping characters \' or the special +characters [],; used by the filtergraph description. +

+

Finally, when you specify a filtergraph on a shell commandline, you +need to perform a third level escaping for the shell special +characters contained within it. +

+

For example, consider the following string to be embedded in +the drawtext filter description text value: +

+
this is a 'string': may contain one, or more, special characters
+
+ +

This string contains the ' special escaping character, and the +: special character, so it needs to be escaped in this way: +

+
text=this is a \'string\'\: may contain one, or more, special characters
+
+ +

A second level of escaping is required when embedding the filter +description in a filtergraph description, in order to escape all the +filtergraph special characters. Thus the example above becomes: +

+
drawtext=text=this is a \\\'string\\\'\\: may contain one\, or more\, special characters
+
+

(note that in addition to the \' escaping special characters, +also , needs to be escaped). +

+

Finally an additional level of escaping is needed when writing the +filtergraph description in a shell command, which depends on the +escaping rules of the adopted shell. For example, assuming that +\ is special and needs to be escaped with another \, the +previous string will finally result in: +

+
-vf "drawtext=text=this is a \\\\\\'string\\\\\\'\\\\: may contain one\\, or more\\, special characters"
+
+ + +

33 Timeline editing

+ +

Some filters support a generic enable option. For the filters +supporting timeline editing, this option can be set to an expression which is +evaluated before sending a frame to the filter. If the evaluation is non-zero, +the filter will be enabled, otherwise the frame will be sent unchanged to the +next filter in the filtergraph. +

+

The expression accepts the following values: +

+
‘t’
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+
‘n’
+

sequential number of the input frame, starting from 0 +

+
+
‘pos’
+

the position in the file of the input frame, NAN if unknown +

+
+
‘w’
+
‘h’
+

width and height of the input frame if video +

+
+ +

Additionally, these filters support an enable command that can be used +to re-define the expression. +

+

Like any other filtering option, the enable option follows the same +rules. +

+

For example, to enable a blur filter (smartblur) from 10 seconds to 3 +minutes, and a curves filter starting at 3 seconds: +

+
smartblur = enable='between(t,10,3*60)',
+curves    = enable='gte(t,3)' : preset=cross_process
+
+ +

See ffmpeg -filters to view which filters have timeline support. +

+ + +

34 Changing options at runtime with a command

+ +

Some options can be changed during the operation of the filter using +a command. These options are marked ’T’ on the output of +ffmpeg -h filter=<name of filter>. +The name of the command is the name of the option and the argument is +the new value. +

+ +

35 Options for filters with several inputs (framesync)

+ +

Some filters with several inputs support a common set of options. +These options can only be set by name, not with the short notation. +

+
+
eof_action
+

The action to take when EOF is encountered on the secondary input; it accepts +one of the following values: +

+
+
repeat
+

Repeat the last frame (the default). +

+
endall
+

End both streams. +

+
pass
+

Pass the main input through. +

+
+ +
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+
repeatlast
+

If set to 1, force the filter to extend the last frame of secondary streams +until the end of the primary stream. A value of 0 disables this behavior. +Default value is 1. +

+
+ + + +

36 Audio Filters

+ +

When you configure your FFmpeg build, you can disable any of the +existing filters using --disable-filters. +The configure output will show the audio filters included in your +build. +

+

Below is a description of the currently available audio filters. +

+ +

36.1 acompressor

+ +

A compressor is mainly used to reduce the dynamic range of a signal. +Especially modern music is mostly compressed at a high ratio to +improve the overall loudness. It’s done to get the highest attention +of a listener, "fatten" the sound and bring more "power" to the track. +If a signal is compressed too much it may sound dull or "dead" +afterwards or it may start to "pump" (which could be a powerful effect +but can also destroy a track completely). +The right compression is the key to reach a professional sound and is +the high art of mixing and mastering. Because of its complex settings +it may take a long time to get the right feeling for this kind of effect. +

+

Compression is done by detecting the volume above a chosen level +threshold and dividing it by the factor set with ratio. +So if you set the threshold to -12dB and your signal reaches -6dB a ratio +of 2:1 will result in a signal at -9dB. Because an exact manipulation of +the signal would cause distortion of the waveform the reduction can be +levelled over the time. This is done by setting "Attack" and "Release". +attack determines how long the signal has to rise above the threshold +before any reduction will occur and release sets the time the signal +has to fall below the threshold to reduce the reduction again. Shorter signals +than the chosen attack time will be left untouched. +The overall reduction of the signal can be made up afterwards with the +makeup setting. So compressing the peaks of a signal about 6dB and +raising the makeup to this level results in a signal twice as loud than the +source. To gain a softer entry in the compression the knee flattens the +hard edge at the threshold in the range of the chosen decibels. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. Default is 1. Range is between 0.015625 and 64. +

+
+
mode
+

Set mode of compressor operation. Can be upward or downward. +Default is downward. +

+
+
threshold
+

If a signal of stream rises above this level it will affect the gain +reduction. +By default it is 0.125. Range is between 0.00097563 and 1. +

+
+
ratio
+

Set a ratio by which the signal is reduced. 1:2 means that if the level +rose 4dB above the threshold, it will be only 2dB above after the reduction. +Default is 2. Range is between 1 and 20. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction starts. Default is 20. Range is between 0.01 and 2000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before +reduction is decreased again. Default is 250. Range is between 0.01 and 9000. +

+
+
makeup
+

Set the amount by how much signal will be amplified after processing. +Default is 1. Range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.82843. Range is between 1 and 8. +

+
+
link
+

Choose if the average level between all channels of input stream +or the louder(maximum) channel of input stream affects the +reduction. Default is average. +

+
+
detection
+

Should the exact signal be taken in case of peak or an RMS one in case +of rms. Default is rms which is mostly smoother. +

+
+
mix
+

How much to use compressed signal in output. Default is 1. +Range is between 0 and 1. +

+
+ + +

36.1.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

36.2 acontrast

+

Simple audio dynamic range compression/expansion filter. +

+

The filter accepts the following options: +

+
+
contrast
+

Set contrast. Default is 33. Allowed range is between 0 and 100. +

+
+ + +

36.3 acopy

+ +

Copy the input audio source unchanged to the output. This is mainly useful for +testing purposes. +

+ +

36.4 acrossfade

+ +

Apply cross fade from one input audio stream to another input audio stream. +The cross fade is applied for specified duration near the end of first stream. +

+

The filter accepts the following options: +

+
+
nb_samples, ns
+

Specify the number of samples for which the cross fade effect has to last. +At the end of the cross fade effect the first input audio will be completely +silent. Default is 44100. +

+
+
duration, d
+

Specify the duration of the cross fade effect. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +By default the duration is determined by nb_samples. +If set this option is used instead of nb_samples. +

+
+
overlap, o
+

Should first stream end overlap with second stream start. Default is enabled. +

+
+
curve1
+

Set curve for cross fade transition for first stream. +

+
+
curve2
+

Set curve for cross fade transition for second stream. +

+

For description of available curve types see afade filter description. +

+
+ + +

36.4.1 Examples

+ +
    +
  • Cross fade from one input to another: +
    +
    ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:c1=exp:c2=exp output.flac
+
    + +
  • Cross fade from one input to another but without overlapping: +
    +
    ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:o=0:c1=exp:c2=exp output.flac
+
    +
+ + +

36.5 acrossover

+

Split audio stream into several bands. +

+

This filter splits audio stream into two or more frequency ranges. +Summing all streams back will give flat output. +

+

The filter accepts the following options: +

+
+
split
+

Set split frequencies. Those must be positive and increasing. +

+
+
order
+

Set filter order, can be 2nd, 4th or 8th. +Default is 4th. +

+
+ + +

36.6 acrusher

+ +

Reduce audio bit resolution. +

+

This filter is bit crusher with enhanced functionality. A bit crusher +is used to audibly reduce number of bits an audio signal is sampled +with. This doesn’t change the bit depth at all, it just produces the +effect. Material reduced in bit depth sounds more harsh and "digital". +This filter is able to even round to continuous values instead of discrete +bit depths. +Additionally it has a D/C offset which results in different crushing of +the lower and the upper half of the signal. +An Anti-Aliasing setting is able to produce "softer" crushing sounds. +

+

Another feature of this filter is the logarithmic mode. +This setting switches from linear distances between bits to logarithmic ones. +The result is a much more "natural" sounding crusher which doesn’t gate low +signals for example. The human ear has a logarithmic perception, +so this kind of crushing is much more pleasant. +Logarithmic crushing is also able to get anti-aliased. +

+

The filter accepts the following options: +

+
+
level_in
+

Set level in. +

+
+
level_out
+

Set level out. +

+
+
bits
+

Set bit reduction. +

+
+
mix
+

Set mixing amount. +

+
+
mode
+

Can be linear: lin or logarithmic: log. +

+
+
dc
+

Set DC. +

+
+
aa
+

Set anti-aliasing. +

+
+
samples
+

Set sample reduction. +

+
+
lfo
+

Enable LFO. By default disabled. +

+
+
lforange
+

Set LFO range. +

+
+
lforate
+

Set LFO rate. +

+
+ + +

36.7 acue

+ +

Delay audio filtering until a given wallclock timestamp. See the cue +filter. +

+ +

36.8 adeclick

+

Remove impulsive noise from input audio. +

+

Samples detected as impulsive noise are replaced by interpolated samples using +autoregressive modelling. +

+
+
w
+

Set window size, in milliseconds. Allowed range is from 10 to +100. Default value is 55 milliseconds. +This sets size of window which will be processed at once. +

+
+
o
+

Set window overlap, in percentage of window size. Allowed range is from +50 to 95. Default value is 75 percent. +Setting this to a very high value increases impulsive noise removal but makes +whole process much slower. +

+
+
a
+

Set autoregression order, in percentage of window size. Allowed range is from +0 to 25. Default value is 2 percent. This option also +controls quality of interpolated samples using neighbour good samples. +

+
+
t
+

Set threshold value. Allowed range is from 1 to 100. +Default value is 2. +This controls the strength of impulsive noise which is going to be removed. +The lower value, the more samples will be detected as impulsive noise. +

+
+
b
+

Set burst fusion, in percentage of window size. Allowed range is 0 to +10. Default value is 2. +If any two samples detected as noise are spaced less than this value then any +sample between those two samples will be also detected as noise. +

+
+
m
+

Set overlap method. +

+

It accepts the following values: +

+
a
+

Select overlap-add method. Even not interpolated samples are slightly +changed with this method. +

+
+
s
+

Select overlap-save method. Not interpolated samples remain unchanged. +

+
+ +

Default value is a. +

+
+ + +

36.9 adeclip

+

Remove clipped samples from input audio. +

+

Samples detected as clipped are replaced by interpolated samples using +autoregressive modelling. +

+
+
w
+

Set window size, in milliseconds. Allowed range is from 10 to 100. +Default value is 55 milliseconds. +This sets size of window which will be processed at once. +

+
+
o
+

Set window overlap, in percentage of window size. Allowed range is from 50 +to 95. Default value is 75 percent. +

+
+
a
+

Set autoregression order, in percentage of window size. Allowed range is from +0 to 25. Default value is 8 percent. This option also controls +quality of interpolated samples using neighbour good samples. +

+
+
t
+

Set threshold value. Allowed range is from 1 to 100. +Default value is 10. Higher values make clip detection less aggressive. +

+
+
n
+

Set size of histogram used to detect clips. Allowed range is from 100 to 9999. +Default value is 1000. Higher values make clip detection less aggressive. +

+
+
m
+

Set overlap method. +

+

It accepts the following values: +

+
a
+

Select overlap-add method. Even not interpolated samples are slightly changed +with this method. +

+
+
s
+

Select overlap-save method. Not interpolated samples remain unchanged. +

+
+ +

Default value is a. +

+
+ + +

36.10 adelay

+ +

Delay one or more audio channels. +

+

Samples in delayed channel are filled with silence. +

+

The filter accepts the following option: +

+
+
delays
+

Set list of delays in milliseconds for each channel separated by ’|’. +Unused delays will be silently ignored. If number of given delays is +smaller than number of channels all remaining channels will not be delayed. +If you want to delay exact number of samples, append ’S’ to number. +If you want instead to delay in seconds, append ’s’ to number. +

+
+
all
+

Use last set delay for all remaining channels. By default is disabled. +This option if enabled changes how option delays is interpreted. +

+
+ + +

36.10.1 Examples

+ +
    +
  • Delay first channel by 1.5 seconds, the third channel by 0.5 seconds and leave +the second channel (and any other channels that may be present) unchanged. +
    +
    adelay=1500|0|500
+
    + +
  • Delay second channel by 500 samples, the third channel by 700 samples and leave +the first channel (and any other channels that may be present) unchanged. +
    +
    adelay=0|500S|700S
+
    + +
  • Delay all channels by same number of samples: +
    +
    adelay=delays=64S:all=1
+
    +
+ + +

36.11 aderivative, aintegral

+ +

Compute derivative/integral of audio stream. +

+

Applying both filters one after another produces original audio. +

+ +

36.12 aecho

+ +

Apply echoing to the input audio. +

+

Echoes are reflected sound and can occur naturally amongst mountains +(and sometimes large buildings) when talking or shouting; digital echo +effects emulate this behaviour and are often used to help fill out the +sound of a single instrument or vocal. The time difference between the +original signal and the reflection is the delay, and the +loudness of the reflected signal is the decay. +Multiple echoes can have different delays and decays. +

+

A description of the accepted parameters follows. +

+
+
in_gain
+

Set input gain of reflected signal. Default is 0.6. +

+
+
out_gain
+

Set output gain of reflected signal. Default is 0.3. +

+
+
delays
+

Set list of time intervals in milliseconds between original signal and reflections +separated by ’|’. Allowed range for each delay is (0 - 90000.0]. +Default is 1000. +

+
+
decays
+

Set list of loudness of reflected signals separated by ’|’. +Allowed range for each decay is (0 - 1.0]. +Default is 0.5. +

+
+ + +

36.12.1 Examples

+ +
    +
  • Make it sound as if there are twice as many instruments as are actually playing: +
    +
    aecho=0.8:0.88:60:0.4
+
    + +
  • If delay is very short, then it sounds like a (metallic) robot playing music: +
    +
    aecho=0.8:0.88:6:0.4
+
    + +
  • A longer delay will sound like an open air concert in the mountains: +
    +
    aecho=0.8:0.9:1000:0.3
+
    + +
  • Same as above but with one more mountain: +
    +
    aecho=0.8:0.9:1000|1800:0.3|0.25
+
    +
+ + +

36.13 aemphasis

+

Audio emphasis filter creates or restores material directly taken from LPs or +emphased CDs with different filter curves. E.g. to store music on vinyl the +signal has to be altered by a filter first to even out the disadvantages of +this recording medium. +Once the material is played back the inverse filter has to be applied to +restore the distortion of the frequency response. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. +

+
+
level_out
+

Set output gain. +

+
+
mode
+

Set filter mode. For restoring material use reproduction mode, otherwise +use production mode. Default is reproduction mode. +

+
+
type
+

Set filter type. Selects medium. Can be one of the following: +

+
+
col
+

select Columbia. +

+
emi
+

select EMI. +

+
bsi
+

select BSI (78RPM). +

+
riaa
+

select RIAA. +

+
cd
+

select Compact Disc (CD). +

+
50fm
+

select 50µs (FM). +

+
75fm
+

select 75µs (FM). +

+
50kf
+

select 50µs (FM-KF). +

+
75kf
+

select 75µs (FM-KF). +

+
+
+
+ + +

36.14 aeval

+ +

Modify an audio signal according to the specified expressions. +

+

This filter accepts one or more expressions (one for each channel), +which are evaluated and used to modify a corresponding audio signal. +

+

It accepts the following parameters: +

+
+
exprs
+

Set the ’|’-separated expressions list for each separate channel. If +the number of input channels is greater than the number of +expressions, the last specified expression is used for the remaining +output channels. +

+
+
channel_layout, c
+

Set output channel layout. If not specified, the channel layout is +specified by the number of expressions. If set to ‘same’, it will +use by default the same input channel layout. +

+
+ +

Each expression in exprs can contain the following constants and functions: +

+
+
ch
+

channel number of the current expression +

+
+
n
+

number of the evaluated sample, starting from 0 +

+
+
s
+

sample rate +

+
+
t
+

time of the evaluated sample expressed in seconds +

+
+
nb_in_channels
+
nb_out_channels
+

input and output number of channels +

+
+
val(CH)
+

the value of input channel with number CH +

+
+ +

Note: this filter is slow. For faster processing you should use a +dedicated filter. +

+ +

36.14.1 Examples

+ +
    +
  • Half volume: +
    +
    aeval=val(ch)/2:c=same
+
    + +
  • Invert phase of the second channel: +
    +
    aeval=val(0)|-val(1)
+
    +
+ + +

36.15 afade

+ +

Apply fade-in/out effect to input audio. +

+

A description of the accepted parameters follows. +

+
+
type, t
+

Specify the effect type, can be either in for fade-in, or +out for a fade-out effect. Default is in. +

+
+
start_sample, ss
+

Specify the number of the start sample for starting to apply the fade +effect. Default is 0. +

+
+
nb_samples, ns
+

Specify the number of samples for which the fade effect has to last. At +the end of the fade-in effect the output audio will have the same +volume as the input audio, at the end of the fade-out transition +the output audio will be silence. Default is 44100. +

+
+
start_time, st
+

Specify the start time of the fade effect. Default is 0. +The value must be specified as a time duration; see +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +If set this option is used instead of start_sample. +

+
+
duration, d
+

Specify the duration of the fade effect. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +At the end of the fade-in effect the output audio will have the same +volume as the input audio, at the end of the fade-out transition +the output audio will be silence. +By default the duration is determined by nb_samples. +If set this option is used instead of nb_samples. +

+
+
curve
+

Set curve for fade transition. +

+

It accepts the following values: +

+
tri
+

select triangular, linear slope (default) +

+
qsin
+

select quarter of sine wave +

+
hsin
+

select half of sine wave +

+
esin
+

select exponential sine wave +

+
log
+

select logarithmic +

+
ipar
+

select inverted parabola +

+
qua
+

select quadratic +

+
cub
+

select cubic +

+
squ
+

select square root +

+
cbr
+

select cubic root +

+
par
+

select parabola +

+
exp
+

select exponential +

+
iqsin
+

select inverted quarter of sine wave +

+
ihsin
+

select inverted half of sine wave +

+
dese
+

select double-exponential seat +

+
desi
+

select double-exponential sigmoid +

+
losi
+

select logistic sigmoid +

+
nofade
+

no fade applied +

+
+
+
+ + +

36.15.1 Examples

+ +
    +
  • Fade in first 15 seconds of audio: +
    +
    afade=t=in:ss=0:d=15
+
    + +
  • Fade out last 25 seconds of a 900 seconds audio: +
    +
    afade=t=out:st=875:d=25
+
    +
+ + +

36.16 afftdn

+

Denoise audio samples with FFT. +

+

A description of the accepted parameters follows. +

+
+
nr
+

Set the noise reduction in dB, allowed range is 0.01 to 97. +Default value is 12 dB. +

+
+
nf
+

Set the noise floor in dB, allowed range is -80 to -20. +Default value is -50 dB. +

+
+
nt
+

Set the noise type. +

+

It accepts the following values: +

+
w
+

Select white noise. +

+
+
v
+

Select vinyl noise. +

+
+
s
+

Select shellac noise. +

+
+
c
+

Select custom noise, defined in bn option. +

+

Default value is white noise. +

+
+ +
+
bn
+

Set custom band noise for every one of 15 bands. +Bands are separated by ’ ’ or ’|’. +

+
+
rf
+

Set the residual floor in dB, allowed range is -80 to -20. +Default value is -38 dB. +

+
+
tn
+

Enable noise tracking. By default is disabled. +With this enabled, noise floor is automatically adjusted. +

+
+
tr
+

Enable residual tracking. By default is disabled. +

+
+
om
+

Set the output mode. +

+

It accepts the following values: +

+
i
+

Pass input unchanged. +

+
+
o
+

Pass noise filtered out. +

+
+
n
+

Pass only noise. +

+

Default value is o. +

+
+
+
+ + +

36.16.1 Commands

+ +

This filter supports the following commands: +

+
sample_noise, sn
+

Start or stop measuring noise profile. +Syntax for the command is : "start" or "stop" string. +After measuring noise profile is stopped it will be +automatically applied in filtering. +

+
+
noise_reduction, nr
+

Change noise reduction. Argument is single float number. +Syntax for the command is : "noise_reduction" +

+
+
noise_floor, nf
+

Change noise floor. Argument is single float number. +Syntax for the command is : "noise_floor" +

+
+
output_mode, om
+

Change output mode operation. +Syntax for the command is : "i", "o" or "n" string. +

+
+ + +

36.17 afftfilt

+

Apply arbitrary expressions to samples in frequency domain. +

+
+
real
+

Set frequency domain real expression for each separate channel separated +by ’|’. Default is "re". +If the number of input channels is greater than the number of +expressions, the last specified expression is used for the remaining +output channels. +

+
+
imag
+

Set frequency domain imaginary expression for each separate channel +separated by ’|’. Default is "im". +

+

Each expression in real and imag can contain the following +constants and functions: +

+
+
sr
+

sample rate +

+
+
b
+

current frequency bin number +

+
+
nb
+

number of available bins +

+
+
ch
+

channel number of the current expression +

+
+
chs
+

number of channels +

+
+
pts
+

current frame pts +

+
+
re
+

current real part of frequency bin of current channel +

+
+
im
+

current imaginary part of frequency bin of current channel +

+
+
real(b, ch)
+

Return the value of real part of frequency bin at location (bin,channel) +

+
+
imag(b, ch)
+

Return the value of imaginary part of frequency bin at location (bin,channel) +

+
+ +
+
win_size
+

Set window size. Allowed range is from 16 to 131072. +Default is 4096 +

+
+
win_func
+

Set window function. Default is hann. +

+
+
overlap
+

Set window overlap. If set to 1, the recommended overlap for selected +window function will be picked. Default is 0.75. +

+
+ + +

36.17.1 Examples

+ +
    +
  • Leave almost only low frequencies in audio: +
    +
    afftfilt="'real=re * (1-clip((b/nb)*b,0,1))':imag='im * (1-clip((b/nb)*b,0,1))'"
+
    + +
  • Apply robotize effect: +
    +
    afftfilt="real='hypot(re,im)*sin(0)':imag='hypot(re,im)*cos(0)':win_size=512:overlap=0.75"
+
    + +
  • Apply whisper effect: +
    +
    afftfilt="real='hypot(re,im)*cos((random(0)*2-1)*2*3.14)':imag='hypot(re,im)*sin((random(1)*2-1)*2*3.14)':win_size=128:overlap=0.8"
+
    +
+ + +

36.18 afir

+ +

Apply an arbitrary Finite Impulse Response filter. +

+

This filter is designed for applying long FIR filters, +up to 60 seconds long. +

+

It can be used as component for digital crossover filters, +room equalization, cross talk cancellation, wavefield synthesis, +auralization, ambiophonics, ambisonics and spatialization. +

+

This filter uses the streams higher than first one as FIR coefficients. +If the non-first stream holds a single channel, it will be used +for all input channels in the first stream, otherwise +the number of channels in the non-first stream must be same as +the number of channels in the first stream. +

+

It accepts the following parameters: +

+
+
dry
+

Set dry gain. This sets input gain. +

+
+
wet
+

Set wet gain. This sets final output gain. +

+
+
length
+

Set Impulse Response filter length. Default is 1, which means whole IR is processed. +

+
+
gtype
+

Enable applying gain measured from power of IR. +

+

Set which approach to use for auto gain measurement. +

+
+
none
+

Do not apply any gain. +

+
+
peak
+

select peak gain, very conservative approach. This is default value. +

+
+
dc
+

select DC gain, limited application. +

+
+
gn
+

select gain to noise approach, this is most popular one. +

+
+ +
+
irgain
+

Set gain to be applied to IR coefficients before filtering. +Allowed range is 0 to 1. This gain is applied after any gain applied with gtype option. +

+
+
irfmt
+

Set format of IR stream. Can be mono or input. +Default is input. +

+
+
maxir
+

Set max allowed Impulse Response filter duration in seconds. Default is 30 seconds. +Allowed range is 0.1 to 60 seconds. +

+
+
response
+

Show IR frequency response, magnitude(magenta), phase(green) and group delay(yellow) in additional video stream. +By default it is disabled. +

+
+
channel
+

Set for which IR channel to display frequency response. By default is first channel +displayed. This option is used only when response is enabled. +

+
+
size
+

Set video stream size. This option is used only when response is enabled. +

+
+
rate
+

Set video stream frame rate. This option is used only when response is enabled. +

+
+
minp
+

Set minimal partition size used for convolution. Default is 8192. +Allowed range is from 1 to 32768. +Lower values decreases latency at cost of higher CPU usage. +

+
+
maxp
+

Set maximal partition size used for convolution. Default is 8192. +Allowed range is from 8 to 32768. +Lower values may increase CPU usage. +

+
+
nbirs
+

Set number of input impulse responses streams which will be switchable at runtime. +Allowed range is from 1 to 32. Default is 1. +

+
+
ir
+

Set IR stream which will be used for convolution, starting from 0, should always be +lower than supplied value by nbirs option. Default is 0. +This option can be changed at runtime via commands. +

+
+ + +

36.18.1 Examples

+ +
    +
  • Apply reverb to stream using mono IR file as second input, complete command using ffmpeg: +
    +
    ffmpeg -i input.wav -i middle_tunnel_1way_mono.wav -lavfi afir output.wav
+
    +
+ + +

36.19 aformat

+ +

Set output format constraints for the input audio. The framework will +negotiate the most appropriate format to minimize conversions. +

+

It accepts the following parameters: +

+
sample_fmts, f
+

A ’|’-separated list of requested sample formats. +

+
+
sample_rates, r
+

A ’|’-separated list of requested sample rates. +

+
+
channel_layouts, cl
+

A ’|’-separated list of requested channel layouts. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+ +

If a parameter is omitted, all values are allowed. +

+

Force the output to either unsigned 8-bit or signed 16-bit stereo +

+
aformat=sample_fmts=u8|s16:channel_layouts=stereo
+
+ + +

36.20 agate

+ +

A gate is mainly used to reduce lower parts of a signal. This kind of signal +processing reduces disturbing noise between useful signals. +

+

Gating is done by detecting the volume below a chosen level threshold +and dividing it by the factor set with ratio. The bottom of the noise +floor is set via range. Because an exact manipulation of the signal +would cause distortion of the waveform the reduction can be levelled over +time. This is done by setting attack and release. +

+

attack determines how long the signal has to fall below the threshold +before any reduction will occur and release sets the time the signal +has to rise above the threshold to reduce the reduction again. +Shorter signals than the chosen attack time will be left untouched. +

+
+
level_in
+

Set input level before filtering. +Default is 1. Allowed range is from 0.015625 to 64. +

+
+
mode
+

Set the mode of operation. Can be upward or downward. +Default is downward. If set to upward mode, higher parts of signal +will be amplified, expanding dynamic range in upward direction. +Otherwise, in case of downward lower parts of signal will be reduced. +

+
+
range
+

Set the level of gain reduction when the signal is below the threshold. +Default is 0.06125. Allowed range is from 0 to 1. +Setting this to 0 disables reduction and then filter behaves like expander. +

+
+
threshold
+

If a signal rises above this level the gain reduction is released. +Default is 0.125. Allowed range is from 0 to 1. +

+
+
ratio
+

Set a ratio by which the signal is reduced. +Default is 2. Allowed range is from 1 to 9000. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction stops. +Default is 20 milliseconds. Allowed range is from 0.01 to 9000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before the +reduction is increased again. Default is 250 milliseconds. +Allowed range is from 0.01 to 9000. +

+
+
makeup
+

Set amount of amplification of signal after processing. +Default is 1. Allowed range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.828427125. Allowed range is from 1 to 8. +

+
+
detection
+

Choose if exact signal should be taken for detection or an RMS like one. +Default is rms. Can be peak or rms. +

+
+
link
+

Choose if the average level between all channels or the louder channel affects +the reduction. +Default is average. Can be average or maximum. +

+
+ + +

36.21 aiir

+ +

Apply an arbitrary Infinite Impulse Response filter. +

+

It accepts the following parameters: +

+
+
zeros, z
+

Set numerator/zeros coefficients. +

+
+
poles, p
+

Set denominator/poles coefficients. +

+
+
gains, k
+

Set channels gains. +

+
+
dry_gain
+

Set input gain. +

+
+
wet_gain
+

Set output gain. +

+
+
format, f
+

Set coefficients format. +

+
+
‘tf’
+

digital transfer function +

+
‘zp’
+

Z-plane zeros/poles, cartesian (default) +

+
‘pr’
+

Z-plane zeros/poles, polar radians +

+
‘pd’
+

Z-plane zeros/poles, polar degrees +

+
‘sp’
+

S-plane zeros/poles +

+
+ +
+
process, r
+

Set kind of processing. +Can be d - direct or s - serial cascading. Default is s. +

+
+
precision, e
+

Set filtering precision. +

+
+
‘dbl’
+

double-precision floating-point (default) +

+
‘flt’
+

single-precision floating-point +

+
‘i32’
+

32-bit integers +

+
‘i16’
+

16-bit integers +

+
+ +
+
normalize, n
+

Normalize filter coefficients, by default is enabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+
mix
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
response
+

Show IR frequency response, magnitude(magenta), phase(green) and group delay(yellow) in additional video stream. +By default it is disabled. +

+
+
channel
+

Set for which IR channel to display frequency response. By default is first channel +displayed. This option is used only when response is enabled. +

+
+
size
+

Set video stream size. This option is used only when response is enabled. +

+
+ +

Coefficients in tf format are separated by spaces and are in ascending +order. +

+

Coefficients in zp format are separated by spaces and order of coefficients +doesn’t matter. Coefficients in zp format are complex numbers with i +imaginary unit. +

+

Different coefficients and gains can be provided for every channel, in such case +use ’|’ to separate coefficients or gains. Last provided coefficients will be +used for all remaining channels. +

+ +

36.21.1 Examples

+ +
    +
  • Apply 2 pole elliptic notch at around 5000Hz for 48000 Hz sample rate: +
    +
    aiir=k=1:z=7.957584807809675810E-1 -2.575128568908332300 3.674839853930788710 -2.57512875289799137 7.957586296317130880E-1:p=1 -2.86950072432325953 3.63022088054647218 -2.28075678147272232 6.361362326477423500E-1:f=tf:r=d
+
    + +
  • Same as above but in zp format: +
    +
    aiir=k=0.79575848078096756:z=0.80918701+0.58773007i 0.80918701-0.58773007i 0.80884700+0.58784055i 0.80884700-0.58784055i:p=0.63892345+0.59951235i 0.63892345-0.59951235i 0.79582691+0.44198673i 0.79582691-0.44198673i:f=zp:r=s
+
    +
+ + +

36.22 alimiter

+ +

The limiter prevents an input signal from rising over a desired threshold. +This limiter uses lookahead technology to prevent your signal from distorting. +It means that there is a small delay after the signal is processed. Keep in mind +that the delay it produces is the attack time you set. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. Default is 1. +

+
+
level_out
+

Set output gain. Default is 1. +

+
+
limit
+

Don’t let signals above this level pass the limiter. Default is 1. +

+
+
attack
+

The limiter will reach its attenuation level in this amount of time in +milliseconds. Default is 5 milliseconds. +

+
+
release
+

Come back from limiting to attenuation 1.0 in this amount of milliseconds. +Default is 50 milliseconds. +

+
+
asc
+

When gain reduction is always needed ASC takes care of releasing to an +average reduction level rather than reaching a reduction of 0 in the release +time. +

+
+
asc_level
+

Select how much the release time is affected by ASC, 0 means nearly no changes +in release time while 1 produces higher release times. +

+
+
level
+

Auto level output signal. Default is enabled. +This normalizes audio back to 0dB if enabled. +

+
+ +

Depending on picked setting it is recommended to upsample input 2x or 4x times +with aresample before applying this filter. +

+ +

36.23 allpass

+ +

Apply a two-pole all-pass filter with central frequency (in Hz) +frequency, and filter-width width. +An all-pass filter changes the audio’s frequency to phase relationship +without changing its frequency to amplitude relationship. +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set frequency in Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+
order, o
+

Set the filter order, can be 1 or 2. Default is 2. +

+
+ + +

36.23.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change allpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change allpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change allpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change allpass mix. +Syntax for the command is : "mix" +

+
+ + +

36.24 aloop

+ +

Loop audio samples. +

+

The filter accepts the following options: +

+
+
loop
+

Set the number of loops. Setting this value to -1 will result in infinite loops. +Default is 0. +

+
+
size
+

Set maximal number of samples. Default is 0. +

+
+
start
+

Set first sample of loop. Default is 0. +

+
+ + +

36.25 amerge

+ +

Merge two or more audio streams into a single multi-channel stream. +

+

The filter accepts the following options: +

+
+
inputs
+

Set the number of inputs. Default is 2. +

+
+
+ +

If the channel layouts of the inputs are disjoint, and therefore compatible, +the channel layout of the output will be set accordingly and the channels +will be reordered as necessary. If the channel layouts of the inputs are not +disjoint, the output will have all the channels of the first input then all +the channels of the second input, in that order, and the channel layout of +the output will be the default value corresponding to the total number of +channels. +

+

For example, if the first input is in 2.1 (FL+FR+LF) and the second input +is FC+BL+BR, then the output will be in 5.1, with the channels in the +following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the +first input, b1 is the first channel of the second input). +

+

On the other hand, if both input are in stereo, the output channels will be +in the default order: a1, a2, b1, b2, and the channel layout will be +arbitrarily set to 4.0, which may or may not be the expected value. +

+

All inputs must have the same sample rate, and format. +

+

If inputs do not have the same duration, the output will stop with the +shortest. +

+ +

36.25.1 Examples

+ +
    +
  • Merge two mono files into a stereo stream: +
    +
    amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
+
    + +
  • Multiple merges assuming 1 video stream and 6 audio streams in input.mkv: +
    +
    ffmpeg -i input.mkv -filter_complex "[0:1][0:2][0:3][0:4][0:5][0:6] amerge=inputs=6" -c:a pcm_s16le output.mkv
+
    +
+ + +

36.26 amix

+ +

Mixes multiple audio inputs into a single output. +

+

Note that this filter only supports float samples (the amerge +and pan audio filters support many formats). If the amix +input has integer samples then aresample will be automatically +inserted to perform the conversion to float samples. +

+

For example +

+
ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
+
+

will mix 3 input audio streams to a single output with the same duration as the +first input and a dropout transition time of 3 seconds. +

+

It accepts the following parameters: +

+
inputs
+

The number of inputs. If unspecified, it defaults to 2. +

+
+
duration
+

How to determine the end-of-stream. +

+
longest
+

The duration of the longest input. (default) +

+
+
shortest
+

The duration of the shortest input. +

+
+
first
+

The duration of the first input. +

+
+
+ +
+
dropout_transition
+

The transition time, in seconds, for volume renormalization when an input +stream ends. The default value is 2 seconds. +

+
+
weights
+

Specify weight of each input audio stream as sequence. +Each weight is separated by space. By default all inputs have same weight. +

+
+ + +

36.26.1 Commands

+ +

This filter supports the following commands: +

+
weights
+

Syntax is same as option with same name. +

+
+ + +

36.27 amultiply

+ +

Multiply first audio stream with second audio stream and store result +in output audio stream. Multiplication is done by multiplying each +sample from first stream with sample at same position from second stream. +

+

With this element-wise multiplication one can create amplitude fades and +amplitude modulations. +

+ +

36.28 anequalizer

+ +

High-order parametric multiband equalizer for each channel. +

+

It accepts the following parameters: +

+
params
+
+

This option string is in format: +"cchn f=cf w=w g=g t=f | ..." +Each equalizer band is separated by ’|’. +

+
+
chn
+

Set channel number to which equalization will be applied. +If input doesn’t have that channel the entry is ignored. +

+
+
f
+

Set central frequency for band. +If input doesn’t have that frequency the entry is ignored. +

+
+
w
+

Set band width in hertz. +

+
+
g
+

Set band gain in dB. +

+
+
t
+

Set filter type for band, optional, can be: +

+
+
‘0’
+

Butterworth, this is default. +

+
+
‘1’
+

Chebyshev type 1. +

+
+
‘2’
+

Chebyshev type 2. +

+
+
+
+ +
+
curves
+

With this option activated frequency response of anequalizer is displayed +in video stream. +

+
+
size
+

Set video stream size. Only useful if curves option is activated. +

+
+
mgain
+

Set max gain that will be displayed. Only useful if curves option is activated. +Setting this to a reasonable value makes it possible to display gain which is derived from +neighbour bands which are too close to each other and thus produce higher gain +when both are activated. +

+
+
fscale
+

Set frequency scale used to draw frequency response in video output. +Can be linear or logarithmic. Default is logarithmic. +

+
+
colors
+

Set color for each channel curve which is going to be displayed in video stream. +This is list of color names separated by space or by ’|’. +Unrecognised or missing colors will be replaced by white color. +

+
+ + +

36.28.1 Examples

+ +
    +
  • Lower gain by 10 of central frequency 200Hz and width 100 Hz +for first 2 channels using Chebyshev type 1 filter: +
    +
    anequalizer=c0 f=200 w=100 g=-10 t=1|c1 f=200 w=100 g=-10 t=1
+
    +
+ + +

36.28.2 Commands

+ +

This filter supports the following commands: +

+
change
+

Alter existing filter parameters. +Syntax for the commands is : "fN|f=freq|w=width|g=gain" +

+

fN is existing filter number, starting from 0, if no such filter is available +error is returned. +freq set new frequency parameter. +width set new width parameter in herz. +gain set new gain parameter in dB. +

+

Full filter invocation with asendcmd may look like this: +asendcmd=c=’4.0 anequalizer change 0|f=200|w=50|g=1’,anequalizer=... +

+
+ + +

36.29 anlmdn

+ +

Reduce broadband noise in audio samples using Non-Local Means algorithm. +

+

Each sample is adjusted by looking for other samples with similar contexts. This +context similarity is defined by comparing their surrounding patches of size +p. Patches are searched in an area of r around the sample. +

+

The filter accepts the following options: +

+
+
s
+

Set denoising strength. Allowed range is from 0.00001 to 10. Default value is 0.00001. +

+
+
p
+

Set patch radius duration. Allowed range is from 1 to 100 milliseconds. +Default value is 2 milliseconds. +

+
+
r
+

Set research radius duration. Allowed range is from 2 to 300 milliseconds. +Default value is 6 milliseconds. +

+
+
o
+

Set the output mode. +

+

It accepts the following values: +

+
i
+

Pass input unchanged. +

+
+
o
+

Pass noise filtered out. +

+
+
n
+

Pass only noise. +

+

Default value is o. +

+
+ +
+
m
+

Set smooth factor. Default value is 11. Allowed range is from 1 to 15. +

+
+ + +

36.29.1 Commands

+ +

This filter supports the following commands: +

+
s
+

Change denoise strength. Argument is single float number. +Syntax for the command is : "s" +

+
+
o
+

Change output mode. +Syntax for the command is : "i", "o" or "n" string. +

+
+ + +

36.30 anlms

+

Apply Normalized Least-Mean-Squares algorithm to the first audio stream using the second audio stream. +

+

This adaptive filter is used to mimic a desired filter by finding the filter coefficients that +relate to producing the least mean square of the error signal (difference between the desired, +2nd input audio stream and the actual signal, the 1st input audio stream). +

+

A description of the accepted options follows. +

+
+
order
+

Set filter order. +

+
+
mu
+

Set filter mu. +

+
+
eps
+

Set the filter eps. +

+
+
leakage
+

Set the filter leakage. +

+
+
out_mode
+

It accepts the following values: +

+
i
+

Pass the 1st input. +

+
+
d
+

Pass the 2nd input. +

+
+
o
+

Pass filtered samples. +

+
+
n
+

Pass difference between desired and filtered samples. +

+

Default value is o. +

+
+
+
+ + +

36.30.1 Examples

+ +
    +
  • One of many usages of this filter is noise reduction, input audio is filtered +with same samples that are delayed by fixed amount, one such example for stereo audio is: +
    +
    asplit[a][b],[a]adelay=32S|32S[a],[b][a]anlms=order=128:leakage=0.0005:mu=.5:out_mode=o
+
    +
+ + +

36.30.2 Commands

+ +

This filter supports the same commands as options, excluding option order. +

+ +

36.31 anull

+ +

Pass the audio source unchanged to the output. +

+ +

36.32 apad

+ +

Pad the end of an audio stream with silence. +

+

This can be used together with ffmpeg -shortest to +extend audio streams to the same length as the video stream. +

+

A description of the accepted options follows. +

+
+
packet_size
+

Set silence packet size. Default value is 4096. +

+
+
pad_len
+

Set the number of samples of silence to add to the end. After the +value is reached, the stream is terminated. This option is mutually +exclusive with whole_len. +

+
+
whole_len
+

Set the minimum total number of samples in the output audio stream. If +the value is longer than the input audio length, silence is added to +the end, until the value is reached. This option is mutually exclusive +with pad_len. +

+
+
pad_dur
+

Specify the duration of samples of silence to add. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. Used only if set to non-zero value. +

+
+
whole_dur
+

Specify the minimum total duration in the output audio stream. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. Used only if set to non-zero value. If the value is longer than +the input audio length, silence is added to the end, until the value is reached. +This option is mutually exclusive with pad_dur +

+
+ +

If neither the pad_len nor the whole_len nor pad_dur +nor whole_dur option is set, the filter will add silence to the end of +the input stream indefinitely. +

+ +

36.32.1 Examples

+ +
    +
  • Add 1024 samples of silence to the end of the input: +
    +
    apad=pad_len=1024
+
    + +
  • Make sure the audio output will contain at least 10000 samples, pad +the input with silence if required: +
    +
    apad=whole_len=10000
+
    + +
  • Use ffmpeg to pad the audio input with silence, so that the +video stream will always result the shortest and will be converted +until the end in the output file when using the shortest +option: +
    +
    ffmpeg -i VIDEO -i AUDIO -filter_complex "[1:0]apad" -shortest OUTPUT
+
    +
+ + +

36.33 aphaser

+

Add a phasing effect to the input audio. +

+

A phaser filter creates series of peaks and troughs in the frequency spectrum. +The position of the peaks and troughs are modulated so that they vary over time, creating a sweeping effect. +

+

A description of the accepted parameters follows. +

+
+
in_gain
+

Set input gain. Default is 0.4. +

+
+
out_gain
+

Set output gain. Default is 0.74 +

+
+
delay
+

Set delay in milliseconds. Default is 3.0. +

+
+
decay
+

Set decay. Default is 0.4. +

+
+
speed
+

Set modulation speed in Hz. Default is 0.5. +

+
+
type
+

Set modulation type. Default is triangular. +

+

It accepts the following values: +

+
‘triangular, t’
+
‘sinusoidal, s’
+
+
+
+ + +

36.34 apulsator

+ +

Audio pulsator is something between an autopanner and a tremolo. +But it can produce funny stereo effects as well. Pulsator changes the volume +of the left and right channel based on a LFO (low frequency oscillator) with +different waveforms and shifted phases. +This filter have the ability to define an offset between left and right +channel. An offset of 0 means that both LFO shapes match each other. +The left and right channel are altered equally - a conventional tremolo. +An offset of 50% means that the shape of the right channel is exactly shifted +in phase (or moved backwards about half of the frequency) - pulsator acts as +an autopanner. At 1 both curves match again. Every setting in between moves the +phase shift gapless between all stages and produces some "bypassing" sounds with +sine and triangle waveforms. The more you set the offset near 1 (starting from +the 0.5) the faster the signal passes from the left to the right speaker. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. By default it is 1. Range is [0.015625 - 64]. +

+
+
level_out
+

Set output gain. By default it is 1. Range is [0.015625 - 64]. +

+
+
mode
+

Set waveform shape the LFO will use. Can be one of: sine, triangle, square, +sawup or sawdown. Default is sine. +

+
+
amount
+

Set modulation. Define how much of original signal is affected by the LFO. +

+
+
offset_l
+

Set left channel offset. Default is 0. Allowed range is [0 - 1]. +

+
+
offset_r
+

Set right channel offset. Default is 0.5. Allowed range is [0 - 1]. +

+
+
width
+

Set pulse width. Default is 1. Allowed range is [0 - 2]. +

+
+
timing
+

Set possible timing mode. Can be one of: bpm, ms or hz. Default is hz. +

+
+
bpm
+

Set bpm. Default is 120. Allowed range is [30 - 300]. Only used if timing +is set to bpm. +

+
+
ms
+

Set ms. Default is 500. Allowed range is [10 - 2000]. Only used if timing +is set to ms. +

+
+
hz
+

Set frequency in Hz. Default is 2. Allowed range is [0.01 - 100]. Only used +if timing is set to hz. +

+
+ + +

36.35 aresample

+ +

Resample the input audio to the specified parameters, using the +libswresample library. If none are specified then the filter will +automatically convert between its input and output. +

+

This filter is also able to stretch/squeeze the audio data to make it match +the timestamps or to inject silence / cut out audio to make it match the +timestamps, do a combination of both or do neither. +

+

The filter accepts the syntax +[sample_rate:]resampler_options, where sample_rate +expresses a sample rate and resampler_options is a list of +key=value pairs, separated by ":". See the +(ffmpeg-resampler)"Resampler Options" section in the +ffmpeg-resampler(1) manual +for the complete list of supported options. +

+ +

36.35.1 Examples

+ +
    +
  • Resample the input audio to 44100Hz: +
    +
    aresample=44100
+
    + +
  • Stretch/squeeze samples to the given timestamps, with a maximum of 1000 +samples per second compensation: +
    +
    aresample=async=1000
+
    +
+ + +

36.36 areverse

+ +

Reverse an audio clip. +

+

Warning: This filter requires memory to buffer the entire clip, so trimming +is suggested. +

+ +

36.36.1 Examples

+ +
    +
  • Take the first 5 seconds of a clip, and reverse it. +
    +
    atrim=end=5,areverse
+
    +
+ + +

36.37 arnndn

+ +

Reduce noise from speech using Recurrent Neural Networks. +

+

This filter accepts the following options: +

+
+
model, m
+

Set train model file to load. This option is always required. +

+
+ + +

36.38 asetnsamples

+ +

Set the number of samples per each output audio frame. +

+

The last output packet may contain a different number of samples, as +the filter will flush all the remaining samples when the input audio +signals its end. +

+

The filter accepts the following options: +

+
+
nb_out_samples, n
+

Set the number of frames per each output audio frame. The number is +intended as the number of samples per each channel. +Default value is 1024. +

+
+
pad, p
+

If set to 1, the filter will pad the last audio frame with zeroes, so +that the last frame will contain the same number of samples as the +previous ones. Default value is 1. +

+
+ +

For example, to set the number of per-frame samples to 1234 and +disable padding for the last frame, use: +

+
asetnsamples=n=1234:p=0
+
+ + +

36.39 asetrate

+ +

Set the sample rate without altering the PCM data. +This will result in a change of speed and pitch. +

+

The filter accepts the following options: +

+
+
sample_rate, r
+

Set the output sample rate. Default is 44100 Hz. +

+
+ + +

36.40 ashowinfo

+ +

Show a line containing various information for each input audio frame. +The input audio is not modified. +

+

The shown line contains a sequence of key/value pairs of the form +key:value. +

+

The following values are shown in the output: +

+
+
n
+

The (sequential) number of the input frame, starting from 0. +

+
+
pts
+

The presentation timestamp of the input frame, in time base units; the time base +depends on the filter input pad, and is usually 1/sample_rate. +

+
+
pts_time
+

The presentation timestamp of the input frame in seconds. +

+
+
pos
+

position of the frame in the input stream, -1 if this information in +unavailable and/or meaningless (for example in case of synthetic audio) +

+
+
fmt
+

The sample format. +

+
+
chlayout
+

The channel layout. +

+
+
rate
+

The sample rate for the audio frame. +

+
+
nb_samples
+

The number of samples (per channel) in the frame. +

+
+
checksum
+

The Adler-32 checksum (printed in hexadecimal) of the audio data. For planar +audio, the data is treated as if all the planes were concatenated. +

+
+
plane_checksums
+

A list of Adler-32 checksums for each data plane. +

+
+ + +

36.41 asoftclip

+

Apply audio soft clipping. +

+

Soft clipping is a type of distortion effect where the amplitude of a signal is saturated +along a smooth curve, rather than the abrupt shape of hard-clipping. +

+

This filter accepts the following options: +

+
+
type
+

Set type of soft-clipping. +

+

It accepts the following values: +

+
tanh
+
atan
+
cubic
+
exp
+
alg
+
quintic
+
sin
+
+ +
+
param
+

Set additional parameter which controls sigmoid function. +

+
+ + +

36.41.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

36.42 asr

+

Automatic Speech Recognition +

+

This filter uses PocketSphinx for speech recognition. To enable +compilation of this filter, you need to configure FFmpeg with +--enable-pocketsphinx. +

+

It accepts the following options: +

+
+
rate
+

Set sampling rate of input audio. Defaults is 16000. +This need to match speech models, otherwise one will get poor results. +

+
+
hmm
+

Set dictionary containing acoustic model files. +

+
+
dict
+

Set pronunciation dictionary. +

+
+
lm
+

Set language model file. +

+
+
lmctl
+

Set language model set. +

+
+
lmname
+

Set which language model to use. +

+
+
logfn
+

Set output for log messages. +

+
+ +

The filter exports recognized speech as the frame metadata lavfi.asr.text. +

+ +

36.43 astats

+ +

Display time domain statistical information about the audio channels. +Statistics are calculated and displayed for each audio channel and, +where applicable, an overall figure is also given. +

+

It accepts the following option: +

+
length
+

Short window length in seconds, used for peak and trough RMS measurement. +Default is 0.05 (50 milliseconds). Allowed range is [0.01 - 10]. +

+
+
metadata
+
+

Set metadata injection. All the metadata keys are prefixed with lavfi.astats.X, +where X is channel number starting from 1 or string Overall. Default is +disabled. +

+

Available keys for each channel are: +DC_offset +Min_level +Max_level +Min_difference +Max_difference +Mean_difference +RMS_difference +Peak_level +RMS_peak +RMS_trough +Crest_factor +Flat_factor +Peak_count +Noise_floor +Noise_floor_count +Bit_depth +Dynamic_range +Zero_crossings +Zero_crossings_rate +Number_of_NaNs +Number_of_Infs +Number_of_denormals +

+

and for Overall: +DC_offset +Min_level +Max_level +Min_difference +Max_difference +Mean_difference +RMS_difference +Peak_level +RMS_level +RMS_peak +RMS_trough +Flat_factor +Peak_count +Noise_floor +Noise_floor_count +Bit_depth +Number_of_samples +Number_of_NaNs +Number_of_Infs +Number_of_denormals +

+

For example full key look like this lavfi.astats.1.DC_offset or +this lavfi.astats.Overall.Peak_count. +

+

For description what each key means read below. +

+
+
reset
+

Set number of frame after which stats are going to be recalculated. +Default is disabled. +

+
+
measure_perchannel
+

Select the entries which need to be measured per channel. The metadata keys can +be used as flags, default is all which measures everything. +none disables all per channel measurement. +

+
+
measure_overall
+

Select the entries which need to be measured overall. The metadata keys can +be used as flags, default is all which measures everything. +none disables all overall measurement. +

+
+
+ +

A description of each shown parameter follows: +

+
+
DC offset
+

Mean amplitude displacement from zero. +

+
+
Min level
+

Minimal sample level. +

+
+
Max level
+

Maximal sample level. +

+
+
Min difference
+

Minimal difference between two consecutive samples. +

+
+
Max difference
+

Maximal difference between two consecutive samples. +

+
+
Mean difference
+

Mean difference between two consecutive samples. +The average of each difference between two consecutive samples. +

+
+
RMS difference
+

Root Mean Square difference between two consecutive samples. +

+
+
Peak level dB
+
RMS level dB
+

Standard peak and RMS level measured in dBFS. +

+
+
RMS peak dB
+
RMS trough dB
+

Peak and trough values for RMS level measured over a short window. +

+
+
Crest factor
+

Standard ratio of peak to RMS level (note: not in dB). +

+
+
Flat factor
+

Flatness (i.e. consecutive samples with the same value) of the signal at its peak levels +(i.e. either Min level or Max level). +

+
+
Peak count
+

Number of occasions (not the number of samples) that the signal attained either +Min level or Max level. +

+
+
Noise floor dB
+

Minimum local peak measured in dBFS over a short window. +

+
+
Noise floor count
+

Number of occasions (not the number of samples) that the signal attained +Noise floor. +

+
+
Bit depth
+

Overall bit depth of audio. Number of bits used for each sample. +

+
+
Dynamic range
+

Measured dynamic range of audio in dB. +

+
+
Zero crossings
+

Number of points where the waveform crosses the zero level axis. +

+
+
Zero crossings rate
+

Rate of Zero crossings and number of audio samples. +

+
+ + +

36.44 asubboost

+

Boost subwoofer frequencies. +

+

The filter accepts the following options: +

+
+
dry
+

Set dry gain, how much of original signal is kept. Allowed range is from 0 to 1. +Default value is 0.5. +

+
+
wet
+

Set wet gain, how much of filtered signal is kept. Allowed range is from 0 to 1. +Default value is 0.8. +

+
+
decay
+

Set delay line decay gain value. Allowed range is from 0 to 1. +Default value is 0.7. +

+
+
feedback
+

Set delay line feedback gain value. Allowed range is from 0 to 1. +Default value is 0.5. +

+
+
cutoff
+

Set cutoff frequency in herz. Allowed range is 50 to 900. +Default value is 100. +

+
+
slope
+

Set slope amount for cutoff frequency. Allowed range is 0.0001 to 1. +Default value is 0.5. +

+
+
delay
+

Set delay. Allowed range is from 1 to 100. +Default value is 20. +

+
+ + +

36.44.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

36.45 atempo

+ +

Adjust audio tempo. +

+

The filter accepts exactly one parameter, the audio tempo. If not +specified then the filter will assume nominal 1.0 tempo. Tempo must +be in the [0.5, 100.0] range. +

+

Note that tempo greater than 2 will skip some samples rather than +blend them in. If for any reason this is a concern it is always +possible to daisy-chain several instances of atempo to achieve the +desired product tempo. +

+ +

36.45.1 Examples

+ +
    +
  • Slow down audio to 80% tempo: +
    +
    atempo=0.8
+
    + +
  • To speed up audio to 300% tempo: +
    +
    atempo=3
+
    + +
  • To speed up audio to 300% tempo by daisy-chaining two atempo instances: +
    +
    atempo=sqrt(3),atempo=sqrt(3)
+
    +
+ + +

36.45.2 Commands

+ +

This filter supports the following commands: +

+
tempo
+

Change filter tempo scale factor. +Syntax for the command is : "tempo" +

+
+ + +

36.46 atrim

+ +

Trim the input so that the output contains one continuous subpart of the input. +

+

It accepts the following parameters: +

+
start
+

Timestamp (in seconds) of the start of the section to keep. I.e. the audio +sample with the timestamp start will be the first sample in the output. +

+
+
end
+

Specify time of the first audio sample that will be dropped, i.e. the +audio sample immediately preceding the one with the timestamp end will be +the last sample in the output. +

+
+
start_pts
+

Same as start, except this option sets the start timestamp in samples +instead of seconds. +

+
+
end_pts
+

Same as end, except this option sets the end timestamp in samples instead +of seconds. +

+
+
duration
+

The maximum duration of the output in seconds. +

+
+
start_sample
+

The number of the first sample that should be output. +

+
+
end_sample
+

The number of the first sample that should be dropped. +

+
+ +

start, end, and duration are expressed as time +duration specifications; see +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+

Note that the first two sets of the start/end options and the duration +option look at the frame timestamp, while the _sample options simply count the +samples that pass through the filter. So start/end_pts and start/end_sample will +give different results when the timestamps are wrong, inexact or do not start at +zero. Also note that this filter does not modify the timestamps. If you wish +to have the output timestamps start at zero, insert the asetpts filter after the +atrim filter. +

+

If multiple start or end options are set, this filter tries to be greedy and +keep all samples that match at least one of the specified constraints. To keep +only the part that matches all the constraints at once, chain multiple atrim +filters. +

+

The defaults are such that all the input is kept. So it is possible to set e.g. +just the end values to keep everything before the specified time. +

+

Examples: +

    +
  • Drop everything except the second minute of input: +
    +
    ffmpeg -i INPUT -af atrim=60:120
+
    + +
  • Keep only the first 1000 samples: +
    +
    ffmpeg -i INPUT -af atrim=end_sample=1000
+
    + +
+ + +

36.47 axcorrelate

+

Calculate normalized cross-correlation between two input audio streams. +

+

Resulted samples are always between -1 and 1 inclusive. +If result is 1 it means two input samples are highly correlated in that selected segment. +Result 0 means they are not correlated at all. +If result is -1 it means two input samples are out of phase, which means they cancel each +other. +

+

The filter accepts the following options: +

+
+
size
+

Set size of segment over which cross-correlation is calculated. +Default is 256. Allowed range is from 2 to 131072. +

+
+
algo
+

Set algorithm for cross-correlation. Can be slow or fast. +Default is slow. Fast algorithm assumes mean values over any given segment +are always zero and thus need much less calculations to make. +This is generally not true, but is valid for typical audio streams. +

+
+ + +

36.47.1 Examples

+ +
    +
  • Calculate correlation between channels in stereo audio stream: +
    +
    ffmpeg -i stereo.wav -af channelsplit,axcorrelate=size=1024:algo=fast correlation.wav
+
    +
+ + +

36.48 bandpass

+ +

Apply a two-pole Butterworth band-pass filter with central +frequency frequency, and (3dB-point) band-width width. +The csg option selects a constant skirt gain (peak gain = Q) +instead of the default: constant 0dB peak gain. +The filter roll off at 6dB per octave (20dB per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the filter’s central frequency. Default is 3000. +

+
+
csg
+

Constant skirt gain if set to 1. Defaults to 0. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

36.48.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change bandpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change bandpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change bandpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change bandpass mix. +Syntax for the command is : "mix" +

+
+ + +

36.49 bandreject

+ +

Apply a two-pole Butterworth band-reject filter with central +frequency frequency, and (3dB-point) band-width width. +The filter roll off at 6dB per octave (20dB per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the filter’s central frequency. Default is 3000. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

36.49.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change bandreject frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change bandreject width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change bandreject width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change bandreject mix. +Syntax for the command is : "mix" +

+
+ + +

36.50 bass, lowshelf

+ +

Boost or cut the bass (lower) frequencies of the audio using a two-pole +shelving filter with a response similar to that of a standard +hi-fi’s tone-controls. This is also known as shelving equalisation (EQ). +

+

The filter accepts the following options: +

+
+
gain, g
+

Give the gain at 0 Hz. Its useful range is about -20 +(for a large cut) to +20 (for a large boost). +Beware of clipping when using a positive gain. +

+
+
frequency, f
+

Set the filter’s central frequency and so can be used +to extend or reduce the frequency range to be boosted or cut. +The default value is 100 Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Determine how steep is the filter’s shelf transition. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

36.50.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change bass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change bass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change bass width. +Syntax for the command is : "width" +

+
+
gain, g
+

Change bass gain. +Syntax for the command is : "gain" +

+
+
mix, m
+

Change bass mix. +Syntax for the command is : "mix" +

+
+ + +

36.51 biquad

+ +

Apply a biquad IIR filter with the given coefficients. +Where b0, b1, b2 and a0, a1, a2 +are the numerator and denominator coefficients respectively. +and channels, c specify which channels to filter, by default all +available are filtered. +

+ +

36.51.1 Commands

+ +

This filter supports the following commands: +

+
a0
+
a1
+
a2
+
b0
+
b1
+
b2
+

Change biquad parameter. +Syntax for the command is : "value" +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

36.52 bs2b

+

Bauer stereo to binaural transformation, which improves headphone listening of +stereo audio records. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libbs2b. +

+

It accepts the following parameters: +

+
profile
+

Pre-defined crossfeed level. +

+
default
+

Default level (fcut=700, feed=50). +

+
+
cmoy
+

Chu Moy circuit (fcut=700, feed=60). +

+
+
jmeier
+

Jan Meier circuit (fcut=650, feed=95). +

+
+
+ +
+
fcut
+

Cut frequency (in Hz). +

+
+
feed
+

Feed level (in Hz). +

+
+
+ + +

36.53 channelmap

+ +

Remap input channels to new locations. +

+

It accepts the following parameters: +

+
map
+

Map channels from input to output. The argument is a ’|’-separated list of +mappings, each in the in_channel-out_channel or +in_channel form. in_channel can be either the name of the input +channel (e.g. FL for front left) or its index in the input channel layout. +out_channel is the name of the output channel or its index in the output +channel layout. If out_channel is not given then it is implicitly an +index, starting with zero and increasing by one for each mapping. +

+
+
channel_layout
+

The channel layout of the output stream. +

+
+ +

If no mapping is present, the filter will implicitly map input channels to +output channels, preserving indices. +

+ +

36.53.1 Examples

+ +
    +
  • For example, assuming a 5.1+downmix input MOV file, +
    +
    ffmpeg -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
+
    +

    will create an output WAV file tagged as stereo from the downmix channels of +the input. +

    +
  • To fix a 5.1 WAV improperly encoded in AAC’s native channel order +
    +
    ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:5.1' out.wav
+
    +
+ + +

36.54 channelsplit

+ +

Split each channel from an input audio stream into a separate output stream. +

+

It accepts the following parameters: +

+
channel_layout
+

The channel layout of the input stream. The default is "stereo". +

+
channels
+

A channel layout describing the channels to be extracted as separate output streams +or "all" to extract each input channel as a separate stream. The default is "all". +

+

Choosing channels not present in channel layout in the input will result in an error. +

+
+ + +

36.54.1 Examples

+ +
    +
  • For example, assuming a stereo input MP3 file, +
    +
    ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
+
    +

    will create an output Matroska file with two audio streams, one containing only +the left channel and the other the right channel. +

    +
  • Split a 5.1 WAV file into per-channel files: +
    +
    ffmpeg -i in.wav -filter_complex
+'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
+-map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
+front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
+side_right.wav
+
    + +
  • Extract only LFE from a 5.1 WAV file: +
    +
    ffmpeg -i in.wav -filter_complex 'channelsplit=channel_layout=5.1:channels=LFE[LFE]'
+-map '[LFE]' lfe.wav
+
    +
+ + +

36.55 chorus

+

Add a chorus effect to the audio. +

+

Can make a single vocal sound like a chorus, but can also be applied to instrumentation. +

+

Chorus resembles an echo effect with a short delay, but whereas with echo the delay is +constant, with chorus, it is varied using using sinusoidal or triangular modulation. +The modulation depth defines the range the modulated delay is played before or after +the delay. Hence the delayed sound will sound slower or faster, that is the delayed +sound tuned around the original one, like in a chorus where some vocals are slightly +off key. +

+

It accepts the following parameters: +

+
in_gain
+

Set input gain. Default is 0.4. +

+
+
out_gain
+

Set output gain. Default is 0.4. +

+
+
delays
+

Set delays. A typical delay is around 40ms to 60ms. +

+
+
decays
+

Set decays. +

+
+
speeds
+

Set speeds. +

+
+
depths
+

Set depths. +

+
+ + +

36.55.1 Examples

+ +
    +
  • A single delay: +
    +
    chorus=0.7:0.9:55:0.4:0.25:2
+
    + +
  • Two delays: +
    +
    chorus=0.6:0.9:50|60:0.4|0.32:0.25|0.4:2|1.3
+
    + +
  • Fuller sounding chorus with three delays: +
    +
    chorus=0.5:0.9:50|60|40:0.4|0.32|0.3:0.25|0.4|0.3:2|2.3|1.3
+
    +
+ + +

36.56 compand

+

Compress or expand the audio’s dynamic range. +

+

It accepts the following parameters: +

+
+
attacks
+
decays
+

A list of times in seconds for each channel over which the instantaneous level +of the input signal is averaged to determine its volume. attacks refers to +increase of volume and decays refers to decrease of volume. For most +situations, the attack time (response to the audio getting louder) should be +shorter than the decay time, because the human ear is more sensitive to sudden +loud audio than sudden soft audio. A typical value for attack is 0.3 seconds and +a typical value for decay is 0.8 seconds. +If specified number of attacks & decays is lower than number of channels, the last +set attack/decay will be used for all remaining channels. +

+
+
points
+

A list of points for the transfer function, specified in dB relative to the +maximum possible signal amplitude. Each key points list must be defined using +the following syntax: x0/y0|x1/y1|x2/y2|.... or +x0/y0 x1/y1 x2/y2 .... +

+

The input values must be in strictly increasing order but the transfer function +does not have to be monotonically rising. The point 0/0 is assumed but +may be overridden (by 0/out-dBn). Typical values for the transfer +function are -70/-70|-60/-20|1/0. +

+
+
soft-knee
+

Set the curve radius in dB for all joints. It defaults to 0.01. +

+
+
gain
+

Set the additional gain in dB to be applied at all points on the transfer +function. This allows for easy adjustment of the overall gain. +It defaults to 0. +

+
+
volume
+

Set an initial volume, in dB, to be assumed for each channel when filtering +starts. This permits the user to supply a nominal level initially, so that, for +example, a very large gain is not applied to initial signal levels before the +companding has begun to operate. A typical value for audio which is initially +quiet is -90 dB. It defaults to 0. +

+
+
delay
+

Set a delay, in seconds. The input audio is analyzed immediately, but audio is +delayed before being fed to the volume adjuster. Specifying a delay +approximately equal to the attack/decay times allows the filter to effectively +operate in predictive rather than reactive mode. It defaults to 0. +

+
+
+ + +

36.56.1 Examples

+ +
    +
  • Make music with both quiet and loud passages suitable for listening to in a +noisy environment: +
    +
    compand=.3|.3:1|1:-90/-60|-60/-40|-40/-30|-20/-20:6:0:-90:0.2
+
    + +

    Another example for audio with whisper and explosion parts: +

    +
    compand=0|0:1|1:-90/-900|-70/-70|-30/-9|0/-3:6:0:0:0
+
    + +
  • A noise gate for when the noise is at a lower level than the signal: +
    +
    compand=.1|.1:.2|.2:-900/-900|-50.1/-900|-50/-50:.01:0:-90:.1
+
    + +
  • Here is another noise gate, this time for when the noise is at a higher level +than the signal (making it, in some ways, similar to squelch): +
    +
    compand=.1|.1:.1|.1:-45.1/-45.1|-45/-900|0/-900:.01:45:-90:.1
+
    + +
  • 2:1 compression starting at -6dB: +
    +
    compand=points=-80/-80|-6/-6|0/-3.8|20/3.5
+
    + +
  • 2:1 compression starting at -9dB: +
    +
    compand=points=-80/-80|-9/-9|0/-5.3|20/2.9
+
    + +
  • 2:1 compression starting at -12dB: +
    +
    compand=points=-80/-80|-12/-12|0/-6.8|20/1.9
+
    + +
  • 2:1 compression starting at -18dB: +
    +
    compand=points=-80/-80|-18/-18|0/-9.8|20/0.7
+
    + +
  • 3:1 compression starting at -15dB: +
    +
    compand=points=-80/-80|-15/-15|0/-10.8|20/-5.2
+
    + +
  • Compressor/Gate: +
    +
    compand=points=-80/-105|-62/-80|-15.4/-15.4|0/-12|20/-7.6
+
    + +
  • Expander: +
    +
    compand=attacks=0:points=-80/-169|-54/-80|-49.5/-64.6|-41.1/-41.1|-25.8/-15|-10.8/-4.5|0/0|20/8.3
+
    + +
  • Hard limiter at -6dB: +
    +
    compand=attacks=0:points=-80/-80|-6/-6|20/-6
+
    + +
  • Hard limiter at -12dB: +
    +
    compand=attacks=0:points=-80/-80|-12/-12|20/-12
+
    + +
  • Hard noise gate at -35 dB: +
    +
    compand=attacks=0:points=-80/-115|-35.1/-80|-35/-35|20/20
+
    + +
  • Soft limiter: +
    +
    compand=attacks=0:points=-80/-80|-12.4/-12.4|-6/-8|0/-6.8|20/-2.8
+
    +
+ + +

36.57 compensationdelay

+ +

Compensation Delay Line is a metric based delay to compensate differing +positions of microphones or speakers. +

+

For example, you have recorded guitar with two microphones placed in +different locations. Because the front of sound wave has fixed speed in +normal conditions, the phasing of microphones can vary and depends on +their location and interposition. The best sound mix can be achieved when +these microphones are in phase (synchronized). Note that a distance of +~30 cm between microphones makes one microphone capture the signal in +antiphase to the other microphone. That makes the final mix sound moody. +This filter helps to solve phasing problems by adding different delays +to each microphone track and make them synchronized. +

+

The best result can be reached when you take one track as base and +synchronize other tracks one by one with it. +Remember that synchronization/delay tolerance depends on sample rate, too. +Higher sample rates will give more tolerance. +

+

The filter accepts the following parameters: +

+
+
mm
+

Set millimeters distance. This is compensation distance for fine tuning. +Default is 0. +

+
+
cm
+

Set cm distance. This is compensation distance for tightening distance setup. +Default is 0. +

+
+
m
+

Set meters distance. This is compensation distance for hard distance setup. +Default is 0. +

+
+
dry
+

Set dry amount. Amount of unprocessed (dry) signal. +Default is 0. +

+
+
wet
+

Set wet amount. Amount of processed (wet) signal. +Default is 1. +

+
+
temp
+

Set temperature in degrees Celsius. This is the temperature of the environment. +Default is 20. +

+
+ + +

36.58 crossfeed

+

Apply headphone crossfeed filter. +

+

Crossfeed is the process of blending the left and right channels of stereo +audio recording. +It is mainly used to reduce extreme stereo separation of low frequencies. +

+

The intent is to produce more speaker like sound to the listener. +

+

The filter accepts the following options: +

+
+
strength
+

Set strength of crossfeed. Default is 0.2. Allowed range is from 0 to 1. +This sets gain of low shelf filter for side part of stereo image. +Default is -6dB. Max allowed is -30db when strength is set to 1. +

+
+
range
+

Set soundstage wideness. Default is 0.5. Allowed range is from 0 to 1. +This sets cut off frequency of low shelf filter. Default is cut off near +1550 Hz. With range set to 1 cut off frequency is set to 2100 Hz. +

+
+
slope
+

Set curve slope of low shelf filter. Default is 0.5. +Allowed range is from 0.01 to 1. +

+
+
level_in
+

Set input gain. Default is 0.9. +

+
+
level_out
+

Set output gain. Default is 1. +

+
+ + +

36.58.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

36.59 crystalizer

+

Simple algorithm to expand audio dynamic range. +

+

The filter accepts the following options: +

+
+
i
+

Sets the intensity of effect (default: 2.0). Must be in range between 0.0 +(unchanged sound) to 10.0 (maximum effect). +

+
+
c
+

Enable clipping. By default is enabled. +

+
+ + +

36.59.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

36.60 dcshift

+

Apply a DC shift to the audio. +

+

This can be useful to remove a DC offset (caused perhaps by a hardware problem +in the recording chain) from the audio. The effect of a DC offset is reduced +headroom and hence volume. The astats filter can be used to determine if +a signal has a DC offset. +

+
+
shift
+

Set the DC shift, allowed range is [-1, 1]. It indicates the amount to shift +the audio. +

+
+
limitergain
+

Optional. It should have a value much less than 1 (e.g. 0.05 or 0.02) and is +used to prevent clipping. +

+
+ + +

36.61 deesser

+ +

Apply de-essing to the audio samples. +

+
+
i
+

Set intensity for triggering de-essing. Allowed range is from 0 to 1. +Default is 0. +

+
+
m
+

Set amount of ducking on treble part of sound. Allowed range is from 0 to 1. +Default is 0.5. +

+
+
f
+

How much of original frequency content to keep when de-essing. Allowed range is from 0 to 1. +Default is 0.5. +

+
+
s
+

Set the output mode. +

+

It accepts the following values: +

+
i
+

Pass input unchanged. +

+
+
o
+

Pass ess filtered out. +

+
+
e
+

Pass only ess. +

+

Default value is o. +

+
+ +
+
+ + +

36.62 drmeter

+

Measure audio dynamic range. +

+

DR values of 14 and higher is found in very dynamic material. DR of 8 to 13 +is found in transition material. And anything less that 8 have very poor dynamics +and is very compressed. +

+

The filter accepts the following options: +

+
+
length
+

Set window length in seconds used to split audio into segments of equal length. +Default is 3 seconds. +

+
+ + +

36.63 dynaudnorm

+

Dynamic Audio Normalizer. +

+

This filter applies a certain amount of gain to the input audio in order +to bring its peak magnitude to a target level (e.g. 0 dBFS). However, in +contrast to more "simple" normalization algorithms, the Dynamic Audio +Normalizer *dynamically* re-adjusts the gain factor to the input audio. +This allows for applying extra gain to the "quiet" sections of the audio +while avoiding distortions or clipping the "loud" sections. In other words: +The Dynamic Audio Normalizer will "even out" the volume of quiet and loud +sections, in the sense that the volume of each section is brought to the +same target level. Note, however, that the Dynamic Audio Normalizer achieves +this goal *without* applying "dynamic range compressing". It will retain 100% +of the dynamic range *within* each section of the audio file. +

+
+
framelen, f
+

Set the frame length in milliseconds. In range from 10 to 8000 milliseconds. +Default is 500 milliseconds. +The Dynamic Audio Normalizer processes the input audio in small chunks, +referred to as frames. This is required, because a peak magnitude has no +meaning for just a single sample value. Instead, we need to determine the +peak magnitude for a contiguous sequence of sample values. While a "standard" +normalizer would simply use the peak magnitude of the complete file, the +Dynamic Audio Normalizer determines the peak magnitude individually for each +frame. The length of a frame is specified in milliseconds. By default, the +Dynamic Audio Normalizer uses a frame length of 500 milliseconds, which has +been found to give good results with most files. +Note that the exact frame length, in number of samples, will be determined +automatically, based on the sampling rate of the individual input audio file. +

+
+
gausssize, g
+

Set the Gaussian filter window size. In range from 3 to 301, must be odd +number. Default is 31. +Probably the most important parameter of the Dynamic Audio Normalizer is the +window size of the Gaussian smoothing filter. The filter’s window size +is specified in frames, centered around the current frame. For the sake of +simplicity, this must be an odd number. Consequently, the default value of 31 +takes into account the current frame, as well as the 15 preceding frames and +the 15 subsequent frames. Using a larger window results in a stronger +smoothing effect and thus in less gain variation, i.e. slower gain +adaptation. Conversely, using a smaller window results in a weaker smoothing +effect and thus in more gain variation, i.e. faster gain adaptation. +In other words, the more you increase this value, the more the Dynamic Audio +Normalizer will behave like a "traditional" normalization filter. On the +contrary, the more you decrease this value, the more the Dynamic Audio +Normalizer will behave like a dynamic range compressor. +

+
+
peak, p
+

Set the target peak value. This specifies the highest permissible magnitude +level for the normalized audio input. This filter will try to approach the +target peak magnitude as closely as possible, but at the same time it also +makes sure that the normalized signal will never exceed the peak magnitude. +A frame’s maximum local gain factor is imposed directly by the target peak +magnitude. The default value is 0.95 and thus leaves a headroom of 5%*. +It is not recommended to go above this value. +

+
+
maxgain, m
+

Set the maximum gain factor. In range from 1.0 to 100.0. Default is 10.0. +The Dynamic Audio Normalizer determines the maximum possible (local) gain +factor for each input frame, i.e. the maximum gain factor that does not +result in clipping or distortion. The maximum gain factor is determined by +the frame’s highest magnitude sample. However, the Dynamic Audio Normalizer +additionally bounds the frame’s maximum gain factor by a predetermined +(global) maximum gain factor. This is done in order to avoid excessive gain +factors in "silent" or almost silent frames. By default, the maximum gain +factor is 10.0, For most inputs the default value should be sufficient and +it usually is not recommended to increase this value. Though, for input +with an extremely low overall volume level, it may be necessary to allow even +higher gain factors. Note, however, that the Dynamic Audio Normalizer does +not simply apply a "hard" threshold (i.e. cut off values above the threshold). +Instead, a "sigmoid" threshold function will be applied. This way, the +gain factors will smoothly approach the threshold value, but never exceed that +value. +

+
+
targetrms, r
+

Set the target RMS. In range from 0.0 to 1.0. Default is 0.0 - disabled. +By default, the Dynamic Audio Normalizer performs "peak" normalization. +This means that the maximum local gain factor for each frame is defined +(only) by the frame’s highest magnitude sample. This way, the samples can +be amplified as much as possible without exceeding the maximum signal +level, i.e. without clipping. Optionally, however, the Dynamic Audio +Normalizer can also take into account the frame’s root mean square, +abbreviated RMS. In electrical engineering, the RMS is commonly used to +determine the power of a time-varying signal. It is therefore considered +that the RMS is a better approximation of the "perceived loudness" than +just looking at the signal’s peak magnitude. Consequently, by adjusting all +frames to a constant RMS value, a uniform "perceived loudness" can be +established. If a target RMS value has been specified, a frame’s local gain +factor is defined as the factor that would result in exactly that RMS value. +Note, however, that the maximum local gain factor is still restricted by the +frame’s highest magnitude sample, in order to prevent clipping. +

+
+
coupling, n
+

Enable channels coupling. By default is enabled. +By default, the Dynamic Audio Normalizer will amplify all channels by the same +amount. This means the same gain factor will be applied to all channels, i.e. +the maximum possible gain factor is determined by the "loudest" channel. +However, in some recordings, it may happen that the volume of the different +channels is uneven, e.g. one channel may be "quieter" than the other one(s). +In this case, this option can be used to disable the channel coupling. This way, +the gain factor will be determined independently for each channel, depending +only on the individual channel’s highest magnitude sample. This allows for +harmonizing the volume of the different channels. +

+
+
correctdc, c
+

Enable DC bias correction. By default is disabled. +An audio signal (in the time domain) is a sequence of sample values. +In the Dynamic Audio Normalizer these sample values are represented in the +-1.0 to 1.0 range, regardless of the original input format. Normally, the +audio signal, or "waveform", should be centered around the zero point. +That means if we calculate the mean value of all samples in a file, or in a +single frame, then the result should be 0.0 or at least very close to that +value. If, however, there is a significant deviation of the mean value from +0.0, in either positive or negative direction, this is referred to as a +DC bias or DC offset. Since a DC bias is clearly undesirable, the Dynamic +Audio Normalizer provides optional DC bias correction. +With DC bias correction enabled, the Dynamic Audio Normalizer will determine +the mean value, or "DC correction" offset, of each input frame and subtract +that value from all of the frame’s sample values which ensures those samples +are centered around 0.0 again. Also, in order to avoid "gaps" at the frame +boundaries, the DC correction offset values will be interpolated smoothly +between neighbouring frames. +

+
+
altboundary, b
+

Enable alternative boundary mode. By default is disabled. +The Dynamic Audio Normalizer takes into account a certain neighbourhood +around each frame. This includes the preceding frames as well as the +subsequent frames. However, for the "boundary" frames, located at the very +beginning and at the very end of the audio file, not all neighbouring +frames are available. In particular, for the first few frames in the audio +file, the preceding frames are not known. And, similarly, for the last few +frames in the audio file, the subsequent frames are not known. Thus, the +question arises which gain factors should be assumed for the missing frames +in the "boundary" region. The Dynamic Audio Normalizer implements two modes +to deal with this situation. The default boundary mode assumes a gain factor +of exactly 1.0 for the missing frames, resulting in a smooth "fade in" and +"fade out" at the beginning and at the end of the input, respectively. +

+
+
compress, s
+

Set the compress factor. In range from 0.0 to 30.0. Default is 0.0. +By default, the Dynamic Audio Normalizer does not apply "traditional" +compression. This means that signal peaks will not be pruned and thus the +full dynamic range will be retained within each local neighbourhood. However, +in some cases it may be desirable to combine the Dynamic Audio Normalizer’s +normalization algorithm with a more "traditional" compression. +For this purpose, the Dynamic Audio Normalizer provides an optional compression +(thresholding) function. If (and only if) the compression feature is enabled, +all input frames will be processed by a soft knee thresholding function prior +to the actual normalization process. Put simply, the thresholding function is +going to prune all samples whose magnitude exceeds a certain threshold value. +However, the Dynamic Audio Normalizer does not simply apply a fixed threshold +value. Instead, the threshold value will be adjusted for each individual +frame. +In general, smaller parameters result in stronger compression, and vice versa. +Values below 3.0 are not recommended, because audible distortion may appear. +

+
+
threshold, t
+

Set the target threshold value. This specifies the lowest permissible +magnitude level for the audio input which will be normalized. +If input frame volume is above this value frame will be normalized. +Otherwise frame may not be normalized at all. The default value is set +to 0, which means all input frames will be normalized. +This option is mostly useful if digital noise is not wanted to be amplified. +

+
+ + +

36.63.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

36.64 earwax

+ +

Make audio easier to listen to on headphones. +

+

This filter adds ‘cues’ to 44.1kHz stereo (i.e. audio CD format) audio +so that when listened to on headphones the stereo image is moved from +inside your head (standard for headphones) to outside and in front of +the listener (standard for speakers). +

+

Ported from SoX. +

+ +

36.65 equalizer

+ +

Apply a two-pole peaking equalisation (EQ) filter. With this +filter, the signal-level at and around a selected frequency can +be increased or decreased, whilst (unlike bandpass and bandreject +filters) that at all other frequencies is unchanged. +

+

In order to produce complex equalisation curves, this filter can +be given several times, each with a different central frequency. +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the filter’s central frequency in Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
gain, g
+

Set the required gain or attenuation in dB. +Beware of clipping when using a positive gain. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

36.65.1 Examples

+
    +
  • Attenuate 10 dB at 1000 Hz, with a bandwidth of 200 Hz: +
    +
    equalizer=f=1000:t=h:width=200:g=-10
+
    + +
  • Apply 2 dB gain at 1000 Hz with Q 1 and attenuate 5 dB at 100 Hz with Q 2: +
    +
    equalizer=f=1000:t=q:w=1:g=2,equalizer=f=100:t=q:w=2:g=-5
+
    +
+ + +

36.65.2 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change equalizer frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change equalizer width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change equalizer width. +Syntax for the command is : "width" +

+
+
gain, g
+

Change equalizer gain. +Syntax for the command is : "gain" +

+
+
mix, m
+

Change equalizer mix. +Syntax for the command is : "mix" +

+
+ + +

36.66 extrastereo

+ +

Linearly increases the difference between left and right channels which +adds some sort of "live" effect to playback. +

+

The filter accepts the following options: +

+
+
m
+

Sets the difference coefficient (default: 2.5). 0.0 means mono sound +(average of both channels), with 1.0 sound will be unchanged, with +-1.0 left and right channels will be swapped. +

+
+
c
+

Enable clipping. By default is enabled. +

+
+ + +

36.66.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

36.67 firequalizer

+

Apply FIR Equalization using arbitrary frequency response. +

+

The filter accepts the following option: +

+
+
gain
+

Set gain curve equation (in dB). The expression can contain variables: +

+
f
+

the evaluated frequency +

+
sr
+

sample rate +

+
ch
+

channel number, set to 0 when multichannels evaluation is disabled +

+
chid
+

channel id, see libavutil/channel_layout.h, set to the first channel id when +multichannels evaluation is disabled +

+
chs
+

number of channels +

+
chlayout
+

channel_layout, see libavutil/channel_layout.h +

+
+
+

and functions: +

+
gain_interpolate(f)
+

interpolate gain on frequency f based on gain_entry +

+
cubic_interpolate(f)
+

same as gain_interpolate, but smoother +

+
+

This option is also available as command. Default is gain_interpolate(f). +

+
+
gain_entry
+

Set gain entry for gain_interpolate function. The expression can +contain functions: +

+
entry(f, g)
+

store gain entry at frequency f with value g +

+
+

This option is also available as command. +

+
+
delay
+

Set filter delay in seconds. Higher value means more accurate. +Default is 0.01. +

+
+
accuracy
+

Set filter accuracy in Hz. Lower value means more accurate. +Default is 5. +

+
+
wfunc
+

Set window function. Acceptable values are: +

+
rectangular
+

rectangular window, useful when gain curve is already smooth +

+
hann
+

hann window (default) +

+
hamming
+

hamming window +

+
blackman
+

blackman window +

+
nuttall3
+

3-terms continuous 1st derivative nuttall window +

+
mnuttall3
+

minimum 3-terms discontinuous nuttall window +

+
nuttall
+

4-terms continuous 1st derivative nuttall window +

+
bnuttall
+

minimum 4-terms discontinuous nuttall (blackman-nuttall) window +

+
bharris
+

blackman-harris window +

+
tukey
+

tukey window +

+
+ +
+
fixed
+

If enabled, use fixed number of audio samples. This improves speed when +filtering with large delay. Default is disabled. +

+
+
multi
+

Enable multichannels evaluation on gain. Default is disabled. +

+
+
zero_phase
+

Enable zero phase mode by subtracting timestamp to compensate delay. +Default is disabled. +

+
+
scale
+

Set scale used by gain. Acceptable values are: +

+
linlin
+

linear frequency, linear gain +

+
linlog
+

linear frequency, logarithmic (in dB) gain (default) +

+
loglin
+

logarithmic (in octave scale where 20 Hz is 0) frequency, linear gain +

+
loglog
+

logarithmic frequency, logarithmic gain +

+
+ +
+
dumpfile
+

Set file for dumping, suitable for gnuplot. +

+
+
dumpscale
+

Set scale for dumpfile. Acceptable values are same with scale option. +Default is linlog. +

+
+
fft2
+

Enable 2-channel convolution using complex FFT. This improves speed significantly. +Default is disabled. +

+
+
min_phase
+

Enable minimum phase impulse response. Default is disabled. +

+
+ + +

36.67.1 Examples

+
    +
  • lowpass at 1000 Hz: +
    +
    firequalizer=gain='if(lt(f,1000), 0, -INF)'
+
    +
  • lowpass at 1000 Hz with gain_entry: +
    +
    firequalizer=gain_entry='entry(1000,0); entry(1001, -INF)'
+
    +
  • custom equalization: +
    +
    firequalizer=gain_entry='entry(100,0); entry(400, -4); entry(1000, -6); entry(2000, 0)'
+
    +
  • higher delay with zero phase to compensate delay: +
    +
    firequalizer=delay=0.1:fixed=on:zero_phase=on
+
    +
  • lowpass on left channel, highpass on right channel: +
    +
    firequalizer=gain='if(eq(chid,1), gain_interpolate(f), if(eq(chid,2), gain_interpolate(1e6+f), 0))'
+:gain_entry='entry(1000, 0); entry(1001,-INF); entry(1e6+1000,0)':multi=on
+
    +
+ + +

36.68 flanger

+

Apply a flanging effect to the audio. +

+

The filter accepts the following options: +

+
+
delay
+

Set base delay in milliseconds. Range from 0 to 30. Default value is 0. +

+
+
depth
+

Set added sweep delay in milliseconds. Range from 0 to 10. Default value is 2. +

+
+
regen
+

Set percentage regeneration (delayed signal feedback). Range from -95 to 95. +Default value is 0. +

+
+
width
+

Set percentage of delayed signal mixed with original. Range from 0 to 100. +Default value is 71. +

+
+
speed
+

Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5. +

+
+
shape
+

Set swept wave shape, can be triangular or sinusoidal. +Default value is sinusoidal. +

+
+
phase
+

Set swept wave percentage-shift for multi channel. Range from 0 to 100. +Default value is 25. +

+
+
interp
+

Set delay-line interpolation, linear or quadratic. +Default is linear. +

+
+ + +

36.69 haas

+

Apply Haas effect to audio. +

+

Note that this makes most sense to apply on mono signals. +With this filter applied to mono signals it give some directionality and +stretches its stereo image. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input level. By default is 1, or 0dB +

+
+
level_out
+

Set output level. By default is 1, or 0dB. +

+
+
side_gain
+

Set gain applied to side part of signal. By default is 1. +

+
+
middle_source
+

Set kind of middle source. Can be one of the following: +

+
+
‘left’
+

Pick left channel. +

+
+
‘right’
+

Pick right channel. +

+
+
‘mid’
+

Pick middle part signal of stereo image. +

+
+
‘side’
+

Pick side part signal of stereo image. +

+
+ +
+
middle_phase
+

Change middle phase. By default is disabled. +

+
+
left_delay
+

Set left channel delay. By default is 2.05 milliseconds. +

+
+
left_balance
+

Set left channel balance. By default is -1. +

+
+
left_gain
+

Set left channel gain. By default is 1. +

+
+
left_phase
+

Change left phase. By default is disabled. +

+
+
right_delay
+

Set right channel delay. By defaults is 2.12 milliseconds. +

+
+
right_balance
+

Set right channel balance. By default is 1. +

+
+
right_gain
+

Set right channel gain. By default is 1. +

+
+
right_phase
+

Change right phase. By default is enabled. +

+
+ + +

36.70 hdcd

+ +

Decodes High Definition Compatible Digital (HDCD) data. A 16-bit PCM stream with +embedded HDCD codes is expanded into a 20-bit PCM stream. +

+

The filter supports the Peak Extend and Low-level Gain Adjustment features +of HDCD, and detects the Transient Filter flag. +

+
+
ffmpeg -i HDCD16.flac -af hdcd OUT24.flac
+
+ +

When using the filter with wav, note the default encoding for wav is 16-bit, +so the resulting 20-bit stream will be truncated back to 16-bit. Use something +like -acodec pcm_s24le after the filter to get 24-bit PCM output. +

+
ffmpeg -i HDCD16.wav -af hdcd OUT16.wav
+ffmpeg -i HDCD16.wav -af hdcd -c:a pcm_s24le OUT24.wav
+
+ +

The filter accepts the following options: +

+
+
disable_autoconvert
+

Disable any automatic format conversion or resampling in the filter graph. +

+
+
process_stereo
+

Process the stereo channels together. If target_gain does not match between +channels, consider it invalid and use the last valid target_gain. +

+
+
cdt_ms
+

Set the code detect timer period in ms. +

+
+
force_pe
+

Always extend peaks above -3dBFS even if PE isn’t signaled. +

+
+
analyze_mode
+

Replace audio with a solid tone and adjust the amplitude to signal some +specific aspect of the decoding process. The output file can be loaded in +an audio editor alongside the original to aid analysis. +

+

analyze_mode=pe:force_pe=true can be used to see all samples above the PE level. +

+

Modes are: +

+
‘0, off’
+

Disabled +

+
‘1, lle’
+

Gain adjustment level at each sample +

+
‘2, pe’
+

Samples where peak extend occurs +

+
‘3, cdt’
+

Samples where the code detect timer is active +

+
‘4, tgm’
+

Samples where the target gain does not match between channels +

+
+
+
+ + +

36.71 headphone

+ +

Apply head-related transfer functions (HRTFs) to create virtual +loudspeakers around the user for binaural listening via headphones. +The HRIRs are provided via additional streams, for each channel +one stereo input stream is needed. +

+

The filter accepts the following options: +

+
+
map
+

Set mapping of input streams for convolution. +The argument is a ’|’-separated list of channel names in order as they +are given as additional stream inputs for filter. +This also specify number of input streams. Number of input streams +must be not less than number of channels in first stream plus one. +

+
+
gain
+

Set gain applied to audio. Value is in dB. Default is 0. +

+
+
type
+

Set processing type. Can be time or freq. time is +processing audio in time domain which is slow. +freq is processing audio in frequency domain which is fast. +Default is freq. +

+
+
lfe
+

Set custom gain for LFE channels. Value is in dB. Default is 0. +

+
+
size
+

Set size of frame in number of samples which will be processed at once. +Default value is 1024. Allowed range is from 1024 to 96000. +

+
+
hrir
+

Set format of hrir stream. +Default value is stereo. Alternative value is multich. +If value is set to stereo, number of additional streams should +be greater or equal to number of input channels in first input stream. +Also each additional stream should have stereo number of channels. +If value is set to multich, number of additional streams should +be exactly one. Also number of input channels of additional stream +should be equal or greater than twice number of channels of first input +stream. +

+
+ + +

36.71.1 Examples

+ +
    +
  • Full example using wav files as coefficients with amovie filters for 7.1 downmix, +each amovie filter use stereo file with IR coefficients as input. +The files give coefficients for each position of virtual loudspeaker: +
    +
    ffmpeg -i input.wav
+-filter_complex "amovie=azi_270_ele_0_DFC.wav[sr];amovie=azi_90_ele_0_DFC.wav[sl];amovie=azi_225_ele_0_DFC.wav[br];amovie=azi_135_ele_0_DFC.wav[bl];amovie=azi_0_ele_0_DFC.wav,asplit[fc][lfe];amovie=azi_35_ele_0_DFC.wav[fl];amovie=azi_325_ele_0_DFC.wav[fr];[0:a][fl][fr][fc][lfe][bl][br][sl][sr]headphone=FL|FR|FC|LFE|BL|BR|SL|SR"
+output.wav
+
    + +
  • Full example using wav files as coefficients with amovie filters for 7.1 downmix, +but now in multich hrir format. +
    +
    ffmpeg -i input.wav -filter_complex "amovie=minp.wav[hrirs];[0:a][hrirs]headphone=map=FL|FR|FC|LFE|BL|BR|SL|SR:hrir=multich"
+output.wav
+
    +
+ + +

36.72 highpass

+ +

Apply a high-pass filter with 3dB point frequency. +The filter can be either single-pole, or double-pole (the default). +The filter roll off at 6dB per pole per octave (20dB per pole per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set frequency in Hz. Default is 3000. +

+
+
poles, p
+

Set number of poles. Default is 2. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +Applies only to double-pole filter. +The default is 0.707q and gives a Butterworth response. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

36.72.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change highpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change highpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change highpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change highpass mix. +Syntax for the command is : "mix" +

+
+ + +

36.73 join

+ +

Join multiple input streams into one multi-channel stream. +

+

It accepts the following parameters: +

+
inputs
+

The number of input streams. It defaults to 2. +

+
+
channel_layout
+

The desired output channel layout. It defaults to stereo. +

+
+
map
+

Map channels from inputs to output. The argument is a ’|’-separated list of +mappings, each in the input_idx.in_channel-out_channel +form. input_idx is the 0-based index of the input stream. in_channel +can be either the name of the input channel (e.g. FL for front left) or its +index in the specified input stream. out_channel is the name of the output +channel. +

+
+ +

The filter will attempt to guess the mappings when they are not specified +explicitly. It does so by first trying to find an unused matching input channel +and if that fails it picks the first unused input channel. +

+

Join 3 inputs (with properly set channel layouts): +

+
ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
+
+ +

Build a 5.1 output from 6 single-channel streams: +

+
ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
+'join=inputs=6:channel_layout=5.1:map=0.0-FL|1.0-FR|2.0-FC|3.0-SL|4.0-SR|5.0-LFE'
+out
+
+ + +

36.74 ladspa

+ +

Load a LADSPA (Linux Audio Developer’s Simple Plugin API) plugin. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-ladspa. +

+
+
file, f
+

Specifies the name of LADSPA plugin library to load. If the environment +variable LADSPA_PATH is defined, the LADSPA plugin is searched in +each one of the directories specified by the colon separated list in +LADSPA_PATH, otherwise in the standard LADSPA paths, which are in +this order: HOME/.ladspa/lib/, /usr/local/lib/ladspa/, +/usr/lib/ladspa/. +

+
+
plugin, p
+

Specifies the plugin within the library. Some libraries contain only +one plugin, but others contain many of them. If this is not set filter +will list all available plugins within the specified library. +

+
+
controls, c
+

Set the ’|’ separated list of controls which are zero or more floating point +values that determine the behavior of the loaded plugin (for example delay, +threshold or gain). +Controls need to be defined using the following syntax: +c0=value0|c1=value1|c2=value2|..., where +valuei is the value set on the i-th control. +Alternatively they can be also defined using the following syntax: +value0|value1|value2|..., where +valuei is the value set on the i-th control. +If controls is set to help, all available controls and +their valid ranges are printed. +

+
+
sample_rate, s
+

Specify the sample rate, default to 44100. Only used if plugin have +zero inputs. +

+
+
nb_samples, n
+

Set the number of samples per channel per each output frame, default +is 1024. Only used if plugin have zero inputs. +

+
+
duration, d
+

Set the minimum duration of the sourced audio. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +Note that the resulting duration may be greater than the specified duration, +as the generated audio is always cut at the end of a complete frame. +If not specified, or the expressed duration is negative, the audio is +supposed to be generated forever. +Only used if plugin have zero inputs. +

+
+
+ + +

36.74.1 Examples

+ +
    +
  • List all available plugins within amp (LADSPA example plugin) library: +
    +
    ladspa=file=amp
+
    + +
  • List all available controls and their valid ranges for vcf_notch +plugin from VCF library: +
    +
    ladspa=f=vcf:p=vcf_notch:c=help
+
    + +
  • Simulate low quality audio equipment using Computer Music Toolkit (CMT) +plugin library: +
    +
    ladspa=file=cmt:plugin=lofi:controls=c0=22|c1=12|c2=12
+
    + +
  • Add reverberation to the audio using TAP-plugins +(Tom’s Audio Processing plugins): +
    +
    ladspa=file=tap_reverb:tap_reverb
+
    + +
  • Generate white noise, with 0.2 amplitude: +
    +
    ladspa=file=cmt:noise_source_white:c=c0=.2
+
    + +
  • Generate 20 bpm clicks using plugin C* Click - Metronome from the +C* Audio Plugin Suite (CAPS) library: +
    +
    ladspa=file=caps:Click:c=c1=20'
+
    + +
  • Apply C* Eq10X2 - Stereo 10-band equaliser effect: +
    +
    ladspa=caps:Eq10X2:c=c0=-48|c9=-24|c3=12|c4=2
+
    + +
  • Increase volume by 20dB using fast lookahead limiter from Steve Harris +SWH Plugins collection: +
    +
    ladspa=fast_lookahead_limiter_1913:fastLookaheadLimiter:20|0|2
+
    + +
  • Attenuate low frequencies using Multiband EQ from Steve Harris +SWH Plugins collection: +
    +
    ladspa=mbeq_1197:mbeq:-24|-24|-24|0|0|0|0|0|0|0|0|0|0|0|0
+
    + +
  • Reduce stereo image using Narrower from the C* Audio Plugin Suite +(CAPS) library: +
    +
    ladspa=caps:Narrower
+
    + +
  • Another white noise, now using C* Audio Plugin Suite (CAPS) library: +
    +
    ladspa=caps:White:.2
+
    + +
  • Some fractal noise, using C* Audio Plugin Suite (CAPS) library: +
    +
    ladspa=caps:Fractal:c=c1=1
+
    + +
  • Dynamic volume normalization using VLevel plugin: +
    +
    ladspa=vlevel-ladspa:vlevel_mono
+
    +
+ + +

36.74.2 Commands

+ +

This filter supports the following commands: +

+
cN
+

Modify the N-th control value. +

+

If the specified value is not valid, it is ignored and prior one is kept. +

+
+ + +

36.75 loudnorm

+ +

EBU R128 loudness normalization. Includes both dynamic and linear normalization modes. +Support for both single pass (livestreams, files) and double pass (files) modes. +This algorithm can target IL, LRA, and maximum true peak. In dynamic mode, to accurately +detect true peaks, the audio stream will be upsampled to 192 kHz. +Use the -ar option or aresample filter to explicitly set an output sample rate. +

+

The filter accepts the following options: +

+
+
I, i
+

Set integrated loudness target. +Range is -70.0 - -5.0. Default value is -24.0. +

+
+
LRA, lra
+

Set loudness range target. +Range is 1.0 - 20.0. Default value is 7.0. +

+
+
TP, tp
+

Set maximum true peak. +Range is -9.0 - +0.0. Default value is -2.0. +

+
+
measured_I, measured_i
+

Measured IL of input file. +Range is -99.0 - +0.0. +

+
+
measured_LRA, measured_lra
+

Measured LRA of input file. +Range is 0.0 - 99.0. +

+
+
measured_TP, measured_tp
+

Measured true peak of input file. +Range is -99.0 - +99.0. +

+
+
measured_thresh
+

Measured threshold of input file. +Range is -99.0 - +0.0. +

+
+
offset
+

Set offset gain. Gain is applied before the true-peak limiter. +Range is -99.0 - +99.0. Default is +0.0. +

+
+
linear
+

Normalize by linearly scaling the source audio. +measured_I, measured_LRA, measured_TP, +and measured_thresh must all be specified. Target LRA shouldn’t +be lower than source LRA and the change in integrated loudness shouldn’t +result in a true peak which exceeds the target TP. If any of these +conditions aren’t met, normalization mode will revert to dynamic. +Options are true or false. Default is true. +

+
+
dual_mono
+

Treat mono input files as "dual-mono". If a mono file is intended for playback +on a stereo system, its EBU R128 measurement will be perceptually incorrect. +If set to true, this option will compensate for this effect. +Multi-channel input files are not affected by this option. +Options are true or false. Default is false. +

+
+
print_format
+

Set print format for stats. Options are summary, json, or none. +Default value is none. +

+
+ + +

36.76 lowpass

+ +

Apply a low-pass filter with 3dB point frequency. +The filter can be either single-pole or double-pole (the default). +The filter roll off at 6dB per pole per octave (20dB per pole per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set frequency in Hz. Default is 500. +

+
+
poles, p
+

Set number of poles. Default is 2. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +Applies only to double-pole filter. +The default is 0.707q and gives a Butterworth response. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

36.76.1 Examples

+
    +
  • Lowpass only LFE channel, it LFE is not present it does nothing: +
    +
    lowpass=c=LFE
+
    +
+ + +

36.76.2 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change lowpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change lowpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change lowpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change lowpass mix. +Syntax for the command is : "mix" +

+
+ + +

36.77 lv2

+ +

Load a LV2 (LADSPA Version 2) plugin. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-lv2. +

+
+
plugin, p
+

Specifies the plugin URI. You may need to escape ’:’. +

+
+
controls, c
+

Set the ’|’ separated list of controls which are zero or more floating point +values that determine the behavior of the loaded plugin (for example delay, +threshold or gain). +If controls is set to help, all available controls and +their valid ranges are printed. +

+
+
sample_rate, s
+

Specify the sample rate, default to 44100. Only used if plugin have +zero inputs. +

+
+
nb_samples, n
+

Set the number of samples per channel per each output frame, default +is 1024. Only used if plugin have zero inputs. +

+
+
duration, d
+

Set the minimum duration of the sourced audio. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +Note that the resulting duration may be greater than the specified duration, +as the generated audio is always cut at the end of a complete frame. +If not specified, or the expressed duration is negative, the audio is +supposed to be generated forever. +Only used if plugin have zero inputs. +

+
+ + +

36.77.1 Examples

+ +
    +
  • Apply bass enhancer plugin from Calf: +
    +
    lv2=p=http\\\\://calf.sourceforge.net/plugins/BassEnhancer:c=amount=2
+
    + +
  • Apply vinyl plugin from Calf: +
    +
    lv2=p=http\\\\://calf.sourceforge.net/plugins/Vinyl:c=drone=0.2|aging=0.5
+
    + +
  • Apply bit crusher plugin from ArtyFX: +
    +
    lv2=p=http\\\\://www.openavproductions.com/artyfx#bitta:c=crush=0.3
+
    +
+ + +

36.78 mcompand

+

Multiband Compress or expand the audio’s dynamic range. +

+

The input audio is divided into bands using 4th order Linkwitz-Riley IIRs. +This is akin to the crossover of a loudspeaker, and results in flat frequency +response when absent compander action. +

+

It accepts the following parameters: +

+
+
args
+

This option syntax is: +attack,decay,[attack,decay..] soft-knee points crossover_frequency [delay [initial_volume [gain]]] | attack,decay ... +For explanation of each item refer to compand filter documentation. +

+
+ + +

36.79 pan

+ +

Mix channels with specific gain levels. The filter accepts the output +channel layout followed by a set of channels definitions. +

+

This filter is also designed to efficiently remap the channels of an audio +stream. +

+

The filter accepts parameters of the form: +"l|outdef|outdef|..." +

+
+
l
+

output channel layout or number of channels +

+
+
outdef
+

output channel specification, of the form: +"out_name=[gain*]in_name[(+-)[gain*]in_name...]" +

+
+
out_name
+

output channel to define, either a channel name (FL, FR, etc.) or a channel +number (c0, c1, etc.) +

+
+
gain
+

multiplicative coefficient for the channel, 1 leaving the volume unchanged +

+
+
in_name
+

input channel to use, see out_name for details; it is not possible to mix +named and numbered input channels +

+
+ +

If the ‘=’ in a channel specification is replaced by ‘<’, then the gains for +that specification will be renormalized so that the total is 1, thus +avoiding clipping noise. +

+ +

36.79.1 Mixing examples

+ +

For example, if you want to down-mix from stereo to mono, but with a bigger +factor for the left channel: +

+
pan=1c|c0=0.9*c0+0.1*c1
+
+ +

A customized down-mix to stereo that works automatically for 3-, 4-, 5- and +7-channels surround: +

+
pan=stereo| FL < FL + 0.5*FC + 0.6*BL + 0.6*SL | FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
+
+ +

Note that ffmpeg integrates a default down-mix (and up-mix) system +that should be preferred (see "-ac" option) unless you have very specific +needs. +

+ +

36.79.2 Remapping examples

+ +

The channel remapping will be effective if, and only if: +

+
    +
  • gain coefficients are zeroes or ones, +
  • only one input per channel output, +
+ +

If all these conditions are satisfied, the filter will notify the user ("Pure +channel mapping detected"), and use an optimized and lossless method to do the +remapping. +

+

For example, if you have a 5.1 source and want a stereo audio stream by +dropping the extra channels: +

+
pan="stereo| c0=FL | c1=FR"
+
+ +

Given the same source, you can also switch front left and front right channels +and keep the input channel layout: +

+
pan="5.1| c0=c1 | c1=c0 | c2=c2 | c3=c3 | c4=c4 | c5=c5"
+
+ +

If the input is a stereo audio stream, you can mute the front left channel (and +still keep the stereo channel layout) with: +

+
pan="stereo|c1=c1"
+
+ +

Still with a stereo audio stream input, you can copy the right channel in both +front left and right: +

+
pan="stereo| c0=FR | c1=FR"
+
+ + +

36.80 replaygain

+ +

ReplayGain scanner filter. This filter takes an audio stream as an input and +outputs it unchanged. +At end of filtering it displays track_gain and track_peak. +

+ +

36.81 resample

+ +

Convert the audio sample format, sample rate and channel layout. It is +not meant to be used directly. +

+ +

36.82 rubberband

+

Apply time-stretching and pitch-shifting with librubberband. +

+

To enable compilation of this filter, you need to configure FFmpeg with +--enable-librubberband. +

+

The filter accepts the following options: +

+
+
tempo
+

Set tempo scale factor. +

+
+
pitch
+

Set pitch scale factor. +

+
+
transients
+

Set transients detector. +Possible values are: +

+
crisp
+
mixed
+
smooth
+
+ +
+
detector
+

Set detector. +Possible values are: +

+
compound
+
percussive
+
soft
+
+ +
+
phase
+

Set phase. +Possible values are: +

+
laminar
+
independent
+
+ +
+
window
+

Set processing window size. +Possible values are: +

+
standard
+
short
+
long
+
+ +
+
smoothing
+

Set smoothing. +Possible values are: +

+
off
+
on
+
+ +
+
formant
+

Enable formant preservation when shift pitching. +Possible values are: +

+
shifted
+
preserved
+
+ +
+
pitchq
+

Set pitch quality. +Possible values are: +

+
quality
+
speed
+
consistency
+
+ +
+
channels
+

Set channels. +Possible values are: +

+
apart
+
together
+
+
+
+ + +

36.82.1 Commands

+ +

This filter supports the following commands: +

+
tempo
+

Change filter tempo scale factor. +Syntax for the command is : "tempo" +

+
+
pitch
+

Change filter pitch scale factor. +Syntax for the command is : "pitch" +

+
+ + +

36.83 sidechaincompress

+ +

This filter acts like normal compressor but has the ability to compress +detected signal using second input signal. +It needs two input streams and returns one output stream. +First input stream will be processed depending on second stream signal. +The filtered signal then can be filtered with other filters in later stages of +processing. See pan and amerge filter. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. Default is 1. Range is between 0.015625 and 64. +

+
+
mode
+

Set mode of compressor operation. Can be upward or downward. +Default is downward. +

+
+
threshold
+

If a signal of second stream raises above this level it will affect the gain +reduction of first stream. +By default is 0.125. Range is between 0.00097563 and 1. +

+
+
ratio
+

Set a ratio about which the signal is reduced. 1:2 means that if the level +raised 4dB above the threshold, it will be only 2dB above after the reduction. +Default is 2. Range is between 1 and 20. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction starts. Default is 20. Range is between 0.01 and 2000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before +reduction is decreased again. Default is 250. Range is between 0.01 and 9000. +

+
+
makeup
+

Set the amount by how much signal will be amplified after processing. +Default is 1. Range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.82843. Range is between 1 and 8. +

+
+
link
+

Choose if the average level between all channels of side-chain stream +or the louder(maximum) channel of side-chain stream affects the +reduction. Default is average. +

+
+
detection
+

Should the exact signal be taken in case of peak or an RMS one in case +of rms. Default is rms which is mainly smoother. +

+
+
level_sc
+

Set sidechain gain. Default is 1. Range is between 0.015625 and 64. +

+
+
mix
+

How much to use compressed signal in output. Default is 1. +Range is between 0 and 1. +

+
+ + +

36.83.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

36.83.2 Examples

+ +
    +
  • Full ffmpeg example taking 2 audio inputs, 1st input to be compressed +depending on the signal of 2nd input and later compressed signal to be +merged with 2nd input: +
    +
    ffmpeg -i main.flac -i sidechain.flac -filter_complex "[1:a]asplit=2[sc][mix];[0:a][sc]sidechaincompress[compr];[compr][mix]amerge"
+
    +
+ + +

36.84 sidechaingate

+ +

A sidechain gate acts like a normal (wideband) gate but has the ability to +filter the detected signal before sending it to the gain reduction stage. +Normally a gate uses the full range signal to detect a level above the +threshold. +For example: If you cut all lower frequencies from your sidechain signal +the gate will decrease the volume of your track only if not enough highs +appear. With this technique you are able to reduce the resonation of a +natural drum or remove "rumbling" of muted strokes from a heavily distorted +guitar. +It needs two input streams and returns one output stream. +First input stream will be processed depending on second stream signal. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input level before filtering. +Default is 1. Allowed range is from 0.015625 to 64. +

+
+
mode
+

Set the mode of operation. Can be upward or downward. +Default is downward. If set to upward mode, higher parts of signal +will be amplified, expanding dynamic range in upward direction. +Otherwise, in case of downward lower parts of signal will be reduced. +

+
+
range
+

Set the level of gain reduction when the signal is below the threshold. +Default is 0.06125. Allowed range is from 0 to 1. +Setting this to 0 disables reduction and then filter behaves like expander. +

+
+
threshold
+

If a signal rises above this level the gain reduction is released. +Default is 0.125. Allowed range is from 0 to 1. +

+
+
ratio
+

Set a ratio about which the signal is reduced. +Default is 2. Allowed range is from 1 to 9000. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction stops. +Default is 20 milliseconds. Allowed range is from 0.01 to 9000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before the +reduction is increased again. Default is 250 milliseconds. +Allowed range is from 0.01 to 9000. +

+
+
makeup
+

Set amount of amplification of signal after processing. +Default is 1. Allowed range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.828427125. Allowed range is from 1 to 8. +

+
+
detection
+

Choose if exact signal should be taken for detection or an RMS like one. +Default is rms. Can be peak or rms. +

+
+
link
+

Choose if the average level between all channels or the louder channel affects +the reduction. +Default is average. Can be average or maximum. +

+
+
level_sc
+

Set sidechain gain. Default is 1. Range is from 0.015625 to 64. +

+
+ + +

36.85 silencedetect

+ +

Detect silence in an audio stream. +

+

This filter logs a message when it detects that the input audio volume is less +or equal to a noise tolerance value for a duration greater or equal to the +minimum detected noise duration. +

+

The printed times and duration are expressed in seconds. The +lavfi.silence_start or lavfi.silence_start.X metadata key +is set on the first frame whose timestamp equals or exceeds the detection +duration and it contains the timestamp of the first frame of the silence. +

+

The lavfi.silence_duration or lavfi.silence_duration.X +and lavfi.silence_end or lavfi.silence_end.X metadata +keys are set on the first frame after the silence. If mono is +enabled, and each channel is evaluated separately, the .X +suffixed keys are used, and X corresponds to the channel number. +

+

The filter accepts the following options: +

+
+
noise, n
+

Set noise tolerance. Can be specified in dB (in case "dB" is appended to the +specified value) or amplitude ratio. Default is -60dB, or 0.001. +

+
+
duration, d
+

Set silence duration until notification (default is 2 seconds). See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+
+
mono, m
+

Process each channel separately, instead of combined. By default is disabled. +

+
+ + +

36.85.1 Examples

+ +
    +
  • Detect 5 seconds of silence with -50dB noise tolerance: +
    +
    silencedetect=n=-50dB:d=5
+
    + +
  • Complete example with ffmpeg to detect silence with 0.0001 noise +tolerance in silence.mp3: +
    +
    ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
+
    +
+ + +

36.86 silenceremove

+ +

Remove silence from the beginning, middle or end of the audio. +

+

The filter accepts the following options: +

+
+
start_periods
+

This value is used to indicate if audio should be trimmed at beginning of +the audio. A value of zero indicates no silence should be trimmed from the +beginning. When specifying a non-zero value, it trims audio up until it +finds non-silence. Normally, when trimming silence from beginning of audio +the start_periods will be 1 but it can be increased to higher +values to trim all audio up to specific count of non-silence periods. +Default value is 0. +

+
+
start_duration
+

Specify the amount of time that non-silence must be detected before it stops +trimming audio. By increasing the duration, bursts of noises can be treated +as silence and trimmed off. Default value is 0. +

+
+
start_threshold
+

This indicates what sample value should be treated as silence. For digital +audio, a value of 0 may be fine but for audio recorded from analog, +you may wish to increase the value to account for background noise. +Can be specified in dB (in case "dB" is appended to the specified value) +or amplitude ratio. Default value is 0. +

+
+
start_silence
+

Specify max duration of silence at beginning that will be kept after +trimming. Default is 0, which is equal to trimming all samples detected +as silence. +

+
+
start_mode
+

Specify mode of detection of silence end in start of multi-channel audio. +Can be any or all. Default is any. +With any, any sample that is detected as non-silence will cause +stopped trimming of silence. +With all, only if all channels are detected as non-silence will cause +stopped trimming of silence. +

+
+
stop_periods
+

Set the count for trimming silence from the end of audio. +To remove silence from the middle of a file, specify a stop_periods +that is negative. This value is then treated as a positive value and is +used to indicate the effect should restart processing as specified by +start_periods, making it suitable for removing periods of silence +in the middle of the audio. +Default value is 0. +

+
+
stop_duration
+

Specify a duration of silence that must exist before audio is not copied any +more. By specifying a higher duration, silence that is wanted can be left in +the audio. +Default value is 0. +

+
+
stop_threshold
+

This is the same as start_threshold but for trimming silence from +the end of audio. +Can be specified in dB (in case "dB" is appended to the specified value) +or amplitude ratio. Default value is 0. +

+
+
stop_silence
+

Specify max duration of silence at end that will be kept after +trimming. Default is 0, which is equal to trimming all samples detected +as silence. +

+
+
stop_mode
+

Specify mode of detection of silence start in end of multi-channel audio. +Can be any or all. Default is any. +With any, any sample that is detected as non-silence will cause +stopped trimming of silence. +With all, only if all channels are detected as non-silence will cause +stopped trimming of silence. +

+
+
detection
+

Set how is silence detected. Can be rms or peak. Second is faster +and works better with digital silence which is exactly 0. +Default value is rms. +

+
+
window
+

Set duration in number of seconds used to calculate size of window in number +of samples for detecting silence. +Default value is 0.02. Allowed range is from 0 to 10. +

+
+ + +

36.86.1 Examples

+ +
    +
  • The following example shows how this filter can be used to start a recording +that does not contain the delay at the start which usually occurs between +pressing the record button and the start of the performance: +
    +
    silenceremove=start_periods=1:start_duration=5:start_threshold=0.02
+
    + +
  • Trim all silence encountered from beginning to end where there is more than 1 +second of silence in audio: +
    +
    silenceremove=stop_periods=-1:stop_duration=1:stop_threshold=-90dB
+
    + +
  • Trim all digital silence samples, using peak detection, from beginning to end +where there is more than 0 samples of digital silence in audio and digital +silence is detected in all channels at same positions in stream: +
    +
    silenceremove=window=0:detection=peak:stop_mode=all:start_mode=all:stop_periods=-1:stop_threshold=0
+
    +
+ + +

36.87 sofalizer

+ +

SOFAlizer uses head-related transfer functions (HRTFs) to create virtual +loudspeakers around the user for binaural listening via headphones (audio +formats up to 9 channels supported). +The HRTFs are stored in SOFA files (see http://www.sofacoustics.org/ for a database). +SOFAlizer is developed at the Acoustics Research Institute (ARI) of the +Austrian Academy of Sciences. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libmysofa. +

+

The filter accepts the following options: +

+
+
sofa
+

Set the SOFA file used for rendering. +

+
+
gain
+

Set gain applied to audio. Value is in dB. Default is 0. +

+
+
rotation
+

Set rotation of virtual loudspeakers in deg. Default is 0. +

+
+
elevation
+

Set elevation of virtual speakers in deg. Default is 0. +

+
+
radius
+

Set distance in meters between loudspeakers and the listener with near-field +HRTFs. Default is 1. +

+
+
type
+

Set processing type. Can be time or freq. time is +processing audio in time domain which is slow. +freq is processing audio in frequency domain which is fast. +Default is freq. +

+
+
speakers
+

Set custom positions of virtual loudspeakers. Syntax for this option is: +<CH> <AZIM> <ELEV>[|<CH> <AZIM> <ELEV>|...]. +Each virtual loudspeaker is described with short channel name following with +azimuth and elevation in degrees. +Each virtual loudspeaker description is separated by ’|’. +For example to override front left and front right channel positions use: +’speakers=FL 45 15|FR 345 15’. +Descriptions with unrecognised channel names are ignored. +

+
+
lfegain
+

Set custom gain for LFE channels. Value is in dB. Default is 0. +

+
+
framesize
+

Set custom frame size in number of samples. Default is 1024. +Allowed range is from 1024 to 96000. Only used if option ‘type’ +is set to freq. +

+
+
normalize
+

Should all IRs be normalized upon importing SOFA file. +By default is enabled. +

+
+
interpolate
+

Should nearest IRs be interpolated with neighbor IRs if exact position +does not match. By default is disabled. +

+
+
minphase
+

Minphase all IRs upon loading of SOFA file. By default is disabled. +

+
+
anglestep
+

Set neighbor search angle step. Only used if option interpolate is enabled. +

+
+
radstep
+

Set neighbor search radius step. Only used if option interpolate is enabled. +

+
+ + +

36.87.1 Examples

+ +
    +
  • Using ClubFritz6 sofa file: +
    +
    sofalizer=sofa=/path/to/ClubFritz6.sofa:type=freq:radius=1
+
    + +
  • Using ClubFritz12 sofa file and bigger radius with small rotation: +
    +
    sofalizer=sofa=/path/to/ClubFritz12.sofa:type=freq:radius=2:rotation=5
+
    + +
  • Similar as above but with custom speaker positions for front left, front right, back left and back right +and also with custom gain: +
    +
    "sofalizer=sofa=/path/to/ClubFritz6.sofa:type=freq:radius=2:speakers=FL 45|FR 315|BL 135|BR 225:gain=28"
+
    +
+ + +

36.88 stereotools

+ +

This filter has some handy utilities to manage stereo signals, for converting +M/S stereo recordings to L/R signal while having control over the parameters +or spreading the stereo image of master track. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input level before filtering for both channels. Defaults is 1. +Allowed range is from 0.015625 to 64. +

+
+
level_out
+

Set output level after filtering for both channels. Defaults is 1. +Allowed range is from 0.015625 to 64. +

+
+
balance_in
+

Set input balance between both channels. Default is 0. +Allowed range is from -1 to 1. +

+
+
balance_out
+

Set output balance between both channels. Default is 0. +Allowed range is from -1 to 1. +

+
+
softclip
+

Enable softclipping. Results in analog distortion instead of harsh digital 0dB +clipping. Disabled by default. +

+
+
mutel
+

Mute the left channel. Disabled by default. +

+
+
muter
+

Mute the right channel. Disabled by default. +

+
+
phasel
+

Change the phase of the left channel. Disabled by default. +

+
+
phaser
+

Change the phase of the right channel. Disabled by default. +

+
+
mode
+

Set stereo mode. Available values are: +

+
+
‘lr>lr’
+

Left/Right to Left/Right, this is default. +

+
+
‘lr>ms’
+

Left/Right to Mid/Side. +

+
+
‘ms>lr’
+

Mid/Side to Left/Right. +

+
+
‘lr>ll’
+

Left/Right to Left/Left. +

+
+
‘lr>rr’
+

Left/Right to Right/Right. +

+
+
‘lr>l+r’
+

Left/Right to Left + Right. +

+
+
‘lr>rl’
+

Left/Right to Right/Left. +

+
+
‘ms>ll’
+

Mid/Side to Left/Left. +

+
+
‘ms>rr’
+

Mid/Side to Right/Right. +

+
+ +
+
slev
+

Set level of side signal. Default is 1. +Allowed range is from 0.015625 to 64. +

+
+
sbal
+

Set balance of side signal. Default is 0. +Allowed range is from -1 to 1. +

+
+
mlev
+

Set level of the middle signal. Default is 1. +Allowed range is from 0.015625 to 64. +

+
+
mpan
+

Set middle signal pan. Default is 0. Allowed range is from -1 to 1. +

+
+
base
+

Set stereo base between mono and inversed channels. Default is 0. +Allowed range is from -1 to 1. +

+
+
delay
+

Set delay in milliseconds how much to delay left from right channel and +vice versa. Default is 0. Allowed range is from -20 to 20. +

+
+
sclevel
+

Set S/C level. Default is 1. Allowed range is from 1 to 100. +

+
+
phase
+

Set the stereo phase in degrees. Default is 0. Allowed range is from 0 to 360. +

+
+
bmode_in, bmode_out
+

Set balance mode for balance_in/balance_out option. +

+

Can be one of the following: +

+
+
‘balance’
+

Classic balance mode. Attenuate one channel at time. +Gain is raised up to 1. +

+
+
‘amplitude’
+

Similar as classic mode above but gain is raised up to 2. +

+
+
‘power’
+

Equal power distribution, from -6dB to +6dB range. +

+
+
+
+ + +

36.88.1 Examples

+ +
    +
  • Apply karaoke like effect: +
    +
    stereotools=mlev=0.015625
+
    + +
  • Convert M/S signal to L/R: +
    +
    "stereotools=mode=ms>lr"
+
    +
+ + +

36.89 stereowiden

+ +

This filter enhance the stereo effect by suppressing signal common to both +channels and by delaying the signal of left into right and vice versa, +thereby widening the stereo effect. +

+

The filter accepts the following options: +

+
+
delay
+

Time in milliseconds of the delay of left signal into right and vice versa. +Default is 20 milliseconds. +

+
+
feedback
+

Amount of gain in delayed signal into right and vice versa. Gives a delay +effect of left signal in right output and vice versa which gives widening +effect. Default is 0.3. +

+
+
crossfeed
+

Cross feed of left into right with inverted phase. This helps in suppressing +the mono. If the value is 1 it will cancel all the signal common to both +channels. Default is 0.3. +

+
+
drymix
+

Set level of input signal of original channel. Default is 0.8. +

+
+ + +

36.89.1 Commands

+ +

This filter supports the all above options except delay as commands. +

+ +

36.90 superequalizer

+

Apply 18 band equalizer. +

+

The filter accepts the following options: +

+
1b
+

Set 65Hz band gain. +

+
2b
+

Set 92Hz band gain. +

+
3b
+

Set 131Hz band gain. +

+
4b
+

Set 185Hz band gain. +

+
5b
+

Set 262Hz band gain. +

+
6b
+

Set 370Hz band gain. +

+
7b
+

Set 523Hz band gain. +

+
8b
+

Set 740Hz band gain. +

+
9b
+

Set 1047Hz band gain. +

+
10b
+

Set 1480Hz band gain. +

+
11b
+

Set 2093Hz band gain. +

+
12b
+

Set 2960Hz band gain. +

+
13b
+

Set 4186Hz band gain. +

+
14b
+

Set 5920Hz band gain. +

+
15b
+

Set 8372Hz band gain. +

+
16b
+

Set 11840Hz band gain. +

+
17b
+

Set 16744Hz band gain. +

+
18b
+

Set 20000Hz band gain. +

+
+ + +

36.91 surround

+

Apply audio surround upmix filter. +

+

This filter allows to produce multichannel output from audio stream. +

+

The filter accepts the following options: +

+
+
chl_out
+

Set output channel layout. By default, this is 5.1. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+
chl_in
+

Set input channel layout. By default, this is stereo. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+
level_in
+

Set input volume level. By default, this is 1. +

+
+
level_out
+

Set output volume level. By default, this is 1. +

+
+
lfe
+

Enable LFE channel output if output channel layout has it. By default, this is enabled. +

+
+
lfe_low
+

Set LFE low cut off frequency. By default, this is 128 Hz. +

+
+
lfe_high
+

Set LFE high cut off frequency. By default, this is 256 Hz. +

+
+
lfe_mode
+

Set LFE mode, can be add or sub. Default is add. +In add mode, LFE channel is created from input audio and added to output. +In sub mode, LFE channel is created from input audio and added to output but +also all non-LFE output channels are subtracted with output LFE channel. +

+
+
angle
+

Set angle of stereo surround transform, Allowed range is from 0 to 360. +Default is 90. +

+
+
fc_in
+

Set front center input volume. By default, this is 1. +

+
+
fc_out
+

Set front center output volume. By default, this is 1. +

+
+
fl_in
+

Set front left input volume. By default, this is 1. +

+
+
fl_out
+

Set front left output volume. By default, this is 1. +

+
+
fr_in
+

Set front right input volume. By default, this is 1. +

+
+
fr_out
+

Set front right output volume. By default, this is 1. +

+
+
sl_in
+

Set side left input volume. By default, this is 1. +

+
+
sl_out
+

Set side left output volume. By default, this is 1. +

+
+
sr_in
+

Set side right input volume. By default, this is 1. +

+
+
sr_out
+

Set side right output volume. By default, this is 1. +

+
+
bl_in
+

Set back left input volume. By default, this is 1. +

+
+
bl_out
+

Set back left output volume. By default, this is 1. +

+
+
br_in
+

Set back right input volume. By default, this is 1. +

+
+
br_out
+

Set back right output volume. By default, this is 1. +

+
+
bc_in
+

Set back center input volume. By default, this is 1. +

+
+
bc_out
+

Set back center output volume. By default, this is 1. +

+
+
lfe_in
+

Set LFE input volume. By default, this is 1. +

+
+
lfe_out
+

Set LFE output volume. By default, this is 1. +

+
+
allx
+

Set spread usage of stereo image across X axis for all channels. +

+
+
ally
+

Set spread usage of stereo image across Y axis for all channels. +

+
+
fcx, flx, frx, blx, brx, slx, srx, bcx
+

Set spread usage of stereo image across X axis for each channel. +

+
+
fcy, fly, fry, bly, bry, sly, sry, bcy
+

Set spread usage of stereo image across Y axis for each channel. +

+
+
win_size
+

Set window size. Allowed range is from 1024 to 65536. Default size is 4096. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann, hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+

Default is hann. +

+
+
overlap
+

Set window overlap. If set to 1, the recommended overlap for selected +window function will be picked. Default is 0.5. +

+
+ + +

36.92 treble, highshelf

+ +

Boost or cut treble (upper) frequencies of the audio using a two-pole +shelving filter with a response similar to that of a standard +hi-fi’s tone-controls. This is also known as shelving equalisation (EQ). +

+

The filter accepts the following options: +

+
+
gain, g
+

Give the gain at whichever is the lower of ~22 kHz and the +Nyquist frequency. Its useful range is about -20 (for a large cut) +to +20 (for a large boost). Beware of clipping when using a positive gain. +

+
+
frequency, f
+

Set the filter’s central frequency and so can be used +to extend or reduce the frequency range to be boosted or cut. +The default value is 3000 Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Determine how steep is the filter’s shelf transition. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

36.92.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change treble frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change treble width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change treble width. +Syntax for the command is : "width" +

+
+
gain, g
+

Change treble gain. +Syntax for the command is : "gain" +

+
+
mix, m
+

Change treble mix. +Syntax for the command is : "mix" +

+
+ + +

36.93 tremolo

+ +

Sinusoidal amplitude modulation. +

+

The filter accepts the following options: +

+
+
f
+

Modulation frequency in Hertz. Modulation frequencies in the subharmonic range +(20 Hz or lower) will result in a tremolo effect. +This filter may also be used as a ring modulator by specifying +a modulation frequency higher than 20 Hz. +Range is 0.1 - 20000.0. Default value is 5.0 Hz. +

+
+
d
+

Depth of modulation as a percentage. Range is 0.0 - 1.0. +Default value is 0.5. +

+
+ + +

36.94 vibrato

+ +

Sinusoidal phase modulation. +

+

The filter accepts the following options: +

+
+
f
+

Modulation frequency in Hertz. +Range is 0.1 - 20000.0. Default value is 5.0 Hz. +

+
+
d
+

Depth of modulation as a percentage. Range is 0.0 - 1.0. +Default value is 0.5. +

+
+ + +

36.95 volume

+ +

Adjust the input audio volume. +

+

It accepts the following parameters: +

+
volume
+

Set audio volume expression. +

+

Output values are clipped to the maximum value. +

+

The output audio volume is given by the relation: +

+
output_volume = volume * input_volume
+
+ +

The default value for volume is "1.0". +

+
+
precision
+

This parameter represents the mathematical precision. +

+

It determines which input sample formats will be allowed, which affects the +precision of the volume scaling. +

+
+
fixed
+

8-bit fixed-point; this limits input sample format to U8, S16, and S32. +

+
float
+

32-bit floating-point; this limits input sample format to FLT. (default) +

+
double
+

64-bit floating-point; this limits input sample format to DBL. +

+
+ +
+
replaygain
+

Choose the behaviour on encountering ReplayGain side data in input frames. +

+
+
drop
+

Remove ReplayGain side data, ignoring its contents (the default). +

+
+
ignore
+

Ignore ReplayGain side data, but leave it in the frame. +

+
+
track
+

Prefer the track gain, if present. +

+
+
album
+

Prefer the album gain, if present. +

+
+ +
+
replaygain_preamp
+

Pre-amplification gain in dB to apply to the selected replaygain gain. +

+

Default value for replaygain_preamp is 0.0. +

+
+
replaygain_noclip
+

Prevent clipping by limiting the gain applied. +

+

Default value for replaygain_noclip is 1. +

+
+
eval
+

Set when the volume expression is evaluated. +

+

It accepts the following values: +

+
‘once’
+

only evaluate expression once during the filter initialization, or +when the ‘volume’ command is sent +

+
+
‘frame’
+

evaluate expression for each incoming frame +

+
+ +

Default value is ‘once’. +

+
+ +

The volume expression can contain the following parameters. +

+
+
n
+

frame number (starting at zero) +

+
nb_channels
+

number of channels +

+
nb_consumed_samples
+

number of samples consumed by the filter +

+
nb_samples
+

number of samples in the current frame +

+
pos
+

original frame position in the file +

+
pts
+

frame PTS +

+
sample_rate
+

sample rate +

+
startpts
+

PTS at start of stream +

+
startt
+

time at start of stream +

+
t
+

frame time +

+
tb
+

timestamp timebase +

+
volume
+

last set volume value +

+
+ +

Note that when eval is set to ‘once’ only the +sample_rate and tb variables are available, all other +variables will evaluate to NAN. +

+ +

36.95.1 Commands

+ +

This filter supports the following commands: +

+
volume
+

Modify the volume expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

36.95.2 Examples

+ +
    +
  • Halve the input audio volume: +
    +
    volume=volume=0.5
+volume=volume=1/2
+volume=volume=-6.0206dB
+
    + +

    In all the above example the named key for volume can be +omitted, for example like in: +

    +
    volume=0.5
+
    + +
  • Increase input audio power by 6 decibels using fixed-point precision: +
    +
    volume=volume=6dB:precision=fixed
+
    + +
  • Fade volume after time 10 with an annihilation period of 5 seconds: +
    +
    volume='if(lt(t,10),1,max(1-(t-10)/5,0))':eval=frame
+
    +
+ + +

36.96 volumedetect

+ +

Detect the volume of the input video. +

+

The filter has no parameters. The input is not modified. Statistics about +the volume will be printed in the log when the input stream end is reached. +

+

In particular it will show the mean volume (root mean square), maximum +volume (on a per-sample basis), and the beginning of a histogram of the +registered volume values (from the maximum value to a cumulated 1/1000 of +the samples). +

+

All volumes are in decibels relative to the maximum PCM value. +

+ +

36.96.1 Examples

+ +

Here is an excerpt of the output: +

+
[Parsed_volumedetect_0  0xa23120] mean_volume: -27 dB
+[Parsed_volumedetect_0  0xa23120] max_volume: -4 dB
+[Parsed_volumedetect_0  0xa23120] histogram_4db: 6
+[Parsed_volumedetect_0  0xa23120] histogram_5db: 62
+[Parsed_volumedetect_0  0xa23120] histogram_6db: 286
+[Parsed_volumedetect_0  0xa23120] histogram_7db: 1042
+[Parsed_volumedetect_0  0xa23120] histogram_8db: 2551
+[Parsed_volumedetect_0  0xa23120] histogram_9db: 4609
+[Parsed_volumedetect_0  0xa23120] histogram_10db: 8409
+
+ +

It means that: +

    +
  • The mean square energy is approximately -27 dB, or 10^-2.7. +
  • The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB. +
  • There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc. +
+ +

In other words, raising the volume by +4 dB does not cause any clipping, +raising it by +5 dB causes clipping for 6 samples, etc. +

+ + +

37 Audio Sources

+ +

Below is a description of the currently available audio sources. +

+ +

37.1 abuffer

+ +

Buffer audio frames, and make them available to the filter chain. +

+

This source is mainly intended for a programmatic use, in particular +through the interface defined in libavfilter/asrc_abuffer.h. +

+

It accepts the following parameters: +

+
time_base
+

The timebase which will be used for timestamps of submitted frames. It must be +either a floating-point number or in numerator/denominator form. +

+
+
sample_rate
+

The sample rate of the incoming audio buffers. +

+
+
sample_fmt
+

The sample format of the incoming audio buffers. +Either a sample format name or its corresponding integer representation from +the enum AVSampleFormat in libavutil/samplefmt.h +

+
+
channel_layout
+

The channel layout of the incoming audio buffers. +Either a channel layout name from channel_layout_map in +libavutil/channel_layout.c or its corresponding integer representation +from the AV_CH_LAYOUT_* macros in libavutil/channel_layout.h +

+
+
channels
+

The number of channels of the incoming audio buffers. +If both channels and channel_layout are specified, then they +must be consistent. +

+
+
+ + +

37.1.1 Examples

+ +
+
abuffer=sample_rate=44100:sample_fmt=s16p:channel_layout=stereo
+
+ +

will instruct the source to accept planar 16bit signed stereo at 44100Hz. +Since the sample format with name "s16p" corresponds to the number +6 and the "stereo" channel layout corresponds to the value 0x3, this is +equivalent to: +

+
abuffer=sample_rate=44100:sample_fmt=6:channel_layout=0x3
+
+ + +

37.2 aevalsrc

+ +

Generate an audio signal specified by an expression. +

+

This source accepts in input one or more expressions (one for each +channel), which are evaluated and used to generate a corresponding +audio signal. +

+

This source accepts the following options: +

+
+
exprs
+

Set the ’|’-separated expressions list for each separate channel. In case the +channel_layout option is not specified, the selected channel layout +depends on the number of provided expressions. Otherwise the last +specified expression is applied to the remaining output channels. +

+
+
channel_layout, c
+

Set the channel layout. The number of channels in the specified layout +must be equal to the number of specified expressions. +

+
+
duration, d
+

Set the minimum duration of the sourced audio. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +Note that the resulting duration may be greater than the specified +duration, as the generated audio is always cut at the end of a +complete frame. +

+

If not specified, or the expressed duration is negative, the audio is +supposed to be generated forever. +

+
+
nb_samples, n
+

Set the number of samples per channel per each output frame, +default to 1024. +

+
+
sample_rate, s
+

Specify the sample rate, default to 44100. +

+
+ +

Each expression in exprs can contain the following constants: +

+
+
n
+

number of the evaluated sample, starting from 0 +

+
+
t
+

time of the evaluated sample expressed in seconds, starting from 0 +

+
+
s
+

sample rate +

+
+
+ + +

37.2.1 Examples

+ +
    +
  • Generate silence: +
    +
    aevalsrc=0
+
    + +
  • Generate a sin signal with frequency of 440 Hz, set sample rate to +8000 Hz: +
    +
    aevalsrc="sin(440*2*PI*t):s=8000"
+
    + +
  • Generate a two channels signal, specify the channel layout (Front +Center + Back Center) explicitly: +
    +
    aevalsrc="sin(420*2*PI*t)|cos(430*2*PI*t):c=FC|BC"
+
    + +
  • Generate white noise: +
    +
    aevalsrc="-2+random(0)"
+
    + +
  • Generate an amplitude modulated signal: +
    +
    aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
+
    + +
  • Generate 2.5 Hz binaural beats on a 360 Hz carrier: +
    +
    aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) | 0.1*sin(2*PI*(360+2.5/2)*t)"
+
    + +
+ + +

37.3 afirsrc

+ +

Generate a FIR coefficients using frequency sampling method. +

+

The resulting stream can be used with afir filter for filtering the audio signal. +

+

The filter accepts the following options: +

+
+
taps, t
+

Set number of filter coefficents in output audio stream. +Default value is 1025. +

+
+
frequency, f
+

Set frequency points from where magnitude and phase are set. +This must be in non decreasing order, and first element must be 0, while last element +must be 1. Elements are separated by white spaces. +

+
+
magnitude, m
+

Set magnitude value for every frequency point set by frequency. +Number of values must be same as number of frequency points. +Values are separated by white spaces. +

+
+
phase, p
+

Set phase value for every frequency point set by frequency. +Number of values must be same as number of frequency points. +Values are separated by white spaces. +

+
+
sample_rate, r
+

Set sample rate, default is 44100. +

+
+
nb_samples, n
+

Set number of samples per each frame. Default is 1024. +

+
+
win_func, w
+

Set window function. Default is blackman. +

+
+ + +

37.4 anullsrc

+ +

The null audio source, return unprocessed audio frames. It is mainly useful +as a template and to be employed in analysis / debugging tools, or as +the source for filters which ignore the input data (for example the sox +synth filter). +

+

This source accepts the following options: +

+
+
channel_layout, cl
+
+

Specifies the channel layout, and can be either an integer or a string +representing a channel layout. The default value of channel_layout +is "stereo". +

+

Check the channel_layout_map definition in +libavutil/channel_layout.c for the mapping between strings and +channel layout values. +

+
+
sample_rate, r
+

Specifies the sample rate, and defaults to 44100. +

+
+
nb_samples, n
+

Set the number of samples per requested frames. +

+
+
+ + +

37.4.1 Examples

+ +
    +
  • Set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO. +
    +
    anullsrc=r=48000:cl=4
+
    + +
  • Do the same operation with a more obvious syntax: +
    +
    anullsrc=r=48000:cl=mono
+
    +
+ +

All the parameters need to be explicitly defined. +

+ +

37.5 flite

+ +

Synthesize a voice utterance using the libflite library. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libflite. +

+

Note that versions of the flite library prior to 2.0 are not thread-safe. +

+

The filter accepts the following options: +

+
+
list_voices
+

If set to 1, list the names of the available voices and exit +immediately. Default value is 0. +

+
+
nb_samples, n
+

Set the maximum number of samples per frame. Default value is 512. +

+
+
textfile
+

Set the filename containing the text to speak. +

+
+
text
+

Set the text to speak. +

+
+
voice, v
+

Set the voice to use for the speech synthesis. Default value is +kal. See also the list_voices option. +

+
+ + +

37.5.1 Examples

+ +
    +
  • Read from file speech.txt, and synthesize the text using the +standard flite voice: +
    +
    flite=textfile=speech.txt
+
    + +
  • Read the specified text selecting the slt voice: +
    +
    flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
+
    + +
  • Input text to ffmpeg: +
    +
    ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
+
    + +
  • Make ffplay speak the specified text, using flite and +the lavfi device: +
    +
    ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
+
    +
+ +

For more information about libflite, check: +http://www.festvox.org/flite/ +

+ +

37.6 anoisesrc

+ +

Generate a noise audio signal. +

+

The filter accepts the following options: +

+
+
sample_rate, r
+

Specify the sample rate. Default value is 48000 Hz. +

+
+
amplitude, a
+

Specify the amplitude (0.0 - 1.0) of the generated audio stream. Default value +is 1.0. +

+
+
duration, d
+

Specify the duration of the generated audio stream. Not specifying this option +results in noise with an infinite length. +

+
+
color, colour, c
+

Specify the color of noise. Available noise colors are white, pink, brown, +blue, violet and velvet. Default color is white. +

+
+
seed, s
+

Specify a value used to seed the PRNG. +

+
+
nb_samples, n
+

Set the number of samples per each output frame, default is 1024. +

+
+ + +

37.6.1 Examples

+ +
    +
  • Generate 60 seconds of pink noise, with a 44.1 kHz sampling rate and an amplitude of 0.5: +
    +
    anoisesrc=d=60:c=pink:r=44100:a=0.5
+
    +
+ + +

37.7 hilbert

+ +

Generate odd-tap Hilbert transform FIR coefficients. +

+

The resulting stream can be used with afir filter for phase-shifting +the signal by 90 degrees. +

+

This is used in many matrix coding schemes and for analytic signal generation. +The process is often written as a multiplication by i (or j), the imaginary unit. +

+

The filter accepts the following options: +

+
+
sample_rate, s
+

Set sample rate, default is 44100. +

+
+
taps, t
+

Set length of FIR filter, default is 22051. +

+
+
nb_samples, n
+

Set number of samples per each frame. +

+
+
win_func, w
+

Set window function to be used when generating FIR coefficients. +

+
+ + +

37.8 sinc

+ +

Generate a sinc kaiser-windowed low-pass, high-pass, band-pass, or band-reject FIR coefficients. +

+

The resulting stream can be used with afir filter for filtering the audio signal. +

+

The filter accepts the following options: +

+
+
sample_rate, r
+

Set sample rate, default is 44100. +

+
+
nb_samples, n
+

Set number of samples per each frame. Default is 1024. +

+
+
hp
+

Set high-pass frequency. Default is 0. +

+
+
lp
+

Set low-pass frequency. Default is 0. +If high-pass frequency is lower than low-pass frequency and low-pass frequency +is higher than 0 then filter will create band-pass filter coefficients, +otherwise band-reject filter coefficients. +

+
+
phase
+

Set filter phase response. Default is 50. Allowed range is from 0 to 100. +

+
+
beta
+

Set Kaiser window beta. +

+
+
att
+

Set stop-band attenuation. Default is 120dB, allowed range is from 40 to 180 dB. +

+
+
round
+

Enable rounding, by default is disabled. +

+
+
hptaps
+

Set number of taps for high-pass filter. +

+
+
lptaps
+

Set number of taps for low-pass filter. +

+
+ + +

37.9 sine

+ +

Generate an audio signal made of a sine wave with amplitude 1/8. +

+

The audio signal is bit-exact. +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the carrier frequency. Default is 440 Hz. +

+
+
beep_factor, b
+

Enable a periodic beep every second with frequency beep_factor times +the carrier frequency. Default is 0, meaning the beep is disabled. +

+
+
sample_rate, r
+

Specify the sample rate, default is 44100. +

+
+
duration, d
+

Specify the duration of the generated audio stream. +

+
+
samples_per_frame
+

Set the number of samples per output frame. +

+

The expression can contain the following constants: +

+
+
n
+

The (sequential) number of the output audio frame, starting from 0. +

+
+
pts
+

The PTS (Presentation TimeStamp) of the output audio frame, +expressed in TB units. +

+
+
t
+

The PTS of the output audio frame, expressed in seconds. +

+
+
TB
+

The timebase of the output audio frames. +

+
+ +

Default is 1024. +

+
+ + +

37.9.1 Examples

+ +
    +
  • Generate a simple 440 Hz sine wave: +
    +
    sine
+
    + +
  • Generate a 220 Hz sine wave with a 880 Hz beep each second, for 5 seconds: +
    +
    sine=220:4:d=5
+sine=f=220:b=4:d=5
+sine=frequency=220:beep_factor=4:duration=5
+
    + +
  • Generate a 1 kHz sine wave following 1602,1601,1602,1601,1602 NTSC +pattern: +
    +
    sine=1000:samples_per_frame='st(0,mod(n,5)); 1602-not(not(eq(ld(0),1)+eq(ld(0),3)))'
+
    +
+ + + +

38 Audio Sinks

+ +

Below is a description of the currently available audio sinks. +

+ +

38.1 abuffersink

+ +

Buffer audio frames, and make them available to the end of filter chain. +

+

This sink is mainly intended for programmatic use, in particular +through the interface defined in libavfilter/buffersink.h +or the options system. +

+

It accepts a pointer to an AVABufferSinkContext structure, which +defines the incoming buffers’ formats, to be passed as the opaque +parameter to avfilter_init_filter for initialization. +

+

38.2 anullsink

+ +

Null audio sink; do absolutely nothing with the input audio. It is +mainly useful as a template and for use in analysis / debugging +tools. +

+ + +

39 Video Filters

+ +

When you configure your FFmpeg build, you can disable any of the +existing filters using --disable-filters. +The configure output will show the video filters included in your +build. +

+

Below is a description of the currently available video filters. +

+ +

39.1 addroi

+ +

Mark a region of interest in a video frame. +

+

The frame data is passed through unchanged, but metadata is attached +to the frame indicating regions of interest which can affect the +behaviour of later encoding. Multiple regions can be marked by +applying the filter multiple times. +

+
+
x
+

Region distance in pixels from the left edge of the frame. +

+
y
+

Region distance in pixels from the top edge of the frame. +

+
w
+

Region width in pixels. +

+
h
+

Region height in pixels. +

+

The parameters x, y, w and h are expressions, +and may contain the following variables: +

+
iw
+

Width of the input frame. +

+
ih
+

Height of the input frame. +

+
+ +
+
qoffset
+

Quantisation offset to apply within the region. +

+

This must be a real value in the range -1 to +1. A value of zero +indicates no quality change. A negative value asks for better quality +(less quantisation), while a positive value asks for worse quality +(greater quantisation). +

+

The range is calibrated so that the extreme values indicate the +largest possible offset - if the rest of the frame is encoded with the +worst possible quality, an offset of -1 indicates that this region +should be encoded with the best possible quality anyway. Intermediate +values are then interpolated in some codec-dependent way. +

+

For example, in 10-bit H.264 the quantisation parameter varies between +-12 and 51. A typical qoffset value of -1/10 therefore indicates that +this region should be encoded with a QP around one-tenth of the full +range better than the rest of the frame. So, if most of the frame +were to be encoded with a QP of around 30, this region would get a QP +of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3). +An extreme value of -1 would indicate that this region should be +encoded with the best possible quality regardless of the treatment of +the rest of the frame - that is, should be encoded at a QP of -12. +

+
clear
+

If set to true, remove any existing regions of interest marked on the +frame before adding the new one. +

+
+ + +

39.1.1 Examples

+ +
    +
  • Mark the centre quarter of the frame as interesting. +
    +
    addroi=iw/4:ih/4:iw/2:ih/2:-1/10
+
    +
  • Mark the 100-pixel-wide region on the left edge of the frame as very +uninteresting (to be encoded at much lower quality than the rest of +the frame). +
    +
    addroi=0:0:100:ih:+1/5
+
    +
+ + +

39.2 alphaextract

+ +

Extract the alpha component from the input as a grayscale video. This +is especially useful with the alphamerge filter. +

+ +

39.3 alphamerge

+ +

Add or replace the alpha component of the primary input with the +grayscale value of a second input. This is intended for use with +alphaextract to allow the transmission or storage of frame +sequences that have alpha in a format that doesn’t support an alpha +channel. +

+

For example, to reconstruct full frames from a normal YUV-encoded video +and a separate video created with alphaextract, you might use: +

+
movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
+
+ +

Since this filter is designed for reconstruction, it operates on frame +sequences without considering timestamps, and terminates when either +input reaches end of stream. This will cause problems if your encoding +pipeline drops frames. If you’re trying to apply an image as an +overlay to a video stream, consider the overlay filter instead. +

+ +

39.4 amplify

+ +

Amplify differences between current pixel and pixels of adjacent frames in +same pixel location. +

+

This filter accepts the following options: +

+
+
radius
+

Set frame radius. Default is 2. Allowed range is from 1 to 63. +For example radius of 3 will instruct filter to calculate average of 7 frames. +

+
+
factor
+

Set factor to amplify difference. Default is 2. Allowed range is from 0 to 65535. +

+
+
threshold
+

Set threshold for difference amplification. Any difference greater or equal to +this value will not alter source pixel. Default is 10. +Allowed range is from 0 to 65535. +

+
+
tolerance
+

Set tolerance for difference amplification. Any difference lower to +this value will not alter source pixel. Default is 0. +Allowed range is from 0 to 65535. +

+
+
low
+

Set lower limit for changing source pixel. Default is 65535. Allowed range is from 0 to 65535. +This option controls maximum possible value that will decrease source pixel value. +

+
+
high
+

Set high limit for changing source pixel. Default is 65535. Allowed range is from 0 to 65535. +This option controls maximum possible value that will increase source pixel value. +

+
+
planes
+

Set which planes to filter. Default is all. Allowed range is from 0 to 15. +

+
+ + +

39.4.1 Commands

+ +

This filter supports the following commands that corresponds to option of same name: +

+
factor
+
threshold
+
tolerance
+
low
+
high
+
planes
+
+ + +

39.5 ass

+ +

Same as the subtitles filter, except that it doesn’t require libavcodec +and libavformat to work. On the other hand, it is limited to ASS (Advanced +Substation Alpha) subtitles files. +

+

This filter accepts the following option in addition to the common options from +the subtitles filter: +

+
+
shaping
+

Set the shaping engine +

+

Available values are: +

+
‘auto’
+

The default libass shaping engine, which is the best available. +

+
‘simple’
+

Fast, font-agnostic shaper that can do only substitutions +

+
‘complex’
+

Slower shaper using OpenType for substitutions and positioning +

+
+ +

The default is auto. +

+
+ + +

39.6 atadenoise

+

Apply an Adaptive Temporal Averaging Denoiser to the video input. +

+

The filter accepts the following options: +

+
+
0a
+

Set threshold A for 1st plane. Default is 0.02. +Valid range is 0 to 0.3. +

+
+
0b
+

Set threshold B for 1st plane. Default is 0.04. +Valid range is 0 to 5. +

+
+
1a
+

Set threshold A for 2nd plane. Default is 0.02. +Valid range is 0 to 0.3. +

+
+
1b
+

Set threshold B for 2nd plane. Default is 0.04. +Valid range is 0 to 5. +

+
+
2a
+

Set threshold A for 3rd plane. Default is 0.02. +Valid range is 0 to 0.3. +

+
+
2b
+

Set threshold B for 3rd plane. Default is 0.04. +Valid range is 0 to 5. +

+

Threshold A is designed to react on abrupt changes in the input signal and +threshold B is designed to react on continuous changes in the input signal. +

+
+
s
+

Set number of frames filter will use for averaging. Default is 9. Must be odd +number in range [5, 129]. +

+
+
p
+

Set what planes of frame filter will use for averaging. Default is all. +

+
+
a
+

Set what variant of algorithm filter will use for averaging. Default is p parallel. +Alternatively can be set to s serial. +

+

Parallel can be faster then serial, while other way around is never true. +Parallel will abort early on first change being greater then thresholds, while serial +will continue processing other side of frames if they are equal or bellow thresholds. +

+
+ + +

39.6.1 Commands

+

This filter supports same commands as options except option s. +The command accepts the same syntax of the corresponding option. +

+ +

39.7 avgblur

+ +

Apply average blur filter. +

+

The filter accepts the following options: +

+
+
sizeX
+

Set horizontal radius size. +

+
+
planes
+

Set which planes to filter. By default all planes are filtered. +

+
+
sizeY
+

Set vertical radius size, if zero it will be same as sizeX. +Default is 0. +

+
+ + +

39.7.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.8 bbox

+ +

Compute the bounding box for the non-black pixels in the input frame +luminance plane. +

+

This filter computes the bounding box containing all the pixels with a +luminance value greater than the minimum allowed value. +The parameters describing the bounding box are printed on the filter +log. +

+

The filter accepts the following option: +

+
+
min_val
+

Set the minimal luminance value. Default is 16. +

+
+ + +

39.9 bilateral

+

Apply bilateral filter, spatial smoothing while preserving edges. +

+

The filter accepts the following options: +

+
sigmaS
+

Set sigma of gaussian function to calculate spatial weight. +Allowed range is 0 to 10. Default is 0.1. +

+
+
sigmaR
+

Set sigma of gaussian function to calculate range weight. +Allowed range is 0 to 1. Default is 0.1. +

+
+
planes
+

Set planes to filter. Default is first only. +

+
+ + +

39.10 bitplanenoise

+ +

Show and measure bit plane noise. +

+

The filter accepts the following options: +

+
+
bitplane
+

Set which plane to analyze. Default is 1. +

+
+
filter
+

Filter out noisy pixels from bitplane set above. +Default is disabled. +

+
+ + +

39.11 blackdetect

+ +

Detect video intervals that are (almost) completely black. Can be +useful to detect chapter transitions, commercials, or invalid +recordings. +

+

The filter outputs its detection analysis to both the log as well as +frame metadata. If a black segment of at least the specified minimum +duration is found, a line with the start and end timestamps as well +as duration is printed to the log with level info. In addition, +a log line with level debug is printed per frame showing the +black amount detected for that frame. +

+

The filter also attaches metadata to the first frame of a black +segment with key lavfi.black_start and to the first frame +after the black segment ends with key lavfi.black_end. The +value is the frame’s timestamp. This metadata is added regardless +of the minimum duration specified. +

+

The filter accepts the following options: +

+
+
black_min_duration, d
+

Set the minimum detected black duration expressed in seconds. It must +be a non-negative floating point number. +

+

Default value is 2.0. +

+
+
picture_black_ratio_th, pic_th
+

Set the threshold for considering a picture "black". +Express the minimum value for the ratio: +

+
nb_black_pixels / nb_pixels
+
+ +

for which a picture is considered black. +Default value is 0.98. +

+
+
pixel_black_th, pix_th
+

Set the threshold for considering a pixel "black". +

+

The threshold expresses the maximum pixel luminance value for which a +pixel is considered "black". The provided value is scaled according to +the following equation: +

+
absolute_threshold = luminance_minimum_value + pixel_black_th * luminance_range_size
+
+ +

luminance_range_size and luminance_minimum_value depend on +the input video format, the range is [0-255] for YUV full-range +formats and [16-235] for YUV non full-range formats. +

+

Default value is 0.10. +

+
+ +

The following example sets the maximum pixel threshold to the minimum +value, and detects only black intervals of 2 or more seconds: +

+
blackdetect=d=2:pix_th=0.00
+
+ + +

39.12 blackframe

+ +

Detect frames that are (almost) completely black. Can be useful to +detect chapter transitions or commercials. Output lines consist of +the frame number of the detected frame, the percentage of blackness, +the position in the file if known or -1 and the timestamp in seconds. +

+

In order to display the output lines, you need to set the loglevel at +least to the AV_LOG_INFO value. +

+

This filter exports frame metadata lavfi.blackframe.pblack. +The value represents the percentage of pixels in the picture that +are below the threshold value. +

+

It accepts the following parameters: +

+
+
amount
+

The percentage of the pixels that have to be below the threshold; it defaults to +98. +

+
+
threshold, thresh
+

The threshold below which a pixel value is considered black; it defaults to +32. +

+
+
+ + +

39.13 blend

+ +

Blend two video frames into each other. +

+

The blend filter takes two input streams and outputs one +stream, the first input is the "top" layer and second input is +"bottom" layer. By default, the output terminates when the longest input terminates. +

+

The tblend (time blend) filter takes two consecutive frames +from one single stream, and outputs the result obtained by blending +the new frame on top of the old frame. +

+

A description of the accepted options follows. +

+
+
c0_mode
+
c1_mode
+
c2_mode
+
c3_mode
+
all_mode
+

Set blend mode for specific pixel component or all pixel components in case +of all_mode. Default value is normal. +

+

Available values for component modes are: +

+
‘addition’
+
‘grainmerge’
+
‘and’
+
‘average’
+
‘burn’
+
‘darken’
+
‘difference’
+
‘grainextract’
+
‘divide’
+
‘dodge’
+
‘freeze’
+
‘exclusion’
+
‘extremity’
+
‘glow’
+
‘hardlight’
+
‘hardmix’
+
‘heat’
+
‘lighten’
+
‘linearlight’
+
‘multiply’
+
‘multiply128’
+
‘negation’
+
‘normal’
+
‘or’
+
‘overlay’
+
‘phoenix’
+
‘pinlight’
+
‘reflect’
+
‘screen’
+
‘softlight’
+
‘subtract’
+
‘vividlight’
+
‘xor’
+
+ +
+
c0_opacity
+
c1_opacity
+
c2_opacity
+
c3_opacity
+
all_opacity
+

Set blend opacity for specific pixel component or all pixel components in case +of all_opacity. Only used in combination with pixel component blend modes. +

+
+
c0_expr
+
c1_expr
+
c2_expr
+
c3_expr
+
all_expr
+

Set blend expression for specific pixel component or all pixel components in case +of all_expr. Note that related mode options will be ignored if those are set. +

+

The expressions can use the following variables: +

+
+
N
+

The sequential number of the filtered frame, starting from 0. +

+
+
X
+
Y
+

the coordinates of the current sample +

+
+
W
+
H
+

the width and height of currently filtered plane +

+
+
SW
+
SH
+

Width and height scale for the plane being filtered. It is the +ratio between the dimensions of the current plane to the luma plane, +e.g. for a yuv420p frame, the values are 1,1 for +the luma plane and 0.5,0.5 for the chroma planes. +

+
+
T
+

Time of the current frame, expressed in seconds. +

+
+
TOP, A
+

Value of pixel component at current location for first video frame (top layer). +

+
+
BOTTOM, B
+

Value of pixel component at current location for second video frame (bottom layer). +

+
+
+
+ +

The blend filter also supports the framesync options. +

+ +

39.13.1 Examples

+ +
    +
  • Apply transition from bottom layer to top layer in first 10 seconds: +
    +
    blend=all_expr='A*(if(gte(T,10),1,T/10))+B*(1-(if(gte(T,10),1,T/10)))'
+
    + +
  • Apply linear horizontal transition from top layer to bottom layer: +
    +
    blend=all_expr='A*(X/W)+B*(1-X/W)'
+
    + +
  • Apply 1x1 checkerboard effect: +
    +
    blend=all_expr='if(eq(mod(X,2),mod(Y,2)),A,B)'
+
    + +
  • Apply uncover left effect: +
    +
    blend=all_expr='if(gte(N*SW+X,W),A,B)'
+
    + +
  • Apply uncover down effect: +
    +
    blend=all_expr='if(gte(Y-N*SH,0),A,B)'
+
    + +
  • Apply uncover up-left effect: +
    +
    blend=all_expr='if(gte(T*SH*40+Y,H)*gte((T*40*SW+X)*W/H,W),A,B)'
+
    + +
  • Split diagonally video and shows top and bottom layer on each side: +
    +
    blend=all_expr='if(gt(X,Y*(W/H)),A,B)'
+
    + +
  • Display differences between the current and the previous frame: +
    +
    tblend=all_mode=grainextract
+
    +
+ + +

39.14 bm3d

+ +

Denoise frames using Block-Matching 3D algorithm. +

+

The filter accepts the following options. +

+
+
sigma
+

Set denoising strength. Default value is 1. +Allowed range is from 0 to 999.9. +The denoising algorithm is very sensitive to sigma, so adjust it +according to the source. +

+
+
block
+

Set local patch size. This sets dimensions in 2D. +

+
+
bstep
+

Set sliding step for processing blocks. Default value is 4. +Allowed range is from 1 to 64. +Smaller values allows processing more reference blocks and is slower. +

+
+
group
+

Set maximal number of similar blocks for 3rd dimension. Default value is 1. +When set to 1, no block matching is done. Larger values allows more blocks +in single group. +Allowed range is from 1 to 256. +

+
+
range
+

Set radius for search block matching. Default is 9. +Allowed range is from 1 to INT32_MAX. +

+
+
mstep
+

Set step between two search locations for block matching. Default is 1. +Allowed range is from 1 to 64. Smaller is slower. +

+
+
thmse
+

Set threshold of mean square error for block matching. Valid range is 0 to +INT32_MAX. +

+
+
hdthr
+

Set thresholding parameter for hard thresholding in 3D transformed domain. +Larger values results in stronger hard-thresholding filtering in frequency +domain. +

+
+
estim
+

Set filtering estimation mode. Can be basic or final. +Default is basic. +

+
+
ref
+

If enabled, filter will use 2nd stream for block matching. +Default is disabled for basic value of estim option, +and always enabled if value of estim is final. +

+
+
planes
+

Set planes to filter. Default is all available except alpha. +

+
+ + +

39.14.1 Examples

+ +
    +
  • Basic filtering with bm3d: +
    +
    bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic
+
    + +
  • Same as above, but filtering only luma: +
    +
    bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic:planes=1
+
    + +
  • Same as above, but with both estimation modes: +
    +
    split[a][b],[a]bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic[a],[b][a]bm3d=sigma=3:block=4:bstep=2:group=16:estim=final:ref=1
+
    + +
  • Same as above, but prefilter with nlmeans filter instead: +
    +
    split[a][b],[a]nlmeans=s=3:r=7:p=3[a],[b][a]bm3d=sigma=3:block=4:bstep=2:group=16:estim=final:ref=1
+
    +
+ + +

39.15 boxblur

+ +

Apply a boxblur algorithm to the input video. +

+

It accepts the following parameters: +

+
+
luma_radius, lr
+
luma_power, lp
+
chroma_radius, cr
+
chroma_power, cp
+
alpha_radius, ar
+
alpha_power, ap
+
+ +

A description of the accepted options follows. +

+
+
luma_radius, lr
+
chroma_radius, cr
+
alpha_radius, ar
+

Set an expression for the box radius in pixels used for blurring the +corresponding input plane. +

+

The radius value must be a non-negative number, and must not be +greater than the value of the expression min(w,h)/2 for the +luma and alpha planes, and of min(cw,ch)/2 for the chroma +planes. +

+

Default value for luma_radius is "2". If not specified, +chroma_radius and alpha_radius default to the +corresponding value set for luma_radius. +

+

The expressions can contain the following constants: +

+
w
+
h
+

The input width and height in pixels. +

+
+
cw
+
ch
+

The input chroma image width and height in pixels. +

+
+
hsub
+
vsub
+

The horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p", hsub is 2 and vsub is 1. +

+
+ +
+
luma_power, lp
+
chroma_power, cp
+
alpha_power, ap
+

Specify how many times the boxblur filter is applied to the +corresponding plane. +

+

Default value for luma_power is 2. If not specified, +chroma_power and alpha_power default to the +corresponding value set for luma_power. +

+

A value of 0 will disable the effect. +

+
+ + +

39.15.1 Examples

+ +
    +
  • Apply a boxblur filter with the luma, chroma, and alpha radii +set to 2: +
    +
    boxblur=luma_radius=2:luma_power=1
+boxblur=2:1
+
    + +
  • Set the luma radius to 2, and alpha and chroma radius to 0: +
    +
    boxblur=2:1:cr=0:ar=0
+
    + +
  • Set the luma and chroma radii to a fraction of the video dimension: +
    +
    boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
+
    +
+ + +

39.16 bwdif

+ +

Deinterlace the input video ("bwdif" stands for "Bob Weaver +Deinterlacing Filter"). +

+

Motion adaptive deinterlacing based on yadif with the use of w3fdif and cubic +interpolation algorithms. +It accepts the following parameters: +

+
+
mode
+

The interlacing mode to adopt. It accepts one of the following values: +

+
+
0, send_frame
+

Output one frame for each frame. +

+
1, send_field
+

Output one frame for each field. +

+
+ +

The default value is send_field. +

+
+
parity
+

The picture field parity assumed for the input interlaced video. It accepts one +of the following values: +

+
+
0, tff
+

Assume the top field is first. +

+
1, bff
+

Assume the bottom field is first. +

+
-1, auto
+

Enable automatic detection of field parity. +

+
+ +

The default value is auto. +If the interlacing is unknown or the decoder does not export this information, +top field first will be assumed. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following +values: +

+
+
0, all
+

Deinterlace all frames. +

+
1, interlaced
+

Only deinterlace frames marked as interlaced. +

+
+ +

The default value is all. +

+
+ + +

39.17 cas

+ +

Apply Contrast Adaptive Sharpen filter to video stream. +

+

The filter accepts the following options: +

+
+
strength
+

Set the sharpening strength. Default value is 0. +

+
+
planes
+

Set planes to filter. Default value is to filter all +planes except alpha plane. +

+
+ + +

39.18 chromahold

+

Remove all color information for all colors except for certain one. +

+

The filter accepts the following options: +

+
+
color
+

The color which will not be replaced with neutral chroma. +

+
+
similarity
+

Similarity percentage with the above color. +0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +0.0 makes pixels either fully gray, or not gray at all. +Higher values result in more preserved color. +

+
+
yuv
+

Signals that the color passed is already in YUV instead of RGB. +

+

Literal colors like "green" or "red" don’t make sense with this enabled anymore. +This can be used to pass exact YUV values as hexadecimal numbers. +

+
+ + +

39.18.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.19 chromakey

+

YUV colorspace color/chroma keying. +

+

The filter accepts the following options: +

+
+
color
+

The color which will be replaced with transparency. +

+
+
similarity
+

Similarity percentage with the key color. +

+

0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +

+

0.0 makes pixels either fully transparent, or not transparent at all. +

+

Higher values result in semi-transparent pixels, with a higher transparency +the more similar the pixels color is to the key color. +

+
+
yuv
+

Signals that the color passed is already in YUV instead of RGB. +

+

Literal colors like "green" or "red" don’t make sense with this enabled anymore. +This can be used to pass exact YUV values as hexadecimal numbers. +

+
+ + +

39.19.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.19.2 Examples

+ +
    +
  • Make every green pixel in the input image transparent: +
    +
    ffmpeg -i input.png -vf chromakey=green out.png
+
    + +
  • Overlay a greenscreen-video on top of a static black background. +
    +
    ffmpeg -f lavfi -i color=c=black:s=1280x720 -i video.mp4 -shortest -filter_complex "[1:v]chromakey=0x70de77:0.1:0.2[ckout];[0:v][ckout]overlay[out]" -map "[out]" output.mkv
+
    +
+ + +

39.20 chromashift

+

Shift chroma pixels horizontally and/or vertically. +

+

The filter accepts the following options: +

+
cbh
+

Set amount to shift chroma-blue horizontally. +

+
cbv
+

Set amount to shift chroma-blue vertically. +

+
crh
+

Set amount to shift chroma-red horizontally. +

+
crv
+

Set amount to shift chroma-red vertically. +

+
edge
+

Set edge mode, can be smear, default, or warp. +

+
+ + +

39.20.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

39.21 ciescope

+ +

Display CIE color diagram with pixels overlaid onto it. +

+

The filter accepts the following options: +

+
+
system
+

Set color system. +

+
+
‘ntsc, 470m’
+
‘ebu, 470bg’
+
‘smpte’
+
‘240m’
+
‘apple’
+
‘widergb’
+
‘cie1931’
+
‘rec709, hdtv’
+
‘uhdtv, rec2020’
+
‘dcip3’
+
+ +
+
cie
+

Set CIE system. +

+
+
‘xyy’
+
‘ucs’
+
‘luv’
+
+ +
+
gamuts
+

Set what gamuts to draw. +

+

See system option for available values. +

+
+
size, s
+

Set ciescope size, by default set to 512. +

+
+
intensity, i
+

Set intensity used to map input pixel values to CIE diagram. +

+
+
contrast
+

Set contrast used to draw tongue colors that are out of active color system gamut. +

+
+
corrgamma
+

Correct gamma displayed on scope, by default enabled. +

+
+
showwhite
+

Show white point on CIE diagram, by default disabled. +

+
+
gamma
+

Set input gamma. Used only with XYZ input color space. +

+
+ + +

39.22 codecview

+ +

Visualize information exported by some codecs. +

+

Some codecs can export information through frames using side-data or other +means. For example, some MPEG based codecs export motion vectors through the +export_mvs flag in the codec flags2 option. +

+

The filter accepts the following option: +

+
+
mv
+

Set motion vectors to visualize. +

+

Available flags for mv are: +

+
+
‘pf’
+

forward predicted MVs of P-frames +

+
‘bf’
+

forward predicted MVs of B-frames +

+
‘bb’
+

backward predicted MVs of B-frames +

+
+ +
+
qp
+

Display quantization parameters using the chroma planes. +

+
+
mv_type, mvt
+

Set motion vectors type to visualize. Includes MVs from all frames unless specified by frame_type option. +

+

Available flags for mv_type are: +

+
+
‘fp’
+

forward predicted MVs +

+
‘bp’
+

backward predicted MVs +

+
+ +
+
frame_type, ft
+

Set frame type to visualize motion vectors of. +

+

Available flags for frame_type are: +

+
+
‘if’
+

intra-coded frames (I-frames) +

+
‘pf’
+

predicted frames (P-frames) +

+
‘bf’
+

bi-directionally predicted frames (B-frames) +

+
+
+
+ + +

39.22.1 Examples

+ +
    +
  • Visualize forward predicted MVs of all frames using ffplay: +
    +
    ffplay -flags2 +export_mvs input.mp4 -vf codecview=mv_type=fp
+
    + +
  • Visualize multi-directionals MVs of P and B-Frames using ffplay: +
    +
    ffplay -flags2 +export_mvs input.mp4 -vf codecview=mv=pf+bf+bb
+
    +
+ + +

39.23 colorbalance

+

Modify intensity of primary colors (red, green and blue) of input frames. +

+

The filter allows an input frame to be adjusted in the shadows, midtones or highlights +regions for the red-cyan, green-magenta or blue-yellow balance. +

+

A positive adjustment value shifts the balance towards the primary color, a negative +value towards the complementary color. +

+

The filter accepts the following options: +

+
+
rs
+
gs
+
bs
+

Adjust red, green and blue shadows (darkest pixels). +

+
+
rm
+
gm
+
bm
+

Adjust red, green and blue midtones (medium pixels). +

+
+
rh
+
gh
+
bh
+

Adjust red, green and blue highlights (brightest pixels). +

+

Allowed ranges for options are [-1.0, 1.0]. Defaults are 0. +

+
+
pl
+

Preserve lightness when changing color balance. Default is disabled. +

+
+ + +

39.23.1 Examples

+ +
    +
  • Add red color cast to shadows: +
    +
    colorbalance=rs=.3
+
    +
+ + +

39.23.2 Commands

+ +

This filter supports the all above options as commands. +

+ +

39.24 colorchannelmixer

+ +

Adjust video input frames by re-mixing color channels. +

+

This filter modifies a color channel by adding the values associated to +the other channels of the same pixels. For example if the value to +modify is red, the output value will be: +

+
red=red*rr + blue*rb + green*rg + alpha*ra
+
+ +

The filter accepts the following options: +

+
+
rr
+
rg
+
rb
+
ra
+

Adjust contribution of input red, green, blue and alpha channels for output red channel. +Default is 1 for rr, and 0 for rg, rb and ra. +

+
+
gr
+
gg
+
gb
+
ga
+

Adjust contribution of input red, green, blue and alpha channels for output green channel. +Default is 1 for gg, and 0 for gr, gb and ga. +

+
+
br
+
bg
+
bb
+
ba
+

Adjust contribution of input red, green, blue and alpha channels for output blue channel. +Default is 1 for bb, and 0 for br, bg and ba. +

+
+
ar
+
ag
+
ab
+
aa
+

Adjust contribution of input red, green, blue and alpha channels for output alpha channel. +Default is 1 for aa, and 0 for ar, ag and ab. +

+

Allowed ranges for options are [-2.0, 2.0]. +

+
+ + +

39.24.1 Examples

+ +
    +
  • Convert source to grayscale: +
    +
    colorchannelmixer=.3:.4:.3:0:.3:.4:.3:0:.3:.4:.3
+
    +
  • Simulate sepia tones: +
    +
    colorchannelmixer=.393:.769:.189:0:.349:.686:.168:0:.272:.534:.131
+
    +
+ + +

39.24.2 Commands

+ +

This filter supports the all above options as commands. +

+ +

39.25 colorkey

+

RGB colorspace color keying. +

+

The filter accepts the following options: +

+
+
color
+

The color which will be replaced with transparency. +

+
+
similarity
+

Similarity percentage with the key color. +

+

0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +

+

0.0 makes pixels either fully transparent, or not transparent at all. +

+

Higher values result in semi-transparent pixels, with a higher transparency +the more similar the pixels color is to the key color. +

+
+ + +

39.25.1 Examples

+ +
    +
  • Make every green pixel in the input image transparent: +
    +
    ffmpeg -i input.png -vf colorkey=green out.png
+
    + +
  • Overlay a greenscreen-video on top of a static background image. +
    +
    ffmpeg -i background.png -i video.mp4 -filter_complex "[1:v]colorkey=0x3BBD1E:0.3:0.2[ckout];[0:v][ckout]overlay[out]" -map "[out]" output.flv
+
    +
+ + +

39.25.2 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.26 colorhold

+

Remove all color information for all RGB colors except for certain one. +

+

The filter accepts the following options: +

+
+
color
+

The color which will not be replaced with neutral gray. +

+
+
similarity
+

Similarity percentage with the above color. +0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. 0.0 makes pixels fully gray. +Higher values result in more preserved color. +

+
+ + +

39.26.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.27 colorlevels

+ +

Adjust video input frames using levels. +

+

The filter accepts the following options: +

+
+
rimin
+
gimin
+
bimin
+
aimin
+

Adjust red, green, blue and alpha input black point. +Allowed ranges for options are [-1.0, 1.0]. Defaults are 0. +

+
+
rimax
+
gimax
+
bimax
+
aimax
+

Adjust red, green, blue and alpha input white point. +Allowed ranges for options are [-1.0, 1.0]. Defaults are 1. +

+

Input levels are used to lighten highlights (bright tones), darken shadows +(dark tones), change the balance of bright and dark tones. +

+
+
romin
+
gomin
+
bomin
+
aomin
+

Adjust red, green, blue and alpha output black point. +Allowed ranges for options are [0, 1.0]. Defaults are 0. +

+
+
romax
+
gomax
+
bomax
+
aomax
+

Adjust red, green, blue and alpha output white point. +Allowed ranges for options are [0, 1.0]. Defaults are 1. +

+

Output levels allows manual selection of a constrained output level range. +

+
+ + +

39.27.1 Examples

+ +
    +
  • Make video output darker: +
    +
    colorlevels=rimin=0.058:gimin=0.058:bimin=0.058
+
    + +
  • Increase contrast: +
    +
    colorlevels=rimin=0.039:gimin=0.039:bimin=0.039:rimax=0.96:gimax=0.96:bimax=0.96
+
    + +
  • Make video output lighter: +
    +
    colorlevels=rimax=0.902:gimax=0.902:bimax=0.902
+
    + +
  • Increase brightness: +
    +
    colorlevels=romin=0.5:gomin=0.5:bomin=0.5
+
    +
+ + +

39.27.2 Commands

+ +

This filter supports the all above options as commands. +

+ +

39.28 colormatrix

+ +

Convert color matrix. +

+

The filter accepts the following options: +

+
+
src
+
dst
+

Specify the source and destination color matrix. Both values must be +specified. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘fcc’
+

FCC +

+
+
‘bt601’
+

BT.601 +

+
+
‘bt470’
+

BT.470 +

+
+
‘bt470bg’
+

BT.470BG +

+
+
‘smpte170m’
+

SMPTE-170M +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘bt2020’
+

BT.2020 +

+
+
+
+ +

For example to convert from BT.601 to SMPTE-240M, use the command: +

+
colormatrix=bt601:smpte240m
+
+ + +

39.29 colorspace

+ +

Convert colorspace, transfer characteristics or color primaries. +Input video needs to have an even size. +

+

The filter accepts the following options: +

+
+
+
all
+

Specify all color properties at once. +

+

The accepted values are: +

+
‘bt470m’
+

BT.470M +

+
+
‘bt470bg’
+

BT.470BG +

+
+
‘bt601-6-525’
+

BT.601-6 525 +

+
+
‘bt601-6-625’
+

BT.601-6 625 +

+
+
‘bt709’
+

BT.709 +

+
+
‘smpte170m’
+

SMPTE-170M +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘bt2020’
+

BT.2020 +

+
+
+ +
+
space
+

Specify output colorspace. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘fcc’
+

FCC +

+
+
‘bt470bg’
+

BT.470BG or BT.601-6 625 +

+
+
‘smpte170m’
+

SMPTE-170M or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘ycgco’
+

YCgCo +

+
+
‘bt2020ncl’
+

BT.2020 with non-constant luminance +

+
+
+ +
+
trc
+

Specify output transfer characteristics. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘bt470m’
+

BT.470M +

+
+
‘bt470bg’
+

BT.470BG +

+
+
‘gamma22’
+

Constant gamma of 2.2 +

+
+
‘gamma28’
+

Constant gamma of 2.8 +

+
+
‘smpte170m’
+

SMPTE-170M, BT.601-6 625 or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘srgb’
+

SRGB +

+
+
‘iec61966-2-1’
+

iec61966-2-1 +

+
+
‘iec61966-2-4’
+

iec61966-2-4 +

+
+
‘xvycc’
+

xvycc +

+
+
‘bt2020-10’
+

BT.2020 for 10-bits content +

+
+
‘bt2020-12’
+

BT.2020 for 12-bits content +

+
+
+ +
+
primaries
+

Specify output color primaries. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘bt470m’
+

BT.470M +

+
+
‘bt470bg’
+

BT.470BG or BT.601-6 625 +

+
+
‘smpte170m’
+

SMPTE-170M or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘film’
+

film +

+
+
‘smpte431’
+

SMPTE-431 +

+
+
‘smpte432’
+

SMPTE-432 +

+
+
‘bt2020’
+

BT.2020 +

+
+
‘jedec-p22’
+

JEDEC P22 phosphors +

+
+
+ +
+
range
+

Specify output color range. +

+

The accepted values are: +

+
‘tv’
+

TV (restricted) range +

+
+
‘mpeg’
+

MPEG (restricted) range +

+
+
‘pc’
+

PC (full) range +

+
+
‘jpeg’
+

JPEG (full) range +

+
+
+ +
+
format
+

Specify output color format. +

+

The accepted values are: +

+
‘yuv420p’
+

YUV 4:2:0 planar 8-bits +

+
+
‘yuv420p10’
+

YUV 4:2:0 planar 10-bits +

+
+
‘yuv420p12’
+

YUV 4:2:0 planar 12-bits +

+
+
‘yuv422p’
+

YUV 4:2:2 planar 8-bits +

+
+
‘yuv422p10’
+

YUV 4:2:2 planar 10-bits +

+
+
‘yuv422p12’
+

YUV 4:2:2 planar 12-bits +

+
+
‘yuv444p’
+

YUV 4:4:4 planar 8-bits +

+
+
‘yuv444p10’
+

YUV 4:4:4 planar 10-bits +

+
+
‘yuv444p12’
+

YUV 4:4:4 planar 12-bits +

+
+
+ +
+
fast
+

Do a fast conversion, which skips gamma/primary correction. This will take +significantly less CPU, but will be mathematically incorrect. To get output +compatible with that produced by the colormatrix filter, use fast=1. +

+
+
dither
+

Specify dithering mode. +

+

The accepted values are: +

+
‘none’
+

No dithering +

+
+
‘fsb’
+

Floyd-Steinberg dithering +

+
+ +
+
wpadapt
+

Whitepoint adaptation mode. +

+

The accepted values are: +

+
‘bradford’
+

Bradford whitepoint adaptation +

+
+
‘vonkries’
+

von Kries whitepoint adaptation +

+
+
‘identity’
+

identity whitepoint adaptation (i.e. no whitepoint adaptation) +

+
+ +
+
iall
+

Override all input properties at once. Same accepted values as all. +

+
+
ispace
+

Override input colorspace. Same accepted values as space. +

+
+
iprimaries
+

Override input color primaries. Same accepted values as primaries. +

+
+
itrc
+

Override input transfer characteristics. Same accepted values as trc. +

+
+
irange
+

Override input color range. Same accepted values as range. +

+
+
+ +

The filter converts the transfer characteristics, color space and color +primaries to the specified user values. The output value, if not specified, +is set to a default value based on the "all" property. If that property is +also not specified, the filter will log an error. The output color range and +format default to the same value as the input color range and format. The +input transfer characteristics, color space, color primaries and color range +should be set on the input data. If any of these are missing, the filter will +log an error and no conversion will take place. +

+

For example to convert the input to SMPTE-240M, use the command: +

+
colorspace=smpte240m
+
+ + +

39.30 convolution

+ +

Apply convolution of 3x3, 5x5, 7x7 or horizontal/vertical up to 49 elements. +

+

The filter accepts the following options: +

+
+
0m
+
1m
+
2m
+
3m
+

Set matrix for each plane. +Matrix is sequence of 9, 25 or 49 signed integers in square mode, +and from 1 to 49 odd number of signed integers in row mode. +

+
+
0rdiv
+
1rdiv
+
2rdiv
+
3rdiv
+

Set multiplier for calculated value for each plane. +If unset or 0, it will be sum of all matrix elements. +

+
+
0bias
+
1bias
+
2bias
+
3bias
+

Set bias for each plane. This value is added to the result of the multiplication. +Useful for making the overall image brighter or darker. Default is 0.0. +

+
+
0mode
+
1mode
+
2mode
+
3mode
+

Set matrix mode for each plane. Can be square, row or column. +Default is square. +

+
+ + +

39.30.1 Examples

+ +
    +
  • Apply sharpen: +
    +
    convolution="0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0"
+
    + +
  • Apply blur: +
    +
    convolution="1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1/9:1/9:1/9:1/9"
+
    + +
  • Apply edge enhance: +
    +
    convolution="0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:5:1:1:1:0:128:128:128"
+
    + +
  • Apply edge detect: +
    +
    convolution="0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:5:5:5:1:0:128:128:128"
+
    + +
  • Apply laplacian edge detector which includes diagonals: +
    +
    convolution="1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:5:5:5:1:0:128:128:0"
+
    + +
  • Apply emboss: +
    +
    convolution="-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2"
+
    +
+ + +

39.31 convolve

+ +

Apply 2D convolution of video stream in frequency domain using second stream +as impulse. +

+

The filter accepts the following options: +

+
+
planes
+

Set which planes to process. +

+
+
impulse
+

Set which impulse video frames will be processed, can be first +or all. Default is all. +

+
+ +

The convolve filter also supports the framesync options. +

+ +

39.32 copy

+ +

Copy the input video source unchanged to the output. This is mainly useful for +testing purposes. +

+ +

39.33 coreimage

+

Video filtering on GPU using Apple’s CoreImage API on OSX. +

+

Hardware acceleration is based on an OpenGL context. Usually, this means it is +processed by video hardware. However, software-based OpenGL implementations +exist which means there is no guarantee for hardware processing. It depends on +the respective OSX. +

+

There are many filters and image generators provided by Apple that come with a +large variety of options. The filter has to be referenced by its name along +with its options. +

+

The coreimage filter accepts the following options: +

+
list_filters
+

List all available filters and generators along with all their respective +options as well as possible minimum and maximum values along with the default +values. +

+
list_filters=true
+
+ +
+
filter
+

Specify all filters by their respective name and options. +Use list_filters to determine all valid filter names and options. +Numerical options are specified by a float value and are automatically clamped +to their respective value range. Vector and color options have to be specified +by a list of space separated float values. Character escaping has to be done. +A special option name default is available to use default options for a +filter. +

+

It is required to specify either default or at least one of the filter options. +All omitted options are used with their default values. +The syntax of the filter string is as follows: +

+
filter=<NAME>@<OPTION>=<VALUE>[@<OPTION>=<VALUE>][@...][#<NAME>@<OPTION>=<VALUE>[@<OPTION>=<VALUE>][@...]][#...]
+
+ +
+
output_rect
+

Specify a rectangle where the output of the filter chain is copied into the +input image. It is given by a list of space separated float values: +

+
output_rect=x\ y\ width\ height
+
+

If not given, the output rectangle equals the dimensions of the input image. +The output rectangle is automatically cropped at the borders of the input +image. Negative values are valid for each component. +

+
output_rect=25\ 25\ 100\ 100
+
+
+
+ +

Several filters can be chained for successive processing without GPU-HOST +transfers allowing for fast processing of complex filter chains. +Currently, only filters with zero (generators) or exactly one (filters) input +image and one output image are supported. Also, transition filters are not yet +usable as intended. +

+

Some filters generate output images with additional padding depending on the +respective filter kernel. The padding is automatically removed to ensure the +filter output has the same size as the input image. +

+

For image generators, the size of the output image is determined by the +previous output image of the filter chain or the input image of the whole +filterchain, respectively. The generators do not use the pixel information of +this image to generate their output. However, the generated output is +blended onto this image, resulting in partial or complete coverage of the +output image. +

+

The coreimagesrc video source can be used for generating input images +which are directly fed into the filter chain. By using it, providing input +images by another video source or an input video is not required. +

+ +

39.33.1 Examples

+ +
    +
  • List all filters available: +
    +
    coreimage=list_filters=true
+
    + +
  • Use the CIBoxBlur filter with default options to blur an image: +
    +
    coreimage=filter=CIBoxBlur@default
+
    + +
  • Use a filter chain with CISepiaTone at default values and CIVignetteEffect with +its center at 100x100 and a radius of 50 pixels: +
    +
    coreimage=filter=CIBoxBlur@default#CIVignetteEffect@inputCenter=100\ 100@inputRadius=50
+
    + +
  • Use nullsrc and CIQRCodeGenerator to create a QR code for the FFmpeg homepage, +given as complete and escaped command-line for Apple’s standard bash shell: +
    +
    ffmpeg -f lavfi -i nullsrc=s=100x100,coreimage=filter=CIQRCodeGenerator@inputMessage=https\\\\\://FFmpeg.org/@inputCorrectionLevel=H -frames:v 1 QRCode.png
+
    +
+ + +

39.34 cover_rect

+ +

Cover a rectangular object +

+

It accepts the following options: +

+
+
cover
+

Filepath of the optional cover image, needs to be in yuv420. +

+
+
mode
+

Set covering mode. +

+

It accepts the following values: +

+
‘cover’
+

cover it by the supplied image +

+
‘blur’
+

cover it by interpolating the surrounding pixels +

+
+ +

Default value is blur. +

+
+ + +

39.34.1 Examples

+ +
    +
  • Cover a rectangular object by the supplied image of a given video using ffmpeg: +
    +
    ffmpeg -i file.ts -vf find_rect=newref.pgm,cover_rect=cover.jpg:mode=cover new.mkv
+
    +
+ + +

39.35 crop

+ +

Crop the input video to given dimensions. +

+

It accepts the following parameters: +

+
+
w, out_w
+

The width of the output video. It defaults to iw. +This expression is evaluated only once during the filter +configuration, or when the ‘w’ or ‘out_w’ command is sent. +

+
+
h, out_h
+

The height of the output video. It defaults to ih. +This expression is evaluated only once during the filter +configuration, or when the ‘h’ or ‘out_h’ command is sent. +

+
+
x
+

The horizontal position, in the input video, of the left edge of the output +video. It defaults to (in_w-out_w)/2. +This expression is evaluated per-frame. +

+
+
y
+

The vertical position, in the input video, of the top edge of the output video. +It defaults to (in_h-out_h)/2. +This expression is evaluated per-frame. +

+
+
keep_aspect
+

If set to 1 will force the output display aspect ratio +to be the same of the input, by changing the output sample aspect +ratio. It defaults to 0. +

+
+
exact
+

Enable exact cropping. If enabled, subsampled videos will be cropped at exact +width/height/x/y as specified and will not be rounded to nearest smaller value. +It defaults to 0. +

+
+ +

The out_w, out_h, x, y parameters are +expressions containing the following constants: +

+
+
x
+
y
+

The computed values for x and y. They are evaluated for +each new frame. +

+
+
in_w
+
in_h
+

The input width and height. +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output (cropped) width and height. +

+
+
ow
+
oh
+

These are the same as out_w and out_h. +

+
+
a
+

same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (iw / ih) * sar +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
n
+

The number of the input frame, starting from 0. +

+
+
pos
+

the position in the file of the input frame, NAN if unknown +

+
+
t
+

The timestamp expressed in seconds. It’s NAN if the input timestamp is unknown. +

+
+
+ +

The expression for out_w may depend on the value of out_h, +and the expression for out_h may depend on out_w, but they +cannot depend on x and y, as x and y are +evaluated after out_w and out_h. +

+

The x and y parameters specify the expressions for the +position of the top-left corner of the output (non-cropped) area. They +are evaluated for each frame. If the evaluated value is not valid, it +is approximated to the nearest valid value. +

+

The expression for x may depend on y, and the expression +for y may depend on x. +

+ +

39.35.1 Examples

+ +
    +
  • Crop area with size 100x100 at position (12,34). +
    +
    crop=100:100:12:34
+
    + +

    Using named options, the example above becomes: +

    +
    crop=w=100:h=100:x=12:y=34
+
    + +
  • Crop the central input area with size 100x100: +
    +
    crop=100:100
+
    + +
  • Crop the central input area with size 2/3 of the input video: +
    +
    crop=2/3*in_w:2/3*in_h
+
    + +
  • Crop the input video central square: +
    +
    crop=out_w=in_h
+crop=in_h
+
    + +
  • Delimit the rectangle with the top-left corner placed at position +100:100 and the right-bottom corner corresponding to the right-bottom +corner of the input image. +
    +
    crop=in_w-100:in_h-100:100:100
+
    + +
  • Crop 10 pixels from the left and right borders, and 20 pixels from +the top and bottom borders +
    +
    crop=in_w-2*10:in_h-2*20
+
    + +
  • Keep only the bottom right quarter of the input image: +
    +
    crop=in_w/2:in_h/2:in_w/2:in_h/2
+
    + +
  • Crop height for getting Greek harmony: +
    +
    crop=in_w:1/PHI*in_w
+
    + +
  • Apply trembling effect: +
    +
    crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(n/10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(n/7)
+
    + +
  • Apply erratic camera effect depending on timestamp: +
    +
    crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(t*10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(t*13)"
+
    + +
  • Set x depending on the value of y: +
    +
    crop=in_w/2:in_h/2:y:10+10*sin(n/10)
+
    +
+ + +

39.35.2 Commands

+ +

This filter supports the following commands: +

+
w, out_w
+
h, out_h
+
x
+
y
+

Set width/height of the output video and the horizontal/vertical position +in the input video. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

39.36 cropdetect

+ +

Auto-detect the crop size. +

+

It calculates the necessary cropping parameters and prints the +recommended parameters via the logging system. The detected dimensions +correspond to the non-black area of the input video. +

+

It accepts the following parameters: +

+
+
limit
+

Set higher black value threshold, which can be optionally specified +from nothing (0) to everything (255 for 8-bit based formats). An intensity +value greater to the set value is considered non-black. It defaults to 24. +You can also specify a value between 0.0 and 1.0 which will be scaled depending +on the bitdepth of the pixel format. +

+
+
round
+

The value which the width/height should be divisible by. It defaults to +16. The offset is automatically adjusted to center the video. Use 2 to +get only even dimensions (needed for 4:2:2 video). 16 is best when +encoding to most video codecs. +

+
+
reset_count, reset
+

Set the counter that determines after how many frames cropdetect will +reset the previously detected largest video area and start over to +detect the current optimal crop area. Default value is 0. +

+

This can be useful when channel logos distort the video area. 0 +indicates ’never reset’, and returns the largest area encountered during +playback. +

+
+ + +

39.37 cue

+ +

Delay video filtering until a given wallclock timestamp. The filter first +passes on preroll amount of frames, then it buffers at most +buffer amount of frames and waits for the cue. After reaching the cue +it forwards the buffered frames and also any subsequent frames coming in its +input. +

+

The filter can be used synchronize the output of multiple ffmpeg processes for +realtime output devices like decklink. By putting the delay in the filtering +chain and pre-buffering frames the process can pass on data to output almost +immediately after the target wallclock timestamp is reached. +

+

Perfect frame accuracy cannot be guaranteed, but the result is good enough for +some use cases. +

+
+
cue
+

The cue timestamp expressed in a UNIX timestamp in microseconds. Default is 0. +

+
+
preroll
+

The duration of content to pass on as preroll expressed in seconds. Default is 0. +

+
+
buffer
+

The maximum duration of content to buffer before waiting for the cue expressed +in seconds. Default is 0. +

+
+
+ + +

39.38 curves

+ +

Apply color adjustments using curves. +

+

This filter is similar to the Adobe Photoshop and GIMP curves tools. Each +component (red, green and blue) has its values defined by N key points +tied from each other using a smooth curve. The x-axis represents the pixel +values from the input frame, and the y-axis the new pixel values to be set for +the output frame. +

+

By default, a component curve is defined by the two points (0;0) and +(1;1). This creates a straight line where each original pixel value is +"adjusted" to its own value, which means no change to the image. +

+

The filter allows you to redefine these two points and add some more. A new +curve (using a natural cubic spline interpolation) will be define to pass +smoothly through all these new coordinates. The new defined points needs to be +strictly increasing over the x-axis, and their x and y values must +be in the [0;1] interval. If the computed curves happened to go outside +the vector spaces, the values will be clipped accordingly. +

+

The filter accepts the following options: +

+
+
preset
+

Select one of the available color presets. This option can be used in addition +to the r, g, b parameters; in this case, the later +options takes priority on the preset values. +Available presets are: +

+
‘none’
+
‘color_negative’
+
‘cross_process’
+
‘darker’
+
‘increase_contrast’
+
‘lighter’
+
‘linear_contrast’
+
‘medium_contrast’
+
‘negative’
+
‘strong_contrast’
+
‘vintage’
+
+

Default is none. +

+
master, m
+

Set the master key points. These points will define a second pass mapping. It +is sometimes called a "luminance" or "value" mapping. It can be used with +r, g, b or all since it acts like a +post-processing LUT. +

+
red, r
+

Set the key points for the red component. +

+
green, g
+

Set the key points for the green component. +

+
blue, b
+

Set the key points for the blue component. +

+
all
+

Set the key points for all components (not including master). +Can be used in addition to the other key points component +options. In this case, the unset component(s) will fallback on this +all setting. +

+
psfile
+

Specify a Photoshop curves file (.acv) to import the settings from. +

+
plot
+

Save Gnuplot script of the curves in specified file. +

+
+ +

To avoid some filtergraph syntax conflicts, each key points list need to be +defined using the following syntax: x0/y0 x1/y1 x2/y2 .... +

+ +

39.38.1 Examples

+ +
    +
  • Increase slightly the middle level of blue: +
    +
    curves=blue='0/0 0.5/0.58 1/1'
+
    + +
  • Vintage effect: +
    +
    curves=r='0/0.11 .42/.51 1/0.95':g='0/0 0.50/0.48 1/1':b='0/0.22 .49/.44 1/0.8'
+
    +

    Here we obtain the following coordinates for each components: +

    +
    red
    +

    (0;0.11) (0.42;0.51) (1;0.95) +

    +
    green
    +

    (0;0) (0.50;0.48) (1;1) +

    +
    blue
    +

    (0;0.22) (0.49;0.44) (1;0.80) +

    +
    + +
  • The previous example can also be achieved with the associated built-in preset: +
    +
    curves=preset=vintage
+
    + +
  • Or simply: +
    +
    curves=vintage
+
    + +
  • Use a Photoshop preset and redefine the points of the green component: +
    +
    curves=psfile='MyCurvesPresets/purple.acv':green='0/0 0.45/0.53 1/1'
+
    + +
  • Check out the curves of the cross_process profile using ffmpeg +and gnuplot: +
    +
    ffmpeg -f lavfi -i color -vf curves=cross_process:plot=/tmp/curves.plt -frames:v 1 -f null -
+gnuplot -p /tmp/curves.plt
+
    +
+ + +

39.39 datascope

+ +

Video data analysis filter. +

+

This filter shows hexadecimal pixel values of part of video. +

+

The filter accepts the following options: +

+
+
size, s
+

Set output video size. +

+
+
x
+

Set x offset from where to pick pixels. +

+
+
y
+

Set y offset from where to pick pixels. +

+
+
mode
+

Set scope mode, can be one of the following: +

+
‘mono’
+

Draw hexadecimal pixel values with white color on black background. +

+
+
‘color’
+

Draw hexadecimal pixel values with input video pixel color on black +background. +

+
+
‘color2’
+

Draw hexadecimal pixel values on color background picked from input video, +the text color is picked in such way so its always visible. +

+
+ +
+
axis
+

Draw rows and columns numbers on left and top of video. +

+
+
opacity
+

Set background opacity. +

+
+
format
+

Set display number format. Can be hex, or dec. Default is hex. +

+
+ + +

39.40 dblur

+

Apply Directional blur filter. +

+

The filter accepts the following options: +

+
+
angle
+

Set angle of directional blur. Default is 45. +

+
+
radius
+

Set radius of directional blur. Default is 5. +

+
+
planes
+

Set which planes to filter. By default all planes are filtered. +

+
+ + +

39.40.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.41 dctdnoiz

+ +

Denoise frames using 2D DCT (frequency domain filtering). +

+

This filter is not designed for real time. +

+

The filter accepts the following options: +

+
+
sigma, s
+

Set the noise sigma constant. +

+

This sigma defines a hard threshold of 3 * sigma; every DCT +coefficient (absolute value) below this threshold with be dropped. +

+

If you need a more advanced filtering, see expr. +

+

Default is 0. +

+
+
overlap
+

Set number overlapping pixels for each block. Since the filter can be slow, you +may want to reduce this value, at the cost of a less effective filter and the +risk of various artefacts. +

+

If the overlapping value doesn’t permit processing the whole input width or +height, a warning will be displayed and according borders won’t be denoised. +

+

Default value is blocksize-1, which is the best possible setting. +

+
+
expr, e
+

Set the coefficient factor expression. +

+

For each coefficient of a DCT block, this expression will be evaluated as a +multiplier value for the coefficient. +

+

If this is option is set, the sigma option will be ignored. +

+

The absolute value of the coefficient can be accessed through the c +variable. +

+
+
n
+

Set the blocksize using the number of bits. 1<<n defines the +blocksize, which is the width and height of the processed blocks. +

+

The default value is 3 (8x8) and can be raised to 4 for a +blocksize of 16x16. Note that changing this setting has huge consequences +on the speed processing. Also, a larger block size does not necessarily means a +better de-noising. +

+
+ + +

39.41.1 Examples

+ +

Apply a denoise with a sigma of 4.5: +

+
dctdnoiz=4.5
+
+ +

The same operation can be achieved using the expression system: +

+
dctdnoiz=e='gte(c, 4.5*3)'
+
+ +

Violent denoise using a block size of 16x16: +

+
dctdnoiz=15:n=4
+
+ + +

39.42 deband

+ +

Remove banding artifacts from input video. +It works by replacing banded pixels with average value of referenced pixels. +

+

The filter accepts the following options: +

+
+
1thr
+
2thr
+
3thr
+
4thr
+

Set banding detection threshold for each plane. Default is 0.02. +Valid range is 0.00003 to 0.5. +If difference between current pixel and reference pixel is less than threshold, +it will be considered as banded. +

+
+
range, r
+

Banding detection range in pixels. Default is 16. If positive, random number +in range 0 to set value will be used. If negative, exact absolute value +will be used. +The range defines square of four pixels around current pixel. +

+
+
direction, d
+

Set direction in radians from which four pixel will be compared. If positive, +random direction from 0 to set direction will be picked. If negative, exact of +absolute value will be picked. For example direction 0, -PI or -2*PI radians +will pick only pixels on same row and -PI/2 will pick only pixels on same +column. +

+
+
blur, b
+

If enabled, current pixel is compared with average value of all four +surrounding pixels. The default is enabled. If disabled current pixel is +compared with all four surrounding pixels. The pixel is considered banded +if only all four differences with surrounding pixels are less than threshold. +

+
+
coupling, c
+

If enabled, current pixel is changed if and only if all pixel components are banded, +e.g. banding detection threshold is triggered for all color components. +The default is disabled. +

+
+ + +

39.43 deblock

+ +

Remove blocking artifacts from input video. +

+

The filter accepts the following options: +

+
+
filter
+

Set filter type, can be weak or strong. Default is strong. +This controls what kind of deblocking is applied. +

+
+
block
+

Set size of block, allowed range is from 4 to 512. Default is 8. +

+
+
alpha
+
beta
+
gamma
+
delta
+

Set blocking detection thresholds. Allowed range is 0 to 1. +Defaults are: 0.098 for alpha and 0.05 for the rest. +Using higher threshold gives more deblocking strength. +Setting alpha controls threshold detection at exact edge of block. +Remaining options controls threshold detection near the edge. Each one for +below/above or left/right. Setting any of those to 0 disables +deblocking. +

+
+
planes
+

Set planes to filter. Default is to filter all available planes. +

+
+ + +

39.43.1 Examples

+ +
    +
  • Deblock using weak filter and block size of 4 pixels. +
    +
    deblock=filter=weak:block=4
+
    + +
  • Deblock using strong filter, block size of 4 pixels and custom thresholds for +deblocking more edges. +
    +
    deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05
+
    + +
  • Similar as above, but filter only first plane. +
    +
    deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05:planes=1
+
    + +
  • Similar as above, but filter only second and third plane. +
    +
    deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05:planes=6
+
    +
+ + +

39.44 decimate

+ +

Drop duplicated frames at regular intervals. +

+

The filter accepts the following options: +

+
+
cycle
+

Set the number of frames from which one will be dropped. Setting this to +N means one frame in every batch of N frames will be dropped. +Default is 5. +

+
+
dupthresh
+

Set the threshold for duplicate detection. If the difference metric for a frame +is less than or equal to this value, then it is declared as duplicate. Default +is 1.1 +

+
+
scthresh
+

Set scene change threshold. Default is 15. +

+
+
blockx
+
blocky
+

Set the size of the x and y-axis blocks used during metric calculations. +Larger blocks give better noise suppression, but also give worse detection of +small movements. Must be a power of two. Default is 32. +

+
+
ppsrc
+

Mark main input as a pre-processed input and activate clean source input +stream. This allows the input to be pre-processed with various filters to help +the metrics calculation while keeping the frame selection lossless. When set to +1, the first stream is for the pre-processed input, and the second +stream is the clean source from where the kept frames are chosen. Default is +0. +

+
+
chroma
+

Set whether or not chroma is considered in the metric calculations. Default is +1. +

+
+ + +

39.45 deconvolve

+ +

Apply 2D deconvolution of video stream in frequency domain using second stream +as impulse. +

+

The filter accepts the following options: +

+
+
planes
+

Set which planes to process. +

+
+
impulse
+

Set which impulse video frames will be processed, can be first +or all. Default is all. +

+
+
noise
+

Set noise when doing divisions. Default is 0.0000001. Useful when width +and height are not same and not power of 2 or if stream prior to convolving +had noise. +

+
+ +

The deconvolve filter also supports the framesync options. +

+ +

39.46 dedot

+ +

Reduce cross-luminance (dot-crawl) and cross-color (rainbows) from video. +

+

It accepts the following options: +

+
+
m
+

Set mode of operation. Can be combination of dotcrawl for cross-luminance reduction and/or +rainbows for cross-color reduction. +

+
+
lt
+

Set spatial luma threshold. Lower values increases reduction of cross-luminance. +

+
+
tl
+

Set tolerance for temporal luma. Higher values increases reduction of cross-luminance. +

+
+
tc
+

Set tolerance for chroma temporal variation. Higher values increases reduction of cross-color. +

+
+
ct
+

Set temporal chroma threshold. Lower values increases reduction of cross-color. +

+
+ + +

39.47 deflate

+ +

Apply deflate effect to the video. +

+

This filter replaces the pixel by the local(3x3) average by taking into account +only values lower than the pixel. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+ + +

39.47.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

39.48 deflicker

+ +

Remove temporal frame luminance variations. +

+

It accepts the following options: +

+
+
size, s
+

Set moving-average filter size in frames. Default is 5. Allowed range is 2 - 129. +

+
+
mode, m
+

Set averaging mode to smooth temporal luminance variations. +

+

Available values are: +

+
‘am’
+

Arithmetic mean +

+
+
‘gm’
+

Geometric mean +

+
+
‘hm’
+

Harmonic mean +

+
+
‘qm’
+

Quadratic mean +

+
+
‘cm’
+

Cubic mean +

+
+
‘pm’
+

Power mean +

+
+
‘median’
+

Median +

+
+ +
+
bypass
+

Do not actually modify frame. Useful when one only wants metadata. +

+
+ + +

39.49 dejudder

+ +

Remove judder produced by partially interlaced telecined content. +

+

Judder can be introduced, for instance, by pullup filter. If the original +source was partially telecined content then the output of pullup,dejudder +will have a variable frame rate. May change the recorded frame rate of the +container. Aside from that change, this filter will not affect constant frame +rate video. +

+

The option available in this filter is: +

+
cycle
+

Specify the length of the window over which the judder repeats. +

+

Accepts any integer greater than 1. Useful values are: +

+
‘4’
+

If the original was telecined from 24 to 30 fps (Film to NTSC). +

+
+
‘5’
+

If the original was telecined from 25 to 30 fps (PAL to NTSC). +

+
+
‘20’
+

If a mixture of the two. +

+
+ +

The default is ‘4’. +

+
+ + +

39.50 delogo

+ +

Suppress a TV station logo by a simple interpolation of the surrounding +pixels. Just set a rectangle covering the logo and watch it disappear +(and sometimes something even uglier appear - your mileage may vary). +

+

It accepts the following parameters: +

+
x
+
y
+

Specify the top left corner coordinates of the logo. They must be +specified. +

+
+
w
+
h
+

Specify the width and height of the logo to clear. They must be +specified. +

+
+
band, t
+

Specify the thickness of the fuzzy edge of the rectangle (added to +w and h). The default value is 1. This option is +deprecated, setting higher values should no longer be necessary and +is not recommended. +

+
+
show
+

When set to 1, a green rectangle is drawn on the screen to simplify +finding the right x, y, w, and h parameters. +The default value is 0. +

+

The rectangle is drawn on the outermost pixels which will be (partly) +replaced with interpolated values. The values of the next pixels +immediately outside this rectangle in each direction will be used to +compute the interpolated pixel values inside the rectangle. +

+
+
+ + +

39.50.1 Examples

+ +
    +
  • Set a rectangle covering the area with top left corner coordinates 0,0 +and size 100x77, and a band of size 10: +
    +
    delogo=x=0:y=0:w=100:h=77:band=10
+
    + +
+ + +

39.51 derain

+ +

Remove the rain in the input image/video by applying the derain methods based on +convolutional neural networks. Supported models: +

+ + +

Training as well as model generation scripts are provided in +the repository at https://github.com/XueweiMeng/derain_filter.git. +

+

Native model files (.model) can be generated from TensorFlow model +files (.pb) by using tools/python/convert.py +

+

The filter accepts the following options: +

+
+
filter_type
+

Specify which filter to use. This option accepts the following values: +

+
+
‘derain’
+

Derain filter. To conduct derain filter, you need to use a derain model. +

+
+
‘dehaze’
+

Dehaze filter. To conduct dehaze filter, you need to use a dehaze model. +

+
+

Default value is ‘derain’. +

+
+
dnn_backend
+

Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +

+
+
‘native’
+

Native implementation of DNN loading and execution. +

+
+
‘tensorflow’
+

TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +https://www.tensorflow.org/install/install_c) and configure FFmpeg with +--enable-libtensorflow +

+
+

Default value is ‘native’. +

+
+
model
+

Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow and native +backend can load files for only its format. +

+
+ +

It can also be finished with dnn_processing filter. +

+ +

39.52 deshake

+ +

Attempt to fix small changes in horizontal and/or vertical shift. This +filter helps remove camera shake from hand-holding a camera, bumping a +tripod, moving on a vehicle, etc. +

+

The filter accepts the following options: +

+
+
x
+
y
+
w
+
h
+

Specify a rectangular area where to limit the search for motion +vectors. +If desired the search for motion vectors can be limited to a +rectangular area of the frame defined by its top left corner, width +and height. These parameters have the same meaning as the drawbox +filter which can be used to visualise the position of the bounding +box. +

+

This is useful when simultaneous movement of subjects within the frame +might be confused for camera motion by the motion vector search. +

+

If any or all of x, y, w and h are set to -1 +then the full frame is used. This allows later options to be set +without specifying the bounding box for the motion vector search. +

+

Default - search the whole frame. +

+
+
rx
+
ry
+

Specify the maximum extent of movement in x and y directions in the +range 0-64 pixels. Default 16. +

+
+
edge
+

Specify how to generate pixels to fill blanks at the edge of the +frame. Available values are: +

+
‘blank, 0’
+

Fill zeroes at blank locations +

+
‘original, 1’
+

Original image at blank locations +

+
‘clamp, 2’
+

Extruded edge value at blank locations +

+
‘mirror, 3’
+

Mirrored edge at blank locations +

+
+

Default value is ‘mirror’. +

+
+
blocksize
+

Specify the blocksize to use for motion search. Range 4-128 pixels, +default 8. +

+
+
contrast
+

Specify the contrast threshold for blocks. Only blocks with more than +the specified contrast (difference between darkest and lightest +pixels) will be considered. Range 1-255, default 125. +

+
+
search
+

Specify the search strategy. Available values are: +

+
‘exhaustive, 0’
+

Set exhaustive search +

+
‘less, 1’
+

Set less exhaustive search. +

+
+

Default value is ‘exhaustive’. +

+
+
filename
+

If set then a detailed log of the motion search is written to the +specified file. +

+
+
+ + +

39.53 despill

+ +

Remove unwanted contamination of foreground colors, caused by reflected color of +greenscreen or bluescreen. +

+

This filter accepts the following options: +

+
+
type
+

Set what type of despill to use. +

+
+
mix
+

Set how spillmap will be generated. +

+
+
expand
+

Set how much to get rid of still remaining spill. +

+
+
red
+

Controls amount of red in spill area. +

+
+
green
+

Controls amount of green in spill area. +Should be -1 for greenscreen. +

+
+
blue
+

Controls amount of blue in spill area. +Should be -1 for bluescreen. +

+
+
brightness
+

Controls brightness of spill area, preserving colors. +

+
+
alpha
+

Modify alpha from generated spillmap. +

+
+ + +

39.54 detelecine

+ +

Apply an exact inverse of the telecine operation. It requires a predefined +pattern specified using the pattern option which must be the same as that passed +to the telecine filter. +

+

This filter accepts the following options: +

+
+
first_field
+
+
‘top, t’
+

top field first +

+
‘bottom, b’
+

bottom field first +The default value is top. +

+
+ +
+
pattern
+

A string of numbers representing the pulldown pattern you wish to apply. +The default value is 23. +

+
+
start_frame
+

A number representing position of the first frame with respect to the telecine +pattern. This is to be used if the stream is cut. The default value is 0. +

+
+ + +

39.55 dilation

+ +

Apply dilation effect to the video. +

+

This filter replaces the pixel by the local(3x3) maximum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. Default is 255 i.e. all eight +pixels are used. +

+

Flags to local 3x3 coordinates maps like this: +

+

1 2 3 + 4 5 + 6 7 8 +

+
+ + +

39.55.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

39.56 displace

+ +

Displace pixels as indicated by second and third input stream. +

+

It takes three input streams and outputs one stream, the first input is the +source, and second and third input are displacement maps. +

+

The second input specifies how much to displace pixels along the +x-axis, while the third input specifies how much to displace pixels +along the y-axis. +If one of displacement map streams terminates, last frame from that +displacement map will be used. +

+

Note that once generated, displacements maps can be reused over and over again. +

+

A description of the accepted options follows. +

+
+
edge
+

Set displace behavior for pixels that are out of range. +

+

Available values are: +

+
‘blank’
+

Missing pixels are replaced by black pixels. +

+
+
‘smear’
+

Adjacent pixels will spread out to replace missing pixels. +

+
+
‘wrap’
+

Out of range pixels are wrapped so they point to pixels of other side. +

+
+
‘mirror’
+

Out of range pixels will be replaced with mirrored pixels. +

+
+

Default is ‘smear’. +

+
+
+ + +

39.56.1 Examples

+ +
    +
  • Add ripple effect to rgb input of video size hd720: +
    +
    ffmpeg -i INPUT -f lavfi -i nullsrc=s=hd720,lutrgb=128:128:128 -f lavfi -i nullsrc=s=hd720,geq='r=128+30*sin(2*PI*X/400+T):g=128+30*sin(2*PI*X/400+T):b=128+30*sin(2*PI*X/400+T)' -lavfi '[0][1][2]displace' OUTPUT
+
    + +
  • Add wave effect to rgb input of video size hd720: +
    +
    ffmpeg -i INPUT -f lavfi -i nullsrc=hd720,geq='r=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T)):g=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T)):b=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T))' -lavfi '[1]split[x][y],[0][x][y]displace' OUTPUT
+
    +
+ + +

39.57 dnn_processing

+ +

Do image processing with deep neural networks. It works together with another filter +which converts the pixel format of the Frame to what the dnn network requires. +

+

The filter accepts the following options: +

+
+
dnn_backend
+

Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +

+
+
‘native’
+

Native implementation of DNN loading and execution. +

+
+
‘tensorflow’
+

TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +https://www.tensorflow.org/install/install_c) and configure FFmpeg with +--enable-libtensorflow +

+
+ +

Default value is ‘native’. +

+
+
model
+

Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow and native +backend can load files for only its format. +

+

Native model file (.model) can be generated from TensorFlow model file (.pb) by using tools/python/convert.py +

+
+
input
+

Set the input name of the dnn network. +

+
+
output
+

Set the output name of the dnn network. +

+
+
+ + +

39.57.1 Examples

+ +
    +
  • Remove rain in rgb24 frame with can.pb (see derain filter): +
    +
    ./ffmpeg -i rain.jpg -vf format=rgb24,dnn_processing=dnn_backend=tensorflow:model=can.pb:input=x:output=y derain.jpg
+
    + +
  • Halve the pixel value of the frame with format gray32f: +
    +
    ffmpeg -i input.jpg -vf format=grayf32,dnn_processing=model=halve_gray_float.model:input=dnn_in:output=dnn_out:dnn_backend=native -y out.native.png
+
    + +
  • Handle the Y channel with srcnn.pb (see sr filter) for frame with yuv420p (planar YUV formats supported): +
    +
    ./ffmpeg -i 480p.jpg -vf format=yuv420p,scale=w=iw*2:h=ih*2,dnn_processing=dnn_backend=tensorflow:model=srcnn.pb:input=x:output=y -y srcnn.jpg
+
    + +
  • Handle the Y channel with espcn.pb (see sr filter), which changes frame size, for format yuv420p (planar YUV formats supported): +
    +
    ./ffmpeg -i 480p.jpg -vf format=yuv420p,dnn_processing=dnn_backend=tensorflow:model=espcn.pb:input=x:output=y -y tmp.espcn.jpg
+
    + +
+ + +

39.58 drawbox

+ +

Draw a colored box on the input image. +

+

It accepts the following parameters: +

+
+
x
+
y
+

The expressions which specify the top left corner coordinates of the box. It defaults to 0. +

+
+
width, w
+
height, h
+

The expressions which specify the width and height of the box; if 0 they are interpreted as +the input width and height. It defaults to 0. +

+
+
color, c
+

Specify the color of the box to write. For the general syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. If the special +value invert is used, the box edge color is the same as the +video with inverted luma. +

+
+
thickness, t
+

The expression which sets the thickness of the box edge. +A value of fill will create a filled box. Default value is 3. +

+

See below for the list of accepted constants. +

+
+
replace
+

Applicable if the input has alpha. With value 1, the pixels of the painted box +will overwrite the video’s color and alpha pixels. +Default is 0, which composites the box onto the input, leaving the video’s alpha intact. +

+
+ +

The parameters for x, y, w and h and t are expressions containing the +following constants: +

+
+
dar
+

The input display aspect ratio, it is the same as (w / h) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
in_h, ih
+
in_w, iw
+

The input width and height. +

+
+
sar
+

The input sample aspect ratio. +

+
+
x
+
y
+

The x and y offset coordinates where the box is drawn. +

+
+
w
+
h
+

The width and height of the drawn box. +

+
+
t
+

The thickness of the drawn box. +

+

These constants allow the x, y, w, h and t expressions to refer to +each other, so you may for example specify y=x/dar or h=w/dar. +

+
+
+ + +

39.58.1 Examples

+ +
    +
  • Draw a black box around the edge of the input image: +
    +
    drawbox
+
    + +
  • Draw a box with color red and an opacity of 50%: +
    +
    drawbox=10:20:200:60:red@0.5
+
    + +

    The previous example can be specified as: +

    +
    drawbox=x=10:y=20:w=200:h=60:color=red@0.5
+
    + +
  • Fill the box with pink color: +
    +
    drawbox=x=10:y=10:w=100:h=100:color=pink@0.5:t=fill
+
    + +
  • Draw a 2-pixel red 2.40:1 mask: +
    +
    drawbox=x=-t:y=0.5*(ih-iw/2.4)-t:w=iw+t*2:h=iw/2.4+t*2:t=2:c=red
+
    +
+ + +

39.58.2 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.59 drawgraph

+

Draw a graph using input video metadata. +

+

It accepts the following parameters: +

+
+
m1
+

Set 1st frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg1
+

Set 1st foreground color expression. +

+
+
m2
+

Set 2nd frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg2
+

Set 2nd foreground color expression. +

+
+
m3
+

Set 3rd frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg3
+

Set 3rd foreground color expression. +

+
+
m4
+

Set 4th frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg4
+

Set 4th foreground color expression. +

+
+
min
+

Set minimal value of metadata value. +

+
+
max
+

Set maximal value of metadata value. +

+
+
bg
+

Set graph background color. Default is white. +

+
+
mode
+

Set graph mode. +

+

Available values for mode is: +

+
‘bar’
+
‘dot’
+
‘line’
+
+ +

Default is line. +

+
+
slide
+

Set slide mode. +

+

Available values for slide is: +

+
‘frame’
+

Draw new frame when right border is reached. +

+
+
‘replace’
+

Replace old columns with new ones. +

+
+
‘scroll’
+

Scroll from right to left. +

+
+
‘rscroll’
+

Scroll from left to right. +

+
+
‘picture’
+

Draw single picture. +

+
+ +

Default is frame. +

+
+
size
+

Set size of graph video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +The default value is 900x256. +

+
+
rate, r
+

Set the output frame rate. Default value is 25. +

+

The foreground color expressions can use the following variables: +

+
MIN
+

Minimal value of metadata value. +

+
+
MAX
+

Maximal value of metadata value. +

+
+
VAL
+

Current metadata key value. +

+
+ +

The color is defined as 0xAABBGGRR. +

+
+ +

Example using metadata from signalstats filter: +

+
signalstats,drawgraph=lavfi.signalstats.YAVG:min=0:max=255
+
+ +

Example using metadata from ebur128 filter: +

+
ebur128=metadata=1,adrawgraph=lavfi.r128.M:min=-120:max=5
+
+ + +

39.60 drawgrid

+ +

Draw a grid on the input image. +

+

It accepts the following parameters: +

+
+
x
+
y
+

The expressions which specify the coordinates of some point of grid intersection (meant to configure offset). Both default to 0. +

+
+
width, w
+
height, h
+

The expressions which specify the width and height of the grid cell, if 0 they are interpreted as the +input width and height, respectively, minus thickness, so image gets +framed. Default to 0. +

+
+
color, c
+

Specify the color of the grid. For the general syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. If the special +value invert is used, the grid color is the same as the +video with inverted luma. +

+
+
thickness, t
+

The expression which sets the thickness of the grid line. Default value is 1. +

+

See below for the list of accepted constants. +

+
+
replace
+

Applicable if the input has alpha. With 1 the pixels of the painted grid +will overwrite the video’s color and alpha pixels. +Default is 0, which composites the grid onto the input, leaving the video’s alpha intact. +

+
+ +

The parameters for x, y, w and h and t are expressions containing the +following constants: +

+
+
dar
+

The input display aspect ratio, it is the same as (w / h) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
in_h, ih
+
in_w, iw
+

The input grid cell width and height. +

+
+
sar
+

The input sample aspect ratio. +

+
+
x
+
y
+

The x and y coordinates of some point of grid intersection (meant to configure offset). +

+
+
w
+
h
+

The width and height of the drawn cell. +

+
+
t
+

The thickness of the drawn cell. +

+

These constants allow the x, y, w, h and t expressions to refer to +each other, so you may for example specify y=x/dar or h=w/dar. +

+
+
+ + +

39.60.1 Examples

+ +
    +
  • Draw a grid with cell 100x100 pixels, thickness 2 pixels, with color red and an opacity of 50%: +
    +
    drawgrid=width=100:height=100:thickness=2:color=red@0.5
+
    + +
  • Draw a white 3x3 grid with an opacity of 50%: +
    +
    drawgrid=w=iw/3:h=ih/3:t=2:c=white@0.5
+
    +
+ + +

39.60.2 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.61 drawtext

+ +

Draw a text string or text from a specified file on top of a video, using the +libfreetype library. +

+

To enable compilation of this filter, you need to configure FFmpeg with +--enable-libfreetype. +To enable default font fallback and the font option you need to +configure FFmpeg with --enable-libfontconfig. +To enable the text_shaping option, you need to configure FFmpeg with +--enable-libfribidi. +

+ +

39.61.1 Syntax

+ +

It accepts the following parameters: +

+
+
box
+

Used to draw a box around text using the background color. +The value must be either 1 (enable) or 0 (disable). +The default value of box is 0. +

+
+
boxborderw
+

Set the width of the border to be drawn around the box using boxcolor. +The default value of boxborderw is 0. +

+
+
boxcolor
+

The color to be used for drawing box around text. For the syntax of this +option, check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+

The default value of boxcolor is "white". +

+
+
line_spacing
+

Set the line spacing in pixels of the border to be drawn around the box using box. +The default value of line_spacing is 0. +

+
+
borderw
+

Set the width of the border to be drawn around the text using bordercolor. +The default value of borderw is 0. +

+
+
bordercolor
+

Set the color to be used for drawing border around text. For the syntax of this +option, check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+

The default value of bordercolor is "black". +

+
+
expansion
+

Select how the text is expanded. Can be either none, +strftime (deprecated) or +normal (default). See the Text expansion section +below for details. +

+
+
basetime
+

Set a start time for the count. Value is in microseconds. Only applied +in the deprecated strftime expansion mode. To emulate in normal expansion +mode use the pts function, supplying the start time (in seconds) +as the second argument. +

+
+
fix_bounds
+

If true, check and fix text coords to avoid clipping. +

+
+
fontcolor
+

The color to be used for drawing fonts. For the syntax of this option, check +the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+

The default value of fontcolor is "black". +

+
+
fontcolor_expr
+

String which is expanded the same way as text to obtain dynamic +fontcolor value. By default this option has empty value and is not +processed. When this option is set, it overrides fontcolor option. +

+
+
font
+

The font family to be used for drawing text. By default Sans. +

+
+
fontfile
+

The font file to be used for drawing text. The path must be included. +This parameter is mandatory if the fontconfig support is disabled. +

+
+
alpha
+

Draw the text applying alpha blending. The value can +be a number between 0.0 and 1.0. +The expression accepts the same variables x, y as well. +The default value is 1. +Please see fontcolor_expr. +

+
+
fontsize
+

The font size to be used for drawing text. +The default value of fontsize is 16. +

+
+
text_shaping
+

If set to 1, attempt to shape the text (for example, reverse the order of +right-to-left text and join Arabic characters) before drawing it. +Otherwise, just draw the text exactly as given. +By default 1 (if supported). +

+
+
ft_load_flags
+

The flags to be used for loading the fonts. +

+

The flags map the corresponding flags supported by libfreetype, and are +a combination of the following values: +

+
default
+
no_scale
+
no_hinting
+
render
+
no_bitmap
+
vertical_layout
+
force_autohint
+
crop_bitmap
+
pedantic
+
ignore_global_advance_width
+
no_recurse
+
ignore_transform
+
monochrome
+
linear_design
+
no_autohint
+
+ +

Default value is "default". +

+

For more information consult the documentation for the FT_LOAD_* +libfreetype flags. +

+
+
shadowcolor
+

The color to be used for drawing a shadow behind the drawn text. For the +syntax of this option, check the (ffmpeg-utils)"Color" section in the +ffmpeg-utils manual. +

+

The default value of shadowcolor is "black". +

+
+
shadowx
+
shadowy
+

The x and y offsets for the text shadow position with respect to the +position of the text. They can be either positive or negative +values. The default value for both is "0". +

+
+
start_number
+

The starting frame number for the n/frame_num variable. The default value +is "0". +

+
+
tabsize
+

The size in number of spaces to use for rendering the tab. +Default value is 4. +

+
+
timecode
+

Set the initial timecode representation in "hh:mm:ss[:;.]ff" +format. It can be used with or without text parameter. timecode_rate +option must be specified. +

+
+
timecode_rate, rate, r
+

Set the timecode frame rate (timecode only). Value will be rounded to nearest +integer. Minimum value is "1". +Drop-frame timecode is supported for frame rates 30 & 60. +

+
+
tc24hmax
+

If set to 1, the output of the timecode option will wrap around at 24 hours. +Default is 0 (disabled). +

+
+
text
+

The text string to be drawn. The text must be a sequence of UTF-8 +encoded characters. +This parameter is mandatory if no file is specified with the parameter +textfile. +

+
+
textfile
+

A text file containing text to be drawn. The text must be a sequence +of UTF-8 encoded characters. +

+

This parameter is mandatory if no text string is specified with the +parameter text. +

+

If both text and textfile are specified, an error is thrown. +

+
+
reload
+

If set to 1, the textfile will be reloaded before each frame. +Be sure to update it atomically, or it may be read partially, or even fail. +

+
+
x
+
y
+

The expressions which specify the offsets where text will be drawn +within the video frame. They are relative to the top/left border of the +output image. +

+

The default value of x and y is "0". +

+

See below for the list of accepted constants and functions. +

+
+ +

The parameters for x and y are expressions containing the +following constants and functions: +

+
+
dar
+

input display aspect ratio, it is the same as (w / h) * sar +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
line_h, lh
+

the height of each text line +

+
+
main_h, h, H
+

the input height +

+
+
main_w, w, W
+

the input width +

+
+
max_glyph_a, ascent
+

the maximum distance from the baseline to the highest/upper grid +coordinate used to place a glyph outline point, for all the rendered +glyphs. +It is a positive value, due to the grid’s orientation with the Y axis +upwards. +

+
+
max_glyph_d, descent
+

the maximum distance from the baseline to the lowest grid coordinate +used to place a glyph outline point, for all the rendered glyphs. +This is a negative value, due to the grid’s orientation, with the Y axis +upwards. +

+
+
max_glyph_h
+

maximum glyph height, that is the maximum height for all the glyphs +contained in the rendered text, it is equivalent to ascent - +descent. +

+
+
max_glyph_w
+

maximum glyph width, that is the maximum width for all the glyphs +contained in the rendered text +

+
+
n
+

the number of input frame, starting from 0 +

+
+
rand(min, max)
+

return a random number included between min and max +

+
+
sar
+

The input sample aspect ratio. +

+
+
t
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+
text_h, th
+

the height of the rendered text +

+
+
text_w, tw
+

the width of the rendered text +

+
+
x
+
y
+

the x and y offset coordinates where the text is drawn. +

+

These parameters allow the x and y expressions to refer +to each other, so you can for example specify y=x/dar. +

+
+
pict_type
+

A one character description of the current frame’s picture type. +

+
+
pkt_pos
+

The current packet’s position in the input file or stream +(in bytes, from the start of the input). A value of -1 indicates +this info is not available. +

+
+
pkt_duration
+

The current packet’s duration, in seconds. +

+
+
pkt_size
+

The current packet’s size (in bytes). +

+
+ + +

39.61.2 Text expansion

+ +

If expansion is set to strftime, +the filter recognizes strftime() sequences in the provided text and +expands them accordingly. Check the documentation of strftime(). This +feature is deprecated. +

+

If expansion is set to none, the text is printed verbatim. +

+

If expansion is set to normal (which is the default), +the following expansion mechanism is used. +

+

The backslash character ‘\’, followed by any character, always expands to +the second character. +

+

Sequences of the form %{...} are expanded. The text between the +braces is a function name, possibly followed by arguments separated by ’:’. +If the arguments contain special characters or delimiters (’:’ or ’}’), +they should be escaped. +

+

Note that they probably must also be escaped as the value for the +text option in the filter argument string and as the filter +argument in the filtergraph description, and possibly also for the shell, +that makes up to four levels of escaping; using a text file avoids these +problems. +

+

The following functions are available: +

+
+
expr, e
+

The expression evaluation result. +

+

It must take one argument specifying the expression to be evaluated, +which accepts the same constants and functions as the x and +y values. Note that not all constants should be used, for +example the text size is not known when evaluating the expression, so +the constants text_w and text_h will have an undefined +value. +

+
+
expr_int_format, eif
+

Evaluate the expression’s value and output as formatted integer. +

+

The first argument is the expression to be evaluated, just as for the expr function. +The second argument specifies the output format. Allowed values are ‘x’, +‘X’, ‘d’ and ‘u’. They are treated exactly as in the +printf function. +The third parameter is optional and sets the number of positions taken by the output. +It can be used to add padding with zeros from the left. +

+
+
gmtime
+

The time at which the filter is running, expressed in UTC. +It can accept an argument: a strftime() format string. +

+
+
localtime
+

The time at which the filter is running, expressed in the local time zone. +It can accept an argument: a strftime() format string. +

+
+
metadata
+

Frame metadata. Takes one or two arguments. +

+

The first argument is mandatory and specifies the metadata key. +

+

The second argument is optional and specifies a default value, used when the +metadata key is not found or empty. +

+

Available metadata can be identified by inspecting entries +starting with TAG included within each frame section +printed by running ffprobe -show_frames. +

+

String metadata generated in filters leading to +the drawtext filter are also available. +

+
+
n, frame_num
+

The frame number, starting from 0. +

+
+
pict_type
+

A one character description of the current picture type. +

+
+
pts
+

The timestamp of the current frame. +It can take up to three arguments. +

+

The first argument is the format of the timestamp; it defaults to flt +for seconds as a decimal number with microsecond accuracy; hms stands +for a formatted [-]HH:MM:SS.mmm timestamp with millisecond accuracy. +gmtime stands for the timestamp of the frame formatted as UTC time; +localtime stands for the timestamp of the frame formatted as +local time zone time. +

+

The second argument is an offset added to the timestamp. +

+

If the format is set to hms, a third argument 24HH may be +supplied to present the hour part of the formatted timestamp in 24h format +(00-23). +

+

If the format is set to localtime or gmtime, +a third argument may be supplied: a strftime() format string. +By default, YYYY-MM-DD HH:MM:SS format will be used. +

+
+ + +

39.61.3 Commands

+ +

This filter supports altering parameters via commands: +

+
reinit
+

Alter existing filter parameters. +

+

Syntax for the argument is the same as for filter invocation, e.g. +

+
+
fontsize=56:fontcolor=green:text='Hello World'
+
+ +

Full filter invocation with sendcmd would look like this: +

+
+
sendcmd=c='56.0 drawtext reinit fontsize=56\:fontcolor=green\:text=Hello\\ World'
+
+
+
+ +

If the entire argument can’t be parsed or applied as valid values then the filter will +continue with its existing parameters. +

+ +

39.61.4 Examples

+ +
    +
  • Draw "Test Text" with font FreeSerif, using the default values for the +optional parameters. + +
    +
    drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
+
    + +
  • Draw ’Test Text’ with font FreeSerif of size 24 at position x=100 +and y=50 (counting from the top-left corner of the screen), text is +yellow with a red box around it. Both the text and the box have an +opacity of 20%. + +
    +
    drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
+          x=100: y=50: fontsize=24: fontcolor=yellow@0.2: box=1: boxcolor=red@0.2"
+
    + +

    Note that the double quotes are not necessary if spaces are not used +within the parameter list. +

    +
  • Show the text at the center of the video frame: +
    +
    drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h)/2"
+
    + +
  • Show the text at a random position, switching to a new position every 30 seconds: +
    +
    drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=if(eq(mod(t\,30)\,0)\,rand(0\,(w-text_w))\,x):y=if(eq(mod(t\,30)\,0)\,rand(0\,(h-text_h))\,y)"
+
    + +
  • Show a text line sliding from right to left in the last row of the video +frame. The file LONG_LINE is assumed to contain a single line +with no newlines. +
    +
    drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
+
    + +
  • Show the content of file CREDITS off the bottom of the frame and scroll up. +
    +
    drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
+
    + +
  • Draw a single green letter "g", at the center of the input video. +The glyph baseline is placed at half screen height. +
    +
    drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
+
    + +
  • Show text for 1 second every 3 seconds: +
    +
    drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:enable=lt(mod(t\,3)\,1):text='blink'"
+
    + +
  • Use fontconfig to set the font. Note that the colons need to be escaped. +
    +
    drawtext='fontfile=Linux Libertine O-40\:style=Semibold:text=FFmpeg'
+
    + +
  • Print the date of a real-time encoding (see strftime(3)): +
    +
    drawtext='fontfile=FreeSans.ttf:text=%{localtime\:%a %b %d %Y}'
+
    + +
  • Show text fading in and out (appearing/disappearing): +
    +
    #!/bin/sh
+DS=1.0 # display start
+DE=10.0 # display end
+FID=1.5 # fade in duration
+FOD=5 # fade out duration
+ffplay -f lavfi "color,drawtext=text=TEST:fontsize=50:fontfile=FreeSerif.ttf:fontcolor_expr=ff0000%{eif\\\\: clip(255*(1*between(t\\, $DS + $FID\\, $DE - $FOD) + ((t - $DS)/$FID)*between(t\\, $DS\\, $DS + $FID) + (-(t - $DE)/$FOD)*between(t\\, $DE - $FOD\\, $DE) )\\, 0\\, 255) \\\\: x\\\\: 2 }"
+
    + +
  • Horizontally align multiple separate texts. Note that max_glyph_a +and the fontsize value are included in the y offset. +
    +
    drawtext=fontfile=FreeSans.ttf:text=DOG:fontsize=24:x=10:y=20+24-max_glyph_a,
+drawtext=fontfile=FreeSans.ttf:text=cow:fontsize=24:x=80:y=20+24-max_glyph_a
+
    + +
  • Plot special lavf.image2dec.source_basename metadata onto each frame if +such metadata exists. Otherwise, plot the string "NA". Note that image2 demuxer +must have option -export_path_metadata 1 for the special metadata fields +to be available for filters. +
    +
    drawtext="fontsize=20:fontcolor=white:fontfile=FreeSans.ttf:text='%{metadata\:lavf.image2dec.source_basename\:NA}':x=10:y=10"
+
    + +
+ +

For more information about libfreetype, check: +http://www.freetype.org/. +

+

For more information about fontconfig, check: +http://freedesktop.org/software/fontconfig/fontconfig-user.html. +

+

For more information about libfribidi, check: +http://fribidi.org/. +

+ +

39.62 edgedetect

+ +

Detect and draw edges. The filter uses the Canny Edge Detection algorithm. +

+

The filter accepts the following options: +

+
+
low
+
high
+

Set low and high threshold values used by the Canny thresholding +algorithm. +

+

The high threshold selects the "strong" edge pixels, which are then +connected through 8-connectivity with the "weak" edge pixels selected +by the low threshold. +

+

low and high threshold values must be chosen in the range +[0,1], and low should be lesser or equal to high. +

+

Default value for low is 20/255, and default value for high +is 50/255. +

+
+
mode
+

Define the drawing mode. +

+
+
‘wires’
+

Draw white/gray wires on black background. +

+
+
‘colormix’
+

Mix the colors to create a paint/cartoon effect. +

+
+
‘canny’
+

Apply Canny edge detector on all selected planes. +

+
+

Default value is wires. +

+
+
planes
+

Select planes for filtering. By default all available planes are filtered. +

+
+ + +

39.62.1 Examples

+ +
    +
  • Standard edge detection with custom values for the hysteresis thresholding: +
    +
    edgedetect=low=0.1:high=0.4
+
    + +
  • Painting effect without thresholding: +
    +
    edgedetect=mode=colormix:high=0
+
    +
+ + +

39.63 elbg

+ +

Apply a posterize effect using the ELBG (Enhanced LBG) algorithm. +

+

For each input image, the filter will compute the optimal mapping from +the input to the output given the codebook length, that is the number +of distinct output colors. +

+

This filter accepts the following options. +

+
+
codebook_length, l
+

Set codebook length. The value must be a positive integer, and +represents the number of distinct output colors. Default value is 256. +

+
+
nb_steps, n
+

Set the maximum number of iterations to apply for computing the optimal +mapping. The higher the value the better the result and the higher the +computation time. Default value is 1. +

+
+
seed, s
+

Set a random seed, must be an integer included between 0 and +UINT32_MAX. If not specified, or if explicitly set to -1, the filter +will try to use a good random seed on a best effort basis. +

+
+
pal8
+

Set pal8 output pixel format. This option does not work with codebook +length greater than 256. +

+
+ + +

39.64 entropy

+ +

Measure graylevel entropy in histogram of color channels of video frames. +

+

It accepts the following parameters: +

+
+
mode
+

Can be either normal or diff. Default is normal. +

+

diff mode measures entropy of histogram delta values, absolute differences +between neighbour histogram values. +

+
+ + +

39.65 eq

+

Set brightness, contrast, saturation and approximate gamma adjustment. +

+

The filter accepts the following options: +

+
+
contrast
+

Set the contrast expression. The value must be a float value in range +-1000.0 to 1000.0. The default value is "1". +

+
+
brightness
+

Set the brightness expression. The value must be a float value in +range -1.0 to 1.0. The default value is "0". +

+
+
saturation
+

Set the saturation expression. The value must be a float in +range 0.0 to 3.0. The default value is "1". +

+
+
gamma
+

Set the gamma expression. The value must be a float in range +0.1 to 10.0. The default value is "1". +

+
+
gamma_r
+

Set the gamma expression for red. The value must be a float in +range 0.1 to 10.0. The default value is "1". +

+
+
gamma_g
+

Set the gamma expression for green. The value must be a float in range +0.1 to 10.0. The default value is "1". +

+
+
gamma_b
+

Set the gamma expression for blue. The value must be a float in range +0.1 to 10.0. The default value is "1". +

+
+
gamma_weight
+

Set the gamma weight expression. It can be used to reduce the effect +of a high gamma value on bright image areas, e.g. keep them from +getting overamplified and just plain white. The value must be a float +in range 0.0 to 1.0. A value of 0.0 turns the +gamma correction all the way down while 1.0 leaves it at its +full strength. Default is "1". +

+
+
eval
+

Set when the expressions for brightness, contrast, saturation and +gamma expressions are evaluated. +

+

It accepts the following values: +

+
‘init’
+

only evaluate expressions once during the filter initialization or +when a command is processed +

+
+
‘frame’
+

evaluate expressions for each incoming frame +

+
+ +

Default value is ‘init’. +

+
+ +

The expressions accept the following parameters: +

+
n
+

frame count of the input frame starting from 0 +

+
+
pos
+

byte position of the corresponding packet in the input file, NAN if +unspecified +

+
+
r
+

frame rate of the input video, NAN if the input frame rate is unknown +

+
+
t
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+ + +

39.65.1 Commands

+

The filter supports the following commands: +

+
+
contrast
+

Set the contrast expression. +

+
+
brightness
+

Set the brightness expression. +

+
+
saturation
+

Set the saturation expression. +

+
+
gamma
+

Set the gamma expression. +

+
+
gamma_r
+

Set the gamma_r expression. +

+
+
gamma_g
+

Set gamma_g expression. +

+
+
gamma_b
+

Set gamma_b expression. +

+
+
gamma_weight
+

Set gamma_weight expression. +

+

The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+
+ + +

39.66 erosion

+ +

Apply erosion effect to the video. +

+

This filter replaces the pixel by the local(3x3) minimum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. Default is 255 i.e. all eight +pixels are used. +

+

Flags to local 3x3 coordinates maps like this: +

+

1 2 3 + 4 5 + 6 7 8 +

+
+ + +

39.66.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

39.67 extractplanes

+ +

Extract color channel components from input video stream into +separate grayscale video streams. +

+

The filter accepts the following option: +

+
+
planes
+

Set plane(s) to extract. +

+

Available values for planes are: +

+
‘y’
+
‘u’
+
‘v’
+
‘a’
+
‘r’
+
‘g’
+
‘b’
+
+ +

Choosing planes not available in the input will result in an error. +That means you cannot select r, g, b planes +with y, u, v planes at same time. +

+
+ + +

39.67.1 Examples

+ +
    +
  • Extract luma, u and v color channel component from input video frame +into 3 grayscale outputs: +
    +
    ffmpeg -i video.avi -filter_complex 'extractplanes=y+u+v[y][u][v]' -map '[y]' y.avi -map '[u]' u.avi -map '[v]' v.avi
+
    +
+ + +

39.68 fade

+ +

Apply a fade-in/out effect to the input video. +

+

It accepts the following parameters: +

+
+
type, t
+

The effect type can be either "in" for a fade-in, or "out" for a fade-out +effect. +Default is in. +

+
+
start_frame, s
+

Specify the number of the frame to start applying the fade +effect at. Default is 0. +

+
+
nb_frames, n
+

The number of frames that the fade effect lasts. At the end of the +fade-in effect, the output video will have the same intensity as the input video. +At the end of the fade-out transition, the output video will be filled with the +selected color. +Default is 25. +

+
+
alpha
+

If set to 1, fade only alpha channel, if one exists on the input. +Default value is 0. +

+
+
start_time, st
+

Specify the timestamp (in seconds) of the frame to start to apply the fade +effect. If both start_frame and start_time are specified, the fade will start at +whichever comes last. Default is 0. +

+
+
duration, d
+

The number of seconds for which the fade effect has to last. At the end of the +fade-in effect the output video will have the same intensity as the input video, +at the end of the fade-out transition the output video will be filled with the +selected color. +If both duration and nb_frames are specified, duration is used. Default is 0 +(nb_frames is used by default). +

+
+
color, c
+

Specify the color of the fade. Default is "black". +

+
+ + +

39.68.1 Examples

+ +
    +
  • Fade in the first 30 frames of video: +
    +
    fade=in:0:30
+
    + +

    The command above is equivalent to: +

    +
    fade=t=in:s=0:n=30
+
    + +
  • Fade out the last 45 frames of a 200-frame video: +
    +
    fade=out:155:45
+fade=type=out:start_frame=155:nb_frames=45
+
    + +
  • Fade in the first 25 frames and fade out the last 25 frames of a 1000-frame video: +
    +
    fade=in:0:25, fade=out:975:25
+
    + +
  • Make the first 5 frames yellow, then fade in from frame 5-24: +
    +
    fade=in:5:20:color=yellow
+
    + +
  • Fade in alpha over first 25 frames of video: +
    +
    fade=in:0:25:alpha=1
+
    + +
  • Make the first 5.5 seconds black, then fade in for 0.5 seconds: +
    +
    fade=t=in:st=5.5:d=0.5
+
    + +
+ + +

39.69 fftdnoiz

+

Denoise frames using 3D FFT (frequency domain filtering). +

+

The filter accepts the following options: +

+
+
sigma
+

Set the noise sigma constant. This sets denoising strength. +Default value is 1. Allowed range is from 0 to 30. +Using very high sigma with low overlap may give blocking artifacts. +

+
+
amount
+

Set amount of denoising. By default all detected noise is reduced. +Default value is 1. Allowed range is from 0 to 1. +

+
+
block
+

Set size of block, Default is 4, can be 3, 4, 5 or 6. +Actual size of block in pixels is 2 to power of block, so by default +block size in pixels is 2^4 which is 16. +

+
+
overlap
+

Set block overlap. Default is 0.5. Allowed range is from 0.2 to 0.8. +

+
+
prev
+

Set number of previous frames to use for denoising. By default is set to 0. +

+
+
next
+

Set number of next frames to to use for denoising. By default is set to 0. +

+
+
planes
+

Set planes which will be filtered, by default are all available filtered +except alpha. +

+
+ + +

39.70 fftfilt

+

Apply arbitrary expressions to samples in frequency domain +

+
+
dc_Y
+

Adjust the dc value (gain) of the luma plane of the image. The filter +accepts an integer value in range 0 to 1000. The default +value is set to 0. +

+
+
dc_U
+

Adjust the dc value (gain) of the 1st chroma plane of the image. The +filter accepts an integer value in range 0 to 1000. The +default value is set to 0. +

+
+
dc_V
+

Adjust the dc value (gain) of the 2nd chroma plane of the image. The +filter accepts an integer value in range 0 to 1000. The +default value is set to 0. +

+
+
weight_Y
+

Set the frequency domain weight expression for the luma plane. +

+
+
weight_U
+

Set the frequency domain weight expression for the 1st chroma plane. +

+
+
weight_V
+

Set the frequency domain weight expression for the 2nd chroma plane. +

+
+
eval
+

Set when the expressions are evaluated. +

+

It accepts the following values: +

+
‘init’
+

Only evaluate expressions once during the filter initialization. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. +

+
+ +

Default value is ‘init’. +

+

The filter accepts the following variables: +

+
X
+
Y
+

The coordinates of the current sample. +

+
+
W
+
H
+

The width and height of the image. +

+
+
N
+

The number of input frame, starting from 0. +

+
+ + +

39.70.1 Examples

+ +
    +
  • High-pass: +
    +
    fftfilt=dc_Y=128:weight_Y='squish(1-(Y+X)/100)'
+
    + +
  • Low-pass: +
    +
    fftfilt=dc_Y=0:weight_Y='squish((Y+X)/100-1)'
+
    + +
  • Sharpen: +
    +
    fftfilt=dc_Y=0:weight_Y='1+squish(1-(Y+X)/100)'
+
    + +
  • Blur: +
    +
    fftfilt=dc_Y=0:weight_Y='exp(-4 * ((Y+X)/(W+H)))'
+
    + +
+ + +

39.71 field

+ +

Extract a single field from an interlaced image using stride +arithmetic to avoid wasting CPU time. The output frames are marked as +non-interlaced. +

+

The filter accepts the following options: +

+
+
type
+

Specify whether to extract the top (if the value is 0 or +top) or the bottom field (if the value is 1 or +bottom). +

+
+ + +

39.72 fieldhint

+ +

Create new frames by copying the top and bottom fields from surrounding frames +supplied as numbers by the hint file. +

+
+
hint
+

Set file containing hints: absolute/relative frame numbers. +

+

There must be one line for each frame in a clip. Each line must contain two +numbers separated by the comma, optionally followed by - or +. +Numbers supplied on each line of file can not be out of [N-1,N+1] where N +is current frame number for absolute mode or out of [-1, 1] range +for relative mode. First number tells from which frame to pick up top +field and second number tells from which frame to pick up bottom field. +

+

If optionally followed by + output frame will be marked as interlaced, +else if followed by - output frame will be marked as progressive, else +it will be marked same as input frame. +If optionally followed by t output frame will use only top field, or in +case of b it will use only bottom field. +If line starts with # or ; that line is skipped. +

+
+
mode
+

Can be item absolute or relative. Default is absolute. +

+
+ +

Example of first several lines of hint file for relative mode: +

+
0,0 - # first frame
+1,0 - # second frame, use third's frame top field and second's frame bottom field
+1,0 - # third frame, use fourth's frame top field and third's frame bottom field
+1,0 -
+0,0 -
+0,0 -
+1,0 -
+1,0 -
+1,0 -
+0,0 -
+0,0 -
+1,0 -
+1,0 -
+1,0 -
+0,0 -
+
+ + +

39.73 fieldmatch

+ +

Field matching filter for inverse telecine. It is meant to reconstruct the +progressive frames from a telecined stream. The filter does not drop duplicated +frames, so to achieve a complete inverse telecine fieldmatch needs to be +followed by a decimation filter such as decimate in the filtergraph. +

+

The separation of the field matching and the decimation is notably motivated by +the possibility of inserting a de-interlacing filter fallback between the two. +If the source has mixed telecined and real interlaced content, +fieldmatch will not be able to match fields for the interlaced parts. +But these remaining combed frames will be marked as interlaced, and thus can be +de-interlaced by a later filter such as yadif before decimation. +

+

In addition to the various configuration options, fieldmatch can take an +optional second stream, activated through the ppsrc option. If +enabled, the frames reconstruction will be based on the fields and frames from +this second stream. This allows the first input to be pre-processed in order to +help the various algorithms of the filter, while keeping the output lossless +(assuming the fields are matched properly). Typically, a field-aware denoiser, +or brightness/contrast adjustments can help. +

+

Note that this filter uses the same algorithms as TIVTC/TFM (AviSynth project) +and VIVTC/VFM (VapourSynth project). The later is a light clone of TFM from +which fieldmatch is based on. While the semantic and usage are very +close, some behaviour and options names can differ. +

+

The decimate filter currently only works for constant frame rate input. +If your input has mixed telecined (30fps) and progressive content with a lower +framerate like 24fps use the following filterchain to produce the necessary cfr +stream: dejudder,fps=30000/1001,fieldmatch,decimate. +

+

The filter accepts the following options: +

+
+
order
+

Specify the assumed field order of the input stream. Available values are: +

+
+
‘auto’
+

Auto detect parity (use FFmpeg’s internal parity value). +

+
‘bff’
+

Assume bottom field first. +

+
‘tff’
+

Assume top field first. +

+
+ +

Note that it is sometimes recommended not to trust the parity announced by the +stream. +

+

Default value is auto. +

+
+
mode
+

Set the matching mode or strategy to use. pc mode is the safest in the +sense that it won’t risk creating jerkiness due to duplicate frames when +possible, but if there are bad edits or blended fields it will end up +outputting combed frames when a good match might actually exist. On the other +hand, pcn_ub mode is the most risky in terms of creating jerkiness, +but will almost always find a good frame if there is one. The other values are +all somewhere in between pc and pcn_ub in terms of risking +jerkiness and creating duplicate frames versus finding good matches in sections +with bad edits, orphaned fields, blended fields, etc. +

+

More details about p/c/n/u/b are available in p/c/n/u/b meaning section. +

+

Available values are: +

+
+
‘pc’
+

2-way matching (p/c) +

+
‘pc_n’
+

2-way matching, and trying 3rd match if still combed (p/c + n) +

+
‘pc_u’
+

2-way matching, and trying 3rd match (same order) if still combed (p/c + u) +

+
‘pc_n_ub’
+

2-way matching, trying 3rd match if still combed, and trying 4th/5th matches if +still combed (p/c + n + u/b) +

+
‘pcn’
+

3-way matching (p/c/n) +

+
‘pcn_ub’
+

3-way matching, and trying 4th/5th matches if all 3 of the original matches are +detected as combed (p/c/n + u/b) +

+
+ +

The parenthesis at the end indicate the matches that would be used for that +mode assuming order=tff (and field on auto or +top). +

+

In terms of speed pc mode is by far the fastest and pcn_ub is +the slowest. +

+

Default value is pc_n. +

+
+
ppsrc
+

Mark the main input stream as a pre-processed input, and enable the secondary +input stream as the clean source to pick the fields from. See the filter +introduction for more details. It is similar to the clip2 feature from +VFM/TFM. +

+

Default value is 0 (disabled). +

+
+
field
+

Set the field to match from. It is recommended to set this to the same value as +order unless you experience matching failures with that setting. In +certain circumstances changing the field that is used to match from can have a +large impact on matching performance. Available values are: +

+
+
‘auto’
+

Automatic (same value as order). +

+
‘bottom’
+

Match from the bottom field. +

+
‘top’
+

Match from the top field. +

+
+ +

Default value is auto. +

+
+
mchroma
+

Set whether or not chroma is included during the match comparisons. In most +cases it is recommended to leave this enabled. You should set this to 0 +only if your clip has bad chroma problems such as heavy rainbowing or other +artifacts. Setting this to 0 could also be used to speed things up at +the cost of some accuracy. +

+

Default value is 1. +

+
+
y0
+
y1
+

These define an exclusion band which excludes the lines between y0 and +y1 from being included in the field matching decision. An exclusion +band can be used to ignore subtitles, a logo, or other things that may +interfere with the matching. y0 sets the starting scan line and +y1 sets the ending line; all lines in between y0 and +y1 (including y0 and y1) will be ignored. Setting +y0 and y1 to the same value will disable the feature. +y0 and y1 defaults to 0. +

+
+
scthresh
+

Set the scene change detection threshold as a percentage of maximum change on +the luma plane. Good values are in the [8.0, 14.0] range. Scene change +detection is only relevant in case combmatch=sc. The range for +scthresh is [0.0, 100.0]. +

+

Default value is 12.0. +

+
+
combmatch
+

When combatch is not none, fieldmatch will take into +account the combed scores of matches when deciding what match to use as the +final match. Available values are: +

+
+
‘none’
+

No final matching based on combed scores. +

+
‘sc’
+

Combed scores are only used when a scene change is detected. +

+
‘full’
+

Use combed scores all the time. +

+
+ +

Default is sc. +

+
+
combdbg
+

Force fieldmatch to calculate the combed metrics for certain matches and +print them. This setting is known as micout in TFM/VFM vocabulary. +Available values are: +

+
+
‘none’
+

No forced calculation. +

+
‘pcn’
+

Force p/c/n calculations. +

+
‘pcnub’
+

Force p/c/n/u/b calculations. +

+
+ +

Default value is none. +

+
+
cthresh
+

This is the area combing threshold used for combed frame detection. This +essentially controls how "strong" or "visible" combing must be to be detected. +Larger values mean combing must be more visible and smaller values mean combing +can be less visible or strong and still be detected. Valid settings are from +-1 (every pixel will be detected as combed) to 255 (no pixel will +be detected as combed). This is basically a pixel difference value. A good +range is [8, 12]. +

+

Default value is 9. +

+
+
chroma
+

Sets whether or not chroma is considered in the combed frame decision. Only +disable this if your source has chroma problems (rainbowing, etc.) that are +causing problems for the combed frame detection with chroma enabled. Actually, +using chroma=0 is usually more reliable, except for the case +where there is chroma only combing in the source. +

+

Default value is 0. +

+
+
blockx
+
blocky
+

Respectively set the x-axis and y-axis size of the window used during combed +frame detection. This has to do with the size of the area in which +combpel pixels are required to be detected as combed for a frame to be +declared combed. See the combpel parameter description for more info. +Possible values are any number that is a power of 2 starting at 4 and going up +to 512. +

+

Default value is 16. +

+
+
combpel
+

The number of combed pixels inside any of the blocky by +blockx size blocks on the frame for the frame to be detected as +combed. While cthresh controls how "visible" the combing must be, this +setting controls "how much" combing there must be in any localized area (a +window defined by the blockx and blocky settings) on the +frame. Minimum value is 0 and maximum is blocky x blockx (at +which point no frames will ever be detected as combed). This setting is known +as MI in TFM/VFM vocabulary. +

+

Default value is 80. +

+
+ + +

39.73.1 p/c/n/u/b meaning

+ + +

39.73.1.1 p/c/n

+ +

We assume the following telecined stream: +

+
+
Top fields:     1 2 2 3 4
+Bottom fields:  1 2 3 4 4
+
+ +

The numbers correspond to the progressive frame the fields relate to. Here, the +first two frames are progressive, the 3rd and 4th are combed, and so on. +

+

When fieldmatch is configured to run a matching from bottom +(field=bottom) this is how this input stream get transformed: +

+
+
Input stream:
+                T     1 2 2 3 4
+                B     1 2 3 4 4   <-- matching reference
+
+Matches:              c c n n c
+
+Output stream:
+                T     1 2 3 4 4
+                B     1 2 3 4 4
+
+ +

As a result of the field matching, we can see that some frames get duplicated. +To perform a complete inverse telecine, you need to rely on a decimation filter +after this operation. See for instance the decimate filter. +

+

The same operation now matching from top fields (field=top) +looks like this: +

+
+
Input stream:
+                T     1 2 2 3 4   <-- matching reference
+                B     1 2 3 4 4
+
+Matches:              c c p p c
+
+Output stream:
+                T     1 2 2 3 4
+                B     1 2 2 3 4
+
+ +

In these examples, we can see what p, c and n mean; +basically, they refer to the frame and field of the opposite parity: +

+
    +
  • p matches the field of the opposite parity in the previous frame +
  • c matches the field of the opposite parity in the current frame +
  • n matches the field of the opposite parity in the next frame +
+ + +

39.73.1.2 u/b

+ +

The u and b matching are a bit special in the sense that they match +from the opposite parity flag. In the following examples, we assume that we are +currently matching the 2nd frame (Top:2, bottom:2). According to the match, a +’x’ is placed above and below each matched fields. +

+

With bottom matching (field=bottom): +

+
Match:           c         p           n          b          u
+
+                 x       x               x        x          x
+  Top          1 2 2     1 2 2       1 2 2      1 2 2      1 2 2
+  Bottom       1 2 3     1 2 3       1 2 3      1 2 3      1 2 3
+                 x         x           x        x              x
+
+Output frames:
+                 2          1          2          2          2
+                 2          2          2          1          3
+
+ +

With top matching (field=top): +

+
Match:           c         p           n          b          u
+
+                 x         x           x        x              x
+  Top          1 2 2     1 2 2       1 2 2      1 2 2      1 2 2
+  Bottom       1 2 3     1 2 3       1 2 3      1 2 3      1 2 3
+                 x       x               x        x          x
+
+Output frames:
+                 2          2          2          1          2
+                 2          1          3          2          2
+
+ + +

39.73.2 Examples

+ +

Simple IVTC of a top field first telecined stream: +

+
fieldmatch=order=tff:combmatch=none, decimate
+
+ +

Advanced IVTC, with fallback on yadif for still combed frames: +

+
fieldmatch=order=tff:combmatch=full, yadif=deint=interlaced, decimate
+
+ + +

39.74 fieldorder

+ +

Transform the field order of the input video. +

+

It accepts the following parameters: +

+
+
order
+

The output field order. Valid values are tff for top field first or bff +for bottom field first. +

+
+ +

The default value is ‘tff’. +

+

The transformation is done by shifting the picture content up or down +by one line, and filling the remaining line with appropriate picture content. +This method is consistent with most broadcast field order converters. +

+

If the input video is not flagged as being interlaced, or it is already +flagged as being of the required output field order, then this filter does +not alter the incoming video. +

+

It is very useful when converting to or from PAL DV material, +which is bottom field first. +

+

For example: +

+
ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
+
+ + +

39.75 fifo, afifo

+ +

Buffer input images and send them when they are requested. +

+

It is mainly useful when auto-inserted by the libavfilter +framework. +

+

It does not take parameters. +

+ +

39.76 fillborders

+ +

Fill borders of the input video, without changing video stream dimensions. +Sometimes video can have garbage at the four edges and you may not want to +crop video input to keep size multiple of some number. +

+

This filter accepts the following options: +

+
+
left
+

Number of pixels to fill from left border. +

+
+
right
+

Number of pixels to fill from right border. +

+
+
top
+

Number of pixels to fill from top border. +

+
+
bottom
+

Number of pixels to fill from bottom border. +

+
+
mode
+

Set fill mode. +

+

It accepts the following values: +

+
‘smear’
+

fill pixels using outermost pixels +

+
+
‘mirror’
+

fill pixels using mirroring +

+
+
‘fixed’
+

fill pixels with constant value +

+
+ +

Default is smear. +

+
+
color
+

Set color for pixels in fixed mode. Default is black. +

+
+ + +

39.76.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.77 find_rect

+ +

Find a rectangular object +

+

It accepts the following options: +

+
+
object
+

Filepath of the object image, needs to be in gray8. +

+
+
threshold
+

Detection threshold, default is 0.5. +

+
+
mipmaps
+

Number of mipmaps, default is 3. +

+
+
xmin, ymin, xmax, ymax
+

Specifies the rectangle in which to search. +

+
+ + +

39.77.1 Examples

+ +
    +
  • Cover a rectangular object by the supplied image of a given video using ffmpeg: +
    +
    ffmpeg -i file.ts -vf find_rect=newref.pgm,cover_rect=cover.jpg:mode=cover new.mkv
+
    +
+ + +

39.78 floodfill

+ +

Flood area with values of same pixel components with another values. +

+

It accepts the following options: +

+
x
+

Set pixel x coordinate. +

+
+
y
+

Set pixel y coordinate. +

+
+
s0
+

Set source #0 component value. +

+
+
s1
+

Set source #1 component value. +

+
+
s2
+

Set source #2 component value. +

+
+
s3
+

Set source #3 component value. +

+
+
d0
+

Set destination #0 component value. +

+
+
d1
+

Set destination #1 component value. +

+
+
d2
+

Set destination #2 component value. +

+
+
d3
+

Set destination #3 component value. +

+
+ + +

39.79 format

+ +

Convert the input video to one of the specified pixel formats. +Libavfilter will try to pick one that is suitable as input to +the next filter. +

+

It accepts the following parameters: +

+
pix_fmts
+

A ’|’-separated list of pixel format names, such as +"pix_fmts=yuv420p|monow|rgb24". +

+
+
+ + +

39.79.1 Examples

+ +
    +
  • Convert the input video to the yuv420p format +
    +
    format=pix_fmts=yuv420p
+
    + +

    Convert the input video to any of the formats in the list +

    +
    format=pix_fmts=yuv420p|yuv444p|yuv410p
+
    +
+ + +

39.80 fps

+ +

Convert the video to specified constant frame rate by duplicating or dropping +frames as necessary. +

+

It accepts the following parameters: +

+
fps
+

The desired output frame rate. The default is 25. +

+
+
start_time
+

Assume the first PTS should be the given value, in seconds. This allows for +padding/trimming at the start of stream. By default, no assumption is made +about the first frame’s expected PTS, so no padding or trimming is done. +For example, this could be set to 0 to pad the beginning with duplicates of +the first frame if a video stream starts after the audio stream or to trim any +frames with a negative PTS. +

+
+
round
+

Timestamp (PTS) rounding method. +

+

Possible values are: +

+
zero
+

round towards 0 +

+
inf
+

round away from 0 +

+
down
+

round towards -infinity +

+
up
+

round towards +infinity +

+
near
+

round to nearest +

+
+

The default is near. +

+
+
eof_action
+

Action performed when reading the last frame. +

+

Possible values are: +

+
round
+

Use same timestamp rounding method as used for other frames. +

+
pass
+

Pass through last frame if input duration has not been reached yet. +

+
+

The default is round. +

+
+
+ +

Alternatively, the options can be specified as a flat string: +fps[:start_time[:round]]. +

+

See also the setpts filter. +

+ +

39.80.1 Examples

+ +
    +
  • A typical usage in order to set the fps to 25: +
    +
    fps=fps=25
+
    + +
  • Sets the fps to 24, using abbreviation and rounding method to round to nearest: +
    +
    fps=fps=film:round=near
+
    +
+ + +

39.81 framepack

+ +

Pack two different video streams into a stereoscopic video, setting proper +metadata on supported codecs. The two views should have the same size and +framerate and processing will stop when the shorter video ends. Please note +that you may conveniently adjust view properties with the scale and +fps filters. +

+

It accepts the following parameters: +

+
format
+

The desired packing format. Supported values are: +

+
+
sbs
+

The views are next to each other (default). +

+
+
tab
+

The views are on top of each other. +

+
+
lines
+

The views are packed by line. +

+
+
columns
+

The views are packed by column. +

+
+
frameseq
+

The views are temporally interleaved. +

+
+
+ +
+
+ +

Some examples: +

+
+
# Convert left and right views into a frame-sequential video
+ffmpeg -i LEFT -i RIGHT -filter_complex framepack=frameseq OUTPUT
+
+# Convert views into a side-by-side video with the same output resolution as the input
+ffmpeg -i LEFT -i RIGHT -filter_complex [0:v]scale=w=iw/2[left],[1:v]scale=w=iw/2[right],[left][right]framepack=sbs OUTPUT
+
+ + +

39.82 framerate

+ +

Change the frame rate by interpolating new video output frames from the source +frames. +

+

This filter is not designed to function correctly with interlaced media. If +you wish to change the frame rate of interlaced media then you are required +to deinterlace before this filter and re-interlace after this filter. +

+

A description of the accepted options follows. +

+
+
fps
+

Specify the output frames per second. This option can also be specified +as a value alone. The default is 50. +

+
+
interp_start
+

Specify the start of a range where the output frame will be created as a +linear interpolation of two frames. The range is [0-255], +the default is 15. +

+
+
interp_end
+

Specify the end of a range where the output frame will be created as a +linear interpolation of two frames. The range is [0-255], +the default is 240. +

+
+
scene
+

Specify the level at which a scene change is detected as a value between +0 and 100 to indicate a new scene; a low value reflects a low +probability for the current frame to introduce a new scene, while a higher +value means the current frame is more likely to be one. +The default is 8.2. +

+
+
flags
+

Specify flags influencing the filter process. +

+

Available value for flags is: +

+
+
scene_change_detect, scd
+

Enable scene change detection using the value of the option scene. +This flag is enabled by default. +

+
+
+
+ + +

39.83 framestep

+ +

Select one frame every N-th frame. +

+

This filter accepts the following option: +

+
step
+

Select frame after every step frames. +Allowed values are positive integers higher than 0. Default value is 1. +

+
+ + +

39.84 freezedetect

+ +

Detect frozen video. +

+

This filter logs a message and sets frame metadata when it detects that the +input video has no significant change in content during a specified duration. +Video freeze detection calculates the mean average absolute difference of all +the components of video frames and compares it to a noise floor. +

+

The printed times and duration are expressed in seconds. The +lavfi.freezedetect.freeze_start metadata key is set on the first frame +whose timestamp equals or exceeds the detection duration and it contains the +timestamp of the first frame of the freeze. The +lavfi.freezedetect.freeze_duration and +lavfi.freezedetect.freeze_end metadata keys are set on the first frame +after the freeze. +

+

The filter accepts the following options: +

+
+
noise, n
+

Set noise tolerance. Can be specified in dB (in case "dB" is appended to the +specified value) or as a difference ratio between 0 and 1. Default is -60dB, or +0.001. +

+
+
duration, d
+

Set freeze duration until notification (default is 2 seconds). +

+
+ + +

39.85 freezeframes

+ +

Freeze video frames. +

+

This filter freezes video frames using frame from 2nd input. +

+

The filter accepts the following options: +

+
+
first
+

Set number of first frame from which to start freeze. +

+
+
last
+

Set number of last frame from which to end freeze. +

+
+
replace
+

Set number of frame from 2nd input which will be used instead of replaced frames. +

+
+ + +

39.86 frei0r

+ +

Apply a frei0r effect to the input video. +

+

To enable the compilation of this filter, you need to install the frei0r +header and configure FFmpeg with --enable-frei0r. +

+

It accepts the following parameters: +

+
+
filter_name
+

The name of the frei0r effect to load. If the environment variable +FREI0R_PATH is defined, the frei0r effect is searched for in each of the +directories specified by the colon-separated list in FREI0R_PATH. +Otherwise, the standard frei0r paths are searched, in this order: +HOME/.frei0r-1/lib/, /usr/local/lib/frei0r-1/, +/usr/lib/frei0r-1/. +

+
+
filter_params
+

A ’|’-separated list of parameters to pass to the frei0r effect. +

+
+
+ +

A frei0r effect parameter can be a boolean (its value is either +"y" or "n"), a double, a color (specified as +R/G/B, where R, G, and B are floating point +numbers between 0.0 and 1.0, inclusive) or a color description as specified in the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual, +a position (specified as X/Y, where +X and Y are floating point numbers) and/or a string. +

+

The number and types of parameters depend on the loaded effect. If an +effect parameter is not specified, the default value is set. +

+ +

39.86.1 Examples

+ +
    +
  • Apply the distort0r effect, setting the first two double parameters: +
    +
    frei0r=filter_name=distort0r:filter_params=0.5|0.01
+
    + +
  • Apply the colordistance effect, taking a color as the first parameter: +
    +
    frei0r=colordistance:0.2/0.3/0.4
+frei0r=colordistance:violet
+frei0r=colordistance:0x112233
+
    + +
  • Apply the perspective effect, specifying the top left and top right image +positions: +
    +
    frei0r=perspective:0.2/0.2|0.8/0.2
+
    +
+ +

For more information, see +http://frei0r.dyne.org +

+ +

39.87 fspp

+ +

Apply fast and simple postprocessing. It is a faster version of spp. +

+

It splits (I)DCT into horizontal/vertical passes. Unlike the simple post- +processing filter, one of them is performed once per block, not per pixel. +This allows for much higher speed. +

+

The filter accepts the following options: +

+
+
quality
+

Set quality. This option defines the number of levels for averaging. It accepts +an integer in the range 4-5. Default value is 4. +

+
+
qp
+

Force a constant quantization parameter. It accepts an integer in range 0-63. +If not set, the filter will use the QP from the video stream (if available). +

+
+
strength
+

Set filter strength. It accepts an integer in range -15 to 32. Lower values mean +more details but also more artifacts, while higher values make the image smoother +but also blurrier. Default value is 0 − PSNR optimal. +

+
+
use_bframe_qp
+

Enable the use of the QP from the B-Frames if set to 1. Using this +option may cause flicker since the B-Frames have often larger QP. Default is +0 (not enabled). +

+
+
+ + +

39.88 gblur

+ +

Apply Gaussian blur filter. +

+

The filter accepts the following options: +

+
+
sigma
+

Set horizontal sigma, standard deviation of Gaussian blur. Default is 0.5. +

+
+
steps
+

Set number of steps for Gaussian approximation. Default is 1. +

+
+
planes
+

Set which planes to filter. By default all planes are filtered. +

+
+
sigmaV
+

Set vertical sigma, if negative it will be same as sigma. +Default is -1. +

+
+ + +

39.88.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.89 geq

+ +

Apply generic equation to each pixel. +

+

The filter accepts the following options: +

+
+
lum_expr, lum
+

Set the luminance expression. +

+
cb_expr, cb
+

Set the chrominance blue expression. +

+
cr_expr, cr
+

Set the chrominance red expression. +

+
alpha_expr, a
+

Set the alpha expression. +

+
red_expr, r
+

Set the red expression. +

+
green_expr, g
+

Set the green expression. +

+
blue_expr, b
+

Set the blue expression. +

+
+ +

The colorspace is selected according to the specified options. If one +of the lum_expr, cb_expr, or cr_expr +options is specified, the filter will automatically select a YCbCr +colorspace. If one of the red_expr, green_expr, or +blue_expr options is specified, it will select an RGB +colorspace. +

+

If one of the chrominance expression is not defined, it falls back on the other +one. If no alpha expression is specified it will evaluate to opaque value. +If none of chrominance expressions are specified, they will evaluate +to the luminance expression. +

+

The expressions can use the following variables and functions: +

+
+
N
+

The sequential number of the filtered frame, starting from 0. +

+
+
X
+
Y
+

The coordinates of the current sample. +

+
+
W
+
H
+

The width and height of the image. +

+
+
SW
+
SH
+

Width and height scale depending on the currently filtered plane. It is the +ratio between the corresponding luma plane number of pixels and the current +plane ones. E.g. for YUV4:2:0 the values are 1,1 for the luma plane, and +0.5,0.5 for chroma planes. +

+
+
T
+

Time of the current frame, expressed in seconds. +

+
+
p(x, y)
+

Return the value of the pixel at location (x,y) of the current +plane. +

+
+
lum(x, y)
+

Return the value of the pixel at location (x,y) of the luminance +plane. +

+
+
cb(x, y)
+

Return the value of the pixel at location (x,y) of the +blue-difference chroma plane. Return 0 if there is no such plane. +

+
+
cr(x, y)
+

Return the value of the pixel at location (x,y) of the +red-difference chroma plane. Return 0 if there is no such plane. +

+
+
r(x, y)
+
g(x, y)
+
b(x, y)
+

Return the value of the pixel at location (x,y) of the +red/green/blue component. Return 0 if there is no such component. +

+
+
alpha(x, y)
+

Return the value of the pixel at location (x,y) of the alpha +plane. Return 0 if there is no such plane. +

+
+
psum(x,y), lumsum(x, y), cbsum(x,y), crsum(x,y), rsum(x,y), gsum(x,y), bsum(x,y), alphasum(x,y)
+

Sum of sample values in the rectangle from (0,0) to (x,y), this allows obtaining +sums of samples within a rectangle. See the functions without the sum postfix. +

+
+
interpolation
+

Set one of interpolation methods: +

+
nearest, n
+
bilinear, b
+
+

Default is bilinear. +

+
+ +

For functions, if x and y are outside the area, the value will be +automatically clipped to the closer edge. +

+

Please note that this filter can use multiple threads in which case each slice +will have its own expression state. If you want to use only a single expression +state because your expressions depend on previous state then you should limit +the number of filter threads to 1. +

+ +

39.89.1 Examples

+ +
    +
  • Flip the image horizontally: +
    +
    geq=p(W-X\,Y)
+
    + +
  • Generate a bidimensional sine wave, with angle PI/3 and a +wavelength of 100 pixels: +
    +
    geq=128 + 100*sin(2*(PI/100)*(cos(PI/3)*(X-50*T) + sin(PI/3)*Y)):128:128
+
    + +
  • Generate a fancy enigmatic moving light: +
    +
    nullsrc=s=256x256,geq=random(1)/hypot(X-cos(N*0.07)*W/2-W/2\,Y-sin(N*0.09)*H/2-H/2)^2*1000000*sin(N*0.02):128:128
+
    + +
  • Generate a quick emboss effect: +
    +
    format=gray,geq=lum_expr='(p(X,Y)+(256-p(X-4,Y-4)))/2'
+
    + +
  • Modify RGB components depending on pixel position: +
    +
    geq=r='X/W*r(X,Y)':g='(1-X/W)*g(X,Y)':b='(H-Y)/H*b(X,Y)'
+
    + +
  • Create a radial gradient that is the same size as the input (also see +the vignette filter): +
    +
    geq=lum=255*gauss((X/W-0.5)*3)*gauss((Y/H-0.5)*3)/gauss(0)/gauss(0),format=gray
+
    +
+ + +

39.90 gradfun

+ +

Fix the banding artifacts that are sometimes introduced into nearly flat +regions by truncation to 8-bit color depth. +Interpolate the gradients that should go where the bands are, and +dither them. +

+

It is designed for playback only. Do not use it prior to +lossy compression, because compression tends to lose the dither and +bring back the bands. +

+

It accepts the following parameters: +

+
+
strength
+

The maximum amount by which the filter will change any one pixel. This is also +the threshold for detecting nearly flat regions. Acceptable values range from +.51 to 64; the default value is 1.2. Out-of-range values will be clipped to the +valid range. +

+
+
radius
+

The neighborhood to fit the gradient to. A larger radius makes for smoother +gradients, but also prevents the filter from modifying the pixels near detailed +regions. Acceptable values are 8-32; the default value is 16. Out-of-range +values will be clipped to the valid range. +

+
+
+ +

Alternatively, the options can be specified as a flat string: +strength[:radius] +

+ +

39.90.1 Examples

+ +
    +
  • Apply the filter with a 3.5 strength and radius of 8: +
    +
    gradfun=3.5:8
+
    + +
  • Specify radius, omitting the strength (which will fall-back to the default +value): +
    +
    gradfun=radius=8
+
    + +
+ + +

39.91 graphmonitor

+

Show various filtergraph stats. +

+

With this filter one can debug complete filtergraph. +Especially issues with links filling with queued frames. +

+

The filter accepts the following options: +

+
+
size, s
+

Set video output size. Default is hd720. +

+
+
opacity, o
+

Set video opacity. Default is 0.9. Allowed range is from 0 to 1. +

+
+
mode, m
+

Set output mode, can be fulll or compact. +In compact mode only filters with some queued frames have displayed stats. +

+
+
flags, f
+

Set flags which enable which stats are shown in video. +

+

Available values for flags are: +

+
‘queue’
+

Display number of queued frames in each link. +

+
+
‘frame_count_in’
+

Display number of frames taken from filter. +

+
+
‘frame_count_out’
+

Display number of frames given out from filter. +

+
+
‘pts’
+

Display current filtered frame pts. +

+
+
‘time’
+

Display current filtered frame time. +

+
+
‘timebase’
+

Display time base for filter link. +

+
+
‘format’
+

Display used format for filter link. +

+
+
‘size’
+

Display video size or number of audio channels in case of audio used by filter link. +

+
+
‘rate’
+

Display video frame rate or sample rate in case of audio used by filter link. +

+
+ +
+
rate, r
+

Set upper limit for video rate of output stream, Default value is 25. +This guarantee that output video frame rate will not be higher than this value. +

+
+ + +

39.92 greyedge

+

A color constancy variation filter which estimates scene illumination via grey edge algorithm +and corrects the scene colors accordingly. +

+

See: https://staff.science.uva.nl/th.gevers/pub/GeversTIP07.pdf +

+

The filter accepts the following options: +

+
+
difford
+

The order of differentiation to be applied on the scene. Must be chosen in the range +[0,2] and default value is 1. +

+
+
minknorm
+

The Minkowski parameter to be used for calculating the Minkowski distance. Must +be chosen in the range [0,20] and default value is 1. Set to 0 for getting +max value instead of calculating Minkowski distance. +

+
+
sigma
+

The standard deviation of Gaussian blur to be applied on the scene. Must be +chosen in the range [0,1024.0] and default value = 1. floor( sigma * break_off_sigma(3) ) +can’t be equal to 0 if difford is greater than 0. +

+
+ + +

39.92.1 Examples

+
    +
  • Grey Edge: +
    +
    greyedge=difford=1:minknorm=5:sigma=2
+
    + +
  • Max Edge: +
    +
    greyedge=difford=1:minknorm=0:sigma=2
+
    + +
+ + +

39.93 haldclut

+ +

Apply a Hald CLUT to a video stream. +

+

First input is the video stream to process, and second one is the Hald CLUT. +The Hald CLUT input can be a simple picture or a complete video stream. +

+

The filter accepts the following options: +

+
+
shortest
+

Force termination when the shortest input terminates. Default is 0. +

+
repeatlast
+

Continue applying the last CLUT after the end of the stream. A value of +0 disable the filter after the last frame of the CLUT is reached. +Default is 1. +

+
+ +

haldclut also has the same interpolation options as lut3d (both +filters share the same internals). +

+

This filter also supports the framesync options. +

+

More information about the Hald CLUT can be found on Eskil Steenberg’s website +(Hald CLUT author) at http://www.quelsolaar.com/technology/clut.html. +

+ +

39.93.1 Workflow examples

+ + +

39.93.1.1 Hald CLUT video stream

+ +

Generate an identity Hald CLUT stream altered with various effects: +

+
ffmpeg -f lavfi -i haldclutsrc=8 -vf "hue=H=2*PI*t:s=sin(2*PI*t)+1, curves=cross_process" -t 10 -c:v ffv1 clut.nut
+
+ +

Note: make sure you use a lossless codec. +

+

Then use it with haldclut to apply it on some random stream: +

+
ffmpeg -f lavfi -i mandelbrot -i clut.nut -filter_complex '[0][1] haldclut' -t 20 mandelclut.mkv
+
+ +

The Hald CLUT will be applied to the 10 first seconds (duration of +clut.nut), then the latest picture of that CLUT stream will be applied +to the remaining frames of the mandelbrot stream. +

+ +

39.93.1.2 Hald CLUT with preview

+ +

A Hald CLUT is supposed to be a squared image of Level*Level*Level by +Level*Level*Level pixels. For a given Hald CLUT, FFmpeg will select the +biggest possible square starting at the top left of the picture. The remaining +padding pixels (bottom or right) will be ignored. This area can be used to add +a preview of the Hald CLUT. +

+

Typically, the following generated Hald CLUT will be supported by the +haldclut filter: +

+
+
ffmpeg -f lavfi -i haldclutsrc=8 -vf "
+   pad=iw+320 [padded_clut];
+   smptebars=s=320x256, split [a][b];
+   [padded_clut][a] overlay=W-320:h, curves=color_negative [main];
+   [main][b] overlay=W-320" -frames:v 1 clut.png
+
+ +

It contains the original and a preview of the effect of the CLUT: SMPTE color +bars are displayed on the right-top, and below the same color bars processed by +the color changes. +

+

Then, the effect of this Hald CLUT can be visualized with: +

+
ffplay input.mkv -vf "movie=clut.png, [in] haldclut"
+
+ + +

39.94 hflip

+ +

Flip the input video horizontally. +

+

For example, to horizontally flip the input video with ffmpeg: +

+
ffmpeg -i in.avi -vf "hflip" out.avi
+
+ + +

39.95 histeq

+

This filter applies a global color histogram equalization on a +per-frame basis. +

+

It can be used to correct video that has a compressed range of pixel +intensities. The filter redistributes the pixel intensities to +equalize their distribution across the intensity range. It may be +viewed as an "automatically adjusting contrast filter". This filter is +useful only for correcting degraded or poorly captured source +video. +

+

The filter accepts the following options: +

+
+
strength
+

Determine the amount of equalization to be applied. As the strength +is reduced, the distribution of pixel intensities more-and-more +approaches that of the input frame. The value must be a float number +in the range [0,1] and defaults to 0.200. +

+
+
intensity
+

Set the maximum intensity that can generated and scale the output +values appropriately. The strength should be set as desired and then +the intensity can be limited if needed to avoid washing-out. The value +must be a float number in the range [0,1] and defaults to 0.210. +

+
+
antibanding
+

Set the antibanding level. If enabled the filter will randomly vary +the luminance of output pixels by a small amount to avoid banding of +the histogram. Possible values are none, weak or +strong. It defaults to none. +

+
+ + +

39.96 histogram

+ +

Compute and draw a color distribution histogram for the input video. +

+

The computed histogram is a representation of the color component +distribution in an image. +

+

Standard histogram displays the color components distribution in an image. +Displays color graph for each color component. Shows distribution of +the Y, U, V, A or R, G, B components, depending on input format, in the +current frame. Below each graph a color component scale meter is shown. +

+

The filter accepts the following options: +

+
+
level_height
+

Set height of level. Default value is 200. +Allowed range is [50, 2048]. +

+
+
scale_height
+

Set height of color scale. Default value is 12. +Allowed range is [0, 40]. +

+
+
display_mode
+

Set display mode. +It accepts the following values: +

+
‘stack’
+

Per color component graphs are placed below each other. +

+
+
‘parade’
+

Per color component graphs are placed side by side. +

+
+
‘overlay’
+

Presents information identical to that in the parade, except +that the graphs representing color components are superimposed directly +over one another. +

+
+

Default is stack. +

+
+
levels_mode
+

Set mode. Can be either linear, or logarithmic. +Default is linear. +

+
+
components
+

Set what color components to display. +Default is 7. +

+
+
fgopacity
+

Set foreground opacity. Default is 0.7. +

+
+
bgopacity
+

Set background opacity. Default is 0.5. +

+
+ + +

39.96.1 Examples

+ +
    +
  • Calculate and draw histogram: +
    +
    ffplay -i input -vf histogram
+
    + +
+ + +

39.97 hqdn3d

+ +

This is a high precision/quality 3d denoise filter. It aims to reduce +image noise, producing smooth images and making still images really +still. It should enhance compressibility. +

+

It accepts the following optional parameters: +

+
+
luma_spatial
+

A non-negative floating point number which specifies spatial luma strength. +It defaults to 4.0. +

+
+
chroma_spatial
+

A non-negative floating point number which specifies spatial chroma strength. +It defaults to 3.0*luma_spatial/4.0. +

+
+
luma_tmp
+

A floating point number which specifies luma temporal strength. It defaults to +6.0*luma_spatial/4.0. +

+
+
chroma_tmp
+

A floating point number which specifies chroma temporal strength. It defaults to +luma_tmp*chroma_spatial/luma_spatial. +

+
+ + +

39.97.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.98 hwdownload

+ +

Download hardware frames to system memory. +

+

The input must be in hardware frames, and the output a non-hardware format. +Not all formats will be supported on the output - it may be necessary to insert +an additional format filter immediately following in the graph to get +the output in a supported format. +

+ +

39.99 hwmap

+ +

Map hardware frames to system memory or to another device. +

+

This filter has several different modes of operation; which one is used depends +on the input and output formats: +

    +
  • Hardware frame input, normal frame output + +

    Map the input frames to system memory and pass them to the output. If the +original hardware frame is later required (for example, after overlaying +something else on part of it), the hwmap filter can be used again +in the next mode to retrieve it. +

  • Normal frame input, hardware frame output + +

    If the input is actually a software-mapped hardware frame, then unmap it - +that is, return the original hardware frame. +

    +

    Otherwise, a device must be provided. Create new hardware surfaces on that +device for the output, then map them back to the software format at the input +and give those frames to the preceding filter. This will then act like the +hwupload filter, but may be able to avoid an additional copy when +the input is already in a compatible format. +

  • Hardware frame input and output + +

    A device must be supplied for the output, either directly or with the +derive_device option. The input and output devices must be of +different types and compatible - the exact meaning of this is +system-dependent, but typically it means that they must refer to the same +underlying hardware context (for example, refer to the same graphics card). +

    +

    If the input frames were originally created on the output device, then unmap +to retrieve the original frames. +

    +

    Otherwise, map the frames to the output device - create new hardware frames +on the output corresponding to the frames on the input. +

+ +

The following additional parameters are accepted: +

+
+
mode
+

Set the frame mapping mode. Some combination of: +

+
read
+

The mapped frame should be readable. +

+
write
+

The mapped frame should be writeable. +

+
overwrite
+

The mapping will always overwrite the entire frame. +

+

This may improve performance in some cases, as the original contents of the +frame need not be loaded. +

+
direct
+

The mapping must not involve any copying. +

+

Indirect mappings to copies of frames are created in some cases where either +direct mapping is not possible or it would have unexpected properties. +Setting this flag ensures that the mapping is direct and will fail if that is +not possible. +

+
+

Defaults to read+write if not specified. +

+
+
derive_device type
+

Rather than using the device supplied at initialisation, instead derive a new +device of type type from the device the input frames exist on. +

+
+
reverse
+

In a hardware to hardware mapping, map in reverse - create frames in the sink +and map them back to the source. This may be necessary in some cases where +a mapping in one direction is required but only the opposite direction is +supported by the devices being used. +

+

This option is dangerous - it may break the preceding filter in undefined +ways if there are any additional constraints on that filter’s output. +Do not use it without fully understanding the implications of its use. +

+
+ + +

39.100 hwupload

+ +

Upload system memory frames to hardware surfaces. +

+

The device to upload to must be supplied when the filter is initialised. If +using ffmpeg, select the appropriate device with the -filter_hw_device +option or with the derive_device option. The input and output devices +must be of different types and compatible - the exact meaning of this is +system-dependent, but typically it means that they must refer to the same +underlying hardware context (for example, refer to the same graphics card). +

+

The following additional parameters are accepted: +

+
+
derive_device type
+

Rather than using the device supplied at initialisation, instead derive a new +device of type type from the device the input frames exist on. +

+
+ + +

39.101 hwupload_cuda

+ +

Upload system memory frames to a CUDA device. +

+

It accepts the following optional parameters: +

+
+
device
+

The number of the CUDA device to use +

+
+ + +

39.102 hqx

+ +

Apply a high-quality magnification filter designed for pixel art. This filter +was originally created by Maxim Stepin. +

+

It accepts the following option: +

+
+
n
+

Set the scaling dimension: 2 for hq2x, 3 for +hq3x and 4 for hq4x. +Default is 3. +

+
+ + +

39.103 hstack

+

Stack input videos horizontally. +

+

All streams must be of same pixel format and of same height. +

+

Note that this filter is faster than using overlay and pad filter +to create same output. +

+

The filter accepts the following option: +

+
+
inputs
+

Set number of input streams. Default is 2. +

+
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+ + +

39.104 hue

+ +

Modify the hue and/or the saturation of the input. +

+

It accepts the following parameters: +

+
+
h
+

Specify the hue angle as a number of degrees. It accepts an expression, +and defaults to "0". +

+
+
s
+

Specify the saturation in the [-10,10] range. It accepts an expression and +defaults to "1". +

+
+
H
+

Specify the hue angle as a number of radians. It accepts an +expression, and defaults to "0". +

+
+
b
+

Specify the brightness in the [-10,10] range. It accepts an expression and +defaults to "0". +

+
+ +

h and H are mutually exclusive, and can’t be +specified at the same time. +

+

The b, h, H and s option values are +expressions containing the following constants: +

+
+
n
+

frame count of the input frame starting from 0 +

+
+
pts
+

presentation timestamp of the input frame expressed in time base units +

+
+
r
+

frame rate of the input video, NAN if the input frame rate is unknown +

+
+
t
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+
tb
+

time base of the input video +

+
+ + +

39.104.1 Examples

+ +
    +
  • Set the hue to 90 degrees and the saturation to 1.0: +
    +
    hue=h=90:s=1
+
    + +
  • Same command but expressing the hue in radians: +
    +
    hue=H=PI/2:s=1
+
    + +
  • Rotate hue and make the saturation swing between 0 +and 2 over a period of 1 second: +
    +
    hue="H=2*PI*t: s=sin(2*PI*t)+1"
+
    + +
  • Apply a 3 seconds saturation fade-in effect starting at 0: +
    +
    hue="s=min(t/3\,1)"
+
    + +

    The general fade-in expression can be written as: +

    +
    hue="s=min(0\, max((t-START)/DURATION\, 1))"
+
    + +
  • Apply a 3 seconds saturation fade-out effect starting at 5 seconds: +
    +
    hue="s=max(0\, min(1\, (8-t)/3))"
+
    + +

    The general fade-out expression can be written as: +

    +
    hue="s=max(0\, min(1\, (START+DURATION-t)/DURATION))"
+
    + +
+ + +

39.104.2 Commands

+ +

This filter supports the following commands: +

+
b
+
s
+
h
+
H
+

Modify the hue and/or the saturation and/or brightness of the input video. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

39.105 hysteresis

+ +

Grow first stream into second stream by connecting components. +This makes it possible to build more robust edge masks. +

+

This filter accepts the following options: +

+
+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+
threshold
+

Set threshold which is used in filtering. If pixel component value is higher than +this value filter algorithm for connecting components is activated. +By default value is 0. +

+
+ +

The hysteresis filter also supports the framesync options. +

+ +

39.106 idet

+ +

Detect video interlacing type. +

+

This filter tries to detect if the input frames are interlaced, progressive, +top or bottom field first. It will also try to detect fields that are +repeated between adjacent frames (a sign of telecine). +

+

Single frame detection considers only immediately adjacent frames when classifying each frame. +Multiple frame detection incorporates the classification history of previous frames. +

+

The filter will log these metadata values: +

+
+
single.current_frame
+

Detected type of current frame using single-frame detection. One of: +“tff” (top field first), “bff” (bottom field first), +“progressive”, or “undetermined” +

+
+
single.tff
+

Cumulative number of frames detected as top field first using single-frame detection. +

+
+
multiple.tff
+

Cumulative number of frames detected as top field first using multiple-frame detection. +

+
+
single.bff
+

Cumulative number of frames detected as bottom field first using single-frame detection. +

+
+
multiple.current_frame
+

Detected type of current frame using multiple-frame detection. One of: +“tff” (top field first), “bff” (bottom field first), +“progressive”, or “undetermined” +

+
+
multiple.bff
+

Cumulative number of frames detected as bottom field first using multiple-frame detection. +

+
+
single.progressive
+

Cumulative number of frames detected as progressive using single-frame detection. +

+
+
multiple.progressive
+

Cumulative number of frames detected as progressive using multiple-frame detection. +

+
+
single.undetermined
+

Cumulative number of frames that could not be classified using single-frame detection. +

+
+
multiple.undetermined
+

Cumulative number of frames that could not be classified using multiple-frame detection. +

+
+
repeated.current_frame
+

Which field in the current frame is repeated from the last. One of “neither”, “top”, or “bottom”. +

+
+
repeated.neither
+

Cumulative number of frames with no repeated field. +

+
+
repeated.top
+

Cumulative number of frames with the top field repeated from the previous frame’s top field. +

+
+
repeated.bottom
+

Cumulative number of frames with the bottom field repeated from the previous frame’s bottom field. +

+
+ +

The filter accepts the following options: +

+
+
intl_thres
+

Set interlacing threshold. +

+
prog_thres
+

Set progressive threshold. +

+
rep_thres
+

Threshold for repeated field detection. +

+
half_life
+

Number of frames after which a given frame’s contribution to the +statistics is halved (i.e., it contributes only 0.5 to its +classification). The default of 0 means that all frames seen are given +full weight of 1.0 forever. +

+
analyze_interlaced_flag
+

When this is not 0 then idet will use the specified number of frames to determine +if the interlaced flag is accurate, it will not count undetermined frames. +If the flag is found to be accurate it will be used without any further +computations, if it is found to be inaccurate it will be cleared without any +further computations. This allows inserting the idet filter as a low computational +method to clean up the interlaced flag +

+
+ + +

39.107 il

+ +

Deinterleave or interleave fields. +

+

This filter allows one to process interlaced images fields without +deinterlacing them. Deinterleaving splits the input frame into 2 +fields (so called half pictures). Odd lines are moved to the top +half of the output image, even lines to the bottom half. +You can process (filter) them independently and then re-interleave them. +

+

The filter accepts the following options: +

+
+
luma_mode, l
+
chroma_mode, c
+
alpha_mode, a
+

Available values for luma_mode, chroma_mode and +alpha_mode are: +

+
+
‘none’
+

Do nothing. +

+
+
‘deinterleave, d’
+

Deinterleave fields, placing one above the other. +

+
+
‘interleave, i’
+

Interleave fields. Reverse the effect of deinterleaving. +

+
+

Default value is none. +

+
+
luma_swap, ls
+
chroma_swap, cs
+
alpha_swap, as
+

Swap luma/chroma/alpha fields. Exchange even & odd lines. Default value is 0. +

+
+ + +

39.107.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

39.108 inflate

+ +

Apply inflate effect to the video. +

+

This filter replaces the pixel by the local(3x3) average by taking into account +only values higher than the pixel. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+ + +

39.108.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

39.109 interlace

+ +

Simple interlacing filter from progressive contents. This interleaves upper (or +lower) lines from odd frames with lower (or upper) lines from even frames, +halving the frame rate and preserving image height. +

+
+
   Original        Original             New Frame
+   Frame 'j'      Frame 'j+1'             (tff)
+  ==========      ===========       ==================
+    Line 0  -------------------->    Frame 'j' Line 0
+    Line 1          Line 1  ---->   Frame 'j+1' Line 1
+    Line 2 --------------------->    Frame 'j' Line 2
+    Line 3          Line 3  ---->   Frame 'j+1' Line 3
+     ...             ...                   ...
+New Frame + 1 will be generated by Frame 'j+2' and Frame 'j+3' and so on
+
+ +

It accepts the following optional parameters: +

+
+
scan
+

This determines whether the interlaced frame is taken from the even +(tff - default) or odd (bff) lines of the progressive frame. +

+
+
lowpass
+

Vertical lowpass filter to avoid twitter interlacing and +reduce moire patterns. +

+
+
‘0, off’
+

Disable vertical lowpass filter +

+
+
‘1, linear’
+

Enable linear filter (default) +

+
+
‘2, complex’
+

Enable complex filter. This will slightly less reduce twitter and moire +but better retain detail and subjective sharpness impression. +

+
+
+
+
+ + +

39.110 kerndeint

+ +

Deinterlace input video by applying Donald Graft’s adaptive kernel +deinterling. Work on interlaced parts of a video to produce +progressive frames. +

+

The description of the accepted parameters follows. +

+
+
thresh
+

Set the threshold which affects the filter’s tolerance when +determining if a pixel line must be processed. It must be an integer +in the range [0,255] and defaults to 10. A value of 0 will result in +applying the process on every pixels. +

+
+
map
+

Paint pixels exceeding the threshold value to white if set to 1. +Default is 0. +

+
+
order
+

Set the fields order. Swap fields if set to 1, leave fields alone if +0. Default is 0. +

+
+
sharp
+

Enable additional sharpening if set to 1. Default is 0. +

+
+
twoway
+

Enable twoway sharpening if set to 1. Default is 0. +

+
+ + +

39.110.1 Examples

+ +
    +
  • Apply default values: +
    +
    kerndeint=thresh=10:map=0:order=0:sharp=0:twoway=0
+
    + +
  • Enable additional sharpening: +
    +
    kerndeint=sharp=1
+
    + +
  • Paint processed pixels in white: +
    +
    kerndeint=map=1
+
    +
+ + +

39.111 lagfun

+ +

Slowly update darker pixels. +

+

This filter makes short flashes of light appear longer. +This filter accepts the following options: +

+
+
decay
+

Set factor for decaying. Default is .95. Allowed range is from 0 to 1. +

+
+
planes
+

Set which planes to filter. Default is all. Allowed range is from 0 to 15. +

+
+ + +

39.112 lenscorrection

+ +

Correct radial lens distortion +

+

This filter can be used to correct for radial distortion as can result from the use +of wide angle lenses, and thereby re-rectify the image. To find the right parameters +one can use tools available for example as part of opencv or simply trial-and-error. +To use opencv use the calibration sample (under samples/cpp) from the opencv sources +and extract the k1 and k2 coefficients from the resulting matrix. +

+

Note that effectively the same filter is available in the open-source tools Krita and +Digikam from the KDE project. +

+

In contrast to the vignette filter, which can also be used to compensate lens errors, +this filter corrects the distortion of the image, whereas vignette corrects the +brightness distribution, so you may want to use both filters together in certain +cases, though you will have to take care of ordering, i.e. whether vignetting should +be applied before or after lens correction. +

+ +

39.112.1 Options

+ +

The filter accepts the following options: +

+
+
cx
+

Relative x-coordinate of the focal point of the image, and thereby the center of the +distortion. This value has a range [0,1] and is expressed as fractions of the image +width. Default is 0.5. +

+
cy
+

Relative y-coordinate of the focal point of the image, and thereby the center of the +distortion. This value has a range [0,1] and is expressed as fractions of the image +height. Default is 0.5. +

+
k1
+

Coefficient of the quadratic correction term. This value has a range [-1,1]. 0 means +no correction. Default is 0. +

+
k2
+

Coefficient of the double quadratic correction term. This value has a range [-1,1]. +0 means no correction. Default is 0. +

+
+ +

The formula that generates the correction is: +

+

r_src = r_tgt * (1 + k1 * (r_tgt / r_0)^2 + k2 * (r_tgt / r_0)^4) +

+

where r_0 is halve of the image diagonal and r_src and r_tgt are the +distances from the focal point in the source and target images, respectively. +

+ +

39.113 lensfun

+ +

Apply lens correction via the lensfun library (http://lensfun.sourceforge.net/). +

+

The lensfun filter requires the camera make, camera model, and lens model +to apply the lens correction. The filter will load the lensfun database and +query it to find the corresponding camera and lens entries in the database. As +long as these entries can be found with the given options, the filter can +perform corrections on frames. Note that incomplete strings will result in the +filter choosing the best match with the given options, and the filter will +output the chosen camera and lens models (logged with level "info"). You must +provide the make, camera model, and lens model as they are required. +

+

The filter accepts the following options: +

+
+
make
+

The make of the camera (for example, "Canon"). This option is required. +

+
+
model
+

The model of the camera (for example, "Canon EOS 100D"). This option is +required. +

+
+
lens_model
+

The model of the lens (for example, "Canon EF-S 18-55mm f/3.5-5.6 IS STM"). This +option is required. +

+
+
mode
+

The type of correction to apply. The following values are valid options: +

+
+
‘vignetting’
+

Enables fixing lens vignetting. +

+
+
‘geometry’
+

Enables fixing lens geometry. This is the default. +

+
+
‘subpixel’
+

Enables fixing chromatic aberrations. +

+
+
‘vig_geo’
+

Enables fixing lens vignetting and lens geometry. +

+
+
‘vig_subpixel’
+

Enables fixing lens vignetting and chromatic aberrations. +

+
+
‘distortion’
+

Enables fixing both lens geometry and chromatic aberrations. +

+
+
‘all’
+

Enables all possible corrections. +

+
+
+
+
focal_length
+

The focal length of the image/video (zoom; expected constant for video). For +example, a 18–55mm lens has focal length range of [18–55], so a value in that +range should be chosen when using that lens. Default 18. +

+
+
aperture
+

The aperture of the image/video (expected constant for video). Note that +aperture is only used for vignetting correction. Default 3.5. +

+
+
focus_distance
+

The focus distance of the image/video (expected constant for video). Note that +focus distance is only used for vignetting and only slightly affects the +vignetting correction process. If unknown, leave it at the default value (which +is 1000). +

+
+
scale
+

The scale factor which is applied after transformation. After correction the +video is no longer necessarily rectangular. This parameter controls how much of +the resulting image is visible. The value 0 means that a value will be chosen +automatically such that there is little or no unmapped area in the output +image. 1.0 means that no additional scaling is done. Lower values may result +in more of the corrected image being visible, while higher values may avoid +unmapped areas in the output. +

+
+
target_geometry
+

The target geometry of the output image/video. The following values are valid +options: +

+
+
‘rectilinear (default)’
+
‘fisheye’
+
‘panoramic’
+
‘equirectangular’
+
‘fisheye_orthographic’
+
‘fisheye_stereographic’
+
‘fisheye_equisolid’
+
‘fisheye_thoby’
+
+
+
reverse
+

Apply the reverse of image correction (instead of correcting distortion, apply +it). +

+
+
interpolation
+

The type of interpolation used when correcting distortion. The following values +are valid options: +

+
+
‘nearest’
+
‘linear (default)’
+
‘lanczos’
+
+
+
+ + +

39.113.1 Examples

+ +
    +
  • Apply lens correction with make "Canon", camera model "Canon EOS 100D", and lens +model "Canon EF-S 18-55mm f/3.5-5.6 IS STM" with focal length of "18" and +aperture of "8.0". + +
    +
    ffmpeg -i input.mov -vf lensfun=make=Canon:model="Canon EOS 100D":lens_model="Canon EF-S 18-55mm f/3.5-5.6 IS STM":focal_length=18:aperture=8 -c:v h264 -b:v 8000k output.mov
+
    + +
  • Apply the same as before, but only for the first 5 seconds of video. + +
    +
    ffmpeg -i input.mov -vf lensfun=make=Canon:model="Canon EOS 100D":lens_model="Canon EF-S 18-55mm f/3.5-5.6 IS STM":focal_length=18:aperture=8:enable='lte(t\,5)' -c:v h264 -b:v 8000k output.mov
+
    + +
+ + +

39.114 libvmaf

+ +

Obtain the VMAF (Video Multi-Method Assessment Fusion) +score between two input videos. +

+

The obtained VMAF score is printed through the logging system. +

+

It requires Netflix’s vmaf library (libvmaf) as a pre-requisite. +After installing the library it can be enabled using: +./configure --enable-libvmaf --enable-version3. +If no model path is specified it uses the default model: vmaf_v0.6.1.pkl. +

+

The filter has following options: +

+
+
model_path
+

Set the model path which is to be used for SVM. +Default value: "/usr/local/share/model/vmaf_v0.6.1.pkl" +

+
+
log_path
+

Set the file path to be used to store logs. +

+
+
log_fmt
+

Set the format of the log file (xml or json). +

+
+
enable_transform
+

This option can enable/disable the score_transform applied to the final predicted VMAF score, +if you have specified score_transform option in the input parameter file passed to run_vmaf_training.py +Default value: false +

+
+
phone_model
+

Invokes the phone model which will generate VMAF scores higher than in the +regular model, which is more suitable for laptop, TV, etc. viewing conditions. +Default value: false +

+
+
psnr
+

Enables computing psnr along with vmaf. +Default value: false +

+
+
ssim
+

Enables computing ssim along with vmaf. +Default value: false +

+
+
ms_ssim
+

Enables computing ms_ssim along with vmaf. +Default value: false +

+
+
pool
+

Set the pool method to be used for computing vmaf. +Options are min, harmonic_mean or mean (default). +

+
+
n_threads
+

Set number of threads to be used when computing vmaf. +Default value: 0, which makes use of all available logical processors. +

+
+
n_subsample
+

Set interval for frame subsampling used when computing vmaf. +Default value: 1 +

+
+
enable_conf_interval
+

Enables confidence interval. +Default value: false +

+
+ +

This filter also supports the framesync options. +

+ +

39.114.1 Examples

+
    +
  • On the below examples the input file main.mpg being processed is +compared with the reference file ref.mpg. + +
    +
    ffmpeg -i main.mpg -i ref.mpg -lavfi libvmaf -f null -
+
    + +
  • Example with options: +
    +
    ffmpeg -i main.mpg -i ref.mpg -lavfi libvmaf="psnr=1:log_fmt=json" -f null -
+
    + +
  • Example with options and different containers: +
    +
    ffmpeg -i main.mpg -i ref.mkv -lavfi "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]libvmaf=psnr=1:log_fmt=json" -f null -
+
    +
+ + +

39.115 limiter

+ +

Limits the pixel components values to the specified range [min, max]. +

+

The filter accepts the following options: +

+
+
min
+

Lower bound. Defaults to the lowest allowed value for the input. +

+
+
max
+

Upper bound. Defaults to the highest allowed value for the input. +

+
+
planes
+

Specify which planes will be processed. Defaults to all available. +

+
+ + +

39.116 loop

+ +

Loop video frames. +

+

The filter accepts the following options: +

+
+
loop
+

Set the number of loops. Setting this value to -1 will result in infinite loops. +Default is 0. +

+
+
size
+

Set maximal size in number of frames. Default is 0. +

+
+
start
+

Set first frame of loop. Default is 0. +

+
+ + +

39.116.1 Examples

+ +
    +
  • Loop single first frame infinitely: +
    +
    loop=loop=-1:size=1:start=0
+
    + +
  • Loop single first frame 10 times: +
    +
    loop=loop=10:size=1:start=0
+
    + +
  • Loop 10 first frames 5 times: +
    +
    loop=loop=5:size=10:start=0
+
    +
+ + +

39.117 lut1d

+ +

Apply a 1D LUT to an input video. +

+

The filter accepts the following options: +

+
+
file
+

Set the 1D LUT file name. +

+

Currently supported formats: +

+
‘cube’
+

Iridas +

+
‘csp’
+

cineSpace +

+
+ +
+
interp
+

Select interpolation mode. +

+

Available values are: +

+
+
‘nearest’
+

Use values from the nearest defined point. +

+
‘linear’
+

Interpolate values using the linear interpolation. +

+
‘cosine’
+

Interpolate values using the cosine interpolation. +

+
‘cubic’
+

Interpolate values using the cubic interpolation. +

+
‘spline’
+

Interpolate values using the spline interpolation. +

+
+
+
+ + +

39.118 lut3d

+ +

Apply a 3D LUT to an input video. +

+

The filter accepts the following options: +

+
+
file
+

Set the 3D LUT file name. +

+

Currently supported formats: +

+
‘3dl’
+

AfterEffects +

+
‘cube’
+

Iridas +

+
‘dat’
+

DaVinci +

+
‘m3d’
+

Pandora +

+
‘csp’
+

cineSpace +

+
+
+
interp
+

Select interpolation mode. +

+

Available values are: +

+
+
‘nearest’
+

Use values from the nearest defined point. +

+
‘trilinear’
+

Interpolate values using the 8 points defining a cube. +

+
‘tetrahedral’
+

Interpolate values using a tetrahedron. +

+
+
+
+ + +

39.119 lumakey

+ +

Turn certain luma values into transparency. +

+

The filter accepts the following options: +

+
+
threshold
+

Set the luma which will be used as base for transparency. +Default value is 0. +

+
+
tolerance
+

Set the range of luma values to be keyed out. +Default value is 0.01. +

+
+
softness
+

Set the range of softness. Default value is 0. +Use this to control gradual transition from zero to full transparency. +

+
+ + +

39.119.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.120 lut, lutrgb, lutyuv

+ +

Compute a look-up table for binding each pixel component input value +to an output value, and apply it to the input video. +

+

lutyuv applies a lookup table to a YUV input video, lutrgb +to an RGB input video. +

+

These filters accept the following parameters: +

+
c0
+

set first pixel component expression +

+
c1
+

set second pixel component expression +

+
c2
+

set third pixel component expression +

+
c3
+

set fourth pixel component expression, corresponds to the alpha component +

+
+
r
+

set red component expression +

+
g
+

set green component expression +

+
b
+

set blue component expression +

+
a
+

alpha component expression +

+
+
y
+

set Y/luminance component expression +

+
u
+

set U/Cb component expression +

+
v
+

set V/Cr component expression +

+
+ +

Each of them specifies the expression to use for computing the lookup table for +the corresponding pixel component values. +

+

The exact component associated to each of the c* options depends on the +format in input. +

+

The lut filter requires either YUV or RGB pixel formats in input, +lutrgb requires RGB pixel formats in input, and lutyuv requires YUV. +

+

The expressions can contain the following constants and functions: +

+
+
w
+
h
+

The input width and height. +

+
+
val
+

The input value for the pixel component. +

+
+
clipval
+

The input value, clipped to the minval-maxval range. +

+
+
maxval
+

The maximum value for the pixel component. +

+
+
minval
+

The minimum value for the pixel component. +

+
+
negval
+

The negated value for the pixel component value, clipped to the +minval-maxval range; it corresponds to the expression +"maxval-clipval+minval". +

+
+
clip(val)
+

The computed value in val, clipped to the +minval-maxval range. +

+
+
gammaval(gamma)
+

The computed gamma correction value of the pixel component value, +clipped to the minval-maxval range. It corresponds to the +expression +"pow((clipval-minval)/(maxval-minval)\,gamma)*(maxval-minval)+minval" +

+
+
+ +

All expressions default to "val". +

+ +

39.120.1 Examples

+ +
    +
  • Negate input video: +
    +
    lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
+lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
+
    + +

    The above is the same as: +

    +
    lutrgb="r=negval:g=negval:b=negval"
+lutyuv="y=negval:u=negval:v=negval"
+
    + +
  • Negate luminance: +
    +
    lutyuv=y=negval
+
    + +
  • Remove chroma components, turning the video into a graytone image: +
    +
    lutyuv="u=128:v=128"
+
    + +
  • Apply a luma burning effect: +
    +
    lutyuv="y=2*val"
+
    + +
  • Remove green and blue components: +
    +
    lutrgb="g=0:b=0"
+
    + +
  • Set a constant alpha channel value on input: +
    +
    format=rgba,lutrgb=a="maxval-minval/2"
+
    + +
  • Correct luminance gamma by a factor of 0.5: +
    +
    lutyuv=y=gammaval(0.5)
+
    + +
  • Discard least significant bits of luma: +
    +
    lutyuv=y='bitand(val, 128+64+32)'
+
    + +
  • Technicolor like effect: +
    +
    lutyuv=u='(val-maxval/2)*2+maxval/2':v='(val-maxval/2)*2+maxval/2'
+
    +
+ + +

39.121 lut2, tlut2

+ +

The lut2 filter takes two input streams and outputs one +stream. +

+

The tlut2 (time lut2) filter takes two consecutive frames +from one single stream. +

+

This filter accepts the following parameters: +

+
c0
+

set first pixel component expression +

+
c1
+

set second pixel component expression +

+
c2
+

set third pixel component expression +

+
c3
+

set fourth pixel component expression, corresponds to the alpha component +

+
+
d
+

set output bit depth, only available for lut2 filter. By default is 0, +which means bit depth is automatically picked from first input format. +

+
+ +

The lut2 filter also supports the framesync options. +

+

Each of them specifies the expression to use for computing the lookup table for +the corresponding pixel component values. +

+

The exact component associated to each of the c* options depends on the +format in inputs. +

+

The expressions can contain the following constants: +

+
+
w
+
h
+

The input width and height. +

+
+
x
+

The first input value for the pixel component. +

+
+
y
+

The second input value for the pixel component. +

+
+
bdx
+

The first input video bit depth. +

+
+
bdy
+

The second input video bit depth. +

+
+ +

All expressions default to "x". +

+ +

39.121.1 Examples

+ +
    +
  • Highlight differences between two RGB video streams: +
    +
    lut2='ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,0,pow(2,bdx)-1)'
+
    + +
  • Highlight differences between two YUV video streams: +
    +
    lut2='ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,pow(2,bdx-1),pow(2,bdx)-1):ifnot(x-y,pow(2,bdx-1),pow(2,bdx)-1)'
+
    + +
  • Show max difference between two video streams: +
    +
    lut2='if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1))):if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1))):if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1)))'
+
    +
+ + +

39.122 maskedclamp

+ +

Clamp the first input stream with the second input and third input stream. +

+

Returns the value of first stream to be between second input +stream - undershoot and third input stream + overshoot. +

+

This filter accepts the following options: +

+
undershoot
+

Default value is 0. +

+
+
overshoot
+

Default value is 0. +

+
+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

39.123 maskedmax

+ +

Merge the second and third input stream into output stream using absolute differences +between second input stream and first input stream and absolute difference between +third input stream and first input stream. The picked value will be from second input +stream if second absolute difference is greater than first one or from third input stream +otherwise. +

+

This filter accepts the following options: +

+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

39.124 maskedmerge

+ +

Merge the first input stream with the second input stream using per pixel +weights in the third input stream. +

+

A value of 0 in the third stream pixel component means that pixel component +from first stream is returned unchanged, while maximum value (eg. 255 for +8-bit videos) means that pixel component from second stream is returned +unchanged. Intermediate values define the amount of merging between both +input stream’s pixel components. +

+

This filter accepts the following options: +

+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

39.125 maskedmin

+ +

Merge the second and third input stream into output stream using absolute differences +between second input stream and first input stream and absolute difference between +third input stream and first input stream. The picked value will be from second input +stream if second absolute difference is less than first one or from third input stream +otherwise. +

+

This filter accepts the following options: +

+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

39.126 maskedthreshold

+

Pick pixels comparing absolute difference of two video streams with fixed +threshold. +

+

If absolute difference between pixel component of first and second video +stream is equal or lower than user supplied threshold than pixel component +from first video stream is picked, otherwise pixel component from second +video stream is picked. +

+

This filter accepts the following options: +

+
threshold
+

Set threshold used when picking pixels from absolute difference from two input +video streams. +

+
+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from second stream. +By default value 0xf, all planes will be processed. +

+
+ + +

39.127 maskfun

+

Create mask from input video. +

+

For example it is useful to create motion masks after tblend filter. +

+

This filter accepts the following options: +

+
+
low
+

Set low threshold. Any pixel component lower or exact than this value will be set to 0. +

+
+
high
+

Set high threshold. Any pixel component higher than this value will be set to max value +allowed for current pixel format. +

+
+
planes
+

Set planes to filter, by default all available planes are filtered. +

+
+
fill
+

Fill all frame pixels with this value. +

+
+
sum
+

Set max average pixel value for frame. If sum of all pixel components is higher that this +average, output frame will be completely filled with value set by fill option. +Typically useful for scene changes when used in combination with tblend filter. +

+
+ + +

39.128 mcdeint

+ +

Apply motion-compensation deinterlacing. +

+

It needs one field per frame as input and must thus be used together +with yadif=1/3 or equivalent. +

+

This filter accepts the following options: +

+
mode
+

Set the deinterlacing mode. +

+

It accepts one of the following values: +

+
‘fast’
+
‘medium’
+
‘slow’
+

use iterative motion estimation +

+
‘extra_slow’
+

like ‘slow’, but use multiple reference frames. +

+
+

Default value is ‘fast’. +

+
+
parity
+

Set the picture field parity assumed for the input video. It must be +one of the following values: +

+
+
‘0, tff’
+

assume top field first +

+
‘1, bff’
+

assume bottom field first +

+
+ +

Default value is ‘bff’. +

+
+
qp
+

Set per-block quantization parameter (QP) used by the internal +encoder. +

+

Higher values should result in a smoother motion vector field but less +optimal individual vectors. Default value is 1. +

+
+ + +

39.129 median

+ +

Pick median pixel from certain rectangle defined by radius. +

+

This filter accepts the following options: +

+
+
radius
+

Set horizontal radius size. Default value is 1. +Allowed range is integer from 1 to 127. +

+
+
planes
+

Set which planes to process. Default is 15, which is all available planes. +

+
+
radiusV
+

Set vertical radius size. Default value is 0. +Allowed range is integer from 0 to 127. +If it is 0, value will be picked from horizontal radius option. +

+
+
percentile
+

Set median percentile. Default value is 0.5. +Default value of 0.5 will pick always median values, while 0 will pick +minimum values, and 1 maximum values. +

+
+ + +

39.129.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.130 mergeplanes

+ +

Merge color channel components from several video streams. +

+

The filter accepts up to 4 input streams, and merge selected input +planes to the output video. +

+

This filter accepts the following options: +

+
mapping
+

Set input to output plane mapping. Default is 0. +

+

The mappings is specified as a bitmap. It should be specified as a +hexadecimal number in the form 0xAa[Bb[Cc[Dd]]]. ’Aa’ describes the +mapping for the first plane of the output stream. ’A’ sets the number of +the input stream to use (from 0 to 3), and ’a’ the plane number of the +corresponding input to use (from 0 to 3). The rest of the mappings is +similar, ’Bb’ describes the mapping for the output stream second +plane, ’Cc’ describes the mapping for the output stream third plane and +’Dd’ describes the mapping for the output stream fourth plane. +

+
+
format
+

Set output pixel format. Default is yuva444p. +

+
+ + +

39.130.1 Examples

+ +
    +
  • Merge three gray video streams of same width and height into single video stream: +
    +
    [a0][a1][a2]mergeplanes=0x001020:yuv444p
+
    + +
  • Merge 1st yuv444p stream and 2nd gray video stream into yuva444p video stream: +
    +
    [a0][a1]mergeplanes=0x00010210:yuva444p
+
    + +
  • Swap Y and A plane in yuva444p stream: +
    +
    format=yuva444p,mergeplanes=0x03010200:yuva444p
+
    + +
  • Swap U and V plane in yuv420p stream: +
    +
    format=yuv420p,mergeplanes=0x000201:yuv420p
+
    + +
  • Cast a rgb24 clip to yuv444p: +
    +
    format=rgb24,mergeplanes=0x000102:yuv444p
+
    +
+ + +

39.131 mestimate

+ +

Estimate and export motion vectors using block matching algorithms. +Motion vectors are stored in frame side data to be used by other filters. +

+

This filter accepts the following options: +

+
method
+

Specify the motion estimation method. Accepts one of the following values: +

+
+
‘esa’
+

Exhaustive search algorithm. +

+
‘tss’
+

Three step search algorithm. +

+
‘tdls’
+

Two dimensional logarithmic search algorithm. +

+
‘ntss’
+

New three step search algorithm. +

+
‘fss’
+

Four step search algorithm. +

+
‘ds’
+

Diamond search algorithm. +

+
‘hexbs’
+

Hexagon-based search algorithm. +

+
‘epzs’
+

Enhanced predictive zonal search algorithm. +

+
‘umh’
+

Uneven multi-hexagon search algorithm. +

+
+

Default value is ‘esa’. +

+
+
mb_size
+

Macroblock size. Default 16. +

+
+
search_param
+

Search parameter. Default 7. +

+
+ + +

39.132 midequalizer

+ +

Apply Midway Image Equalization effect using two video streams. +

+

Midway Image Equalization adjusts a pair of images to have the same +histogram, while maintaining their dynamics as much as possible. It’s +useful for e.g. matching exposures from a pair of stereo cameras. +

+

This filter has two inputs and one output, which must be of same pixel format, but +may be of different sizes. The output of filter is first input adjusted with +midway histogram of both inputs. +

+

This filter accepts the following option: +

+
+
planes
+

Set which planes to process. Default is 15, which is all available planes. +

+
+ + +

39.133 minterpolate

+ +

Convert the video to specified frame rate using motion interpolation. +

+

This filter accepts the following options: +

+
fps
+

Specify the output frame rate. This can be rational e.g. 60000/1001. Frames are dropped if fps is lower than source fps. Default 60. +

+
+
mi_mode
+

Motion interpolation mode. Following values are accepted: +

+
‘dup’
+

Duplicate previous or next frame for interpolating new ones. +

+
‘blend’
+

Blend source frames. Interpolated frame is mean of previous and next frames. +

+
‘mci’
+

Motion compensated interpolation. Following options are effective when this mode is selected: +

+
+
‘mc_mode’
+

Motion compensation mode. Following values are accepted: +

+
‘obmc’
+

Overlapped block motion compensation. +

+
‘aobmc’
+

Adaptive overlapped block motion compensation. Window weighting coefficients are controlled adaptively according to the reliabilities of the neighboring motion vectors to reduce oversmoothing. +

+
+

Default mode is ‘obmc’. +

+
+
‘me_mode’
+

Motion estimation mode. Following values are accepted: +

+
‘bidir’
+

Bidirectional motion estimation. Motion vectors are estimated for each source frame in both forward and backward directions. +

+
‘bilat’
+

Bilateral motion estimation. Motion vectors are estimated directly for interpolated frame. +

+
+

Default mode is ‘bilat’. +

+
+
‘me’
+

The algorithm to be used for motion estimation. Following values are accepted: +

+
‘esa’
+

Exhaustive search algorithm. +

+
‘tss’
+

Three step search algorithm. +

+
‘tdls’
+

Two dimensional logarithmic search algorithm. +

+
‘ntss’
+

New three step search algorithm. +

+
‘fss’
+

Four step search algorithm. +

+
‘ds’
+

Diamond search algorithm. +

+
‘hexbs’
+

Hexagon-based search algorithm. +

+
‘epzs’
+

Enhanced predictive zonal search algorithm. +

+
‘umh’
+

Uneven multi-hexagon search algorithm. +

+
+

Default algorithm is ‘epzs’. +

+
+
‘mb_size’
+

Macroblock size. Default 16. +

+
+
‘search_param’
+

Motion estimation search parameter. Default 32. +

+
+
‘vsbmc’
+

Enable variable-size block motion compensation. Motion estimation is applied with smaller block sizes at object boundaries in order to make the them less blur. Default is 0 (disabled). +

+
+
+
+ +
+
scd
+

Scene change detection method. Scene change leads motion vectors to be in random direction. Scene change detection replace interpolated frames by duplicate ones. May not be needed for other modes. Following values are accepted: +

+
‘none’
+

Disable scene change detection. +

+
‘fdiff’
+

Frame difference. Corresponding pixel values are compared and if it satisfies scd_threshold scene change is detected. +

+
+

Default method is ‘fdiff’. +

+
+
scd_threshold
+

Scene change detection threshold. Default is 10.. +

+
+ + +

39.134 mix

+ +

Mix several video input streams into one video stream. +

+

A description of the accepted options follows. +

+
+
nb_inputs
+

The number of inputs. If unspecified, it defaults to 2. +

+
+
weights
+

Specify weight of each input video stream as sequence. +Each weight is separated by space. If number of weights +is smaller than number of frames last specified +weight will be used for all remaining unset weights. +

+
+
scale
+

Specify scale, if it is set it will be multiplied with sum +of each weight multiplied with pixel values to give final destination +pixel value. By default scale is auto scaled to sum of weights. +

+
+
duration
+

Specify how end of stream is determined. +

+
‘longest’
+

The duration of the longest input. (default) +

+
+
‘shortest’
+

The duration of the shortest input. +

+
+
‘first’
+

The duration of the first input. +

+
+
+
+ + +

39.135 mpdecimate

+ +

Drop frames that do not differ greatly from the previous frame in +order to reduce frame rate. +

+

The main use of this filter is for very-low-bitrate encoding +(e.g. streaming over dialup modem), but it could in theory be used for +fixing movies that were inverse-telecined incorrectly. +

+

A description of the accepted options follows. +

+
+
max
+

Set the maximum number of consecutive frames which can be dropped (if +positive), or the minimum interval between dropped frames (if +negative). If the value is 0, the frame is dropped disregarding the +number of previous sequentially dropped frames. +

+

Default value is 0. +

+
+
hi
+
lo
+
frac
+

Set the dropping threshold values. +

+

Values for hi and lo are for 8x8 pixel blocks and +represent actual pixel value differences, so a threshold of 64 +corresponds to 1 unit of difference for each pixel, or the same spread +out differently over the block. +

+

A frame is a candidate for dropping if no 8x8 blocks differ by more +than a threshold of hi, and if no more than frac blocks (1 +meaning the whole image) differ by more than a threshold of lo. +

+

Default value for hi is 64*12, default value for lo is +64*5, and default value for frac is 0.33. +

+
+ + + +

39.136 negate

+ +

Negate (invert) the input video. +

+

It accepts the following option: +

+
+
negate_alpha
+

With value 1, it negates the alpha component, if present. Default value is 0. +

+
+ + +

39.137 nlmeans

+ +

Denoise frames using Non-Local Means algorithm. +

+

Each pixel is adjusted by looking for other pixels with similar contexts. This +context similarity is defined by comparing their surrounding patches of size +pxp. Patches are searched in an area of rxr +around the pixel. +

+

Note that the research area defines centers for patches, which means some +patches will be made of pixels outside that research area. +

+

The filter accepts the following options. +

+
+
s
+

Set denoising strength. Default is 1.0. Must be in range [1.0, 30.0]. +

+
+
p
+

Set patch size. Default is 7. Must be odd number in range [0, 99]. +

+
+
pc
+

Same as p but for chroma planes. +

+

The default value is 0 and means automatic. +

+
+
r
+

Set research size. Default is 15. Must be odd number in range [0, 99]. +

+
+
rc
+

Same as r but for chroma planes. +

+

The default value is 0 and means automatic. +

+
+ + +

39.138 nnedi

+ +

Deinterlace video using neural network edge directed interpolation. +

+

This filter accepts the following options: +

+
+
weights
+

Mandatory option, without binary file filter can not work. +Currently file can be found here: +https://github.com/dubhater/vapoursynth-nnedi3/blob/master/src/nnedi3_weights.bin +

+
+
deint
+

Set which frames to deinterlace, by default it is all. +Can be all or interlaced. +

+
+
field
+

Set mode of operation. +

+

Can be one of the following: +

+
+
‘af’
+

Use frame flags, both fields. +

+
‘a’
+

Use frame flags, single field. +

+
‘t’
+

Use top field only. +

+
‘b’
+

Use bottom field only. +

+
‘tf’
+

Use both fields, top first. +

+
‘bf’
+

Use both fields, bottom first. +

+
+ +
+
planes
+

Set which planes to process, by default filter process all frames. +

+
+
nsize
+

Set size of local neighborhood around each pixel, used by the predictor neural +network. +

+

Can be one of the following: +

+
+
‘s8x6’
+
‘s16x6’
+
‘s32x6’
+
‘s48x6’
+
‘s8x4’
+
‘s16x4’
+
‘s32x4’
+
+ +
+
nns
+

Set the number of neurons in predictor neural network. +Can be one of the following: +

+
+
‘n16’
+
‘n32’
+
‘n64’
+
‘n128’
+
‘n256’
+
+ +
+
qual
+

Controls the number of different neural network predictions that are blended +together to compute the final output value. Can be fast, default or +slow. +

+
+
etype
+

Set which set of weights to use in the predictor. +Can be one of the following: +

+
+
‘a’
+

weights trained to minimize absolute error +

+
‘s’
+

weights trained to minimize squared error +

+
+ +
+
pscrn
+

Controls whether or not the prescreener neural network is used to decide +which pixels should be processed by the predictor neural network and which +can be handled by simple cubic interpolation. +The prescreener is trained to know whether cubic interpolation will be +sufficient for a pixel or whether it should be predicted by the predictor nn. +The computational complexity of the prescreener nn is much less than that of +the predictor nn. Since most pixels can be handled by cubic interpolation, +using the prescreener generally results in much faster processing. +The prescreener is pretty accurate, so the difference between using it and not +using it is almost always unnoticeable. +

+

Can be one of the following: +

+
+
‘none’
+
‘original’
+
‘new’
+
+ +

Default is new. +

+
+
fapprox
+

Set various debugging flags. +

+
+ + +

39.139 noformat

+ +

Force libavfilter not to use any of the specified pixel formats for the +input to the next filter. +

+

It accepts the following parameters: +

+
pix_fmts
+

A ’|’-separated list of pixel format names, such as +pix_fmts=yuv420p|monow|rgb24". +

+
+
+ + +

39.139.1 Examples

+ +
    +
  • Force libavfilter to use a format different from yuv420p for the +input to the vflip filter: +
    +
    noformat=pix_fmts=yuv420p,vflip
+
    + +
  • Convert the input video to any of the formats not contained in the list: +
    +
    noformat=yuv420p|yuv444p|yuv410p
+
    +
+ + +

39.140 noise

+ +

Add noise on video input frame. +

+

The filter accepts the following options: +

+
+
all_seed
+
c0_seed
+
c1_seed
+
c2_seed
+
c3_seed
+

Set noise seed for specific pixel component or all pixel components in case +of all_seed. Default value is 123457. +

+
+
all_strength, alls
+
c0_strength, c0s
+
c1_strength, c1s
+
c2_strength, c2s
+
c3_strength, c3s
+

Set noise strength for specific pixel component or all pixel components in case +all_strength. Default value is 0. Allowed range is [0, 100]. +

+
+
all_flags, allf
+
c0_flags, c0f
+
c1_flags, c1f
+
c2_flags, c2f
+
c3_flags, c3f
+

Set pixel component flags or set flags for all components if all_flags. +Available values for component flags are: +

+
‘a’
+

averaged temporal noise (smoother) +

+
‘p’
+

mix random noise with a (semi)regular pattern +

+
‘t’
+

temporal noise (noise pattern changes between frames) +

+
‘u’
+

uniform noise (gaussian otherwise) +

+
+
+
+ + +

39.140.1 Examples

+ +

Add temporal and uniform noise to input video: +

+
noise=alls=20:allf=t+u
+
+ + +

39.141 normalize

+ +

Normalize RGB video (aka histogram stretching, contrast stretching). +See: https://en.wikipedia.org/wiki/Normalization_(image_processing) +

+

For each channel of each frame, the filter computes the input range and maps +it linearly to the user-specified output range. The output range defaults +to the full dynamic range from pure black to pure white. +

+

Temporal smoothing can be used on the input range to reduce flickering (rapid +changes in brightness) caused when small dark or bright objects enter or leave +the scene. This is similar to the auto-exposure (automatic gain control) on a +video camera, and, like a video camera, it may cause a period of over- or +under-exposure of the video. +

+

The R,G,B channels can be normalized independently, which may cause some +color shifting, or linked together as a single channel, which prevents +color shifting. Linked normalization preserves hue. Independent normalization +does not, so it can be used to remove some color casts. Independent and linked +normalization can be combined in any ratio. +

+

The normalize filter accepts the following options: +

+
+
blackpt
+
whitept
+

Colors which define the output range. The minimum input value is mapped to +the blackpt. The maximum input value is mapped to the whitept. +The defaults are black and white respectively. Specifying white for +blackpt and black for whitept will give color-inverted, +normalized video. Shades of grey can be used to reduce the dynamic range +(contrast). Specifying saturated colors here can create some interesting +effects. +

+
+
smoothing
+

The number of previous frames to use for temporal smoothing. The input range +of each channel is smoothed using a rolling average over the current frame +and the smoothing previous frames. The default is 0 (no temporal +smoothing). +

+
+
independence
+

Controls the ratio of independent (color shifting) channel normalization to +linked (color preserving) normalization. 0.0 is fully linked, 1.0 is fully +independent. Defaults to 1.0 (fully independent). +

+
+
strength
+

Overall strength of the filter. 1.0 is full strength. 0.0 is a rather +expensive no-op. Defaults to 1.0 (full strength). +

+
+
+ + +

39.141.1 Commands

+

This filter supports same commands as options, excluding smoothing option. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.141.2 Examples

+ +

Stretch video contrast to use the full dynamic range, with no temporal +smoothing; may flicker depending on the source content: +

+
normalize=blackpt=black:whitept=white:smoothing=0
+
+ +

As above, but with 50 frames of temporal smoothing; flicker should be +reduced, depending on the source content: +

+
normalize=blackpt=black:whitept=white:smoothing=50
+
+ +

As above, but with hue-preserving linked channel normalization: +

+
normalize=blackpt=black:whitept=white:smoothing=50:independence=0
+
+ +

As above, but with half strength: +

+
normalize=blackpt=black:whitept=white:smoothing=50:independence=0:strength=0.5
+
+ +

Map the darkest input color to red, the brightest input color to cyan: +

+
normalize=blackpt=red:whitept=cyan
+
+ + +

39.142 null

+ +

Pass the video source unchanged to the output. +

+ +

39.143 ocr

+

Optical Character Recognition +

+

This filter uses Tesseract for optical character recognition. To enable +compilation of this filter, you need to configure FFmpeg with +--enable-libtesseract. +

+

It accepts the following options: +

+
+
datapath
+

Set datapath to tesseract data. Default is to use whatever was +set at installation. +

+
+
language
+

Set language, default is "eng". +

+
+
whitelist
+

Set character whitelist. +

+
+
blacklist
+

Set character blacklist. +

+
+ +

The filter exports recognized text as the frame metadata lavfi.ocr.text. +The filter exports confidence of recognized words as the frame metadata lavfi.ocr.confidence. +

+ +

39.144 ocv

+ +

Apply a video transform using libopencv. +

+

To enable this filter, install the libopencv library and headers and +configure FFmpeg with --enable-libopencv. +

+

It accepts the following parameters: +

+
+
filter_name
+

The name of the libopencv filter to apply. +

+
+
filter_params
+

The parameters to pass to the libopencv filter. If not specified, the default +values are assumed. +

+
+
+ +

Refer to the official libopencv documentation for more precise +information: +http://docs.opencv.org/master/modules/imgproc/doc/filtering.html +

+

Several libopencv filters are supported; see the following subsections. +

+ +

39.144.1 dilate

+ +

Dilate an image by using a specific structuring element. +It corresponds to the libopencv function cvDilate. +

+

It accepts the parameters: struct_el|nb_iterations. +

+

struct_el represents a structuring element, and has the syntax: +colsxrows+anchor_xxanchor_y/shape +

+

cols and rows represent the number of columns and rows of +the structuring element, anchor_x and anchor_y the anchor +point, and shape the shape for the structuring element. shape +must be "rect", "cross", "ellipse", or "custom". +

+

If the value for shape is "custom", it must be followed by a +string of the form "=filename". The file with name +filename is assumed to represent a binary image, with each +printable character corresponding to a bright pixel. When a custom +shape is used, cols and rows are ignored, the number +or columns and rows of the read file are assumed instead. +

+

The default value for struct_el is "3x3+0x0/rect". +

+

nb_iterations specifies the number of times the transform is +applied to the image, and defaults to 1. +

+

Some examples: +

+
# Use the default values
+ocv=dilate
+
+# Dilate using a structuring element with a 5x5 cross, iterating two times
+ocv=filter_name=dilate:filter_params=5x5+2x2/cross|2
+
+# Read the shape from the file diamond.shape, iterating two times.
+# The file diamond.shape may contain a pattern of characters like this
+#   *
+#  ***
+# *****
+#  ***
+#   *
+# The specified columns and rows are ignored
+# but the anchor point coordinates are not
+ocv=dilate:0x0+2x2/custom=diamond.shape|2
+
+ + +

39.144.2 erode

+ +

Erode an image by using a specific structuring element. +It corresponds to the libopencv function cvErode. +

+

It accepts the parameters: struct_el:nb_iterations, +with the same syntax and semantics as the dilate filter. +

+ +

39.144.3 smooth

+ +

Smooth the input video. +

+

The filter takes the following parameters: +type|param1|param2|param3|param4. +

+

type is the type of smooth filter to apply, and must be one of +the following values: "blur", "blur_no_scale", "median", "gaussian", +or "bilateral". The default value is "gaussian". +

+

The meaning of param1, param2, param3, and param4 +depends on the smooth type. param1 and +param2 accept integer positive values or 0. param3 and +param4 accept floating point values. +

+

The default value for param1 is 3. The default value for the +other parameters is 0. +

+

These parameters correspond to the parameters assigned to the +libopencv function cvSmooth. +

+ +

39.145 oscilloscope

+ +

2D Video Oscilloscope. +

+

Useful to measure spatial impulse, step responses, chroma delays, etc. +

+

It accepts the following parameters: +

+
+
x
+

Set scope center x position. +

+
+
y
+

Set scope center y position. +

+
+
s
+

Set scope size, relative to frame diagonal. +

+
+
t
+

Set scope tilt/rotation. +

+
+
o
+

Set trace opacity. +

+
+
tx
+

Set trace center x position. +

+
+
ty
+

Set trace center y position. +

+
+
tw
+

Set trace width, relative to width of frame. +

+
+
th
+

Set trace height, relative to height of frame. +

+
+
c
+

Set which components to trace. By default it traces first three components. +

+
+
g
+

Draw trace grid. By default is enabled. +

+
+
st
+

Draw some statistics. By default is enabled. +

+
+
sc
+

Draw scope. By default is enabled. +

+
+ + +

39.145.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

39.145.2 Examples

+ +
    +
  • Inspect full first row of video frame. +
    +
    oscilloscope=x=0.5:y=0:s=1
+
    + +
  • Inspect full last row of video frame. +
    +
    oscilloscope=x=0.5:y=1:s=1
+
    + +
  • Inspect full 5th line of video frame of height 1080. +
    +
    oscilloscope=x=0.5:y=5/1080:s=1
+
    + +
  • Inspect full last column of video frame. +
    +
    oscilloscope=x=1:y=0.5:s=1:t=1
+
    + +
+ + +

39.146 overlay

+ +

Overlay one video on top of another. +

+

It takes two inputs and has one output. The first input is the "main" +video on which the second input is overlaid. +

+

It accepts the following parameters: +

+

A description of the accepted options follows. +

+
+
x
+
y
+

Set the expression for the x and y coordinates of the overlaid video +on the main video. Default value is "0" for both expressions. In case +the expression is invalid, it is set to a huge value (meaning that the +overlay will not be displayed within the output visible area). +

+
+
eof_action
+

See framesync. +

+
+
eval
+

Set when the expressions for x, and y are evaluated. +

+

It accepts the following values: +

+
‘init’
+

only evaluate expressions once during the filter initialization or +when a command is processed +

+
+
‘frame’
+

evaluate expressions for each incoming frame +

+
+ +

Default value is ‘frame’. +

+
+
shortest
+

See framesync. +

+
+
format
+

Set the format for the output video. +

+

It accepts the following values: +

+
‘yuv420’
+

force YUV420 output +

+
+
‘yuv422’
+

force YUV422 output +

+
+
‘yuv444’
+

force YUV444 output +

+
+
‘rgb’
+

force packed RGB output +

+
+
‘gbrp’
+

force planar RGB output +

+
+
‘auto’
+

automatically pick format +

+
+ +

Default value is ‘yuv420’. +

+
+
repeatlast
+

See framesync. +

+
+
alpha
+

Set format of alpha of the overlaid video, it can be straight or +premultiplied. Default is straight. +

+
+ +

The x, and y expressions can contain the following +parameters. +

+
+
main_w, W
+
main_h, H
+

The main input width and height. +

+
+
overlay_w, w
+
overlay_h, h
+

The overlay input width and height. +

+
+
x
+
y
+

The computed values for x and y. They are evaluated for +each new frame. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values of the output +format. For example for the pixel format "yuv422p" hsub is 2 and +vsub is 1. +

+
+
n
+

the number of input frame, starting from 0 +

+
+
pos
+

the position in the file of the input frame, NAN if unknown +

+
+
t
+

The timestamp, expressed in seconds. It’s NAN if the input timestamp is unknown. +

+
+
+ +

This filter also supports the framesync options. +

+

Note that the n, pos, t variables are available only +when evaluation is done per frame, and will evaluate to NAN +when eval is set to ‘init’. +

+

Be aware that frames are taken from each input video in timestamp +order, hence, if their initial timestamps differ, it is a good idea +to pass the two inputs through a setpts=PTS-STARTPTS filter to +have them begin in the same zero timestamp, as the example for +the movie filter does. +

+

You can chain together more overlays but you should test the +efficiency of such approach. +

+ +

39.146.1 Commands

+ +

This filter supports the following commands: +

+
x
+
y
+

Modify the x and y of the overlay input. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

39.146.2 Examples

+ +
    +
  • Draw the overlay at 10 pixels from the bottom right corner of the main +video: +
    +
    overlay=main_w-overlay_w-10:main_h-overlay_h-10
+
    + +

    Using named options the example above becomes: +

    +
    overlay=x=main_w-overlay_w-10:y=main_h-overlay_h-10
+
    + +
  • Insert a transparent PNG logo in the bottom left corner of the input, +using the ffmpeg tool with the -filter_complex option: +
    +
    ffmpeg -i input -i logo -filter_complex 'overlay=10:main_h-overlay_h-10' output
+
    + +
  • Insert 2 different transparent PNG logos (second logo on bottom +right corner) using the ffmpeg tool: +
    +
    ffmpeg -i input -i logo1 -i logo2 -filter_complex 'overlay=x=10:y=H-h-10,overlay=x=W-w-10:y=H-h-10' output
+
    + +
  • Add a transparent color layer on top of the main video; WxH +must specify the size of the main input to the overlay filter: +
    +
    color=color=red@.3:size=WxH [over]; [in][over] overlay [out]
+
    + +
  • Play an original video and a filtered version (here with the deshake +filter) side by side using the ffplay tool: +
    +
    ffplay input.avi -vf 'split[a][b]; [a]pad=iw*2:ih[src]; [b]deshake[filt]; [src][filt]overlay=w'
+
    + +

    The above command is the same as: +

    +
    ffplay input.avi -vf 'split[b], pad=iw*2[src], [b]deshake, [src]overlay=w'
+
    + +
  • Make a sliding overlay appearing from the left to the right top part of the +screen starting since time 2: +
    +
    overlay=x='if(gte(t,2), -w+(t-2)*20, NAN)':y=0
+
    + +
  • Compose output by putting two input videos side to side: +
    +
    ffmpeg -i left.avi -i right.avi -filter_complex "
+nullsrc=size=200x100 [background];
+[0:v] setpts=PTS-STARTPTS, scale=100x100 [left];
+[1:v] setpts=PTS-STARTPTS, scale=100x100 [right];
+[background][left]       overlay=shortest=1       [background+left];
+[background+left][right] overlay=shortest=1:x=100 [left+right]
+"
+
    + +
  • Mask 10-20 seconds of a video by applying the delogo filter to a section +
    +
    ffmpeg -i test.avi -codec:v:0 wmv2 -ar 11025 -b:v 9000k
+-vf '[in]split[split_main][split_delogo];[split_delogo]trim=start=360:end=371,delogo=0:0:640:480[delogoed];[split_main][delogoed]overlay=eof_action=pass[out]'
+masked.avi
+
    + +
  • Chain several overlays in cascade: +
    +
    nullsrc=s=200x200 [bg];
+testsrc=s=100x100, split=4 [in0][in1][in2][in3];
+[in0] lutrgb=r=0, [bg]   overlay=0:0     [mid0];
+[in1] lutrgb=g=0, [mid0] overlay=100:0   [mid1];
+[in2] lutrgb=b=0, [mid1] overlay=0:100   [mid2];
+[in3] null,       [mid2] overlay=100:100 [out0]
+
    + +
+ + +

39.147 overlay_cuda

+ +

Overlay one video on top of another. +

+

This is the CUDA cariant of the overlay filter. +It only accepts CUDA frames. The underlying input pixel formats have to match. +

+

It takes two inputs and has one output. The first input is the "main" +video on which the second input is overlaid. +

+

It accepts the following parameters: +

+
+
x
+
y
+

Set the x and y coordinates of the overlaid video on the main video. +Default value is "0" for both expressions. +

+
+
eof_action
+

See framesync. +

+
+
shortest
+

See framesync. +

+
+
repeatlast
+

See framesync. +

+
+
+ +

This filter also supports the framesync options. +

+ +

39.148 owdenoise

+ +

Apply Overcomplete Wavelet denoiser. +

+

The filter accepts the following options: +

+
+
depth
+

Set depth. +

+

Larger depth values will denoise lower frequency components more, but +slow down filtering. +

+

Must be an int in the range 8-16, default is 8. +

+
+
luma_strength, ls
+

Set luma strength. +

+

Must be a double value in the range 0-1000, default is 1.0. +

+
+
chroma_strength, cs
+

Set chroma strength. +

+

Must be a double value in the range 0-1000, default is 1.0. +

+
+ + +

39.149 pad

+ +

Add paddings to the input image, and place the original input at the +provided x, y coordinates. +

+

It accepts the following parameters: +

+
+
width, w
+
height, h
+

Specify an expression for the size of the output image with the +paddings added. If the value for width or height is 0, the +corresponding input size is used for the output. +

+

The width expression can reference the value set by the +height expression, and vice versa. +

+

The default value of width and height is 0. +

+
+
x
+
y
+

Specify the offsets to place the input image at within the padded area, +with respect to the top/left border of the output image. +

+

The x expression can reference the value set by the y +expression, and vice versa. +

+

The default value of x and y is 0. +

+

If x or y evaluate to a negative number, they’ll be changed +so the input image is centered on the padded area. +

+
+
color
+

Specify the color of the padded area. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. +

+

The default value of color is "black". +

+
+
eval
+

Specify when to evaluate width, height, x and y expression. +

+

It accepts the following values: +

+
+
‘init’
+

Only evaluate expressions once during the filter initialization or when +a command is processed. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. +

+
+
+ +

Default value is ‘init’. +

+
+
aspect
+

Pad to aspect instead to a resolution. +

+
+
+ +

The value for the width, height, x, and y +options are expressions containing the following constants: +

+
+
in_w
+
in_h
+

The input video width and height. +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output width and height (the size of the padded area), as +specified by the width and height expressions. +

+
+
ow
+
oh
+

These are the same as out_w and out_h. +

+
+
x
+
y
+

The x and y offsets as specified by the x and y +expressions, or NAN if not yet specified. +

+
+
a
+

same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (iw / ih) * sar +

+
+
hsub
+
vsub
+

The horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+ + +

39.149.1 Examples

+ +
    +
  • Add paddings with the color "violet" to the input video. The output video +size is 640x480, and the top-left corner of the input video is placed at +column 0, row 40 +
    +
    pad=640:480:0:40:violet
+
    + +

    The example above is equivalent to the following command: +

    +
    pad=width=640:height=480:x=0:y=40:color=violet
+
    + +
  • Pad the input to get an output with dimensions increased by 3/2, +and put the input video at the center of the padded area: +
    +
    pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • Pad the input to get a squared output with size equal to the maximum +value between the input width and height, and put the input video at +the center of the padded area: +
    +
    pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • Pad the input to get a final w/h ratio of 16:9: +
    +
    pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • In case of anamorphic video, in order to set the output display aspect +correctly, it is necessary to use sar in the expression, +according to the relation: +
    +
    (ih * X / ih) * sar = output_dar
+X = output_dar / sar
+
    + +

    Thus the previous example needs to be modified to: +

    +
    pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • Double the output size and put the input video in the bottom-right +corner of the output padded area: +
    +
    pad="2*iw:2*ih:ow-iw:oh-ih"
+
    +
+ + +

39.150 palettegen

+ +

Generate one palette for a whole video stream. +

+

It accepts the following options: +

+
+
max_colors
+

Set the maximum number of colors to quantize in the palette. +Note: the palette will still contain 256 colors; the unused palette entries +will be black. +

+
+
reserve_transparent
+

Create a palette of 255 colors maximum and reserve the last one for +transparency. Reserving the transparency color is useful for GIF optimization. +If not set, the maximum of colors in the palette will be 256. You probably want +to disable this option for a standalone image. +Set by default. +

+
+
transparency_color
+

Set the color that will be used as background for transparency. +

+
+
stats_mode
+

Set statistics mode. +

+

It accepts the following values: +

+
‘full’
+

Compute full frame histograms. +

+
‘diff’
+

Compute histograms only for the part that differs from previous frame. This +might be relevant to give more importance to the moving part of your input if +the background is static. +

+
‘single’
+

Compute new histogram for each frame. +

+
+ +

Default value is full. +

+
+ +

The filter also exports the frame metadata lavfi.color_quant_ratio +(nb_color_in / nb_color_out) which you can use to evaluate the degree of +color quantization of the palette. This information is also visible at +info logging level. +

+ +

39.150.1 Examples

+ +
    +
  • Generate a representative palette of a given video using ffmpeg: +
    +
    ffmpeg -i input.mkv -vf palettegen palette.png
+
    +
+ + +

39.151 paletteuse

+ +

Use a palette to downsample an input video stream. +

+

The filter takes two inputs: one video stream and a palette. The palette must +be a 256 pixels image. +

+

It accepts the following options: +

+
+
dither
+

Select dithering mode. Available algorithms are: +

+
‘bayer’
+

Ordered 8x8 bayer dithering (deterministic) +

+
‘heckbert’
+

Dithering as defined by Paul Heckbert in 1982 (simple error diffusion). +Note: this dithering is sometimes considered "wrong" and is included as a +reference. +

+
‘floyd_steinberg’
+

Floyd and Steingberg dithering (error diffusion) +

+
‘sierra2’
+

Frankie Sierra dithering v2 (error diffusion) +

+
‘sierra2_4a’
+

Frankie Sierra dithering v2 "Lite" (error diffusion) +

+
+ +

Default is sierra2_4a. +

+
+
bayer_scale
+

When bayer dithering is selected, this option defines the scale of the +pattern (how much the crosshatch pattern is visible). A low value means more +visible pattern for less banding, and higher value means less visible pattern +at the cost of more banding. +

+

The option must be an integer value in the range [0,5]. Default is 2. +

+
+
diff_mode
+

If set, define the zone to process +

+
+
‘rectangle’
+

Only the changing rectangle will be reprocessed. This is similar to GIF +cropping/offsetting compression mechanism. This option can be useful for speed +if only a part of the image is changing, and has use cases such as limiting the +scope of the error diffusal dither to the rectangle that bounds the +moving scene (it leads to more deterministic output if the scene doesn’t change +much, and as a result less moving noise and better GIF compression). +

+
+ +

Default is none. +

+
+
new
+

Take new palette for each output frame. +

+
+
alpha_threshold
+

Sets the alpha threshold for transparency. Alpha values above this threshold +will be treated as completely opaque, and values below this threshold will be +treated as completely transparent. +

+

The option must be an integer value in the range [0,255]. Default is 128. +

+
+ + +

39.151.1 Examples

+ +
    +
  • Use a palette (generated for example with palettegen) to encode a GIF +using ffmpeg: +
    +
    ffmpeg -i input.mkv -i palette.png -lavfi paletteuse output.gif
+
    +
+ + +

39.152 perspective

+ +

Correct perspective of video not recorded perpendicular to the screen. +

+

A description of the accepted parameters follows. +

+
+
x0
+
y0
+
x1
+
y1
+
x2
+
y2
+
x3
+
y3
+

Set coordinates expression for top left, top right, bottom left and bottom right corners. +Default values are 0:0:W:0:0:H:W:H with which perspective will remain unchanged. +If the sense option is set to source, then the specified points will be sent +to the corners of the destination. If the sense option is set to destination, +then the corners of the source will be sent to the specified coordinates. +

+

The expressions can use the following variables: +

+
+
W
+
H
+

the width and height of video frame. +

+
in
+

Input frame count. +

+
on
+

Output frame count. +

+
+ +
+
interpolation
+

Set interpolation for perspective correction. +

+

It accepts the following values: +

+
‘linear’
+
‘cubic’
+
+ +

Default value is ‘linear’. +

+
+
sense
+

Set interpretation of coordinate options. +

+

It accepts the following values: +

+
‘0, source’
+
+

Send point in the source specified by the given coordinates to +the corners of the destination. +

+
+
‘1, destination’
+
+

Send the corners of the source to the point in the destination specified +by the given coordinates. +

+

Default value is ‘source’. +

+
+ +
+
eval
+

Set when the expressions for coordinates x0,y0,...x3,y3 are evaluated. +

+

It accepts the following values: +

+
‘init’
+

only evaluate expressions once during the filter initialization or +when a command is processed +

+
+
‘frame’
+

evaluate expressions for each incoming frame +

+
+ +

Default value is ‘init’. +

+
+ + +

39.153 phase

+ +

Delay interlaced video by one field time so that the field order changes. +

+

The intended use is to fix PAL movies that have been captured with the +opposite field order to the film-to-video transfer. +

+

A description of the accepted parameters follows. +

+
+
mode
+

Set phase mode. +

+

It accepts the following values: +

+
‘t’
+

Capture field order top-first, transfer bottom-first. +Filter will delay the bottom field. +

+
+
‘b’
+

Capture field order bottom-first, transfer top-first. +Filter will delay the top field. +

+
+
‘p’
+

Capture and transfer with the same field order. This mode only exists +for the documentation of the other options to refer to, but if you +actually select it, the filter will faithfully do nothing. +

+
+
‘a’
+

Capture field order determined automatically by field flags, transfer +opposite. +Filter selects among ‘t’ and ‘b’ modes on a frame by frame +basis using field flags. If no field information is available, +then this works just like ‘u’. +

+
+
‘u’
+

Capture unknown or varying, transfer opposite. +Filter selects among ‘t’ and ‘b’ on a frame by frame basis by +analyzing the images and selecting the alternative that produces best +match between the fields. +

+
+
‘T’
+

Capture top-first, transfer unknown or varying. +Filter selects among ‘t’ and ‘p’ using image analysis. +

+
+
‘B’
+

Capture bottom-first, transfer unknown or varying. +Filter selects among ‘b’ and ‘p’ using image analysis. +

+
+
‘A’
+

Capture determined by field flags, transfer unknown or varying. +Filter selects among ‘t’, ‘b’ and ‘p’ using field flags and +image analysis. If no field information is available, then this works just +like ‘U’. This is the default mode. +

+
+
‘U’
+

Both capture and transfer unknown or varying. +Filter selects among ‘t’, ‘b’ and ‘p’ using image analysis only. +

+
+
+
+ + +

39.154 photosensitivity

+

Reduce various flashes in video, so to help users with epilepsy. +

+

It accepts the following options: +

+
frames, f
+

Set how many frames to use when filtering. Default is 30. +

+
+
threshold, t
+

Set detection threshold factor. Default is 1. +Lower is stricter. +

+
+
skip
+

Set how many pixels to skip when sampling frames. Default is 1. +Allowed range is from 1 to 1024. +

+
+
bypass
+

Leave frames unchanged. Default is disabled. +

+
+ + +

39.155 pixdesctest

+ +

Pixel format descriptor test filter, mainly useful for internal +testing. The output video should be equal to the input video. +

+

For example: +

+
format=monow, pixdesctest
+
+ +

can be used to test the monowhite pixel format descriptor definition. +

+ +

39.156 pixscope

+ +

Display sample values of color channels. Mainly useful for checking color +and levels. Minimum supported resolution is 640x480. +

+

The filters accept the following options: +

+
+
x
+

Set scope X position, relative offset on X axis. +

+
+
y
+

Set scope Y position, relative offset on Y axis. +

+
+
w
+

Set scope width. +

+
+
h
+

Set scope height. +

+
+
o
+

Set window opacity. This window also holds statistics about pixel area. +

+
+
wx
+

Set window X position, relative offset on X axis. +

+
+
wy
+

Set window Y position, relative offset on Y axis. +

+
+ + +

39.157 pp

+ +

Enable the specified chain of postprocessing subfilters using libpostproc. This +library should be automatically selected with a GPL build (--enable-gpl). +Subfilters must be separated by ’/’ and can be disabled by prepending a ’-’. +Each subfilter and some options have a short and a long name that can be used +interchangeably, i.e. dr/dering are the same. +

+

The filters accept the following options: +

+
+
subfilters
+

Set postprocessing subfilters string. +

+
+ +

All subfilters share common options to determine their scope: +

+
+
a/autoq
+

Honor the quality commands for this subfilter. +

+
+
c/chrom
+

Do chrominance filtering, too (default). +

+
+
y/nochrom
+

Do luminance filtering only (no chrominance). +

+
+
n/noluma
+

Do chrominance filtering only (no luminance). +

+
+ +

These options can be appended after the subfilter name, separated by a ’|’. +

+

Available subfilters are: +

+
+
hb/hdeblock[|difference[|flatness]]
+

Horizontal deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+ +
+
vb/vdeblock[|difference[|flatness]]
+

Vertical deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+ +
+
ha/hadeblock[|difference[|flatness]]
+

Accurate horizontal deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+ +
+
va/vadeblock[|difference[|flatness]]
+

Accurate vertical deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+
+
+ +

The horizontal and vertical deblocking filters share the difference and +flatness values so you cannot set different horizontal and vertical +thresholds. +

+
+
h1/x1hdeblock
+

Experimental horizontal deblocking filter +

+
+
v1/x1vdeblock
+

Experimental vertical deblocking filter +

+
+
dr/dering
+

Deringing filter +

+
+
tn/tmpnoise[|threshold1[|threshold2[|threshold3]]], temporal noise reducer
+
+
threshold1
+

larger -> stronger filtering +

+
threshold2
+

larger -> stronger filtering +

+
threshold3
+

larger -> stronger filtering +

+
+ +
+
al/autolevels[:f/fullyrange], automatic brightness / contrast correction
+
+
f/fullyrange
+

Stretch luminance to 0-255. +

+
+ +
+
lb/linblenddeint
+

Linear blend deinterlacing filter that deinterlaces the given block by +filtering all lines with a (1 2 1) filter. +

+
+
li/linipoldeint
+

Linear interpolating deinterlacing filter that deinterlaces the given block by +linearly interpolating every second line. +

+
+
ci/cubicipoldeint
+

Cubic interpolating deinterlacing filter deinterlaces the given block by +cubically interpolating every second line. +

+
+
md/mediandeint
+

Median deinterlacing filter that deinterlaces the given block by applying a +median filter to every second line. +

+
+
fd/ffmpegdeint
+

FFmpeg deinterlacing filter that deinterlaces the given block by filtering every +second line with a (-1 4 2 4 -1) filter. +

+
+
l5/lowpass5
+

Vertically applied FIR lowpass deinterlacing filter that deinterlaces the given +block by filtering all lines with a (-1 2 6 2 -1) filter. +

+
+
fq/forceQuant[|quantizer]
+

Overrides the quantizer table from the input with the constant quantizer you +specify. +

+
quantizer
+

Quantizer to use +

+
+ +
+
de/default
+

Default pp filter combination (hb|a,vb|a,dr|a) +

+
+
fa/fast
+

Fast pp filter combination (h1|a,v1|a,dr|a) +

+
+
ac
+

High quality pp filter combination (ha|a|128|7,va|a,dr|a) +

+
+ + +

39.157.1 Examples

+ +
    +
  • Apply horizontal and vertical deblocking, deringing and automatic +brightness/contrast: +
    +
    pp=hb/vb/dr/al
+
    + +
  • Apply default filters without brightness/contrast correction: +
    +
    pp=de/-al
+
    + +
  • Apply default filters and temporal denoiser: +
    +
    pp=default/tmpnoise|1|2|3
+
    + +
  • Apply deblocking on luminance only, and switch vertical deblocking on or off +automatically depending on available CPU time: +
    +
    pp=hb|y/vb|a
+
    +
+ + +

39.158 pp7

+

Apply Postprocessing filter 7. It is variant of the spp filter, +similar to spp = 6 with 7 point DCT, where only the center sample is +used after IDCT. +

+

The filter accepts the following options: +

+
+
qp
+

Force a constant quantization parameter. It accepts an integer in range +0 to 63. If not set, the filter will use the QP from the video stream +(if available). +

+
+
mode
+

Set thresholding mode. Available modes are: +

+
+
‘hard’
+

Set hard thresholding. +

+
‘soft’
+

Set soft thresholding (better de-ringing effect, but likely blurrier). +

+
‘medium’
+

Set medium thresholding (good results, default). +

+
+
+
+ + +

39.159 premultiply

+

Apply alpha premultiply effect to input video stream using first plane +of second stream as alpha. +

+

Both streams must have same dimensions and same pixel format. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
inplace
+

Do not require 2nd input for processing, instead use alpha plane from input stream. +

+
+ + +

39.160 prewitt

+

Apply prewitt operator to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +

+
+
delta
+

Set value which will be added to filtered result. +

+
+ + +

39.161 pseudocolor

+ +

Alter frame colors in video with pseudocolors. +

+

This filter accepts the following options: +

+
+
c0
+

set pixel first component expression +

+
+
c1
+

set pixel second component expression +

+
+
c2
+

set pixel third component expression +

+
+
c3
+

set pixel fourth component expression, corresponds to the alpha component +

+
+
i
+

set component to use as base for altering colors +

+
+ +

Each of them specifies the expression to use for computing the lookup table for +the corresponding pixel component values. +

+

The expressions can contain the following constants and functions: +

+
+
w
+
h
+

The input width and height. +

+
+
val
+

The input value for the pixel component. +

+
+
ymin, umin, vmin, amin
+

The minimum allowed component value. +

+
+
ymax, umax, vmax, amax
+

The maximum allowed component value. +

+
+ +

All expressions default to "val". +

+ +

39.161.1 Examples

+ +
    +
  • Change too high luma values to gradient: +
    +
    pseudocolor="'if(between(val,ymax,amax),lerp(ymin,ymax,(val-ymax)/(amax-ymax)),-1):if(between(val,ymax,amax),lerp(umax,umin,(val-ymax)/(amax-ymax)),-1):if(between(val,ymax,amax),lerp(vmin,vmax,(val-ymax)/(amax-ymax)),-1):-1'"
+
    +
+ + +

39.162 psnr

+ +

Obtain the average, maximum and minimum PSNR (Peak Signal to Noise +Ratio) between two input videos. +

+

This filter takes in input two input videos, the first input is +considered the "main" source and is passed unchanged to the +output. The second input is used as a "reference" video for computing +the PSNR. +

+

Both video inputs must have the same resolution and pixel format for +this filter to work correctly. Also it assumes that both inputs +have the same number of frames, which are compared one by one. +

+

The obtained average PSNR is printed through the logging system. +

+

The filter stores the accumulated MSE (mean squared error) of each +frame, and at the end of the processing it is averaged across all frames +equally, and the following formula is applied to obtain the PSNR: +

+
+
PSNR = 10*log10(MAX^2/MSE)
+
+ +

Where MAX is the average of the maximum values of each component of the +image. +

+

The description of the accepted parameters follows. +

+
+
stats_file, f
+

If specified the filter will use the named file to save the PSNR of +each individual frame. When filename equals "-" the data is sent to +standard output. +

+
+
stats_version
+

Specifies which version of the stats file format to use. Details of +each format are written below. +Default value is 1. +

+
+
stats_add_max
+

Determines whether the max value is output to the stats log. +Default value is 0. +Requires stats_version >= 2. If this is set and stats_version < 2, +the filter will return an error. +

+
+ +

This filter also supports the framesync options. +

+

The file printed if stats_file is selected, contains a sequence of +key/value pairs of the form key:value for each compared +couple of frames. +

+

If a stats_version greater than 1 is specified, a header line precedes +the list of per-frame-pair stats, with key value pairs following the frame +format with the following parameters: +

+
+
psnr_log_version
+

The version of the log file format. Will match stats_version. +

+
+
fields
+

A comma separated list of the per-frame-pair parameters included in +the log. +

+
+ +

A description of each shown per-frame-pair parameter follows: +

+
+
n
+

sequential number of the input frame, starting from 1 +

+
+
mse_avg
+

Mean Square Error pixel-by-pixel average difference of the compared +frames, averaged over all the image components. +

+
+
mse_y, mse_u, mse_v, mse_r, mse_g, mse_b, mse_a
+

Mean Square Error pixel-by-pixel average difference of the compared +frames for the component specified by the suffix. +

+
+
psnr_y, psnr_u, psnr_v, psnr_r, psnr_g, psnr_b, psnr_a
+

Peak Signal to Noise ratio of the compared frames for the component +specified by the suffix. +

+
+
max_avg, max_y, max_u, max_v
+

Maximum allowed value for each channel, and average over all +channels. +

+
+ + +

39.162.1 Examples

+
    +
  • For example: +
    +
    movie=ref_movie.mpg, setpts=PTS-STARTPTS [main];
+[main][ref] psnr="stats_file=stats.log" [out]
+
    + +

    On this example the input file being processed is compared with the +reference file ref_movie.mpg. The PSNR of each individual frame +is stored in stats.log. +

    +
  • Another example with different containers: +
    +
    ffmpeg -i main.mpg -i ref.mkv -lavfi  "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]psnr" -f null -
+
    +
+ + +

39.163 pullup

+ +

Pulldown reversal (inverse telecine) filter, capable of handling mixed +hard-telecine, 24000/1001 fps progressive, and 30000/1001 fps progressive +content. +

+

The pullup filter is designed to take advantage of future context in making +its decisions. This filter is stateless in the sense that it does not lock +onto a pattern to follow, but it instead looks forward to the following +fields in order to identify matches and rebuild progressive frames. +

+

To produce content with an even framerate, insert the fps filter after +pullup, use fps=24000/1001 if the input frame rate is 29.97fps, +fps=24 for 30fps and the (rare) telecined 25fps input. +

+

The filter accepts the following options: +

+
+
jl
+
jr
+
jt
+
jb
+

These options set the amount of "junk" to ignore at the left, right, top, and +bottom of the image, respectively. Left and right are in units of 8 pixels, +while top and bottom are in units of 2 lines. +The default is 8 pixels on each side. +

+
+
sb
+

Set the strict breaks. Setting this option to 1 will reduce the chances of +filter generating an occasional mismatched frame, but it may also cause an +excessive number of frames to be dropped during high motion sequences. +Conversely, setting it to -1 will make filter match fields more easily. +This may help processing of video where there is slight blurring between +the fields, but may also cause there to be interlaced frames in the output. +Default value is 0. +

+
+
mp
+

Set the metric plane to use. It accepts the following values: +

+
‘l’
+

Use luma plane. +

+
+
‘u’
+

Use chroma blue plane. +

+
+
‘v’
+

Use chroma red plane. +

+
+ +

This option may be set to use chroma plane instead of the default luma plane +for doing filter’s computations. This may improve accuracy on very clean +source material, but more likely will decrease accuracy, especially if there +is chroma noise (rainbow effect) or any grayscale video. +The main purpose of setting mp to a chroma plane is to reduce CPU +load and make pullup usable in realtime on slow machines. +

+
+ +

For best results (without duplicated frames in the output file) it is +necessary to change the output frame rate. For example, to inverse +telecine NTSC input: +

+
ffmpeg -i input -vf pullup -r 24000/1001 ...
+
+ + +

39.164 qp

+ +

Change video quantization parameters (QP). +

+

The filter accepts the following option: +

+
+
qp
+

Set expression for quantization parameter. +

+
+ +

The expression is evaluated through the eval API and can contain, among others, +the following constants: +

+
+
known
+

1 if index is not 129, 0 otherwise. +

+
+
qp
+

Sequential index starting from -129 to 128. +

+
+ + +

39.164.1 Examples

+ +
    +
  • Some equation like: +
    +
    qp=2+2*sin(PI*qp)
+
    +
+ + +

39.165 random

+ +

Flush video frames from internal cache of frames into a random order. +No frame is discarded. +Inspired by frei0r nervous filter. +

+
+
frames
+

Set size in number of frames of internal cache, in range from 2 to +512. Default is 30. +

+
+
seed
+

Set seed for random number generator, must be an integer included between +0 and UINT32_MAX. If not specified, or if explicitly set to +less than 0, the filter will try to use a good random seed on a +best effort basis. +

+
+ + +

39.166 readeia608

+ +

Read closed captioning (EIA-608) information from the top lines of a video frame. +

+

This filter adds frame metadata for lavfi.readeia608.X.cc and +lavfi.readeia608.X.line, where X is the number of the identified line +with EIA-608 data (starting from 0). A description of each metadata value follows: +

+
+
lavfi.readeia608.X.cc
+

The two bytes stored as EIA-608 data (printed in hexadecimal). +

+
+
lavfi.readeia608.X.line
+

The number of the line on which the EIA-608 data was identified and read. +

+
+ +

This filter accepts the following options: +

+
+
scan_min
+

Set the line to start scanning for EIA-608 data. Default is 0. +

+
+
scan_max
+

Set the line to end scanning for EIA-608 data. Default is 29. +

+
+
spw
+

Set the ratio of width reserved for sync code detection. +Default is 0.27. Allowed range is [0.1 - 0.7]. +

+
+
chp
+

Enable checking the parity bit. In the event of a parity error, the filter will output +0x00 for that character. Default is false. +

+
+
lp
+

Lowpass lines prior to further processing. Default is enabled. +

+
+ + +

39.166.1 Examples

+ +
    +
  • Output a csv with presentation time and the first two lines of identified EIA-608 captioning data. +
    +
    ffprobe -f lavfi -i movie=captioned_video.mov,readeia608 -show_entries frame=pkt_pts_time:frame_tags=lavfi.readeia608.0.cc,lavfi.readeia608.1.cc -of csv
+
    +
+ + +

39.167 readvitc

+ +

Read vertical interval timecode (VITC) information from the top lines of a +video frame. +

+

The filter adds frame metadata key lavfi.readvitc.tc_str with the +timecode value, if a valid timecode has been detected. Further metadata key +lavfi.readvitc.found is set to 0/1 depending on whether +timecode data has been found or not. +

+

This filter accepts the following options: +

+
+
scan_max
+

Set the maximum number of lines to scan for VITC data. If the value is set to +-1 the full video frame is scanned. Default is 45. +

+
+
thr_b
+

Set the luma threshold for black. Accepts float numbers in the range [0.0,1.0], +default value is 0.2. The value must be equal or less than thr_w. +

+
+
thr_w
+

Set the luma threshold for white. Accepts float numbers in the range [0.0,1.0], +default value is 0.6. The value must be equal or greater than thr_b. +

+
+ + +

39.167.1 Examples

+ +
    +
  • Detect and draw VITC data onto the video frame; if no valid VITC is detected, +draw --:--:--:-- as a placeholder: +
    +
    ffmpeg -i input.avi -filter:v 'readvitc,drawtext=fontfile=FreeMono.ttf:text=%{metadata\\:lavfi.readvitc.tc_str\\:--\\\\\\:--\\\\\\:--\\\\\\:--}:x=(w-tw)/2:y=400-ascent'
+
    +
+ + +

39.168 remap

+ +

Remap pixels using 2nd: Xmap and 3rd: Ymap input video stream. +

+

Destination pixel at position (X, Y) will be picked from source (x, y) position +where x = Xmap(X, Y) and y = Ymap(X, Y). If mapping values are out of range, zero +value for pixel will be used for destination pixel. +

+

Xmap and Ymap input video streams must be of same dimensions. Output video stream +will have Xmap/Ymap video stream dimensions. +Xmap and Ymap input video streams are 16bit depth, single channel. +

+
+
format
+

Specify pixel format of output from this filter. Can be color or gray. +Default is color. +

+
+
fill
+

Specify the color of the unmapped pixels. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. Default color is black. +

+
+ + +

39.169 removegrain

+ +

The removegrain filter is a spatial denoiser for progressive video. +

+
+
m0
+

Set mode for the first plane. +

+
+
m1
+

Set mode for the second plane. +

+
+
m2
+

Set mode for the third plane. +

+
+
m3
+

Set mode for the fourth plane. +

+
+ +

Range of mode is from 0 to 24. Description of each mode follows: +

+
+
0
+

Leave input plane unchanged. Default. +

+
+
1
+

Clips the pixel with the minimum and maximum of the 8 neighbour pixels. +

+
+
2
+

Clips the pixel with the second minimum and maximum of the 8 neighbour pixels. +

+
+
3
+

Clips the pixel with the third minimum and maximum of the 8 neighbour pixels. +

+
+
4
+

Clips the pixel with the fourth minimum and maximum of the 8 neighbour pixels. +This is equivalent to a median filter. +

+
+
5
+

Line-sensitive clipping giving the minimal change. +

+
+
6
+

Line-sensitive clipping, intermediate. +

+
+
7
+

Line-sensitive clipping, intermediate. +

+
+
8
+

Line-sensitive clipping, intermediate. +

+
+
9
+

Line-sensitive clipping on a line where the neighbours pixels are the closest. +

+
+
10
+

Replaces the target pixel with the closest neighbour. +

+
+
11
+

[1 2 1] horizontal and vertical kernel blur. +

+
+
12
+

Same as mode 11. +

+
+
13
+

Bob mode, interpolates top field from the line where the neighbours +pixels are the closest. +

+
+
14
+

Bob mode, interpolates bottom field from the line where the neighbours +pixels are the closest. +

+
+
15
+

Bob mode, interpolates top field. Same as 13 but with a more complicated +interpolation formula. +

+
+
16
+

Bob mode, interpolates bottom field. Same as 14 but with a more complicated +interpolation formula. +

+
+
17
+

Clips the pixel with the minimum and maximum of respectively the maximum and +minimum of each pair of opposite neighbour pixels. +

+
+
18
+

Line-sensitive clipping using opposite neighbours whose greatest distance from +the current pixel is minimal. +

+
+
19
+

Replaces the pixel with the average of its 8 neighbours. +

+
+
20
+

Averages the 9 pixels ([1 1 1] horizontal and vertical blur). +

+
+
21
+

Clips pixels using the averages of opposite neighbour. +

+
+
22
+

Same as mode 21 but simpler and faster. +

+
+
23
+

Small edge and halo removal, but reputed useless. +

+
+
24
+

Similar as 23. +

+
+ + +

39.170 removelogo

+ +

Suppress a TV station logo, using an image file to determine which +pixels comprise the logo. It works by filling in the pixels that +comprise the logo with neighboring pixels. +

+

The filter accepts the following options: +

+
+
filename, f
+

Set the filter bitmap file, which can be any image format supported by +libavformat. The width and height of the image file must match those of the +video stream being processed. +

+
+ +

Pixels in the provided bitmap image with a value of zero are not +considered part of the logo, non-zero pixels are considered part of +the logo. If you use white (255) for the logo and black (0) for the +rest, you will be safe. For making the filter bitmap, it is +recommended to take a screen capture of a black frame with the logo +visible, and then using a threshold filter followed by the erode +filter once or twice. +

+

If needed, little splotches can be fixed manually. Remember that if +logo pixels are not covered, the filter quality will be much +reduced. Marking too many pixels as part of the logo does not hurt as +much, but it will increase the amount of blurring needed to cover over +the image and will destroy more information than necessary, and extra +pixels will slow things down on a large logo. +

+ +

39.171 repeatfields

+ +

This filter uses the repeat_field flag from the Video ES headers and hard repeats +fields based on its value. +

+ +

39.172 reverse

+ +

Reverse a video clip. +

+

Warning: This filter requires memory to buffer the entire clip, so trimming +is suggested. +

+ +

39.172.1 Examples

+ +
    +
  • Take the first 5 seconds of a clip, and reverse it. +
    +
    trim=end=5,reverse
+
    +
+ + +

39.173 rgbashift

+

Shift R/G/B/A pixels horizontally and/or vertically. +

+

The filter accepts the following options: +

+
rh
+

Set amount to shift red horizontally. +

+
rv
+

Set amount to shift red vertically. +

+
gh
+

Set amount to shift green horizontally. +

+
gv
+

Set amount to shift green vertically. +

+
bh
+

Set amount to shift blue horizontally. +

+
bv
+

Set amount to shift blue vertically. +

+
ah
+

Set amount to shift alpha horizontally. +

+
av
+

Set amount to shift alpha vertically. +

+
edge
+

Set edge mode, can be smear, default, or warp. +

+
+ + +

39.173.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

39.174 roberts

+

Apply roberts cross operator to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +

+
+
delta
+

Set value which will be added to filtered result. +

+
+ + +

39.175 rotate

+ +

Rotate video by an arbitrary angle expressed in radians. +

+

The filter accepts the following options: +

+

A description of the optional parameters follows. +

+
angle, a
+

Set an expression for the angle by which to rotate the input video +clockwise, expressed as a number of radians. A negative value will +result in a counter-clockwise rotation. By default it is set to "0". +

+

This expression is evaluated for each frame. +

+
+
out_w, ow
+

Set the output width expression, default value is "iw". +This expression is evaluated just once during configuration. +

+
+
out_h, oh
+

Set the output height expression, default value is "ih". +This expression is evaluated just once during configuration. +

+
+
bilinear
+

Enable bilinear interpolation if set to 1, a value of 0 disables +it. Default value is 1. +

+
+
fillcolor, c
+

Set the color used to fill the output area not covered by the rotated +image. For the general syntax of this option, check the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +If the special value "none" is selected then no +background is printed (useful for example if the background is never shown). +

+

Default value is "black". +

+
+ +

The expressions for the angle and the output size can contain the +following constants and functions: +

+
+
n
+

sequential number of the input frame, starting from 0. It is always NAN +before the first frame is filtered. +

+
+
t
+

time in seconds of the input frame, it is set to 0 when the filter is +configured. It is always NAN before the first frame is filtered. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
in_w, iw
+
in_h, ih
+

the input video width and height +

+
+
out_w, ow
+
out_h, oh
+

the output width and height, that is the size of the padded area as +specified by the width and height expressions +

+
+
rotw(a)
+
roth(a)
+

the minimal width/height required for completely containing the input +video rotated by a radians. +

+

These are only available when computing the out_w and +out_h expressions. +

+
+ + +

39.175.1 Examples

+ +
    +
  • Rotate the input by PI/6 radians clockwise: +
    +
    rotate=PI/6
+
    + +
  • Rotate the input by PI/6 radians counter-clockwise: +
    +
    rotate=-PI/6
+
    + +
  • Rotate the input by 45 degrees clockwise: +
    +
    rotate=45*PI/180
+
    + +
  • Apply a constant rotation with period T, starting from an angle of PI/3: +
    +
    rotate=PI/3+2*PI*t/T
+
    + +
  • Make the input video rotation oscillating with a period of T +seconds and an amplitude of A radians: +
    +
    rotate=A*sin(2*PI/T*t)
+
    + +
  • Rotate the video, output size is chosen so that the whole rotating +input video is always completely contained in the output: +
    +
    rotate='2*PI*t:ow=hypot(iw,ih):oh=ow'
+
    + +
  • Rotate the video, reduce the output size so that no background is ever +shown: +
    +
    rotate=2*PI*t:ow='min(iw,ih)/sqrt(2)':oh=ow:c=none
+
    +
+ + +

39.175.2 Commands

+ +

The filter supports the following commands: +

+
+
a, angle
+

Set the angle expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

39.176 sab

+ +

Apply Shape Adaptive Blur. +

+

The filter accepts the following options: +

+
+
luma_radius, lr
+

Set luma blur filter strength, must be a value in range 0.1-4.0, default +value is 1.0. A greater value will result in a more blurred image, and +in slower processing. +

+
+
luma_pre_filter_radius, lpfr
+

Set luma pre-filter radius, must be a value in the 0.1-2.0 range, default +value is 1.0. +

+
+
luma_strength, ls
+

Set luma maximum difference between pixels to still be considered, must +be a value in the 0.1-100.0 range, default value is 1.0. +

+
+
chroma_radius, cr
+

Set chroma blur filter strength, must be a value in range -0.9-4.0. A +greater value will result in a more blurred image, and in slower +processing. +

+
+
chroma_pre_filter_radius, cpfr
+

Set chroma pre-filter radius, must be a value in the -0.9-2.0 range. +

+
+
chroma_strength, cs
+

Set chroma maximum difference between pixels to still be considered, +must be a value in the -0.9-100.0 range. +

+
+ +

Each chroma option value, if not explicitly specified, is set to the +corresponding luma option value. +

+ +

39.177 scale

+ +

Scale (resize) the input video, using the libswscale library. +

+

The scale filter forces the output display aspect ratio to be the same +of the input, by changing the output sample aspect ratio. +

+

If the input image format is different from the format requested by +the next filter, the scale filter will convert the input to the +requested format. +

+ +

39.177.1 Options

+

The filter accepts the following options, or any of the options +supported by the libswscale scaler. +

+

See (ffmpeg-scaler)the ffmpeg-scaler manual for +the complete list of scaler options. +

+
+
width, w
+
height, h
+

Set the output video dimension expression. Default value is the input +dimension. +

+

If the width or w value is 0, the input width is used for +the output. If the height or h value is 0, the input height +is used for the output. +

+

If one and only one of the values is -n with n >= 1, the scale filter +will use a value that maintains the aspect ratio of the input image, +calculated from the other specified dimension. After that it will, +however, make sure that the calculated dimension is divisible by n and +adjust the value if necessary. +

+

If both values are -n with n >= 1, the behavior will be identical to +both values being set to 0 as previously detailed. +

+

See below for the list of accepted constants for use in the dimension +expression. +

+
+
eval
+

Specify when to evaluate width and height expression. It accepts the following values: +

+
+
‘init’
+

Only evaluate expressions once during the filter initialization or when a command is processed. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. +

+
+
+ +

Default value is ‘init’. +

+ +
+
interl
+

Set the interlacing mode. It accepts the following values: +

+
+
‘1’
+

Force interlaced aware scaling. +

+
+
‘0’
+

Do not apply interlaced scaling. +

+
+
‘-1’
+

Select interlaced aware scaling depending on whether the source frames +are flagged as interlaced or not. +

+
+ +

Default value is ‘0’. +

+
+
flags
+

Set libswscale scaling flags. See +(ffmpeg-scaler)the ffmpeg-scaler manual for the +complete list of values. If not explicitly specified the filter applies +the default flags. +

+ +
+
param0, param1
+

Set libswscale input parameters for scaling algorithms that need them. See +(ffmpeg-scaler)the ffmpeg-scaler manual for the +complete documentation. If not explicitly specified the filter applies +empty parameters. +

+ + +
+
size, s
+

Set the video size. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
in_color_matrix
+
out_color_matrix
+

Set in/output YCbCr color space type. +

+

This allows the autodetected value to be overridden as well as allows forcing +a specific value used for the output and encoder. +

+

If not specified, the color space type depends on the pixel format. +

+

Possible values: +

+
+
‘auto’
+

Choose automatically. +

+
+
‘bt709’
+

Format conforming to International Telecommunication Union (ITU) +Recommendation BT.709. +

+
+
‘fcc’
+

Set color space conforming to the United States Federal Communications +Commission (FCC) Code of Federal Regulations (CFR) Title 47 (2003) 73.682 (a). +

+
+
‘bt601’
+
‘bt470’
+
‘smpte170m’
+

Set color space conforming to: +

+
    +
  • ITU Radiocommunication Sector (ITU-R) Recommendation BT.601 + +
  • ITU-R Rec. BT.470-6 (1998) Systems B, B1, and G + +
  • Society of Motion Picture and Television Engineers (SMPTE) ST 170:2004 + +
+ +
+
‘smpte240m’
+

Set color space conforming to SMPTE ST 240:1999. +

+
+
‘bt2020’
+

Set color space conforming to ITU-R BT.2020 non-constant luminance system. +

+
+ +
+
in_range
+
out_range
+

Set in/output YCbCr sample range. +

+

This allows the autodetected value to be overridden as well as allows forcing +a specific value used for the output and encoder. If not specified, the +range depends on the pixel format. Possible values: +

+
+
‘auto/unknown’
+

Choose automatically. +

+
+
‘jpeg/full/pc’
+

Set full range (0-255 in case of 8-bit luma). +

+
+
‘mpeg/limited/tv’
+

Set "MPEG" range (16-235 in case of 8-bit luma). +

+
+ +
+
force_original_aspect_ratio
+

Enable decreasing or increasing output video width or height if necessary to +keep the original aspect ratio. Possible values: +

+
+
‘disable’
+

Scale the video as specified and disable this feature. +

+
+
‘decrease’
+

The output video dimensions will automatically be decreased if needed. +

+
+
‘increase’
+

The output video dimensions will automatically be increased if needed. +

+
+
+ +

One useful instance of this option is that when you know a specific device’s +maximum allowed resolution, you can use this to limit the output video to +that, while retaining the aspect ratio. For example, device A allows +1280x720 playback, and your video is 1920x800. Using this option (set it to +decrease) and specifying 1280x720 to the command line makes the output +1280x533. +

+

Please note that this is a different thing than specifying -1 for w +or h, you still need to specify the output resolution for this option +to work. +

+
+
force_divisible_by
+

Ensures that both the output dimensions, width and height, are divisible by the +given integer when used together with force_original_aspect_ratio. This +works similar to using -n in the w and h options. +

+

This option respects the value set for force_original_aspect_ratio, +increasing or decreasing the resolution accordingly. The video’s aspect ratio +may be slightly modified. +

+

This option can be handy if you need to have a video fit within or exceed +a defined resolution using force_original_aspect_ratio but also have +encoder restrictions on width or height divisibility. +

+
+
+ +

The values of the w and h options are expressions +containing the following constants: +

+
+
in_w
+
in_h
+

The input width and height +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output (scaled) width and height +

+
+
ow
+
oh
+

These are the same as out_w and out_h +

+
+
a
+

The same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

The input display aspect ratio. Calculated from (iw / ih) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical input chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
ohsub
+
ovsub
+

horizontal and vertical output chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
n
+

The (sequential) number of the input frame, starting from 0. +Only available with eval=frame. +

+
+
t
+

The presentation timestamp of the input frame, expressed as a number of +seconds. Only available with eval=frame. +

+
+
pos
+

The position (byte offset) of the frame in the input stream, or NaN if +this information is unavailable and/or meaningless (for example in case of synthetic video). +Only available with eval=frame. +

+
+ + +

39.177.2 Examples

+ +
    +
  • Scale the input video to a size of 200x100 +
    +
    scale=w=200:h=100
+
    + +

    This is equivalent to: +

    +
    scale=200:100
+
    + +

    or: +

    +
    scale=200x100
+
    + +
  • Specify a size abbreviation for the output size: +
    +
    scale=qcif
+
    + +

    which can also be written as: +

    +
    scale=size=qcif
+
    + +
  • Scale the input to 2x: +
    +
    scale=w=2*iw:h=2*ih
+
    + +
  • The above is the same as: +
    +
    scale=2*in_w:2*in_h
+
    + +
  • Scale the input to 2x with forced interlaced scaling: +
    +
    scale=2*iw:2*ih:interl=1
+
    + +
  • Scale the input to half size: +
    +
    scale=w=iw/2:h=ih/2
+
    + +
  • Increase the width, and set the height to the same size: +
    +
    scale=3/2*iw:ow
+
    + +
  • Seek Greek harmony: +
    +
    scale=iw:1/PHI*iw
+scale=ih*PHI:ih
+
    + +
  • Increase the height, and set the width to 3/2 of the height: +
    +
    scale=w=3/2*oh:h=3/5*ih
+
    + +
  • Increase the size, making the size a multiple of the chroma +subsample values: +
    +
    scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
+
    + +
  • Increase the width to a maximum of 500 pixels, +keeping the same aspect ratio as the input: +
    +
    scale=w='min(500\, iw*3/2):h=-1'
+
    + +
  • Make pixels square by combining scale and setsar: +
    +
    scale='trunc(ih*dar):ih',setsar=1/1
+
    + +
  • Make pixels square by combining scale and setsar, +making sure the resulting resolution is even (required by some codecs): +
    +
    scale='trunc(ih*dar/2)*2:trunc(ih/2)*2',setsar=1/1
+
    +
+ + +

39.177.3 Commands

+ +

This filter supports the following commands: +

+
width, w
+
height, h
+

Set the output video dimension expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

39.178 scale_npp

+ +

Use the NVIDIA Performance Primitives (libnpp) to perform scaling and/or pixel +format conversion on CUDA video frames. Setting the output width and height +works in the same way as for the scale filter. +

+

The following additional options are accepted: +

+
format
+

The pixel format of the output CUDA frames. If set to the string "same" (the +default), the input format will be kept. Note that automatic format negotiation +and conversion is not yet supported for hardware frames +

+
+
interp_algo
+

The interpolation algorithm used for resizing. One of the following: +

+
nn
+

Nearest neighbour. +

+
+
linear
+
cubic
+
cubic2p_bspline
+

2-parameter cubic (B=1, C=0) +

+
+
cubic2p_catmullrom
+

2-parameter cubic (B=0, C=1/2) +

+
+
cubic2p_b05c03
+

2-parameter cubic (B=1/2, C=3/10) +

+
+
super
+

Supersampling +

+
+
lanczos
+
+ +
+
force_original_aspect_ratio
+

Enable decreasing or increasing output video width or height if necessary to +keep the original aspect ratio. Possible values: +

+
+
‘disable’
+

Scale the video as specified and disable this feature. +

+
+
‘decrease’
+

The output video dimensions will automatically be decreased if needed. +

+
+
‘increase’
+

The output video dimensions will automatically be increased if needed. +

+
+
+ +

One useful instance of this option is that when you know a specific device’s +maximum allowed resolution, you can use this to limit the output video to +that, while retaining the aspect ratio. For example, device A allows +1280x720 playback, and your video is 1920x800. Using this option (set it to +decrease) and specifying 1280x720 to the command line makes the output +1280x533. +

+

Please note that this is a different thing than specifying -1 for w +or h, you still need to specify the output resolution for this option +to work. +

+
+
force_divisible_by
+

Ensures that both the output dimensions, width and height, are divisible by the +given integer when used together with force_original_aspect_ratio. This +works similar to using -n in the w and h options. +

+

This option respects the value set for force_original_aspect_ratio, +increasing or decreasing the resolution accordingly. The video’s aspect ratio +may be slightly modified. +

+

This option can be handy if you need to have a video fit within or exceed +a defined resolution using force_original_aspect_ratio but also have +encoder restrictions on width or height divisibility. +

+
+
+ + +

39.179 scale2ref

+ +

Scale (resize) the input video, based on a reference video. +

+

See the scale filter for available options, scale2ref supports the same but +uses the reference video instead of the main input as basis. scale2ref also +supports the following additional constants for the w and +h options: +

+
+
main_w
+
main_h
+

The main input video’s width and height +

+
+
main_a
+

The same as main_w / main_h +

+
+
main_sar
+

The main input video’s sample aspect ratio +

+
+
main_dar, mdar
+

The main input video’s display aspect ratio. Calculated from +(main_w / main_h) * main_sar. +

+
+
main_hsub
+
main_vsub
+

The main input video’s horizontal and vertical chroma subsample values. +For example for the pixel format "yuv422p" hsub is 2 and vsub +is 1. +

+
+
main_n
+

The (sequential) number of the main input frame, starting from 0. +Only available with eval=frame. +

+
+
main_t
+

The presentation timestamp of the main input frame, expressed as a number of +seconds. Only available with eval=frame. +

+
+
main_pos
+

The position (byte offset) of the frame in the main input stream, or NaN if +this information is unavailable and/or meaningless (for example in case of synthetic video). +Only available with eval=frame. +

+
+ + +

39.179.1 Examples

+ +
    +
  • Scale a subtitle stream (b) to match the main video (a) in size before overlaying +
    +
    'scale2ref[b][a];[a][b]overlay'
+
    + +
  • Scale a logo to 1/10th the height of a video, while preserving its display aspect ratio. +
    +
    [logo-in][video-in]scale2ref=w=oh*mdar:h=ih/10[logo-out][video-out]
+
    +
+ + +

39.179.2 Commands

+ +

This filter supports the following commands: +

+
width, w
+
height, h
+

Set the output video dimension expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

39.180 scroll

+

Scroll input video horizontally and/or vertically by constant speed. +

+

The filter accepts the following options: +

+
horizontal, h
+

Set the horizontal scrolling speed. Default is 0. Allowed range is from -1 to 1. +Negative values changes scrolling direction. +

+
+
vertical, v
+

Set the vertical scrolling speed. Default is 0. Allowed range is from -1 to 1. +Negative values changes scrolling direction. +

+
+
hpos
+

Set the initial horizontal scrolling position. Default is 0. Allowed range is from 0 to 1. +

+
+
vpos
+

Set the initial vertical scrolling position. Default is 0. Allowed range is from 0 to 1. +

+
+ + +

39.180.1 Commands

+ +

This filter supports the following commands: +

+
horizontal, h
+

Set the horizontal scrolling speed. +

+
vertical, v
+

Set the vertical scrolling speed. +

+
+ + +

39.181 scdet

+ +

Detect video scene change. +

+

This filter sets frame metadata with mafd between frame, the scene score, and +forward the frame to the next filter, so they can use these metadata to detect +scene change or others. +

+

In addition, this filter logs a message and sets frame metadata when it detects +a scene change by threshold. +

+

lavfi.scd.mafd metadata keys are set with mafd for every frame. +

+

lavfi.scd.score metadata keys are set with scene change score for every frame +to detect scene change. +

+

lavfi.scd.time metadata keys are set with current filtered frame time which +detect scene change with threshold. +

+

The filter accepts the following options: +

+
+
threshold, t
+

Set the scene change detection threshold as a percentage of maximum change. Good +values are in the [8.0, 14.0] range. The range for threshold is +[0., 100.]. +

+

Default value is 10.. +

+
+
sc_pass, s
+

Set the flag to pass scene change frames to the next filter. Default value is 0 +You can enable it if you want to get snapshot of scene change frames only. +

+
+ + +

39.182 selectivecolor

+ +

Adjust cyan, magenta, yellow and black (CMYK) to certain ranges of colors (such +as "reds", "yellows", "greens", "cyans", ...). The adjustment range is defined +by the "purity" of the color (that is, how saturated it already is). +

+

This filter is similar to the Adobe Photoshop Selective Color tool. +

+

The filter accepts the following options: +

+
+
correction_method
+

Select color correction method. +

+

Available values are: +

+
‘absolute’
+

Specified adjustments are applied "as-is" (added/subtracted to original pixel +component value). +

+
‘relative’
+

Specified adjustments are relative to the original component value. +

+
+

Default is absolute. +

+
reds
+

Adjustments for red pixels (pixels where the red component is the maximum) +

+
yellows
+

Adjustments for yellow pixels (pixels where the blue component is the minimum) +

+
greens
+

Adjustments for green pixels (pixels where the green component is the maximum) +

+
cyans
+

Adjustments for cyan pixels (pixels where the red component is the minimum) +

+
blues
+

Adjustments for blue pixels (pixels where the blue component is the maximum) +

+
magentas
+

Adjustments for magenta pixels (pixels where the green component is the minimum) +

+
whites
+

Adjustments for white pixels (pixels where all components are greater than 128) +

+
neutrals
+

Adjustments for all pixels except pure black and pure white +

+
blacks
+

Adjustments for black pixels (pixels where all components are lesser than 128) +

+
psfile
+

Specify a Photoshop selective color file (.asv) to import the settings from. +

+
+ +

All the adjustment settings (reds, yellows, ...) accept up to +4 space separated floating point adjustment values in the [-1,1] range, +respectively to adjust the amount of cyan, magenta, yellow and black for the +pixels of its range. +

+ +

39.182.1 Examples

+ +
    +
  • Increase cyan by 50% and reduce yellow by 33% in every green areas, and +increase magenta by 27% in blue areas: +
    +
    selectivecolor=greens=.5 0 -.33 0:blues=0 .27
+
    + +
  • Use a Photoshop selective color preset: +
    +
    selectivecolor=psfile=MySelectiveColorPresets/Misty.asv
+
    +
+ + +

39.183 separatefields

+ +

The separatefields takes a frame-based video input and splits +each frame into its components fields, producing a new half height clip +with twice the frame rate and twice the frame count. +

+

This filter use field-dominance information in frame to decide which +of each pair of fields to place first in the output. +If it gets it wrong use setfield filter before separatefields filter. +

+ +

39.184 setdar, setsar

+ +

The setdar filter sets the Display Aspect Ratio for the filter +output video. +

+

This is done by changing the specified Sample (aka Pixel) Aspect +Ratio, according to the following equation: +

+
DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR
+
+ +

Keep in mind that the setdar filter does not modify the pixel +dimensions of the video frame. Also, the display aspect ratio set by +this filter may be changed by later filters in the filterchain, +e.g. in case of scaling or if another "setdar" or a "setsar" filter is +applied. +

+

The setsar filter sets the Sample (aka Pixel) Aspect Ratio for +the filter output video. +

+

Note that as a consequence of the application of this filter, the +output display aspect ratio will change according to the equation +above. +

+

Keep in mind that the sample aspect ratio set by the setsar +filter may be changed by later filters in the filterchain, e.g. if +another "setsar" or a "setdar" filter is applied. +

+

It accepts the following parameters: +

+
+
r, ratio, dar (setdar only), sar (setsar only)
+

Set the aspect ratio used by the filter. +

+

The parameter can be a floating point number string, an expression, or +a string of the form num:den, where num and +den are the numerator and denominator of the aspect ratio. If +the parameter is not specified, it is assumed the value "0". +In case the form "num:den" is used, the : character +should be escaped. +

+
+
max
+

Set the maximum integer value to use for expressing numerator and +denominator when reducing the expressed aspect ratio to a rational. +Default value is 100. +

+
+
+ +

The parameter sar is an expression containing +the following constants: +

+
+
E, PI, PHI
+

These are approximated values for the mathematical constants e +(Euler’s number), pi (Greek pi), and phi (the golden ratio). +

+
+
w, h
+

The input width and height. +

+
+
a
+

These are the same as w / h. +

+
+
sar
+

The input sample aspect ratio. +

+
+
dar
+

The input display aspect ratio. It is the same as +(w / h) * sar. +

+
+
hsub, vsub
+

Horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+ + +

39.184.1 Examples

+ +
    +
  • To change the display aspect ratio to 16:9, specify one of the following: +
    +
    setdar=dar=1.77777
+setdar=dar=16/9
+
    + +
  • To change the sample aspect ratio to 10:11, specify: +
    +
    setsar=sar=10/11
+
    + +
  • To set a display aspect ratio of 16:9, and specify a maximum integer value of +1000 in the aspect ratio reduction, use the command: +
    +
    setdar=ratio=16/9:max=1000
+
    + +
+ + +

39.185 setfield

+ +

Force field for the output video frame. +

+

The setfield filter marks the interlace type field for the +output frames. It does not change the input frame, but only sets the +corresponding property, which affects how the frame is treated by +following filters (e.g. fieldorder or yadif). +

+

The filter accepts the following options: +

+
+
mode
+

Available values are: +

+
+
‘auto’
+

Keep the same field property. +

+
+
‘bff’
+

Mark the frame as bottom-field-first. +

+
+
‘tff’
+

Mark the frame as top-field-first. +

+
+
‘prog’
+

Mark the frame as progressive. +

+
+
+
+ + +

39.186 setparams

+ +

Force frame parameter for the output video frame. +

+

The setparams filter marks interlace and color range for the +output frames. It does not change the input frame, but only sets the +corresponding property, which affects how the frame is treated by +filters/encoders. +

+
+
field_mode
+

Available values are: +

+
+
‘auto’
+

Keep the same field property (default). +

+
+
‘bff’
+

Mark the frame as bottom-field-first. +

+
+
‘tff’
+

Mark the frame as top-field-first. +

+
+
‘prog’
+

Mark the frame as progressive. +

+
+ +
+
range
+

Available values are: +

+
+
‘auto’
+

Keep the same color range property (default). +

+
+
‘unspecified, unknown’
+

Mark the frame as unspecified color range. +

+
+
‘limited, tv, mpeg’
+

Mark the frame as limited range. +

+
+
‘full, pc, jpeg’
+

Mark the frame as full range. +

+
+ +
+
color_primaries
+

Set the color primaries. +Available values are: +

+
+
‘auto’
+

Keep the same color primaries property (default). +

+
+
‘bt709’
+
‘unknown’
+
‘bt470m’
+
‘bt470bg’
+
‘smpte170m’
+
‘smpte240m’
+
‘film’
+
‘bt2020’
+
‘smpte428’
+
‘smpte431’
+
‘smpte432’
+
‘jedec-p22’
+
+ +
+
color_trc
+

Set the color transfer. +Available values are: +

+
+
‘auto’
+

Keep the same color trc property (default). +

+
+
‘bt709’
+
‘unknown’
+
‘bt470m’
+
‘bt470bg’
+
‘smpte170m’
+
‘smpte240m’
+
‘linear’
+
‘log100’
+
‘log316’
+
‘iec61966-2-4’
+
‘bt1361e’
+
‘iec61966-2-1’
+
‘bt2020-10’
+
‘bt2020-12’
+
‘smpte2084’
+
‘smpte428’
+
‘arib-std-b67’
+
+ +
+
colorspace
+

Set the colorspace. +Available values are: +

+
+
‘auto’
+

Keep the same colorspace property (default). +

+
+
‘gbr’
+
‘bt709’
+
‘unknown’
+
‘fcc’
+
‘bt470bg’
+
‘smpte170m’
+
‘smpte240m’
+
‘ycgco’
+
‘bt2020nc’
+
‘bt2020c’
+
‘smpte2085’
+
‘chroma-derived-nc’
+
‘chroma-derived-c’
+
‘ictcp’
+
+
+
+ + +

39.187 showinfo

+ +

Show a line containing various information for each input video frame. +The input video is not modified. +

+

This filter supports the following options: +

+
+
checksum
+

Calculate checksums of each plane. By default enabled. +

+
+ +

The shown line contains a sequence of key/value pairs of the form +key:value. +

+

The following values are shown in the output: +

+
+
n
+

The (sequential) number of the input frame, starting from 0. +

+
+
pts
+

The Presentation TimeStamp of the input frame, expressed as a number of +time base units. The time base unit depends on the filter input pad. +

+
+
pts_time
+

The Presentation TimeStamp of the input frame, expressed as a number of +seconds. +

+
+
pos
+

The position of the frame in the input stream, or -1 if this information is +unavailable and/or meaningless (for example in case of synthetic video). +

+
+
fmt
+

The pixel format name. +

+
+
sar
+

The sample aspect ratio of the input frame, expressed in the form +num/den. +

+
+
s
+

The size of the input frame. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
i
+

The type of interlaced mode ("P" for "progressive", "T" for top field first, "B" +for bottom field first). +

+
+
iskey
+

This is 1 if the frame is a key frame, 0 otherwise. +

+
+
type
+

The picture type of the input frame ("I" for an I-frame, "P" for a +P-frame, "B" for a B-frame, or "?" for an unknown type). +Also refer to the documentation of the AVPictureType enum and of +the av_get_picture_type_char function defined in +libavutil/avutil.h. +

+
+
checksum
+

The Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame. +

+
+
plane_checksum
+

The Adler-32 checksum (printed in hexadecimal) of each plane of the input frame, +expressed in the form "[c0 c1 c2 c3]". +

+
+
mean
+

The mean value of pixels in each plane of the input frame, expressed in the form +"[mean0 mean1 mean2 mean3]". +

+
+
stdev
+

The standard deviation of pixel values in each plane of the input frame, expressed +in the form "[stdev0 stdev1 stdev2 stdev3]". +

+
+
+ + +

39.188 showpalette

+ +

Displays the 256 colors palette of each frame. This filter is only relevant for +pal8 pixel format frames. +

+

It accepts the following option: +

+
+
s
+

Set the size of the box used to represent one palette color entry. Default is +30 (for a 30x30 pixel box). +

+
+ + +

39.189 shuffleframes

+ +

Reorder and/or duplicate and/or drop video frames. +

+

It accepts the following parameters: +

+
+
mapping
+

Set the destination indexes of input frames. +This is space or ’|’ separated list of indexes that maps input frames to output +frames. Number of indexes also sets maximal value that each index may have. +’-1’ index have special meaning and that is to drop frame. +

+
+ +

The first frame has the index 0. The default is to keep the input unchanged. +

+ +

39.189.1 Examples

+ +
    +
  • Swap second and third frame of every three frames of the input: +
    +
    ffmpeg -i INPUT -vf "shuffleframes=0 2 1" OUTPUT
+
    + +
  • Swap 10th and 1st frame of every ten frames of the input: +
    +
    ffmpeg -i INPUT -vf "shuffleframes=9 1 2 3 4 5 6 7 8 0" OUTPUT
+
    +
+ + +

39.190 shuffleplanes

+ +

Reorder and/or duplicate video planes. +

+

It accepts the following parameters: +

+
+
map0
+

The index of the input plane to be used as the first output plane. +

+
+
map1
+

The index of the input plane to be used as the second output plane. +

+
+
map2
+

The index of the input plane to be used as the third output plane. +

+
+
map3
+

The index of the input plane to be used as the fourth output plane. +

+
+
+ +

The first plane has the index 0. The default is to keep the input unchanged. +

+ +

39.190.1 Examples

+ +
    +
  • Swap the second and third planes of the input: +
    +
    ffmpeg -i INPUT -vf shuffleplanes=0:2:1:3 OUTPUT
+
    +
+ + +

39.191 signalstats

+

Evaluate various visual metrics that assist in determining issues associated +with the digitization of analog video media. +

+

By default the filter will log these metadata values: +

+
+
YMIN
+

Display the minimal Y value contained within the input frame. Expressed in +range of [0-255]. +

+
+
YLOW
+

Display the Y value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
YAVG
+

Display the average Y value within the input frame. Expressed in range of +[0-255]. +

+
+
YHIGH
+

Display the Y value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
YMAX
+

Display the maximum Y value contained within the input frame. Expressed in +range of [0-255]. +

+
+
UMIN
+

Display the minimal U value contained within the input frame. Expressed in +range of [0-255]. +

+
+
ULOW
+

Display the U value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
UAVG
+

Display the average U value within the input frame. Expressed in range of +[0-255]. +

+
+
UHIGH
+

Display the U value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
UMAX
+

Display the maximum U value contained within the input frame. Expressed in +range of [0-255]. +

+
+
VMIN
+

Display the minimal V value contained within the input frame. Expressed in +range of [0-255]. +

+
+
VLOW
+

Display the V value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
VAVG
+

Display the average V value within the input frame. Expressed in range of +[0-255]. +

+
+
VHIGH
+

Display the V value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
VMAX
+

Display the maximum V value contained within the input frame. Expressed in +range of [0-255]. +

+
+
SATMIN
+

Display the minimal saturation value contained within the input frame. +Expressed in range of [0-~181.02]. +

+
+
SATLOW
+

Display the saturation value at the 10% percentile within the input frame. +Expressed in range of [0-~181.02]. +

+
+
SATAVG
+

Display the average saturation value within the input frame. Expressed in range +of [0-~181.02]. +

+
+
SATHIGH
+

Display the saturation value at the 90% percentile within the input frame. +Expressed in range of [0-~181.02]. +

+
+
SATMAX
+

Display the maximum saturation value contained within the input frame. +Expressed in range of [0-~181.02]. +

+
+
HUEMED
+

Display the median value for hue within the input frame. Expressed in range of +[0-360]. +

+
+
HUEAVG
+

Display the average value for hue within the input frame. Expressed in range of +[0-360]. +

+
+
YDIF
+

Display the average of sample value difference between all values of the Y +plane in the current frame and corresponding values of the previous input frame. +Expressed in range of [0-255]. +

+
+
UDIF
+

Display the average of sample value difference between all values of the U +plane in the current frame and corresponding values of the previous input frame. +Expressed in range of [0-255]. +

+
+
VDIF
+

Display the average of sample value difference between all values of the V +plane in the current frame and corresponding values of the previous input frame. +Expressed in range of [0-255]. +

+
+
YBITDEPTH
+

Display bit depth of Y plane in current frame. +Expressed in range of [0-16]. +

+
+
UBITDEPTH
+

Display bit depth of U plane in current frame. +Expressed in range of [0-16]. +

+
+
VBITDEPTH
+

Display bit depth of V plane in current frame. +Expressed in range of [0-16]. +

+
+ +

The filter accepts the following options: +

+
+
stat
+
out
+
+

stat specify an additional form of image analysis. +out output video with the specified type of pixel highlighted. +

+

Both options accept the following values: +

+
+
‘tout’
+

Identify temporal outliers pixels. A temporal outlier is a pixel +unlike the neighboring pixels of the same field. Examples of temporal outliers +include the results of video dropouts, head clogs, or tape tracking issues. +

+
+
‘vrep’
+

Identify vertical line repetition. Vertical line repetition includes +similar rows of pixels within a frame. In born-digital video vertical line +repetition is common, but this pattern is uncommon in video digitized from an +analog source. When it occurs in video that results from the digitization of an +analog source it can indicate concealment from a dropout compensator. +

+
+
‘brng’
+

Identify pixels that fall outside of legal broadcast range. +

+
+ +
+
color, c
+

Set the highlight color for the out option. The default color is +yellow. +

+
+ + +

39.191.1 Examples

+ +
    +
  • Output data of various video metrics: +
    +
    ffprobe -f lavfi movie=example.mov,signalstats="stat=tout+vrep+brng" -show_frames
+
    + +
  • Output specific data about the minimum and maximum values of the Y plane per frame: +
    +
    ffprobe -f lavfi movie=example.mov,signalstats -show_entries frame_tags=lavfi.signalstats.YMAX,lavfi.signalstats.YMIN
+
    + +
  • Playback video while highlighting pixels that are outside of broadcast range in red. +
    +
    ffplay example.mov -vf signalstats="out=brng:color=red"
+
    + +
  • Playback video with signalstats metadata drawn over the frame. +
    +
    ffplay example.mov -vf signalstats=stat=brng+vrep+tout,drawtext=fontfile=FreeSerif.ttf:textfile=signalstat_drawtext.txt
+
    + +

    The contents of signalstat_drawtext.txt used in the command are: +

    +
    time %{pts:hms}
+Y (%{metadata:lavfi.signalstats.YMIN}-%{metadata:lavfi.signalstats.YMAX})
+U (%{metadata:lavfi.signalstats.UMIN}-%{metadata:lavfi.signalstats.UMAX})
+V (%{metadata:lavfi.signalstats.VMIN}-%{metadata:lavfi.signalstats.VMAX})
+saturation maximum: %{metadata:lavfi.signalstats.SATMAX}
+
+
    +
+ + +

39.192 signature

+ +

Calculates the MPEG-7 Video Signature. The filter can handle more than one +input. In this case the matching between the inputs can be calculated additionally. +The filter always passes through the first input. The signature of each stream can +be written into a file. +

+

It accepts the following options: +

+
+
detectmode
+

Enable or disable the matching process. +

+

Available values are: +

+
+
‘off’
+

Disable the calculation of a matching (default). +

+
‘full’
+

Calculate the matching for the whole video and output whether the whole video +matches or only parts. +

+
‘fast’
+

Calculate only until a matching is found or the video ends. Should be faster in +some cases. +

+
+ +
+
nb_inputs
+

Set the number of inputs. The option value must be a non negative integer. +Default value is 1. +

+
+
filename
+

Set the path to which the output is written. If there is more than one input, +the path must be a prototype, i.e. must contain %d or %0nd (where n is a positive +integer), that will be replaced with the input number. If no filename is +specified, no output will be written. This is the default. +

+
+
format
+

Choose the output format. +

+

Available values are: +

+
+
‘binary’
+

Use the specified binary representation (default). +

+
‘xml’
+

Use the specified xml representation. +

+
+ +
+
th_d
+

Set threshold to detect one word as similar. The option value must be an integer +greater than zero. The default value is 9000. +

+
+
th_dc
+

Set threshold to detect all words as similar. The option value must be an integer +greater than zero. The default value is 60000. +

+
+
th_xh
+

Set threshold to detect frames as similar. The option value must be an integer +greater than zero. The default value is 116. +

+
+
th_di
+

Set the minimum length of a sequence in frames to recognize it as matching +sequence. The option value must be a non negative integer value. +The default value is 0. +

+
+
th_it
+

Set the minimum relation, that matching frames to all frames must have. +The option value must be a double value between 0 and 1. The default value is 0.5. +

+
+ + +

39.192.1 Examples

+ +
    +
  • To calculate the signature of an input video and store it in signature.bin: +
    +
    ffmpeg -i input.mkv -vf signature=filename=signature.bin -map 0:v -f null -
+
    + +
  • To detect whether two videos match and store the signatures in XML format in +signature0.xml and signature1.xml: +
    +
    ffmpeg -i input1.mkv -i input2.mkv -filter_complex "[0:v][1:v] signature=nb_inputs=2:detectmode=full:format=xml:filename=signature%d.xml" -map :v -f null -
+
    + +
+ + +

39.193 smartblur

+ +

Blur the input video without impacting the outlines. +

+

It accepts the following options: +

+
+
luma_radius, lr
+

Set the luma radius. The option value must be a float number in +the range [0.1,5.0] that specifies the variance of the gaussian filter +used to blur the image (slower if larger). Default value is 1.0. +

+
+
luma_strength, ls
+

Set the luma strength. The option value must be a float number +in the range [-1.0,1.0] that configures the blurring. A value included +in [0.0,1.0] will blur the image whereas a value included in +[-1.0,0.0] will sharpen the image. Default value is 1.0. +

+
+
luma_threshold, lt
+

Set the luma threshold used as a coefficient to determine +whether a pixel should be blurred or not. The option value must be an +integer in the range [-30,30]. A value of 0 will filter all the image, +a value included in [0,30] will filter flat areas and a value included +in [-30,0] will filter edges. Default value is 0. +

+
+
chroma_radius, cr
+

Set the chroma radius. The option value must be a float number in +the range [0.1,5.0] that specifies the variance of the gaussian filter +used to blur the image (slower if larger). Default value is luma_radius. +

+
+
chroma_strength, cs
+

Set the chroma strength. The option value must be a float number +in the range [-1.0,1.0] that configures the blurring. A value included +in [0.0,1.0] will blur the image whereas a value included in +[-1.0,0.0] will sharpen the image. Default value is luma_strength. +

+
+
chroma_threshold, ct
+

Set the chroma threshold used as a coefficient to determine +whether a pixel should be blurred or not. The option value must be an +integer in the range [-30,30]. A value of 0 will filter all the image, +a value included in [0,30] will filter flat areas and a value included +in [-30,0] will filter edges. Default value is luma_threshold. +

+
+ +

If a chroma option is not explicitly set, the corresponding luma value +is set. +

+ +

39.194 sobel

+

Apply sobel operator to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +

+
+
delta
+

Set value which will be added to filtered result. +

+
+ + +

39.195 spp

+ +

Apply a simple postprocessing filter that compresses and decompresses the image +at several (or - in the case of quality level 6 - all) shifts +and average the results. +

+

The filter accepts the following options: +

+
+
quality
+

Set quality. This option defines the number of levels for averaging. It accepts +an integer in the range 0-6. If set to 0, the filter will have no +effect. A value of 6 means the higher quality. For each increment of +that value the speed drops by a factor of approximately 2. Default value is +3. +

+
+
qp
+

Force a constant quantization parameter. If not set, the filter will use the QP +from the video stream (if available). +

+
+
mode
+

Set thresholding mode. Available modes are: +

+
+
‘hard’
+

Set hard thresholding (default). +

+
‘soft’
+

Set soft thresholding (better de-ringing effect, but likely blurrier). +

+
+ +
+
use_bframe_qp
+

Enable the use of the QP from the B-Frames if set to 1. Using this +option may cause flicker since the B-Frames have often larger QP. Default is +0 (not enabled). +

+
+ + +

39.195.1 Commands

+ +

This filter supports the following commands: +

+
quality, level
+

Set quality level. The value max can be used to set the maximum level, +currently 6. +

+
+ + +

39.196 sr

+ +

Scale the input by applying one of the super-resolution methods based on +convolutional neural networks. Supported models: +

+ + +

Training scripts as well as scripts for model file (.pb) saving can be found at +https://github.com/XueweiMeng/sr/tree/sr_dnn_native. Original repository +is at https://github.com/HighVoltageRocknRoll/sr.git. +

+

Native model files (.model) can be generated from TensorFlow model +files (.pb) by using tools/python/convert.py +

+

The filter accepts the following options: +

+
+
dnn_backend
+

Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +

+
+
‘native’
+

Native implementation of DNN loading and execution. +

+
+
‘tensorflow’
+

TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +https://www.tensorflow.org/install/install_c) and configure FFmpeg with +--enable-libtensorflow +

+
+ +

Default value is ‘native’. +

+
+
model
+

Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow backend +can load files for both formats, while native backend can load files for only +its format. +

+
+
scale_factor
+

Set scale factor for SRCNN model. Allowed values are 2, 3 and 4. +Default value is 2. Scale factor is necessary for SRCNN model, because it accepts +input upscaled using bicubic upscaling with proper scale factor. +

+
+ +

This feature can also be finished with dnn_processing filter. +

+ +

39.197 ssim

+ +

Obtain the SSIM (Structural SImilarity Metric) between two input videos. +

+

This filter takes in input two input videos, the first input is +considered the "main" source and is passed unchanged to the +output. The second input is used as a "reference" video for computing +the SSIM. +

+

Both video inputs must have the same resolution and pixel format for +this filter to work correctly. Also it assumes that both inputs +have the same number of frames, which are compared one by one. +

+

The filter stores the calculated SSIM of each frame. +

+

The description of the accepted parameters follows. +

+
+
stats_file, f
+

If specified the filter will use the named file to save the SSIM of +each individual frame. When filename equals "-" the data is sent to +standard output. +

+
+ +

The file printed if stats_file is selected, contains a sequence of +key/value pairs of the form key:value for each compared +couple of frames. +

+

A description of each shown parameter follows: +

+
+
n
+

sequential number of the input frame, starting from 1 +

+
+
Y, U, V, R, G, B
+

SSIM of the compared frames for the component specified by the suffix. +

+
+
All
+

SSIM of the compared frames for the whole frame. +

+
+
dB
+

Same as above but in dB representation. +

+
+ +

This filter also supports the framesync options. +

+ +

39.197.1 Examples

+
    +
  • For example: +
    +
    movie=ref_movie.mpg, setpts=PTS-STARTPTS [main];
+[main][ref] ssim="stats_file=stats.log" [out]
+
    + +

    On this example the input file being processed is compared with the +reference file ref_movie.mpg. The SSIM of each individual frame +is stored in stats.log. +

    +
  • Another example with both psnr and ssim at same time: +
    +
    ffmpeg -i main.mpg -i ref.mpg -lavfi  "ssim;[0:v][1:v]psnr" -f null -
+
    + +
  • Another example with different containers: +
    +
    ffmpeg -i main.mpg -i ref.mkv -lavfi  "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]ssim" -f null -
+
    +
+ + +

39.198 stereo3d

+ +

Convert between different stereoscopic image formats. +

+

The filters accept the following options: +

+
+
in
+

Set stereoscopic image format of input. +

+

Available values for input image formats are: +

+
‘sbsl’
+

side by side parallel (left eye left, right eye right) +

+
+
‘sbsr’
+

side by side crosseye (right eye left, left eye right) +

+
+
‘sbs2l’
+

side by side parallel with half width resolution +(left eye left, right eye right) +

+
+
‘sbs2r’
+

side by side crosseye with half width resolution +(right eye left, left eye right) +

+
+
‘abl’
+
‘tbl’
+

above-below (left eye above, right eye below) +

+
+
‘abr’
+
‘tbr’
+

above-below (right eye above, left eye below) +

+
+
‘ab2l’
+
‘tb2l’
+

above-below with half height resolution +(left eye above, right eye below) +

+
+
‘ab2r’
+
‘tb2r’
+

above-below with half height resolution +(right eye above, left eye below) +

+
+
‘al’
+

alternating frames (left eye first, right eye second) +

+
+
‘ar’
+

alternating frames (right eye first, left eye second) +

+
+
‘irl’
+

interleaved rows (left eye has top row, right eye starts on next row) +

+
+
‘irr’
+

interleaved rows (right eye has top row, left eye starts on next row) +

+
+
‘icl’
+

interleaved columns, left eye first +

+
+
‘icr’
+

interleaved columns, right eye first +

+

Default value is ‘sbsl’. +

+
+ +
+
out
+

Set stereoscopic image format of output. +

+
+
‘sbsl’
+

side by side parallel (left eye left, right eye right) +

+
+
‘sbsr’
+

side by side crosseye (right eye left, left eye right) +

+
+
‘sbs2l’
+

side by side parallel with half width resolution +(left eye left, right eye right) +

+
+
‘sbs2r’
+

side by side crosseye with half width resolution +(right eye left, left eye right) +

+
+
‘abl’
+
‘tbl’
+

above-below (left eye above, right eye below) +

+
+
‘abr’
+
‘tbr’
+

above-below (right eye above, left eye below) +

+
+
‘ab2l’
+
‘tb2l’
+

above-below with half height resolution +(left eye above, right eye below) +

+
+
‘ab2r’
+
‘tb2r’
+

above-below with half height resolution +(right eye above, left eye below) +

+
+
‘al’
+

alternating frames (left eye first, right eye second) +

+
+
‘ar’
+

alternating frames (right eye first, left eye second) +

+
+
‘irl’
+

interleaved rows (left eye has top row, right eye starts on next row) +

+
+
‘irr’
+

interleaved rows (right eye has top row, left eye starts on next row) +

+
+
‘arbg’
+

anaglyph red/blue gray +(red filter on left eye, blue filter on right eye) +

+
+
‘argg’
+

anaglyph red/green gray +(red filter on left eye, green filter on right eye) +

+
+
‘arcg’
+

anaglyph red/cyan gray +(red filter on left eye, cyan filter on right eye) +

+
+
‘arch’
+

anaglyph red/cyan half colored +(red filter on left eye, cyan filter on right eye) +

+
+
‘arcc’
+

anaglyph red/cyan color +(red filter on left eye, cyan filter on right eye) +

+
+
‘arcd’
+

anaglyph red/cyan color optimized with the least squares projection of dubois +(red filter on left eye, cyan filter on right eye) +

+
+
‘agmg’
+

anaglyph green/magenta gray +(green filter on left eye, magenta filter on right eye) +

+
+
‘agmh’
+

anaglyph green/magenta half colored +(green filter on left eye, magenta filter on right eye) +

+
+
‘agmc’
+

anaglyph green/magenta colored +(green filter on left eye, magenta filter on right eye) +

+
+
‘agmd’
+

anaglyph green/magenta color optimized with the least squares projection of dubois +(green filter on left eye, magenta filter on right eye) +

+
+
‘aybg’
+

anaglyph yellow/blue gray +(yellow filter on left eye, blue filter on right eye) +

+
+
‘aybh’
+

anaglyph yellow/blue half colored +(yellow filter on left eye, blue filter on right eye) +

+
+
‘aybc’
+

anaglyph yellow/blue colored +(yellow filter on left eye, blue filter on right eye) +

+
+
‘aybd’
+

anaglyph yellow/blue color optimized with the least squares projection of dubois +(yellow filter on left eye, blue filter on right eye) +

+
+
‘ml’
+

mono output (left eye only) +

+
+
‘mr’
+

mono output (right eye only) +

+
+
‘chl’
+

checkerboard, left eye first +

+
+
‘chr’
+

checkerboard, right eye first +

+
+
‘icl’
+

interleaved columns, left eye first +

+
+
‘icr’
+

interleaved columns, right eye first +

+
+
‘hdmi’
+

HDMI frame pack +

+
+ +

Default value is ‘arcd’. +

+
+ + +

39.198.1 Examples

+ +
    +
  • Convert input video from side by side parallel to anaglyph yellow/blue dubois: +
    +
    stereo3d=sbsl:aybd
+
    + +
  • Convert input video from above below (left eye above, right eye below) to side by side crosseye. +
    +
    stereo3d=abl:sbsr
+
    +
+ + +

39.199 streamselect, astreamselect

+

Select video or audio streams. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of inputs. Default is 2. +

+
+
map
+

Set input indexes to remap to outputs. +

+
+ + +

39.199.1 Commands

+ +

The streamselect and astreamselect filter supports the following +commands: +

+
+
map
+

Set input indexes to remap to outputs. +

+
+ + +

39.199.2 Examples

+ +
    +
  • Select first 5 seconds 1st stream and rest of time 2nd stream: +
    +
    sendcmd='5.0 streamselect map 1',streamselect=inputs=2:map=0
+
    + +
  • Same as above, but for audio: +
    +
    asendcmd='5.0 astreamselect map 1',astreamselect=inputs=2:map=0
+
    +
+ + +

39.200 subtitles

+ +

Draw subtitles on top of input video using the libass library. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libass. This filter also requires a build with libavcodec and +libavformat to convert the passed subtitles file to ASS (Advanced Substation +Alpha) subtitles format. +

+

The filter accepts the following options: +

+
+
filename, f
+

Set the filename of the subtitle file to read. It must be specified. +

+
+
original_size
+

Specify the size of the original video, the video for which the ASS file +was composed. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Due to a misdesign in ASS aspect ratio arithmetic, this is necessary to +correctly scale the fonts if the aspect ratio has been changed. +

+
+
fontsdir
+

Set a directory path containing fonts that can be used by the filter. +These fonts will be used in addition to whatever the font provider uses. +

+
+
alpha
+

Process alpha channel, by default alpha channel is untouched. +

+
+
charenc
+

Set subtitles input character encoding. subtitles filter only. Only +useful if not UTF-8. +

+
+
stream_index, si
+

Set subtitles stream index. subtitles filter only. +

+
+
force_style
+

Override default style or script info parameters of the subtitles. It accepts a +string containing ASS style format KEY=VALUE couples separated by ",". +

+
+ +

If the first key is not specified, it is assumed that the first value +specifies the filename. +

+

For example, to render the file sub.srt on top of the input +video, use the command: +

+
subtitles=sub.srt
+
+ +

which is equivalent to: +

+
subtitles=filename=sub.srt
+
+ +

To render the default subtitles stream from file video.mkv, use: +

+
subtitles=video.mkv
+
+ +

To render the second subtitles stream from that file, use: +

+
subtitles=video.mkv:si=1
+
+ +

To make the subtitles stream from sub.srt appear in 80% transparent blue +DejaVu Serif, use: +

+
subtitles=sub.srt:force_style='FontName=DejaVu Serif,PrimaryColour=&HCCFF0000'
+
+ + +

39.201 super2xsai

+ +

Scale the input by 2x and smooth using the Super2xSaI (Scale and +Interpolate) pixel art scaling algorithm. +

+

Useful for enlarging pixel art images without reducing sharpness. +

+ +

39.202 swaprect

+ +

Swap two rectangular objects in video. +

+

This filter accepts the following options: +

+
+
w
+

Set object width. +

+
+
h
+

Set object height. +

+
+
x1
+

Set 1st rect x coordinate. +

+
+
y1
+

Set 1st rect y coordinate. +

+
+
x2
+

Set 2nd rect x coordinate. +

+
+
y2
+

Set 2nd rect y coordinate. +

+

All expressions are evaluated once for each frame. +

+
+ +

The all options are expressions containing the following constants: +

+
+
w
+
h
+

The input width and height. +

+
+
a
+

same as w / h +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (w / h) * sar +

+
+
n
+

The number of the input frame, starting from 0. +

+
+
t
+

The timestamp expressed in seconds. It’s NAN if the input timestamp is unknown. +

+
+
pos
+

the position in the file of the input frame, NAN if unknown +

+
+ + +

39.203 swapuv

+

Swap U & V plane. +

+ +

39.204 tblend

+

Blend successive video frames. +

+

See blend +

+ +

39.205 telecine

+ +

Apply telecine process to the video. +

+

This filter accepts the following options: +

+
+
first_field
+
+
‘top, t’
+

top field first +

+
‘bottom, b’
+

bottom field first +The default value is top. +

+
+ +
+
pattern
+

A string of numbers representing the pulldown pattern you wish to apply. +The default value is 23. +

+
+ +
+
Some typical patterns:
+
+NTSC output (30i):
+27.5p: 32222
+24p: 23 (classic)
+24p: 2332 (preferred)
+20p: 33
+18p: 334
+16p: 3444
+
+PAL output (25i):
+27.5p: 12222
+24p: 222222222223 ("Euro pulldown")
+16.67p: 33
+16p: 33333334
+
+ + +

39.206 thistogram

+ +

Compute and draw a color distribution histogram for the input video across time. +

+

Unlike histogram video filter which only shows histogram of single input frame +at certain time, this filter shows also past histograms of number of frames defined +by width option. +

+

The computed histogram is a representation of the color component +distribution in an image. +

+

The filter accepts the following options: +

+
+
width, w
+

Set width of single color component output. Default value is 0. +Value of 0 means width will be picked from input video. +This also set number of passed histograms to keep. +Allowed range is [0, 8192]. +

+
+
display_mode, d
+

Set display mode. +It accepts the following values: +

+
‘stack’
+

Per color component graphs are placed below each other. +

+
+
‘parade’
+

Per color component graphs are placed side by side. +

+
+
‘overlay’
+

Presents information identical to that in the parade, except +that the graphs representing color components are superimposed directly +over one another. +

+
+

Default is stack. +

+
+
levels_mode, m
+

Set mode. Can be either linear, or logarithmic. +Default is linear. +

+
+
components, c
+

Set what color components to display. +Default is 7. +

+
+
bgopacity, b
+

Set background opacity. Default is 0.9. +

+
+
envelope, e
+

Show envelope. Default is disabled. +

+
+
ecolor, ec
+

Set envelope color. Default is gold. +

+
+ + +

39.207 threshold

+ +

Apply threshold effect to video stream. +

+

This filter needs four video streams to perform thresholding. +First stream is stream we are filtering. +Second stream is holding threshold values, third stream is holding min values, +and last, fourth stream is holding max values. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+ +

For example if first stream pixel’s component value is less then threshold value +of pixel component from 2nd threshold stream, third stream value will picked, +otherwise fourth stream pixel component value will be picked. +

+

Using color source filter one can perform various types of thresholding: +

+ +

39.207.1 Examples

+ +
    +
  • Binary threshold, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=black -f lavfi -i color=white -lavfi threshold output.avi
+
    + +
  • Inverted binary threshold, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=white -f lavfi -i color=black -lavfi threshold output.avi
+
    + +
  • Truncate binary threshold, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -i 320x240.avi -f lavfi -i color=gray -lavfi threshold output.avi
+
    + +
  • Threshold to zero, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=white -i 320x240.avi -lavfi threshold output.avi
+
    + +
  • Inverted threshold to zero, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -i 320x240.avi -f lavfi -i color=white -lavfi threshold output.avi
+
    +
+ + +

39.208 thumbnail

+

Select the most representative frame in a given sequence of consecutive frames. +

+

The filter accepts the following options: +

+
+
n
+

Set the frames batch size to analyze; in a set of n frames, the filter +will pick one of them, and then handle the next batch of n frames until +the end. Default is 100. +

+
+ +

Since the filter keeps track of the whole frames sequence, a bigger n +value will result in a higher memory usage, so a high value is not recommended. +

+ +

39.208.1 Examples

+ +
    +
  • Extract one picture each 50 frames: +
    +
    thumbnail=50
+
    + +
  • Complete example of a thumbnail creation with ffmpeg: +
    +
    ffmpeg -i in.avi -vf thumbnail,scale=300:200 -frames:v 1 out.png
+
    +
+ + +

39.209 tile

+ +

Tile several successive frames together. +

+

The untile filter can do the reverse. +

+

The filter accepts the following options: +

+
+
layout
+

Set the grid size (i.e. the number of lines and columns). For the syntax of +this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
nb_frames
+

Set the maximum number of frames to render in the given area. It must be less +than or equal to wxh. The default value is 0, meaning all +the area will be used. +

+
+
margin
+

Set the outer border margin in pixels. +

+
+
padding
+

Set the inner border thickness (i.e. the number of pixels between frames). For +more advanced padding options (such as having different values for the edges), +refer to the pad video filter. +

+
+
color
+

Specify the color of the unused area. For the syntax of this option, check the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +The default value of color is "black". +

+
+
overlap
+

Set the number of frames to overlap when tiling several successive frames together. +The value must be between 0 and nb_frames - 1. +

+
+
init_padding
+

Set the number of frames to initially be empty before displaying first output frame. +This controls how soon will one get first output frame. +The value must be between 0 and nb_frames - 1. +

+
+ + +

39.209.1 Examples

+ +
    +
  • Produce 8x8 PNG tiles of all keyframes (-skip_frame nokey) in a movie: +
    +
    ffmpeg -skip_frame nokey -i file.avi -vf 'scale=128:72,tile=8x8' -an -vsync 0 keyframes%03d.png
+
    +

    The -vsync 0 is necessary to prevent ffmpeg from +duplicating each output frame to accommodate the originally detected frame +rate. +

    +
  • Display 5 pictures in an area of 3x2 frames, +with 7 pixels between them, and 2 pixels of initial margin, using +mixed flat and named options: +
    +
    tile=3x2:nb_frames=5:padding=7:margin=2
+
    +
+ + +

39.210 tinterlace

+ +

Perform various types of temporal field interlacing. +

+

Frames are counted starting from 1, so the first input frame is +considered odd. +

+

The filter accepts the following options: +

+
+
mode
+

Specify the mode of the interlacing. This option can also be specified +as a value alone. See below for a list of values for this option. +

+

Available values are: +

+
+
‘merge, 0’
+

Move odd frames into the upper field, even into the lower field, +generating a double height frame at half frame rate. +

+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+
+ +
+
‘drop_even, 1’
+

Only output odd frames, even frames are dropped, generating a frame with +unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111                           33333
+11111                           33333
+11111                           33333
+11111                           33333
+
+ +
+
‘drop_odd, 2’
+

Only output even frames, odd frames are dropped, generating a frame with +unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+                22222                           44444
+                22222                           44444
+                22222                           44444
+                22222                           44444
+
+ +
+
‘pad, 3’
+

Expand each frame to full height, but pad alternate lines with black, +generating a frame with double height at the same input frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111           .....           33333           .....
+.....           22222           .....           44444
+11111           .....           33333           .....
+.....           22222           .....           44444
+11111           .....           33333           .....
+.....           22222           .....           44444
+11111           .....           33333           .....
+.....           22222           .....           44444
+
+ + +
+
‘interleave_top, 4’
+

Interleave the upper field from odd frames with the lower field from +even frames, generating a frame with unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111<-         22222           33333<-         44444
+11111           22222<-         33333           44444<-
+11111<-         22222           33333<-         44444
+11111           22222<-         33333           44444<-
+
+Output:
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+
+ + +
+
‘interleave_bottom, 5’
+

Interleave the lower field from odd frames with the upper field from +even frames, generating a frame with unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222<-         33333           44444<-
+11111<-         22222           33333<-         44444
+11111           22222<-         33333           44444<-
+11111<-         22222           33333<-         44444
+
+Output:
+22222                           44444
+11111                           33333
+22222                           44444
+11111                           33333
+
+ + +
+
‘interlacex2, 6’
+

Double frame rate with unchanged height. Frames are inserted each +containing the second temporal field from the previous input frame and +the first temporal field from the next input frame. This mode relies on +the top_field_first flag. Useful for interlaced video displays with no +field synchronisation. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+ 11111           22222           33333           44444
+11111           22222           33333           44444
+ 11111           22222           33333           44444
+
+Output:
+11111   22222   22222   33333   33333   44444   44444
+ 11111   11111   22222   22222   33333   33333   44444
+11111   22222   22222   33333   33333   44444   44444
+ 11111   11111   22222   22222   33333   33333   44444
+
+ + +
+
‘mergex2, 7’
+

Move odd frames into the upper field, even into the lower field, +generating a double height frame at same frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111           33333           33333           55555
+22222           22222           44444           44444
+11111           33333           33333           55555
+22222           22222           44444           44444
+11111           33333           33333           55555
+22222           22222           44444           44444
+11111           33333           33333           55555
+22222           22222           44444           44444
+
+ +
+
+ +

Numeric values are deprecated but are accepted for backward +compatibility reasons. +

+

Default mode is merge. +

+
+
flags
+

Specify flags influencing the filter process. +

+

Available value for flags is: +

+
+
low_pass_filter, vlpf
+

Enable linear vertical low-pass filtering in the filter. +Vertical low-pass filtering is required when creating an interlaced +destination from a progressive source which contains high-frequency +vertical detail. Filtering will reduce interlace ’twitter’ and Moire +patterning. +

+
+
complex_filter, cvlpf
+

Enable complex vertical low-pass filtering. +This will slightly less reduce interlace ’twitter’ and Moire +patterning but better retain detail and subjective sharpness impression. +

+
+
bypass_il
+

Bypass already interlaced frames, only adjust the frame rate. +

+
+ +

Vertical low-pass filtering and bypassing already interlaced frames can only be +enabled for mode interleave_top and interleave_bottom. +

+
+
+ + +

39.211 tmedian

+

Pick median pixels from several successive input video frames. +

+

The filter accepts the following options: +

+
+
radius
+

Set radius of median filter. +Default is 1. Allowed range is from 1 to 127. +

+
+
planes
+

Set which planes to filter. Default value is 15, by which all planes are processed. +

+
+
percentile
+

Set median percentile. Default value is 0.5. +Default value of 0.5 will pick always median values, while 0 will pick +minimum values, and 1 maximum values. +

+
+ + +

39.212 tmix

+ +

Mix successive video frames. +

+

A description of the accepted options follows. +

+
+
frames
+

The number of successive frames to mix. If unspecified, it defaults to 3. +

+
+
weights
+

Specify weight of each input video frame. +Each weight is separated by space. If number of weights is smaller than +number of frames last specified weight will be used for all remaining +unset weights. +

+
+
scale
+

Specify scale, if it is set it will be multiplied with sum +of each weight multiplied with pixel values to give final destination +pixel value. By default scale is auto scaled to sum of weights. +

+
+ + +

39.212.1 Examples

+ +
    +
  • Average 7 successive frames: +
    +
    tmix=frames=7:weights="1 1 1 1 1 1 1"
+
    + +
  • Apply simple temporal convolution: +
    +
    tmix=frames=3:weights="-1 3 -1"
+
    + +
  • Similar as above but only showing temporal differences: +
    +
    tmix=frames=3:weights="-1 2 -1":scale=1
+
    +
+ + +

39.213 tonemap

+

Tone map colors from different dynamic ranges. +

+

This filter expects data in single precision floating point, as it needs to +operate on (and can output) out-of-range values. Another filter, such as +zscale, is needed to convert the resulting frame to a usable format. +

+

The tonemapping algorithms implemented only work on linear light, so input +data should be linearized beforehand (and possibly correctly tagged). +

+
+
ffmpeg -i INPUT -vf zscale=transfer=linear,tonemap=clip,zscale=transfer=bt709,format=yuv420p OUTPUT
+
+ + +

39.213.1 Options

+

The filter accepts the following options. +

+
+
tonemap
+

Set the tone map algorithm to use. +

+

Possible values are: +

+
none
+

Do not apply any tone map, only desaturate overbright pixels. +

+
+
clip
+

Hard-clip any out-of-range values. Use it for perfect color accuracy for +in-range values, while distorting out-of-range values. +

+
+
linear
+

Stretch the entire reference gamut to a linear multiple of the display. +

+
+
gamma
+

Fit a logarithmic transfer between the tone curves. +

+
+
reinhard
+

Preserve overall image brightness with a simple curve, using nonlinear +contrast, which results in flattening details and degrading color accuracy. +

+
+
hable
+

Preserve both dark and bright details better than reinhard, at the cost +of slightly darkening everything. Use it when detail preservation is more +important than color and brightness accuracy. +

+
+
mobius
+

Smoothly map out-of-range values, while retaining contrast and colors for +in-range material as much as possible. Use it when color accuracy is more +important than detail preservation. +

+
+ +

Default is none. +

+
+
param
+

Tune the tone mapping algorithm. +

+

This affects the following algorithms: +

+
none
+

Ignored. +

+
+
linear
+

Specifies the scale factor to use while stretching. +Default to 1.0. +

+
+
gamma
+

Specifies the exponent of the function. +Default to 1.8. +

+
+
clip
+

Specify an extra linear coefficient to multiply into the signal before clipping. +Default to 1.0. +

+
+
reinhard
+

Specify the local contrast coefficient at the display peak. +Default to 0.5, which means that in-gamut values will be about half as bright +as when clipping. +

+
+
hable
+

Ignored. +

+
+
mobius
+

Specify the transition point from linear to mobius transform. Every value +below this point is guaranteed to be mapped 1:1. The higher the value, the +more accurate the result will be, at the cost of losing bright details. +Default to 0.3, which due to the steep initial slope still preserves in-range +colors fairly accurately. +

+
+ +
+
desat
+

Apply desaturation for highlights that exceed this level of brightness. The +higher the parameter, the more color information will be preserved. This +setting helps prevent unnaturally blown-out colors for super-highlights, by +(smoothly) turning into white instead. This makes images feel more natural, +at the cost of reducing information about out-of-range colors. +

+

The default of 2.0 is somewhat conservative and will mostly just apply to +skies or directly sunlit surfaces. A setting of 0.0 disables this option. +

+

This option works only if the input frame has a supported color tag. +

+
+
peak
+

Override signal/nominal/reference peak with this value. Useful when the +embedded peak information in display metadata is not reliable or when tone +mapping from a lower range to a higher range. +

+
+ + +

39.214 tpad

+ +

Temporarily pad video frames. +

+

The filter accepts the following options: +

+
+
start
+

Specify number of delay frames before input video stream. Default is 0. +

+
+
stop
+

Specify number of padding frames after input video stream. +Set to -1 to pad indefinitely. Default is 0. +

+
+
start_mode
+

Set kind of frames added to beginning of stream. +Can be either add or clone. +With add frames of solid-color are added. +With clone frames are clones of first frame. +Default is add. +

+
+
stop_mode
+

Set kind of frames added to end of stream. +Can be either add or clone. +With add frames of solid-color are added. +With clone frames are clones of last frame. +Default is add. +

+
+
start_duration, stop_duration
+

Specify the duration of the start/stop delay. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +These options override start and stop. Default is 0. +

+
+
color
+

Specify the color of the padded area. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. +

+

The default value of color is "black". +

+
+ + +

39.215 transpose

+ +

Transpose rows with columns in the input video and optionally flip it. +

+

It accepts the following parameters: +

+
+
dir
+

Specify the transposition direction. +

+

Can assume the following values: +

+
‘0, 4, cclock_flip’
+

Rotate by 90 degrees counterclockwise and vertically flip (default), that is: +

+
L.R     L.l
+. . ->  . .
+l.r     R.r
+
+ +
+
‘1, 5, clock’
+

Rotate by 90 degrees clockwise, that is: +

+
L.R     l.L
+. . ->  . .
+l.r     r.R
+
+ +
+
‘2, 6, cclock’
+

Rotate by 90 degrees counterclockwise, that is: +

+
L.R     R.r
+. . ->  . .
+l.r     L.l
+
+ +
+
‘3, 7, clock_flip’
+

Rotate by 90 degrees clockwise and vertically flip, that is: +

+
L.R     r.R
+. . ->  . .
+l.r     l.L
+
+
+
+ +

For values between 4-7, the transposition is only done if the input +video geometry is portrait and not landscape. These values are +deprecated, the passthrough option should be used instead. +

+

Numerical values are deprecated, and should be dropped in favor of +symbolic constants. +

+
+
passthrough
+

Do not apply the transposition if the input geometry matches the one +specified by the specified value. It accepts the following values: +

+
‘none’
+

Always apply transposition. +

+
‘portrait’
+

Preserve portrait geometry (when height >= width). +

+
‘landscape’
+

Preserve landscape geometry (when width >= height). +

+
+ +

Default value is none. +

+
+ +

For example to rotate by 90 degrees clockwise and preserve portrait +layout: +

+
transpose=dir=1:passthrough=portrait
+
+ +

The command above can also be specified as: +

+
transpose=1:portrait
+
+ + +

39.216 transpose_npp

+ +

Transpose rows with columns in the input video and optionally flip it. +For more in depth examples see the transpose video filter, which shares mostly the same options. +

+

It accepts the following parameters: +

+
+
dir
+

Specify the transposition direction. +

+

Can assume the following values: +

+
‘cclock_flip’
+

Rotate by 90 degrees counterclockwise and vertically flip. (default) +

+
+
‘clock’
+

Rotate by 90 degrees clockwise. +

+
+
‘cclock’
+

Rotate by 90 degrees counterclockwise. +

+
+
‘clock_flip’
+

Rotate by 90 degrees clockwise and vertically flip. +

+
+ +
+
passthrough
+

Do not apply the transposition if the input geometry matches the one +specified by the specified value. It accepts the following values: +

+
‘none’
+

Always apply transposition. (default) +

+
‘portrait’
+

Preserve portrait geometry (when height >= width). +

+
‘landscape’
+

Preserve landscape geometry (when width >= height). +

+
+ +
+
+ + +

39.217 trim

+

Trim the input so that the output contains one continuous subpart of the input. +

+

It accepts the following parameters: +

+
start
+

Specify the time of the start of the kept section, i.e. the frame with the +timestamp start will be the first frame in the output. +

+
+
end
+

Specify the time of the first frame that will be dropped, i.e. the frame +immediately preceding the one with the timestamp end will be the last +frame in the output. +

+
+
start_pts
+

This is the same as start, except this option sets the start timestamp +in timebase units instead of seconds. +

+
+
end_pts
+

This is the same as end, except this option sets the end timestamp +in timebase units instead of seconds. +

+
+
duration
+

The maximum duration of the output in seconds. +

+
+
start_frame
+

The number of the first frame that should be passed to the output. +

+
+
end_frame
+

The number of the first frame that should be dropped. +

+
+ +

start, end, and duration are expressed as time +duration specifications; see +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

Note that the first two sets of the start/end options and the duration +option look at the frame timestamp, while the _frame variants simply count the +frames that pass through the filter. Also note that this filter does not modify +the timestamps. If you wish for the output timestamps to start at zero, insert a +setpts filter after the trim filter. +

+

If multiple start or end options are set, this filter tries to be greedy and +keep all the frames that match at least one of the specified constraints. To keep +only the part that matches all the constraints at once, chain multiple trim +filters. +

+

The defaults are such that all the input is kept. So it is possible to set e.g. +just the end values to keep everything before the specified time. +

+

Examples: +

    +
  • Drop everything except the second minute of input: +
    +
    ffmpeg -i INPUT -vf trim=60:120
+
    + +
  • Keep only the first second: +
    +
    ffmpeg -i INPUT -vf trim=duration=1
+
    + +
+ + +

39.218 unpremultiply

+

Apply alpha unpremultiply effect to input video stream using first plane +of second stream as alpha. +

+

Both streams must have same dimensions and same pixel format. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+

If the format has 1 or 2 components, then luma is bit 0. +If the format has 3 or 4 components: +for RGB formats bit 0 is green, bit 1 is blue and bit 2 is red; +for YUV formats bit 0 is luma, bit 1 is chroma-U and bit 2 is chroma-V. +If present, the alpha channel is always the last bit. +

+
+
inplace
+

Do not require 2nd input for processing, instead use alpha plane from input stream. +

+
+ + +

39.219 unsharp

+ +

Sharpen or blur the input video. +

+

It accepts the following parameters: +

+
+
luma_msize_x, lx
+

Set the luma matrix horizontal size. It must be an odd integer between +3 and 23. The default value is 5. +

+
+
luma_msize_y, ly
+

Set the luma matrix vertical size. It must be an odd integer between 3 +and 23. The default value is 5. +

+
+
luma_amount, la
+

Set the luma effect strength. It must be a floating point number, reasonable +values lay between -1.5 and 1.5. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+

Default value is 1.0. +

+
+
chroma_msize_x, cx
+

Set the chroma matrix horizontal size. It must be an odd integer +between 3 and 23. The default value is 5. +

+
+
chroma_msize_y, cy
+

Set the chroma matrix vertical size. It must be an odd integer +between 3 and 23. The default value is 5. +

+
+
chroma_amount, ca
+

Set the chroma effect strength. It must be a floating point number, reasonable +values lay between -1.5 and 1.5. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+

Default value is 0.0. +

+
+
+ +

All parameters are optional and default to the equivalent of the +string ’5:5:1.0:5:5:0.0’. +

+ +

39.219.1 Examples

+ +
    +
  • Apply strong luma sharpen effect: +
    +
    unsharp=luma_msize_x=7:luma_msize_y=7:luma_amount=2.5
+
    + +
  • Apply a strong blur of both luma and chroma parameters: +
    +
    unsharp=7:7:-2:7:7:-2
+
    +
+ + +

39.220 untile

+ +

Decompose a video made of tiled images into the individual images. +

+

The frame rate of the output video is the frame rate of the input video +multiplied by the number of tiles. +

+

This filter does the reverse of tile. +

+

The filter accepts the following options: +

+
+
layout
+

Set the grid size (i.e. the number of lines and columns). For the syntax of +this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+ + +

39.220.1 Examples

+ +
    +
  • Produce a 1-second video from a still image file made of 25 frames stacked +vertically, like an analogic film reel: +
    +
    ffmpeg -r 1 -i image.jpg -vf untile=1x25 movie.mkv
+
    +
+ + +

39.221 uspp

+ +

Apply ultra slow/simple postprocessing filter that compresses and decompresses +the image at several (or - in the case of quality level 8 - all) +shifts and average the results. +

+

The way this differs from the behavior of spp is that uspp actually encodes & +decodes each case with libavcodec Snow, whereas spp uses a simplified intra only 8x8 +DCT similar to MJPEG. +

+

The filter accepts the following options: +

+
+
quality
+

Set quality. This option defines the number of levels for averaging. It accepts +an integer in the range 0-8. If set to 0, the filter will have no +effect. A value of 8 means the higher quality. For each increment of +that value the speed drops by a factor of approximately 2. Default value is +3. +

+
+
qp
+

Force a constant quantization parameter. If not set, the filter will use the QP +from the video stream (if available). +

+
+ + +

39.222 v360

+ +

Convert 360 videos between various formats. +

+

The filter accepts the following options: +

+
+
input
+
output
+

Set format of the input/output video. +

+

Available formats: +

+
+
‘e’
+
‘equirect’
+

Equirectangular projection. +

+
+
‘c3x2’
+
‘c6x1’
+
‘c1x6’
+

Cubemap with 3x2/6x1/1x6 layout. +

+

Format specific options: +

+
+
in_pad
+
out_pad
+

Set padding proportion for the input/output cubemap. Values in decimals. +

+

Example values: +

+
‘0’
+

No padding. +

+
‘0.01’
+

1% of face is padding. For example, with 1920x1280 resolution face size would be 640x640 and padding would be 3 pixels from each side. (640 * 0.01 = 6 pixels) +

+
+ +

Default value is ‘0’. +Maximum value is ‘0.1’. +

+
+
fin_pad
+
fout_pad
+

Set fixed padding for the input/output cubemap. Values in pixels. +

+

Default value is ‘0’. If greater than zero it overrides other padding options. +

+
+
in_forder
+
out_forder
+

Set order of faces for the input/output cubemap. Choose one direction for each position. +

+

Designation of directions: +

+
‘r’
+

right +

+
‘l’
+

left +

+
‘u’
+

up +

+
‘d’
+

down +

+
‘f’
+

forward +

+
‘b’
+

back +

+
+ +

Default value is ‘rludfb’. +

+
+
in_frot
+
out_frot
+

Set rotation of faces for the input/output cubemap. Choose one angle for each position. +

+

Designation of angles: +

+
‘0’
+

0 degrees clockwise +

+
‘1’
+

90 degrees clockwise +

+
‘2’
+

180 degrees clockwise +

+
‘3’
+

270 degrees clockwise +

+
+ +

Default value is ‘000000’. +

+
+ +
+
‘eac’
+

Equi-Angular Cubemap. +

+
+
‘flat’
+
‘gnomonic’
+
‘rectilinear’
+

Regular video. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘dfisheye’
+

Dual fisheye. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘barrel’
+
‘fb’
+
‘barrelsplit’
+

Facebook’s 360 formats. +

+
+
‘sg’
+

Stereographic format. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘mercator’
+

Mercator format. +

+
+
‘ball’
+

Ball format, gives significant distortion toward the back. +

+
+
‘hammer’
+

Hammer-Aitoff map projection format. +

+
+
‘sinusoidal’
+

Sinusoidal map projection format. +

+
+
‘fisheye’
+

Fisheye projection. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘pannini’
+

Pannini projection. +

+

Format specific options: +

+
h_fov
+

Set output pannini parameter. +

+
+
ih_fov
+

Set input pannini parameter. +

+
+ +
+
‘cylindrical’
+

Cylindrical projection. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘perspective’
+

Perspective projection. (output only) +

+

Format specific options: +

+
v_fov
+

Set perspective parameter. +

+
+ +
+
‘tetrahedron’
+

Tetrahedron projection. +

+
+
‘tsp’
+

Truncated square pyramid projection. +

+
+
‘he’
+
‘hequirect’
+

Half equirectangular projection. +

+
+ +
+
interp
+

Set interpolation method.
+Note: more complex interpolation methods require much more memory to run. +

+

Available methods: +

+
+
‘near’
+
‘nearest’
+

Nearest neighbour. +

+
‘line’
+
‘linear’
+

Bilinear interpolation. +

+
‘lagrange9’
+

Lagrange9 interpolation. +

+
‘cube’
+
‘cubic’
+

Bicubic interpolation. +

+
‘lanc’
+
‘lanczos’
+

Lanczos interpolation. +

+
‘sp16’
+
‘spline16’
+

Spline16 interpolation. +

+
‘gauss’
+
‘gaussian’
+

Gaussian interpolation. +

+
+ +

Default value is ‘line’. +

+
+
w
+
h
+

Set the output video resolution. +

+

Default resolution depends on formats. +

+
+
in_stereo
+
out_stereo
+

Set the input/output stereo format. +

+
+
‘2d’
+

2D mono +

+
‘sbs’
+

Side by side +

+
‘tb’
+

Top bottom +

+
+ +

Default value is ‘2d’ for input and output format. +

+
+
yaw
+
pitch
+
roll
+

Set rotation for the output video. Values in degrees. +

+
+
rorder
+

Set rotation order for the output video. Choose one item for each position. +

+
+
‘y, Y’
+

yaw +

+
‘p, P’
+

pitch +

+
‘r, R’
+

roll +

+
+ +

Default value is ‘ypr’. +

+
+
h_flip
+
v_flip
+
d_flip
+

Flip the output video horizontally(swaps left-right)/vertically(swaps up-down)/in-depth(swaps back-forward). Boolean values. +

+
+
ih_flip
+
iv_flip
+

Set if input video is flipped horizontally/vertically. Boolean values. +

+
+
in_trans
+

Set if input video is transposed. Boolean value, by default disabled. +

+
+
out_trans
+

Set if output video needs to be transposed. Boolean value, by default disabled. +

+
+
alpha_mask
+

Build mask in alpha plane for all unmapped pixels by marking them fully transparent. Boolean value, by default disabled. +

+
+ + +

39.222.1 Examples

+ +
    +
  • Convert equirectangular video to cubemap with 3x2 layout and 1% padding using bicubic interpolation: +
    +
    ffmpeg -i input.mkv -vf v360=e:c3x2:cubic:out_pad=0.01 output.mkv
+
    +
  • Extract back view of Equi-Angular Cubemap: +
    +
    ffmpeg -i input.mkv -vf v360=eac:flat:yaw=180 output.mkv
+
    +
  • Convert transposed and horizontally flipped Equi-Angular Cubemap in side-by-side stereo format to equirectangular top-bottom stereo format: +
    +
    v360=eac:equirect:in_stereo=sbs:in_trans=1:ih_flip=1:out_stereo=tb
+
    +
+ + +

39.222.2 Commands

+ +

This filter supports subset of above options as commands. +

+ +

39.223 vaguedenoiser

+ +

Apply a wavelet based denoiser. +

+

It transforms each frame from the video input into the wavelet domain, +using Cohen-Daubechies-Feauveau 9/7. Then it applies some filtering to +the obtained coefficients. It does an inverse wavelet transform after. +Due to wavelet properties, it should give a nice smoothed result, and +reduced noise, without blurring picture features. +

+

This filter accepts the following options: +

+
+
threshold
+

The filtering strength. The higher, the more filtered the video will be. +Hard thresholding can use a higher threshold than soft thresholding +before the video looks overfiltered. Default value is 2. +

+
+
method
+

The filtering method the filter will use. +

+

It accepts the following values: +

+
‘hard’
+

All values under the threshold will be zeroed. +

+
+
‘soft’
+

All values under the threshold will be zeroed. All values above will be +reduced by the threshold. +

+
+
‘garrote’
+

Scales or nullifies coefficients - intermediary between (more) soft and +(less) hard thresholding. +

+
+ +

Default is garrote. +

+
+
nsteps
+

Number of times, the wavelet will decompose the picture. Picture can’t +be decomposed beyond a particular point (typically, 8 for a 640x480 +frame - as 2^9 = 512 > 480). Valid values are integers between 1 and 32. Default value is 6. +

+
+
percent
+

Partial of full denoising (limited coefficients shrinking), from 0 to 100. Default value is 85. +

+
+
planes
+

A list of the planes to process. By default all planes are processed. +

+
+
type
+

The threshold type the filter will use. +

+

It accepts the following values: +

+
‘universal’
+

Threshold used is same for all decompositions. +

+
+
‘bayes’
+

Threshold used depends also on each decomposition coefficients. +

+
+ +

Default is universal. +

+
+ + +

39.224 vectorscope

+ +

Display 2 color component values in the two dimensional graph (which is called +a vectorscope). +

+

This filter accepts the following options: +

+
+
mode, m
+

Set vectorscope mode. +

+

It accepts the following values: +

+
‘gray’
+
‘tint’
+

Gray values are displayed on graph, higher brightness means more pixels have +same component color value on location in graph. This is the default mode. +

+
+
‘color’
+

Gray values are displayed on graph. Surrounding pixels values which are not +present in video frame are drawn in gradient of 2 color components which are +set by option x and y. The 3rd color component is static. +

+
+
‘color2’
+

Actual color components values present in video frame are displayed on graph. +

+
+
‘color3’
+

Similar as color2 but higher frequency of same values x and y +on graph increases value of another color component, which is luminance by +default values of x and y. +

+
+
‘color4’
+

Actual colors present in video frame are displayed on graph. If two different +colors map to same position on graph then color with higher value of component +not present in graph is picked. +

+
+
‘color5’
+

Gray values are displayed on graph. Similar to color but with 3rd color +component picked from radial gradient. +

+
+ +
+
x
+

Set which color component will be represented on X-axis. Default is 1. +

+
+
y
+

Set which color component will be represented on Y-axis. Default is 2. +

+
+
intensity, i
+

Set intensity, used by modes: gray, color, color3 and color5 for increasing brightness +of color component which represents frequency of (X, Y) location in graph. +

+
+
envelope, e
+
+
‘none’
+

No envelope, this is default. +

+
+
‘instant’
+

Instant envelope, even darkest single pixel will be clearly highlighted. +

+
+
‘peak’
+

Hold maximum and minimum values presented in graph over time. This way you +can still spot out of range values without constantly looking at vectorscope. +

+
+
‘peak+instant’
+

Peak and instant envelope combined together. +

+
+ +
+
graticule, g
+

Set what kind of graticule to draw. +

+
‘none’
+
‘green’
+
‘color’
+
‘invert’
+
+ +
+
opacity, o
+

Set graticule opacity. +

+
+
flags, f
+

Set graticule flags. +

+
+
‘white’
+

Draw graticule for white point. +

+
+
‘black’
+

Draw graticule for black point. +

+
+
‘name’
+

Draw color points short names. +

+
+ +
+
bgopacity, b
+

Set background opacity. +

+
+
lthreshold, l
+

Set low threshold for color component not represented on X or Y axis. +Values lower than this value will be ignored. Default is 0. +Note this value is multiplied with actual max possible value one pixel component +can have. So for 8-bit input and low threshold value of 0.1 actual threshold +is 0.1 * 255 = 25. +

+
+
hthreshold, h
+

Set high threshold for color component not represented on X or Y axis. +Values higher than this value will be ignored. Default is 1. +Note this value is multiplied with actual max possible value one pixel component +can have. So for 8-bit input and high threshold value of 0.9 actual threshold +is 0.9 * 255 = 230. +

+
+
colorspace, c
+

Set what kind of colorspace to use when drawing graticule. +

+
‘auto’
+
‘601’
+
‘709’
+
+

Default is auto. +

+
+
tint0, t0
+
tint1, t1
+

Set color tint for gray/tint vectorscope mode. By default both options are zero. +This means no tint, and output will remain gray. +

+
+ + +

39.225 vidstabdetect

+ +

Analyze video stabilization/deshaking. Perform pass 1 of 2, see +vidstabtransform for pass 2. +

+

This filter generates a file with relative translation and rotation +transform information about subsequent frames, which is then used by +the vidstabtransform filter. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libvidstab. +

+

This filter accepts the following options: +

+
+
result
+

Set the path to the file used to write the transforms information. +Default value is transforms.trf. +

+
+
shakiness
+

Set how shaky the video is and how quick the camera is. It accepts an +integer in the range 1-10, a value of 1 means little shakiness, a +value of 10 means strong shakiness. Default value is 5. +

+
+
accuracy
+

Set the accuracy of the detection process. It must be a value in the +range 1-15. A value of 1 means low accuracy, a value of 15 means high +accuracy. Default value is 15. +

+
+
stepsize
+

Set stepsize of the search process. The region around minimum is +scanned with 1 pixel resolution. Default value is 6. +

+
+
mincontrast
+

Set minimum contrast. Below this value a local measurement field is +discarded. Must be a floating point value in the range 0-1. Default +value is 0.3. +

+
+
tripod
+

Set reference frame number for tripod mode. +

+

If enabled, the motion of the frames is compared to a reference frame +in the filtered stream, identified by the specified number. The idea +is to compensate all movements in a more-or-less static scene and keep +the camera view absolutely still. +

+

If set to 0, it is disabled. The frames are counted starting from 1. +

+
+
show
+

Show fields and transforms in the resulting frames. It accepts an +integer in the range 0-2. Default value is 0, which disables any +visualization. +

+
+ + +

39.225.1 Examples

+ +
    +
  • Use default values: +
    +
    vidstabdetect
+
    + +
  • Analyze strongly shaky movie and put the results in file +mytransforms.trf: +
    +
    vidstabdetect=shakiness=10:accuracy=15:result="mytransforms.trf"
+
    + +
  • Visualize the result of internal transformations in the resulting +video: +
    +
    vidstabdetect=show=1
+
    + +
  • Analyze a video with medium shakiness using ffmpeg: +
    +
    ffmpeg -i input -vf vidstabdetect=shakiness=5:show=1 dummy.avi
+
    +
+ + +

39.226 vidstabtransform

+ +

Video stabilization/deshaking: pass 2 of 2, +see vidstabdetect for pass 1. +

+

Read a file with transform information for each frame and +apply/compensate them. Together with the vidstabdetect +filter this can be used to deshake videos. See also +http://public.hronopik.de/vid.stab. It is important to also use +the unsharp filter, see below. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libvidstab. +

+ +

39.226.1 Options

+ +
+
input
+

Set path to the file used to read the transforms. Default value is +transforms.trf. +

+
+
smoothing
+

Set the number of frames (value*2 + 1) used for lowpass filtering the +camera movements. Default value is 10. +

+

For example a number of 10 means that 21 frames are used (10 in the +past and 10 in the future) to smoothen the motion in the video. A +larger value leads to a smoother video, but limits the acceleration of +the camera (pan/tilt movements). 0 is a special case where a static +camera is simulated. +

+
+
optalgo
+

Set the camera path optimization algorithm. +

+

Accepted values are: +

+
‘gauss’
+

gaussian kernel low-pass filter on camera motion (default) +

+
‘avg’
+

averaging on transformations +

+
+ +
+
maxshift
+

Set maximal number of pixels to translate frames. Default value is -1, +meaning no limit. +

+
+
maxangle
+

Set maximal angle in radians (degree*PI/180) to rotate frames. Default +value is -1, meaning no limit. +

+
+
crop
+

Specify how to deal with borders that may be visible due to movement +compensation. +

+

Available values are: +

+
‘keep’
+

keep image information from previous frame (default) +

+
‘black’
+

fill the border black +

+
+ +
+
invert
+

Invert transforms if set to 1. Default value is 0. +

+
+
relative
+

Consider transforms as relative to previous frame if set to 1, +absolute if set to 0. Default value is 0. +

+
+
zoom
+

Set percentage to zoom. A positive value will result in a zoom-in +effect, a negative value in a zoom-out effect. Default value is 0 (no +zoom). +

+
+
optzoom
+

Set optimal zooming to avoid borders. +

+

Accepted values are: +

+
‘0’
+

disabled +

+
‘1’
+

optimal static zoom value is determined (only very strong movements +will lead to visible borders) (default) +

+
‘2’
+

optimal adaptive zoom value is determined (no borders will be +visible), see zoomspeed +

+
+ +

Note that the value given at zoom is added to the one calculated here. +

+
+
zoomspeed
+

Set percent to zoom maximally each frame (enabled when +optzoom is set to 2). Range is from 0 to 5, default value is +0.25. +

+
+
interpol
+

Specify type of interpolation. +

+

Available values are: +

+
‘no’
+

no interpolation +

+
‘linear’
+

linear only horizontal +

+
‘bilinear’
+

linear in both directions (default) +

+
‘bicubic’
+

cubic in both directions (slow) +

+
+ +
+
tripod
+

Enable virtual tripod mode if set to 1, which is equivalent to +relative=0:smoothing=0. Default value is 0. +

+

Use also tripod option of vidstabdetect. +

+
+
debug
+

Increase log verbosity if set to 1. Also the detected global motions +are written to the temporary file global_motions.trf. Default +value is 0. +

+
+ + +

39.226.2 Examples

+ +
    +
  • Use ffmpeg for a typical stabilization with default values: +
    +
    ffmpeg -i inp.mpeg -vf vidstabtransform,unsharp=5:5:0.8:3:3:0.4 inp_stabilized.mpeg
+
    + +

    Note the use of the unsharp filter which is always recommended. +

    +
  • Zoom in a bit more and load transform data from a given file: +
    +
    vidstabtransform=zoom=5:input="mytransforms.trf"
+
    + +
  • Smoothen the video even more: +
    +
    vidstabtransform=smoothing=30
+
    +
+ + +

39.227 vflip

+ +

Flip the input video vertically. +

+

For example, to vertically flip a video with ffmpeg: +

+
ffmpeg -i in.avi -vf "vflip" out.avi
+
+ + +

39.228 vfrdet

+ +

Detect variable frame rate video. +

+

This filter tries to detect if the input is variable or constant frame rate. +

+

At end it will output number of frames detected as having variable delta pts, +and ones with constant delta pts. +If there was frames with variable delta, than it will also show min, max and +average delta encountered. +

+ +

39.229 vibrance

+ +

Boost or alter saturation. +

+

The filter accepts the following options: +

+
intensity
+

Set strength of boost if positive value or strength of alter if negative value. +Default is 0. Allowed range is from -2 to 2. +

+
+
rbal
+

Set the red balance. Default is 1. Allowed range is from -10 to 10. +

+
+
gbal
+

Set the green balance. Default is 1. Allowed range is from -10 to 10. +

+
+
bbal
+

Set the blue balance. Default is 1. Allowed range is from -10 to 10. +

+
+
rlum
+

Set the red luma coefficient. +

+
+
glum
+

Set the green luma coefficient. +

+
+
blum
+

Set the blue luma coefficient. +

+
+
alternate
+

If intensity is negative and this is set to 1, colors will change, +otherwise colors will be less saturated, more towards gray. +

+
+ + +

39.229.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

39.230 vignette

+ +

Make or reverse a natural vignetting effect. +

+

The filter accepts the following options: +

+
+
angle, a
+

Set lens angle expression as a number of radians. +

+

The value is clipped in the [0,PI/2] range. +

+

Default value: "PI/5" +

+
+
x0
+
y0
+

Set center coordinates expressions. Respectively "w/2" and "h/2" +by default. +

+
+
mode
+

Set forward/backward mode. +

+

Available modes are: +

+
‘forward’
+

The larger the distance from the central point, the darker the image becomes. +

+
+
‘backward’
+

The larger the distance from the central point, the brighter the image becomes. +This can be used to reverse a vignette effect, though there is no automatic +detection to extract the lens angle and other settings (yet). It can +also be used to create a burning effect. +

+
+ +

Default value is ‘forward’. +

+
+
eval
+

Set evaluation mode for the expressions (angle, x0, y0). +

+

It accepts the following values: +

+
‘init’
+

Evaluate expressions only once during the filter initialization. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. This is way slower than the +‘init’ mode since it requires all the scalers to be re-computed, but it +allows advanced dynamic expressions. +

+
+ +

Default value is ‘init’. +

+
+
dither
+

Set dithering to reduce the circular banding effects. Default is 1 +(enabled). +

+
+
aspect
+

Set vignette aspect. This setting allows one to adjust the shape of the vignette. +Setting this value to the SAR of the input will make a rectangular vignetting +following the dimensions of the video. +

+

Default is 1/1. +

+
+ + +

39.230.1 Expressions

+ +

The alpha, x0 and y0 expressions can contain the +following parameters. +

+
+
w
+
h
+

input width and height +

+
+
n
+

the number of input frame, starting from 0 +

+
+
pts
+

the PTS (Presentation TimeStamp) time of the filtered video frame, expressed in +TB units, NAN if undefined +

+
+
r
+

frame rate of the input video, NAN if the input frame rate is unknown +

+
+
t
+

the PTS (Presentation TimeStamp) of the filtered video frame, +expressed in seconds, NAN if undefined +

+
+
tb
+

time base of the input video +

+
+ + + +

39.230.2 Examples

+ +
    +
  • Apply simple strong vignetting effect: +
    +
    vignette=PI/4
+
    + +
  • Make a flickering vignetting: +
    +
    vignette='PI/4+random(1)*PI/50':eval=frame
+
    + +
+ + +

39.231 vmafmotion

+ +

Obtain the average VMAF motion score of a video. +It is one of the component metrics of VMAF. +

+

The obtained average motion score is printed through the logging system. +

+

The filter accepts the following options: +

+
+
stats_file
+

If specified, the filter will use the named file to save the motion score of +each frame with respect to the previous frame. +When filename equals "-" the data is sent to standard output. +

+
+ +

Example: +

+
ffmpeg -i ref.mpg -vf vmafmotion -f null -
+
+ + +

39.232 vstack

+

Stack input videos vertically. +

+

All streams must be of same pixel format and of same width. +

+

Note that this filter is faster than using overlay and pad filter +to create same output. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of input streams. Default is 2. +

+
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+ + +

39.233 w3fdif

+ +

Deinterlace the input video ("w3fdif" stands for "Weston 3 Field +Deinterlacing Filter"). +

+

Based on the process described by Martin Weston for BBC R&D, and +implemented based on the de-interlace algorithm written by Jim +Easterbrook for BBC R&D, the Weston 3 field deinterlacing filter +uses filter coefficients calculated by BBC R&D. +

+

This filter uses field-dominance information in frame to decide which +of each pair of fields to place first in the output. +If it gets it wrong use setfield filter before w3fdif filter. +

+

There are two sets of filter coefficients, so called "simple" +and "complex". Which set of filter coefficients is used can +be set by passing an optional parameter: +

+
+
filter
+

Set the interlacing filter coefficients. Accepts one of the following values: +

+
+
‘simple’
+

Simple filter coefficient set. +

+
‘complex’
+

More-complex filter coefficient set. +

+
+

Default value is ‘complex’. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following values: +

+
+
‘all’
+

Deinterlace all frames, +

+
‘interlaced’
+

Only deinterlace frames marked as interlaced. +

+
+ +

Default value is ‘all’. +

+
+ + +

39.234 waveform

+

Video waveform monitor. +

+

The waveform monitor plots color component intensity. By default luminance +only. Each column of the waveform corresponds to a column of pixels in the +source video. +

+

It accepts the following options: +

+
+
mode, m
+

Can be either row, or column. Default is column. +In row mode, the graph on the left side represents color component value 0 and +the right side represents value = 255. In column mode, the top side represents +color component value = 0 and bottom side represents value = 255. +

+
+
intensity, i
+

Set intensity. Smaller values are useful to find out how many values of the same +luminance are distributed across input rows/columns. +Default value is 0.04. Allowed range is [0, 1]. +

+
+
mirror, r
+

Set mirroring mode. 0 means unmirrored, 1 means mirrored. +In mirrored mode, higher values will be represented on the left +side for row mode and at the top for column mode. Default is +1 (mirrored). +

+
+
display, d
+

Set display mode. +It accepts the following values: +

+
‘overlay’
+

Presents information identical to that in the parade, except +that the graphs representing color components are superimposed directly +over one another. +

+

This display mode makes it easier to spot relative differences or similarities +in overlapping areas of the color components that are supposed to be identical, +such as neutral whites, grays, or blacks. +

+
+
‘stack’
+

Display separate graph for the color components side by side in +row mode or one below the other in column mode. +

+
+
‘parade’
+

Display separate graph for the color components side by side in +column mode or one below the other in row mode. +

+

Using this display mode makes it easy to spot color casts in the highlights +and shadows of an image, by comparing the contours of the top and the bottom +graphs of each waveform. Since whites, grays, and blacks are characterized +by exactly equal amounts of red, green, and blue, neutral areas of the picture +should display three waveforms of roughly equal width/height. If not, the +correction is easy to perform by making level adjustments the three waveforms. +

+
+

Default is stack. +

+
+
components, c
+

Set which color components to display. Default is 1, which means only luminance +or red color component if input is in RGB colorspace. If is set for example to +7 it will display all 3 (if) available color components. +

+
+
envelope, e
+
+
‘none’
+

No envelope, this is default. +

+
+
‘instant’
+

Instant envelope, minimum and maximum values presented in graph will be easily +visible even with small step value. +

+
+
‘peak’
+

Hold minimum and maximum values presented in graph across time. This way you +can still spot out of range values without constantly looking at waveforms. +

+
+
‘peak+instant’
+

Peak and instant envelope combined together. +

+
+ +
+
filter, f
+
+
‘lowpass’
+

No filtering, this is default. +

+
+
‘flat’
+

Luma and chroma combined together. +

+
+
‘aflat’
+

Similar as above, but shows difference between blue and red chroma. +

+
+
‘xflat’
+

Similar as above, but use different colors. +

+
+
‘yflat’
+

Similar as above, but again with different colors. +

+
+
‘chroma’
+

Displays only chroma. +

+
+
‘color’
+

Displays actual color value on waveform. +

+
+
‘acolor’
+

Similar as above, but with luma showing frequency of chroma values. +

+
+ +
+
graticule, g
+

Set which graticule to display. +

+
+
‘none’
+

Do not display graticule. +

+
+
‘green’
+

Display green graticule showing legal broadcast ranges. +

+
+
‘orange’
+

Display orange graticule showing legal broadcast ranges. +

+
+
‘invert’
+

Display invert graticule showing legal broadcast ranges. +

+
+ +
+
opacity, o
+

Set graticule opacity. +

+
+
flags, fl
+

Set graticule flags. +

+
+
‘numbers’
+

Draw numbers above lines. By default enabled. +

+
+
‘dots’
+

Draw dots instead of lines. +

+
+ +
+
scale, s
+

Set scale used for displaying graticule. +

+
+
‘digital’
+
‘millivolts’
+
‘ire’
+
+

Default is digital. +

+
+
bgopacity, b
+

Set background opacity. +

+
+
tint0, t0
+
tint1, t1
+

Set tint for output. +Only used with lowpass filter and when display is not overlay and input +pixel formats are not RGB. +

+
+ + +

39.235 weave, doubleweave

+ +

The weave takes a field-based video input and join +each two sequential fields into single frame, producing a new double +height clip with half the frame rate and half the frame count. +

+

The doubleweave works same as weave but without +halving frame rate and frame count. +

+

It accepts the following option: +

+
+
first_field
+

Set first field. Available values are: +

+
+
‘top, t’
+

Set the frame as top-field-first. +

+
+
‘bottom, b’
+

Set the frame as bottom-field-first. +

+
+
+
+ + +

39.235.1 Examples

+ +
    +
  • Interlace video using select and separatefields filter: +
    +
    separatefields,select=eq(mod(n,4),0)+eq(mod(n,4),3),weave
+
    +
+ + +

39.236 xbr

+

Apply the xBR high-quality magnification filter which is designed for pixel +art. It follows a set of edge-detection rules, see +https://forums.libretro.com/t/xbr-algorithm-tutorial/123. +

+

It accepts the following option: +

+
+
n
+

Set the scaling dimension: 2 for 2xBR, 3 for +3xBR and 4 for 4xBR. +Default is 3. +

+
+ + +

39.237 xfade

+ +

Apply cross fade from one input video stream to another input video stream. +The cross fade is applied for specified duration. +

+

The filter accepts the following options: +

+
+
transition
+

Set one of available transition effects: +

+
+
‘custom’
+
‘fade’
+
‘wipeleft’
+
‘wiperight’
+
‘wipeup’
+
‘wipedown’
+
‘slideleft’
+
‘slideright’
+
‘slideup’
+
‘slidedown’
+
‘circlecrop’
+
‘rectcrop’
+
‘distance’
+
‘fadeblack’
+
‘fadewhite’
+
‘radial’
+
‘smoothleft’
+
‘smoothright’
+
‘smoothup’
+
‘smoothdown’
+
‘circleopen’
+
‘circleclose’
+
‘vertopen’
+
‘vertclose’
+
‘horzopen’
+
‘horzclose’
+
‘dissolve’
+
‘pixelize’
+
‘diagtl’
+
‘diagtr’
+
‘diagbl’
+
‘diagbr’
+
‘hlslice’
+
‘hrslice’
+
‘vuslice’
+
‘vdslice’
+
+

Default transition effect is fade. +

+
+
duration
+

Set cross fade duration in seconds. +Default duration is 1 second. +

+
+
offset
+

Set cross fade start relative to first input stream in seconds. +Default offset is 0. +

+
+
expr
+

Set expression for custom transition effect. +

+

The expressions can use the following variables and functions: +

+
+
X
+
Y
+

The coordinates of the current sample. +

+
+
W
+
H
+

The width and height of the image. +

+
+
P
+

Progress of transition effect. +

+
+
PLANE
+

Currently processed plane. +

+
+
A
+

Return value of first input at current location and plane. +

+
+
B
+

Return value of second input at current location and plane. +

+
+
a0(x, y)
+
a1(x, y)
+
a2(x, y)
+
a3(x, y)
+

Return the value of the pixel at location (x,y) of the +first/second/third/fourth component of first input. +

+
+
b0(x, y)
+
b1(x, y)
+
b2(x, y)
+
b3(x, y)
+

Return the value of the pixel at location (x,y) of the +first/second/third/fourth component of second input. +

+
+
+
+ + +

39.237.1 Examples

+ +
    +
  • Cross fade from one input video to another input video, with fade transition and duration of transition +of 2 seconds starting at offset of 5 seconds: +
    +
    ffmpeg -i first.mp4 -i second.mp4 -filter_complex xfade=transition=fade:duration=2:offset=5 output.mp4
+
    +
+ + +

39.238 xmedian

+

Pick median pixels from several input videos. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of inputs. +Default is 3. Allowed range is from 3 to 255. +If number of inputs is even number, than result will be mean value between two median values. +

+
+
planes
+

Set which planes to filter. Default value is 15, by which all planes are processed. +

+
+
percentile
+

Set median percentile. Default value is 0.5. +Default value of 0.5 will pick always median values, while 0 will pick +minimum values, and 1 maximum values. +

+
+ + +

39.239 xstack

+

Stack video inputs into custom layout. +

+

All streams must be of same pixel format. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of input streams. Default is 2. +

+
+
layout
+

Specify layout of inputs. +This option requires the desired layout configuration to be explicitly set by the user. +This sets position of each video input in output. Each input +is separated by ’|’. +The first number represents the column, and the second number represents the row. +Numbers start at 0 and are separated by ’_’. Optionally one can use wX and hX, +where X is video input from which to take width or height. +Multiple values can be used when separated by ’+’. In such +case values are summed together. +

+

Note that if inputs are of different sizes gaps may appear, as not all of +the output video frame will be filled. Similarly, videos can overlap each +other if their position doesn’t leave enough space for the full frame of +adjoining videos. +

+

For 2 inputs, a default layout of 0_0|w0_0 is set. In all other cases, +a layout must be set by the user. +

+
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+
fill
+

If set to valid color, all unused pixels will be filled with that color. +By default fill is set to none, so it is disabled. +

+
+ + +

39.239.1 Examples

+ +
    +
  • Display 4 inputs into 2x2 grid. + +

    Layout: +

    +
    input1(0, 0)  | input3(w0, 0)
+input2(0, h0) | input4(w0, h0)
+
    + +
    +
    xstack=inputs=4:layout=0_0|0_h0|w0_0|w0_h0
+
    + +

    Note that if inputs are of different sizes, gaps or overlaps may occur. +

    +
  • Display 4 inputs into 1x4 grid. + +

    Layout: +

    +
    input1(0, 0)
+input2(0, h0)
+input3(0, h0+h1)
+input4(0, h0+h1+h2)
+
    + +
    +
    xstack=inputs=4:layout=0_0|0_h0|0_h0+h1|0_h0+h1+h2
+
    + +

    Note that if inputs are of different widths, unused space will appear. +

    +
  • Display 9 inputs into 3x3 grid. + +

    Layout: +

    +
    input1(0, 0)       | input4(w0, 0)      | input7(w0+w3, 0)
+input2(0, h0)      | input5(w0, h0)     | input8(w0+w3, h0)
+input3(0, h0+h1)   | input6(w0, h0+h1)  | input9(w0+w3, h0+h1)
+
    + +
    +
    xstack=inputs=9:layout=0_0|0_h0|0_h0+h1|w0_0|w0_h0|w0_h0+h1|w0+w3_0|w0+w3_h0|w0+w3_h0+h1
+
    + +

    Note that if inputs are of different sizes, gaps or overlaps may occur. +

    +
  • Display 16 inputs into 4x4 grid. + +

    Layout: +

    +
    input1(0, 0)       | input5(w0, 0)       | input9 (w0+w4, 0)       | input13(w0+w4+w8, 0)
+input2(0, h0)      | input6(w0, h0)      | input10(w0+w4, h0)      | input14(w0+w4+w8, h0)
+input3(0, h0+h1)   | input7(w0, h0+h1)   | input11(w0+w4, h0+h1)   | input15(w0+w4+w8, h0+h1)
+input4(0, h0+h1+h2)| input8(w0, h0+h1+h2)| input12(w0+w4, h0+h1+h2)| input16(w0+w4+w8, h0+h1+h2)
+
    + +
    +
    xstack=inputs=16:layout=0_0|0_h0|0_h0+h1|0_h0+h1+h2|w0_0|w0_h0|w0_h0+h1|w0_h0+h1+h2|w0+w4_0|
+w0+w4_h0|w0+w4_h0+h1|w0+w4_h0+h1+h2|w0+w4+w8_0|w0+w4+w8_h0|w0+w4+w8_h0+h1|w0+w4+w8_h0+h1+h2
+
    + +

    Note that if inputs are of different sizes, gaps or overlaps may occur. +

    +
+ + +

39.240 yadif

+ +

Deinterlace the input video ("yadif" means "yet another deinterlacing +filter"). +

+

It accepts the following parameters: +

+ +
+
mode
+

The interlacing mode to adopt. It accepts one of the following values: +

+
+
0, send_frame
+

Output one frame for each frame. +

+
1, send_field
+

Output one frame for each field. +

+
2, send_frame_nospatial
+

Like send_frame, but it skips the spatial interlacing check. +

+
3, send_field_nospatial
+

Like send_field, but it skips the spatial interlacing check. +

+
+ +

The default value is send_frame. +

+
+
parity
+

The picture field parity assumed for the input interlaced video. It accepts one +of the following values: +

+
+
0, tff
+

Assume the top field is first. +

+
1, bff
+

Assume the bottom field is first. +

+
-1, auto
+

Enable automatic detection of field parity. +

+
+ +

The default value is auto. +If the interlacing is unknown or the decoder does not export this information, +top field first will be assumed. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following +values: +

+
+
0, all
+

Deinterlace all frames. +

+
1, interlaced
+

Only deinterlace frames marked as interlaced. +

+
+ +

The default value is all. +

+
+ + +

39.241 yadif_cuda

+ +

Deinterlace the input video using the yadif algorithm, but implemented +in CUDA so that it can work as part of a GPU accelerated pipeline with nvdec +and/or nvenc. +

+

It accepts the following parameters: +

+ +
+
mode
+

The interlacing mode to adopt. It accepts one of the following values: +

+
+
0, send_frame
+

Output one frame for each frame. +

+
1, send_field
+

Output one frame for each field. +

+
2, send_frame_nospatial
+

Like send_frame, but it skips the spatial interlacing check. +

+
3, send_field_nospatial
+

Like send_field, but it skips the spatial interlacing check. +

+
+ +

The default value is send_frame. +

+
+
parity
+

The picture field parity assumed for the input interlaced video. It accepts one +of the following values: +

+
+
0, tff
+

Assume the top field is first. +

+
1, bff
+

Assume the bottom field is first. +

+
-1, auto
+

Enable automatic detection of field parity. +

+
+ +

The default value is auto. +If the interlacing is unknown or the decoder does not export this information, +top field first will be assumed. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following +values: +

+
+
0, all
+

Deinterlace all frames. +

+
1, interlaced
+

Only deinterlace frames marked as interlaced. +

+
+ +

The default value is all. +

+
+ + +

39.242 yaepblur

+ +

Apply blur filter while preserving edges ("yaepblur" means "yet another edge preserving blur filter"). +The algorithm is described in +"J. S. Lee, Digital image enhancement and noise filtering by use of local statistics, IEEE Trans. Pattern Anal. Mach. Intell. PAMI-2, 1980." +

+

It accepts the following parameters: +

+
+
radius, r
+

Set the window radius. Default value is 3. +

+
+
planes, p
+

Set which planes to filter. Default is only the first plane. +

+
+
sigma, s
+

Set blur strength. Default value is 128. +

+
+ + +

39.242.1 Commands

+

This filter supports same commands as options. +

+ +

39.243 zoompan

+ +

Apply Zoom & Pan effect. +

+

This filter accepts the following options: +

+
+
zoom, z
+

Set the zoom expression. Range is 1-10. Default is 1. +

+
+
x
+
y
+

Set the x and y expression. Default is 0. +

+
+
d
+

Set the duration expression in number of frames. +This sets for how many number of frames effect will last for +single input image. +

+
+
s
+

Set the output image size, default is ’hd720’. +

+
+
fps
+

Set the output frame rate, default is ’25’. +

+
+ +

Each expression can contain the following constants: +

+
+
in_w, iw
+

Input width. +

+
+
in_h, ih
+

Input height. +

+
+
out_w, ow
+

Output width. +

+
+
out_h, oh
+

Output height. +

+
+
in
+

Input frame count. +

+
+
on
+

Output frame count. +

+
+
x
+
y
+

Last calculated ’x’ and ’y’ position from ’x’ and ’y’ expression +for current input frame. +

+
+
px
+
py
+

’x’ and ’y’ of last output frame of previous input frame or 0 when there was +not yet such frame (first input frame). +

+
+
zoom
+

Last calculated zoom from ’z’ expression for current input frame. +

+
+
pzoom
+

Last calculated zoom of last output frame of previous input frame. +

+
+
duration
+

Number of output frames for current input frame. Calculated from ’d’ expression +for each input frame. +

+
+
pduration
+

number of output frames created for previous input frame +

+
+
a
+

Rational number: input width / input height +

+
+
sar
+

sample aspect ratio +

+
+
dar
+

display aspect ratio +

+
+
+ + +

39.243.1 Examples

+ +
    +
  • Zoom-in up to 1.5 and pan at same time to some spot near center of picture: +
    +
    zoompan=z='min(zoom+0.0015,1.5)':d=700:x='if(gte(zoom,1.5),x,x+1/a)':y='if(gte(zoom,1.5),y,y+1)':s=640x360
+
    + +
  • Zoom-in up to 1.5 and pan always at center of picture: +
    +
    zoompan=z='min(zoom+0.0015,1.5)':d=700:x='iw/2-(iw/zoom/2)':y='ih/2-(ih/zoom/2)'
+
    + +
  • Same as above but without pausing: +
    +
    zoompan=z='min(max(zoom,pzoom)+0.0015,1.5)':d=1:x='iw/2-(iw/zoom/2)':y='ih/2-(ih/zoom/2)'
+
    +
+ + +

39.244 zscale

+

Scale (resize) the input video, using the z.lib library: +https://github.com/sekrit-twc/zimg. To enable compilation of this +filter, you need to configure FFmpeg with --enable-libzimg. +

+

The zscale filter forces the output display aspect ratio to be the same +as the input, by changing the output sample aspect ratio. +

+

If the input image format is different from the format requested by +the next filter, the zscale filter will convert the input to the +requested format. +

+ +

39.244.1 Options

+

The filter accepts the following options. +

+
+
width, w
+
height, h
+

Set the output video dimension expression. Default value is the input +dimension. +

+

If the width or w value is 0, the input width is used for +the output. If the height or h value is 0, the input height +is used for the output. +

+

If one and only one of the values is -n with n >= 1, the zscale filter +will use a value that maintains the aspect ratio of the input image, +calculated from the other specified dimension. After that it will, +however, make sure that the calculated dimension is divisible by n and +adjust the value if necessary. +

+

If both values are -n with n >= 1, the behavior will be identical to +both values being set to 0 as previously detailed. +

+

See below for the list of accepted constants for use in the dimension +expression. +

+
+
size, s
+

Set the video size. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
dither, d
+

Set the dither type. +

+

Possible values are: +

+
none
+
ordered
+
random
+
error_diffusion
+
+ +

Default is none. +

+
+
filter, f
+

Set the resize filter type. +

+

Possible values are: +

+
point
+
bilinear
+
bicubic
+
spline16
+
spline36
+
lanczos
+
+ +

Default is bilinear. +

+
+
range, r
+

Set the color range. +

+

Possible values are: +

+
input
+
limited
+
full
+
+ +

Default is same as input. +

+
+
primaries, p
+

Set the color primaries. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
170m
+
240m
+
2020
+
+ +

Default is same as input. +

+
+
transfer, t
+

Set the transfer characteristics. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
601
+
linear
+
2020_10
+
2020_12
+
smpte2084
+
iec61966-2-1
+
arib-std-b67
+
+ +

Default is same as input. +

+
+
matrix, m
+

Set the colorspace matrix. +

+

Possible value are: +

+
input
+
709
+
unspecified
+
470bg
+
170m
+
2020_ncl
+
2020_cl
+
+ +

Default is same as input. +

+
+
rangein, rin
+

Set the input color range. +

+

Possible values are: +

+
input
+
limited
+
full
+
+ +

Default is same as input. +

+
+
primariesin, pin
+

Set the input color primaries. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
170m
+
240m
+
2020
+
+ +

Default is same as input. +

+
+
transferin, tin
+

Set the input transfer characteristics. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
601
+
linear
+
2020_10
+
2020_12
+
+ +

Default is same as input. +

+
+
matrixin, min
+

Set the input colorspace matrix. +

+

Possible value are: +

+
input
+
709
+
unspecified
+
470bg
+
170m
+
2020_ncl
+
2020_cl
+
+ +
+
chromal, c
+

Set the output chroma location. +

+

Possible values are: +

+
input
+
left
+
center
+
topleft
+
top
+
bottomleft
+
bottom
+
+ +
+
chromalin, cin
+

Set the input chroma location. +

+

Possible values are: +

+
input
+
left
+
center
+
topleft
+
top
+
bottomleft
+
bottom
+
+ +
+
npl
+

Set the nominal peak luminance. +

+
+ +

The values of the w and h options are expressions +containing the following constants: +

+
+
in_w
+
in_h
+

The input width and height +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output (scaled) width and height +

+
+
ow
+
oh
+

These are the same as out_w and out_h +

+
+
a
+

The same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

The input display aspect ratio. Calculated from (iw / ih) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical input chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
ohsub
+
ovsub
+

horizontal and vertical output chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+ + +

39.244.2 Commands

+ +

This filter supports the following commands: +

+
width, w
+
height, h
+

Set the output video dimension expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + + +

40 OpenCL Video Filters

+ +

Below is a description of the currently available OpenCL video filters. +

+

To enable compilation of these filters you need to configure FFmpeg with +--enable-opencl. +

+

Running OpenCL filters requires you to initialize a hardware device and to pass that device to all filters in any filter graph. +

+
-init_hw_device opencl[=name][:device[,key=value...]]
+

Initialise a new hardware device of type opencl called name, using the +given device parameters. +

+
+
-filter_hw_device name
+

Pass the hardware device called name to all filters in any filter graph. +

+
+
+ +

For more detailed information see https://www.ffmpeg.org/ffmpeg.html#Advanced-Video-options +

+
    +
  • Example of choosing the first device on the second platform and running avgblur_opencl filter with default parameters on it. +
    +
    -init_hw_device opencl=gpu:1.0 -filter_hw_device gpu -i INPUT -vf "hwupload, avgblur_opencl, hwdownload" OUTPUT
+
    +
+ +

Since OpenCL filters are not able to access frame data in normal memory, all frame data needs to be uploaded(hwupload) to hardware surfaces connected to the appropriate device before being used and then downloaded(hwdownload) back to normal memory. Note that hwupload will upload to a surface with the same layout as the software frame, so it may be necessary to add a format filter immediately before to get the input into the right format and hwdownload does not support all formats on the output - it may be necessary to insert an additional format filter immediately following in the graph to get the output in a supported format. +

+ +

40.1 avgblur_opencl

+ +

Apply average blur filter. +

+

The filter accepts the following options: +

+
+
sizeX
+

Set horizontal radius size. +Range is [1, 1024] and default value is 1. +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
sizeY
+

Set vertical radius size. Range is [1, 1024] and default value is 0. If zero, sizeX value will be used. +

+
+ + +

40.1.1 Example

+ +
    +
  • Apply average blur filter with horizontal and vertical size of 3, setting each pixel of the output to the average value of the 7x7 region centered on it in the input. For pixels on the edges of the image, the region does not extend beyond the image boundaries, and so out-of-range coordinates are not used in the calculations. +
    +
    -i INPUT -vf "hwupload, avgblur_opencl=3, hwdownload" OUTPUT
+
    +
+ + +

40.2 boxblur_opencl

+ +

Apply a boxblur algorithm to the input video. +

+

It accepts the following parameters: +

+
+
luma_radius, lr
+
luma_power, lp
+
chroma_radius, cr
+
chroma_power, cp
+
alpha_radius, ar
+
alpha_power, ap
+
+ +

A description of the accepted options follows. +

+
+
luma_radius, lr
+
chroma_radius, cr
+
alpha_radius, ar
+

Set an expression for the box radius in pixels used for blurring the +corresponding input plane. +

+

The radius value must be a non-negative number, and must not be +greater than the value of the expression min(w,h)/2 for the +luma and alpha planes, and of min(cw,ch)/2 for the chroma +planes. +

+

Default value for luma_radius is "2". If not specified, +chroma_radius and alpha_radius default to the +corresponding value set for luma_radius. +

+

The expressions can contain the following constants: +

+
w
+
h
+

The input width and height in pixels. +

+
+
cw
+
ch
+

The input chroma image width and height in pixels. +

+
+
hsub
+
vsub
+

The horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p", hsub is 2 and vsub is 1. +

+
+ +
+
luma_power, lp
+
chroma_power, cp
+
alpha_power, ap
+

Specify how many times the boxblur filter is applied to the +corresponding plane. +

+

Default value for luma_power is 2. If not specified, +chroma_power and alpha_power default to the +corresponding value set for luma_power. +

+

A value of 0 will disable the effect. +

+
+ + +

40.2.1 Examples

+ +

Apply boxblur filter, setting each pixel of the output to the average value of box-radiuses luma_radius, chroma_radius, alpha_radius for each plane respectively. The filter will apply luma_power, chroma_power, alpha_power times onto the corresponding plane. For pixels on the edges of the image, the radius does not extend beyond the image boundaries, and so out-of-range coordinates are not used in the calculations. +

+
    +
  • Apply a boxblur filter with the luma, chroma, and alpha radius +set to 2 and luma, chroma, and alpha power set to 3. The filter will run 3 times with box-radius set to 2 for every plane of the image. +
    +
    -i INPUT -vf "hwupload, boxblur_opencl=luma_radius=2:luma_power=3, hwdownload" OUTPUT
+-i INPUT -vf "hwupload, boxblur_opencl=2:3, hwdownload" OUTPUT
+
    + +
  • Apply a boxblur filter with luma radius set to 2, luma_power to 1, chroma_radius to 4, chroma_power to 5, alpha_radius to 3 and alpha_power to 7. + +

    For the luma plane, a 2x2 box radius will be run once. +

    +

    For the chroma plane, a 4x4 box radius will be run 5 times. +

    +

    For the alpha plane, a 3x3 box radius will be run 7 times. +

    +
    -i INPUT -vf "hwupload, boxblur_opencl=2:1:4:5:3:7, hwdownload" OUTPUT
+
    +
+ + +

40.3 colorkey_opencl

+

RGB colorspace color keying. +

+

The filter accepts the following options: +

+
+
color
+

The color which will be replaced with transparency. +

+
+
similarity
+

Similarity percentage with the key color. +

+

0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +

+

0.0 makes pixels either fully transparent, or not transparent at all. +

+

Higher values result in semi-transparent pixels, with a higher transparency +the more similar the pixels color is to the key color. +

+
+ + +

40.3.1 Examples

+ +
    +
  • Make every semi-green pixel in the input transparent with some slight blending: +
    +
    -i INPUT -vf "hwupload, colorkey_opencl=green:0.3:0.1, hwdownload" OUTPUT
+
    +
+ + +

40.4 convolution_opencl

+ +

Apply convolution of 3x3, 5x5, 7x7 matrix. +

+

The filter accepts the following options: +

+
+
0m
+
1m
+
2m
+
3m
+

Set matrix for each plane. +Matrix is sequence of 9, 25 or 49 signed numbers. +Default value for each plane is 0 0 0 0 1 0 0 0 0. +

+
+
0rdiv
+
1rdiv
+
2rdiv
+
3rdiv
+

Set multiplier for calculated value for each plane. +If unset or 0, it will be sum of all matrix elements. +The option value must be a float number greater or equal to 0.0. Default value is 1.0. +

+
+
0bias
+
1bias
+
2bias
+
3bias
+

Set bias for each plane. This value is added to the result of the multiplication. +Useful for making the overall image brighter or darker. +The option value must be a float number greater or equal to 0.0. Default value is 0.0. +

+
+
+ + +

40.4.1 Examples

+ +
    +
  • Apply sharpen: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0, hwdownload" OUTPUT
+
    + +
  • Apply blur: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1/9:1/9:1/9:1/9, hwdownload" OUTPUT
+
    + +
  • Apply edge enhance: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:5:1:1:1:0:128:128:128, hwdownload" OUTPUT
+
    + +
  • Apply edge detect: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:5:5:5:1:0:128:128:128, hwdownload" OUTPUT
+
    + +
  • Apply laplacian edge detector which includes diagonals: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:5:5:5:1:0:128:128:0, hwdownload" OUTPUT
+
    + +
  • Apply emboss: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2, hwdownload" OUTPUT
+
    +
+ + +

40.5 erosion_opencl

+ +

Apply erosion effect to the video. +

+

This filter replaces the pixel by the local(3x3) minimum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane. Range is [0, 65535] and default value is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. +Range is [0, 255] and default value is 255, i.e. all eight pixels are used. +

+

Flags to local 3x3 coordinates region centered on x: +

+

1 2 3 +

+

4 x 5 +

+

6 7 8 +

+
+ + +

40.5.1 Example

+ +
    +
  • Apply erosion filter with threshold0 set to 30, threshold1 set 40, threshold2 set to 50 and coordinates set to 231, setting each pixel of the output to the local minimum between pixels: 1, 2, 3, 6, 7, 8 of the 3x3 region centered on it in the input. If the difference between input pixel and local minimum is more then threshold of the corresponding plane, output pixel will be set to input pixel - threshold of corresponding plane. +
    +
    -i INPUT -vf "hwupload, erosion_opencl=30:40:50:coordinates=231, hwdownload" OUTPUT
+
    +
+ + +

40.6 deshake_opencl

+

Feature-point based video stabilization filter. +

+

The filter accepts the following options: +

+
+
tripod
+

Simulates a tripod by preventing any camera movement whatsoever from the original frame. Defaults to 0. +

+
+
debug
+

Whether or not additional debug info should be displayed, both in the processed output and in the console. +

+

Note that in order to see console debug output you will also need to pass -v verbose to ffmpeg. +

+

Viewing point matches in the output video is only supported for RGB input. +

+

Defaults to 0. +

+
+
adaptive_crop
+

Whether or not to do a tiny bit of cropping at the borders to cut down on the amount of mirrored pixels. +

+

Defaults to 1. +

+
+
refine_features
+

Whether or not feature points should be refined at a sub-pixel level. +

+

This can be turned off for a slight performance gain at the cost of precision. +

+

Defaults to 1. +

+
+
smooth_strength
+

The strength of the smoothing applied to the camera path from 0.0 to 1.0. +

+

1.0 is the maximum smoothing strength while values less than that result in less smoothing. +

+

0.0 causes the filter to adaptively choose a smoothing strength on a per-frame basis. +

+

Defaults to 0.0. +

+
+
smooth_window_multiplier
+

Controls the size of the smoothing window (the number of frames buffered to determine motion information from). +

+

The size of the smoothing window is determined by multiplying the framerate of the video by this number. +

+

Acceptable values range from 0.1 to 10.0. +

+

Larger values increase the amount of motion data available for determining how to smooth the camera path, +potentially improving smoothness, but also increase latency and memory usage. +

+

Defaults to 2.0. +

+
+
+ + +

40.6.1 Examples

+ +
    +
  • Stabilize a video with a fixed, medium smoothing strength: +
    +
    -i INPUT -vf "hwupload, deshake_opencl=smooth_strength=0.5, hwdownload" OUTPUT
+
    + +
  • Stabilize a video with debugging (both in console and in rendered video): +
    +
    -i INPUT -filter_complex "[0:v]format=rgba, hwupload, deshake_opencl=debug=1, hwdownload, format=rgba, format=yuv420p" -v verbose OUTPUT
+
    +
+ + +

40.7 dilation_opencl

+ +

Apply dilation effect to the video. +

+

This filter replaces the pixel by the local(3x3) maximum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane. Range is [0, 65535] and default value is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. +Range is [0, 255] and default value is 255, i.e. all eight pixels are used. +

+

Flags to local 3x3 coordinates region centered on x: +

+

1 2 3 +

+

4 x 5 +

+

6 7 8 +

+
+ + +

40.7.1 Example

+ +
    +
  • Apply dilation filter with threshold0 set to 30, threshold1 set 40, threshold2 set to 50 and coordinates set to 231, setting each pixel of the output to the local maximum between pixels: 1, 2, 3, 6, 7, 8 of the 3x3 region centered on it in the input. If the difference between input pixel and local maximum is more then threshold of the corresponding plane, output pixel will be set to input pixel + threshold of corresponding plane. +
    +
    -i INPUT -vf "hwupload, dilation_opencl=30:40:50:coordinates=231, hwdownload" OUTPUT
+
    +
+ + +

40.8 nlmeans_opencl

+ +

Non-local Means denoise filter through OpenCL, this filter accepts same options as nlmeans. +

+ +

40.9 overlay_opencl

+ +

Overlay one video on top of another. +

+

It takes two inputs and has one output. The first input is the "main" video on which the second input is overlaid. +This filter requires same memory layout for all the inputs. So, format conversion may be needed. +

+

The filter accepts the following options: +

+
+
x
+

Set the x coordinate of the overlaid video on the main video. +Default value is 0. +

+
+
y
+

Set the y coordinate of the overlaid video on the main video. +Default value is 0. +

+
+
+ + +

40.9.1 Examples

+ +
    +
  • Overlay an image LOGO at the top-left corner of the INPUT video. Both inputs are yuv420p format. +
    +
    -i INPUT -i LOGO -filter_complex "[0:v]hwupload[a], [1:v]format=yuv420p, hwupload[b], [a][b]overlay_opencl, hwdownload" OUTPUT
+
    +
  • The inputs have same memory layout for color channels , the overlay has additional alpha plane, like INPUT is yuv420p, and the LOGO is yuva420p. +
    +
    -i INPUT -i LOGO -filter_complex "[0:v]hwupload[a], [1:v]format=yuva420p, hwupload[b], [a][b]overlay_opencl, hwdownload" OUTPUT
+
    + +
+ + +

40.10 pad_opencl

+ +

Add paddings to the input image, and place the original input at the +provided x, y coordinates. +

+

It accepts the following options: +

+
+
width, w
+
height, h
+

Specify an expression for the size of the output image with the +paddings added. If the value for width or height is 0, the +corresponding input size is used for the output. +

+

The width expression can reference the value set by the +height expression, and vice versa. +

+

The default value of width and height is 0. +

+
+
x
+
y
+

Specify the offsets to place the input image at within the padded area, +with respect to the top/left border of the output image. +

+

The x expression can reference the value set by the y +expression, and vice versa. +

+

The default value of x and y is 0. +

+

If x or y evaluate to a negative number, they’ll be changed +so the input image is centered on the padded area. +

+
+
color
+

Specify the color of the padded area. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. +

+
+
aspect
+

Pad to an aspect instead to a resolution. +

+
+ +

The value for the width, height, x, and y +options are expressions containing the following constants: +

+
+
in_w
+
in_h
+

The input video width and height. +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output width and height (the size of the padded area), as +specified by the width and height expressions. +

+
+
ow
+
oh
+

These are the same as out_w and out_h. +

+
+
x
+
y
+

The x and y offsets as specified by the x and y +expressions, or NAN if not yet specified. +

+
+
a
+

same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (iw / ih) * sar +

+
+ + +

40.11 prewitt_opencl

+ +

Apply the Prewitt operator (https://en.wikipedia.org/wiki/Prewitt_operator) to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +Range is [0.0, 65535] and default value is 1.0. +

+
+
delta
+

Set value which will be added to filtered result. +Range is [-65535, 65535] and default value is 0.0. +

+
+ + +

40.11.1 Example

+ +
    +
  • Apply the Prewitt operator with scale set to 2 and delta set to 10. +
    +
    -i INPUT -vf "hwupload, prewitt_opencl=scale=2:delta=10, hwdownload" OUTPUT
+
    +
+ + +

40.12 program_opencl

+ +

Filter video using an OpenCL program. +

+
+
source
+

OpenCL program source file. +

+
+
kernel
+

Kernel name in program. +

+
+
inputs
+

Number of inputs to the filter. Defaults to 1. +

+
+
size, s
+

Size of output frames. Defaults to the same as the first input. +

+
+
+ +

The program_opencl filter also supports the framesync options. +

+

The program source file must contain a kernel function with the given name, +which will be run once for each plane of the output. Each run on a plane +gets enqueued as a separate 2D global NDRange with one work-item for each +pixel to be generated. The global ID offset for each work-item is therefore +the coordinates of a pixel in the destination image. +

+

The kernel function needs to take the following arguments: +

    +
  • Destination image, __write_only image2d_t. + +

    This image will become the output; the kernel should write all of it. +

  • Frame index, unsigned int. + +

    This is a counter starting from zero and increasing by one for each frame. +

  • Source images, __read_only image2d_t. + +

    These are the most recent images on each input. The kernel may read from +them to generate the output, but they can’t be written to. +

+ +

Example programs: +

+
    +
  • Copy the input to the output (output must be the same size as the input). +
    __kernel void copy(__write_only image2d_t destination,
+                   unsigned int index,
+                   __read_only  image2d_t source)
+{
+    const sampler_t sampler = CLK_NORMALIZED_COORDS_FALSE;
+
+    int2 location = (int2)(get_global_id(0), get_global_id(1));
+
+    float4 value = read_imagef(source, sampler, location);
+
+    write_imagef(destination, location, value);
+}
+
    +
  • Apply a simple transformation, rotating the input by an amount increasing +with the index counter. Pixel values are linearly interpolated by the +sampler, and the output need not have the same dimensions as the input. +
    __kernel void rotate_image(__write_only image2d_t dst,
+                           unsigned int index,
+                           __read_only  image2d_t src)
+{
+    const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE |
+                               CLK_FILTER_LINEAR);
+
+    float angle = (float)index / 100.0f;
+
+    float2 dst_dim = convert_float2(get_image_dim(dst));
+    float2 src_dim = convert_float2(get_image_dim(src));
+
+    float2 dst_cen = dst_dim / 2.0f;
+    float2 src_cen = src_dim / 2.0f;
+
+    int2   dst_loc = (int2)(get_global_id(0), get_global_id(1));
+
+    float2 dst_pos = convert_float2(dst_loc) - dst_cen;
+    float2 src_pos = {
+        cos(angle) * dst_pos.x - sin(angle) * dst_pos.y,
+        sin(angle) * dst_pos.x + cos(angle) * dst_pos.y
+    };
+    src_pos = src_pos * src_dim / dst_dim;
+
+    float2 src_loc = src_pos + src_cen;
+
+    if (src_loc.x < 0.0f      || src_loc.y < 0.0f ||
+        src_loc.x > src_dim.x || src_loc.y > src_dim.y)
+        write_imagef(dst, dst_loc, 0.5f);
+    else
+        write_imagef(dst, dst_loc, read_imagef(src, sampler, src_loc));
+}
+
    +
  • Blend two inputs together, with the amount of each input used varying +with the index counter. +
    __kernel void blend_images(__write_only image2d_t dst,
+                           unsigned int index,
+                           __read_only  image2d_t src1,
+                           __read_only  image2d_t src2)
+{
+    const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE |
+                               CLK_FILTER_LINEAR);
+
+    float blend = (cos((float)index / 50.0f) + 1.0f) / 2.0f;
+
+    int2  dst_loc = (int2)(get_global_id(0), get_global_id(1));
+    int2 src1_loc = dst_loc * get_image_dim(src1) / get_image_dim(dst);
+    int2 src2_loc = dst_loc * get_image_dim(src2) / get_image_dim(dst);
+
+    float4 val1 = read_imagef(src1, sampler, src1_loc);
+    float4 val2 = read_imagef(src2, sampler, src2_loc);
+
+    write_imagef(dst, dst_loc, val1 * blend + val2 * (1.0f - blend));
+}
+
    +
+ + +

40.13 roberts_opencl

+

Apply the Roberts cross operator (https://en.wikipedia.org/wiki/Roberts_cross) to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +Range is [0.0, 65535] and default value is 1.0. +

+
+
delta
+

Set value which will be added to filtered result. +Range is [-65535, 65535] and default value is 0.0. +

+
+ + +

40.13.1 Example

+ +
    +
  • Apply the Roberts cross operator with scale set to 2 and delta set to 10 +
    +
    -i INPUT -vf "hwupload, roberts_opencl=scale=2:delta=10, hwdownload" OUTPUT
+
    +
+ + +

40.14 sobel_opencl

+ +

Apply the Sobel operator (https://en.wikipedia.org/wiki/Sobel_operator) to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +Range is [0.0, 65535] and default value is 1.0. +

+
+
delta
+

Set value which will be added to filtered result. +Range is [-65535, 65535] and default value is 0.0. +

+
+ + +

40.14.1 Example

+ +
    +
  • Apply sobel operator with scale set to 2 and delta set to 10 +
    +
    -i INPUT -vf "hwupload, sobel_opencl=scale=2:delta=10, hwdownload" OUTPUT
+
    +
+ + +

40.15 tonemap_opencl

+ +

Perform HDR(PQ/HLG) to SDR conversion with tone-mapping. +

+

It accepts the following parameters: +

+
+
tonemap
+

Specify the tone-mapping operator to be used. Same as tonemap option in tonemap. +

+
+
param
+

Tune the tone mapping algorithm. same as param option in tonemap. +

+
+
desat
+

Apply desaturation for highlights that exceed this level of brightness. The +higher the parameter, the more color information will be preserved. This +setting helps prevent unnaturally blown-out colors for super-highlights, by +(smoothly) turning into white instead. This makes images feel more natural, +at the cost of reducing information about out-of-range colors. +

+

The default value is 0.5, and the algorithm here is a little different from +the cpu version tonemap currently. A setting of 0.0 disables this option. +

+
+
threshold
+

The tonemapping algorithm parameters is fine-tuned per each scene. And a threshold +is used to detect whether the scene has changed or not. If the distance between +the current frame average brightness and the current running average exceeds +a threshold value, we would re-calculate scene average and peak brightness. +The default value is 0.2. +

+
+
format
+

Specify the output pixel format. +

+

Currently supported formats are: +

+
p010
+
nv12
+
+ +
+
range, r
+

Set the output color range. +

+

Possible values are: +

+
tv/mpeg
+
pc/jpeg
+
+ +

Default is same as input. +

+
+
primaries, p
+

Set the output color primaries. +

+

Possible values are: +

+
bt709
+
bt2020
+
+ +

Default is same as input. +

+
+
transfer, t
+

Set the output transfer characteristics. +

+

Possible values are: +

+
bt709
+
bt2020
+
+ +

Default is bt709. +

+
+
matrix, m
+

Set the output colorspace matrix. +

+

Possible value are: +

+
bt709
+
bt2020
+
+ +

Default is same as input. +

+
+
+ + +

40.15.1 Example

+ +
    +
  • Convert HDR(PQ/HLG) video to bt2020-transfer-characteristic p010 format using linear operator. +
    +
    -i INPUT -vf "format=p010,hwupload,tonemap_opencl=t=bt2020:tonemap=linear:format=p010,hwdownload,format=p010" OUTPUT
+
    +
+ + +

40.16 unsharp_opencl

+ +

Sharpen or blur the input video. +

+

It accepts the following parameters: +

+
+
luma_msize_x, lx
+

Set the luma matrix horizontal size. +Range is [1, 23] and default value is 5. +

+
+
luma_msize_y, ly
+

Set the luma matrix vertical size. +Range is [1, 23] and default value is 5. +

+
+
luma_amount, la
+

Set the luma effect strength. +Range is [-10, 10] and default value is 1.0. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+
+
chroma_msize_x, cx
+

Set the chroma matrix horizontal size. +Range is [1, 23] and default value is 5. +

+
+
chroma_msize_y, cy
+

Set the chroma matrix vertical size. +Range is [1, 23] and default value is 5. +

+
+
chroma_amount, ca
+

Set the chroma effect strength. +Range is [-10, 10] and default value is 0.0. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+
+
+ +

All parameters are optional and default to the equivalent of the +string ’5:5:1.0:5:5:0.0’. +

+ +

40.16.1 Examples

+ +
    +
  • Apply strong luma sharpen effect: +
    +
    -i INPUT -vf "hwupload, unsharp_opencl=luma_msize_x=7:luma_msize_y=7:luma_amount=2.5, hwdownload" OUTPUT
+
    + +
  • Apply a strong blur of both luma and chroma parameters: +
    +
    -i INPUT -vf "hwupload, unsharp_opencl=7:7:-2:7:7:-2, hwdownload" OUTPUT
+
    +
+ + +

40.17 xfade_opencl

+ +

Cross fade two videos with custom transition effect by using OpenCL. +

+

It accepts the following options: +

+
+
transition
+

Set one of possible transition effects. +

+
+
custom
+

Select custom transition effect, the actual transition description +will be picked from source and kernel options. +

+
+
fade
+
wipeleft
+
wiperight
+
wipeup
+
wipedown
+
slideleft
+
slideright
+
slideup
+
slidedown
+
+

Default transition is fade. +

+
+ +
+
source
+

OpenCL program source file for custom transition. +

+
+
kernel
+

Set name of kernel to use for custom transition from program source file. +

+
+
duration
+

Set duration of video transition. +

+
+
offset
+

Set time of start of transition relative to first video. +

+
+ +

The program source file must contain a kernel function with the given name, +which will be run once for each plane of the output. Each run on a plane +gets enqueued as a separate 2D global NDRange with one work-item for each +pixel to be generated. The global ID offset for each work-item is therefore +the coordinates of a pixel in the destination image. +

+

The kernel function needs to take the following arguments: +

    +
  • Destination image, __write_only image2d_t. + +

    This image will become the output; the kernel should write all of it. +

    +
  • First Source image, __read_only image2d_t. +Second Source image, __read_only image2d_t. + +

    These are the most recent images on each input. The kernel may read from +them to generate the output, but they can’t be written to. +

    +
  • Transition progress, float. This value is always between 0 and 1 inclusive. +
+ +

Example programs: +

+
    +
  • Apply dots curtain transition effect: +
    __kernel void blend_images(__write_only image2d_t dst,
+                           __read_only  image2d_t src1,
+                           __read_only  image2d_t src2,
+                           float progress)
+{
+    const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE |
+                               CLK_FILTER_LINEAR);
+    int2  p = (int2)(get_global_id(0), get_global_id(1));
+    float2 rp = (float2)(get_global_id(0), get_global_id(1));
+    float2 dim = (float2)(get_image_dim(src1).x, get_image_dim(src1).y);
+    rp = rp / dim;
+
+    float2 dots = (float2)(20.0, 20.0);
+    float2 center = (float2)(0,0);
+    float2 unused;
+
+    float4 val1 = read_imagef(src1, sampler, p);
+    float4 val2 = read_imagef(src2, sampler, p);
+    bool next = distance(fract(rp * dots, &unused), (float2)(0.5, 0.5)) < (progress / distance(rp, center));
+
+    write_imagef(dst, p, next ? val1 : val2);
+}
+
    +
+ + + +

41 VAAPI Video Filters

+ +

VAAPI Video filters are usually used with VAAPI decoder and VAAPI encoder. Below is a description of VAAPI video filters. +

+

To enable compilation of these filters you need to configure FFmpeg with +--enable-vaapi. +

+

To use vaapi filters, you need to setup the vaapi device correctly. For more information, please read https://trac.ffmpeg.org/wiki/Hardware/VAAPI +

+ +

41.1 tonemap_vaapi

+ +

Perform HDR(High Dynamic Range) to SDR(Standard Dynamic Range) conversion with tone-mapping. +It maps the dynamic range of HDR10 content to the SDR content. +It currently only accepts HDR10 as input. +

+

It accepts the following parameters: +

+
+
format
+

Specify the output pixel format. +

+

Currently supported formats are: +

+
p010
+
nv12
+
+ +

Default is nv12. +

+
+
primaries, p
+

Set the output color primaries. +

+

Default is same as input. +

+
+
transfer, t
+

Set the output transfer characteristics. +

+

Default is bt709. +

+
+
matrix, m
+

Set the output colorspace matrix. +

+

Default is same as input. +

+
+
+ + +

41.1.1 Example

+ +
    +
  • Convert HDR(HDR10) video to bt2020-transfer-characteristic p010 format +
    +
    tonemap_vaapi=format=p010:t=bt2020-10
+
    +
+ + + +

42 Video Sources

+ +

Below is a description of the currently available video sources. +

+ +

42.1 buffer

+ +

Buffer video frames, and make them available to the filter chain. +

+

This source is mainly intended for a programmatic use, in particular +through the interface defined in libavfilter/vsrc_buffer.h. +

+

It accepts the following parameters: +

+
+
video_size
+

Specify the size (width and height) of the buffered video frames. For the +syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
width
+

The input video width. +

+
+
height
+

The input video height. +

+
+
pix_fmt
+

A string representing the pixel format of the buffered video frames. +It may be a number corresponding to a pixel format, or a pixel format +name. +

+
+
time_base
+

Specify the timebase assumed by the timestamps of the buffered frames. +

+
+
frame_rate
+

Specify the frame rate expected for the video stream. +

+
+
pixel_aspect, sar
+

The sample (pixel) aspect ratio of the input video. +

+
+
sws_param
+

This option is deprecated and ignored. Prepend sws_flags=flags; +to the filtergraph description to specify swscale flags for automatically +inserted scalers. See Filtergraph syntax. +

+
+
hw_frames_ctx
+

When using a hardware pixel format, this should be a reference to an +AVHWFramesContext describing input frames. +

+
+ +

For example: +

+
buffer=width=320:height=240:pix_fmt=yuv410p:time_base=1/24:sar=1
+
+ +

will instruct the source to accept video frames with size 320x240 and +with format "yuv410p", assuming 1/24 as the timestamps timebase and +square pixels (1:1 sample aspect ratio). +Since the pixel format with name "yuv410p" corresponds to the number 6 +(check the enum AVPixelFormat definition in libavutil/pixfmt.h), +this example corresponds to: +

+
buffer=size=320x240:pixfmt=6:time_base=1/24:pixel_aspect=1/1
+
+ +

Alternatively, the options can be specified as a flat string, but this +syntax is deprecated: +

+

width:height:pix_fmt:time_base.num:time_base.den:pixel_aspect.num:pixel_aspect.den +

+ +

42.2 cellauto

+ +

Create a pattern generated by an elementary cellular automaton. +

+

The initial state of the cellular automaton can be defined through the +filename and pattern options. If such options are +not specified an initial state is created randomly. +

+

At each new frame a new row in the video is filled with the result of +the cellular automaton next generation. The behavior when the whole +frame is filled is defined by the scroll option. +

+

This source accepts the following options: +

+
+
filename, f
+

Read the initial cellular automaton state, i.e. the starting row, from +the specified file. +In the file, each non-whitespace character is considered an alive +cell, a newline will terminate the row, and further characters in the +file will be ignored. +

+
+
pattern, p
+

Read the initial cellular automaton state, i.e. the starting row, from +the specified string. +

+

Each non-whitespace character in the string is considered an alive +cell, a newline will terminate the row, and further characters in the +string will be ignored. +

+
+
rate, r
+

Set the video rate, that is the number of frames generated per second. +Default is 25. +

+
+
random_fill_ratio, ratio
+

Set the random fill ratio for the initial cellular automaton row. It +is a floating point number value ranging from 0 to 1, defaults to +1/PHI. +

+

This option is ignored when a file or a pattern is specified. +

+
+
random_seed, seed
+

Set the seed for filling randomly the initial row, must be an integer +included between 0 and UINT32_MAX. If not specified, or if explicitly +set to -1, the filter will try to use a good random seed on a best +effort basis. +

+
+
rule
+

Set the cellular automaton rule, it is a number ranging from 0 to 255. +Default value is 110. +

+
+
size, s
+

Set the size of the output video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+

If filename or pattern is specified, the size is set +by default to the width of the specified initial state row, and the +height is set to width * PHI. +

+

If size is set, it must contain the width of the specified +pattern string, and the specified pattern will be centered in the +larger row. +

+

If a filename or a pattern string is not specified, the size value +defaults to "320x518" (used for a randomly generated initial state). +

+
+
scroll
+

If set to 1, scroll the output upward when all the rows in the output +have been already filled. If set to 0, the new generated row will be +written over the top row just after the bottom row is filled. +Defaults to 1. +

+
+
start_full, full
+

If set to 1, completely fill the output with generated rows before +outputting the first frame. +This is the default behavior, for disabling set the value to 0. +

+
+
stitch
+

If set to 1, stitch the left and right row edges together. +This is the default behavior, for disabling set the value to 0. +

+
+ + +

42.2.1 Examples

+ +
    +
  • Read the initial state from pattern, and specify an output of +size 200x400. +
    +
    cellauto=f=pattern:s=200x400
+
    + +
  • Generate a random initial row with a width of 200 cells, with a fill +ratio of 2/3: +
    +
    cellauto=ratio=2/3:s=200x200
+
    + +
  • Create a pattern generated by rule 18 starting by a single alive cell +centered on an initial row with width 100: +
    +
    cellauto=p=@:s=100x400:full=0:rule=18
+
    + +
  • Specify a more elaborated initial pattern: +
    +
    cellauto=p='@@ @ @@':s=100x400:full=0:rule=18
+
    + +
+ + +

42.3 coreimagesrc

+

Video source generated on GPU using Apple’s CoreImage API on OSX. +

+

This video source is a specialized version of the coreimage video filter. +Use a core image generator at the beginning of the applied filterchain to +generate the content. +

+

The coreimagesrc video source accepts the following options: +

+
list_generators
+

List all available generators along with all their respective options as well as +possible minimum and maximum values along with the default values. +

+
list_generators=true
+
+ +
+
size, s
+

Specify the size of the sourced video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +The default value is 320x240. +

+
+
rate, r
+

Specify the frame rate of the sourced video, as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a floating point +number or a valid video frame rate abbreviation. The default value is +"25". +

+
+
sar
+

Set the sample aspect ratio of the sourced video. +

+
+
duration, d
+

Set the duration of the sourced video. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

If not specified, or the expressed duration is negative, the video is +supposed to be generated forever. +

+
+ +

Additionally, all options of the coreimage video filter are accepted. +A complete filterchain can be used for further processing of the +generated input without CPU-HOST transfer. See coreimage documentation +and examples for details. +

+ +

42.3.1 Examples

+ +
    +
  • Use CIQRCodeGenerator to create a QR code for the FFmpeg homepage, +given as complete and escaped command-line for Apple’s standard bash shell: +
    +
    ffmpeg -f lavfi -i coreimagesrc=s=100x100:filter=CIQRCodeGenerator@inputMessage=https\\\\\://FFmpeg.org/@inputCorrectionLevel=H -frames:v 1 QRCode.png
+
    +

    This example is equivalent to the QRCode example of coreimage without the +need for a nullsrc video source. +

+ + + +

42.4 gradients

+

Generate several gradients. +

+
+
size, s
+

Set frame size. For the syntax of this option, check the (ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual. Default value is "640x480". +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
c0, c1, c2, c3, c4, c5, c6, c7
+

Set 8 colors. Default values for colors is to pick random one. +

+
+
x0, y0, y0, y1
+

Set gradient line source and destination points. If negative or out of range, random ones +are picked. +

+
+
nb_colors, n
+

Set number of colors to use at once. Allowed range is from 2 to 8. Default value is 2. +

+
+
seed
+

Set seed for picking gradient line points. +

+
+ + + +

42.5 mandelbrot

+ +

Generate a Mandelbrot set fractal, and progressively zoom towards the +point specified with start_x and start_y. +

+

This source accepts the following options: +

+
+
end_pts
+

Set the terminal pts value. Default value is 400. +

+
+
end_scale
+

Set the terminal scale value. +Must be a floating point value. Default value is 0.3. +

+
+
inner
+

Set the inner coloring mode, that is the algorithm used to draw the +Mandelbrot fractal internal region. +

+

It shall assume one of the following values: +

+
black
+

Set black mode. +

+
convergence
+

Show time until convergence. +

+
mincol
+

Set color based on point closest to the origin of the iterations. +

+
period
+

Set period mode. +

+
+ +

Default value is mincol. +

+
+
bailout
+

Set the bailout value. Default value is 10.0. +

+
+
maxiter
+

Set the maximum of iterations performed by the rendering +algorithm. Default value is 7189. +

+
+
outer
+

Set outer coloring mode. +It shall assume one of following values: +

+
iteration_count
+

Set iteration count mode. +

+
normalized_iteration_count
+

set normalized iteration count mode. +

+
+

Default value is normalized_iteration_count. +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
size, s
+

Set frame size. For the syntax of this option, check the (ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual. Default value is "640x480". +

+
+
start_scale
+

Set the initial scale value. Default value is 3.0. +

+
+
start_x
+

Set the initial x position. Must be a floating point value between +-100 and 100. Default value is -0.743643887037158704752191506114774. +

+
+
start_y
+

Set the initial y position. Must be a floating point value between +-100 and 100. Default value is -0.131825904205311970493132056385139. +

+
+ + +

42.6 mptestsrc

+ +

Generate various test patterns, as generated by the MPlayer test filter. +

+

The size of the generated video is fixed, and is 256x256. +This source is useful in particular for testing encoding features. +

+

This source accepts the following options: +

+
+
rate, r
+

Specify the frame rate of the sourced video, as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a floating point +number or a valid video frame rate abbreviation. The default value is +"25". +

+
+
duration, d
+

Set the duration of the sourced video. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

If not specified, or the expressed duration is negative, the video is +supposed to be generated forever. +

+
+
test, t
+
+

Set the number or the name of the test to perform. Supported tests are: +

+
dc_luma
+
dc_chroma
+
freq_luma
+
freq_chroma
+
amp_luma
+
amp_chroma
+
cbp
+
mv
+
ring1
+
ring2
+
all
+
max_frames, m
+

Set the maximum number of frames generated for each test, default value is 30. +

+
+
+ +

Default value is "all", which will cycle through the list of all tests. +

+
+ +

Some examples: +

+
mptestsrc=t=dc_luma
+
+ +

will generate a "dc_luma" test pattern. +

+ +

42.7 frei0r_src

+ +

Provide a frei0r source. +

+

To enable compilation of this filter you need to install the frei0r +header and configure FFmpeg with --enable-frei0r. +

+

This source accepts the following parameters: +

+
+
size
+

The size of the video to generate. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
framerate
+

The framerate of the generated video. It may be a string of the form +num/den or a frame rate abbreviation. +

+
+
filter_name
+

The name to the frei0r source to load. For more information regarding frei0r and +how to set the parameters, read the frei0r section in the video filters +documentation. +

+
+
filter_params
+

A ’|’-separated list of parameters to pass to the frei0r source. +

+
+
+ +

For example, to generate a frei0r partik0l source with size 200x200 +and frame rate 10 which is overlaid on the overlay filter main input: +

+
frei0r_src=size=200x200:framerate=10:filter_name=partik0l:filter_params=1234 [overlay]; [in][overlay] overlay
+
+ + +

42.8 life

+ +

Generate a life pattern. +

+

This source is based on a generalization of John Conway’s life game. +

+

The sourced input represents a life grid, each pixel represents a cell +which can be in one of two possible states, alive or dead. Every cell +interacts with its eight neighbours, which are the cells that are +horizontally, vertically, or diagonally adjacent. +

+

At each interaction the grid evolves according to the adopted rule, +which specifies the number of neighbor alive cells which will make a +cell stay alive or born. The rule option allows one to specify +the rule to adopt. +

+

This source accepts the following options: +

+
+
filename, f
+

Set the file from which to read the initial grid state. In the file, +each non-whitespace character is considered an alive cell, and newline +is used to delimit the end of each row. +

+

If this option is not specified, the initial grid is generated +randomly. +

+
+
rate, r
+

Set the video rate, that is the number of frames generated per second. +Default is 25. +

+
+
random_fill_ratio, ratio
+

Set the random fill ratio for the initial random grid. It is a +floating point number value ranging from 0 to 1, defaults to 1/PHI. +It is ignored when a file is specified. +

+
+
random_seed, seed
+

Set the seed for filling the initial random grid, must be an integer +included between 0 and UINT32_MAX. If not specified, or if explicitly +set to -1, the filter will try to use a good random seed on a best +effort basis. +

+
+
rule
+

Set the life rule. +

+

A rule can be specified with a code of the kind "SNS/BNB", +where NS and NB are sequences of numbers in the range 0-8, +NS specifies the number of alive neighbor cells which make a +live cell stay alive, and NB the number of alive neighbor cells +which make a dead cell to become alive (i.e. to "born"). +"s" and "b" can be used in place of "S" and "B", respectively. +

+

Alternatively a rule can be specified by an 18-bits integer. The 9 +high order bits are used to encode the next cell state if it is alive +for each number of neighbor alive cells, the low order bits specify +the rule for "borning" new cells. Higher order bits encode for an +higher number of neighbor cells. +For example the number 6153 = (12<<9)+9 specifies a stay alive +rule of 12 and a born rule of 9, which corresponds to "S23/B03". +

+

Default value is "S23/B3", which is the original Conway’s game of life +rule, and will keep a cell alive if it has 2 or 3 neighbor alive +cells, and will born a new cell if there are three alive cells around +a dead cell. +

+
+
size, s
+

Set the size of the output video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+

If filename is specified, the size is set by default to the +same size of the input file. If size is set, it must contain +the size specified in the input file, and the initial grid defined in +that file is centered in the larger resulting area. +

+

If a filename is not specified, the size value defaults to "320x240" +(used for a randomly generated initial grid). +

+
+
stitch
+

If set to 1, stitch the left and right grid edges together, and the +top and bottom edges also. Defaults to 1. +

+
+
mold
+

Set cell mold speed. If set, a dead cell will go from death_color to +mold_color with a step of mold. mold can have a +value from 0 to 255. +

+
+
life_color
+

Set the color of living (or new born) cells. +

+
+
death_color
+

Set the color of dead cells. If mold is set, this is the first color +used to represent a dead cell. +

+
+
mold_color
+

Set mold color, for definitely dead and moldy cells. +

+

For the syntax of these 3 color options, check the (ffmpeg-utils)"Color" section in the +ffmpeg-utils manual. +

+
+ + +

42.8.1 Examples

+ +
    +
  • Read a grid from pattern, and center it on a grid of size +300x300 pixels: +
    +
    life=f=pattern:s=300x300
+
    + +
  • Generate a random grid of size 200x200, with a fill ratio of 2/3: +
    +
    life=ratio=2/3:s=200x200
+
    + +
  • Specify a custom rule for evolving a randomly generated grid: +
    +
    life=rule=S14/B34
+
    + +
  • Full example with slow death effect (mold) using ffplay: +
    +
    ffplay -f lavfi life=s=300x200:mold=10:r=60:ratio=0.1:death_color=#C83232:life_color=#00ff00,scale=1200:800:flags=16
+
    +
+ + +

42.9 allrgb, allyuv, color, haldclutsrc, nullsrc, pal75bars, pal100bars, rgbtestsrc, smptebars, smptehdbars, testsrc, testsrc2, yuvtestsrc

+ +

The allrgb source returns frames of size 4096x4096 of all rgb colors. +

+

The allyuv source returns frames of size 4096x4096 of all yuv colors. +

+

The color source provides an uniformly colored input. +

+

The haldclutsrc source provides an identity Hald CLUT. See also +haldclut filter. +

+

The nullsrc source returns unprocessed video frames. It is +mainly useful to be employed in analysis / debugging tools, or as the +source for filters which ignore the input data. +

+

The pal75bars source generates a color bars pattern, based on +EBU PAL recommendations with 75% color levels. +

+

The pal100bars source generates a color bars pattern, based on +EBU PAL recommendations with 100% color levels. +

+

The rgbtestsrc source generates an RGB test pattern useful for +detecting RGB vs BGR issues. You should see a red, green and blue +stripe from top to bottom. +

+

The smptebars source generates a color bars pattern, based on +the SMPTE Engineering Guideline EG 1-1990. +

+

The smptehdbars source generates a color bars pattern, based on +the SMPTE RP 219-2002. +

+

The testsrc source generates a test video pattern, showing a +color pattern, a scrolling gradient and a timestamp. This is mainly +intended for testing purposes. +

+

The testsrc2 source is similar to testsrc, but supports more +pixel formats instead of just rgb24. This allows using it as an +input for other tests without requiring a format conversion. +

+

The yuvtestsrc source generates an YUV test pattern. You should +see a y, cb and cr stripe from top to bottom. +

+

The sources accept the following parameters: +

+
+
level
+

Specify the level of the Hald CLUT, only available in the haldclutsrc +source. A level of N generates a picture of N*N*N by N*N*N +pixels to be used as identity matrix for 3D lookup tables. Each component is +coded on a 1/(N*N) scale. +

+
+
color, c
+

Specify the color of the source, only available in the color +source. For the syntax of this option, check the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+
+
size, s
+

Specify the size of the sourced video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +The default value is 320x240. +

+

This option is not available with the allrgb, allyuv, and +haldclutsrc filters. +

+
+
rate, r
+

Specify the frame rate of the sourced video, as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a floating point +number or a valid video frame rate abbreviation. The default value is +"25". +

+
+
duration, d
+

Set the duration of the sourced video. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

If not specified, or the expressed duration is negative, the video is +supposed to be generated forever. +

+
+
sar
+

Set the sample aspect ratio of the sourced video. +

+
+
alpha
+

Specify the alpha (opacity) of the background, only available in the +testsrc2 source. The value must be between 0 (fully transparent) and +255 (fully opaque, the default). +

+
+
decimals, n
+

Set the number of decimals to show in the timestamp, only available in the +testsrc source. +

+

The displayed timestamp value will correspond to the original +timestamp value multiplied by the power of 10 of the specified +value. Default value is 0. +

+
+ + +

42.9.1 Examples

+ +
    +
  • Generate a video with a duration of 5.3 seconds, with size +176x144 and a frame rate of 10 frames per second: +
    +
    testsrc=duration=5.3:size=qcif:rate=10
+
    + +
  • The following graph description will generate a red source +with an opacity of 0.2, with size "qcif" and a frame rate of 10 +frames per second: +
    +
    color=c=red@0.2:s=qcif:r=10
+
    + +
  • If the input content is to be ignored, nullsrc can be used. The +following command generates noise in the luminance plane by employing +the geq filter: +
    +
    nullsrc=s=256x256, geq=random(1)*255:128:128
+
    +
+ + +

42.9.2 Commands

+ +

The color source supports the following commands: +

+
+
c, color
+

Set the color of the created image. Accepts the same syntax of the +corresponding color option. +

+
+ + +

42.10 openclsrc

+ +

Generate video using an OpenCL program. +

+
+
source
+

OpenCL program source file. +

+
+
kernel
+

Kernel name in program. +

+
+
size, s
+

Size of frames to generate. This must be set. +

+
+
format
+

Pixel format to use for the generated frames. This must be set. +

+
+
rate, r
+

Number of frames generated every second. Default value is ’25’. +

+
+
+ +

For details of how the program loading works, see the program_opencl +filter. +

+

Example programs: +

+
    +
  • Generate a colour ramp by setting pixel values from the position of the pixel +in the output image. (Note that this will work with all pixel formats, but +the generated output will not be the same.) +
    __kernel void ramp(__write_only image2d_t dst,
+                   unsigned int index)
+{
+    int2 loc = (int2)(get_global_id(0), get_global_id(1));
+
+    float4 val;
+    val.xy = val.zw = convert_float2(loc) / convert_float2(get_image_dim(dst));
+
+    write_imagef(dst, loc, val);
+}
+
    +
  • Generate a Sierpinski carpet pattern, panning by a single pixel each frame. +
    __kernel void sierpinski_carpet(__write_only image2d_t dst,
+                                unsigned int index)
+{
+    int2 loc = (int2)(get_global_id(0), get_global_id(1));
+
+    float4 value = 0.0f;
+    int x = loc.x + index;
+    int y = loc.y + index;
+    while (x > 0 || y > 0) {
+        if (x % 3 == 1 && y % 3 == 1) {
+            value = 1.0f;
+            break;
+        }
+        x /= 3;
+        y /= 3;
+    }
+
+    write_imagef(dst, loc, value);
+}
+
    +
+ + +

42.11 sierpinski

+ +

Generate a Sierpinski carpet/triangle fractal, and randomly pan around. +

+

This source accepts the following options: +

+
+
size, s
+

Set frame size. For the syntax of this option, check the (ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual. Default value is "640x480". +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
seed
+

Set seed which is used for random panning. +

+
+
jump
+

Set max jump for single pan destination. Allowed range is from 1 to 10000. +

+
+
type
+

Set fractal type, can be default carpet or triangle. +

+
+ + + +

43 Video Sinks

+ +

Below is a description of the currently available video sinks. +

+ +

43.1 buffersink

+ +

Buffer video frames, and make them available to the end of the filter +graph. +

+

This sink is mainly intended for programmatic use, in particular +through the interface defined in libavfilter/buffersink.h +or the options system. +

+

It accepts a pointer to an AVBufferSinkContext structure, which +defines the incoming buffers’ formats, to be passed as the opaque +parameter to avfilter_init_filter for initialization. +

+ +

43.2 nullsink

+ +

Null video sink: do absolutely nothing with the input video. It is +mainly useful as a template and for use in analysis / debugging +tools. +

+ + +

44 Multimedia Filters

+ +

Below is a description of the currently available multimedia filters. +

+ +

44.1 abitscope

+ +

Convert input audio to a video output, displaying the audio bit scope. +

+

The filter accepts the following options: +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 1024x256. +

+
+
colors
+

Specify list of colors separated by space or by ’|’ which will be used to +draw channels. Unrecognized or missing colors will be replaced +by white color. +

+
+ + +

44.2 adrawgraph

+

Draw a graph using input audio metadata. +

+

See drawgraph +

+ +

44.3 agraphmonitor

+ +

See graphmonitor. +

+ +

44.4 ahistogram

+ +

Convert input audio to a video output, displaying the volume histogram. +

+

The filter accepts the following options: +

+
+
dmode
+

Specify how histogram is calculated. +

+

It accepts the following values: +

+
‘single’
+

Use single histogram for all channels. +

+
‘separate’
+

Use separate histogram for each channel. +

+
+

Default is single. +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is hd720. +

+
+
scale
+

Set display scale. +

+

It accepts the following values: +

+
‘log’
+

logarithmic +

+
‘sqrt’
+

square root +

+
‘cbrt’
+

cubic root +

+
‘lin’
+

linear +

+
‘rlog’
+

reverse logarithmic +

+
+

Default is log. +

+
+
ascale
+

Set amplitude scale. +

+

It accepts the following values: +

+
‘log’
+

logarithmic +

+
‘lin’
+

linear +

+
+

Default is log. +

+
+
acount
+

Set how much frames to accumulate in histogram. +Default is 1. Setting this to -1 accumulates all frames. +

+
+
rheight
+

Set histogram ratio of window height. +

+
+
slide
+

Set sonogram sliding. +

+

It accepts the following values: +

+
‘replace’
+

replace old rows with new ones. +

+
‘scroll’
+

scroll from top to bottom. +

+
+

Default is replace. +

+
+ + +

44.5 aphasemeter

+ +

Measures phase of input audio, which is exported as metadata lavfi.aphasemeter.phase, +representing mean phase of current audio frame. A video output can also be produced and is +enabled by default. The audio is passed through as first output. +

+

Audio will be rematrixed to stereo if it has a different channel layout. Phase value is in +range [-1, 1] where -1 means left and right channels are completely out of phase +and 1 means channels are in phase. +

+

The filter accepts the following options, all related to its video output: +

+
+
rate, r
+

Set the output frame rate. Default value is 25. +

+
+
size, s
+

Set the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 800x400. +

+
+
rc
+
gc
+
bc
+

Specify the red, green, blue contrast. Default values are 2, +7 and 1. +Allowed range is [0, 255]. +

+
+
mpc
+

Set color which will be used for drawing median phase. If color is +none which is default, no median phase value will be drawn. +

+
+
video
+

Enable video output. Default is enabled. +

+
+ + +

44.6 avectorscope

+ +

Convert input audio to a video output, representing the audio vector +scope. +

+

The filter is used to measure the difference between channels of stereo +audio stream. A monaural signal, consisting of identical left and right +signal, results in straight vertical line. Any stereo separation is visible +as a deviation from this line, creating a Lissajous figure. +If the straight (or deviation from it) but horizontal line appears this +indicates that the left and right channels are out of phase. +

+

The filter accepts the following options: +

+
+
mode, m
+

Set the vectorscope mode. +

+

Available values are: +

+
‘lissajous’
+

Lissajous rotated by 45 degrees. +

+
+
‘lissajous_xy’
+

Same as above but not rotated. +

+
+
‘polar’
+

Shape resembling half of circle. +

+
+ +

Default value is ‘lissajous’. +

+
+
size, s
+

Set the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 400x400. +

+
+
rate, r
+

Set the output frame rate. Default value is 25. +

+
+
rc
+
gc
+
bc
+
ac
+

Specify the red, green, blue and alpha contrast. Default values are 40, +160, 80 and 255. +Allowed range is [0, 255]. +

+
+
rf
+
gf
+
bf
+
af
+

Specify the red, green, blue and alpha fade. Default values are 15, +10, 5 and 5. +Allowed range is [0, 255]. +

+
+
zoom
+

Set the zoom factor. Default value is 1. Allowed range is [0, 10]. +Values lower than 1 will auto adjust zoom factor to maximal possible value. +

+
+
draw
+

Set the vectorscope drawing mode. +

+

Available values are: +

+
‘dot’
+

Draw dot for each sample. +

+
+
‘line’
+

Draw line between previous and current sample. +

+
+ +

Default value is ‘dot’. +

+
+
scale
+

Specify amplitude scale of audio samples. +

+

Available values are: +

+
‘lin’
+

Linear. +

+
+
‘sqrt’
+

Square root. +

+
+
‘cbrt’
+

Cubic root. +

+
+
‘log’
+

Logarithmic. +

+
+ +
+
swap
+

Swap left channel axis with right channel axis. +

+
+
mirror
+

Mirror axis. +

+
+
‘none’
+

No mirror. +

+
+
‘x’
+

Mirror only x axis. +

+
+
‘y’
+

Mirror only y axis. +

+
+
‘xy’
+

Mirror both axis. +

+
+ +
+
+ + +

44.6.1 Examples

+ +
    +
  • Complete example using ffplay: +
    +
    ffplay -f lavfi 'amovie=input.mp3, asplit [a][out1];
+             [a] avectorscope=zoom=1.3:rc=2:gc=200:bc=10:rf=1:gf=8:bf=7 [out0]'
+
    +
+ + +

44.7 bench, abench

+ +

Benchmark part of a filtergraph. +

+

The filter accepts the following options: +

+
+
action
+

Start or stop a timer. +

+

Available values are: +

+
‘start’
+

Get the current time, set it as frame metadata (using the key +lavfi.bench.start_time), and forward the frame to the next filter. +

+
+
‘stop’
+

Get the current time and fetch the lavfi.bench.start_time metadata from +the input frame metadata to get the time difference. Time difference, average, +maximum and minimum time (respectively t, avg, max and +min) are then printed. The timestamps are expressed in seconds. +

+
+
+
+ + +

44.7.1 Examples

+ +
    +
  • Benchmark selectivecolor filter: +
    +
    bench=start,selectivecolor=reds=-.2 .12 -.49,bench=stop
+
    +
+ + +

44.8 concat

+ +

Concatenate audio and video streams, joining them together one after the +other. +

+

The filter works on segments of synchronized video and audio streams. All +segments must have the same number of streams of each type, and that will +also be the number of streams at output. +

+

The filter accepts the following options: +

+
+
n
+

Set the number of segments. Default is 2. +

+
+
v
+

Set the number of output video streams, that is also the number of video +streams in each segment. Default is 1. +

+
+
a
+

Set the number of output audio streams, that is also the number of audio +streams in each segment. Default is 0. +

+
+
unsafe
+

Activate unsafe mode: do not fail if segments have a different format. +

+
+
+ +

The filter has v+a outputs: first v video outputs, then +a audio outputs. +

+

There are nx(v+a) inputs: first the inputs for the first +segment, in the same order as the outputs, then the inputs for the second +segment, etc. +

+

Related streams do not always have exactly the same duration, for various +reasons including codec frame size or sloppy authoring. For that reason, +related synchronized streams (e.g. a video and its audio track) should be +concatenated at once. The concat filter will use the duration of the longest +stream in each segment (except the last one), and if necessary pad shorter +audio streams with silence. +

+

For this filter to work correctly, all segments must start at timestamp 0. +

+

All corresponding streams must have the same parameters in all segments; the +filtering system will automatically select a common pixel format for video +streams, and a common sample format, sample rate and channel layout for +audio streams, but other settings, such as resolution, must be converted +explicitly by the user. +

+

Different frame rates are acceptable but will result in variable frame rate +at output; be sure to configure the output file to handle it. +

+ +

44.8.1 Examples

+ +
    +
  • Concatenate an opening, an episode and an ending, all in bilingual version +(video in stream 0, audio in streams 1 and 2): +
    +
    ffmpeg -i opening.mkv -i episode.mkv -i ending.mkv -filter_complex \
+  '[0:0] [0:1] [0:2] [1:0] [1:1] [1:2] [2:0] [2:1] [2:2]
+   concat=n=3:v=1:a=2 [v] [a1] [a2]' \
+  -map '[v]' -map '[a1]' -map '[a2]' output.mkv
+
    + +
  • Concatenate two parts, handling audio and video separately, using the +(a)movie sources, and adjusting the resolution: +
    +
    movie=part1.mp4, scale=512:288 [v1] ; amovie=part1.mp4 [a1] ;
+movie=part2.mp4, scale=512:288 [v2] ; amovie=part2.mp4 [a2] ;
+[v1] [v2] concat [outv] ; [a1] [a2] concat=v=0:a=1 [outa]
+
    +

    Note that a desync will happen at the stitch if the audio and video streams +do not have exactly the same duration in the first file. +

    +
+ + +

44.8.2 Commands

+ +

This filter supports the following commands: +

+
next
+

Close the current segment and step to the next one +

+
+ + +

44.9 ebur128

+ +

EBU R128 scanner filter. This filter takes an audio stream and analyzes its loudness +level. By default, it logs a message at a frequency of 10Hz with the +Momentary loudness (identified by M), Short-term loudness (S), +Integrated loudness (I) and Loudness Range (LRA). +

+

The filter can only analyze streams which have a sampling rate of 48000 Hz and whose +sample format is double-precision floating point. The input stream will be converted to +this specification, if needed. Users may need to insert aformat and/or aresample filters +after this filter to obtain the original parameters. +

+

The filter also has a video output (see the video option) with a real +time graph to observe the loudness evolution. The graphic contains the logged +message mentioned above, so it is not printed anymore when this option is set, +unless the verbose logging is set. The main graphing area contains the +short-term loudness (3 seconds of analysis), and the gauge on the right is for +the momentary loudness (400 milliseconds), but can optionally be configured +to instead display short-term loudness (see gauge). +

+

The green area marks a +/- 1LU target range around the target loudness +(-23LUFS by default, unless modified through target). +

+

More information about the Loudness Recommendation EBU R128 on +http://tech.ebu.ch/loudness. +

+

The filter accepts the following options: +

+
+
video
+

Activate the video output. The audio stream is passed unchanged whether this +option is set or no. The video stream will be the first output stream if +activated. Default is 0. +

+
+
size
+

Set the video size. This option is for video only. For the syntax of this +option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default and minimum resolution is 640x480. +

+
+
meter
+

Set the EBU scale meter. Default is 9. Common values are 9 and +18, respectively for EBU scale meter +9 and EBU scale meter +18. Any +other integer value between this range is allowed. +

+
+
metadata
+

Set metadata injection. If set to 1, the audio input will be segmented +into 100ms output frames, each of them containing various loudness information +in metadata. All the metadata keys are prefixed with lavfi.r128.. +

+

Default is 0. +

+
+
framelog
+

Force the frame logging level. +

+

Available values are: +

+
‘info’
+

information logging level +

+
‘verbose’
+

verbose logging level +

+
+ +

By default, the logging level is set to info. If the video or +the metadata options are set, it switches to verbose. +

+
+
peak
+

Set peak mode(s). +

+

Available modes can be cumulated (the option is a flag type). Possible +values are: +

+
‘none’
+

Disable any peak mode (default). +

+
‘sample’
+

Enable sample-peak mode. +

+

Simple peak mode looking for the higher sample value. It logs a message +for sample-peak (identified by SPK). +

+
‘true’
+

Enable true-peak mode. +

+

If enabled, the peak lookup is done on an over-sampled version of the input +stream for better peak accuracy. It logs a message for true-peak. +(identified by TPK) and true-peak per frame (identified by FTPK). +This mode requires a build with libswresample. +

+
+ +
+
dualmono
+

Treat mono input files as "dual mono". If a mono file is intended for playback +on a stereo system, its EBU R128 measurement will be perceptually incorrect. +If set to true, this option will compensate for this effect. +Multi-channel input files are not affected by this option. +

+
+
panlaw
+

Set a specific pan law to be used for the measurement of dual mono files. +This parameter is optional, and has a default value of -3.01dB. +

+
+
target
+

Set a specific target level (in LUFS) used as relative zero in the visualization. +This parameter is optional and has a default value of -23LUFS as specified +by EBU R128. However, material published online may prefer a level of -16LUFS +(e.g. for use with podcasts or video platforms). +

+
+
gauge
+

Set the value displayed by the gauge. Valid values are momentary and s +shortterm. By default the momentary value will be used, but in certain +scenarios it may be more useful to observe the short term value instead (e.g. +live mixing). +

+
+
scale
+

Sets the display scale for the loudness. Valid parameters are absolute +(in LUFS) or relative (LU) relative to the target. This only affects the +video output, not the summary or continuous log output. +

+
+ + +

44.9.1 Examples

+ +
    +
  • Real-time graph using ffplay, with a EBU scale meter +18: +
    +
    ffplay -f lavfi -i "amovie=input.mp3,ebur128=video=1:meter=18 [out0][out1]"
+
    + +
  • Run an analysis with ffmpeg: +
    +
    ffmpeg -nostats -i input.mp3 -filter_complex ebur128 -f null -
+
    +
+ + +

44.10 interleave, ainterleave

+ +

Temporally interleave frames from several inputs. +

+

interleave works with video inputs, ainterleave with audio. +

+

These filters read frames from several inputs and send the oldest +queued frame to the output. +

+

Input streams must have well defined, monotonically increasing frame +timestamp values. +

+

In order to submit one frame to output, these filters need to enqueue +at least one frame for each input, so they cannot work in case one +input is not yet terminated and will not receive incoming frames. +

+

For example consider the case when one input is a select filter +which always drops input frames. The interleave filter will keep +reading from that input, but it will never be able to send new frames +to output until the input sends an end-of-stream signal. +

+

Also, depending on inputs synchronization, the filters will drop +frames in case one input receives more frames than the other ones, and +the queue is already filled. +

+

These filters accept the following options: +

+
+
nb_inputs, n
+

Set the number of different inputs, it is 2 by default. +

+
+
duration
+

How to determine the end-of-stream. +

+
+
longest
+

The duration of the longest input. (default) +

+
+
shortest
+

The duration of the shortest input. +

+
+
first
+

The duration of the first input. +

+
+ +
+
+ + +

44.10.1 Examples

+ +
    +
  • Interleave frames belonging to different streams using ffmpeg: +
    +
    ffmpeg -i bambi.avi -i pr0n.mkv -filter_complex "[0:v][1:v] interleave" out.avi
+
    + +
  • Add flickering blur effect: +
    +
    select='if(gt(random(0), 0.2), 1, 2)':n=2 [tmp], boxblur=2:2, [tmp] interleave
+
    +
+ + +

44.11 metadata, ametadata

+ +

Manipulate frame metadata. +

+

This filter accepts the following options: +

+
+
mode
+

Set mode of operation of the filter. +

+

Can be one of the following: +

+
+
‘select’
+

If both value and key is set, select frames +which have such metadata. If only key is set, select +every frame that has such key in metadata. +

+
+
‘add’
+

Add new metadata key and value. If key is already available +do nothing. +

+
+
‘modify’
+

Modify value of already present key. +

+
+
‘delete’
+

If value is set, delete only keys that have such value. +Otherwise, delete key. If key is not set, delete all metadata values in +the frame. +

+
+
‘print’
+

Print key and its value if metadata was found. If key is not set print all +metadata values available in frame. +

+
+ +
+
key
+

Set key used with all modes. Must be set for all modes except print and delete. +

+
+
value
+

Set metadata value which will be used. This option is mandatory for +modify and add mode. +

+
+
function
+

Which function to use when comparing metadata value and value. +

+

Can be one of following: +

+
+
‘same_str’
+

Values are interpreted as strings, returns true if metadata value is same as value. +

+
+
‘starts_with’
+

Values are interpreted as strings, returns true if metadata value starts with +the value option string. +

+
+
‘less’
+

Values are interpreted as floats, returns true if metadata value is less than value. +

+
+
‘equal’
+

Values are interpreted as floats, returns true if value is equal with metadata value. +

+
+
‘greater’
+

Values are interpreted as floats, returns true if metadata value is greater than value. +

+
+
‘expr’
+

Values are interpreted as floats, returns true if expression from option expr +evaluates to true. +

+
+
‘ends_with’
+

Values are interpreted as strings, returns true if metadata value ends with +the value option string. +

+
+ +
+
expr
+

Set expression which is used when function is set to expr. +The expression is evaluated through the eval API and can contain the following +constants: +

+
+
VALUE1
+

Float representation of value from metadata key. +

+
+
VALUE2
+

Float representation of value as supplied by user in value option. +

+
+ +
+
file
+

If specified in print mode, output is written to the named file. Instead of +plain filename any writable url can be specified. Filename “-” is a shorthand +for standard output. If file option is not set, output is written to the log +with AV_LOG_INFO loglevel. +

+
+
direct
+

Reduces buffering in print mode when output is written to a URL set using file. +

+
+
+ + +

44.11.1 Examples

+ +
    +
  • Print all metadata values for frames with key lavfi.signalstats.YDIF with values +between 0 and 1. +
    +
    signalstats,metadata=print:key=lavfi.signalstats.YDIF:value=0:function=expr:expr='between(VALUE1,0,1)'
+
    +
  • Print silencedetect output to file metadata.txt. +
    +
    silencedetect,ametadata=mode=print:file=metadata.txt
+
    +
  • Direct all metadata to a pipe with file descriptor 4. +
    +
    metadata=mode=print:file='pipe\:4'
+
    +
+ + +

44.12 perms, aperms

+ +

Set read/write permissions for the output frames. +

+

These filters are mainly aimed at developers to test direct path in the +following filter in the filtergraph. +

+

The filters accept the following options: +

+
+
mode
+

Select the permissions mode. +

+

It accepts the following values: +

+
‘none’
+

Do nothing. This is the default. +

+
‘ro’
+

Set all the output frames read-only. +

+
‘rw’
+

Set all the output frames directly writable. +

+
‘toggle’
+

Make the frame read-only if writable, and writable if read-only. +

+
‘random’
+

Set each output frame read-only or writable randomly. +

+
+ +
+
seed
+

Set the seed for the random mode, must be an integer included between +0 and UINT32_MAX. If not specified, or if explicitly set to +-1, the filter will try to use a good random seed on a best effort +basis. +

+
+ +

Note: in case of auto-inserted filter between the permission filter and the +following one, the permission might not be received as expected in that +following filter. Inserting a format or aformat filter before the +perms/aperms filter can avoid this problem. +

+ +

44.13 realtime, arealtime

+ +

Slow down filtering to match real time approximately. +

+

These filters will pause the filtering for a variable amount of time to +match the output rate with the input timestamps. +They are similar to the re option to ffmpeg. +

+

They accept the following options: +

+
+
limit
+

Time limit for the pauses. Any pause longer than that will be considered +a timestamp discontinuity and reset the timer. Default is 2 seconds. +

+
speed
+

Speed factor for processing. The value must be a float larger than zero. +Values larger than 1.0 will result in faster than realtime processing, +smaller will slow processing down. The limit is automatically adapted +accordingly. Default is 1.0. +

+

A processing speed faster than what is possible without these filters cannot +be achieved. +

+
+ + +

44.14 select, aselect

+ +

Select frames to pass in output. +

+

This filter accepts the following options: +

+
+
expr, e
+

Set expression, which is evaluated for each input frame. +

+

If the expression is evaluated to zero, the frame is discarded. +

+

If the evaluation result is negative or NaN, the frame is sent to the +first output; otherwise it is sent to the output with index +ceil(val)-1, assuming that the input index starts from 0. +

+

For example a value of 1.2 corresponds to the output with index +ceil(1.2)-1 = 2-1 = 1, that is the second output. +

+
+
outputs, n
+

Set the number of outputs. The output to which to send the selected +frame is based on the result of the evaluation. Default value is 1. +

+
+ +

The expression can contain the following constants: +

+
+
n
+

The (sequential) number of the filtered frame, starting from 0. +

+
+
selected_n
+

The (sequential) number of the selected frame, starting from 0. +

+
+
prev_selected_n
+

The sequential number of the last selected frame. It’s NAN if undefined. +

+
+
TB
+

The timebase of the input timestamps. +

+
+
pts
+

The PTS (Presentation TimeStamp) of the filtered video frame, +expressed in TB units. It’s NAN if undefined. +

+
+
t
+

The PTS of the filtered video frame, +expressed in seconds. It’s NAN if undefined. +

+
+
prev_pts
+

The PTS of the previously filtered video frame. It’s NAN if undefined. +

+
+
prev_selected_pts
+

The PTS of the last previously filtered video frame. It’s NAN if undefined. +

+
+
prev_selected_t
+

The PTS of the last previously selected video frame, expressed in seconds. It’s NAN if undefined. +

+
+
start_pts
+

The PTS of the first video frame in the video. It’s NAN if undefined. +

+
+
start_t
+

The time of the first video frame in the video. It’s NAN if undefined. +

+
+
pict_type (video only)
+

The type of the filtered frame. It can assume one of the following +values: +

+
I
+
P
+
B
+
S
+
SI
+
SP
+
BI
+
+ +
+
interlace_type (video only)
+

The frame interlace type. It can assume one of the following values: +

+
PROGRESSIVE
+

The frame is progressive (not interlaced). +

+
TOPFIRST
+

The frame is top-field-first. +

+
BOTTOMFIRST
+

The frame is bottom-field-first. +

+
+ +
+
consumed_sample_n (audio only)
+

the number of selected samples before the current frame +

+
+
samples_n (audio only)
+

the number of samples in the current frame +

+
+
sample_rate (audio only)
+

the input sample rate +

+
+
key
+

This is 1 if the filtered frame is a key-frame, 0 otherwise. +

+
+
pos
+

the position in the file of the filtered frame, -1 if the information +is not available (e.g. for synthetic video) +

+
+
scene (video only)
+

value between 0 and 1 to indicate a new scene; a low value reflects a low +probability for the current frame to introduce a new scene, while a higher +value means the current frame is more likely to be one (see the example below) +

+
+
concatdec_select
+

The concat demuxer can select only part of a concat input file by setting an +inpoint and an outpoint, but the output packets may not be entirely contained +in the selected interval. By using this variable, it is possible to skip frames +generated by the concat demuxer which are not exactly contained in the selected +interval. +

+

This works by comparing the frame pts against the lavf.concat.start_time +and the lavf.concat.duration packet metadata values which are also +present in the decoded frames. +

+

The concatdec_select variable is -1 if the frame pts is at least +start_time and either the duration metadata is missing or the frame pts is less +than start_time + duration, 0 otherwise, and NaN if the start_time metadata is +missing. +

+

That basically means that an input frame is selected if its pts is within the +interval set by the concat demuxer. +

+
+
+ +

The default value of the select expression is "1". +

+ +

44.14.1 Examples

+ +
    +
  • Select all frames in input: +
    +
    select
+
    + +

    The example above is the same as: +

    +
    select=1
+
    + +
  • Skip all frames: +
    +
    select=0
+
    + +
  • Select only I-frames: +
    +
    select='eq(pict_type\,I)'
+
    + +
  • Select one frame every 100: +
    +
    select='not(mod(n\,100))'
+
    + +
  • Select only frames contained in the 10-20 time interval: +
    +
    select=between(t\,10\,20)
+
    + +
  • Select only I-frames contained in the 10-20 time interval: +
    +
    select=between(t\,10\,20)*eq(pict_type\,I)
+
    + +
  • Select frames with a minimum distance of 10 seconds: +
    +
    select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
+
    + +
  • Use aselect to select only audio frames with samples number > 100: +
    +
    aselect='gt(samples_n\,100)'
+
    + +
  • Create a mosaic of the first scenes: +
    +
    ffmpeg -i video.avi -vf select='gt(scene\,0.4)',scale=160:120,tile -frames:v 1 preview.png
+
    + +

    Comparing scene against a value between 0.3 and 0.5 is generally a sane +choice. +

    +
  • Send even and odd frames to separate outputs, and compose them: +
    +
    select=n=2:e='mod(n, 2)+1' [odd][even]; [odd] pad=h=2*ih [tmp]; [tmp][even] overlay=y=h
+
    + +
  • Select useful frames from an ffconcat file which is using inpoints and +outpoints but where the source files are not intra frame only. +
    +
    ffmpeg -copyts -vsync 0 -segment_time_metadata 1 -i input.ffconcat -vf select=concatdec_select -af aselect=concatdec_select output.avi
+
    +
+ + +

44.15 sendcmd, asendcmd

+ +

Send commands to filters in the filtergraph. +

+

These filters read commands to be sent to other filters in the +filtergraph. +

+

sendcmd must be inserted between two video filters, +asendcmd must be inserted between two audio filters, but apart +from that they act the same way. +

+

The specification of commands can be provided in the filter arguments +with the commands option, or in a file specified by the +filename option. +

+

These filters accept the following options: +

+
commands, c
+

Set the commands to be read and sent to the other filters. +

+
filename, f
+

Set the filename of the commands to be read and sent to the other +filters. +

+
+ + +

44.15.1 Commands syntax

+ +

A commands description consists of a sequence of interval +specifications, comprising a list of commands to be executed when a +particular event related to that interval occurs. The occurring event +is typically the current frame time entering or leaving a given time +interval. +

+

An interval is specified by the following syntax: +

+
START[-END] COMMANDS;
+
+ +

The time interval is specified by the START and END times. +END is optional and defaults to the maximum time. +

+

The current frame time is considered within the specified interval if +it is included in the interval [START, END), that is when +the time is greater or equal to START and is lesser than +END. +

+

COMMANDS consists of a sequence of one or more command +specifications, separated by ",", relating to that interval. The +syntax of a command specification is given by: +

+
[FLAGS] TARGET COMMAND ARG
+
+ +

FLAGS is optional and specifies the type of events relating to +the time interval which enable sending the specified command, and must +be a non-null sequence of identifier flags separated by "+" or "|" and +enclosed between "[" and "]". +

+

The following flags are recognized: +

+
enter
+

The command is sent when the current frame timestamp enters the +specified interval. In other words, the command is sent when the +previous frame timestamp was not in the given interval, and the +current is. +

+
+
leave
+

The command is sent when the current frame timestamp leaves the +specified interval. In other words, the command is sent when the +previous frame timestamp was in the given interval, and the +current is not. +

+
+
expr
+

The command ARG is interpreted as expression and result of +expression is passed as ARG. +

+

The expression is evaluated through the eval API and can contain the following +constants: +

+
+
POS
+

Original position in the file of the frame, or undefined if undefined +for the current frame. +

+
+
PTS
+

The presentation timestamp in input. +

+
+
N
+

The count of the input frame for video or audio, starting from 0. +

+
+
T
+

The time in seconds of the current frame. +

+
+
TS
+

The start time in seconds of the current command interval. +

+
+
TE
+

The end time in seconds of the current command interval. +

+
+
TI
+

The interpolated time of the current command interval, TI = (T - TS) / (TE - TS). +

+
+ +
+
+ +

If FLAGS is not specified, a default value of [enter] is +assumed. +

+

TARGET specifies the target of the command, usually the name of +the filter class or a specific filter instance name. +

+

COMMAND specifies the name of the command for the target filter. +

+

ARG is optional and specifies the optional list of argument for +the given COMMAND. +

+

Between one interval specification and another, whitespaces, or +sequences of characters starting with # until the end of line, +are ignored and can be used to annotate comments. +

+

A simplified BNF description of the commands specification syntax +follows: +

+
COMMAND_FLAG  ::= "enter" | "leave"
+COMMAND_FLAGS ::= COMMAND_FLAG [(+|"|")COMMAND_FLAG]
+COMMAND       ::= ["[" COMMAND_FLAGS "]"] TARGET COMMAND [ARG]
+COMMANDS      ::= COMMAND [,COMMANDS]
+INTERVAL      ::= START[-END] COMMANDS
+INTERVALS     ::= INTERVAL[;INTERVALS]
+
+ + +

44.15.2 Examples

+ +
    +
  • Specify audio tempo change at second 4: +
    +
    asendcmd=c='4.0 atempo tempo 1.5',atempo
+
    + +
  • Target a specific filter instance: +
    +
    asendcmd=c='4.0 atempo@my tempo 1.5',atempo@my
+
    + +
  • Specify a list of drawtext and hue commands in a file. +
    +
    # show text in the interval 5-10
+5.0-10.0 [enter] drawtext reinit 'fontfile=FreeSerif.ttf:text=hello world',
+         [leave] drawtext reinit 'fontfile=FreeSerif.ttf:text=';
+
+# desaturate the image in the interval 15-20
+15.0-20.0 [enter] hue s 0,
+          [enter] drawtext reinit 'fontfile=FreeSerif.ttf:text=nocolor',
+          [leave] hue s 1,
+          [leave] drawtext reinit 'fontfile=FreeSerif.ttf:text=color';
+
+# apply an exponential saturation fade-out effect, starting from time 25
+25 [enter] hue s exp(25-t)
+
    + +

    A filtergraph allowing to read and process the above command list +stored in a file test.cmd, can be specified with: +

    +
    sendcmd=f=test.cmd,drawtext=fontfile=FreeSerif.ttf:text='',hue
+
    +
+ + +

44.16 setpts, asetpts

+ +

Change the PTS (presentation timestamp) of the input frames. +

+

setpts works on video frames, asetpts on audio frames. +

+

This filter accepts the following options: +

+
+
expr
+

The expression which is evaluated for each frame to construct its timestamp. +

+
+
+ +

The expression is evaluated through the eval API and can contain the following +constants: +

+
+
FRAME_RATE, FR
+

frame rate, only defined for constant frame-rate video +

+
+
PTS
+

The presentation timestamp in input +

+
+
N
+

The count of the input frame for video or the number of consumed samples, +not including the current frame for audio, starting from 0. +

+
+
NB_CONSUMED_SAMPLES
+

The number of consumed samples, not including the current frame (only +audio) +

+
+
NB_SAMPLES, S
+

The number of samples in the current frame (only audio) +

+
+
SAMPLE_RATE, SR
+

The audio sample rate. +

+
+
STARTPTS
+

The PTS of the first frame. +

+
+
STARTT
+

the time in seconds of the first frame +

+
+
INTERLACED
+

State whether the current frame is interlaced. +

+
+
T
+

the time in seconds of the current frame +

+
+
POS
+

original position in the file of the frame, or undefined if undefined +for the current frame +

+
+
PREV_INPTS
+

The previous input PTS. +

+
+
PREV_INT
+

previous input time in seconds +

+
+
PREV_OUTPTS
+

The previous output PTS. +

+
+
PREV_OUTT
+

previous output time in seconds +

+
+
RTCTIME
+

The wallclock (RTC) time in microseconds. This is deprecated, use time(0) +instead. +

+
+
RTCSTART
+

The wallclock (RTC) time at the start of the movie in microseconds. +

+
+
TB
+

The timebase of the input timestamps. +

+
+
+ + +

44.16.1 Examples

+ +
    +
  • Start counting PTS from zero +
    +
    setpts=PTS-STARTPTS
+
    + +
  • Apply fast motion effect: +
    +
    setpts=0.5*PTS
+
    + +
  • Apply slow motion effect: +
    +
    setpts=2.0*PTS
+
    + +
  • Set fixed rate of 25 frames per second: +
    +
    setpts=N/(25*TB)
+
    + +
  • Set fixed rate 25 fps with some jitter: +
    +
    setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
+
    + +
  • Apply an offset of 10 seconds to the input PTS: +
    +
    setpts=PTS+10/TB
+
    + +
  • Generate timestamps from a "live source" and rebase onto the current timebase: +
    +
    setpts='(RTCTIME - RTCSTART) / (TB * 1000000)'
+
    + +
  • Generate timestamps by counting samples: +
    +
    asetpts=N/SR/TB
+
    + +
+ + +

44.17 setrange

+ +

Force color range for the output video frame. +

+

The setrange filter marks the color range property for the +output frames. It does not change the input frame, but only sets the +corresponding property, which affects how the frame is treated by +following filters. +

+

The filter accepts the following options: +

+
+
range
+

Available values are: +

+
+
‘auto’
+

Keep the same color range property. +

+
+
‘unspecified, unknown’
+

Set the color range as unspecified. +

+
+
‘limited, tv, mpeg’
+

Set the color range as limited. +

+
+
‘full, pc, jpeg’
+

Set the color range as full. +

+
+
+
+ + +

44.18 settb, asettb

+ +

Set the timebase to use for the output frames timestamps. +It is mainly useful for testing timebase configuration. +

+

It accepts the following parameters: +

+
+
expr, tb
+

The expression which is evaluated into the output timebase. +

+
+
+ +

The value for tb is an arithmetic expression representing a +rational. The expression can contain the constants "AVTB" (the default +timebase), "intb" (the input timebase) and "sr" (the sample rate, +audio only). Default value is "intb". +

+ +

44.18.1 Examples

+ +
    +
  • Set the timebase to 1/25: +
    +
    settb=expr=1/25
+
    + +
  • Set the timebase to 1/10: +
    +
    settb=expr=0.1
+
    + +
  • Set the timebase to 1001/1000: +
    +
    settb=1+0.001
+
    + +
  • Set the timebase to 2*intb: +
    +
    settb=2*intb
+
    + +
  • Set the default timebase value: +
    +
    settb=AVTB
+
    +
+ + +

44.19 showcqt

+

Convert input audio to a video output representing frequency spectrum +logarithmically using Brown-Puckette constant Q transform algorithm with +direct frequency domain coefficient calculation (but the transform itself +is not really constant Q, instead the Q factor is actually variable/clamped), +with musical tone scale, from E0 to D#10. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. It must be even. For the syntax of this option, +check the (ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 1920x1080. +

+
+
fps, rate, r
+

Set the output frame rate. Default value is 25. +

+
+
bar_h
+

Set the bargraph height. It must be even. Default value is -1 which +computes the bargraph height automatically. +

+
+
axis_h
+

Set the axis height. It must be even. Default value is -1 which computes +the axis height automatically. +

+
+
sono_h
+

Set the sonogram height. It must be even. Default value is -1 which +computes the sonogram height automatically. +

+
+
fullhd
+

Set the fullhd resolution. This option is deprecated, use size, s +instead. Default value is 1. +

+
+
sono_v, volume
+

Specify the sonogram volume expression. It can contain variables: +

+
bar_v
+

the bar_v evaluated expression +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option +

+
+

and functions: +

+
a_weighting(f)
+

A-weighting of equal loudness +

+
b_weighting(f)
+

B-weighting of equal loudness +

+
c_weighting(f)
+

C-weighting of equal loudness. +

+
+

Default value is 16. +

+
+
bar_v, volume2
+

Specify the bargraph volume expression. It can contain variables: +

+
sono_v
+

the sono_v evaluated expression +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option +

+
+

and functions: +

+
a_weighting(f)
+

A-weighting of equal loudness +

+
b_weighting(f)
+

B-weighting of equal loudness +

+
c_weighting(f)
+

C-weighting of equal loudness. +

+
+

Default value is sono_v. +

+
+
sono_g, gamma
+

Specify the sonogram gamma. Lower gamma makes the spectrum more contrast, +higher gamma makes the spectrum having more range. Default value is 3. +Acceptable range is [1, 7]. +

+
+
bar_g, gamma2
+

Specify the bargraph gamma. Default value is 1. Acceptable range is +[1, 7]. +

+
+
bar_t
+

Specify the bargraph transparency level. Lower value makes the bargraph sharper. +Default value is 1. Acceptable range is [0, 1]. +

+
+
timeclamp, tc
+

Specify the transform timeclamp. At low frequency, there is trade-off between +accuracy in time domain and frequency domain. If timeclamp is lower, +event in time domain is represented more accurately (such as fast bass drum), +otherwise event in frequency domain is represented more accurately +(such as bass guitar). Acceptable range is [0.002, 1]. Default value is 0.17. +

+
+
attack
+

Set attack time in seconds. The default is 0 (disabled). Otherwise, it +limits future samples by applying asymmetric windowing in time domain, useful +when low latency is required. Accepted range is [0, 1]. +

+
+
basefreq
+

Specify the transform base frequency. Default value is 20.01523126408007475, +which is frequency 50 cents below E0. Acceptable range is [10, 100000]. +

+
+
endfreq
+

Specify the transform end frequency. Default value is 20495.59681441799654, +which is frequency 50 cents above D#10. Acceptable range is [10, 100000]. +

+
+
coeffclamp
+

This option is deprecated and ignored. +

+
+
tlength
+

Specify the transform length in time domain. Use this option to control accuracy +trade-off between time domain and frequency domain at every frequency sample. +It can contain variables: +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option. +

+
+

Default value is 384*tc/(384+tc*f). +

+
+
count
+

Specify the transform count for every video frame. Default value is 6. +Acceptable range is [1, 30]. +

+
+
fcount
+

Specify the transform count for every single pixel. Default value is 0, +which makes it computed automatically. Acceptable range is [0, 10]. +

+
+
fontfile
+

Specify font file for use with freetype to draw the axis. If not specified, +use embedded font. Note that drawing with font file or embedded font is not +implemented with custom basefreq and endfreq, use axisfile +option instead. +

+
+
font
+

Specify fontconfig pattern. This has lower priority than fontfile. The +: in the pattern may be replaced by | to avoid unnecessary +escaping. +

+
+
fontcolor
+

Specify font color expression. This is arithmetic expression that should return +integer value 0xRRGGBB. It can contain variables: +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option +

+
+

and functions: +

+
midi(f)
+

midi number of frequency f, some midi numbers: E0(16), C1(24), C2(36), A4(69) +

+
r(x), g(x), b(x)
+

red, green, and blue value of intensity x. +

+
+

Default value is st(0, (midi(f)-59.5)/12); +st(1, if(between(ld(0),0,1), 0.5-0.5*cos(2*PI*ld(0)), 0)); +r(1-ld(1)) + b(ld(1)). +

+
+
axisfile
+

Specify image file to draw the axis. This option override fontfile and +fontcolor option. +

+
+
axis, text
+

Enable/disable drawing text to the axis. If it is set to 0, drawing to +the axis is disabled, ignoring fontfile and axisfile option. +Default value is 1. +

+
+
csp
+

Set colorspace. The accepted values are: +

+
‘unspecified’
+

Unspecified (default) +

+
+
‘bt709’
+

BT.709 +

+
+
‘fcc’
+

FCC +

+
+
‘bt470bg’
+

BT.470BG or BT.601-6 625 +

+
+
‘smpte170m’
+

SMPTE-170M or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘bt2020ncl’
+

BT.2020 with non-constant luminance +

+
+
+ +
+
cscheme
+

Set spectrogram color scheme. This is list of floating point values with format +left_r|left_g|left_b|right_r|right_g|right_b. +The default is 1|0.5|0|0|0.5|1. +

+
+
+ + +

44.19.1 Examples

+ +
    +
  • Playing audio while showing the spectrum: +
    +
    ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt [out0]'
+
    + +
  • Same as above, but with frame rate 30 fps: +
    +
    ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt=fps=30:count=5 [out0]'
+
    + +
  • Playing at 1280x720: +
    +
    ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt=s=1280x720:count=4 [out0]'
+
    + +
  • Disable sonogram display: +
    +
    sono_h=0
+
    + +
  • A1 and its harmonics: A1, A2, (near)E3, A3: +
    +
    ffplay -f lavfi 'aevalsrc=0.1*sin(2*PI*55*t)+0.1*sin(4*PI*55*t)+0.1*sin(6*PI*55*t)+0.1*sin(8*PI*55*t),
+                 asplit[a][out1]; [a] showcqt [out0]'
+
    + +
  • Same as above, but with more accuracy in frequency domain: +
    +
    ffplay -f lavfi 'aevalsrc=0.1*sin(2*PI*55*t)+0.1*sin(4*PI*55*t)+0.1*sin(6*PI*55*t)+0.1*sin(8*PI*55*t),
+                 asplit[a][out1]; [a] showcqt=timeclamp=0.5 [out0]'
+
    + +
  • Custom volume: +
    +
    bar_v=10:sono_v=bar_v*a_weighting(f)
+
    + +
  • Custom gamma, now spectrum is linear to the amplitude. +
    +
    bar_g=2:sono_g=2
+
    + +
  • Custom tlength equation: +
    +
    tc=0.33:tlength='st(0,0.17); 384*tc / (384 / ld(0) + tc*f /(1-ld(0))) + 384*tc / (tc*f / ld(0) + 384 /(1-ld(0)))'
+
    + +
  • Custom fontcolor and fontfile, C-note is colored green, others are colored blue: +
    +
    fontcolor='if(mod(floor(midi(f)+0.5),12), 0x0000FF, g(1))':fontfile=myfont.ttf
+
    + +
  • Custom font using fontconfig: +
    +
    font='Courier New,Monospace,mono|bold'
+
    + +
  • Custom frequency range with custom axis using image file: +
    +
    axisfile=myaxis.png:basefreq=40:endfreq=10000
+
    +
+ + +

44.20 showfreqs

+ +

Convert input audio to video output representing the audio power spectrum. +Audio amplitude is on Y-axis while frequency is on X-axis. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify size of video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default is 1024x512. +

+
+
mode
+

Set display mode. +This set how each frequency bin will be represented. +

+

It accepts the following values: +

+
‘line’
+
‘bar’
+
‘dot’
+
+

Default is bar. +

+
+
ascale
+

Set amplitude scale. +

+

It accepts the following values: +

+
‘lin’
+

Linear scale. +

+
+
‘sqrt’
+

Square root scale. +

+
+
‘cbrt’
+

Cubic root scale. +

+
+
‘log’
+

Logarithmic scale. +

+
+

Default is log. +

+
+
fscale
+

Set frequency scale. +

+

It accepts the following values: +

+
‘lin’
+

Linear scale. +

+
+
‘log’
+

Logarithmic scale. +

+
+
‘rlog’
+

Reverse logarithmic scale. +

+
+

Default is lin. +

+
+
win_size
+

Set window size. Allowed range is from 16 to 65536. +

+

Default is 2048 +

+
+
win_func
+

Set windowing function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+

Default is hanning. +

+
+
overlap
+

Set window overlap. In range [0, 1]. Default is 1, +which means optimal overlap for selected window function will be picked. +

+
+
averaging
+

Set time averaging. Setting this to 0 will display current maximal peaks. +Default is 1, which means time averaging is disabled. +

+
+
colors
+

Specify list of colors separated by space or by ’|’ which will be used to +draw channel frequencies. Unrecognized or missing colors will be replaced +by white color. +

+
+
cmode
+

Set channel display mode. +

+

It accepts the following values: +

+
‘combined’
+
‘separate’
+
+

Default is combined. +

+
+
minamp
+

Set minimum amplitude used in log amplitude scaler. +

+
+
+ + +

44.21 showspatial

+ +

Convert stereo input audio to a video output, representing the spatial relationship +between two channels. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 512x512. +

+
+
win_size
+

Set window size. Allowed range is from 1024 to 65536. Default size is 4096. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+ +

Default value is hann. +

+
+
overlap
+

Set ratio of overlap window. Default value is 0.5. +When value is 1 overlap is set to recommended size for specific +window function currently used. +

+
+ + +

44.22 showspectrum

+ +

Convert input audio to a video output, representing the audio frequency +spectrum. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 640x512. +

+
+
slide
+

Specify how the spectrum should slide along the window. +

+

It accepts the following values: +

+
‘replace’
+

the samples start again on the left when they reach the right +

+
‘scroll’
+

the samples scroll from right to left +

+
‘fullframe’
+

frames are only produced when the samples reach the right +

+
‘rscroll’
+

the samples scroll from left to right +

+
+ +

Default value is replace. +

+
+
mode
+

Specify display mode. +

+

It accepts the following values: +

+
‘combined’
+

all channels are displayed in the same row +

+
‘separate’
+

all channels are displayed in separate rows +

+
+ +

Default value is ‘combined’. +

+
+
color
+

Specify display color mode. +

+

It accepts the following values: +

+
‘channel’
+

each channel is displayed in a separate color +

+
‘intensity’
+

each channel is displayed using the same color scheme +

+
‘rainbow’
+

each channel is displayed using the rainbow color scheme +

+
‘moreland’
+

each channel is displayed using the moreland color scheme +

+
‘nebulae’
+

each channel is displayed using the nebulae color scheme +

+
‘fire’
+

each channel is displayed using the fire color scheme +

+
‘fiery’
+

each channel is displayed using the fiery color scheme +

+
‘fruit’
+

each channel is displayed using the fruit color scheme +

+
‘cool’
+

each channel is displayed using the cool color scheme +

+
‘magma’
+

each channel is displayed using the magma color scheme +

+
‘green’
+

each channel is displayed using the green color scheme +

+
‘viridis’
+

each channel is displayed using the viridis color scheme +

+
‘plasma’
+

each channel is displayed using the plasma color scheme +

+
‘cividis’
+

each channel is displayed using the cividis color scheme +

+
‘terrain’
+

each channel is displayed using the terrain color scheme +

+
+ +

Default value is ‘channel’. +

+
+
scale
+

Specify scale used for calculating intensity color values. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘sqrt’
+

square root, default +

+
‘cbrt’
+

cubic root +

+
‘log’
+

logarithmic +

+
‘4thrt’
+

4th root +

+
‘5thrt’
+

5th root +

+
+ +

Default value is ‘sqrt’. +

+
+
fscale
+

Specify frequency scale. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘log’
+

logarithmic +

+
+ +

Default value is ‘lin’. +

+
+
saturation
+

Set saturation modifier for displayed colors. Negative values provide +alternative color scheme. 0 is no saturation at all. +Saturation must be in [-10.0, 10.0] range. +Default value is 1. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+ +

Default value is hann. +

+
+
orientation
+

Set orientation of time vs frequency axis. Can be vertical or +horizontal. Default is vertical. +

+
+
overlap
+

Set ratio of overlap window. Default value is 0. +When value is 1 overlap is set to recommended size for specific +window function currently used. +

+
+
gain
+

Set scale gain for calculating intensity color values. +Default value is 1. +

+
+
data
+

Set which data to display. Can be magnitude, default or phase. +

+
+
rotation
+

Set color rotation, must be in [-1.0, 1.0] range. +Default value is 0. +

+
+
start
+

Set start frequency from which to display spectrogram. Default is 0. +

+
+
stop
+

Set stop frequency to which to display spectrogram. Default is 0. +

+
+
fps
+

Set upper frame rate limit. Default is auto, unlimited. +

+
+
legend
+

Draw time and frequency axes and legends. Default is disabled. +

+
+ +

The usage is very similar to the showwaves filter; see the examples in that +section. +

+ +

44.22.1 Examples

+ +
    +
  • Large window with logarithmic color scaling: +
    +
    showspectrum=s=1280x480:scale=log
+
    + +
  • Complete example for a colored and sliding spectrum per channel using ffplay: +
    +
    ffplay -f lavfi 'amovie=input.mp3, asplit [a][out1];
+             [a] showspectrum=mode=separate:color=intensity:slide=1:scale=cbrt [out0]'
+
    +
+ + +

44.23 showspectrumpic

+ +

Convert input audio to a single video frame, representing the audio frequency +spectrum. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 4096x2048. +

+
+
mode
+

Specify display mode. +

+

It accepts the following values: +

+
‘combined’
+

all channels are displayed in the same row +

+
‘separate’
+

all channels are displayed in separate rows +

+
+

Default value is ‘combined’. +

+
+
color
+

Specify display color mode. +

+

It accepts the following values: +

+
‘channel’
+

each channel is displayed in a separate color +

+
‘intensity’
+

each channel is displayed using the same color scheme +

+
‘rainbow’
+

each channel is displayed using the rainbow color scheme +

+
‘moreland’
+

each channel is displayed using the moreland color scheme +

+
‘nebulae’
+

each channel is displayed using the nebulae color scheme +

+
‘fire’
+

each channel is displayed using the fire color scheme +

+
‘fiery’
+

each channel is displayed using the fiery color scheme +

+
‘fruit’
+

each channel is displayed using the fruit color scheme +

+
‘cool’
+

each channel is displayed using the cool color scheme +

+
‘magma’
+

each channel is displayed using the magma color scheme +

+
‘green’
+

each channel is displayed using the green color scheme +

+
‘viridis’
+

each channel is displayed using the viridis color scheme +

+
‘plasma’
+

each channel is displayed using the plasma color scheme +

+
‘cividis’
+

each channel is displayed using the cividis color scheme +

+
‘terrain’
+

each channel is displayed using the terrain color scheme +

+
+

Default value is ‘intensity’. +

+
+
scale
+

Specify scale used for calculating intensity color values. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘sqrt’
+

square root, default +

+
‘cbrt’
+

cubic root +

+
‘log’
+

logarithmic +

+
‘4thrt’
+

4th root +

+
‘5thrt’
+

5th root +

+
+

Default value is ‘log’. +

+
+
fscale
+

Specify frequency scale. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘log’
+

logarithmic +

+
+ +

Default value is ‘lin’. +

+
+
saturation
+

Set saturation modifier for displayed colors. Negative values provide +alternative color scheme. 0 is no saturation at all. +Saturation must be in [-10.0, 10.0] range. +Default value is 1. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+

Default value is hann. +

+
+
orientation
+

Set orientation of time vs frequency axis. Can be vertical or +horizontal. Default is vertical. +

+
+
gain
+

Set scale gain for calculating intensity color values. +Default value is 1. +

+
+
legend
+

Draw time and frequency axes and legends. Default is enabled. +

+
+
rotation
+

Set color rotation, must be in [-1.0, 1.0] range. +Default value is 0. +

+
+
start
+

Set start frequency from which to display spectrogram. Default is 0. +

+
+
stop
+

Set stop frequency to which to display spectrogram. Default is 0. +

+
+ + +

44.23.1 Examples

+ +
    +
  • Extract an audio spectrogram of a whole audio track +in a 1024x1024 picture using ffmpeg: +
    +
    ffmpeg -i audio.flac -lavfi showspectrumpic=s=1024x1024 spectrogram.png
+
    +
+ + +

44.24 showvolume

+ +

Convert input audio volume to a video output. +

+

The filter accepts the following options: +

+
+
rate, r
+

Set video rate. +

+
+
b
+

Set border width, allowed range is [0, 5]. Default is 1. +

+
+
w
+

Set channel width, allowed range is [80, 8192]. Default is 400. +

+
+
h
+

Set channel height, allowed range is [1, 900]. Default is 20. +

+
+
f
+

Set fade, allowed range is [0, 1]. Default is 0.95. +

+
+
c
+

Set volume color expression. +

+

The expression can use the following variables: +

+
+
VOLUME
+

Current max volume of channel in dB. +

+
+
PEAK
+

Current peak. +

+
+
CHANNEL
+

Current channel number, starting from 0. +

+
+ +
+
t
+

If set, displays channel names. Default is enabled. +

+
+
v
+

If set, displays volume values. Default is enabled. +

+
+
o
+

Set orientation, can be horizontal: h or vertical: v, +default is h. +

+
+
s
+

Set step size, allowed range is [0, 5]. Default is 0, which means +step is disabled. +

+
+
p
+

Set background opacity, allowed range is [0, 1]. Default is 0. +

+
+
m
+

Set metering mode, can be peak: p or rms: r, +default is p. +

+
+
ds
+

Set display scale, can be linear: lin or log: log, +default is lin. +

+
+
dm
+

In second. +If set to > 0., display a line for the max level +in the previous seconds. +default is disabled: 0. +

+
+
dmc
+

The color of the max line. Use when dm option is set to > 0. +default is: orange +

+
+ + +

44.25 showwaves

+ +

Convert input audio to a video output, representing the samples waves. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 600x240. +

+
+
mode
+

Set display mode. +

+

Available values are: +

+
‘point’
+

Draw a point for each sample. +

+
+
‘line’
+

Draw a vertical line for each sample. +

+
+
‘p2p’
+

Draw a point for each sample and a line between them. +

+
+
‘cline’
+

Draw a centered vertical line for each sample. +

+
+ +

Default value is point. +

+
+
n
+

Set the number of samples which are printed on the same column. A +larger value will decrease the frame rate. Must be a positive +integer. This option can be set only if the value for rate +is not explicitly specified. +

+
+
rate, r
+

Set the (approximate) output frame rate. This is done by setting the +option n. Default value is "25". +

+
+
split_channels
+

Set if channels should be drawn separately or overlap. Default value is 0. +

+
+
colors
+

Set colors separated by ’|’ which are going to be used for drawing of each channel. +

+
+
scale
+

Set amplitude scale. +

+

Available values are: +

+
‘lin’
+

Linear. +

+
+
‘log’
+

Logarithmic. +

+
+
‘sqrt’
+

Square root. +

+
+
‘cbrt’
+

Cubic root. +

+
+ +

Default is linear. +

+
+
draw
+

Set the draw mode. This is mostly useful to set for high n. +

+

Available values are: +

+
‘scale’
+

Scale pixel values for each drawn sample. +

+
+
‘full’
+

Draw every sample directly. +

+
+ +

Default value is scale. +

+
+ + +

44.25.1 Examples

+ +
    +
  • Output the input file audio and the corresponding video representation +at the same time: +
    +
    amovie=a.mp3,asplit[out0],showwaves[out1]
+
    + +
  • Create a synthetic signal and show it with showwaves, forcing a +frame rate of 30 frames per second: +
    +
    aevalsrc=sin(1*2*PI*t)*sin(880*2*PI*t):cos(2*PI*200*t),asplit[out0],showwaves=r=30[out1]
+
    +
+ + +

44.26 showwavespic

+ +

Convert input audio to a single video frame, representing the samples waves. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 600x240. +

+
+
split_channels
+

Set if channels should be drawn separately or overlap. Default value is 0. +

+
+
colors
+

Set colors separated by ’|’ which are going to be used for drawing of each channel. +

+
+
scale
+

Set amplitude scale. +

+

Available values are: +

+
‘lin’
+

Linear. +

+
+
‘log’
+

Logarithmic. +

+
+
‘sqrt’
+

Square root. +

+
+
‘cbrt’
+

Cubic root. +

+
+ +

Default is linear. +

+
+
draw
+

Set the draw mode. +

+

Available values are: +

+
‘scale’
+

Scale pixel values for each drawn sample. +

+
+
‘full’
+

Draw every sample directly. +

+
+ +

Default value is scale. +

+
+ + +

44.26.1 Examples

+ +
    +
  • Extract a channel split representation of the wave form of a whole audio track +in a 1024x800 picture using ffmpeg: +
    +
    ffmpeg -i audio.flac -lavfi showwavespic=split_channels=1:s=1024x800 waveform.png
+
    +
+ + +

44.27 sidedata, asidedata

+ +

Delete frame side data, or select frames based on it. +

+

This filter accepts the following options: +

+
+
mode
+

Set mode of operation of the filter. +

+

Can be one of the following: +

+
+
‘select’
+

Select every frame with side data of type. +

+
+
‘delete’
+

Delete side data of type. If type is not set, delete all side +data in the frame. +

+
+
+ +
+
type
+

Set side data type used with all modes. Must be set for select mode. For +the list of frame side data types, refer to the AVFrameSideDataType enum +in libavutil/frame.h. For example, to choose +AV_FRAME_DATA_PANSCAN side data, you must specify PANSCAN. +

+
+
+ + +

44.28 spectrumsynth

+ +

Synthesize audio from 2 input video spectrums, first input stream represents +magnitude across time and second represents phase across time. +The filter will transform from frequency domain as displayed in videos back +to time domain as presented in audio output. +

+

This filter is primarily created for reversing processed showspectrum +filter outputs, but can synthesize sound from other spectrograms too. +But in such case results are going to be poor if the phase data is not +available, because in such cases phase data need to be recreated, usually +it’s just recreated from random noise. +For best results use gray only output (channel color mode in +showspectrum filter) and log scale for magnitude video and +lin scale for phase video. To produce phase, for 2nd video, use +data option. Inputs videos should generally use fullframe +slide mode as that saves resources needed for decoding video. +

+

The filter accepts the following options: +

+
+
sample_rate
+

Specify sample rate of output audio, the sample rate of audio from which +spectrum was generated may differ. +

+
+
channels
+

Set number of channels represented in input video spectrums. +

+
+
scale
+

Set scale which was used when generating magnitude input spectrum. +Can be lin or log. Default is log. +

+
+
slide
+

Set slide which was used when generating inputs spectrums. +Can be replace, scroll, fullframe or rscroll. +Default is fullframe. +

+
+
win_func
+

Set window function used for resynthesis. +

+
+
overlap
+

Set window overlap. In range [0, 1]. Default is 1, +which means optimal overlap for selected window function will be picked. +

+
+
orientation
+

Set orientation of input videos. Can be vertical or horizontal. +Default is vertical. +

+
+ + +

44.28.1 Examples

+ +
    +
  • First create magnitude and phase videos from audio, assuming audio is stereo with 44100 sample rate, +then resynthesize videos back to audio with spectrumsynth: +
    +
    ffmpeg -i input.flac -lavfi showspectrum=mode=separate:scale=log:overlap=0.875:color=channel:slide=fullframe:data=magnitude -an -c:v rawvideo magnitude.nut
+ffmpeg -i input.flac -lavfi showspectrum=mode=separate:scale=lin:overlap=0.875:color=channel:slide=fullframe:data=phase -an -c:v rawvideo phase.nut
+ffmpeg -i magnitude.nut -i phase.nut -lavfi spectrumsynth=channels=2:sample_rate=44100:win_func=hann:overlap=0.875:slide=fullframe output.flac
+
    +
+ + +

44.29 split, asplit

+ +

Split input into several identical outputs. +

+

asplit works with audio input, split with video. +

+

The filter accepts a single parameter which specifies the number of outputs. If +unspecified, it defaults to 2. +

+ +

44.29.1 Examples

+ +
    +
  • Create two separate outputs from the same input: +
    +
    [in] split [out0][out1]
+
    + +
  • To create 3 or more outputs, you need to specify the number of +outputs, like in: +
    +
    [in] asplit=3 [out0][out1][out2]
+
    + +
  • Create two separate outputs from the same input, one cropped and +one padded: +
    +
    [in] split [splitout1][splitout2];
+[splitout1] crop=100:100:0:0    [cropout];
+[splitout2] pad=200:200:100:100 [padout];
+
    + +
  • Create 5 copies of the input audio with ffmpeg: +
    +
    ffmpeg -i INPUT -filter_complex asplit=5 OUTPUT
+
    +
+ + +

44.30 zmq, azmq

+ +

Receive commands sent through a libzmq client, and forward them to +filters in the filtergraph. +

+

zmq and azmq work as a pass-through filters. zmq +must be inserted between two video filters, azmq between two +audio filters. Both are capable to send messages to any filter type. +

+

To enable these filters you need to install the libzmq library and +headers and configure FFmpeg with --enable-libzmq. +

+

For more information about libzmq see: +http://www.zeromq.org/ +

+

The zmq and azmq filters work as a libzmq server, which +receives messages sent through a network interface defined by the +bind_address (or the abbreviation "b") option. +Default value of this option is tcp://localhost:5555. You may +want to alter this value to your needs, but do not forget to escape any +’:’ signs (see filtergraph escaping). +

+

The received message must be in the form: +

+
TARGET COMMAND [ARG]
+
+ +

TARGET specifies the target of the command, usually the name of +the filter class or a specific filter instance name. The default +filter instance name uses the pattern ‘Parsed_<filter_name>_<index>’, +but you can override this by using the ‘filter_name@id’ syntax +(see Filtergraph syntax). +

+

COMMAND specifies the name of the command for the target filter. +

+

ARG is optional and specifies the optional argument list for the +given COMMAND. +

+

Upon reception, the message is processed and the corresponding command +is injected into the filtergraph. Depending on the result, the filter +will send a reply to the client, adopting the format: +

+
ERROR_CODE ERROR_REASON
+MESSAGE
+
+ +

MESSAGE is optional. +

+ +

44.30.1 Examples

+ +

Look at tools/zmqsend for an example of a zmq client which can +be used to send commands processed by these filters. +

+

Consider the following filtergraph generated by ffplay. +In this example the last overlay filter has an instance name. All other +filters will have default instance names. +

+
+
ffplay -dumpgraph 1 -f lavfi "
+color=s=100x100:c=red  [l];
+color=s=100x100:c=blue [r];
+nullsrc=s=200x100, zmq [bg];
+[bg][l]   overlay     [bg+l];
+[bg+l][r] overlay@my=x=100 "
+
+ +

To change the color of the left side of the video, the following +command can be used: +

+
echo Parsed_color_0 c yellow | tools/zmqsend
+
+ +

To change the right side: +

+
echo Parsed_color_1 c pink | tools/zmqsend
+
+ +

To change the position of the right side: +

+
echo overlay@my x 150 | tools/zmqsend
+
+ + + + +

45 Multimedia Sources

+ +

Below is a description of the currently available multimedia sources. +

+ +

45.1 amovie

+ +

This is the same as movie source, except it selects an audio +stream by default. +

+ +

45.2 movie

+ +

Read audio and/or video stream(s) from a movie container. +

+

It accepts the following parameters: +

+
+
filename
+

The name of the resource to read (not necessarily a file; it can also be a +device or a stream accessed through some protocol). +

+
+
format_name, f
+

Specifies the format assumed for the movie to read, and can be either +the name of a container or an input device. If not specified, the +format is guessed from movie_name or by probing. +

+
+
seek_point, sp
+

Specifies the seek point in seconds. The frames will be output +starting from this seek point. The parameter is evaluated with +av_strtod, so the numerical value may be suffixed by an IS +postfix. The default value is "0". +

+
+
streams, s
+

Specifies the streams to read. Several streams can be specified, +separated by "+". The source will then have as many outputs, in the +same order. The syntax is explained in the (ffmpeg)"Stream specifiers" +section in the ffmpeg manual. Two special names, "dv" and "da" specify +respectively the default (best suited) video and audio stream. Default +is "dv", or "da" if the filter is called as "amovie". +

+
+
stream_index, si
+

Specifies the index of the video stream to read. If the value is -1, +the most suitable video stream will be automatically selected. The default +value is "-1". Deprecated. If the filter is called "amovie", it will select +audio instead of video. +

+
+
loop
+

Specifies how many times to read the stream in sequence. +If the value is 0, the stream will be looped infinitely. +Default value is "1". +

+

Note that when the movie is looped the source timestamps are not +changed, so it will generate non monotonically increasing timestamps. +

+
+
discontinuity
+

Specifies the time difference between frames above which the point is +considered a timestamp discontinuity which is removed by adjusting the later +timestamps. +

+
+ +

It allows overlaying a second video on top of the main input of +a filtergraph, as shown in this graph: +

+
input -----------> deltapts0 --> overlay --> output
+                                    ^
+                                    |
+movie --> scale--> deltapts1 -------+
+
+ +

45.2.1 Examples

+ +
    +
  • Skip 3.2 seconds from the start of the AVI file in.avi, and overlay it +on top of the input labelled "in": +
    +
    movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [over];
+[in] setpts=PTS-STARTPTS [main];
+[main][over] overlay=16:16 [out]
+
    + +
  • Read from a video4linux2 device, and overlay it on top of the input +labelled "in": +
    +
    movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [over];
+[in] setpts=PTS-STARTPTS [main];
+[main][over] overlay=16:16 [out]
+
    + +
  • Read the first video stream and the audio stream with id 0x81 from +dvd.vob; the video is connected to the pad named "video" and the audio is +connected to the pad named "audio": +
    +
    movie=dvd.vob:s=v:0+#0x81 [video] [audio]
+
    +
+ + +

45.2.2 Commands

+ +

Both movie and amovie support the following commands: +

+
seek
+

Perform seek using "av_seek_frame". +The syntax is: seek stream_index|timestamp|flags +

    +
  • stream_index: If stream_index is -1, a default +stream is selected, and timestamp is automatically converted +from AV_TIME_BASE units to the stream specific time_base. +
  • timestamp: Timestamp in AVStream.time_base units +or, if no stream is specified, in AV_TIME_BASE units. +
  • flags: Flags which select direction and seeking mode. +
+ +
+
get_duration
+

Get movie duration in AV_TIME_BASE units. +

+
+
+ + + +

46 See Also

+ +

ffmpeg +ffplay, ffprobe, +ffmpeg-utils, +ffmpeg-scaler, +ffmpeg-resampler, +ffmpeg-codecs, +ffmpeg-bitstream-filters, +ffmpeg-formats, +ffmpeg-devices, +ffmpeg-protocols, +ffmpeg-filters +

+ + +

47 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-bitstream-filters.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-bitstream-filters.html new file mode 100644 index 0000000..6756fb2 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-bitstream-filters.html @@ -0,0 +1,953 @@ + + + + + + + FFmpeg Bitstream Filters Documentation + + + + + + +
+

+ FFmpeg Bitstream Filters Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

This document describes the bitstream filters provided by the +libavcodec library. +

+

A bitstream filter operates on the encoded stream data, and performs +bitstream level modifications without performing decoding. +

+ + +

2 Bitstream Filters

+ +

When you configure your FFmpeg build, all the supported bitstream +filters are enabled by default. You can list all available ones using +the configure option --list-bsfs. +

+

You can disable all the bitstream filters using the configure option +--disable-bsfs, and selectively enable any bitstream filter using +the option --enable-bsf=BSF, or you can disable a particular +bitstream filter using the option --disable-bsf=BSF. +

+

The option -bsfs of the ff* tools will display the list of +all the supported bitstream filters included in your build. +

+

The ff* tools have a -bsf option applied per stream, taking a +comma-separated list of filters, whose parameters follow the filter +name after a ’=’. +

+
+
ffmpeg -i INPUT -c:v copy -bsf:v filter1[=opt1=str1:opt2=str2][,filter2] OUTPUT
+
+ +

Below is a description of the currently available bitstream filters, +with their parameters, if any. +

+ +

2.1 aac_adtstoasc

+ +

Convert MPEG-2/4 AAC ADTS to an MPEG-4 Audio Specific Configuration +bitstream. +

+

This filter creates an MPEG-4 AudioSpecificConfig from an MPEG-2/4 +ADTS header and removes the ADTS header. +

+

This filter is required for example when copying an AAC stream from a +raw ADTS AAC or an MPEG-TS container to MP4A-LATM, to an FLV file, or +to MOV/MP4 files and related formats such as 3GP or M4A. Please note +that it is auto-inserted for MP4A-LATM and MOV/MP4 and related formats. +

+ +

2.2 av1_metadata

+ +

Modify metadata embedded in an AV1 stream. +

+
+
td
+

Insert or remove temporal delimiter OBUs in all temporal units of the +stream. +

+
+
‘insert’
+

Insert a TD at the beginning of every TU which does not already have one. +

+
‘remove’
+

Remove the TD from the beginning of every TU which has one. +

+
+ +
+
color_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the color description fields in the stream (see AV1 section 6.4.2). +

+
+
color_range
+

Set the color range in the stream (see AV1 section 6.4.2; note that +this cannot be set for streams using BT.709 primaries, sRGB transfer +characteristic and identity (RGB) matrix coefficients). +

+
‘tv’
+

Limited range. +

+
‘pc’
+

Full range. +

+
+ +
+
chroma_sample_position
+

Set the chroma sample location in the stream (see AV1 section 6.4.2). +This can only be set for 4:2:0 streams. +

+
+
‘vertical’
+

Left position (matching the default in MPEG-2 and H.264). +

+
‘colocated’
+

Top-left position. +

+
+ +
+
tick_rate
+

Set the tick rate (num_units_in_display_tick / time_scale) in +the timing info in the sequence header. +

+
num_ticks_per_picture
+

Set the number of ticks in each picture, to indicate that the stream +has a fixed framerate. Ignored if tick_rate is not also set. +

+
+
delete_padding
+

Deletes Padding OBUs. +

+
+
+ + +

2.3 chomp

+ +

Remove zero padding at the end of a packet. +

+ +

2.4 dca_core

+ +

Extract the core from a DCA/DTS stream, dropping extensions such as +DTS-HD. +

+ +

2.5 dump_extra

+ +

Add extradata to the beginning of the filtered packets except when +said packets already exactly begin with the extradata that is intended +to be added. +

+
+
freq
+

The additional argument specifies which packets should be filtered. +It accepts the values: +

+
‘k’
+
‘keyframe’
+

add extradata to all key packets +

+
+
‘e’
+
‘all’
+

add extradata to all packets +

+
+
+
+ +

If not specified it is assumed ‘k’. +

+

For example the following ffmpeg command forces a global +header (thus disabling individual packet headers) in the H.264 packets +generated by the libx264 encoder, but corrects them by adding +the header stored in extradata to the key packets: +

+
ffmpeg -i INPUT -map 0 -flags:v +global_header -c:v libx264 -bsf:v dump_extra out.ts
+
+ + +

2.6 eac3_core

+ +

Extract the core from a E-AC-3 stream, dropping extra channels. +

+ +

2.7 extract_extradata

+ +

Extract the in-band extradata. +

+

Certain codecs allow the long-term headers (e.g. MPEG-2 sequence headers, +or H.264/HEVC (VPS/)SPS/PPS) to be transmitted either "in-band" (i.e. as a part +of the bitstream containing the coded frames) or "out of band" (e.g. on the +container level). This latter form is called "extradata" in FFmpeg terminology. +

+

This bitstream filter detects the in-band headers and makes them available as +extradata. +

+
+
remove
+

When this option is enabled, the long-term headers are removed from the +bitstream after extraction. +

+
+ + +

2.8 filter_units

+ +

Remove units with types in or not in a given set from the stream. +

+
+
pass_types
+

List of unit types or ranges of unit types to pass through while removing +all others. This is specified as a ’|’-separated list of unit type values +or ranges of values with ’-’. +

+
+
remove_types
+

Identical to pass_types, except the units in the given set +removed and all others passed through. +

+
+ +

Extradata is unchanged by this transformation, but note that if the stream +contains inline parameter sets then the output may be unusable if they are +removed. +

+

For example, to remove all non-VCL NAL units from an H.264 stream: +

+
ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=pass_types=1-5' OUTPUT
+
+ +

To remove all AUDs, SEI and filler from an H.265 stream: +

+
ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=remove_types=35|38-40' OUTPUT
+
+ + +

2.9 hapqa_extract

+ +

Extract Rgb or Alpha part of an HAPQA file, without recompression, in order to create an HAPQ or an HAPAlphaOnly file. +

+
+
texture
+

Specifies the texture to keep. +

+
+
color
+
alpha
+
+ +
+
+ +

Convert HAPQA to HAPQ +

+
ffmpeg -i hapqa_inputfile.mov -c copy -bsf:v hapqa_extract=texture=color -tag:v HapY -metadata:s:v:0 encoder="HAPQ" hapq_file.mov
+
+ +

Convert HAPQA to HAPAlphaOnly +

+
ffmpeg -i hapqa_inputfile.mov -c copy -bsf:v hapqa_extract=texture=alpha -tag:v HapA -metadata:s:v:0 encoder="HAPAlpha Only" hapalphaonly_file.mov
+
+ + +

2.10 h264_metadata

+ +

Modify metadata embedded in an H.264 stream. +

+
+
aud
+

Insert or remove AUD NAL units in all access units of the stream. +

+
+
‘insert’
+
‘remove’
+
+ +
+
sample_aspect_ratio
+

Set the sample aspect ratio of the stream in the VUI parameters. +

+
+
overscan_appropriate_flag
+

Set whether the stream is suitable for display using overscan +or not (see H.264 section E.2.1). +

+
+
video_format
+
video_full_range_flag
+

Set the video format in the stream (see H.264 section E.2.1 and +table E-2). +

+
+
colour_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the colour description in the stream (see H.264 section E.2.1 +and tables E-3, E-4 and E-5). +

+
+
chroma_sample_loc_type
+

Set the chroma sample location in the stream (see H.264 section +E.2.1 and figure E-1). +

+
+
tick_rate
+

Set the tick rate (num_units_in_tick / time_scale) in the VUI +parameters. This is the smallest time unit representable in the +stream, and in many cases represents the field rate of the stream +(double the frame rate). +

+
fixed_frame_rate_flag
+

Set whether the stream has fixed framerate - typically this indicates +that the framerate is exactly half the tick rate, but the exact +meaning is dependent on interlacing and the picture structure (see +H.264 section E.2.1 and table E-6). +

+
+
crop_left
+
crop_right
+
crop_top
+
crop_bottom
+

Set the frame cropping offsets in the SPS. These values will replace +the current ones if the stream is already cropped. +

+

These fields are set in pixels. Note that some sizes may not be +representable if the chroma is subsampled or the stream is interlaced +(see H.264 section 7.4.2.1.1). +

+
+
sei_user_data
+

Insert a string as SEI unregistered user data. The argument must +be of the form UUID+string, where the UUID is as hex digits +possibly separated by hyphens, and the string can be anything. +

+

For example, ‘086f3693-b7b3-4f2c-9653-21492feee5b8+hello’ will +insert the string “hello” associated with the given UUID. +

+
+
delete_filler
+

Deletes both filler NAL units and filler SEI messages. +

+
+
level
+

Set the level in the SPS. Refer to H.264 section A.3 and tables A-1 +to A-5. +

+

The argument must be the name of a level (for example, ‘4.2’), a +level_idc value (for example, ‘42’), or the special name ‘auto’ +indicating that the filter should attempt to guess the level from the +input stream properties. +

+
+
+ + +

2.11 h264_mp4toannexb

+ +

Convert an H.264 bitstream from length prefixed mode to start code +prefixed mode (as defined in the Annex B of the ITU-T H.264 +specification). +

+

This is required by some streaming formats, typically the MPEG-2 +transport stream format (muxer mpegts). +

+

For example to remux an MP4 file containing an H.264 stream to mpegts +format with ffmpeg, you can use the command: +

+
+
ffmpeg -i INPUT.mp4 -codec copy -bsf:v h264_mp4toannexb OUTPUT.ts
+
+ +

Please note that this filter is auto-inserted for MPEG-TS (muxer +mpegts) and raw H.264 (muxer h264) output formats. +

+ +

2.12 h264_redundant_pps

+ +

This applies a specific fixup to some Blu-ray streams which contain +redundant PPSs modifying irrelevant parameters of the stream which +confuse other transformations which require correct extradata. +

+

A new single global PPS is created, and all of the redundant PPSs +within the stream are removed. +

+ +

2.13 hevc_metadata

+ +

Modify metadata embedded in an HEVC stream. +

+
+
aud
+

Insert or remove AUD NAL units in all access units of the stream. +

+
+
‘insert’
+
‘remove’
+
+ +
+
sample_aspect_ratio
+

Set the sample aspect ratio in the stream in the VUI parameters. +

+
+
video_format
+
video_full_range_flag
+

Set the video format in the stream (see H.265 section E.3.1 and +table E.2). +

+
+
colour_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the colour description in the stream (see H.265 section E.3.1 +and tables E.3, E.4 and E.5). +

+
+
chroma_sample_loc_type
+

Set the chroma sample location in the stream (see H.265 section +E.3.1 and figure E.1). +

+
+
tick_rate
+

Set the tick rate in the VPS and VUI parameters (num_units_in_tick / +time_scale). Combined with num_ticks_poc_diff_one, this can +set a constant framerate in the stream. Note that it is likely to be +overridden by container parameters when the stream is in a container. +

+
+
num_ticks_poc_diff_one
+

Set poc_proportional_to_timing_flag in VPS and VUI and use this value +to set num_ticks_poc_diff_one_minus1 (see H.265 sections 7.4.3.1 and +E.3.1). Ignored if tick_rate is not also set. +

+
+
crop_left
+
crop_right
+
crop_top
+
crop_bottom
+

Set the conformance window cropping offsets in the SPS. These values +will replace the current ones if the stream is already cropped. +

+

These fields are set in pixels. Note that some sizes may not be +representable if the chroma is subsampled (H.265 section 7.4.3.2.1). +

+
+
level
+

Set the level in the VPS and SPS. See H.265 section A.4 and tables +A.6 and A.7. +

+

The argument must be the name of a level (for example, ‘5.1’), a +general_level_idc value (for example, ‘153’ for level 5.1), +or the special name ‘auto’ indicating that the filter should +attempt to guess the level from the input stream properties. +

+
+
+ + +

2.14 hevc_mp4toannexb

+ +

Convert an HEVC/H.265 bitstream from length prefixed mode to start code +prefixed mode (as defined in the Annex B of the ITU-T H.265 +specification). +

+

This is required by some streaming formats, typically the MPEG-2 +transport stream format (muxer mpegts). +

+

For example to remux an MP4 file containing an HEVC stream to mpegts +format with ffmpeg, you can use the command: +

+
+
ffmpeg -i INPUT.mp4 -codec copy -bsf:v hevc_mp4toannexb OUTPUT.ts
+
+ +

Please note that this filter is auto-inserted for MPEG-TS (muxer +mpegts) and raw HEVC/H.265 (muxer h265 or +hevc) output formats. +

+ +

2.15 imxdump

+ +

Modifies the bitstream to fit in MOV and to be usable by the Final Cut +Pro decoder. This filter only applies to the mpeg2video codec, and is +likely not needed for Final Cut Pro 7 and newer with the appropriate +-tag:v. +

+

For example, to remux 30 MB/sec NTSC IMX to MOV: +

+
+
ffmpeg -i input.mxf -c copy -bsf:v imxdump -tag:v mx3n output.mov
+
+ + +

2.16 mjpeg2jpeg

+ +

Convert MJPEG/AVI1 packets to full JPEG/JFIF packets. +

+

MJPEG is a video codec wherein each video frame is essentially a +JPEG image. The individual frames can be extracted without loss, +e.g. by +

+
+
ffmpeg -i ../some_mjpeg.avi -c:v copy frames_%d.jpg
+
+ +

Unfortunately, these chunks are incomplete JPEG images, because +they lack the DHT segment required for decoding. Quoting from +http://www.digitalpreservation.gov/formats/fdd/fdd000063.shtml: +

+

Avery Lee, writing in the rec.video.desktop newsgroup in 2001, +commented that "MJPEG, or at least the MJPEG in AVIs having the +MJPG fourcc, is restricted JPEG with a fixed – and *omitted* – +Huffman table. The JPEG must be YCbCr colorspace, it must be 4:2:2, +and it must use basic Huffman encoding, not arithmetic or +progressive. . . . You can indeed extract the MJPEG frames and +decode them with a regular JPEG decoder, but you have to prepend +the DHT segment to them, or else the decoder won’t have any idea +how to decompress the data. The exact table necessary is given in +the OpenDML spec." +

+

This bitstream filter patches the header of frames extracted from an MJPEG +stream (carrying the AVI1 header ID and lacking a DHT segment) to +produce fully qualified JPEG images. +

+
+
ffmpeg -i mjpeg-movie.avi -c:v copy -bsf:v mjpeg2jpeg frame_%d.jpg
+exiftran -i -9 frame*.jpg
+ffmpeg -i frame_%d.jpg -c:v copy rotated.avi
+
+ + +

2.17 mjpegadump

+ +

Add an MJPEG A header to the bitstream, to enable decoding by +Quicktime. +

+ +

2.18 mov2textsub

+ +

Extract a representable text file from MOV subtitles, stripping the +metadata header from each subtitle packet. +

+

See also the text2movsub filter. +

+ +

2.19 mp3decomp

+ +

Decompress non-standard compressed MP3 audio headers. +

+ +

2.20 mpeg2_metadata

+ +

Modify metadata embedded in an MPEG-2 stream. +

+
+
display_aspect_ratio
+

Set the display aspect ratio in the stream. +

+

The following fixed values are supported: +

+
4/3
+
16/9
+
221/100
+
+

Any other value will result in square pixels being signalled instead +(see H.262 section 6.3.3 and table 6-3). +

+
+
frame_rate
+

Set the frame rate in the stream. This is constructed from a table +of known values combined with a small multiplier and divisor - if +the supplied value is not exactly representable, the nearest +representable value will be used instead (see H.262 section 6.3.3 +and table 6-4). +

+
+
video_format
+

Set the video format in the stream (see H.262 section 6.3.6 and +table 6-6). +

+
+
colour_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the colour description in the stream (see H.262 section 6.3.6 +and tables 6-7, 6-8 and 6-9). +

+
+
+ + +

2.21 mpeg4_unpack_bframes

+ +

Unpack DivX-style packed B-frames. +

+

DivX-style packed B-frames are not valid MPEG-4 and were only a +workaround for the broken Video for Windows subsystem. +They use more space, can cause minor AV sync issues, require more +CPU power to decode (unless the player has some decoded picture queue +to compensate the 2,0,2,0 frame per packet style) and cause +trouble if copied into a standard container like mp4 or mpeg-ps/ts, +because MPEG-4 decoders may not be able to decode them, since they are +not valid MPEG-4. +

+

For example to fix an AVI file containing an MPEG-4 stream with +DivX-style packed B-frames using ffmpeg, you can use the command: +

+
+
ffmpeg -i INPUT.avi -codec copy -bsf:v mpeg4_unpack_bframes OUTPUT.avi
+
+ + +

2.22 noise

+ +

Damages the contents of packets or simply drops them without damaging the +container. Can be used for fuzzing or testing error resilience/concealment. +

+

Parameters: +

+
amount
+

A numeral string, whose value is related to how often output bytes will +be modified. Therefore, values below or equal to 0 are forbidden, and +the lower the more frequent bytes will be modified, with 1 meaning +every byte is modified. +

+
dropamount
+

A numeral string, whose value is related to how often packets will be dropped. +Therefore, values below or equal to 0 are forbidden, and the lower the more +frequent packets will be dropped, with 1 meaning every packet is dropped. +

+
+ +

The following example applies the modification to every byte but does not drop +any packets. +

+
ffmpeg -i INPUT -c copy -bsf noise[=1] output.mkv
+
+ + +

2.23 null

+

This bitstream filter passes the packets through unchanged. +

+ +

2.24 pcm_rechunk

+ +

Repacketize PCM audio to a fixed number of samples per packet or a fixed packet +rate per second. This is similar to the (ffmpeg-filters)asetnsamples audio +filter but works on audio packets instead of audio frames. +

+
+
nb_out_samples, n
+

Set the number of samples per each output audio packet. The number is intended +as the number of samples per each channel. Default value is 1024. +

+
+
pad, p
+

If set to 1, the filter will pad the last audio packet with silence, so that it +will contain the same number of samples (or roughly the same number of samples, +see frame_rate) as the previous ones. Default value is 1. +

+
+
frame_rate, r
+

This option makes the filter output a fixed number of packets per second instead +of a fixed number of samples per packet. If the audio sample rate is not +divisible by the frame rate then the number of samples will not be constant but +will vary slightly so that each packet will start as close to the frame +boundary as possible. Using this option has precedence over nb_out_samples. +

+
+ +

You can generate the well known 1602-1601-1602-1601-1602 pattern of 48kHz audio +for NTSC frame rate using the frame_rate option. +

+
ffmpeg -f lavfi -i sine=r=48000:d=1 -c pcm_s16le -bsf pcm_rechunk=r=30000/1001 -f framecrc -
+
+ + +

2.25 prores_metadata

+ +

Modify color property metadata embedded in prores stream. +

+
+
color_primaries
+

Set the color primaries. +Available values are: +

+
+
‘auto’
+

Keep the same color primaries property (default). +

+
+
‘unknown’
+
‘bt709’
+
‘bt470bg’
+

BT601 625 +

+
+
‘smpte170m’
+

BT601 525 +

+
+
‘bt2020’
+
‘smpte431’
+

DCI P3 +

+
+
‘smpte432’
+

P3 D65 +

+
+
+ +
+
transfer_characteristics
+

Set the color transfer. +Available values are: +

+
+
‘auto’
+

Keep the same transfer characteristics property (default). +

+
+
‘unknown’
+
‘bt709’
+

BT 601, BT 709, BT 2020 +

+
‘smpte2084’
+

SMPTE ST 2084 +

+
‘arib-std-b67’
+

ARIB STD-B67 +

+
+ + +
+
matrix_coefficients
+

Set the matrix coefficient. +Available values are: +

+
+
‘auto’
+

Keep the same colorspace property (default). +

+
+
‘unknown’
+
‘bt709’
+
‘smpte170m’
+

BT 601 +

+
+
‘bt2020nc’
+
+
+
+ +

Set Rec709 colorspace for each frame of the file +

+
ffmpeg -i INPUT -c copy -bsf:v prores_metadata=color_primaries=bt709:color_trc=bt709:colorspace=bt709 output.mov
+
+ +

Set Hybrid Log-Gamma parameters for each frame of the file +

+
ffmpeg -i INPUT -c copy -bsf:v prores_metadata=color_primaries=bt2020:color_trc=arib-std-b67:colorspace=bt2020nc output.mov
+
+ + +

2.26 remove_extra

+ +

Remove extradata from packets. +

+

It accepts the following parameter: +

+
freq
+

Set which frame types to remove extradata from. +

+
+
‘k’
+

Remove extradata from non-keyframes only. +

+
+
‘keyframe’
+

Remove extradata from keyframes only. +

+
+
‘e, all’
+

Remove extradata from all frames. +

+
+
+
+
+ + +

2.27 text2movsub

+ +

Convert text subtitles to MOV subtitles (as used by the mov_text +codec) with metadata headers. +

+

See also the mov2textsub filter. +

+ +

2.28 trace_headers

+ +

Log trace output containing all syntax elements in the coded stream +headers (everything above the level of individual coded blocks). +This can be useful for debugging low-level stream issues. +

+

Supports AV1, H.264, H.265, (M)JPEG, MPEG-2 and VP9, but depending +on the build only a subset of these may be available. +

+ +

2.29 truehd_core

+ +

Extract the core from a TrueHD stream, dropping ATMOS data. +

+ +

2.30 vp9_metadata

+ +

Modify metadata embedded in a VP9 stream. +

+
+
color_space
+

Set the color space value in the frame header. Note that any frame +set to RGB will be implicitly set to PC range and that RGB is +incompatible with profiles 0 and 2. +

+
‘unknown’
+
‘bt601’
+
‘bt709’
+
‘smpte170’
+
‘smpte240’
+
‘bt2020’
+
‘rgb’
+
+ +
+
color_range
+

Set the color range value in the frame header. Note that any value +imposed by the color space will take precedence over this value. +

+
‘tv’
+
‘pc’
+
+
+
+ + +

2.31 vp9_superframe

+ +

Merge VP9 invisible (alt-ref) frames back into VP9 superframes. This +fixes merging of split/segmented VP9 streams where the alt-ref frame +was split from its visible counterpart. +

+ +

2.32 vp9_superframe_split

+ +

Split VP9 superframes into single frames. +

+ +

2.33 vp9_raw_reorder

+ +

Given a VP9 stream with correct timestamps but possibly out of order, +insert additional show-existing-frame packets to correct the ordering. +

+ + +

3 See Also

+ +

ffmpeg, ffplay, ffprobe, +libavcodec +

+ + +

4 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-codecs.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-codecs.html new file mode 100644 index 0000000..5ed6a31 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-codecs.html @@ -0,0 +1,6051 @@ + + + + + + + FFmpeg Codecs Documentation + + + + + + +
+

+ FFmpeg Codecs Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

This document describes the codecs (decoders and encoders) provided by +the libavcodec library. +

+ + +

2 Codec Options

+ +

libavcodec provides some generic global options, which can be set on +all the encoders and decoders. In addition each codec may support +so-called private options, which are specific for a given codec. +

+

Sometimes, a global option may only affect a specific kind of codec, +and may be nonsensical or ignored by another, so you need to be aware +of the meaning of the specified options. Also some options are +meant only for decoding or encoding. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the +AVCodecContext options or using the libavutil/opt.h API +for programmatic use. +

+

The list of supported options follow: +

+
+
b integer (encoding,audio,video)
+

Set bitrate in bits/s. Default value is 200K. +

+
+
ab integer (encoding,audio)
+

Set audio bitrate (in bits/s). Default value is 128K. +

+
+
bt integer (encoding,video)
+

Set video bitrate tolerance (in bits/s). In 1-pass mode, bitrate +tolerance specifies how far ratecontrol is willing to deviate from the +target average bitrate value. This is not related to min/max +bitrate. Lowering tolerance too much has an adverse effect on quality. +

+
+
flags flags (decoding/encoding,audio,video,subtitles)
+

Set generic flags. +

+

Possible values: +

+
‘mv4’
+

Use four motion vector by macroblock (mpeg4). +

+
‘qpel’
+

Use 1/4 pel motion compensation. +

+
‘loop’
+

Use loop filter. +

+
‘qscale’
+

Use fixed qscale. +

+
‘pass1’
+

Use internal 2pass ratecontrol in first pass mode. +

+
‘pass2’
+

Use internal 2pass ratecontrol in second pass mode. +

+
‘gray’
+

Only decode/encode grayscale. +

+
‘emu_edge’
+

Do not draw edges. +

+
‘psnr’
+

Set error[?] variables during encoding. +

+
‘truncated’
+

Input bitstream might be randomly truncated. +

+
‘drop_changed’
+

Don’t output frames whose parameters differ from first decoded frame in stream. +Error AVERROR_INPUT_CHANGED is returned when a frame is dropped. +

+
+
‘ildct’
+

Use interlaced DCT. +

+
‘low_delay’
+

Force low delay. +

+
‘global_header’
+

Place global headers in extradata instead of every keyframe. +

+
‘bitexact’
+

Only write platform-, build- and time-independent data. (except (I)DCT). +This ensures that file and data checksums are reproducible and match between +platforms. Its primary use is for regression testing. +

+
‘aic’
+

Apply H263 advanced intra coding / mpeg4 ac prediction. +

+
‘cbp’
+

Deprecated, use mpegvideo private options instead. +

+
‘qprd’
+

Deprecated, use mpegvideo private options instead. +

+
‘ilme’
+

Apply interlaced motion estimation. +

+
‘cgop’
+

Use closed gop. +

+
‘output_corrupt’
+

Output even potentially corrupted frames. +

+
+ +
+
me_method integer (encoding,video)
+

Set motion estimation method. +

+

Possible values: +

+
‘zero’
+

zero motion estimation (fastest) +

+
‘full’
+

full motion estimation (slowest) +

+
‘epzs’
+

EPZS motion estimation (default) +

+
‘esa’
+

esa motion estimation (alias for full) +

+
‘tesa’
+

tesa motion estimation +

+
‘dia’
+

dia motion estimation (alias for epzs) +

+
‘log’
+

log motion estimation +

+
‘phods’
+

phods motion estimation +

+
‘x1’
+

X1 motion estimation +

+
‘hex’
+

hex motion estimation +

+
‘umh’
+

umh motion estimation +

+
‘iter’
+

iter motion estimation +

+
+ +
+
extradata_size integer
+

Set extradata size. +

+
+
time_base rational number
+

Set codec time base. +

+

It is the fundamental unit of time (in seconds) in terms of which +frame timestamps are represented. For fixed-fps content, timebase +should be 1 / frame_rate and timestamp increments should be +identically 1. +

+
+
g integer (encoding,video)
+

Set the group of picture (GOP) size. Default value is 12. +

+
+
ar integer (decoding/encoding,audio)
+

Set audio sampling rate (in Hz). +

+
+
ac integer (decoding/encoding,audio)
+

Set number of audio channels. +

+
+
cutoff integer (encoding,audio)
+

Set cutoff bandwidth. (Supported only by selected encoders, see +their respective documentation sections.) +

+
+
frame_size integer (encoding,audio)
+

Set audio frame size. +

+

Each submitted frame except the last must contain exactly frame_size +samples per channel. May be 0 when the codec has +CODEC_CAP_VARIABLE_FRAME_SIZE set, in that case the frame size is not +restricted. It is set by some decoders to indicate constant frame +size. +

+
+
frame_number integer
+

Set the frame number. +

+
+
delay integer
+
qcomp float (encoding,video)
+

Set video quantizer scale compression (VBR). It is used as a constant +in the ratecontrol equation. Recommended range for default rc_eq: +0.0-1.0. +

+
+
qblur float (encoding,video)
+

Set video quantizer scale blur (VBR). +

+
+
qmin integer (encoding,video)
+

Set min video quantizer scale (VBR). Must be included between -1 and +69, default value is 2. +

+
+
qmax integer (encoding,video)
+

Set max video quantizer scale (VBR). Must be included between -1 and +1024, default value is 31. +

+
+
qdiff integer (encoding,video)
+

Set max difference between the quantizer scale (VBR). +

+
+
bf integer (encoding,video)
+

Set max number of B frames between non-B-frames. +

+

Must be an integer between -1 and 16. 0 means that B-frames are +disabled. If a value of -1 is used, it will choose an automatic value +depending on the encoder. +

+

Default value is 0. +

+
+
b_qfactor float (encoding,video)
+

Set qp factor between P and B frames. +

+
+
rc_strategy integer (encoding,video)
+

Set ratecontrol method. +

+
+
b_strategy integer (encoding,video)
+

Set strategy to choose between I/P/B-frames. +

+
+
ps integer (encoding,video)
+

Set RTP payload size in bytes. +

+
+
mv_bits integer
+
header_bits integer
+
i_tex_bits integer
+
p_tex_bits integer
+
i_count integer
+
p_count integer
+
skip_count integer
+
misc_bits integer
+
frame_bits integer
+
codec_tag integer
+
bug flags (decoding,video)
+

Workaround not auto detected encoder bugs. +

+

Possible values: +

+
‘autodetect’
+
‘old_msmpeg4’
+

some old lavc generated msmpeg4v3 files (no autodetection) +

+
‘xvid_ilace’
+

Xvid interlacing bug (autodetected if fourcc==XVIX) +

+
‘ump4’
+

(autodetected if fourcc==UMP4) +

+
‘no_padding’
+

padding bug (autodetected) +

+
‘amv’
+
‘ac_vlc’
+

illegal vlc bug (autodetected per fourcc) +

+
‘qpel_chroma’
+
‘std_qpel’
+

old standard qpel (autodetected per fourcc/version) +

+
‘qpel_chroma2’
+
‘direct_blocksize’
+

direct-qpel-blocksize bug (autodetected per fourcc/version) +

+
‘edge’
+

edge padding bug (autodetected per fourcc/version) +

+
‘hpel_chroma’
+
‘dc_clip’
+
‘ms’
+

Workaround various bugs in microsoft broken decoders. +

+
‘trunc’
+

trancated frames +

+
+ +
+
lelim integer (encoding,video)
+

Set single coefficient elimination threshold for luminance (negative +values also consider DC coefficient). +

+
+
celim integer (encoding,video)
+

Set single coefficient elimination threshold for chrominance (negative +values also consider dc coefficient) +

+
+
strict integer (decoding/encoding,audio,video)
+

Specify how strictly to follow the standards. +

+

Possible values: +

+
‘very’
+

strictly conform to an older more strict version of the spec or reference software +

+
‘strict’
+

strictly conform to all the things in the spec no matter what consequences +

+
‘normal’
+
‘unofficial’
+

allow unofficial extensions +

+
‘experimental’
+

allow non standardized experimental things, experimental +(unfinished/work in progress/not well tested) decoders and encoders. +Note: experimental decoders can pose a security risk, do not use this for +decoding untrusted input. +

+
+ +
+
b_qoffset float (encoding,video)
+

Set QP offset between P and B frames. +

+
+
err_detect flags (decoding,audio,video)
+

Set error detection flags. +

+

Possible values: +

+
‘crccheck’
+

verify embedded CRCs +

+
‘bitstream’
+

detect bitstream specification deviations +

+
‘buffer’
+

detect improper bitstream length +

+
‘explode’
+

abort decoding on minor error detection +

+
‘ignore_err’
+

ignore decoding errors, and continue decoding. +This is useful if you want to analyze the content of a video and thus want +everything to be decoded no matter what. This option will not result in a video +that is pleasing to watch in case of errors. +

+
‘careful’
+

consider things that violate the spec and have not been seen in the wild as errors +

+
‘compliant’
+

consider all spec non compliancies as errors +

+
‘aggressive’
+

consider things that a sane encoder should not do as an error +

+
+ +
+
has_b_frames integer
+
block_align integer
+
mpeg_quant integer (encoding,video)
+

Use MPEG quantizers instead of H.263. +

+
+
qsquish float (encoding,video)
+

How to keep quantizer between qmin and qmax (0 = clip, 1 = use +differentiable function). +

+
+
rc_qmod_amp float (encoding,video)
+

Set experimental quantizer modulation. +

+
+
rc_qmod_freq integer (encoding,video)
+

Set experimental quantizer modulation. +

+
+
rc_override_count integer
+
rc_eq string (encoding,video)
+

Set rate control equation. When computing the expression, besides the +standard functions defined in the section ’Expression Evaluation’, the +following functions are available: bits2qp(bits), qp2bits(qp). Also +the following constants are available: iTex pTex tex mv fCode iCount +mcVar var isI isP isB avgQP qComp avgIITex avgPITex avgPPTex avgBPTex +avgTex. +

+
+
maxrate integer (encoding,audio,video)
+

Set max bitrate tolerance (in bits/s). Requires bufsize to be set. +

+
+
minrate integer (encoding,audio,video)
+

Set min bitrate tolerance (in bits/s). Most useful in setting up a CBR +encode. It is of little use elsewise. +

+
+
bufsize integer (encoding,audio,video)
+

Set ratecontrol buffer size (in bits). +

+
+
rc_buf_aggressivity float (encoding,video)
+

Currently useless. +

+
+
i_qfactor float (encoding,video)
+

Set QP factor between P and I frames. +

+
+
i_qoffset float (encoding,video)
+

Set QP offset between P and I frames. +

+
+
rc_init_cplx float (encoding,video)
+

Set initial complexity for 1-pass encoding. +

+
+
dct integer (encoding,video)
+

Set DCT algorithm. +

+

Possible values: +

+
‘auto’
+

autoselect a good one (default) +

+
‘fastint’
+

fast integer +

+
‘int’
+

accurate integer +

+
‘mmx’
+
‘altivec’
+
‘faan’
+

floating point AAN DCT +

+
+ +
+
lumi_mask float (encoding,video)
+

Compress bright areas stronger than medium ones. +

+
+
tcplx_mask float (encoding,video)
+

Set temporal complexity masking. +

+
+
scplx_mask float (encoding,video)
+

Set spatial complexity masking. +

+
+
p_mask float (encoding,video)
+

Set inter masking. +

+
+
dark_mask float (encoding,video)
+

Compress dark areas stronger than medium ones. +

+
+
idct integer (decoding/encoding,video)
+

Select IDCT implementation. +

+

Possible values: +

+
‘auto’
+
‘int’
+
‘simple’
+
‘simplemmx’
+
‘simpleauto’
+

Automatically pick a IDCT compatible with the simple one +

+
+
‘arm’
+
‘altivec’
+
‘sh4’
+
‘simplearm’
+
‘simplearmv5te’
+
‘simplearmv6’
+
‘simpleneon’
+
‘simplealpha’
+
‘ipp’
+
‘xvidmmx’
+
‘faani’
+

floating point AAN IDCT +

+
+ +
+
slice_count integer
+
ec flags (decoding,video)
+

Set error concealment strategy. +

+

Possible values: +

+
‘guess_mvs’
+

iterative motion vector (MV) search (slow) +

+
‘deblock’
+

use strong deblock filter for damaged MBs +

+
‘favor_inter’
+

favor predicting from the previous frame instead of the current +

+
+ +
+
bits_per_coded_sample integer
+
pred integer (encoding,video)
+

Set prediction method. +

+

Possible values: +

+
‘left’
+
‘plane’
+
‘median’
+
+ +
+
aspect rational number (encoding,video)
+

Set sample aspect ratio. +

+
+
sar rational number (encoding,video)
+

Set sample aspect ratio. Alias to aspect. +

+
+
debug flags (decoding/encoding,audio,video,subtitles)
+

Print specific debug info. +

+

Possible values: +

+
‘pict’
+

picture info +

+
‘rc’
+

rate control +

+
‘bitstream’
+
‘mb_type’
+

macroblock (MB) type +

+
‘qp’
+

per-block quantization parameter (QP) +

+
‘dct_coeff’
+
‘green_metadata’
+

display complexity metadata for the upcoming frame, GoP or for a given duration. +

+
+
‘skip’
+
‘startcode’
+
‘er’
+

error recognition +

+
‘mmco’
+

memory management control operations (H.264) +

+
‘bugs’
+
‘buffers’
+

picture buffer allocations +

+
‘thread_ops’
+

threading operations +

+
‘nomc’
+

skip motion compensation +

+
+ +
+
cmp integer (encoding,video)
+

Set full pel me compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
subcmp integer (encoding,video)
+

Set sub pel me compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
mbcmp integer (encoding,video)
+

Set macroblock compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
ildctcmp integer (encoding,video)
+

Set interlaced dct compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
dia_size integer (encoding,video)
+

Set diamond type & size for motion estimation. +

+
‘(1024, INT_MAX)’
+

full motion estimation(slowest) +

+
‘(768, 1024]’
+

umh motion estimation +

+
‘(512, 768]’
+

hex motion estimation +

+
‘(256, 512]’
+

l2s diamond motion estimation +

+
‘[2,256]’
+

var diamond motion estimation +

+
‘(-1, 2)’
+

small diamond motion estimation +

+
‘-1’
+

funny diamond motion estimation +

+
‘(INT_MIN, -1)’
+

sab diamond motion estimation +

+
+ +
+
last_pred integer (encoding,video)
+

Set amount of motion predictors from the previous frame. +

+
+
preme integer (encoding,video)
+

Set pre motion estimation. +

+
+
precmp integer (encoding,video)
+

Set pre motion estimation compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
pre_dia_size integer (encoding,video)
+

Set diamond type & size for motion estimation pre-pass. +

+
+
subq integer (encoding,video)
+

Set sub pel motion estimation quality. +

+
+
dtg_active_format integer
+
me_range integer (encoding,video)
+

Set limit motion vectors range (1023 for DivX player). +

+
+
ibias integer (encoding,video)
+

Set intra quant bias. +

+
+
pbias integer (encoding,video)
+

Set inter quant bias. +

+
+
color_table_id integer
+
global_quality integer (encoding,audio,video)
+
coder integer (encoding,video)
+
+

Possible values: +

+
‘vlc’
+

variable length coder / huffman coder +

+
‘ac’
+

arithmetic coder +

+
‘raw’
+

raw (no encoding) +

+
‘rle’
+

run-length coder +

+
‘deflate’
+

deflate-based coder +

+
+ +
+
context integer (encoding,video)
+

Set context model. +

+
+
slice_flags integer
+
mbd integer (encoding,video)
+

Set macroblock decision algorithm (high quality mode). +

+

Possible values: +

+
‘simple’
+

use mbcmp (default) +

+
‘bits’
+

use fewest bits +

+
‘rd’
+

use best rate distortion +

+
+ +
+
stream_codec_tag integer
+
sc_threshold integer (encoding,video)
+

Set scene change threshold. +

+
+
lmin integer (encoding,video)
+

Set min lagrange factor (VBR). +

+
+
lmax integer (encoding,video)
+

Set max lagrange factor (VBR). +

+
+
nr integer (encoding,video)
+

Set noise reduction. +

+
+
rc_init_occupancy integer (encoding,video)
+

Set number of bits which should be loaded into the rc buffer before +decoding starts. +

+
+
flags2 flags (decoding/encoding,audio,video,subtitles)
+
+

Possible values: +

+
‘fast’
+

Allow non spec compliant speedup tricks. +

+
‘noout’
+

Skip bitstream encoding. +

+
‘ignorecrop’
+

Ignore cropping information from sps. +

+
‘local_header’
+

Place global headers at every keyframe instead of in extradata. +

+
‘chunks’
+

Frame data might be split into multiple chunks. +

+
‘showall’
+

Show all frames before the first keyframe. +

+
‘export_mvs’
+

Export motion vectors into frame side-data (see AV_FRAME_DATA_MOTION_VECTORS) +for codecs that support it. See also doc/examples/export_mvs.c. +

+
‘skip_manual’
+

Do not skip samples and export skip information as frame side data. +

+
‘ass_ro_flush_noop’
+

Do not reset ASS ReadOrder field on flush. +

+
+ +
+
export_side_data flags (decoding/encoding,audio,video,subtitles)
+
+

Possible values: +

+
‘mvs’
+

Export motion vectors into frame side-data (see AV_FRAME_DATA_MOTION_VECTORS) +for codecs that support it. See also doc/examples/export_mvs.c. +

+
‘prft’
+

Export encoder Producer Reference Time into packet side-data (see AV_PKT_DATA_PRFT) +for codecs that support it. +

+
+ +
+
error integer (encoding,video)
+
qns integer (encoding,video)
+

Deprecated, use mpegvideo private options instead. +

+
+
threads integer (decoding/encoding,video)
+

Set the number of threads to be used, in case the selected codec +implementation supports multi-threading. +

+

Possible values: +

+
‘auto, 0’
+

automatically select the number of threads to set +

+
+ +

Default value is ‘auto’. +

+
+
me_threshold integer (encoding,video)
+

Set motion estimation threshold. +

+
+
mb_threshold integer (encoding,video)
+

Set macroblock threshold. +

+
+
dc integer (encoding,video)
+

Set intra_dc_precision. +

+
+
nssew integer (encoding,video)
+

Set nsse weight. +

+
+
skip_top integer (decoding,video)
+

Set number of macroblock rows at the top which are skipped. +

+
+
skip_bottom integer (decoding,video)
+

Set number of macroblock rows at the bottom which are skipped. +

+
+
profile integer (encoding,audio,video)
+
+

Set encoder codec profile. Default value is ‘unknown’. Encoder specific +profiles are documented in the relevant encoder documentation. +

+
+
level integer (encoding,audio,video)
+
+

Possible values: +

+
‘unknown’
+
+ +
+
lowres integer (decoding,audio,video)
+

Decode at 1= 1/2, 2=1/4, 3=1/8 resolutions. +

+
+
skip_threshold integer (encoding,video)
+

Set frame skip threshold. +

+
+
skip_factor integer (encoding,video)
+

Set frame skip factor. +

+
+
skip_exp integer (encoding,video)
+

Set frame skip exponent. +Negative values behave identical to the corresponding positive ones, except +that the score is normalized. +Positive values exist primarily for compatibility reasons and are not so useful. +

+
+
skipcmp integer (encoding,video)
+

Set frame skip compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
border_mask float (encoding,video)
+

Increase the quantizer for macroblocks close to borders. +

+
+
mblmin integer (encoding,video)
+

Set min macroblock lagrange factor (VBR). +

+
+
mblmax integer (encoding,video)
+

Set max macroblock lagrange factor (VBR). +

+
+
mepc integer (encoding,video)
+

Set motion estimation bitrate penalty compensation (1.0 = 256). +

+
+
skip_loop_filter integer (decoding,video)
+
skip_idct integer (decoding,video)
+
skip_frame integer (decoding,video)
+
+

Make decoder discard processing depending on the frame type selected +by the option value. +

+

skip_loop_filter skips frame loop filtering, skip_idct +skips frame IDCT/dequantization, skip_frame skips decoding. +

+

Possible values: +

+
‘none’
+

Discard no frame. +

+
+
‘default’
+

Discard useless frames like 0-sized frames. +

+
+
‘noref’
+

Discard all non-reference frames. +

+
+
‘bidir’
+

Discard all bidirectional frames. +

+
+
‘nokey’
+

Discard all frames excepts keyframes. +

+
+
‘nointra’
+

Discard all frames except I frames. +

+
+
‘all’
+

Discard all frames. +

+
+ +

Default value is ‘default’. +

+
+
bidir_refine integer (encoding,video)
+

Refine the two motion vectors used in bidirectional macroblocks. +

+
+
brd_scale integer (encoding,video)
+

Downscale frames for dynamic B-frame decision. +

+
+
keyint_min integer (encoding,video)
+

Set minimum interval between IDR-frames. +

+
+
refs integer (encoding,video)
+

Set reference frames to consider for motion compensation. +

+
+
chromaoffset integer (encoding,video)
+

Set chroma qp offset from luma. +

+
+
trellis integer (encoding,audio,video)
+

Set rate-distortion optimal quantization. +

+
+
mv0_threshold integer (encoding,video)
+
b_sensitivity integer (encoding,video)
+

Adjust sensitivity of b_frame_strategy 1. +

+
+
compression_level integer (encoding,audio,video)
+
min_prediction_order integer (encoding,audio)
+
max_prediction_order integer (encoding,audio)
+
timecode_frame_start integer (encoding,video)
+

Set GOP timecode frame start number, in non drop frame format. +

+
+
request_channels integer (decoding,audio)
+

Set desired number of audio channels. +

+
+
bits_per_raw_sample integer
+
channel_layout integer (decoding/encoding,audio)
+
+

Possible values: +

+
request_channel_layout integer (decoding,audio)
+
+

Possible values: +

+
rc_max_vbv_use float (encoding,video)
+
rc_min_vbv_use float (encoding,video)
+
ticks_per_frame integer (decoding/encoding,audio,video)
+
color_primaries integer (decoding/encoding,video)
+

Possible values: +

+
‘bt709’
+

BT.709 +

+
‘bt470m’
+

BT.470 M +

+
‘bt470bg’
+

BT.470 BG +

+
‘smpte170m’
+

SMPTE 170 M +

+
‘smpte240m’
+

SMPTE 240 M +

+
‘film’
+

Film +

+
‘bt2020’
+

BT.2020 +

+
‘smpte428’
+
‘smpte428_1’
+

SMPTE ST 428-1 +

+
‘smpte431’
+

SMPTE 431-2 +

+
‘smpte432’
+

SMPTE 432-1 +

+
‘jedec-p22’
+

JEDEC P22 +

+
+ +
+
color_trc integer (decoding/encoding,video)
+

Possible values: +

+
‘bt709’
+

BT.709 +

+
‘gamma22’
+

BT.470 M +

+
‘gamma28’
+

BT.470 BG +

+
‘smpte170m’
+

SMPTE 170 M +

+
‘smpte240m’
+

SMPTE 240 M +

+
‘linear’
+

Linear +

+
‘log’
+
‘log100’
+

Log +

+
‘log_sqrt’
+
‘log316’
+

Log square root +

+
‘iec61966_2_4’
+
‘iec61966-2-4’
+

IEC 61966-2-4 +

+
‘bt1361’
+
‘bt1361e’
+

BT.1361 +

+
‘iec61966_2_1’
+
‘iec61966-2-1’
+

IEC 61966-2-1 +

+
‘bt2020_10’
+
‘bt2020_10bit’
+

BT.2020 - 10 bit +

+
‘bt2020_12’
+
‘bt2020_12bit’
+

BT.2020 - 12 bit +

+
‘smpte2084’
+

SMPTE ST 2084 +

+
‘smpte428’
+
‘smpte428_1’
+

SMPTE ST 428-1 +

+
‘arib-std-b67’
+

ARIB STD-B67 +

+
+ +
+
colorspace integer (decoding/encoding,video)
+

Possible values: +

+
‘rgb’
+

RGB +

+
‘bt709’
+

BT.709 +

+
‘fcc’
+

FCC +

+
‘bt470bg’
+

BT.470 BG +

+
‘smpte170m’
+

SMPTE 170 M +

+
‘smpte240m’
+

SMPTE 240 M +

+
‘ycocg’
+

YCOCG +

+
‘bt2020nc’
+
‘bt2020_ncl’
+

BT.2020 NCL +

+
‘bt2020c’
+
‘bt2020_cl’
+

BT.2020 CL +

+
‘smpte2085’
+

SMPTE 2085 +

+
+ +
+
color_range integer (decoding/encoding,video)
+

If used as input parameter, it serves as a hint to the decoder, which +color_range the input has. +Possible values: +

+
‘tv’
+
‘mpeg’
+

MPEG (219*2^(n-8)) +

+
‘pc’
+
‘jpeg’
+

JPEG (2^n-1) +

+
+ +
+
chroma_sample_location integer (decoding/encoding,video)
+

Possible values: +

+
‘left’
+
‘center’
+
‘topleft’
+
‘top’
+
‘bottomleft’
+
‘bottom’
+
+ +
+
log_level_offset integer
+

Set the log level offset. +

+
+
slices integer (encoding,video)
+

Number of slices, used in parallelized encoding. +

+
+
thread_type flags (decoding/encoding,video)
+

Select which multithreading methods to use. +

+

Use of ‘frame’ will increase decoding delay by one frame per +thread, so clients which cannot provide future frames should not use +it. +

+

Possible values: +

+
‘slice’
+

Decode more than one part of a single frame at once. +

+

Multithreading using slices works only when the video was encoded with +slices. +

+
+
‘frame’
+

Decode more than one frame at once. +

+
+ +

Default value is ‘slice+frame’. +

+
+
audio_service_type integer (encoding,audio)
+

Set audio service type. +

+

Possible values: +

+
‘ma’
+

Main Audio Service +

+
‘ef’
+

Effects +

+
‘vi’
+

Visually Impaired +

+
‘hi’
+

Hearing Impaired +

+
‘di’
+

Dialogue +

+
‘co’
+

Commentary +

+
‘em’
+

Emergency +

+
‘vo’
+

Voice Over +

+
‘ka’
+

Karaoke +

+
+ +
+
request_sample_fmt sample_fmt (decoding,audio)
+

Set sample format audio decoders should prefer. Default value is +none. +

+
+
pkt_timebase rational number
+
sub_charenc encoding (decoding,subtitles)
+

Set the input subtitles character encoding. +

+
+
field_order field_order (video)
+

Set/override the field order of the video. +Possible values: +

+
‘progressive’
+

Progressive video +

+
‘tt’
+

Interlaced video, top field coded and displayed first +

+
‘bb’
+

Interlaced video, bottom field coded and displayed first +

+
‘tb’
+

Interlaced video, top coded first, bottom displayed first +

+
‘bt’
+

Interlaced video, bottom coded first, top displayed first +

+
+ +
+
skip_alpha bool (decoding,video)
+

Set to 1 to disable processing alpha (transparency). This works like the +‘gray’ flag in the flags option which skips chroma information +instead of alpha. Default is 0. +

+
+
codec_whitelist list (input)
+

"," separated list of allowed decoders. By default all are allowed. +

+
+
dump_separator string (input)
+

Separator used to separate the fields printed on the command line about the +Stream parameters. +For example, to separate the fields with newlines and indentation: +

+
ffprobe -dump_separator "
+                          "  -i ~/videos/matrixbench_mpeg2.mpg
+
+ +
+
max_pixels integer (decoding/encoding,video)
+

Maximum number of pixels per image. This value can be used to avoid out of +memory failures due to large images. +

+
+
apply_cropping bool (decoding,video)
+

Enable cropping if cropping parameters are multiples of the required +alignment for the left and top parameters. If the alignment is not met the +cropping will be partially applied to maintain alignment. +Default is 1 (enabled). +Note: The required alignment depends on if AV_CODEC_FLAG_UNALIGNED is set and the +CPU. AV_CODEC_FLAG_UNALIGNED cannot be changed from the command line. Also hardware +decoders will not apply left/top Cropping. +

+ +
+
+ + + +

3 Decoders

+ +

Decoders are configured elements in FFmpeg which allow the decoding of +multimedia streams. +

+

When you configure your FFmpeg build, all the supported native decoders +are enabled by default. Decoders requiring an external library must be enabled +manually via the corresponding --enable-lib option. You can list all +available decoders using the configure option --list-decoders. +

+

You can disable all the decoders with the configure option +--disable-decoders and selectively enable / disable single decoders +with the options --enable-decoder=DECODER / +--disable-decoder=DECODER. +

+

The option -decoders of the ff* tools will display the list of +enabled decoders. +

+ + +

4 Video Decoders

+ +

A description of some of the currently available video decoders +follows. +

+ +

4.1 rawvideo

+ +

Raw video decoder. +

+

This decoder decodes rawvideo streams. +

+ +

4.1.1 Options

+ +
+
top top_field_first
+

Specify the assumed field type of the input video. +

+
-1
+

the video is assumed to be progressive (default) +

+
0
+

bottom-field-first is assumed +

+
1
+

top-field-first is assumed +

+
+ +
+
+ + +

4.2 libdav1d

+ +

dav1d AV1 decoder. +

+

libdav1d allows libavcodec to decode the AOMedia Video 1 (AV1) codec. +Requires the presence of the libdav1d headers and library during configuration. +You need to explicitly configure the build with --enable-libdav1d. +

+ +

4.2.1 Options

+ +

The following options are supported by the libdav1d wrapper. +

+
+
framethreads
+

Set amount of frame threads to use during decoding. The default value is 0 (autodetect). +

+
+
tilethreads
+

Set amount of tile threads to use during decoding. The default value is 0 (autodetect). +

+
+
filmgrain
+

Apply film grain to the decoded video if present in the bitstream. Defaults to the +internal default of the library. +

+
+
oppoint
+

Select an operating point of a scalable AV1 bitstream (0 - 31). Defaults to the +internal default of the library. +

+
+
alllayers
+

Output all spatial layers of a scalable AV1 bitstream. The default value is false. +

+
+
+ + +

4.3 libdavs2

+ +

AVS2-P2/IEEE1857.4 video decoder wrapper. +

+

This decoder allows libavcodec to decode AVS2 streams with davs2 library. +

+ + +

5 Audio Decoders

+ +

A description of some of the currently available audio decoders +follows. +

+ +

5.1 ac3

+ +

AC-3 audio decoder. +

+

This decoder implements part of ATSC A/52:2010 and ETSI TS 102 366, as well as +the undocumented RealAudio 3 (a.k.a. dnet). +

+ +

5.1.1 AC-3 Decoder Options

+ +
+
-drc_scale value
+

Dynamic Range Scale Factor. The factor to apply to dynamic range values +from the AC-3 stream. This factor is applied exponentially. +There are 3 notable scale factor ranges: +

+
drc_scale == 0
+

DRC disabled. Produces full range audio. +

+
0 < drc_scale <= 1
+

DRC enabled. Applies a fraction of the stream DRC value. +Audio reproduction is between full range and full compression. +

+
drc_scale > 1
+

DRC enabled. Applies drc_scale asymmetrically. +Loud sounds are fully compressed. Soft sounds are enhanced. +

+
+ +
+
+ + +

5.2 flac

+ +

FLAC audio decoder. +

+

This decoder aims to implement the complete FLAC specification from Xiph. +

+ +

5.2.1 FLAC Decoder options

+ +
+
-use_buggy_lpc
+

The lavc FLAC encoder used to produce buggy streams with high lpc values +(like the default value). This option makes it possible to decode such streams +correctly by using lavc’s old buggy lpc logic for decoding. +

+
+
+ + +

5.3 ffwavesynth

+ +

Internal wave synthesizer. +

+

This decoder generates wave patterns according to predefined sequences. Its +use is purely internal and the format of the data it accepts is not publicly +documented. +

+ +

5.4 libcelt

+ +

libcelt decoder wrapper. +

+

libcelt allows libavcodec to decode the Xiph CELT ultra-low delay audio codec. +Requires the presence of the libcelt headers and library during configuration. +You need to explicitly configure the build with --enable-libcelt. +

+ +

5.5 libgsm

+ +

libgsm decoder wrapper. +

+

libgsm allows libavcodec to decode the GSM full rate audio codec. Requires +the presence of the libgsm headers and library during configuration. You need +to explicitly configure the build with --enable-libgsm. +

+

This decoder supports both the ordinary GSM and the Microsoft variant. +

+ +

5.6 libilbc

+ +

libilbc decoder wrapper. +

+

libilbc allows libavcodec to decode the Internet Low Bitrate Codec (iLBC) +audio codec. Requires the presence of the libilbc headers and library during +configuration. You need to explicitly configure the build with +--enable-libilbc. +

+ +

5.6.1 Options

+ +

The following option is supported by the libilbc wrapper. +

+
+
enhance
+
+

Enable the enhancement of the decoded audio when set to 1. The default +value is 0 (disabled). +

+
+
+ + +

5.7 libopencore-amrnb

+ +

libopencore-amrnb decoder wrapper. +

+

libopencore-amrnb allows libavcodec to decode the Adaptive Multi-Rate +Narrowband audio codec. Using it requires the presence of the +libopencore-amrnb headers and library during configuration. You need to +explicitly configure the build with --enable-libopencore-amrnb. +

+

An FFmpeg native decoder for AMR-NB exists, so users can decode AMR-NB +without this library. +

+ +

5.8 libopencore-amrwb

+ +

libopencore-amrwb decoder wrapper. +

+

libopencore-amrwb allows libavcodec to decode the Adaptive Multi-Rate +Wideband audio codec. Using it requires the presence of the +libopencore-amrwb headers and library during configuration. You need to +explicitly configure the build with --enable-libopencore-amrwb. +

+

An FFmpeg native decoder for AMR-WB exists, so users can decode AMR-WB +without this library. +

+ +

5.9 libopus

+ +

libopus decoder wrapper. +

+

libopus allows libavcodec to decode the Opus Interactive Audio Codec. +Requires the presence of the libopus headers and library during +configuration. You need to explicitly configure the build with +--enable-libopus. +

+

An FFmpeg native decoder for Opus exists, so users can decode Opus +without this library. +

+ + +

6 Subtitles Decoders

+ + +

6.1 libaribb24

+ +

ARIB STD-B24 caption decoder. +

+

Implements profiles A and C of the ARIB STD-B24 standard. +

+ +

6.1.1 libaribb24 Decoder Options

+ +
+
-aribb24-base-path path
+

Sets the base path for the libaribb24 library. This is utilized for reading of +configuration files (for custom unicode conversions), and for dumping of +non-text symbols as images under that location. +

+

Unset by default. +

+
+
-aribb24-skip-ruby-text boolean
+

Tells the decoder wrapper to skip text blocks that contain half-height ruby +text. +

+

Enabled by default. +

+
+
+ + +

6.2 dvbsub

+ + +

6.2.1 Options

+ +
+
compute_clut
+
+
-1
+

Compute clut if no matching CLUT is in the stream. +

+
0
+

Never compute CLUT +

+
1
+

Always compute CLUT and override the one provided in the stream. +

+
+
+
dvb_substream
+

Selects the dvb substream, or all substreams if -1 which is default. +

+
+
+ + +

6.3 dvdsub

+ +

This codec decodes the bitmap subtitles used in DVDs; the same subtitles can +also be found in VobSub file pairs and in some Matroska files. +

+ +

6.3.1 Options

+ +
+
palette
+

Specify the global palette used by the bitmaps. When stored in VobSub, the +palette is normally specified in the index file; in Matroska, the palette is +stored in the codec extra-data in the same format as in VobSub. In DVDs, the +palette is stored in the IFO file, and therefore not available when reading +from dumped VOB files. +

+

The format for this option is a string containing 16 24-bits hexadecimal +numbers (without 0x prefix) separated by commas, for example 0d00ee, +ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1, +7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b. +

+
+
ifo_palette
+

Specify the IFO file from which the global palette is obtained. +(experimental) +

+
+
forced_subs_only
+

Only decode subtitle entries marked as forced. Some titles have forced +and non-forced subtitles in the same track. Setting this flag to 1 +will only keep the forced subtitles. Default value is 0. +

+
+ + +

6.4 libzvbi-teletext

+ +

Libzvbi allows libavcodec to decode DVB teletext pages and DVB teletext +subtitles. Requires the presence of the libzvbi headers and library during +configuration. You need to explicitly configure the build with +--enable-libzvbi. +

+ +

6.4.1 Options

+ +
+
txt_page
+

List of teletext page numbers to decode. Pages that do not match the specified +list are dropped. You may use the special * string to match all pages, +or subtitle to match all subtitle pages. +Default value is *. +

+
txt_default_region
+

Set default character set used for decoding, a value between 0 and 87 (see +ETS 300 706, Section 15, Table 32). Default value is -1, which does not +override the libzvbi default. This option is needed for some legacy level 1.0 +transmissions which cannot signal the proper charset. +

+
txt_chop_top
+

Discards the top teletext line. Default value is 1. +

+
txt_format
+

Specifies the format of the decoded subtitles. +

+
bitmap
+

The default format, you should use this for teletext pages, because certain +graphics and colors cannot be expressed in simple text or even ASS. +

+
text
+

Simple text based output without formatting. +

+
ass
+

Formatted ASS output, subtitle pages and teletext pages are returned in +different styles, subtitle pages are stripped down to text, but an effort is +made to keep the text alignment and the formatting. +

+
+
+
txt_left
+

X offset of generated bitmaps, default is 0. +

+
txt_top
+

Y offset of generated bitmaps, default is 0. +

+
txt_chop_spaces
+

Chops leading and trailing spaces and removes empty lines from the generated +text. This option is useful for teletext based subtitles where empty spaces may +be present at the start or at the end of the lines or empty lines may be +present between the subtitle lines because of double-sized teletext characters. +Default value is 1. +

+
txt_duration
+

Sets the display duration of the decoded teletext pages or subtitles in +milliseconds. Default value is -1 which means infinity or until the next +subtitle event comes. +

+
txt_transparent
+

Force transparent background of the generated teletext bitmaps. Default value +is 0 which means an opaque background. +

+
txt_opacity
+

Sets the opacity (0-255) of the teletext background. If +txt_transparent is not set, it only affects characters between a start +box and an end box, typically subtitles. Default value is 0 if +txt_transparent is set, 255 otherwise. +

+
+
+ + +

7 Encoders

+ +

Encoders are configured elements in FFmpeg which allow the encoding of +multimedia streams. +

+

When you configure your FFmpeg build, all the supported native encoders +are enabled by default. Encoders requiring an external library must be enabled +manually via the corresponding --enable-lib option. You can list all +available encoders using the configure option --list-encoders. +

+

You can disable all the encoders with the configure option +--disable-encoders and selectively enable / disable single encoders +with the options --enable-encoder=ENCODER / +--disable-encoder=ENCODER. +

+

The option -encoders of the ff* tools will display the list of +enabled encoders. +

+ + +

8 Audio Encoders

+ +

A description of some of the currently available audio encoders +follows. +

+ +

8.1 aac

+ +

Advanced Audio Coding (AAC) encoder. +

+

This encoder is the default AAC encoder, natively implemented into FFmpeg. +

+ +

8.1.1 Options

+ +
+
b
+

Set bit rate in bits/s. Setting this automatically activates constant bit rate +(CBR) mode. If this option is unspecified it is set to 128kbps. +

+
+
q
+

Set quality for variable bit rate (VBR) mode. This option is valid only using +the ffmpeg command-line tool. For library interface users, use +global_quality. +

+
+
cutoff
+

Set cutoff frequency. If unspecified will allow the encoder to dynamically +adjust the cutoff to improve clarity on low bitrates. +

+
+
aac_coder
+

Set AAC encoder coding method. Possible values: +

+
+
‘twoloop’
+

Two loop searching (TLS) method. +

+

This method first sets quantizers depending on band thresholds and then tries +to find an optimal combination by adding or subtracting a specific value from +all quantizers and adjusting some individual quantizer a little. Will tune +itself based on whether aac_is, aac_ms and aac_pns +are enabled. +

+
+
‘anmr’
+

Average noise to mask ratio (ANMR) trellis-based solution. +

+

This is an experimental coder which currently produces a lower quality, is more +unstable and is slower than the default twoloop coder but has potential. +Currently has no support for the aac_is or aac_pns options. +Not currently recommended. +

+
+
‘fast’
+

Constant quantizer method. +

+

Uses a cheaper version of twoloop algorithm that doesn’t try to do as many +clever adjustments. Worse with low bitrates (less than 64kbps), but is better +and much faster at higher bitrates. +This is the default choice for a coder +

+
+
+ +
+
aac_ms
+

Sets mid/side coding mode. The default value of "auto" will automatically use +M/S with bands which will benefit from such coding. Can be forced for all bands +using the value "enable", which is mainly useful for debugging or disabled using +"disable". +

+
+
aac_is
+

Sets intensity stereo coding tool usage. By default, it’s enabled and will +automatically toggle IS for similar pairs of stereo bands if it’s beneficial. +Can be disabled for debugging by setting the value to "disable". +

+
+
aac_pns
+

Uses perceptual noise substitution to replace low entropy high frequency bands +with imperceptible white noise during the decoding process. By default, it’s +enabled, but can be disabled for debugging purposes by using "disable". +

+
+
aac_tns
+

Enables the use of a multitap FIR filter which spans through the high frequency +bands to hide quantization noise during the encoding process and is reverted +by the decoder. As well as decreasing unpleasant artifacts in the high range +this also reduces the entropy in the high bands and allows for more bits to +be used by the mid-low bands. By default it’s enabled but can be disabled for +debugging by setting the option to "disable". +

+
+
aac_ltp
+

Enables the use of the long term prediction extension which increases coding +efficiency in very low bandwidth situations such as encoding of voice or +solo piano music by extending constant harmonic peaks in bands throughout +frames. This option is implied by profile:a aac_low and is incompatible with +aac_pred. Use in conjunction with -ar to decrease the samplerate. +

+
+
aac_pred
+

Enables the use of a more traditional style of prediction where the spectral +coefficients transmitted are replaced by the difference of the current +coefficients minus the previous "predicted" coefficients. In theory and sometimes +in practice this can improve quality for low to mid bitrate audio. +This option implies the aac_main profile and is incompatible with aac_ltp. +

+
+
profile
+

Sets the encoding profile, possible values: +

+
+
‘aac_low’
+

The default, AAC "Low-complexity" profile. Is the most compatible and produces +decent quality. +

+
+
‘mpeg2_aac_low’
+

Equivalent to -profile:a aac_low -aac_pns 0. PNS was introduced with the +MPEG4 specifications. +

+
+
‘aac_ltp’
+

Long term prediction profile, is enabled by and will enable the aac_ltp +option. Introduced in MPEG4. +

+
+
‘aac_main’
+

Main-type prediction profile, is enabled by and will enable the aac_pred +option. Introduced in MPEG2. +

+
+
+

If this option is unspecified it is set to ‘aac_low’. +

+
+ + +

8.2 ac3 and ac3_fixed

+ +

AC-3 audio encoders. +

+

These encoders implement part of ATSC A/52:2010 and ETSI TS 102 366, as well as +the undocumented RealAudio 3 (a.k.a. dnet). +

+

The ac3 encoder uses floating-point math, while the ac3_fixed +encoder only uses fixed-point integer math. This does not mean that one is +always faster, just that one or the other may be better suited to a +particular system. The floating-point encoder will generally produce better +quality audio for a given bitrate. The ac3_fixed encoder is not the +default codec for any of the output formats, so it must be specified explicitly +using the option -acodec ac3_fixed in order to use it. +

+ +

8.2.1 AC-3 Metadata

+ +

The AC-3 metadata options are used to set parameters that describe the audio, +but in most cases do not affect the audio encoding itself. Some of the options +do directly affect or influence the decoding and playback of the resulting +bitstream, while others are just for informational purposes. A few of the +options will add bits to the output stream that could otherwise be used for +audio data, and will thus affect the quality of the output. Those will be +indicated accordingly with a note in the option list below. +

+

These parameters are described in detail in several publicly-available +documents. +

+ + +

8.2.1.1 Metadata Control Options

+ +
+
-per_frame_metadata boolean
+

Allow Per-Frame Metadata. Specifies if the encoder should check for changing +metadata for each frame. +

+
0
+

The metadata values set at initialization will be used for every frame in the +stream. (default) +

+
1
+

Metadata values can be changed before encoding each frame. +

+
+ +
+
+ + +

8.2.1.2 Downmix Levels

+ +
+
-center_mixlev level
+

Center Mix Level. The amount of gain the decoder should apply to the center +channel when downmixing to stereo. This field will only be written to the +bitstream if a center channel is present. The value is specified as a scale +factor. There are 3 valid values: +

+
0.707
+

Apply -3dB gain +

+
0.595
+

Apply -4.5dB gain (default) +

+
0.500
+

Apply -6dB gain +

+
+ +
+
-surround_mixlev level
+

Surround Mix Level. The amount of gain the decoder should apply to the surround +channel(s) when downmixing to stereo. This field will only be written to the +bitstream if one or more surround channels are present. The value is specified +as a scale factor. There are 3 valid values: +

+
0.707
+

Apply -3dB gain +

+
0.500
+

Apply -6dB gain (default) +

+
0.000
+

Silence Surround Channel(s) +

+
+ +
+
+ + +

8.2.1.3 Audio Production Information

+

Audio Production Information is optional information describing the mixing +environment. Either none or both of the fields are written to the bitstream. +

+
+
-mixing_level number
+

Mixing Level. Specifies peak sound pressure level (SPL) in the production +environment when the mix was mastered. Valid values are 80 to 111, or -1 for +unknown or not indicated. The default value is -1, but that value cannot be +used if the Audio Production Information is written to the bitstream. Therefore, +if the room_type option is not the default value, the mixing_level +option must not be -1. +

+
+
-room_type type
+

Room Type. Describes the equalization used during the final mixing session at +the studio or on the dubbing stage. A large room is a dubbing stage with the +industry standard X-curve equalization; a small room has flat equalization. +This field will not be written to the bitstream if both the mixing_level +option and the room_type option have the default values. +

+
0
+
notindicated
+

Not Indicated (default) +

+
1
+
large
+

Large Room +

+
2
+
small
+

Small Room +

+
+ +
+
+ + +

8.2.1.4 Other Metadata Options

+ +
+
-copyright boolean
+

Copyright Indicator. Specifies whether a copyright exists for this audio. +

+
0
+
off
+

No Copyright Exists (default) +

+
1
+
on
+

Copyright Exists +

+
+ +
+
-dialnorm value
+

Dialogue Normalization. Indicates how far the average dialogue level of the +program is below digital 100% full scale (0 dBFS). This parameter determines a +level shift during audio reproduction that sets the average volume of the +dialogue to a preset level. The goal is to match volume level between program +sources. A value of -31dB will result in no volume level change, relative to +the source volume, during audio reproduction. Valid values are whole numbers in +the range -31 to -1, with -31 being the default. +

+
+
-dsur_mode mode
+

Dolby Surround Mode. Specifies whether the stereo signal uses Dolby Surround +(Pro Logic). This field will only be written to the bitstream if the audio +stream is stereo. Using this option does NOT mean the encoder will actually +apply Dolby Surround processing. +

+
0
+
notindicated
+

Not Indicated (default) +

+
1
+
off
+

Not Dolby Surround Encoded +

+
2
+
on
+

Dolby Surround Encoded +

+
+ +
+
-original boolean
+

Original Bit Stream Indicator. Specifies whether this audio is from the +original source and not a copy. +

+
0
+
off
+

Not Original Source +

+
1
+
on
+

Original Source (default) +

+
+ +
+
+ + +

8.2.2 Extended Bitstream Information

+

The extended bitstream options are part of the Alternate Bit Stream Syntax as +specified in Annex D of the A/52:2010 standard. It is grouped into 2 parts. +If any one parameter in a group is specified, all values in that group will be +written to the bitstream. Default values are used for those that are written +but have not been specified. If the mixing levels are written, the decoder +will use these values instead of the ones specified in the center_mixlev +and surround_mixlev options if it supports the Alternate Bit Stream +Syntax. +

+ +

8.2.2.1 Extended Bitstream Information - Part 1

+ +
+
-dmix_mode mode
+

Preferred Stereo Downmix Mode. Allows the user to select either Lt/Rt +(Dolby Surround) or Lo/Ro (normal stereo) as the preferred stereo downmix mode. +

+
0
+
notindicated
+

Not Indicated (default) +

+
1
+
ltrt
+

Lt/Rt Downmix Preferred +

+
2
+
loro
+

Lo/Ro Downmix Preferred +

+
+ +
+
-ltrt_cmixlev level
+

Lt/Rt Center Mix Level. The amount of gain the decoder should apply to the +center channel when downmixing to stereo in Lt/Rt mode. +

+
1.414
+

Apply +3dB gain +

+
1.189
+

Apply +1.5dB gain +

+
1.000
+

Apply 0dB gain +

+
0.841
+

Apply -1.5dB gain +

+
0.707
+

Apply -3.0dB gain +

+
0.595
+

Apply -4.5dB gain (default) +

+
0.500
+

Apply -6.0dB gain +

+
0.000
+

Silence Center Channel +

+
+ +
+
-ltrt_surmixlev level
+

Lt/Rt Surround Mix Level. The amount of gain the decoder should apply to the +surround channel(s) when downmixing to stereo in Lt/Rt mode. +

+
0.841
+

Apply -1.5dB gain +

+
0.707
+

Apply -3.0dB gain +

+
0.595
+

Apply -4.5dB gain +

+
0.500
+

Apply -6.0dB gain (default) +

+
0.000
+

Silence Surround Channel(s) +

+
+ +
+
-loro_cmixlev level
+

Lo/Ro Center Mix Level. The amount of gain the decoder should apply to the +center channel when downmixing to stereo in Lo/Ro mode. +

+
1.414
+

Apply +3dB gain +

+
1.189
+

Apply +1.5dB gain +

+
1.000
+

Apply 0dB gain +

+
0.841
+

Apply -1.5dB gain +

+
0.707
+

Apply -3.0dB gain +

+
0.595
+

Apply -4.5dB gain (default) +

+
0.500
+

Apply -6.0dB gain +

+
0.000
+

Silence Center Channel +

+
+ +
+
-loro_surmixlev level
+

Lo/Ro Surround Mix Level. The amount of gain the decoder should apply to the +surround channel(s) when downmixing to stereo in Lo/Ro mode. +

+
0.841
+

Apply -1.5dB gain +

+
0.707
+

Apply -3.0dB gain +

+
0.595
+

Apply -4.5dB gain +

+
0.500
+

Apply -6.0dB gain (default) +

+
0.000
+

Silence Surround Channel(s) +

+
+ +
+
+ + +

8.2.2.2 Extended Bitstream Information - Part 2

+ +
+
-dsurex_mode mode
+

Dolby Surround EX Mode. Indicates whether the stream uses Dolby Surround EX +(7.1 matrixed to 5.1). Using this option does NOT mean the encoder will actually +apply Dolby Surround EX processing. +

+
0
+
notindicated
+

Not Indicated (default) +

+
1
+
on
+

Dolby Surround EX Off +

+
2
+
off
+

Dolby Surround EX On +

+
+ +
+
-dheadphone_mode mode
+

Dolby Headphone Mode. Indicates whether the stream uses Dolby Headphone +encoding (multi-channel matrixed to 2.0 for use with headphones). Using this +option does NOT mean the encoder will actually apply Dolby Headphone +processing. +

+
0
+
notindicated
+

Not Indicated (default) +

+
1
+
on
+

Dolby Headphone Off +

+
2
+
off
+

Dolby Headphone On +

+
+ +
+
-ad_conv_type type
+

A/D Converter Type. Indicates whether the audio has passed through HDCD A/D +conversion. +

+
0
+
standard
+

Standard A/D Converter (default) +

+
1
+
hdcd
+

HDCD A/D Converter +

+
+ +
+
+ + +

8.2.3 Other AC-3 Encoding Options

+ +
+
-stereo_rematrixing boolean
+

Stereo Rematrixing. Enables/Disables use of rematrixing for stereo input. This +is an optional AC-3 feature that increases quality by selectively encoding +the left/right channels as mid/side. This option is enabled by default, and it +is highly recommended that it be left as enabled except for testing purposes. +

+
+
cutoff frequency
+

Set lowpass cutoff frequency. If unspecified, the encoder selects a default +determined by various other encoding parameters. +

+
+
+ + +

8.2.4 Floating-Point-Only AC-3 Encoding Options

+ +

These options are only valid for the floating-point encoder and do not exist +for the fixed-point encoder due to the corresponding features not being +implemented in fixed-point. +

+
+
-channel_coupling boolean
+

Enables/Disables use of channel coupling, which is an optional AC-3 feature +that increases quality by combining high frequency information from multiple +channels into a single channel. The per-channel high frequency information is +sent with less accuracy in both the frequency and time domains. This allows +more bits to be used for lower frequencies while preserving enough information +to reconstruct the high frequencies. This option is enabled by default for the +floating-point encoder and should generally be left as enabled except for +testing purposes or to increase encoding speed. +

+
-1
+
auto
+

Selected by Encoder (default) +

+
0
+
off
+

Disable Channel Coupling +

+
1
+
on
+

Enable Channel Coupling +

+
+ +
+
-cpl_start_band number
+

Coupling Start Band. Sets the channel coupling start band, from 1 to 15. If a +value higher than the bandwidth is used, it will be reduced to 1 less than the +coupling end band. If auto is used, the start band will be determined by +the encoder based on the bit rate, sample rate, and channel layout. This option +has no effect if channel coupling is disabled. +

+
-1
+
auto
+

Selected by Encoder (default) +

+
+ +
+
+ + +

8.3 flac

+ +

FLAC (Free Lossless Audio Codec) Encoder +

+ +

8.3.1 Options

+ +

The following options are supported by FFmpeg’s flac encoder. +

+
+
compression_level
+

Sets the compression level, which chooses defaults for many other options +if they are not set explicitly. Valid values are from 0 to 12, 5 is the +default. +

+
+
frame_size
+

Sets the size of the frames in samples per channel. +

+
+
lpc_coeff_precision
+

Sets the LPC coefficient precision, valid values are from 1 to 15, 15 is the +default. +

+
+
lpc_type
+

Sets the first stage LPC algorithm +

+
‘none’
+

LPC is not used +

+
+
‘fixed’
+

fixed LPC coefficients +

+
+
‘levinson’
+
‘cholesky’
+
+ +
+
lpc_passes
+

Number of passes to use for Cholesky factorization during LPC analysis +

+
+
min_partition_order
+

The minimum partition order +

+
+
max_partition_order
+

The maximum partition order +

+
+
prediction_order_method
+
+
‘estimation’
+
‘2level’
+
‘4level’
+
‘8level’
+
‘search’
+

Bruteforce search +

+
‘log’
+
+ +
+
ch_mode
+

Channel mode +

+
‘auto’
+

The mode is chosen automatically for each frame +

+
‘indep’
+

Channels are independently coded +

+
‘left_side’
+
‘right_side’
+
‘mid_side’
+
+ +
+
exact_rice_parameters
+

Chooses if rice parameters are calculated exactly or approximately. +if set to 1 then they are chosen exactly, which slows the code down slightly and +improves compression slightly. +

+
+
multi_dim_quant
+

Multi Dimensional Quantization. If set to 1 then a 2nd stage LPC algorithm is +applied after the first stage to finetune the coefficients. This is quite slow +and slightly improves compression. +

+
+
+ + +

8.4 opus

+ +

Opus encoder. +

+

This is a native FFmpeg encoder for the Opus format. Currently its in development and +only implements the CELT part of the codec. Its quality is usually worse and at best +is equal to the libopus encoder. +

+ +

8.4.1 Options

+ +
+
b
+

Set bit rate in bits/s. If unspecified it uses the number of channels and the layout +to make a good guess. +

+
+
opus_delay
+

Sets the maximum delay in milliseconds. Lower delays than 20ms will very quickly +decrease quality. +

+
+ + +

8.5 libfdk_aac

+ +

libfdk-aac AAC (Advanced Audio Coding) encoder wrapper. +

+

The libfdk-aac library is based on the Fraunhofer FDK AAC code from +the Android project. +

+

Requires the presence of the libfdk-aac headers and library during +configuration. You need to explicitly configure the build with +--enable-libfdk-aac. The library is also incompatible with GPL, +so if you allow the use of GPL, you should configure with +--enable-gpl --enable-nonfree --enable-libfdk-aac. +

+

This encoder has support for the AAC-HE profiles. +

+

VBR encoding, enabled through the vbr or flags ++qscale options, is experimental and only works with some +combinations of parameters. +

+

Support for encoding 7.1 audio is only available with libfdk-aac 0.1.3 or +higher. +

+

For more information see the fdk-aac project at +http://sourceforge.net/p/opencore-amr/fdk-aac/. +

+ +

8.5.1 Options

+ +

The following options are mapped on the shared FFmpeg codec options. +

+
+
b
+

Set bit rate in bits/s. If the bitrate is not explicitly specified, it +is automatically set to a suitable value depending on the selected +profile. +

+

In case VBR mode is enabled the option is ignored. +

+
+
ar
+

Set audio sampling rate (in Hz). +

+
+
channels
+

Set the number of audio channels. +

+
+
flags +qscale
+

Enable fixed quality, VBR (Variable Bit Rate) mode. +Note that VBR is implicitly enabled when the vbr value is +positive. +

+
+
cutoff
+

Set cutoff frequency. If not specified (or explicitly set to 0) it +will use a value automatically computed by the library. Default value +is 0. +

+
+
profile
+

Set audio profile. +

+

The following profiles are recognized: +

+
‘aac_low’
+

Low Complexity AAC (LC) +

+
+
‘aac_he’
+

High Efficiency AAC (HE-AAC) +

+
+
‘aac_he_v2’
+

High Efficiency AAC version 2 (HE-AACv2) +

+
+
‘aac_ld’
+

Low Delay AAC (LD) +

+
+
‘aac_eld’
+

Enhanced Low Delay AAC (ELD) +

+
+ +

If not specified it is set to ‘aac_low’. +

+
+ +

The following are private options of the libfdk_aac encoder. +

+
+
afterburner
+

Enable afterburner feature if set to 1, disabled if set to 0. This +improves the quality but also the required processing power. +

+

Default value is 1. +

+
+
eld_sbr
+

Enable SBR (Spectral Band Replication) for ELD if set to 1, disabled +if set to 0. +

+

Default value is 0. +

+
+
eld_v2
+

Enable ELDv2 (LD-MPS extension for ELD stereo signals) for ELDv2 if set to 1, +disabled if set to 0. +

+

Note that option is available when fdk-aac version (AACENCODER_LIB_VL0.AACENCODER_LIB_VL1.AACENCODER_LIB_VL2) > (4.0.0). +

+

Default value is 0. +

+
+
signaling
+

Set SBR/PS signaling style. +

+

It can assume one of the following values: +

+
‘default’
+

choose signaling implicitly (explicit hierarchical by default, +implicit if global header is disabled) +

+
+
‘implicit’
+

implicit backwards compatible signaling +

+
+
‘explicit_sbr’
+

explicit SBR, implicit PS signaling +

+
+
‘explicit_hierarchical’
+

explicit hierarchical signaling +

+
+ +

Default value is ‘default’. +

+
+
latm
+

Output LATM/LOAS encapsulated data if set to 1, disabled if set to 0. +

+

Default value is 0. +

+
+
header_period
+

Set StreamMuxConfig and PCE repetition period (in frames) for sending +in-band configuration buffers within LATM/LOAS transport layer. +

+

Must be a 16-bits non-negative integer. +

+

Default value is 0. +

+
+
vbr
+

Set VBR mode, from 1 to 5. 1 is lowest quality (though still pretty +good) and 5 is highest quality. A value of 0 will disable VBR, and CBR +(Constant Bit Rate) is enabled. +

+

Currently only the ‘aac_low’ profile supports VBR encoding. +

+

VBR modes 1-5 correspond to roughly the following average bit rates: +

+
+
‘1’
+

32 kbps/channel +

+
‘2’
+

40 kbps/channel +

+
‘3’
+

48-56 kbps/channel +

+
‘4’
+

64 kbps/channel +

+
‘5’
+

about 80-96 kbps/channel +

+
+ +

Default value is 0. +

+
+ + +

8.5.2 Examples

+ +
    +
  • Use ffmpeg to convert an audio file to VBR AAC in an M4A (MP4) +container: +
    +
    ffmpeg -i input.wav -codec:a libfdk_aac -vbr 3 output.m4a
+
    + +
  • Use ffmpeg to convert an audio file to CBR 64k kbps AAC, using the +High-Efficiency AAC profile: +
    +
    ffmpeg -i input.wav -c:a libfdk_aac -profile:a aac_he -b:a 64k output.m4a
+
    +
+ + +

8.6 libmp3lame

+ +

LAME (Lame Ain’t an MP3 Encoder) MP3 encoder wrapper. +

+

Requires the presence of the libmp3lame headers and library during +configuration. You need to explicitly configure the build with +--enable-libmp3lame. +

+

See libshine for a fixed-point MP3 encoder, although with a +lower quality. +

+ +

8.6.1 Options

+ +

The following options are supported by the libmp3lame wrapper. The +lame-equivalent of the options are listed in parentheses. +

+
+
b (-b)
+

Set bitrate expressed in bits/s for CBR or ABR. LAME bitrate is +expressed in kilobits/s. +

+
+
q (-V)
+

Set constant quality setting for VBR. This option is valid only +using the ffmpeg command-line tool. For library interface +users, use global_quality. +

+
+
compression_level (-q)
+

Set algorithm quality. Valid arguments are integers in the 0-9 range, +with 0 meaning highest quality but slowest, and 9 meaning fastest +while producing the worst quality. +

+
+
cutoff (--lowpass)
+

Set lowpass cutoff frequency. If unspecified, the encoder dynamically +adjusts the cutoff. +

+
+
reservoir
+

Enable use of bit reservoir when set to 1. Default value is 1. LAME +has this enabled by default, but can be overridden by use +--nores option. +

+
+
joint_stereo (-m j)
+

Enable the encoder to use (on a frame by frame basis) either L/R +stereo or mid/side stereo. Default value is 1. +

+
+
abr (--abr)
+

Enable the encoder to use ABR when set to 1. The lame +--abr sets the target bitrate, while this options only +tells FFmpeg to use ABR still relies on b to set bitrate. +

+
+
+ + +

8.7 libopencore-amrnb

+ +

OpenCORE Adaptive Multi-Rate Narrowband encoder. +

+

Requires the presence of the libopencore-amrnb headers and library during +configuration. You need to explicitly configure the build with +--enable-libopencore-amrnb --enable-version3. +

+

This is a mono-only encoder. Officially it only supports 8000Hz sample rate, +but you can override it by setting strict to ‘unofficial’ or +lower. +

+ +

8.7.1 Options

+ +
+
b
+

Set bitrate in bits per second. Only the following bitrates are supported, +otherwise libavcodec will round to the nearest valid bitrate. +

+
+
4750
+
5150
+
5900
+
6700
+
7400
+
7950
+
10200
+
12200
+
+ +
+
dtx
+

Allow discontinuous transmission (generate comfort noise) when set to 1. The +default value is 0 (disabled). +

+
+
+ + +

8.8 libopus

+ +

libopus Opus Interactive Audio Codec encoder wrapper. +

+

Requires the presence of the libopus headers and library during +configuration. You need to explicitly configure the build with +--enable-libopus. +

+ +

8.8.1 Option Mapping

+ +

Most libopus options are modelled after the opusenc utility from +opus-tools. The following is an option mapping chart describing options +supported by the libopus wrapper, and their opusenc-equivalent +in parentheses. +

+
+
b (bitrate)
+

Set the bit rate in bits/s. FFmpeg’s b option is +expressed in bits/s, while opusenc’s bitrate in +kilobits/s. +

+
+
vbr (vbr, hard-cbr, and cvbr)
+

Set VBR mode. The FFmpeg vbr option has the following +valid arguments, with the opusenc equivalent options +in parentheses: +

+
+
‘off (hard-cbr)’
+

Use constant bit rate encoding. +

+
+
‘on (vbr)’
+

Use variable bit rate encoding (the default). +

+
+
‘constrained (cvbr)’
+

Use constrained variable bit rate encoding. +

+
+ +
+
compression_level (comp)
+

Set encoding algorithm complexity. Valid options are integers in +the 0-10 range. 0 gives the fastest encodes but lower quality, while 10 +gives the highest quality but slowest encoding. The default is 10. +

+
+
frame_duration (framesize)
+

Set maximum frame size, or duration of a frame in milliseconds. The +argument must be exactly the following: 2.5, 5, 10, 20, 40, 60. Smaller +frame sizes achieve lower latency but less quality at a given bitrate. +Sizes greater than 20ms are only interesting at fairly low bitrates. +The default is 20ms. +

+
+
packet_loss (expect-loss)
+

Set expected packet loss percentage. The default is 0. +

+
+
application (N.A.)
+

Set intended application type. Valid options are listed below: +

+
+
‘voip’
+

Favor improved speech intelligibility. +

+
‘audio’
+

Favor faithfulness to the input (the default). +

+
‘lowdelay’
+

Restrict to only the lowest delay modes. +

+
+ +
+
cutoff (N.A.)
+

Set cutoff bandwidth in Hz. The argument must be exactly one of the +following: 4000, 6000, 8000, 12000, or 20000, corresponding to +narrowband, mediumband, wideband, super wideband, and fullband +respectively. The default is 0 (cutoff disabled). +

+
+
mapping_family (mapping_family)
+

Set channel mapping family to be used by the encoder. The default value of -1 +uses mapping family 0 for mono and stereo inputs, and mapping family 1 +otherwise. The default also disables the surround masking and LFE bandwidth +optimzations in libopus, and requires that the input contains 8 channels or +fewer. +

+

Other values include 0 for mono and stereo, 1 for surround sound with masking +and LFE bandwidth optimizations, and 255 for independent streams with an +unspecified channel layout. +

+
+
apply_phase_inv (N.A.) (requires libopus >= 1.2)
+

If set to 0, disables the use of phase inversion for intensity stereo, +improving the quality of mono downmixes, but slightly reducing normal stereo +quality. The default is 1 (phase inversion enabled). +

+
+
+ + +

8.9 libshine

+ +

Shine Fixed-Point MP3 encoder wrapper. +

+

Shine is a fixed-point MP3 encoder. It has a far better performance on +platforms without an FPU, e.g. armel CPUs, and some phones and tablets. +However, as it is more targeted on performance than quality, it is not on par +with LAME and other production-grade encoders quality-wise. Also, according to +the project’s homepage, this encoder may not be free of bugs as the code was +written a long time ago and the project was dead for at least 5 years. +

+

This encoder only supports stereo and mono input. This is also CBR-only. +

+

The original project (last updated in early 2007) is at +http://sourceforge.net/projects/libshine-fxp/. We only support the +updated fork by the Savonet/Liquidsoap project at https://github.com/savonet/shine. +

+

Requires the presence of the libshine headers and library during +configuration. You need to explicitly configure the build with +--enable-libshine. +

+

See also libmp3lame. +

+ +

8.9.1 Options

+ +

The following options are supported by the libshine wrapper. The +shineenc-equivalent of the options are listed in parentheses. +

+
+
b (-b)
+

Set bitrate expressed in bits/s for CBR. shineenc -b option +is expressed in kilobits/s. +

+
+
+ + +

8.10 libtwolame

+ +

TwoLAME MP2 encoder wrapper. +

+

Requires the presence of the libtwolame headers and library during +configuration. You need to explicitly configure the build with +--enable-libtwolame. +

+ +

8.10.1 Options

+ +

The following options are supported by the libtwolame wrapper. The +twolame-equivalent options follow the FFmpeg ones and are in +parentheses. +

+
+
b (-b)
+

Set bitrate expressed in bits/s for CBR. twolame b +option is expressed in kilobits/s. Default value is 128k. +

+
+
q (-V)
+

Set quality for experimental VBR support. Maximum value range is +from -50 to 50, useful range is from -10 to 10. The higher the +value, the better the quality. This option is valid only using the +ffmpeg command-line tool. For library interface users, +use global_quality. +

+
+
mode (--mode)
+

Set the mode of the resulting audio. Possible values: +

+
+
‘auto’
+

Choose mode automatically based on the input. This is the default. +

+
‘stereo’
+

Stereo +

+
‘joint_stereo’
+

Joint stereo +

+
‘dual_channel’
+

Dual channel +

+
‘mono’
+

Mono +

+
+ +
+
psymodel (--psyc-mode)
+

Set psychoacoustic model to use in encoding. The argument must be +an integer between -1 and 4, inclusive. The higher the value, the +better the quality. The default value is 3. +

+
+
energy_levels (--energy)
+

Enable energy levels extensions when set to 1. The default value is +0 (disabled). +

+
+
error_protection (--protect)
+

Enable CRC error protection when set to 1. The default value is 0 +(disabled). +

+
+
copyright (--copyright)
+

Set MPEG audio copyright flag when set to 1. The default value is 0 +(disabled). +

+
+
original (--original)
+

Set MPEG audio original flag when set to 1. The default value is 0 +(disabled). +

+
+
+ + +

8.11 libvo-amrwbenc

+ +

VisualOn Adaptive Multi-Rate Wideband encoder. +

+

Requires the presence of the libvo-amrwbenc headers and library during +configuration. You need to explicitly configure the build with +--enable-libvo-amrwbenc --enable-version3. +

+

This is a mono-only encoder. Officially it only supports 16000Hz sample +rate, but you can override it by setting strict to +‘unofficial’ or lower. +

+ +

8.11.1 Options

+ +
+
b
+

Set bitrate in bits/s. Only the following bitrates are supported, otherwise +libavcodec will round to the nearest valid bitrate. +

+
+
‘6600’
+
‘8850’
+
‘12650’
+
‘14250’
+
‘15850’
+
‘18250’
+
‘19850’
+
‘23050’
+
‘23850’
+
+ +
+
dtx
+

Allow discontinuous transmission (generate comfort noise) when set to 1. The +default value is 0 (disabled). +

+
+
+ + +

8.12 libvorbis

+ +

libvorbis encoder wrapper. +

+

Requires the presence of the libvorbisenc headers and library during +configuration. You need to explicitly configure the build with +--enable-libvorbis. +

+ +

8.12.1 Options

+ +

The following options are supported by the libvorbis wrapper. The +oggenc-equivalent of the options are listed in parentheses. +

+

To get a more accurate and extensive documentation of the libvorbis +options, consult the libvorbisenc’s and oggenc’s documentations. +See http://xiph.org/vorbis/, +http://wiki.xiph.org/Vorbis-tools, and oggenc(1). +

+
+
b (-b)
+

Set bitrate expressed in bits/s for ABR. oggenc -b is +expressed in kilobits/s. +

+
+
q (-q)
+

Set constant quality setting for VBR. The value should be a float +number in the range of -1.0 to 10.0. The higher the value, the better +the quality. The default value is ‘3.0’. +

+

This option is valid only using the ffmpeg command-line tool. +For library interface users, use global_quality. +

+
+
cutoff (--advanced-encode-option lowpass_frequency=N)
+

Set cutoff bandwidth in Hz, a value of 0 disables cutoff. oggenc’s +related option is expressed in kHz. The default value is ‘0’ (cutoff +disabled). +

+
+
minrate (-m)
+

Set minimum bitrate expressed in bits/s. oggenc -m is +expressed in kilobits/s. +

+
+
maxrate (-M)
+

Set maximum bitrate expressed in bits/s. oggenc -M is +expressed in kilobits/s. This only has effect on ABR mode. +

+
+
iblock (--advanced-encode-option impulse_noisetune=N)
+

Set noise floor bias for impulse blocks. The value is a float number from +-15.0 to 0.0. A negative bias instructs the encoder to pay special attention +to the crispness of transients in the encoded audio. The tradeoff for better +transient response is a higher bitrate. +

+
+
+ + +

8.13 libwavpack

+ +

A wrapper providing WavPack encoding through libwavpack. +

+

Only lossless mode using 32-bit integer samples is supported currently. +

+

Requires the presence of the libwavpack headers and library during +configuration. You need to explicitly configure the build with +--enable-libwavpack. +

+

Note that a libavcodec-native encoder for the WavPack codec exists so users can +encode audios with this codec without using this encoder. See wavpackenc. +

+ +

8.13.1 Options

+ +

wavpack command line utility’s corresponding options are listed in +parentheses, if any. +

+
+
frame_size (--blocksize)
+

Default is 32768. +

+
+
compression_level
+

Set speed vs. compression tradeoff. Acceptable arguments are listed below: +

+
+
‘0 (-f)’
+

Fast mode. +

+
+
‘1’
+

Normal (default) settings. +

+
+
‘2 (-h)’
+

High quality. +

+
+
‘3 (-hh)’
+

Very high quality. +

+
+
‘4-8 (-hh -xEXTRAPROC)’
+

Same as ‘3’, but with extra processing enabled. +

+

‘4’ is the same as -x2 and ‘8’ is the same as -x6. +

+
+
+
+
+ + +

8.14 mjpeg

+ +

Motion JPEG encoder. +

+ +

8.14.1 Options

+ +
+
huffman
+

Set the huffman encoding strategy. Possible values: +

+
+
‘default’
+

Use the default huffman tables. This is the default strategy. +

+
+
‘optimal’
+

Compute and use optimal huffman tables. +

+
+
+
+
+ + +

8.15 wavpack

+ +

WavPack lossless audio encoder. +

+

This is a libavcodec-native WavPack encoder. There is also an encoder based on +libwavpack, but there is virtually no reason to use that encoder. +

+

See also libwavpack. +

+ +

8.15.1 Options

+ +

The equivalent options for wavpack command line utility are listed in +parentheses. +

+ +

8.15.1.1 Shared options

+ +

The following shared options are effective for this encoder. Only special notes +about this particular encoder will be documented here. For the general meaning +of the options, see the Codec Options chapter. +

+
+
frame_size (--blocksize)
+

For this encoder, the range for this option is between 128 and 131072. Default +is automatically decided based on sample rate and number of channel. +

+

For the complete formula of calculating default, see +libavcodec/wavpackenc.c. +

+
+
compression_level (-f, -h, -hh, and -x)
+

This option’s syntax is consistent with libwavpack’s. +

+
+ + +

8.15.1.2 Private options

+ +
+
joint_stereo (-j)
+

Set whether to enable joint stereo. Valid values are: +

+
+
‘on (1)’
+

Force mid/side audio encoding. +

+
‘off (0)’
+

Force left/right audio encoding. +

+
‘auto’
+

Let the encoder decide automatically. +

+
+ +
+
optimize_mono
+

Set whether to enable optimization for mono. This option is only effective for +non-mono streams. Available values: +

+
+
‘on’
+

enabled +

+
‘off’
+

disabled +

+
+ +
+
+ + + +

9 Video Encoders

+ +

A description of some of the currently available video encoders +follows. +

+ +

9.1 Hap

+ +

Vidvox Hap video encoder. +

+ +

9.1.1 Options

+ +
+
format integer
+

Specifies the Hap format to encode. +

+
+
hap
+
hap_alpha
+
hap_q
+
+ +

Default value is hap. +

+
+
chunks integer
+

Specifies the number of chunks to split frames into, between 1 and 64. This +permits multithreaded decoding of large frames, potentially at the cost of +data-rate. The encoder may modify this value to divide frames evenly. +

+

Default value is 1. +

+
+
compressor integer
+

Specifies the second-stage compressor to use. If set to none, +chunks will be limited to 1, as chunked uncompressed frames offer no +benefit. +

+
+
none
+
snappy
+
+ +

Default value is snappy. +

+
+
+ + +

9.2 jpeg2000

+ +

The native jpeg 2000 encoder is lossy by default, the -q:v +option can be used to set the encoding quality. Lossless encoding +can be selected with -pred 1. +

+ +

9.2.1 Options

+ +
+
format
+

Can be set to either j2k or jp2 (the default) that +makes it possible to store non-rgb pix_fmts. +

+
+
+ + +

9.3 librav1e

+ +

rav1e AV1 encoder wrapper. +

+

Requires the presence of the rav1e headers and library during configuration. +You need to explicitly configure the build with --enable-librav1e. +

+ +

9.3.1 Options

+ +
+
qmax
+

Sets the maximum quantizer to use when using bitrate mode. +

+
+
qmin
+

Sets the minimum quantizer to use when using bitrate mode. +

+
+
qp
+

Uses quantizer mode to encode at the given quantizer (0-255). +

+
+
speed
+

Selects the speed preset (0-10) to encode with. +

+
+
tiles
+

Selects how many tiles to encode with. +

+
+
tile-rows
+

Selects how many rows of tiles to encode with. +

+
+
tile-columns
+

Selects how many columns of tiles to encode with. +

+
+
rav1e-params
+

Set rav1e options using a list of key=value pairs separated +by ":". See rav1e --help for a list of options. +

+

For example to specify librav1e encoding options with -rav1e-params: +

+
+
ffmpeg -i input -c:v librav1e -b:v 500K -rav1e-params speed=5:low_latency=true output.mp4
+
+ +
+
+ + +

9.4 libaom-av1

+ +

libaom AV1 encoder wrapper. +

+

Requires the presence of the libaom headers and library during +configuration. You need to explicitly configure the build with +--enable-libaom. +

+ +

9.4.1 Options

+ +

The wrapper supports the following standard libavcodec options: +

+
+
b
+

Set bitrate target in bits/second. By default this will use +variable-bitrate mode. If maxrate and minrate are +also set to the same value then it will use constant-bitrate mode, +otherwise if crf is set as well then it will use +constrained-quality mode. +

+
+
g keyint_min
+

Set key frame placement. The GOP size sets the maximum distance between +key frames; if zero the output stream will be intra-only. The minimum +distance is ignored unless it is the same as the GOP size, in which case +key frames will always appear at a fixed interval. Not set by default, +so without this option the library has completely free choice about +where to place key frames. +

+
+
qmin qmax
+

Set minimum/maximum quantisation values. Valid range is from 0 to 63 +(warning: this does not match the quantiser values actually used by AV1 +- divide by four to map real quantiser values to this range). Defaults +to min/max (no constraint). +

+
+
minrate maxrate bufsize rc_init_occupancy
+

Set rate control buffering parameters. Not used if not set - defaults +to unconstrained variable bitrate. +

+
+
threads
+

Set the number of threads to use while encoding. This may require the +tiles or row-mt options to also be set to actually +use the specified number of threads fully. Defaults to the number of +hardware threads supported by the host machine. +

+
+
profile
+

Set the encoding profile. Defaults to using the profile which matches +the bit depth and chroma subsampling of the input. +

+
+
+ +

The wrapper also has some specific options: +

+
+
cpu-used
+

Set the quality/encoding speed tradeoff. Valid range is from 0 to 8, +higher numbers indicating greater speed and lower quality. The default +value is 1, which will be slow and high quality. +

+
+
auto-alt-ref
+

Enable use of alternate reference frames. Defaults to the internal +default of the library. +

+
+
arnr-max-frames (frames)
+

Set altref noise reduction max frame count. Default is -1. +

+
+
arnr-strength (strength)
+

Set altref noise reduction filter strength. Range is -1 to 6. Default is -1. +

+
+
aq-mode (aq-mode)
+

Set adaptive quantization mode. Possible values: +

+
+
‘none (0)’
+

Disabled. +

+
+
‘variance (1)’
+

Variance-based. +

+
+
‘complexity (2)’
+

Complexity-based. +

+
+
‘cyclic (3)’
+

Cyclic refresh. +

+
+ +
+
tune (tune)
+

Set the distortion metric the encoder is tuned with. Default is psnr. +

+
+
‘psnr (0)’
+
‘ssim (1)’
+
+ +
+
lag-in-frames
+

Set the maximum number of frames which the encoder may keep in flight +at any one time for lookahead purposes. Defaults to the internal +default of the library. +

+
+
error-resilience
+

Enable error resilience features: +

+
default
+

Improve resilience against losses of whole frames. +

+
+

Not enabled by default. +

+
+
crf
+

Set the quality/size tradeoff for constant-quality (no bitrate target) +and constrained-quality (with maximum bitrate target) modes. Valid +range is 0 to 63, higher numbers indicating lower quality and smaller +output size. Only used if set; by default only the bitrate target is +used. +

+
+
static-thresh
+

Set a change threshold on blocks below which they will be skipped by +the encoder. Defined in arbitrary units as a nonnegative integer, +defaulting to zero (no blocks are skipped). +

+
+
drop-threshold
+

Set a threshold for dropping frames when close to rate control bounds. +Defined as a percentage of the target buffer - when the rate control +buffer falls below this percentage, frames will be dropped until it +has refilled above the threshold. Defaults to zero (no frames are +dropped). +

+
+
denoise-noise-level (level)
+

Amount of noise to be removed for grain synthesis. Grain synthesis is disabled if +this option is not set or set to 0. +

+
+
denoise-block-size (pixels)
+

Block size used for denoising for grain synthesis. If not set, AV1 codec +uses the default value of 32. +

+
+
undershoot-pct (pct)
+

Set datarate undershoot (min) percentage of the target bitrate. Range is -1 to 100. +Default is -1. +

+
+
overshoot-pct (pct)
+

Set datarate overshoot (max) percentage of the target bitrate. Range is -1 to 1000. +Default is -1. +

+
+
minsection-pct (pct)
+

Minimum percentage variation of the GOP bitrate from the target bitrate. If minsection-pct +is not set, the libaomenc wrapper computes it as follows: (minrate * 100 / bitrate). +Range is -1 to 100. Default is -1 (unset). +

+
+
maxsection-pct (pct)
+

Maximum percentage variation of the GOP bitrate from the target bitrate. If maxsection-pct +is not set, the libaomenc wrapper computes it as follows: (maxrate * 100 / bitrate). +Range is -1 to 5000. Default is -1 (unset). +

+
+
frame-parallel (boolean)
+

Enable frame parallel decodability features. Default is true. +

+
+
tiles
+

Set the number of tiles to encode the input video with, as columns x +rows. Larger numbers allow greater parallelism in both encoding and +decoding, but may decrease coding efficiency. Defaults to the minimum +number of tiles required by the size of the input video (this is 1x1 +(that is, a single tile) for sizes up to and including 4K). +

+
+
tile-columns tile-rows
+

Set the number of tiles as log2 of the number of tile rows and columns. +Provided for compatibility with libvpx/VP9. +

+
+
row-mt (Requires libaom >= 1.0.0-759-g90a15f4f2)
+

Enable row based multi-threading. Disabled by default. +

+
+
enable-cdef (boolean)
+

Enable Constrained Directional Enhancement Filter. The libaom-av1 +encoder enables CDEF by default. +

+
+
enable-restoration (boolean)
+

Enable Loop Restoration Filter. Default is true for libaom-av1. +

+
+
enable-global-motion (boolean)
+

Enable the use of global motion for block prediction. Default is true. +

+
+
enable-intrabc (boolean)
+

Enable block copy mode for intra block prediction. This mode is +useful for screen content. Default is true. +

+
+
+ + +

9.5 libkvazaar

+ +

Kvazaar H.265/HEVC encoder. +

+

Requires the presence of the libkvazaar headers and library during +configuration. You need to explicitly configure the build with +--enable-libkvazaar. +

+ +

9.5.1 Options

+ +
+
b
+

Set target video bitrate in bit/s and enable rate control. +

+
+
kvazaar-params
+

Set kvazaar parameters as a list of name=value pairs separated +by commas (,). See kvazaar documentation for a list of options. +

+
+
+ + +

9.6 libopenh264

+ +

Cisco libopenh264 H.264/MPEG-4 AVC encoder wrapper. +

+

This encoder requires the presence of the libopenh264 headers and +library during configuration. You need to explicitly configure the +build with --enable-libopenh264. The library is detected using +pkg-config. +

+

For more information about the library see +http://www.openh264.org. +

+ +

9.6.1 Options

+ +

The following FFmpeg global options affect the configurations of the +libopenh264 encoder. +

+
+
b
+

Set the bitrate (as a number of bits per second). +

+
+
g
+

Set the GOP size. +

+
+
maxrate
+

Set the max bitrate (as a number of bits per second). +

+
+
flags +global_header
+

Set global header in the bitstream. +

+
+
slices
+

Set the number of slices, used in parallelized encoding. Default value +is 0. This is only used when slice_mode is set to +‘fixed’. +

+
+
slice_mode
+

Set slice mode. Can assume one of the following possible values: +

+
+
‘fixed’
+

a fixed number of slices +

+
‘rowmb’
+

one slice per row of macroblocks +

+
‘auto’
+

automatic number of slices according to number of threads +

+
‘dyn’
+

dynamic slicing +

+
+ +

Default value is ‘auto’. +

+
+
loopfilter
+

Enable loop filter, if set to 1 (automatically enabled). To disable +set a value of 0. +

+
+
profile
+

Set profile restrictions. If set to the value of ‘main’ enable +CABAC (set the SEncParamExt.iEntropyCodingModeFlag flag to 1). +

+
+
max_nal_size
+

Set maximum NAL size in bytes. +

+
+
allow_skip_frames
+

Allow skipping frames to hit the target bitrate if set to 1. +

+
+ + +

9.7 libtheora

+ +

libtheora Theora encoder wrapper. +

+

Requires the presence of the libtheora headers and library during +configuration. You need to explicitly configure the build with +--enable-libtheora. +

+

For more information about the libtheora project see +http://www.theora.org/. +

+ +

9.7.1 Options

+ +

The following global options are mapped to internal libtheora options +which affect the quality and the bitrate of the encoded stream. +

+
+
b
+

Set the video bitrate in bit/s for CBR (Constant Bit Rate) mode. In +case VBR (Variable Bit Rate) mode is enabled this option is ignored. +

+
+
flags
+

Used to enable constant quality mode (VBR) encoding through the +qscale flag, and to enable the pass1 and pass2 +modes. +

+
+
g
+

Set the GOP size. +

+
+
global_quality
+

Set the global quality as an integer in lambda units. +

+

Only relevant when VBR mode is enabled with flags +qscale. The +value is converted to QP units by dividing it by FF_QP2LAMBDA, +clipped in the [0 - 10] range, and then multiplied by 6.3 to get a +value in the native libtheora range [0-63]. A higher value corresponds +to a higher quality. +

+
+
q
+

Enable VBR mode when set to a non-negative value, and set constant +quality value as a double floating point value in QP units. +

+

The value is clipped in the [0-10] range, and then multiplied by 6.3 +to get a value in the native libtheora range [0-63]. +

+

This option is valid only using the ffmpeg command-line +tool. For library interface users, use global_quality. +

+
+ + +

9.7.2 Examples

+ +
    +
  • Set maximum constant quality (VBR) encoding with ffmpeg: +
    +
    ffmpeg -i INPUT -codec:v libtheora -q:v 10 OUTPUT.ogg
+
    + +
  • Use ffmpeg to convert a CBR 1000 kbps Theora video stream: +
    +
    ffmpeg -i INPUT -codec:v libtheora -b:v 1000k OUTPUT.ogg
+
    +
+ + +

9.8 libvpx

+ +

VP8/VP9 format supported through libvpx. +

+

Requires the presence of the libvpx headers and library during configuration. +You need to explicitly configure the build with --enable-libvpx. +

+ +

9.8.1 Options

+ +

The following options are supported by the libvpx wrapper. The +vpxenc-equivalent options or values are listed in parentheses +for easy migration. +

+

To reduce the duplication of documentation, only the private options +and some others requiring special attention are documented here. For +the documentation of the undocumented generic options, see +the Codec Options chapter. +

+

To get more documentation of the libvpx options, invoke the command +ffmpeg -h encoder=libvpx, ffmpeg -h encoder=libvpx-vp9 or +vpxenc --help. Further information is available in the libvpx API +documentation. +

+
+
b (target-bitrate)
+

Set bitrate in bits/s. Note that FFmpeg’s b option is +expressed in bits/s, while vpxenc’s target-bitrate is in +kilobits/s. +

+
+
g (kf-max-dist)
+
keyint_min (kf-min-dist)
+
qmin (min-q)
+
qmax (max-q)
+
bufsize (buf-sz, buf-optimal-sz)
+

Set ratecontrol buffer size (in bits). Note vpxenc’s options are +specified in milliseconds, the libvpx wrapper converts this value as follows: +buf-sz = bufsize * 1000 / bitrate, +buf-optimal-sz = bufsize * 1000 / bitrate * 5 / 6. +

+
+
rc_init_occupancy (buf-initial-sz)
+

Set number of bits which should be loaded into the rc buffer before decoding +starts. Note vpxenc’s option is specified in milliseconds, the libvpx +wrapper converts this value as follows: +rc_init_occupancy * 1000 / bitrate. +

+
+
undershoot-pct
+

Set datarate undershoot (min) percentage of the target bitrate. +

+
+
overshoot-pct
+

Set datarate overshoot (max) percentage of the target bitrate. +

+
+
skip_threshold (drop-frame)
+
qcomp (bias-pct)
+
maxrate (maxsection-pct)
+

Set GOP max bitrate in bits/s. Note vpxenc’s option is specified as a +percentage of the target bitrate, the libvpx wrapper converts this value as +follows: (maxrate * 100 / bitrate). +

+
+
minrate (minsection-pct)
+

Set GOP min bitrate in bits/s. Note vpxenc’s option is specified as a +percentage of the target bitrate, the libvpx wrapper converts this value as +follows: (minrate * 100 / bitrate). +

+
+
minrate, maxrate, b end-usage=cbr
+

(minrate == maxrate == bitrate). +

+
+
crf (end-usage=cq, cq-level)
+
tune (tune)
+
+
‘psnr (psnr)’
+
‘ssim (ssim)’
+
+ +
+
quality, deadline (deadline)
+
+
‘best’
+

Use best quality deadline. Poorly named and quite slow, this option should be +avoided as it may give worse quality output than good. +

+
‘good’
+

Use good quality deadline. This is a good trade-off between speed and quality +when used with the cpu-used option. +

+
‘realtime’
+

Use realtime quality deadline. +

+
+ +
+
speed, cpu-used (cpu-used)
+

Set quality/speed ratio modifier. Higher values speed up the encode at the cost +of quality. +

+
+
nr (noise-sensitivity)
+
static-thresh
+

Set a change threshold on blocks below which they will be skipped by the +encoder. +

+
+
slices (token-parts)
+

Note that FFmpeg’s slices option gives the total number of partitions, +while vpxenc’s token-parts is given as +log2(partitions). +

+
+
max-intra-rate
+

Set maximum I-frame bitrate as a percentage of the target bitrate. A value of 0 +means unlimited. +

+
+
force_key_frames
+

VPX_EFLAG_FORCE_KF +

+
+
Alternate reference frame related
+
+
auto-alt-ref
+

Enable use of alternate reference frames (2-pass only). +Values greater than 1 enable multi-layer alternate reference frames (VP9 only). +

+
arnr-maxframes
+

Set altref noise reduction max frame count. +

+
arnr-type
+

Set altref noise reduction filter type: backward, forward, centered. +

+
arnr-strength
+

Set altref noise reduction filter strength. +

+
rc-lookahead, lag-in-frames (lag-in-frames)
+

Set number of frames to look ahead for frametype and ratecontrol. +

+
+ +
+
error-resilient
+

Enable error resiliency features. +

+
+
sharpness integer
+

Increase sharpness at the expense of lower PSNR. +The valid range is [0, 7]. +

+
+
ts-parameters
+

Sets the temporal scalability configuration using a :-separated list of +key=value pairs. For example, to specify temporal scalability parameters +with ffmpeg: +

+
ffmpeg -i INPUT -c:v libvpx -ts-parameters ts_number_layers=3:\
+ts_target_bitrate=250,500,1000:ts_rate_decimator=4,2,1:\
+ts_periodicity=4:ts_layer_id=0,2,1,2:ts_layering_mode=3 OUTPUT
+
+

Below is a brief explanation of each of the parameters, please +refer to struct vpx_codec_enc_cfg in vpx/vpx_encoder.h for more +details. +

+
ts_number_layers
+

Number of temporal coding layers. +

+
ts_target_bitrate
+

Target bitrate for each temporal layer (in kbps). +(bitrate should be inclusive of the lower temporal layer). +

+
ts_rate_decimator
+

Frame rate decimation factor for each temporal layer. +

+
ts_periodicity
+

Length of the sequence defining frame temporal layer membership. +

+
ts_layer_id
+

Template defining the membership of frames to temporal layers. +

+
ts_layering_mode
+

(optional) Selecting the temporal structure from a set of pre-defined temporal layering modes. +Currently supports the following options. +

+
0
+

No temporal layering flags are provided internally, +relies on flags being passed in using metadata field in AVFrame +with following keys. +

+
vp8-flags
+

Sets the flags passed into the encoder to indicate the referencing scheme for +the current frame. +Refer to function vpx_codec_encode in vpx/vpx_encoder.h for more +details. +

+
temporal_id
+

Explicitly sets the temporal id of the current frame to encode. +

+
+
+
2
+

Two temporal layers. 0-1... +

+
3
+

Three temporal layers. 0-2-1-2...; with single reference frame. +

+
4
+

Same as option "3", except there is a dependency between +the two temporal layer 2 frames within the temporal period. +

+
+
+
+ +
+
VP9-specific options
+
+
lossless
+

Enable lossless mode. +

+
tile-columns
+

Set number of tile columns to use. Note this is given as +log2(tile_columns). For example, 8 tile columns would be requested by +setting the tile-columns option to 3. +

+
tile-rows
+

Set number of tile rows to use. Note this is given as log2(tile_rows). +For example, 4 tile rows would be requested by setting the tile-rows +option to 2. +

+
frame-parallel
+

Enable frame parallel decodability features. +

+
aq-mode
+

Set adaptive quantization mode (0: off (default), 1: variance 2: complexity, 3: +cyclic refresh, 4: equator360). +

+
colorspace color-space
+

Set input color space. The VP9 bitstream supports signaling the following +colorspaces: +

+
‘rgb’ sRGB
+
‘bt709’ bt709
+
‘unspecified’ unknown
+
‘bt470bg’ bt601
+
‘smpte170m’ smpte170
+
‘smpte240m’ smpte240
+
‘bt2020_ncl’ bt2020
+
+
+
row-mt boolean
+

Enable row based multi-threading. +

+
tune-content
+

Set content type: default (0), screen (1), film (2). +

+
corpus-complexity
+

Corpus VBR mode is a variant of standard VBR where the complexity distribution +midpoint is passed in rather than calculated for a specific clip or chunk. +

+

The valid range is [0, 10000]. 0 (default) uses standard VBR. +

+
enable-tpl boolean
+

Enable temporal dependency model. +

+
+ +
+
+ +

For more information about libvpx see: +http://www.webmproject.org/ +

+ +

9.9 libwebp

+ +

libwebp WebP Image encoder wrapper +

+

libwebp is Google’s official encoder for WebP images. It can encode in either +lossy or lossless mode. Lossy images are essentially a wrapper around a VP8 +frame. Lossless images are a separate codec developed by Google. +

+ +

9.9.1 Pixel Format

+ +

Currently, libwebp only supports YUV420 for lossy and RGB for lossless due +to limitations of the format and libwebp. Alpha is supported for either mode. +Because of API limitations, if RGB is passed in when encoding lossy or YUV is +passed in for encoding lossless, the pixel format will automatically be +converted using functions from libwebp. This is not ideal and is done only for +convenience. +

+ +

9.9.2 Options

+ +
+
-lossless boolean
+

Enables/Disables use of lossless mode. Default is 0. +

+
+
-compression_level integer
+

For lossy, this is a quality/speed tradeoff. Higher values give better quality +for a given size at the cost of increased encoding time. For lossless, this is +a size/speed tradeoff. Higher values give smaller size at the cost of increased +encoding time. More specifically, it controls the number of extra algorithms +and compression tools used, and varies the combination of these tools. This +maps to the method option in libwebp. The valid range is 0 to 6. +Default is 4. +

+
+
-qscale float
+

For lossy encoding, this controls image quality, 0 to 100. For lossless +encoding, this controls the effort and time spent at compressing more. The +default value is 75. Note that for usage via libavcodec, this option is called +global_quality and must be multiplied by FF_QP2LAMBDA. +

+
+
-preset type
+

Configuration preset. This does some automatic settings based on the general +type of the image. +

+
none
+

Do not use a preset. +

+
default
+

Use the encoder default. +

+
picture
+

Digital picture, like portrait, inner shot +

+
photo
+

Outdoor photograph, with natural lighting +

+
drawing
+

Hand or line drawing, with high-contrast details +

+
icon
+

Small-sized colorful images +

+
text
+

Text-like +

+
+ +
+
+ + +

9.10 libx264, libx264rgb

+ +

x264 H.264/MPEG-4 AVC encoder wrapper. +

+

This encoder requires the presence of the libx264 headers and library +during configuration. You need to explicitly configure the build with +--enable-libx264. +

+

libx264 supports an impressive number of features, including 8x8 and +4x4 adaptive spatial transform, adaptive B-frame placement, CAVLC/CABAC +entropy coding, interlacing (MBAFF), lossless mode, psy optimizations +for detail retention (adaptive quantization, psy-RD, psy-trellis). +

+

Many libx264 encoder options are mapped to FFmpeg global codec +options, while unique encoder options are provided through private +options. Additionally the x264opts and x264-params +private options allows one to pass a list of key=value tuples as accepted +by the libx264 x264_param_parse function. +

+

The x264 project website is at +http://www.videolan.org/developers/x264.html. +

+

The libx264rgb encoder is the same as libx264, except it accepts packed RGB +pixel formats as input instead of YUV. +

+ +

9.10.1 Supported Pixel Formats

+ +

x264 supports 8- to 10-bit color spaces. The exact bit depth is controlled at +x264’s configure time. FFmpeg only supports one bit depth in one particular +build. In other words, it is not possible to build one FFmpeg with multiple +versions of x264 with different bit depths. +

+ +

9.10.2 Options

+ +

The following options are supported by the libx264 wrapper. The +x264-equivalent options or values are listed in parentheses +for easy migration. +

+

To reduce the duplication of documentation, only the private options +and some others requiring special attention are documented here. For +the documentation of the undocumented generic options, see +the Codec Options chapter. +

+

To get a more accurate and extensive documentation of the libx264 +options, invoke the command x264 --fullhelp or consult +the libx264 documentation. +

+
+
b (bitrate)
+

Set bitrate in bits/s. Note that FFmpeg’s b option is +expressed in bits/s, while x264’s bitrate is in +kilobits/s. +

+
+
bf (bframes)
+
g (keyint)
+
qmin (qpmin)
+

Minimum quantizer scale. +

+
+
qmax (qpmax)
+

Maximum quantizer scale. +

+
+
qdiff (qpstep)
+

Maximum difference between quantizer scales. +

+
+
qblur (qblur)
+

Quantizer curve blur +

+
+
qcomp (qcomp)
+

Quantizer curve compression factor +

+
+
refs (ref)
+

Number of reference frames each P-frame can use. The range is from 0-16. +

+
+
sc_threshold (scenecut)
+

Sets the threshold for the scene change detection. +

+
+
trellis (trellis)
+

Performs Trellis quantization to increase efficiency. Enabled by default. +

+
+
nr (nr)
+
me_range (merange)
+

Maximum range of the motion search in pixels. +

+
+
me_method (me)
+

Set motion estimation method. Possible values in the decreasing order +of speed: +

+
+
‘dia (dia)’
+
‘epzs (dia)’
+

Diamond search with radius 1 (fastest). ‘epzs’ is an alias for +‘dia’. +

+
‘hex (hex)’
+

Hexagonal search with radius 2. +

+
‘umh (umh)’
+

Uneven multi-hexagon search. +

+
‘esa (esa)’
+

Exhaustive search. +

+
‘tesa (tesa)’
+

Hadamard exhaustive search (slowest). +

+
+ +
+
forced-idr
+

Normally, when forcing a I-frame type, the encoder can select any type +of I-frame. This option forces it to choose an IDR-frame. +

+
+
subq (subme)
+

Sub-pixel motion estimation method. +

+
+
b_strategy (b-adapt)
+

Adaptive B-frame placement decision algorithm. Use only on first-pass. +

+
+
keyint_min (min-keyint)
+

Minimum GOP size. +

+
+
coder
+

Set entropy encoder. Possible values: +

+
+
‘ac’
+

Enable CABAC. +

+
+
‘vlc’
+

Enable CAVLC and disable CABAC. It generates the same effect as +x264’s --no-cabac option. +

+
+ +
+
cmp
+

Set full pixel motion estimation comparison algorithm. Possible values: +

+
+
‘chroma’
+

Enable chroma in motion estimation. +

+
+
‘sad’
+

Ignore chroma in motion estimation. It generates the same effect as +x264’s --no-chroma-me option. +

+
+ +
+
threads (threads)
+

Number of encoding threads. +

+
+
thread_type
+

Set multithreading technique. Possible values: +

+
+
‘slice’
+

Slice-based multithreading. It generates the same effect as +x264’s --sliced-threads option. +

+
‘frame’
+

Frame-based multithreading. +

+
+ +
+
flags
+

Set encoding flags. It can be used to disable closed GOP and enable +open GOP by setting it to -cgop. The result is similar to +the behavior of x264’s --open-gop option. +

+
+
rc_init_occupancy (vbv-init)
+
preset (preset)
+

Set the encoding preset. +

+
+
tune (tune)
+

Set tuning of the encoding params. +

+
+
profile (profile)
+

Set profile restrictions. +

+
+
fastfirstpass
+

Enable fast settings when encoding first pass, when set to 1. When set +to 0, it has the same effect of x264’s +--slow-firstpass option. +

+
+
crf (crf)
+

Set the quality for constant quality mode. +

+
+
crf_max (crf-max)
+

In CRF mode, prevents VBV from lowering quality beyond this point. +

+
+
qp (qp)
+

Set constant quantization rate control method parameter. +

+
+
aq-mode (aq-mode)
+

Set AQ method. Possible values: +

+
+
‘none (0)’
+

Disabled. +

+
+
‘variance (1)’
+

Variance AQ (complexity mask). +

+
+
‘autovariance (2)’
+

Auto-variance AQ (experimental). +

+
+ +
+
aq-strength (aq-strength)
+

Set AQ strength, reduce blocking and blurring in flat and textured areas. +

+
+
psy
+

Use psychovisual optimizations when set to 1. When set to 0, it has the +same effect as x264’s --no-psy option. +

+
+
psy-rd (psy-rd)
+

Set strength of psychovisual optimization, in +psy-rd:psy-trellis format. +

+
+
rc-lookahead (rc-lookahead)
+

Set number of frames to look ahead for frametype and ratecontrol. +

+
+
weightb
+

Enable weighted prediction for B-frames when set to 1. When set to 0, +it has the same effect as x264’s --no-weightb option. +

+
+
weightp (weightp)
+

Set weighted prediction method for P-frames. Possible values: +

+
+
‘none (0)’
+

Disabled +

+
‘simple (1)’
+

Enable only weighted refs +

+
‘smart (2)’
+

Enable both weighted refs and duplicates +

+
+ +
+
ssim (ssim)
+

Enable calculation and printing SSIM stats after the encoding. +

+
+
intra-refresh (intra-refresh)
+

Enable the use of Periodic Intra Refresh instead of IDR frames when set +to 1. +

+
+
avcintra-class (class)
+

Configure the encoder to generate AVC-Intra. +Valid values are 50,100 and 200 +

+
+
bluray-compat (bluray-compat)
+

Configure the encoder to be compatible with the bluray standard. +It is a shorthand for setting "bluray-compat=1 force-cfr=1". +

+
+
b-bias (b-bias)
+

Set the influence on how often B-frames are used. +

+
+
b-pyramid (b-pyramid)
+

Set method for keeping of some B-frames as references. Possible values: +

+
+
‘none (none)’
+

Disabled. +

+
‘strict (strict)’
+

Strictly hierarchical pyramid. +

+
‘normal (normal)’
+

Non-strict (not Blu-ray compatible). +

+
+ +
+
mixed-refs
+

Enable the use of one reference per partition, as opposed to one +reference per macroblock when set to 1. When set to 0, it has the +same effect as x264’s --no-mixed-refs option. +

+
+
8x8dct
+

Enable adaptive spatial transform (high profile 8x8 transform) +when set to 1. When set to 0, it has the same effect as +x264’s --no-8x8dct option. +

+
+
fast-pskip
+

Enable early SKIP detection on P-frames when set to 1. When set +to 0, it has the same effect as x264’s +--no-fast-pskip option. +

+
+
aud (aud)
+

Enable use of access unit delimiters when set to 1. +

+
+
mbtree
+

Enable use macroblock tree ratecontrol when set to 1. When set +to 0, it has the same effect as x264’s +--no-mbtree option. +

+
+
deblock (deblock)
+

Set loop filter parameters, in alpha:beta form. +

+
+
cplxblur (cplxblur)
+

Set fluctuations reduction in QP (before curve compression). +

+
+
partitions (partitions)
+

Set partitions to consider as a comma-separated list of. Possible +values in the list: +

+
+
‘p8x8’
+

8x8 P-frame partition. +

+
‘p4x4’
+

4x4 P-frame partition. +

+
‘b8x8’
+

4x4 B-frame partition. +

+
‘i8x8’
+

8x8 I-frame partition. +

+
‘i4x4’
+

4x4 I-frame partition. +(Enabling ‘p4x4’ requires ‘p8x8’ to be enabled. Enabling +‘i8x8’ requires adaptive spatial transform (8x8dct +option) to be enabled.) +

+
‘none (none)’
+

Do not consider any partitions. +

+
‘all (all)’
+

Consider every partition. +

+
+ +
+
direct-pred (direct)
+

Set direct MV prediction mode. Possible values: +

+
+
‘none (none)’
+

Disable MV prediction. +

+
‘spatial (spatial)’
+

Enable spatial predicting. +

+
‘temporal (temporal)’
+

Enable temporal predicting. +

+
‘auto (auto)’
+

Automatically decided. +

+
+ +
+
slice-max-size (slice-max-size)
+

Set the limit of the size of each slice in bytes. If not specified +but RTP payload size (ps) is specified, that is used. +

+
+
stats (stats)
+

Set the file name for multi-pass stats. +

+
+
nal-hrd (nal-hrd)
+

Set signal HRD information (requires vbv-bufsize to be set). +Possible values: +

+
+
‘none (none)’
+

Disable HRD information signaling. +

+
‘vbr (vbr)’
+

Variable bit rate. +

+
‘cbr (cbr)’
+

Constant bit rate (not allowed in MP4 container). +

+
+ +
+
x264opts (N.A.)
+

Set any x264 option, see x264 --fullhelp for a list. +

+

Argument is a list of key=value couples separated by +":". In filter and psy-rd options that use ":" as a separator +themselves, use "," instead. They accept it as well since long ago but this +is kept undocumented for some reason. +

+

For example to specify libx264 encoding options with ffmpeg: +

+
ffmpeg -i foo.mpg -c:v libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
+
+ +
+
a53cc boolean
+

Import closed captions (which must be ATSC compatible format) into output. +Only the mpeg2 and h264 decoders provide these. Default is 1 (on). +

+
+
x264-params (N.A.)
+

Override the x264 configuration using a :-separated list of key=value +parameters. +

+

This option is functionally the same as the x264opts, but is +duplicated for compatibility with the Libav fork. +

+

For example to specify libx264 encoding options with ffmpeg: +

+
ffmpeg -i INPUT -c:v libx264 -x264-params level=30:bframes=0:weightp=0:\
+cabac=0:ref=1:vbv-maxrate=768:vbv-bufsize=2000:analyse=all:me=umh:\
+no-fast-pskip=1:subq=6:8x8dct=0:trellis=0 OUTPUT
+
+
+
+ +

Encoding ffpresets for common usages are provided so they can be used with the +general presets system (e.g. passing the pre option). +

+ +

9.11 libx265

+ +

x265 H.265/HEVC encoder wrapper. +

+

This encoder requires the presence of the libx265 headers and library +during configuration. You need to explicitly configure the build with +--enable-libx265. +

+ +

9.11.1 Options

+ +
+
b
+

Sets target video bitrate. +

+
+
bf
+
g
+

Set the GOP size. +

+
+
keyint_min
+

Minimum GOP size. +

+
+
refs
+

Number of reference frames each P-frame can use. The range is from 1-16. +

+
+
preset
+

Set the x265 preset. +

+
+
tune
+

Set the x265 tune parameter. +

+
+
profile
+

Set profile restrictions. +

+
+
crf
+

Set the quality for constant quality mode. +

+
+
qp
+

Set constant quantization rate control method parameter. +

+
+
qmin
+

Minimum quantizer scale. +

+
+
qmax
+

Maximum quantizer scale. +

+
+
qdiff
+

Maximum difference between quantizer scales. +

+
+
qblur
+

Quantizer curve blur +

+
+
qcomp
+

Quantizer curve compression factor +

+
+
i_qfactor
+
b_qfactor
+
forced-idr
+

Normally, when forcing a I-frame type, the encoder can select any type +of I-frame. This option forces it to choose an IDR-frame. +

+
+
x265-params
+

Set x265 options using a list of key=value couples separated +by ":". See x265 --help for a list of options. +

+

For example to specify libx265 encoding options with -x265-params: +

+
+
ffmpeg -i input -c:v libx265 -x265-params crf=26:psy-rd=1 output.mp4
+
+
+
+ + +

9.12 libxavs2

+ +

xavs2 AVS2-P2/IEEE1857.4 encoder wrapper. +

+

This encoder requires the presence of the libxavs2 headers and library +during configuration. You need to explicitly configure the build with +--enable-libxavs2. +

+

The following standard libavcodec options are used: +

    +
  • b / bit_rate +
  • g / gop_size +
  • bf / max_b_frames +
+ +

The encoder also has its own specific options: +

+

9.12.1 Options

+ +
+
lcu_row_threads
+

Set the number of parallel threads for rows from 1 to 8 (default 5). +

+
+
initial_qp
+

Set the xavs2 quantization parameter from 1 to 63 (default 34). This is +used to set the initial qp for the first frame. +

+
+
qp
+

Set the xavs2 quantization parameter from 1 to 63 (default 34). This is +used to set the qp value under constant-QP mode. +

+
+
max_qp
+

Set the max qp for rate control from 1 to 63 (default 55). +

+
+
min_qp
+

Set the min qp for rate control from 1 to 63 (default 20). +

+
+
speed_level
+

Set the Speed level from 0 to 9 (default 0). Higher is better but slower. +

+
+
log_level
+

Set the log level from -1 to 3 (default 0). -1: none, 0: error, +1: warning, 2: info, 3: debug. +

+
+
xavs2-params
+

Set xavs2 options using a list of key=value couples separated +by ":". +

+

For example to specify libxavs2 encoding options with -xavs2-params: +

+
+
ffmpeg -i input -c:v libxavs2 -xavs2-params RdoqLevel=0 output.avs2
+
+
+
+ + +

9.13 libxvid

+ +

Xvid MPEG-4 Part 2 encoder wrapper. +

+

This encoder requires the presence of the libxvidcore headers and library +during configuration. You need to explicitly configure the build with +--enable-libxvid --enable-gpl. +

+

The native mpeg4 encoder supports the MPEG-4 Part 2 format, so +users can encode to this format without this library. +

+ +

9.13.1 Options

+ +

The following options are supported by the libxvid wrapper. Some of +the following options are listed but are not documented, and +correspond to shared codec options. See the Codec +Options chapter for their documentation. The other shared options +which are not listed have no effect for the libxvid encoder. +

+
+
b
+
g
+
qmin
+
qmax
+
mpeg_quant
+
threads
+
bf
+
b_qfactor
+
b_qoffset
+
flags
+

Set specific encoding flags. Possible values: +

+
+
‘mv4’
+

Use four motion vector by macroblock. +

+
+
‘aic’
+

Enable high quality AC prediction. +

+
+
‘gray’
+

Only encode grayscale. +

+
+
‘gmc’
+

Enable the use of global motion compensation (GMC). +

+
+
‘qpel’
+

Enable quarter-pixel motion compensation. +

+
+
‘cgop’
+

Enable closed GOP. +

+
+
‘global_header’
+

Place global headers in extradata instead of every keyframe. +

+
+
+ +
+
trellis
+
me_method
+

Set motion estimation method. Possible values in decreasing order of +speed and increasing order of quality: +

+
+
‘zero’
+

Use no motion estimation (default). +

+
+
‘phods’
+
‘x1’
+
‘log’
+

Enable advanced diamond zonal search for 16x16 blocks and half-pixel +refinement for 16x16 blocks. ‘x1’ and ‘log’ are aliases for +‘phods’. +

+
+
‘epzs’
+

Enable all of the things described above, plus advanced diamond zonal +search for 8x8 blocks, half-pixel refinement for 8x8 blocks, and motion +estimation on chroma planes. +

+
+
‘full’
+

Enable all of the things described above, plus extended 16x16 and 8x8 +blocks search. +

+
+ +
+
mbd
+

Set macroblock decision algorithm. Possible values in the increasing +order of quality: +

+
+
‘simple’
+

Use macroblock comparing function algorithm (default). +

+
+
‘bits’
+

Enable rate distortion-based half pixel and quarter pixel refinement for +16x16 blocks. +

+
+
‘rd’
+

Enable all of the things described above, plus rate distortion-based +half pixel and quarter pixel refinement for 8x8 blocks, and rate +distortion-based search using square pattern. +

+
+ +
+
lumi_aq
+

Enable lumi masking adaptive quantization when set to 1. Default is 0 +(disabled). +

+
+
variance_aq
+

Enable variance adaptive quantization when set to 1. Default is 0 +(disabled). +

+

When combined with lumi_aq, the resulting quality will not +be better than any of the two specified individually. In other +words, the resulting quality will be the worse one of the two +effects. +

+
+
ssim
+

Set structural similarity (SSIM) displaying method. Possible values: +

+
+
‘off’
+

Disable displaying of SSIM information. +

+
+
‘avg’
+

Output average SSIM at the end of encoding to stdout. The format of +showing the average SSIM is: +

+
+
Average SSIM: %f
+
+ +

For users who are not familiar with C, %f means a float number, or +a decimal (e.g. 0.939232). +

+
+
‘frame’
+

Output both per-frame SSIM data during encoding and average SSIM at +the end of encoding to stdout. The format of per-frame information +is: +

+
+
       SSIM: avg: %1.3f min: %1.3f max: %1.3f
+
+ +

For users who are not familiar with C, %1.3f means a float number +rounded to 3 digits after the dot (e.g. 0.932). +

+
+
+ +
+
ssim_acc
+

Set SSIM accuracy. Valid options are integers within the range of +0-4, while 0 gives the most accurate result and 4 computes the +fastest. +

+
+
+ + +

9.14 MediaFoundation

+ +

This provides wrappers to encoders (both audio and video) in the +MediaFoundation framework. It can access both SW and HW encoders. +Video encoders can take input in either of nv12 or yuv420p form +(some encoders support both, some support only either - in practice, +nv12 is the safer choice, especially among HW encoders). +

+ +

9.15 mpeg2

+ +

MPEG-2 video encoder. +

+ +

9.15.1 Options

+ +
+
profile integer
+

Select the mpeg2 profile to encode: +

+
+
‘422’
+
‘main’
+
‘ss’
+

Spatially Scalable +

+
‘snr’
+

SNR Scalable +

+
‘high’
+
‘simple’
+
+ +
+
seq_disp_ext integer
+

Specifies if the encoder should write a sequence_display_extension to the +output. +

+
-1
+
auto
+

Decide automatically to write it or not (this is the default) by checking if +the data to be written is different from the default or unspecified values. +

+
0
+
never
+

Never write it. +

+
1
+
always
+

Always write it. +

+
+
+
video_format integer
+

Specifies the video_format written into the sequence display extension +indicating the source of the video pictures. The default is ‘unspecified’, +can be ‘component’, ‘pal’, ‘ntsc’, ‘secam’ or ‘mac’. +For maximum compatibility, use ‘component’. +

+
a53cc boolean
+

Import closed captions (which must be ATSC compatible format) into output. +Default is 1 (on). +

+
+ + +

9.16 png

+ +

PNG image encoder. +

+ +

9.16.1 Private options

+ +
+
dpi integer
+

Set physical density of pixels, in dots per inch, unset by default +

+
dpm integer
+

Set physical density of pixels, in dots per meter, unset by default +

+
+ + +

9.17 ProRes

+ +

Apple ProRes encoder. +

+

FFmpeg contains 2 ProRes encoders, the prores-aw and prores-ks encoder. +The used encoder can be chosen with the -vcodec option. +

+ +

9.17.1 Private Options for prores-ks

+ +
+
profile integer
+

Select the ProRes profile to encode +

+
‘proxy’
+
‘lt’
+
‘standard’
+
‘hq’
+
‘4444’
+
‘4444xq’
+
+ +
+
quant_mat integer
+

Select quantization matrix. +

+
‘auto’
+
‘default’
+
‘proxy’
+
‘lt’
+
‘standard’
+
‘hq’
+
+

If set to auto, the matrix matching the profile will be picked. +If not set, the matrix providing the highest quality, default, will be +picked. +

+
+
bits_per_mb integer
+

How many bits to allot for coding one macroblock. Different profiles use +between 200 and 2400 bits per macroblock, the maximum is 8000. +

+
+
mbs_per_slice integer
+

Number of macroblocks in each slice (1-8); the default value (8) +should be good in almost all situations. +

+
+
vendor string
+

Override the 4-byte vendor ID. +A custom vendor ID like apl0 would claim the stream was produced by +the Apple encoder. +

+
+
alpha_bits integer
+

Specify number of bits for alpha component. +Possible values are 0, 8 and 16. +Use 0 to disable alpha plane coding. +

+
+
+ + +

9.17.2 Speed considerations

+ +

In the default mode of operation the encoder has to honor frame constraints +(i.e. not produce frames with size bigger than requested) while still making +output picture as good as possible. +A frame containing a lot of small details is harder to compress and the encoder +would spend more time searching for appropriate quantizers for each slice. +

+

Setting a higher bits_per_mb limit will improve the speed. +

+

For the fastest encoding speed set the qscale parameter (4 is the +recommended value) and do not set a size constraint. +

+ +

9.18 QSV encoders

+ +

The family of Intel QuickSync Video encoders (MPEG-2, H.264, HEVC, JPEG/MJPEG and VP9) +

+

The ratecontrol method is selected as follows: +

+
    +
  • When global_quality is specified, a quality-based mode is used. +Specifically this means either +
      +
    • - CQP - constant quantizer scale, when the qscale codec flag is +also set (the -qscale ffmpeg option). + +
    • - LA_ICQ - intelligent constant quality with lookahead, when the +look_ahead option is also set. + +
    • - ICQ – intelligent constant quality otherwise. +
    + +
  • Otherwise, a bitrate-based mode is used. For all of those, you should specify at +least the desired average bitrate with the b option. +
      +
    • - LA - VBR with lookahead, when the look_ahead option is specified. + +
    • - VCM - video conferencing mode, when the vcm option is set. + +
    • - CBR - constant bitrate, when maxrate is specified and equal to +the average bitrate. + +
    • - VBR - variable bitrate, when maxrate is specified, but is higher +than the average bitrate. + +
    • - AVBR - average VBR mode, when maxrate is not specified. This mode +is further configured by the avbr_accuracy and +avbr_convergence options. +
    +
+ +

Note that depending on your system, a different mode than the one you specified +may be selected by the encoder. Set the verbosity level to verbose or +higher to see the actual settings used by the QSV runtime. +

+

Additional libavcodec global options are mapped to MSDK options as follows: +

+
    +
  • g/gop_size -> GopPicSize + +
  • bf/max_b_frames+1 -> GopRefDist + +
  • rc_init_occupancy/rc_initial_buffer_occupancy -> +InitialDelayInKB + +
  • slices -> NumSlice + +
  • refs -> NumRefFrame + +
  • b_strategy/b_frame_strategy -> BRefType + +
  • cgop/CLOSED_GOP codec flag -> GopOptFlag + +
  • For the CQP mode, the i_qfactor/i_qoffset and +b_qfactor/b_qoffset set the difference between QPP and QPI, +and QPP and QPB respectively. + +
  • Setting the coder option to the value vlc will make the H.264 +encoder use CAVLC instead of CABAC. + +
+ + +

9.19 snow

+ + +

9.19.1 Options

+ +
+
iterative_dia_size
+

dia size for the iterative motion estimation +

+
+ + +

9.20 VAAPI encoders

+ +

Wrappers for hardware encoders accessible via VAAPI. +

+

These encoders only accept input in VAAPI hardware surfaces. If you have input +in software frames, use the hwupload filter to upload them to the GPU. +

+

The following standard libavcodec options are used: +

    +
  • g / gop_size +
  • bf / max_b_frames +
  • profile + +

    If not set, this will be determined automatically from the format of the input +frames and the profiles supported by the driver. +

  • level +
  • b / bit_rate +
  • maxrate / rc_max_rate +
  • bufsize / rc_buffer_size +
  • rc_init_occupancy / rc_initial_buffer_occupancy +
  • compression_level + +

    Speed / quality tradeoff: higher values are faster / worse quality. +

  • q / global_quality + +

    Size / quality tradeoff: higher values are smaller / worse quality. +

  • qmin +
  • qmax +
  • i_qfactor / i_quant_factor +
  • i_qoffset / i_quant_offset +
  • b_qfactor / b_quant_factor +
  • b_qoffset / b_quant_offset +
  • slices +
+ +

All encoders support the following options: +

+
low_power
+

Some drivers/platforms offer a second encoder for some codecs intended to use +less power than the default encoder; setting this option will attempt to use +that encoder. Note that it may support a reduced feature set, so some other +options may not be available in this mode. +

+
+
idr_interval
+

Set the number of normal intra frames between full-refresh (IDR) frames in +open-GOP mode. The intra frames are still IRAPs, but will not include global +headers and may have non-decodable leading pictures. +

+
+
b_depth
+

Set the B-frame reference depth. When set to one (the default), all B-frames +will refer only to P- or I-frames. When set to greater values multiple layers +of B-frames will be present, frames in each layer only referring to frames in +higher layers. +

+
+
rc_mode
+

Set the rate control mode to use. A given driver may only support a subset of +modes. +

+

Possible modes: +

+
auto
+

Choose the mode automatically based on driver support and the other options. +This is the default. +

+
CQP
+

Constant-quality. +

+
CBR
+

Constant-bitrate. +

+
VBR
+

Variable-bitrate. +

+
ICQ
+

Intelligent constant-quality. +

+
QVBR
+

Quality-defined variable-bitrate. +

+
AVBR
+

Average variable bitrate. +

+
+ +
+
+ +

Each encoder also has its own specific options: +

+
h264_vaapi
+

profile sets the value of profile_idc and the constraint_set*_flags. +level sets the value of level_idc. +

+
+
coder
+

Set entropy encoder (default is cabac). Possible values: +

+
+
‘ac’
+
‘cabac’
+

Use CABAC. +

+
+
‘vlc’
+
‘cavlc’
+

Use CAVLC. +

+
+ +
+
aud
+

Include access unit delimiters in the stream (not included by default). +

+
+
sei
+

Set SEI message types to include. +Some combination of the following values: +

+
‘identifier’
+

Include a user_data_unregistered message containing information about +the encoder. +

+
‘timing’
+

Include picture timing parameters (buffering_period and +pic_timing messages). +

+
‘recovery_point’
+

Include recovery points where appropriate (recovery_point messages). +

+
+ +
+
+ +
+
hevc_vaapi
+

profile and level set the values of +general_profile_idc and general_level_idc respectively. +

+
+
aud
+

Include access unit delimiters in the stream (not included by default). +

+
+
tier
+

Set general_tier_flag. This may affect the level chosen for the stream +if it is not explicitly specified. +

+
+
sei
+

Set SEI message types to include. +Some combination of the following values: +

+
‘hdr’
+

Include HDR metadata if the input frames have it +(mastering_display_colour_volume and content_light_level +messages). +

+
+ +
+
+ +
+
mjpeg_vaapi
+

Only baseline DCT encoding is supported. The encoder always uses the standard +quantisation and huffman tables - global_quality scales the standard +quantisation table (range 1-100). +

+

For YUV, 4:2:0, 4:2:2 and 4:4:4 subsampling modes are supported. RGB is also +supported, and will create an RGB JPEG. +

+
+
jfif
+

Include JFIF header in each frame (not included by default). +

+
huffman
+

Include standard huffman tables (on by default). Turning this off will save +a few hundred bytes in each output frame, but may lose compatibility with some +JPEG decoders which don’t fully handle MJPEG. +

+
+ +
+
mpeg2_vaapi
+

profile and level set the value of profile_and_level_indication. +

+
+
vp8_vaapi
+

B-frames are not supported. +

+

global_quality sets the q_idx used for non-key frames (range 0-127). +

+
+
loop_filter_level
+
loop_filter_sharpness
+

Manually set the loop filter parameters. +

+
+ +
+
vp9_vaapi
+

global_quality sets the q_idx used for P-frames (range 0-255). +

+
+
loop_filter_level
+
loop_filter_sharpness
+

Manually set the loop filter parameters. +

+
+ +

B-frames are supported, but the output stream is always in encode order rather than display +order. If B-frames are enabled, it may be necessary to use the vp9_raw_reorder +bitstream filter to modify the output stream to display frames in the correct order. +

+

Only normal frames are produced - the vp9_superframe bitstream filter may be +required to produce a stream usable with all decoders. +

+
+
+ + +

9.21 vc2

+ +

SMPTE VC-2 (previously BBC Dirac Pro). This codec was primarily aimed at +professional broadcasting but since it supports yuv420, yuv422 and yuv444 at +8 (limited range or full range), 10 or 12 bits, this makes it suitable for +other tasks which require low overhead and low compression (like screen +recording). +

+ +

9.21.1 Options

+ +
+
b
+

Sets target video bitrate. Usually that’s around 1:6 of the uncompressed +video bitrate (e.g. for 1920x1080 50fps yuv422p10 that’s around 400Mbps). Higher +values (close to the uncompressed bitrate) turn on lossless compression mode. +

+
+
field_order
+

Enables field coding when set (e.g. to tt - top field first) for interlaced +inputs. Should increase compression with interlaced content as it splits the +fields and encodes each separately. +

+
+
wavelet_depth
+

Sets the total amount of wavelet transforms to apply, between 1 and 5 (default). +Lower values reduce compression and quality. Less capable decoders may not be +able to handle values of wavelet_depth over 3. +

+
+
wavelet_type
+

Sets the transform type. Currently only 5_3 (LeGall) and 9_7 +(Deslauriers-Dubuc) +are implemented, with 9_7 being the one with better compression and thus +is the default. +

+
+
slice_width
+
slice_height
+

Sets the slice size for each slice. Larger values result in better compression. +For compatibility with other more limited decoders use slice_width of +32 and slice_height of 8. +

+
+
tolerance
+

Sets the undershoot tolerance of the rate control system in percent. This is +to prevent an expensive search from being run. +

+
+
qm
+

Sets the quantization matrix preset to use by default or when wavelet_depth +is set to 5 +

    +
  • - default +Uses the default quantization matrix from the specifications, extended with +values for the fifth level. This provides a good balance between keeping detail +and omitting artifacts. + +
  • - flat +Use a completely zeroed out quantization matrix. This increases PSNR but might +reduce perception. Use in bogus benchmarks. + +
  • - color +Reduces detail but attempts to preserve color at extremely low bitrates. +
+ +
+
+ + + +

10 Subtitles Encoders

+ + +

10.1 dvdsub

+ +

This codec encodes the bitmap subtitle format that is used in DVDs. +Typically they are stored in VOBSUB file pairs (*.idx + *.sub), +and they can also be used in Matroska files. +

+ +

10.1.1 Options

+ +
+
palette
+

Specify the global palette used by the bitmaps. +

+

The format for this option is a string containing 16 24-bits hexadecimal +numbers (without 0x prefix) separated by commas, for example 0d00ee, +ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1, +7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b. +

+
+
even_rows_fix
+

When set to 1, enable a work-around that makes the number of pixel rows +even in all subtitles. This fixes a problem with some players that +cut off the bottom row if the number is odd. The work-around just adds +a fully transparent row if needed. The overhead is low, typically +one byte per subtitle on average. +

+

By default, this work-around is disabled. +

+
+ + + +

11 See Also

+ +

ffmpeg, ffplay, ffprobe, +libavcodec +

+ + +

12 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-devices.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-devices.html new file mode 100644 index 0000000..27563fd --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-devices.html @@ -0,0 +1,2410 @@ + + + + + + + FFmpeg Devices Documentation + + + + + + +
+

+ FFmpeg Devices Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

This document describes the input and output devices provided by the +libavdevice library. +

+ + +

2 Device Options

+ +

The libavdevice library provides the same interface as +libavformat. Namely, an input device is considered like a demuxer, and +an output device like a muxer, and the interface and generic device +options are the same provided by libavformat (see the ffmpeg-formats +manual). +

+

In addition each input or output device may support so-called private +options, which are specific for that component. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the device +AVFormatContext options or using the libavutil/opt.h API +for programmatic use. +

+ + +

3 Input Devices

+ +

Input devices are configured elements in FFmpeg which enable accessing +the data coming from a multimedia device attached to your system. +

+

When you configure your FFmpeg build, all the supported input devices +are enabled by default. You can list all available ones using the +configure option "–list-indevs". +

+

You can disable all the input devices using the configure option +"–disable-indevs", and selectively enable an input device using the +option "–enable-indev=INDEV", or you can disable a particular +input device using the option "–disable-indev=INDEV". +

+

The option "-devices" of the ff* tools will display the list of +supported input devices. +

+

A description of the currently available input devices follows. +

+ +

3.1 alsa

+ +

ALSA (Advanced Linux Sound Architecture) input device. +

+

To enable this input device during configuration you need libasound +installed on your system. +

+

This device allows capturing from an ALSA device. The name of the +device to capture has to be an ALSA card identifier. +

+

An ALSA identifier has the syntax: +

+
hw:CARD[,DEV[,SUBDEV]]
+
+ +

where the DEV and SUBDEV components are optional. +

+

The three arguments (in order: CARD,DEV,SUBDEV) +specify card number or identifier, device number and subdevice number +(-1 means any). +

+

To see the list of cards currently recognized by your system check the +files /proc/asound/cards and /proc/asound/devices. +

+

For example to capture with ffmpeg from an ALSA device with +card id 0, you may run the command: +

+
ffmpeg -f alsa -i hw:0 alsaout.wav
+
+ +

For more information see: +http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html +

+ +

3.1.1 Options

+ +
+
sample_rate
+

Set the sample rate in Hz. Default is 48000. +

+
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

3.2 android_camera

+ +

Android camera input device. +

+

This input devices uses the Android Camera2 NDK API which is +available on devices with API level 24+. The availability of +android_camera is autodetected during configuration. +

+

This device allows capturing from all cameras on an Android device, +which are integrated into the Camera2 NDK API. +

+

The available cameras are enumerated internally and can be selected +with the camera_index parameter. The input file string is +discarded. +

+

Generally the back facing camera has index 0 while the front facing +camera has index 1. +

+ +

3.2.1 Options

+ +
+
video_size
+

Set the video size given as a string such as 640x480 or hd720. +Falls back to the first available configuration reported by +Android if requested video size is not available or by default. +

+
+
framerate
+

Set the video framerate. +Falls back to the first available configuration reported by +Android if requested framerate is not available or by default (-1). +

+
+
camera_index
+

Set the index of the camera to use. Default is 0. +

+
+
input_queue_size
+

Set the maximum number of frames to buffer. Default is 5. +

+
+
+ + +

3.3 avfoundation

+ +

AVFoundation input device. +

+

AVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX >= 10.7 as well as on iOS. +

+

The input filename has to be given in the following syntax: +

+
-i "[[VIDEO]:[AUDIO]]"
+
+

The first entry selects the video input while the latter selects the audio input. +The stream has to be specified by the device name or the device index as shown by the device list. +Alternatively, the video and/or audio input device can be chosen by index using the + + -video_device_index <INDEX> + +and/or + + -audio_device_index <INDEX> + +, overriding any +device name or index given in the input filename. +

+

All available devices can be enumerated by using -list_devices true, listing +all device names and corresponding indices. +

+

There are two device name aliases: +

+
default
+

Select the AVFoundation default device of the corresponding type. +

+
+
none
+

Do not record the corresponding media type. +This is equivalent to specifying an empty device name or index. +

+
+
+ + +

3.3.1 Options

+ +

AVFoundation supports the following options: +

+
+
-list_devices <TRUE|FALSE>
+

If set to true, a list of all available input devices is given showing all +device names and indices. +

+
+
-video_device_index <INDEX>
+

Specify the video device by its index. Overrides anything given in the input filename. +

+
+
-audio_device_index <INDEX>
+

Specify the audio device by its index. Overrides anything given in the input filename. +

+
+
-pixel_format <FORMAT>
+

Request the video device to use a specific pixel format. +If the specified format is not supported, a list of available formats is given +and the first one in this list is used instead. Available pixel formats are: +monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0, + bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10, + yuv420p, nv12, yuyv422, gray +

+
+
-framerate
+

Set the grabbing frame rate. Default is ntsc, corresponding to a +frame rate of 30000/1001. +

+
+
-video_size
+

Set the video frame size. +

+
+
-capture_cursor
+

Capture the mouse pointer. Default is 0. +

+
+
-capture_mouse_clicks
+

Capture the screen mouse clicks. Default is 0. +

+
+
-capture_raw_data
+

Capture the raw device data. Default is 0. +Using this option may result in receiving the underlying data delivered to the AVFoundation framework. E.g. for muxed devices that sends raw DV data to the framework (like tape-based camcorders), setting this option to false results in extracted video frames captured in the designated pixel format only. Setting this option to true results in receiving the raw DV stream untouched. +

+
+ + +

3.3.2 Examples

+ +
    +
  • Print the list of AVFoundation supported devices and exit: +
    +
    $ ffmpeg -f avfoundation -list_devices true -i ""
+
    + +
  • Record video from video device 0 and audio from audio device 0 into out.avi: +
    +
    $ ffmpeg -f avfoundation -i "0:0" out.avi
+
    + +
  • Record video from video device 2 and audio from audio device 1 into out.avi: +
    +
    $ ffmpeg -f avfoundation -video_device_index 2 -i ":1" out.avi
+
    + +
  • Record video from the system default video device using the pixel format bgr0 and do not record any audio into out.avi: +
    +
    $ ffmpeg -f avfoundation -pixel_format bgr0 -i "default:none" out.avi
+
    + +
  • Record raw DV data from a suitable input device and write the output into out.dv: +
    +
    $ ffmpeg -f avfoundation -capture_raw_data true -i "zr100:none" out.dv
+
    + + +
+ + +

3.4 bktr

+ +

BSD video input device. +

+ +

3.4.1 Options

+ +
+
framerate
+

Set the frame rate. +

+
+
video_size
+

Set the video frame size. Default is vga. +

+
+
standard
+
+

Available values are: +

+
‘pal’
+
‘ntsc’
+
‘secam’
+
‘paln’
+
‘palm’
+
‘ntscj’
+
+ +
+
+ + +

3.5 decklink

+ +

The decklink input device provides capture capabilities for Blackmagic +DeckLink devices. +

+

To enable this input device, you need the Blackmagic DeckLink SDK and you +need to configure with the appropriate --extra-cflags +and --extra-ldflags. +On Windows, you need to run the IDL files through widl. +

+

DeckLink is very picky about the formats it supports. Pixel format of the +input can be set with raw_format. +Framerate and video size must be determined for your device with +-list_formats 1. Audio sample rate is always 48 kHz and the number +of channels can be 2, 8 or 16. Note that all audio channels are bundled in one single +audio track. +

+ +

3.5.1 Options

+ +
+
list_devices
+

If set to true, print a list of devices and exit. +Defaults to false. This option is deprecated, please use the +-sources option of ffmpeg to list the available input devices. +

+
+
list_formats
+

If set to true, print a list of supported formats and exit. +Defaults to false. +

+
+
format_code <FourCC>
+

This sets the input video format to the format given by the FourCC. To see +the supported values of your device(s) use list_formats. +Note that there is a FourCC 'pal ' that can also be used +as pal (3 letters). +Default behavior is autodetection of the input video format, if the hardware +supports it. +

+
+
raw_format
+

Set the pixel format of the captured video. +Available values are: +

+
‘uyvy422’
+
‘yuv422p10’
+
‘argb’
+
‘bgra’
+
‘rgb10’
+
+ +
+
teletext_lines
+

If set to nonzero, an additional teletext stream will be captured from the +vertical ancillary data. Both SD PAL (576i) and HD (1080i or 1080p) +sources are supported. In case of HD sources, OP47 packets are decoded. +

+

This option is a bitmask of the SD PAL VBI lines captured, specifically lines 6 +to 22, and lines 318 to 335. Line 6 is the LSB in the mask. Selected lines +which do not contain teletext information will be ignored. You can use the +special all constant to select all possible lines, or +standard to skip lines 6, 318 and 319, which are not compatible with +all receivers. +

+

For SD sources, ffmpeg needs to be compiled with --enable-libzvbi. For +HD sources, on older (pre-4K) DeckLink card models you have to capture in 10 +bit mode. +

+
+
channels
+

Defines number of audio channels to capture. Must be ‘2’, ‘8’ or ‘16’. +Defaults to ‘2’. +

+
+
duplex_mode
+

Sets the decklink device duplex mode. Must be ‘unset’, ‘half’ or ‘full’. +Defaults to ‘unset’. +

+
+
timecode_format
+

Timecode type to include in the frame and video stream metadata. Must be +‘none’, ‘rp188vitc’, ‘rp188vitc2’, ‘rp188ltc’, +‘rp188any’, ‘vitc’, ‘vitc2’, or ‘serial’. Defaults to +‘none’ (not included). +

+
+
video_input
+

Sets the video input source. Must be ‘unset’, ‘sdi’, ‘hdmi’, +‘optical_sdi’, ‘component’, ‘composite’ or ‘s_video’. +Defaults to ‘unset’. +

+
+
audio_input
+

Sets the audio input source. Must be ‘unset’, ‘embedded’, +‘aes_ebu’, ‘analog’, ‘analog_xlr’, ‘analog_rca’ or +‘microphone’. Defaults to ‘unset’. +

+
+
video_pts
+

Sets the video packet timestamp source. Must be ‘video’, ‘audio’, +‘reference’, ‘wallclock’ or ‘abs_wallclock’. +Defaults to ‘video’. +

+
+
audio_pts
+

Sets the audio packet timestamp source. Must be ‘video’, ‘audio’, +‘reference’, ‘wallclock’ or ‘abs_wallclock’. +Defaults to ‘audio’. +

+
+
draw_bars
+

If set to ‘true’, color bars are drawn in the event of a signal loss. +Defaults to ‘true’. +

+
+
queue_size
+

Sets maximum input buffer size in bytes. If the buffering reaches this value, +incoming frames will be dropped. +Defaults to ‘1073741824’. +

+
+
audio_depth
+

Sets the audio sample bit depth. Must be ‘16’ or ‘32’. +Defaults to ‘16’. +

+
+
decklink_copyts
+

If set to true, timestamps are forwarded as they are without removing +the initial offset. +Defaults to false. +

+
+
timestamp_align
+

Capture start time alignment in seconds. If set to nonzero, input frames are +dropped till the system timestamp aligns with configured value. +Alignment difference of up to one frame duration is tolerated. +This is useful for maintaining input synchronization across N different +hardware devices deployed for ’N-way’ redundancy. The system time of different +hardware devices should be synchronized with protocols such as NTP or PTP, +before using this option. +Note that this method is not foolproof. In some border cases input +synchronization may not happen due to thread scheduling jitters in the OS. +Either sync could go wrong by 1 frame or in a rarer case +timestamp_align seconds. +Defaults to ‘0’. +

+
+
wait_for_tc (bool)
+

Drop frames till a frame with timecode is received. Sometimes serial timecode +isn’t received with the first input frame. If that happens, the stored stream +timecode will be inaccurate. If this option is set to true, input frames +are dropped till a frame with timecode is received. +Option timecode_format must be specified. +Defaults to false. +

+
+
+ + +

3.5.2 Examples

+ +
    +
  • List input devices: +
    +
    ffmpeg -sources decklink
+
    + +
  • List supported formats: +
    +
    ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
+
    + +
  • Capture video clip at 1080i50: +
    +
    ffmpeg -format_code Hi50 -f decklink -i 'Intensity Pro' -c:a copy -c:v copy output.avi
+
    + +
  • Capture video clip at 1080i50 10 bit: +
    +
    ffmpeg -raw_format yuv422p10 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi
+
    + +
  • Capture video clip at 1080i50 with 16 audio channels: +
    +
    ffmpeg -channels 16 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi
+
    + +
+ + +

3.6 dshow

+ +

Windows DirectShow input device. +

+

DirectShow support is enabled when FFmpeg is built with the mingw-w64 project. +Currently only audio and video devices are supported. +

+

Multiple devices may be opened as separate inputs, but they may also be +opened on the same input, which should improve synchronism between them. +

+

The input name should be in the format: +

+
+
TYPE=NAME[:TYPE=NAME]
+
+ +

where TYPE can be either audio or video, +and NAME is the device’s name or alternative name.. +

+ +

3.6.1 Options

+ +

If no options are specified, the device’s defaults are used. +If the device does not support the requested options, it will +fail to open. +

+
+
video_size
+

Set the video size in the captured video. +

+
+
framerate
+

Set the frame rate in the captured video. +

+
+
sample_rate
+

Set the sample rate (in Hz) of the captured audio. +

+
+
sample_size
+

Set the sample size (in bits) of the captured audio. +

+
+
channels
+

Set the number of channels in the captured audio. +

+
+
list_devices
+

If set to true, print a list of devices and exit. +

+
+
list_options
+

If set to true, print a list of selected device’s options +and exit. +

+
+
video_device_number
+

Set video device number for devices with the same name (starts at 0, +defaults to 0). +

+
+
audio_device_number
+

Set audio device number for devices with the same name (starts at 0, +defaults to 0). +

+
+
pixel_format
+

Select pixel format to be used by DirectShow. This may only be set when +the video codec is not set or set to rawvideo. +

+
+
audio_buffer_size
+

Set audio device buffer size in milliseconds (which can directly +impact latency, depending on the device). +Defaults to using the audio device’s +default buffer size (typically some multiple of 500ms). +Setting this value too low can degrade performance. +See also +http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx +

+
+
video_pin_name
+

Select video capture pin to use by name or alternative name. +

+
+
audio_pin_name
+

Select audio capture pin to use by name or alternative name. +

+
+
crossbar_video_input_pin_number
+

Select video input pin number for crossbar device. This will be +routed to the crossbar device’s Video Decoder output pin. +Note that changing this value can affect future invocations +(sets a new default) until system reboot occurs. +

+
+
crossbar_audio_input_pin_number
+

Select audio input pin number for crossbar device. This will be +routed to the crossbar device’s Audio Decoder output pin. +Note that changing this value can affect future invocations +(sets a new default) until system reboot occurs. +

+
+
show_video_device_dialog
+

If set to true, before capture starts, popup a display dialog +to the end user, allowing them to change video filter properties +and configurations manually. +Note that for crossbar devices, adjusting values in this dialog +may be needed at times to toggle between PAL (25 fps) and NTSC (29.97) +input frame rates, sizes, interlacing, etc. Changing these values can +enable different scan rates/frame rates and avoiding green bars at +the bottom, flickering scan lines, etc. +Note that with some devices, changing these properties can also affect future +invocations (sets new defaults) until system reboot occurs. +

+
+
show_audio_device_dialog
+

If set to true, before capture starts, popup a display dialog +to the end user, allowing them to change audio filter properties +and configurations manually. +

+
+
show_video_crossbar_connection_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify crossbar pin routings, when it opens a video device. +

+
+
show_audio_crossbar_connection_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify crossbar pin routings, when it opens an audio device. +

+
+
show_analog_tv_tuner_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify TV channels and frequencies. +

+
+
show_analog_tv_tuner_audio_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify TV audio (like mono vs. stereo, Language A,B or C). +

+
+
audio_device_load
+

Load an audio capture filter device from file instead of searching +it by name. It may load additional parameters too, if the filter +supports the serialization of its properties to. +To use this an audio capture source has to be specified, but it can +be anything even fake one. +

+
+
audio_device_save
+

Save the currently used audio capture filter device and its +parameters (if the filter supports it) to a file. +If a file with the same name exists it will be overwritten. +

+
+
video_device_load
+

Load a video capture filter device from file instead of searching +it by name. It may load additional parameters too, if the filter +supports the serialization of its properties to. +To use this a video capture source has to be specified, but it can +be anything even fake one. +

+
+
video_device_save
+

Save the currently used video capture filter device and its +parameters (if the filter supports it) to a file. +If a file with the same name exists it will be overwritten. +

+
+
+ + +

3.6.2 Examples

+ +
    +
  • Print the list of DirectShow supported devices and exit: +
    +
    $ ffmpeg -list_devices true -f dshow -i dummy
+
    + +
  • Open video device Camera: +
    +
    $ ffmpeg -f dshow -i video="Camera"
+
    + +
  • Open second video device with name Camera: +
    +
    $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
+
    + +
  • Open video device Camera and audio device Microphone: +
    +
    $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
+
    + +
  • Print the list of supported options in selected device and exit: +
    +
    $ ffmpeg -list_options true -f dshow -i video="Camera"
+
    + +
  • Specify pin names to capture by name or alternative name, specify alternative device name: +
    +
    $ ffmpeg -f dshow -audio_pin_name "Audio Out" -video_pin_name 2 -i video=video="@device_pnp_\\?\pci#ven_1a0a&dev_6200&subsys_62021461&rev_01#4&e2c7dd6&0&00e1#{65e8773d-8f56-11d0-a3b9-00a0c9223196}\{ca465100-deb0-4d59-818f-8c477184adf6}":audio="Microphone"
+
    + +
  • Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup: +
    +
    $ ffmpeg -f dshow -show_video_device_dialog true -crossbar_video_input_pin_number 0
+     -crossbar_audio_input_pin_number 3 -i video="AVerMedia BDA Analog Capture":audio="AVerMedia BDA Analog Capture"
+
    + +
+ + +

3.7 fbdev

+ +

Linux framebuffer input device. +

+

The Linux framebuffer is a graphic hardware-independent abstraction +layer to show graphics on a computer monitor, typically on the +console. It is accessed through a file device node, usually +/dev/fb0. +

+

For more detailed information read the file +Documentation/fb/framebuffer.txt included in the Linux source tree. +

+

See also http://linux-fbdev.sourceforge.net/, and fbset(1). +

+

To record from the framebuffer device /dev/fb0 with +ffmpeg: +

+
ffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi
+
+ +

You can take a single screenshot image with the command: +

+
ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
+
+ + +

3.7.1 Options

+ +
+
framerate
+

Set the frame rate. Default is 25. +

+
+
+ + +

3.8 gdigrab

+ +

Win32 GDI-based screen capture device. +

+

This device allows you to capture a region of the display on Windows. +

+

There are two options for the input filename: +

+
desktop
+
+

or +

+
title=window_title
+
+ +

The first option will capture the entire desktop, or a fixed region of the +desktop. The second option will instead capture the contents of a single +window, regardless of its position on the screen. +

+

For example, to grab the entire desktop using ffmpeg: +

+
ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
+
+ +

Grab a 640x480 region at position 10,20: +

+
ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
+
+ +

Grab the contents of the window named "Calculator" +

+
ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
+
+ + +

3.8.1 Options

+ +
+
draw_mouse
+

Specify whether to draw the mouse pointer. Use the value 0 to +not draw the pointer. Default value is 1. +

+
+
framerate
+

Set the grabbing frame rate. Default value is ntsc, +corresponding to a frame rate of 30000/1001. +

+
+
show_region
+

Show grabbed region on screen. +

+

If show_region is specified with 1, then the grabbing +region will be indicated on screen. With this option, it is easy to +know what is being grabbed if only a portion of the screen is grabbed. +

+

Note that show_region is incompatible with grabbing the contents +of a single window. +

+

For example: +

+
ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
+
+ +
+
video_size
+

Set the video frame size. The default is to capture the full screen if desktop is selected, or the full window size if title=window_title is selected. +

+
+
offset_x
+

When capturing a region with video_size, set the distance from the left edge of the screen or desktop. +

+

Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned to the left of your primary monitor, you will need to use a negative offset_x value to move the region to that monitor. +

+
+
offset_y
+

When capturing a region with video_size, set the distance from the top edge of the screen or desktop. +

+

Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned above your primary monitor, you will need to use a negative offset_y value to move the region to that monitor. +

+
+
+ + +

3.9 iec61883

+ +

FireWire DV/HDV input device using libiec61883. +

+

To enable this input device, you need libiec61883, libraw1394 and +libavc1394 installed on your system. Use the configure option +--enable-libiec61883 to compile with the device enabled. +

+

The iec61883 capture device supports capturing from a video device +connected via IEEE1394 (FireWire), using libiec61883 and the new Linux +FireWire stack (juju). This is the default DV/HDV input method in Linux +Kernel 2.6.37 and later, since the old FireWire stack was removed. +

+

Specify the FireWire port to be used as input file, or "auto" +to choose the first port connected. +

+ +

3.9.1 Options

+ +
+
dvtype
+

Override autodetection of DV/HDV. This should only be used if auto +detection does not work, or if usage of a different device type +should be prohibited. Treating a DV device as HDV (or vice versa) will +not work and result in undefined behavior. +The values auto, dv and hdv are supported. +

+
+
dvbuffer
+

Set maximum size of buffer for incoming data, in frames. For DV, this +is an exact value. For HDV, it is not frame exact, since HDV does +not have a fixed frame size. +

+
+
dvguid
+

Select the capture device by specifying its GUID. Capturing will only +be performed from the specified device and fails if no device with the +given GUID is found. This is useful to select the input if multiple +devices are connected at the same time. +Look at /sys/bus/firewire/devices to find out the GUIDs. +

+
+
+ + +

3.9.2 Examples

+ +
    +
  • Grab and show the input of a FireWire DV/HDV device. +
    +
    ffplay -f iec61883 -i auto
+
    + +
  • Grab and record the input of a FireWire DV/HDV device, +using a packet buffer of 100000 packets if the source is HDV. +
    +
    ffmpeg -f iec61883 -i auto -dvbuffer 100000 out.mpg
+
    + +
+ + +

3.10 jack

+ +

JACK input device. +

+

To enable this input device during configuration you need libjack +installed on your system. +

+

A JACK input device creates one or more JACK writable clients, one for +each audio channel, with name client_name:input_N, where +client_name is the name provided by the application, and N +is a number which identifies the channel. +Each writable client will send the acquired data to the FFmpeg input +device. +

+

Once you have created one or more JACK readable clients, you need to +connect them to one or more JACK writable clients. +

+

To connect or disconnect JACK clients you can use the jack_connect +and jack_disconnect programs, or do it through a graphical interface, +for example with qjackctl. +

+

To list the JACK clients and their properties you can invoke the command +jack_lsp. +

+

Follows an example which shows how to capture a JACK readable client +with ffmpeg. +

+
# Create a JACK writable client with name "ffmpeg".
+$ ffmpeg -f jack -i ffmpeg -y out.wav
+
+# Start the sample jack_metro readable client.
+$ jack_metro -b 120 -d 0.2 -f 4000
+
+# List the current JACK clients.
+$ jack_lsp -c
+system:capture_1
+system:capture_2
+system:playback_1
+system:playback_2
+ffmpeg:input_1
+metro:120_bpm
+
+# Connect metro to the ffmpeg writable client.
+$ jack_connect metro:120_bpm ffmpeg:input_1
+
+ +

For more information read: +http://jackaudio.org/ +

+ +

3.10.1 Options

+ +
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

3.11 kmsgrab

+ +

KMS video input device. +

+

Captures the KMS scanout framebuffer associated with a specified CRTC or plane as a +DRM object that can be passed to other hardware functions. +

+

Requires either DRM master or CAP_SYS_ADMIN to run. +

+

If you don’t understand what all of that means, you probably don’t want this. Look at +x11grab instead. +

+ +

3.11.1 Options

+ +
+
device
+

DRM device to capture on. Defaults to /dev/dri/card0. +

+
+
format
+

Pixel format of the framebuffer. Defaults to bgr0. +

+
+
format_modifier
+

Format modifier to signal on output frames. This is necessary to import correctly into +some APIs, but can’t be autodetected. See the libdrm documentation for possible values. +

+
+
crtc_id
+

KMS CRTC ID to define the capture source. The first active plane on the given CRTC +will be used. +

+
+
plane_id
+

KMS plane ID to define the capture source. Defaults to the first active plane found if +neither crtc_id nor plane_id are specified. +

+
+
framerate
+

Framerate to capture at. This is not synchronised to any page flipping or framebuffer +changes - it just defines the interval at which the framebuffer is sampled. Sampling +faster than the framebuffer update rate will generate independent frames with the same +content. Defaults to 30. +

+
+
+ + +

3.11.2 Examples

+ +
    +
  • Capture from the first active plane, download the result to normal frames and encode. +This will only work if the framebuffer is both linear and mappable - if not, the result +may be scrambled or fail to download. +
    +
    ffmpeg -f kmsgrab -i - -vf 'hwdownload,format=bgr0' output.mp4
+
    + +
  • Capture from CRTC ID 42 at 60fps, map the result to VAAPI, convert to NV12 and encode as H.264. +
    +
    ffmpeg -crtc_id 42 -framerate 60 -f kmsgrab -i - -vf 'hwmap=derive_device=vaapi,scale_vaapi=w=1920:h=1080:format=nv12' -c:v h264_vaapi output.mp4
+
    + +
  • To capture only part of a plane the output can be cropped - this can be used to capture +a single window, as long as it has a known absolute position and size. For example, to +capture and encode the middle quarter of a 1920x1080 plane: +
    +
    ffmpeg -f kmsgrab -i - -vf 'hwmap=derive_device=vaapi,crop=960:540:480:270,scale_vaapi=960:540:nv12' -c:v h264_vaapi output.mp4
+
    + +
+ + +

3.12 lavfi

+ +

Libavfilter input virtual device. +

+

This input device reads data from the open output pads of a libavfilter +filtergraph. +

+

For each filtergraph open output, the input device will create a +corresponding stream which is mapped to the generated output. Currently +only video data is supported. The filtergraph is specified through the +option graph. +

+ +

3.12.1 Options

+ +
+
graph
+

Specify the filtergraph to use as input. Each video open output must be +labelled by a unique string of the form "outN", where N is a +number starting from 0 corresponding to the mapped input stream +generated by the device. +The first unlabelled output is automatically assigned to the "out0" +label, but all the others need to be specified explicitly. +

+

The suffix "+subcc" can be appended to the output label to create an extra +stream with the closed captions packets attached to that output +(experimental; only for EIA-608 / CEA-708 for now). +The subcc streams are created after all the normal streams, in the order of +the corresponding stream. +For example, if there is "out19+subcc", "out7+subcc" and up to "out42", the +stream #43 is subcc for stream #7 and stream #44 is subcc for stream #19. +

+

If not specified defaults to the filename specified for the input +device. +

+
+
graph_file
+

Set the filename of the filtergraph to be read and sent to the other +filters. Syntax of the filtergraph is the same as the one specified by +the option graph. +

+
+
dumpgraph
+

Dump graph to stderr. +

+
+
+ + +

3.12.2 Examples

+ +
    +
  • Create a color video stream and play it back with ffplay: +
    +
    ffplay -f lavfi -graph "color=c=pink [out0]" dummy
+
    + +
  • As the previous example, but use filename for specifying the graph +description, and omit the "out0" label: +
    +
    ffplay -f lavfi color=c=pink
+
    + +
  • Create three different video test filtered sources and play them: +
    +
    ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
+
    + +
  • Read an audio stream from a file using the amovie source and play it +back with ffplay: +
    +
    ffplay -f lavfi "amovie=test.wav"
+
    + +
  • Read an audio stream and a video stream and play it back with +ffplay: +
    +
    ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
+
    + +
  • Dump decoded frames to images and closed captions to a file (experimental): +
    +
    ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
+
    + +
+ + +

3.13 libcdio

+ +

Audio-CD input device based on libcdio. +

+

To enable this input device during configuration you need libcdio +installed on your system. It requires the configure option +--enable-libcdio. +

+

This device allows playing and grabbing from an Audio-CD. +

+

For example to copy with ffmpeg the entire Audio-CD in /dev/sr0, +you may run the command: +

+
ffmpeg -f libcdio -i /dev/sr0 cd.wav
+
+ + +

3.13.1 Options

+
+
speed
+

Set drive reading speed. Default value is 0. +

+

The speed is specified CD-ROM speed units. The speed is set through +the libcdio cdio_cddap_speed_set function. On many CD-ROM +drives, specifying a value too large will result in using the fastest +speed. +

+
+
paranoia_mode
+

Set paranoia recovery mode flags. It accepts one of the following values: +

+
+
‘disable’
+
‘verify’
+
‘overlap’
+
‘neverskip’
+
‘full’
+
+ +

Default value is ‘disable’. +

+

For more information about the available recovery modes, consult the +paranoia project documentation. +

+
+ + +

3.14 libdc1394

+ +

IIDC1394 input device, based on libdc1394 and libraw1394. +

+

Requires the configure option --enable-libdc1394. +

+ +

3.14.1 Options

+
+
framerate
+

Set the frame rate. Default is ntsc, corresponding to a frame +rate of 30000/1001. +

+
+
pixel_format
+

Select the pixel format. Default is uyvy422. +

+
+
video_size
+

Set the video size given as a string such as 640x480 or hd720. +Default is qvga. +

+
+ + +

3.15 openal

+ +

The OpenAL input device provides audio capture on all systems with a +working OpenAL 1.1 implementation. +

+

To enable this input device during configuration, you need OpenAL +headers and libraries installed on your system, and need to configure +FFmpeg with --enable-openal. +

+

OpenAL headers and libraries should be provided as part of your OpenAL +implementation, or as an additional download (an SDK). Depending on your +installation you may need to specify additional flags via the +--extra-cflags and --extra-ldflags for allowing the build +system to locate the OpenAL headers and libraries. +

+

An incomplete list of OpenAL implementations follows: +

+
+
Creative
+

The official Windows implementation, providing hardware acceleration +with supported devices and software fallback. +See http://openal.org/. +

+
OpenAL Soft
+

Portable, open source (LGPL) software implementation. Includes +backends for the most common sound APIs on the Windows, Linux, +Solaris, and BSD operating systems. +See http://kcat.strangesoft.net/openal.html. +

+
Apple
+

OpenAL is part of Core Audio, the official Mac OS X Audio interface. +See http://developer.apple.com/technologies/mac/audio-and-video.html +

+
+ +

This device allows one to capture from an audio input device handled +through OpenAL. +

+

You need to specify the name of the device to capture in the provided +filename. If the empty string is provided, the device will +automatically select the default device. You can get the list of the +supported devices by using the option list_devices. +

+ +

3.15.1 Options

+ +
+
channels
+

Set the number of channels in the captured audio. Only the values +1 (monaural) and 2 (stereo) are currently supported. +Defaults to 2. +

+
+
sample_size
+

Set the sample size (in bits) of the captured audio. Only the values +8 and 16 are currently supported. Defaults to +16. +

+
+
sample_rate
+

Set the sample rate (in Hz) of the captured audio. +Defaults to 44.1k. +

+
+
list_devices
+

If set to true, print a list of devices and exit. +Defaults to false. +

+
+
+ + +

3.15.2 Examples

+ +

Print the list of OpenAL supported devices and exit: +

+
$ ffmpeg -list_devices true -f openal -i dummy out.ogg
+
+ +

Capture from the OpenAL device DR-BT101 via PulseAudio: +

+
$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
+
+ +

Capture from the default device (note the empty string ” as filename): +

+
$ ffmpeg -f openal -i '' out.ogg
+
+ +

Capture from two devices simultaneously, writing to two different files, +within the same ffmpeg command: +

+
$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
+
+

Note: not all OpenAL implementations support multiple simultaneous capture - +try the latest OpenAL Soft if the above does not work. +

+ +

3.16 oss

+ +

Open Sound System input device. +

+

The filename to provide to the input device is the device node +representing the OSS input device, and is usually set to +/dev/dsp. +

+

For example to grab from /dev/dsp using ffmpeg use the +command: +

+
ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
+
+ +

For more information about OSS see: +http://manuals.opensound.com/usersguide/dsp.html +

+ +

3.16.1 Options

+ +
+
sample_rate
+

Set the sample rate in Hz. Default is 48000. +

+
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

3.17 pulse

+ +

PulseAudio input device. +

+

To enable this output device you need to configure FFmpeg with --enable-libpulse. +

+

The filename to provide to the input device is a source device or the +string "default" +

+

To list the PulseAudio source devices and their properties you can invoke +the command pactl list sources. +

+

More information about PulseAudio can be found on http://www.pulseaudio.org. +

+ +

3.17.1 Options

+
+
server
+

Connect to a specific PulseAudio server, specified by an IP address. +Default server is used when not provided. +

+
+
name
+

Specify the application name PulseAudio will use when showing active clients, +by default it is the LIBAVFORMAT_IDENT string. +

+
+
stream_name
+

Specify the stream name PulseAudio will use when showing active streams, +by default it is "record". +

+
+
sample_rate
+

Specify the samplerate in Hz, by default 48kHz is used. +

+
+
channels
+

Specify the channels in use, by default 2 (stereo) is set. +

+
+
frame_size
+

Specify the number of bytes per frame, by default it is set to 1024. +

+
+
fragment_size
+

Specify the minimal buffering fragment in PulseAudio, it will affect the +audio latency. By default it is unset. +

+
+
wallclock
+

Set the initial PTS using the current time. Default is 1. +

+
+
+ + +

3.17.2 Examples

+

Record a stream from default device: +

+
ffmpeg -f pulse -i default /tmp/pulse.wav
+
+ + +

3.18 sndio

+ +

sndio input device. +

+

To enable this input device during configuration you need libsndio +installed on your system. +

+

The filename to provide to the input device is the device node +representing the sndio input device, and is usually set to +/dev/audio0. +

+

For example to grab from /dev/audio0 using ffmpeg use the +command: +

+
ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
+
+ + +

3.18.1 Options

+ +
+
sample_rate
+

Set the sample rate in Hz. Default is 48000. +

+
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

3.19 video4linux2, v4l2

+ +

Video4Linux2 input video device. +

+

"v4l2" can be used as alias for "video4linux2". +

+

If FFmpeg is built with v4l-utils support (by using the +--enable-libv4l2 configure option), it is possible to use it with the +-use_libv4l2 input device option. +

+

The name of the device to grab is a file device node, usually Linux +systems tend to automatically create such nodes when the device +(e.g. an USB webcam) is plugged into the system, and has a name of the +kind /dev/videoN, where N is a number associated to +the device. +

+

Video4Linux2 devices usually support a limited set of +widthxheight sizes and frame rates. You can check which are +supported using -list_formats all for Video4Linux2 devices. +Some devices, like TV cards, support one or more standards. It is possible +to list all the supported standards using -list_standards all. +

+

The time base for the timestamps is 1 microsecond. Depending on the kernel +version and configuration, the timestamps may be derived from the real time +clock (origin at the Unix Epoch) or the monotonic clock (origin usually at +boot time, unaffected by NTP or manual changes to the clock). The +-timestamps abs or -ts abs option can be used to force +conversion into the real time clock. +

+

Some usage examples of the video4linux2 device with ffmpeg +and ffplay: +

    +
  • List supported formats for a video4linux2 device: +
    +
    ffplay -f video4linux2 -list_formats all /dev/video0
+
    + +
  • Grab and show the input of a video4linux2 device: +
    +
    ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
+
    + +
  • Grab and record the input of a video4linux2 device, leave the +frame rate and size as previously set: +
    +
    ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
+
    +
+ +

For more information about Video4Linux, check http://linuxtv.org/. +

+ +

3.19.1 Options

+ +
+
standard
+

Set the standard. Must be the name of a supported standard. To get a +list of the supported standards, use the list_standards +option. +

+
+
channel
+

Set the input channel number. Default to -1, which means using the +previously selected channel. +

+
+
video_size
+

Set the video frame size. The argument must be a string in the form +WIDTHxHEIGHT or a valid size abbreviation. +

+
+
pixel_format
+

Select the pixel format (only valid for raw video input). +

+
+
input_format
+

Set the preferred pixel format (for raw video) or a codec name. +This option allows one to select the input format, when several are +available. +

+
+
framerate
+

Set the preferred video frame rate. +

+
+
list_formats
+

List available formats (supported pixel formats, codecs, and frame +sizes) and exit. +

+

Available values are: +

+
‘all’
+

Show all available (compressed and non-compressed) formats. +

+
+
‘raw’
+

Show only raw video (non-compressed) formats. +

+
+
‘compressed’
+

Show only compressed formats. +

+
+ +
+
list_standards
+

List supported standards and exit. +

+

Available values are: +

+
‘all’
+

Show all supported standards. +

+
+ +
+
timestamps, ts
+

Set type of timestamps for grabbed frames. +

+

Available values are: +

+
‘default’
+

Use timestamps from the kernel. +

+
+
‘abs’
+

Use absolute timestamps (wall clock). +

+
+
‘mono2abs’
+

Force conversion from monotonic to absolute timestamps. +

+
+ +

Default value is default. +

+
+
use_libv4l2
+

Use libv4l2 (v4l-utils) conversion functions. Default is 0. +

+
+
+ + +

3.20 vfwcap

+ +

VfW (Video for Windows) capture input device. +

+

The filename passed as input is the capture driver number, ranging from +0 to 9. You may use "list" as filename to print a list of drivers. Any +other filename will be interpreted as device number 0. +

+ +

3.20.1 Options

+ +
+
video_size
+

Set the video frame size. +

+
+
framerate
+

Set the grabbing frame rate. Default value is ntsc, +corresponding to a frame rate of 30000/1001. +

+
+
+ + +

3.21 x11grab

+ +

X11 video input device. +

+

To enable this input device during configuration you need libxcb +installed on your system. It will be automatically detected during +configuration. +

+

This device allows one to capture a region of an X11 display. +

+

The filename passed as input has the syntax: +

+
[hostname]:display_number.screen_number[+x_offset,y_offset]
+
+ +

hostname:display_number.screen_number specifies the +X11 display name of the screen to grab from. hostname can be +omitted, and defaults to "localhost". The environment variable +DISPLAY contains the default display name. +

+

x_offset and y_offset specify the offsets of the grabbed +area with respect to the top-left border of the X11 screen. They +default to 0. +

+

Check the X11 documentation (e.g. man X) for more detailed +information. +

+

Use the xdpyinfo program for getting basic information about +the properties of your X11 display (e.g. grep for "name" or +"dimensions"). +

+

For example to grab from :0.0 using ffmpeg: +

+
ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +

Grab at position 10,20: +

+
ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
+
+ + +

3.21.1 Options

+ +
+
draw_mouse
+

Specify whether to draw the mouse pointer. A value of 0 specifies +not to draw the pointer. Default value is 1. +

+
+
follow_mouse
+

Make the grabbed area follow the mouse. The argument can be +centered or a number of pixels PIXELS. +

+

When it is specified with "centered", the grabbing region follows the mouse +pointer and keeps the pointer at the center of region; otherwise, the region +follows only when the mouse pointer reaches within PIXELS (greater than +zero) to the edge of region. +

+

For example: +

+
ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +

To follow only when the mouse pointer reaches within 100 pixels to edge: +

+
ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +
+
framerate
+

Set the grabbing frame rate. Default value is ntsc, +corresponding to a frame rate of 30000/1001. +

+
+
show_region
+

Show grabbed region on screen. +

+

If show_region is specified with 1, then the grabbing +region will be indicated on screen. With this option, it is easy to +know what is being grabbed if only a portion of the screen is grabbed. +

+
+
region_border
+

Set the region border thickness if -show_region 1 is used. +Range is 1 to 128 and default is 3 (XCB-based x11grab only). +

+

For example: +

+
ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
+
+ +

With follow_mouse: +

+
ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +
+
video_size
+

Set the video frame size. Default is the full desktop. +

+
+
grab_x
+
grab_y
+

Set the grabbing region coordinates. They are expressed as offset from +the top left corner of the X11 window and correspond to the +x_offset and y_offset parameters in the device name. The +default value for both options is 0. +

+
+ + +

4 Output Devices

+ +

Output devices are configured elements in FFmpeg that can write +multimedia data to an output device attached to your system. +

+

When you configure your FFmpeg build, all the supported output devices +are enabled by default. You can list all available ones using the +configure option "–list-outdevs". +

+

You can disable all the output devices using the configure option +"–disable-outdevs", and selectively enable an output device using the +option "–enable-outdev=OUTDEV", or you can disable a particular +input device using the option "–disable-outdev=OUTDEV". +

+

The option "-devices" of the ff* tools will display the list of +enabled output devices. +

+

A description of the currently available output devices follows. +

+ +

4.1 alsa

+ +

ALSA (Advanced Linux Sound Architecture) output device. +

+ +

4.1.1 Examples

+ +
    +
  • Play a file on default ALSA device: +
    +
    ffmpeg -i INPUT -f alsa default
+
    + +
  • Play a file on soundcard 1, audio device 7: +
    +
    ffmpeg -i INPUT -f alsa hw:1,7
+
    +
+ + +

4.2 caca

+ +

CACA output device. +

+

This output device allows one to show a video stream in CACA window. +Only one CACA window is allowed per application, so you can +have only one instance of this output device in an application. +

+

To enable this output device you need to configure FFmpeg with +--enable-libcaca. +libcaca is a graphics library that outputs text instead of pixels. +

+

For more information about libcaca, check: +http://caca.zoy.org/wiki/libcaca +

+ +

4.2.1 Options

+ +
+
window_title
+

Set the CACA window title, if not specified default to the filename +specified for the output device. +

+
+
window_size
+

Set the CACA window size, can be a string of the form +widthxheight or a video size abbreviation. +If not specified it defaults to the size of the input video. +

+
+
driver
+

Set display driver. +

+
+
algorithm
+

Set dithering algorithm. Dithering is necessary +because the picture being rendered has usually far more colours than +the available palette. +The accepted values are listed with -list_dither algorithms. +

+
+
antialias
+

Set antialias method. Antialiasing smoothens the rendered +image and avoids the commonly seen staircase effect. +The accepted values are listed with -list_dither antialiases. +

+
+
charset
+

Set which characters are going to be used when rendering text. +The accepted values are listed with -list_dither charsets. +

+
+
color
+

Set color to be used when rendering text. +The accepted values are listed with -list_dither colors. +

+
+
list_drivers
+

If set to true, print a list of available drivers and exit. +

+
+
list_dither
+

List available dither options related to the argument. +The argument must be one of algorithms, antialiases, +charsets, colors. +

+
+ + +

4.2.2 Examples

+ +
    +
  • The following command shows the ffmpeg output is an +CACA window, forcing its size to 80x25: +
    +
    ffmpeg -i INPUT -c:v rawvideo -pix_fmt rgb24 -window_size 80x25 -f caca -
+
    + +
  • Show the list of available drivers and exit: +
    +
    ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_drivers true -
+
    + +
  • Show the list of available dither colors and exit: +
    +
    ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_dither colors -
+
    +
+ + +

4.3 decklink

+ +

The decklink output device provides playback capabilities for Blackmagic +DeckLink devices. +

+

To enable this output device, you need the Blackmagic DeckLink SDK and you +need to configure with the appropriate --extra-cflags +and --extra-ldflags. +On Windows, you need to run the IDL files through widl. +

+

DeckLink is very picky about the formats it supports. Pixel format is always +uyvy422, framerate, field order and video size must be determined for your +device with -list_formats 1. Audio sample rate is always 48 kHz. +

+ +

4.3.1 Options

+ +
+
list_devices
+

If set to true, print a list of devices and exit. +Defaults to false. This option is deprecated, please use the +-sinks option of ffmpeg to list the available output devices. +

+
+
list_formats
+

If set to true, print a list of supported formats and exit. +Defaults to false. +

+
+
preroll
+

Amount of time to preroll video in seconds. +Defaults to 0.5. +

+
+
duplex_mode
+

Sets the decklink device duplex mode. Must be ‘unset’, ‘half’ or ‘full’. +Defaults to ‘unset’. +

+
+
timing_offset
+

Sets the genlock timing pixel offset on the used output. +Defaults to ‘unset’. +

+
+
+ + +

4.3.2 Examples

+ +
    +
  • List output devices: +
    +
    ffmpeg -sinks decklink
+
    + +
  • List supported formats: +
    +
    ffmpeg -i test.avi -f decklink -list_formats 1 'DeckLink Mini Monitor'
+
    + +
  • Play video clip: +
    +
    ffmpeg -i test.avi -f decklink -pix_fmt uyvy422 'DeckLink Mini Monitor'
+
    + +
  • Play video clip with non-standard framerate or video size: +
    +
    ffmpeg -i test.avi -f decklink -pix_fmt uyvy422 -s 720x486 -r 24000/1001 'DeckLink Mini Monitor'
+
    + +
+ + +

4.4 fbdev

+ +

Linux framebuffer output device. +

+

The Linux framebuffer is a graphic hardware-independent abstraction +layer to show graphics on a computer monitor, typically on the +console. It is accessed through a file device node, usually +/dev/fb0. +

+

For more detailed information read the file +Documentation/fb/framebuffer.txt included in the Linux source tree. +

+ +

4.4.1 Options

+
+
xoffset
+
yoffset
+

Set x/y coordinate of top left corner. Default is 0. +

+
+ + +

4.4.2 Examples

+

Play a file on framebuffer device /dev/fb0. +Required pixel format depends on current framebuffer settings. +

+
ffmpeg -re -i INPUT -c:v rawvideo -pix_fmt bgra -f fbdev /dev/fb0
+
+ +

See also http://linux-fbdev.sourceforge.net/, and fbset(1). +

+ +

4.5 opengl

+

OpenGL output device. +

+

To enable this output device you need to configure FFmpeg with --enable-opengl. +

+

This output device allows one to render to OpenGL context. +Context may be provided by application or default SDL window is created. +

+

When device renders to external context, application must implement handlers for following messages: +AV_DEV_TO_APP_CREATE_WINDOW_BUFFER - create OpenGL context on current thread. +AV_DEV_TO_APP_PREPARE_WINDOW_BUFFER - make OpenGL context current. +AV_DEV_TO_APP_DISPLAY_WINDOW_BUFFER - swap buffers. +AV_DEV_TO_APP_DESTROY_WINDOW_BUFFER - destroy OpenGL context. +Application is also required to inform a device about current resolution by sending AV_APP_TO_DEV_WINDOW_SIZE message. +

+ +

4.5.1 Options

+
+
background
+

Set background color. Black is a default. +

+
no_window
+

Disables default SDL window when set to non-zero value. +Application must provide OpenGL context and both window_size_cb and window_swap_buffers_cb callbacks when set. +

+
window_title
+

Set the SDL window title, if not specified default to the filename specified for the output device. +Ignored when no_window is set. +

+
window_size
+

Set preferred window size, can be a string of the form widthxheight or a video size abbreviation. +If not specified it defaults to the size of the input video, downscaled according to the aspect ratio. +Mostly usable when no_window is not set. +

+
+
+ + +

4.5.2 Examples

+

Play a file on SDL window using OpenGL rendering: +

+
ffmpeg  -i INPUT -f opengl "window title"
+
+ + +

4.6 oss

+ +

OSS (Open Sound System) output device. +

+ +

4.7 pulse

+ +

PulseAudio output device. +

+

To enable this output device you need to configure FFmpeg with --enable-libpulse. +

+

More information about PulseAudio can be found on http://www.pulseaudio.org +

+ +

4.7.1 Options

+
+
server
+

Connect to a specific PulseAudio server, specified by an IP address. +Default server is used when not provided. +

+
+
name
+

Specify the application name PulseAudio will use when showing active clients, +by default it is the LIBAVFORMAT_IDENT string. +

+
+
stream_name
+

Specify the stream name PulseAudio will use when showing active streams, +by default it is set to the specified output name. +

+
+
device
+

Specify the device to use. Default device is used when not provided. +List of output devices can be obtained with command pactl list sinks. +

+
+
buffer_size
+
buffer_duration
+

Control the size and duration of the PulseAudio buffer. A small buffer +gives more control, but requires more frequent updates. +

+

buffer_size specifies size in bytes while +buffer_duration specifies duration in milliseconds. +

+

When both options are provided then the highest value is used +(duration is recalculated to bytes using stream parameters). If they +are set to 0 (which is default), the device will use the default +PulseAudio duration value. By default PulseAudio set buffer duration +to around 2 seconds. +

+
+
prebuf
+

Specify pre-buffering size in bytes. The server does not start with +playback before at least prebuf bytes are available in the +buffer. By default this option is initialized to the same value as +buffer_size or buffer_duration (whichever is bigger). +

+
+
minreq
+

Specify minimum request size in bytes. The server does not request less +than minreq bytes from the client, instead waits until the buffer +is free enough to request more bytes at once. It is recommended to not set +this option, which will initialize this to a value that is deemed sensible +by the server. +

+
+
+ + +

4.7.2 Examples

+

Play a file on default device on default server: +

+
ffmpeg  -i INPUT -f pulse "stream name"
+
+ + +

4.8 sdl

+ +

SDL (Simple DirectMedia Layer) output device. +

+

"sdl2" can be used as alias for "sdl". +

+

This output device allows one to show a video stream in an SDL +window. Only one SDL window is allowed per application, so you can +have only one instance of this output device in an application. +

+

To enable this output device you need libsdl installed on your system +when configuring your build. +

+

For more information about SDL, check: +http://www.libsdl.org/ +

+ +

4.8.1 Options

+ +
+
window_title
+

Set the SDL window title, if not specified default to the filename +specified for the output device. +

+
+
icon_title
+

Set the name of the iconified SDL window, if not specified it is set +to the same value of window_title. +

+
+
window_size
+

Set the SDL window size, can be a string of the form +widthxheight or a video size abbreviation. +If not specified it defaults to the size of the input video, +downscaled according to the aspect ratio. +

+
+
window_x
+
window_y
+

Set the position of the window on the screen. +

+
+
window_fullscreen
+

Set fullscreen mode when non-zero value is provided. +Default value is zero. +

+
+
window_enable_quit
+

Enable quit action (using window button or keyboard key) +when non-zero value is provided. +Default value is 1 (enable quit action) +

+
+ + +

4.8.2 Interactive commands

+ +

The window created by the device can be controlled through the +following interactive commands. +

+
+
q, ESC
+

Quit the device immediately. +

+
+ + +

4.8.3 Examples

+ +

The following command shows the ffmpeg output is an +SDL window, forcing its size to the qcif format: +

+
ffmpeg -i INPUT -c:v rawvideo -pix_fmt yuv420p -window_size qcif -f sdl "SDL output"
+
+ + +

4.9 sndio

+ +

sndio audio output device. +

+ +

4.10 v4l2

+ +

Video4Linux2 output device. +

+ +

4.11 xv

+ +

XV (XVideo) output device. +

+

This output device allows one to show a video stream in a X Window System +window. +

+ +

4.11.1 Options

+ +
+
display_name
+

Specify the hardware display name, which determines the display and +communications domain to be used. +

+

The display name or DISPLAY environment variable can be a string in +the format hostname[:number[.screen_number]]. +

+

hostname specifies the name of the host machine on which the +display is physically attached. number specifies the number of +the display server on that host machine. screen_number specifies +the screen to be used on that server. +

+

If unspecified, it defaults to the value of the DISPLAY environment +variable. +

+

For example, dual-headed:0.1 would specify screen 1 of display +0 on the machine named “dual-headed”. +

+

Check the X11 specification for more detailed information about the +display name format. +

+
+
window_id
+

When set to non-zero value then device doesn’t create new window, +but uses existing one with provided window_id. By default +this options is set to zero and device creates its own window. +

+
+
window_size
+

Set the created window size, can be a string of the form +widthxheight or a video size abbreviation. If not +specified it defaults to the size of the input video. +Ignored when window_id is set. +

+
+
window_x
+
window_y
+

Set the X and Y window offsets for the created window. They are both +set to 0 by default. The values may be ignored by the window manager. +Ignored when window_id is set. +

+
+
window_title
+

Set the window title, if not specified default to the filename +specified for the output device. Ignored when window_id is set. +

+
+ +

For more information about XVideo see http://www.x.org/. +

+ +

4.11.2 Examples

+ +
    +
  • Decode, display and encode video input with ffmpeg at the +same time: +
    +
    ffmpeg -i INPUT OUTPUT -f xv display
+
    + +
  • Decode and display the input video to multiple X11 windows: +
    +
    ffmpeg -i INPUT -f xv normal -vf negate -f xv negated
+
    +
+ + + +

5 See Also

+ +

ffmpeg, ffplay, ffprobe, +libavdevice +

+ + +

6 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-filters.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-filters.html new file mode 100644 index 0000000..d699a7d --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-filters.html @@ -0,0 +1,30241 @@ + + + + + + + FFmpeg Filters Documentation + + + + + + +
+

+ FFmpeg Filters Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

This document describes filters, sources, and sinks provided by the +libavfilter library. +

+ + +

2 Filtering Introduction

+ +

Filtering in FFmpeg is enabled through the libavfilter library. +

+

In libavfilter, a filter can have multiple inputs and multiple +outputs. +To illustrate the sorts of things that are possible, we consider the +following filtergraph. +

+
                [main]
+input --> split ---------------------> overlay --> output
+            |                             ^
+            |[tmp]                  [flip]|
+            +-----> crop --> vflip -------+
+
+

This filtergraph splits the input stream in two streams, then sends one +stream through the crop filter and the vflip filter, before merging it +back with the other stream by overlaying it on top. You can use the +following command to achieve this: +

+
+
ffmpeg -i INPUT -vf "split [main][tmp]; [tmp] crop=iw:ih/2:0:0, vflip [flip]; [main][flip] overlay=0:H/2" OUTPUT
+
+ +

The result will be that the top half of the video is mirrored +onto the bottom half of the output video. +

+

Filters in the same linear chain are separated by commas, and distinct +linear chains of filters are separated by semicolons. In our example, +crop,vflip are in one linear chain, split and +overlay are separately in another. The points where the linear +chains join are labelled by names enclosed in square brackets. In the +example, the split filter generates two outputs that are associated to +the labels [main] and [tmp]. +

+

The stream sent to the second output of split, labelled as +[tmp], is processed through the crop filter, which crops +away the lower half part of the video, and then vertically flipped. The +overlay filter takes in input the first unchanged output of the +split filter (which was labelled as [main]), and overlay on its +lower half the output generated by the crop,vflip filterchain. +

+

Some filters take in input a list of parameters: they are specified +after the filter name and an equal sign, and are separated from each other +by a colon. +

+

There exist so-called source filters that do not have an +audio/video input, and sink filters that will not have audio/video +output. +

+ + +

3 graph2dot

+ +

The graph2dot program included in the FFmpeg tools +directory can be used to parse a filtergraph description and issue a +corresponding textual representation in the dot language. +

+

Invoke the command: +

+
graph2dot -h
+
+ +

to see how to use graph2dot. +

+

You can then pass the dot description to the dot program (from +the graphviz suite of programs) and obtain a graphical representation +of the filtergraph. +

+

For example the sequence of commands: +

+
echo GRAPH_DESCRIPTION | \
+tools/graph2dot -o graph.tmp && \
+dot -Tpng graph.tmp -o graph.png && \
+display graph.png
+
+ +

can be used to create and display an image representing the graph +described by the GRAPH_DESCRIPTION string. Note that this string must be +a complete self-contained graph, with its inputs and outputs explicitly defined. +For example if your command line is of the form: +

+
ffmpeg -i infile -vf scale=640:360 outfile
+
+

your GRAPH_DESCRIPTION string will need to be of the form: +

+
nullsrc,scale=640:360,nullsink
+
+

you may also need to set the nullsrc parameters and add a format +filter in order to simulate a specific input file. +

+ + +

4 Filtergraph description

+ +

A filtergraph is a directed graph of connected filters. It can contain +cycles, and there can be multiple links between a pair of +filters. Each link has one input pad on one side connecting it to one +filter from which it takes its input, and one output pad on the other +side connecting it to one filter accepting its output. +

+

Each filter in a filtergraph is an instance of a filter class +registered in the application, which defines the features and the +number of input and output pads of the filter. +

+

A filter with no input pads is called a "source", and a filter with no +output pads is called a "sink". +

+ +

4.1 Filtergraph syntax

+ +

A filtergraph has a textual representation, which is recognized by the +-filter/-vf/-af and +-filter_complex options in ffmpeg and +-vf/-af in ffplay, and by the +avfilter_graph_parse_ptr() function defined in +libavfilter/avfilter.h. +

+

A filterchain consists of a sequence of connected filters, each one +connected to the previous one in the sequence. A filterchain is +represented by a list of ","-separated filter descriptions. +

+

A filtergraph consists of a sequence of filterchains. A sequence of +filterchains is represented by a list of ";"-separated filterchain +descriptions. +

+

A filter is represented by a string of the form: +[in_link_1]...[in_link_N]filter_name@id=arguments[out_link_1]...[out_link_M] +

+

filter_name is the name of the filter class of which the +described filter is an instance of, and has to be the name of one of +the filter classes registered in the program optionally followed by "@id". +The name of the filter class is optionally followed by a string +"=arguments". +

+

arguments is a string which contains the parameters used to +initialize the filter instance. It may have one of two forms: +

    +
  • A ’:’-separated list of key=value pairs. + +
  • A ’:’-separated list of value. In this case, the keys are assumed to be +the option names in the order they are declared. E.g. the fade filter +declares three options in this order – type, start_frame and +nb_frames. Then the parameter list in:0:30 means that the value +in is assigned to the option type, 0 to +start_frame and 30 to nb_frames. + +
  • A ’:’-separated list of mixed direct value and long key=value +pairs. The direct value must precede the key=value pairs, and +follow the same constraints order of the previous point. The following +key=value pairs can be set in any preferred order. + +
+ +

If the option value itself is a list of items (e.g. the format filter +takes a list of pixel formats), the items in the list are usually separated by +‘|’. +

+

The list of arguments can be quoted using the character ‘'’ as initial +and ending mark, and the character ‘\’ for escaping the characters +within the quoted text; otherwise the argument string is considered +terminated when the next special character (belonging to the set +‘[]=;,’) is encountered. +

+

The name and arguments of the filter are optionally preceded and +followed by a list of link labels. +A link label allows one to name a link and associate it to a filter output +or input pad. The preceding labels in_link_1 +... in_link_N, are associated to the filter input pads, +the following labels out_link_1 ... out_link_M, are +associated to the output pads. +

+

When two link labels with the same name are found in the +filtergraph, a link between the corresponding input and output pad is +created. +

+

If an output pad is not labelled, it is linked by default to the first +unlabelled input pad of the next filter in the filterchain. +For example in the filterchain +

+
nullsrc, split[L1], [L2]overlay, nullsink
+
+

the split filter instance has two output pads, and the overlay filter +instance two input pads. The first output pad of split is labelled +"L1", the first input pad of overlay is labelled "L2", and the second +output pad of split is linked to the second input pad of overlay, +which are both unlabelled. +

+

In a filter description, if the input label of the first filter is not +specified, "in" is assumed; if the output label of the last filter is not +specified, "out" is assumed. +

+

In a complete filterchain all the unlabelled filter input and output +pads must be connected. A filtergraph is considered valid if all the +filter input and output pads of all the filterchains are connected. +

+

Libavfilter will automatically insert scale filters where format +conversion is required. It is possible to specify swscale flags +for those automatically inserted scalers by prepending +sws_flags=flags; +to the filtergraph description. +

+

Here is a BNF description of the filtergraph syntax: +

+
NAME             ::= sequence of alphanumeric characters and '_'
+FILTER_NAME      ::= NAME["@"NAME]
+LINKLABEL        ::= "[" NAME "]"
+LINKLABELS       ::= LINKLABEL [LINKLABELS]
+FILTER_ARGUMENTS ::= sequence of chars (possibly quoted)
+FILTER           ::= [LINKLABELS] FILTER_NAME ["=" FILTER_ARGUMENTS] [LINKLABELS]
+FILTERCHAIN      ::= FILTER [,FILTERCHAIN]
+FILTERGRAPH      ::= [sws_flags=flags;] FILTERCHAIN [;FILTERGRAPH]
+
+ + +

4.2 Notes on filtergraph escaping

+ +

Filtergraph description composition entails several levels of +escaping. See (ffmpeg-utils)the "Quoting and escaping" +section in the ffmpeg-utils(1) manual for more +information about the employed escaping procedure. +

+

A first level escaping affects the content of each filter option +value, which may contain the special character : used to +separate values, or one of the escaping characters \'. +

+

A second level escaping affects the whole filter description, which +may contain the escaping characters \' or the special +characters [],; used by the filtergraph description. +

+

Finally, when you specify a filtergraph on a shell commandline, you +need to perform a third level escaping for the shell special +characters contained within it. +

+

For example, consider the following string to be embedded in +the drawtext filter description text value: +

+
this is a 'string': may contain one, or more, special characters
+
+ +

This string contains the ' special escaping character, and the +: special character, so it needs to be escaped in this way: +

+
text=this is a \'string\'\: may contain one, or more, special characters
+
+ +

A second level of escaping is required when embedding the filter +description in a filtergraph description, in order to escape all the +filtergraph special characters. Thus the example above becomes: +

+
drawtext=text=this is a \\\'string\\\'\\: may contain one\, or more\, special characters
+
+

(note that in addition to the \' escaping special characters, +also , needs to be escaped). +

+

Finally an additional level of escaping is needed when writing the +filtergraph description in a shell command, which depends on the +escaping rules of the adopted shell. For example, assuming that +\ is special and needs to be escaped with another \, the +previous string will finally result in: +

+
-vf "drawtext=text=this is a \\\\\\'string\\\\\\'\\\\: may contain one\\, or more\\, special characters"
+
+ + +

5 Timeline editing

+ +

Some filters support a generic enable option. For the filters +supporting timeline editing, this option can be set to an expression which is +evaluated before sending a frame to the filter. If the evaluation is non-zero, +the filter will be enabled, otherwise the frame will be sent unchanged to the +next filter in the filtergraph. +

+

The expression accepts the following values: +

+
‘t’
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+
‘n’
+

sequential number of the input frame, starting from 0 +

+
+
‘pos’
+

the position in the file of the input frame, NAN if unknown +

+
+
‘w’
+
‘h’
+

width and height of the input frame if video +

+
+ +

Additionally, these filters support an enable command that can be used +to re-define the expression. +

+

Like any other filtering option, the enable option follows the same +rules. +

+

For example, to enable a blur filter (smartblur) from 10 seconds to 3 +minutes, and a curves filter starting at 3 seconds: +

+
smartblur = enable='between(t,10,3*60)',
+curves    = enable='gte(t,3)' : preset=cross_process
+
+ +

See ffmpeg -filters to view which filters have timeline support. +

+ + +

6 Changing options at runtime with a command

+ +

Some options can be changed during the operation of the filter using +a command. These options are marked ’T’ on the output of +ffmpeg -h filter=<name of filter>. +The name of the command is the name of the option and the argument is +the new value. +

+ +

7 Options for filters with several inputs (framesync)

+ +

Some filters with several inputs support a common set of options. +These options can only be set by name, not with the short notation. +

+
+
eof_action
+

The action to take when EOF is encountered on the secondary input; it accepts +one of the following values: +

+
+
repeat
+

Repeat the last frame (the default). +

+
endall
+

End both streams. +

+
pass
+

Pass the main input through. +

+
+ +
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+
repeatlast
+

If set to 1, force the filter to extend the last frame of secondary streams +until the end of the primary stream. A value of 0 disables this behavior. +Default value is 1. +

+
+ + + +

8 Audio Filters

+ +

When you configure your FFmpeg build, you can disable any of the +existing filters using --disable-filters. +The configure output will show the audio filters included in your +build. +

+

Below is a description of the currently available audio filters. +

+ +

8.1 acompressor

+ +

A compressor is mainly used to reduce the dynamic range of a signal. +Especially modern music is mostly compressed at a high ratio to +improve the overall loudness. It’s done to get the highest attention +of a listener, "fatten" the sound and bring more "power" to the track. +If a signal is compressed too much it may sound dull or "dead" +afterwards or it may start to "pump" (which could be a powerful effect +but can also destroy a track completely). +The right compression is the key to reach a professional sound and is +the high art of mixing and mastering. Because of its complex settings +it may take a long time to get the right feeling for this kind of effect. +

+

Compression is done by detecting the volume above a chosen level +threshold and dividing it by the factor set with ratio. +So if you set the threshold to -12dB and your signal reaches -6dB a ratio +of 2:1 will result in a signal at -9dB. Because an exact manipulation of +the signal would cause distortion of the waveform the reduction can be +levelled over the time. This is done by setting "Attack" and "Release". +attack determines how long the signal has to rise above the threshold +before any reduction will occur and release sets the time the signal +has to fall below the threshold to reduce the reduction again. Shorter signals +than the chosen attack time will be left untouched. +The overall reduction of the signal can be made up afterwards with the +makeup setting. So compressing the peaks of a signal about 6dB and +raising the makeup to this level results in a signal twice as loud than the +source. To gain a softer entry in the compression the knee flattens the +hard edge at the threshold in the range of the chosen decibels. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. Default is 1. Range is between 0.015625 and 64. +

+
+
mode
+

Set mode of compressor operation. Can be upward or downward. +Default is downward. +

+
+
threshold
+

If a signal of stream rises above this level it will affect the gain +reduction. +By default it is 0.125. Range is between 0.00097563 and 1. +

+
+
ratio
+

Set a ratio by which the signal is reduced. 1:2 means that if the level +rose 4dB above the threshold, it will be only 2dB above after the reduction. +Default is 2. Range is between 1 and 20. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction starts. Default is 20. Range is between 0.01 and 2000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before +reduction is decreased again. Default is 250. Range is between 0.01 and 9000. +

+
+
makeup
+

Set the amount by how much signal will be amplified after processing. +Default is 1. Range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.82843. Range is between 1 and 8. +

+
+
link
+

Choose if the average level between all channels of input stream +or the louder(maximum) channel of input stream affects the +reduction. Default is average. +

+
+
detection
+

Should the exact signal be taken in case of peak or an RMS one in case +of rms. Default is rms which is mostly smoother. +

+
+
mix
+

How much to use compressed signal in output. Default is 1. +Range is between 0 and 1. +

+
+ + +

8.1.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

8.2 acontrast

+

Simple audio dynamic range compression/expansion filter. +

+

The filter accepts the following options: +

+
+
contrast
+

Set contrast. Default is 33. Allowed range is between 0 and 100. +

+
+ + +

8.3 acopy

+ +

Copy the input audio source unchanged to the output. This is mainly useful for +testing purposes. +

+ +

8.4 acrossfade

+ +

Apply cross fade from one input audio stream to another input audio stream. +The cross fade is applied for specified duration near the end of first stream. +

+

The filter accepts the following options: +

+
+
nb_samples, ns
+

Specify the number of samples for which the cross fade effect has to last. +At the end of the cross fade effect the first input audio will be completely +silent. Default is 44100. +

+
+
duration, d
+

Specify the duration of the cross fade effect. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +By default the duration is determined by nb_samples. +If set this option is used instead of nb_samples. +

+
+
overlap, o
+

Should first stream end overlap with second stream start. Default is enabled. +

+
+
curve1
+

Set curve for cross fade transition for first stream. +

+
+
curve2
+

Set curve for cross fade transition for second stream. +

+

For description of available curve types see afade filter description. +

+
+ + +

8.4.1 Examples

+ +
    +
  • Cross fade from one input to another: +
    +
    ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:c1=exp:c2=exp output.flac
+
    + +
  • Cross fade from one input to another but without overlapping: +
    +
    ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:o=0:c1=exp:c2=exp output.flac
+
    +
+ + +

8.5 acrossover

+

Split audio stream into several bands. +

+

This filter splits audio stream into two or more frequency ranges. +Summing all streams back will give flat output. +

+

The filter accepts the following options: +

+
+
split
+

Set split frequencies. Those must be positive and increasing. +

+
+
order
+

Set filter order, can be 2nd, 4th or 8th. +Default is 4th. +

+
+ + +

8.6 acrusher

+ +

Reduce audio bit resolution. +

+

This filter is bit crusher with enhanced functionality. A bit crusher +is used to audibly reduce number of bits an audio signal is sampled +with. This doesn’t change the bit depth at all, it just produces the +effect. Material reduced in bit depth sounds more harsh and "digital". +This filter is able to even round to continuous values instead of discrete +bit depths. +Additionally it has a D/C offset which results in different crushing of +the lower and the upper half of the signal. +An Anti-Aliasing setting is able to produce "softer" crushing sounds. +

+

Another feature of this filter is the logarithmic mode. +This setting switches from linear distances between bits to logarithmic ones. +The result is a much more "natural" sounding crusher which doesn’t gate low +signals for example. The human ear has a logarithmic perception, +so this kind of crushing is much more pleasant. +Logarithmic crushing is also able to get anti-aliased. +

+

The filter accepts the following options: +

+
+
level_in
+

Set level in. +

+
+
level_out
+

Set level out. +

+
+
bits
+

Set bit reduction. +

+
+
mix
+

Set mixing amount. +

+
+
mode
+

Can be linear: lin or logarithmic: log. +

+
+
dc
+

Set DC. +

+
+
aa
+

Set anti-aliasing. +

+
+
samples
+

Set sample reduction. +

+
+
lfo
+

Enable LFO. By default disabled. +

+
+
lforange
+

Set LFO range. +

+
+
lforate
+

Set LFO rate. +

+
+ + +

8.7 acue

+ +

Delay audio filtering until a given wallclock timestamp. See the cue +filter. +

+ +

8.8 adeclick

+

Remove impulsive noise from input audio. +

+

Samples detected as impulsive noise are replaced by interpolated samples using +autoregressive modelling. +

+
+
w
+

Set window size, in milliseconds. Allowed range is from 10 to +100. Default value is 55 milliseconds. +This sets size of window which will be processed at once. +

+
+
o
+

Set window overlap, in percentage of window size. Allowed range is from +50 to 95. Default value is 75 percent. +Setting this to a very high value increases impulsive noise removal but makes +whole process much slower. +

+
+
a
+

Set autoregression order, in percentage of window size. Allowed range is from +0 to 25. Default value is 2 percent. This option also +controls quality of interpolated samples using neighbour good samples. +

+
+
t
+

Set threshold value. Allowed range is from 1 to 100. +Default value is 2. +This controls the strength of impulsive noise which is going to be removed. +The lower value, the more samples will be detected as impulsive noise. +

+
+
b
+

Set burst fusion, in percentage of window size. Allowed range is 0 to +10. Default value is 2. +If any two samples detected as noise are spaced less than this value then any +sample between those two samples will be also detected as noise. +

+
+
m
+

Set overlap method. +

+

It accepts the following values: +

+
a
+

Select overlap-add method. Even not interpolated samples are slightly +changed with this method. +

+
+
s
+

Select overlap-save method. Not interpolated samples remain unchanged. +

+
+ +

Default value is a. +

+
+ + +

8.9 adeclip

+

Remove clipped samples from input audio. +

+

Samples detected as clipped are replaced by interpolated samples using +autoregressive modelling. +

+
+
w
+

Set window size, in milliseconds. Allowed range is from 10 to 100. +Default value is 55 milliseconds. +This sets size of window which will be processed at once. +

+
+
o
+

Set window overlap, in percentage of window size. Allowed range is from 50 +to 95. Default value is 75 percent. +

+
+
a
+

Set autoregression order, in percentage of window size. Allowed range is from +0 to 25. Default value is 8 percent. This option also controls +quality of interpolated samples using neighbour good samples. +

+
+
t
+

Set threshold value. Allowed range is from 1 to 100. +Default value is 10. Higher values make clip detection less aggressive. +

+
+
n
+

Set size of histogram used to detect clips. Allowed range is from 100 to 9999. +Default value is 1000. Higher values make clip detection less aggressive. +

+
+
m
+

Set overlap method. +

+

It accepts the following values: +

+
a
+

Select overlap-add method. Even not interpolated samples are slightly changed +with this method. +

+
+
s
+

Select overlap-save method. Not interpolated samples remain unchanged. +

+
+ +

Default value is a. +

+
+ + +

8.10 adelay

+ +

Delay one or more audio channels. +

+

Samples in delayed channel are filled with silence. +

+

The filter accepts the following option: +

+
+
delays
+

Set list of delays in milliseconds for each channel separated by ’|’. +Unused delays will be silently ignored. If number of given delays is +smaller than number of channels all remaining channels will not be delayed. +If you want to delay exact number of samples, append ’S’ to number. +If you want instead to delay in seconds, append ’s’ to number. +

+
+
all
+

Use last set delay for all remaining channels. By default is disabled. +This option if enabled changes how option delays is interpreted. +

+
+ + +

8.10.1 Examples

+ +
    +
  • Delay first channel by 1.5 seconds, the third channel by 0.5 seconds and leave +the second channel (and any other channels that may be present) unchanged. +
    +
    adelay=1500|0|500
+
    + +
  • Delay second channel by 500 samples, the third channel by 700 samples and leave +the first channel (and any other channels that may be present) unchanged. +
    +
    adelay=0|500S|700S
+
    + +
  • Delay all channels by same number of samples: +
    +
    adelay=delays=64S:all=1
+
    +
+ + +

8.11 aderivative, aintegral

+ +

Compute derivative/integral of audio stream. +

+

Applying both filters one after another produces original audio. +

+ +

8.12 aecho

+ +

Apply echoing to the input audio. +

+

Echoes are reflected sound and can occur naturally amongst mountains +(and sometimes large buildings) when talking or shouting; digital echo +effects emulate this behaviour and are often used to help fill out the +sound of a single instrument or vocal. The time difference between the +original signal and the reflection is the delay, and the +loudness of the reflected signal is the decay. +Multiple echoes can have different delays and decays. +

+

A description of the accepted parameters follows. +

+
+
in_gain
+

Set input gain of reflected signal. Default is 0.6. +

+
+
out_gain
+

Set output gain of reflected signal. Default is 0.3. +

+
+
delays
+

Set list of time intervals in milliseconds between original signal and reflections +separated by ’|’. Allowed range for each delay is (0 - 90000.0]. +Default is 1000. +

+
+
decays
+

Set list of loudness of reflected signals separated by ’|’. +Allowed range for each decay is (0 - 1.0]. +Default is 0.5. +

+
+ + +

8.12.1 Examples

+ +
    +
  • Make it sound as if there are twice as many instruments as are actually playing: +
    +
    aecho=0.8:0.88:60:0.4
+
    + +
  • If delay is very short, then it sounds like a (metallic) robot playing music: +
    +
    aecho=0.8:0.88:6:0.4
+
    + +
  • A longer delay will sound like an open air concert in the mountains: +
    +
    aecho=0.8:0.9:1000:0.3
+
    + +
  • Same as above but with one more mountain: +
    +
    aecho=0.8:0.9:1000|1800:0.3|0.25
+
    +
+ + +

8.13 aemphasis

+

Audio emphasis filter creates or restores material directly taken from LPs or +emphased CDs with different filter curves. E.g. to store music on vinyl the +signal has to be altered by a filter first to even out the disadvantages of +this recording medium. +Once the material is played back the inverse filter has to be applied to +restore the distortion of the frequency response. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. +

+
+
level_out
+

Set output gain. +

+
+
mode
+

Set filter mode. For restoring material use reproduction mode, otherwise +use production mode. Default is reproduction mode. +

+
+
type
+

Set filter type. Selects medium. Can be one of the following: +

+
+
col
+

select Columbia. +

+
emi
+

select EMI. +

+
bsi
+

select BSI (78RPM). +

+
riaa
+

select RIAA. +

+
cd
+

select Compact Disc (CD). +

+
50fm
+

select 50µs (FM). +

+
75fm
+

select 75µs (FM). +

+
50kf
+

select 50µs (FM-KF). +

+
75kf
+

select 75µs (FM-KF). +

+
+
+
+ + +

8.14 aeval

+ +

Modify an audio signal according to the specified expressions. +

+

This filter accepts one or more expressions (one for each channel), +which are evaluated and used to modify a corresponding audio signal. +

+

It accepts the following parameters: +

+
+
exprs
+

Set the ’|’-separated expressions list for each separate channel. If +the number of input channels is greater than the number of +expressions, the last specified expression is used for the remaining +output channels. +

+
+
channel_layout, c
+

Set output channel layout. If not specified, the channel layout is +specified by the number of expressions. If set to ‘same’, it will +use by default the same input channel layout. +

+
+ +

Each expression in exprs can contain the following constants and functions: +

+
+
ch
+

channel number of the current expression +

+
+
n
+

number of the evaluated sample, starting from 0 +

+
+
s
+

sample rate +

+
+
t
+

time of the evaluated sample expressed in seconds +

+
+
nb_in_channels
+
nb_out_channels
+

input and output number of channels +

+
+
val(CH)
+

the value of input channel with number CH +

+
+ +

Note: this filter is slow. For faster processing you should use a +dedicated filter. +

+ +

8.14.1 Examples

+ +
    +
  • Half volume: +
    +
    aeval=val(ch)/2:c=same
+
    + +
  • Invert phase of the second channel: +
    +
    aeval=val(0)|-val(1)
+
    +
+ + +

8.15 afade

+ +

Apply fade-in/out effect to input audio. +

+

A description of the accepted parameters follows. +

+
+
type, t
+

Specify the effect type, can be either in for fade-in, or +out for a fade-out effect. Default is in. +

+
+
start_sample, ss
+

Specify the number of the start sample for starting to apply the fade +effect. Default is 0. +

+
+
nb_samples, ns
+

Specify the number of samples for which the fade effect has to last. At +the end of the fade-in effect the output audio will have the same +volume as the input audio, at the end of the fade-out transition +the output audio will be silence. Default is 44100. +

+
+
start_time, st
+

Specify the start time of the fade effect. Default is 0. +The value must be specified as a time duration; see +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +If set this option is used instead of start_sample. +

+
+
duration, d
+

Specify the duration of the fade effect. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +At the end of the fade-in effect the output audio will have the same +volume as the input audio, at the end of the fade-out transition +the output audio will be silence. +By default the duration is determined by nb_samples. +If set this option is used instead of nb_samples. +

+
+
curve
+

Set curve for fade transition. +

+

It accepts the following values: +

+
tri
+

select triangular, linear slope (default) +

+
qsin
+

select quarter of sine wave +

+
hsin
+

select half of sine wave +

+
esin
+

select exponential sine wave +

+
log
+

select logarithmic +

+
ipar
+

select inverted parabola +

+
qua
+

select quadratic +

+
cub
+

select cubic +

+
squ
+

select square root +

+
cbr
+

select cubic root +

+
par
+

select parabola +

+
exp
+

select exponential +

+
iqsin
+

select inverted quarter of sine wave +

+
ihsin
+

select inverted half of sine wave +

+
dese
+

select double-exponential seat +

+
desi
+

select double-exponential sigmoid +

+
losi
+

select logistic sigmoid +

+
nofade
+

no fade applied +

+
+
+
+ + +

8.15.1 Examples

+ +
    +
  • Fade in first 15 seconds of audio: +
    +
    afade=t=in:ss=0:d=15
+
    + +
  • Fade out last 25 seconds of a 900 seconds audio: +
    +
    afade=t=out:st=875:d=25
+
    +
+ + +

8.16 afftdn

+

Denoise audio samples with FFT. +

+

A description of the accepted parameters follows. +

+
+
nr
+

Set the noise reduction in dB, allowed range is 0.01 to 97. +Default value is 12 dB. +

+
+
nf
+

Set the noise floor in dB, allowed range is -80 to -20. +Default value is -50 dB. +

+
+
nt
+

Set the noise type. +

+

It accepts the following values: +

+
w
+

Select white noise. +

+
+
v
+

Select vinyl noise. +

+
+
s
+

Select shellac noise. +

+
+
c
+

Select custom noise, defined in bn option. +

+

Default value is white noise. +

+
+ +
+
bn
+

Set custom band noise for every one of 15 bands. +Bands are separated by ’ ’ or ’|’. +

+
+
rf
+

Set the residual floor in dB, allowed range is -80 to -20. +Default value is -38 dB. +

+
+
tn
+

Enable noise tracking. By default is disabled. +With this enabled, noise floor is automatically adjusted. +

+
+
tr
+

Enable residual tracking. By default is disabled. +

+
+
om
+

Set the output mode. +

+

It accepts the following values: +

+
i
+

Pass input unchanged. +

+
+
o
+

Pass noise filtered out. +

+
+
n
+

Pass only noise. +

+

Default value is o. +

+
+
+
+ + +

8.16.1 Commands

+ +

This filter supports the following commands: +

+
sample_noise, sn
+

Start or stop measuring noise profile. +Syntax for the command is : "start" or "stop" string. +After measuring noise profile is stopped it will be +automatically applied in filtering. +

+
+
noise_reduction, nr
+

Change noise reduction. Argument is single float number. +Syntax for the command is : "noise_reduction" +

+
+
noise_floor, nf
+

Change noise floor. Argument is single float number. +Syntax for the command is : "noise_floor" +

+
+
output_mode, om
+

Change output mode operation. +Syntax for the command is : "i", "o" or "n" string. +

+
+ + +

8.17 afftfilt

+

Apply arbitrary expressions to samples in frequency domain. +

+
+
real
+

Set frequency domain real expression for each separate channel separated +by ’|’. Default is "re". +If the number of input channels is greater than the number of +expressions, the last specified expression is used for the remaining +output channels. +

+
+
imag
+

Set frequency domain imaginary expression for each separate channel +separated by ’|’. Default is "im". +

+

Each expression in real and imag can contain the following +constants and functions: +

+
+
sr
+

sample rate +

+
+
b
+

current frequency bin number +

+
+
nb
+

number of available bins +

+
+
ch
+

channel number of the current expression +

+
+
chs
+

number of channels +

+
+
pts
+

current frame pts +

+
+
re
+

current real part of frequency bin of current channel +

+
+
im
+

current imaginary part of frequency bin of current channel +

+
+
real(b, ch)
+

Return the value of real part of frequency bin at location (bin,channel) +

+
+
imag(b, ch)
+

Return the value of imaginary part of frequency bin at location (bin,channel) +

+
+ +
+
win_size
+

Set window size. Allowed range is from 16 to 131072. +Default is 4096 +

+
+
win_func
+

Set window function. Default is hann. +

+
+
overlap
+

Set window overlap. If set to 1, the recommended overlap for selected +window function will be picked. Default is 0.75. +

+
+ + +

8.17.1 Examples

+ +
    +
  • Leave almost only low frequencies in audio: +
    +
    afftfilt="'real=re * (1-clip((b/nb)*b,0,1))':imag='im * (1-clip((b/nb)*b,0,1))'"
+
    + +
  • Apply robotize effect: +
    +
    afftfilt="real='hypot(re,im)*sin(0)':imag='hypot(re,im)*cos(0)':win_size=512:overlap=0.75"
+
    + +
  • Apply whisper effect: +
    +
    afftfilt="real='hypot(re,im)*cos((random(0)*2-1)*2*3.14)':imag='hypot(re,im)*sin((random(1)*2-1)*2*3.14)':win_size=128:overlap=0.8"
+
    +
+ + +

8.18 afir

+ +

Apply an arbitrary Finite Impulse Response filter. +

+

This filter is designed for applying long FIR filters, +up to 60 seconds long. +

+

It can be used as component for digital crossover filters, +room equalization, cross talk cancellation, wavefield synthesis, +auralization, ambiophonics, ambisonics and spatialization. +

+

This filter uses the streams higher than first one as FIR coefficients. +If the non-first stream holds a single channel, it will be used +for all input channels in the first stream, otherwise +the number of channels in the non-first stream must be same as +the number of channels in the first stream. +

+

It accepts the following parameters: +

+
+
dry
+

Set dry gain. This sets input gain. +

+
+
wet
+

Set wet gain. This sets final output gain. +

+
+
length
+

Set Impulse Response filter length. Default is 1, which means whole IR is processed. +

+
+
gtype
+

Enable applying gain measured from power of IR. +

+

Set which approach to use for auto gain measurement. +

+
+
none
+

Do not apply any gain. +

+
+
peak
+

select peak gain, very conservative approach. This is default value. +

+
+
dc
+

select DC gain, limited application. +

+
+
gn
+

select gain to noise approach, this is most popular one. +

+
+ +
+
irgain
+

Set gain to be applied to IR coefficients before filtering. +Allowed range is 0 to 1. This gain is applied after any gain applied with gtype option. +

+
+
irfmt
+

Set format of IR stream. Can be mono or input. +Default is input. +

+
+
maxir
+

Set max allowed Impulse Response filter duration in seconds. Default is 30 seconds. +Allowed range is 0.1 to 60 seconds. +

+
+
response
+

Show IR frequency response, magnitude(magenta), phase(green) and group delay(yellow) in additional video stream. +By default it is disabled. +

+
+
channel
+

Set for which IR channel to display frequency response. By default is first channel +displayed. This option is used only when response is enabled. +

+
+
size
+

Set video stream size. This option is used only when response is enabled. +

+
+
rate
+

Set video stream frame rate. This option is used only when response is enabled. +

+
+
minp
+

Set minimal partition size used for convolution. Default is 8192. +Allowed range is from 1 to 32768. +Lower values decreases latency at cost of higher CPU usage. +

+
+
maxp
+

Set maximal partition size used for convolution. Default is 8192. +Allowed range is from 8 to 32768. +Lower values may increase CPU usage. +

+
+
nbirs
+

Set number of input impulse responses streams which will be switchable at runtime. +Allowed range is from 1 to 32. Default is 1. +

+
+
ir
+

Set IR stream which will be used for convolution, starting from 0, should always be +lower than supplied value by nbirs option. Default is 0. +This option can be changed at runtime via commands. +

+
+ + +

8.18.1 Examples

+ +
    +
  • Apply reverb to stream using mono IR file as second input, complete command using ffmpeg: +
    +
    ffmpeg -i input.wav -i middle_tunnel_1way_mono.wav -lavfi afir output.wav
+
    +
+ + +

8.19 aformat

+ +

Set output format constraints for the input audio. The framework will +negotiate the most appropriate format to minimize conversions. +

+

It accepts the following parameters: +

+
sample_fmts, f
+

A ’|’-separated list of requested sample formats. +

+
+
sample_rates, r
+

A ’|’-separated list of requested sample rates. +

+
+
channel_layouts, cl
+

A ’|’-separated list of requested channel layouts. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+ +

If a parameter is omitted, all values are allowed. +

+

Force the output to either unsigned 8-bit or signed 16-bit stereo +

+
aformat=sample_fmts=u8|s16:channel_layouts=stereo
+
+ + +

8.20 agate

+ +

A gate is mainly used to reduce lower parts of a signal. This kind of signal +processing reduces disturbing noise between useful signals. +

+

Gating is done by detecting the volume below a chosen level threshold +and dividing it by the factor set with ratio. The bottom of the noise +floor is set via range. Because an exact manipulation of the signal +would cause distortion of the waveform the reduction can be levelled over +time. This is done by setting attack and release. +

+

attack determines how long the signal has to fall below the threshold +before any reduction will occur and release sets the time the signal +has to rise above the threshold to reduce the reduction again. +Shorter signals than the chosen attack time will be left untouched. +

+
+
level_in
+

Set input level before filtering. +Default is 1. Allowed range is from 0.015625 to 64. +

+
+
mode
+

Set the mode of operation. Can be upward or downward. +Default is downward. If set to upward mode, higher parts of signal +will be amplified, expanding dynamic range in upward direction. +Otherwise, in case of downward lower parts of signal will be reduced. +

+
+
range
+

Set the level of gain reduction when the signal is below the threshold. +Default is 0.06125. Allowed range is from 0 to 1. +Setting this to 0 disables reduction and then filter behaves like expander. +

+
+
threshold
+

If a signal rises above this level the gain reduction is released. +Default is 0.125. Allowed range is from 0 to 1. +

+
+
ratio
+

Set a ratio by which the signal is reduced. +Default is 2. Allowed range is from 1 to 9000. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction stops. +Default is 20 milliseconds. Allowed range is from 0.01 to 9000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before the +reduction is increased again. Default is 250 milliseconds. +Allowed range is from 0.01 to 9000. +

+
+
makeup
+

Set amount of amplification of signal after processing. +Default is 1. Allowed range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.828427125. Allowed range is from 1 to 8. +

+
+
detection
+

Choose if exact signal should be taken for detection or an RMS like one. +Default is rms. Can be peak or rms. +

+
+
link
+

Choose if the average level between all channels or the louder channel affects +the reduction. +Default is average. Can be average or maximum. +

+
+ + +

8.21 aiir

+ +

Apply an arbitrary Infinite Impulse Response filter. +

+

It accepts the following parameters: +

+
+
zeros, z
+

Set numerator/zeros coefficients. +

+
+
poles, p
+

Set denominator/poles coefficients. +

+
+
gains, k
+

Set channels gains. +

+
+
dry_gain
+

Set input gain. +

+
+
wet_gain
+

Set output gain. +

+
+
format, f
+

Set coefficients format. +

+
+
‘tf’
+

digital transfer function +

+
‘zp’
+

Z-plane zeros/poles, cartesian (default) +

+
‘pr’
+

Z-plane zeros/poles, polar radians +

+
‘pd’
+

Z-plane zeros/poles, polar degrees +

+
‘sp’
+

S-plane zeros/poles +

+
+ +
+
process, r
+

Set kind of processing. +Can be d - direct or s - serial cascading. Default is s. +

+
+
precision, e
+

Set filtering precision. +

+
+
‘dbl’
+

double-precision floating-point (default) +

+
‘flt’
+

single-precision floating-point +

+
‘i32’
+

32-bit integers +

+
‘i16’
+

16-bit integers +

+
+ +
+
normalize, n
+

Normalize filter coefficients, by default is enabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+
mix
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
response
+

Show IR frequency response, magnitude(magenta), phase(green) and group delay(yellow) in additional video stream. +By default it is disabled. +

+
+
channel
+

Set for which IR channel to display frequency response. By default is first channel +displayed. This option is used only when response is enabled. +

+
+
size
+

Set video stream size. This option is used only when response is enabled. +

+
+ +

Coefficients in tf format are separated by spaces and are in ascending +order. +

+

Coefficients in zp format are separated by spaces and order of coefficients +doesn’t matter. Coefficients in zp format are complex numbers with i +imaginary unit. +

+

Different coefficients and gains can be provided for every channel, in such case +use ’|’ to separate coefficients or gains. Last provided coefficients will be +used for all remaining channels. +

+ +

8.21.1 Examples

+ +
    +
  • Apply 2 pole elliptic notch at around 5000Hz for 48000 Hz sample rate: +
    +
    aiir=k=1:z=7.957584807809675810E-1 -2.575128568908332300 3.674839853930788710 -2.57512875289799137 7.957586296317130880E-1:p=1 -2.86950072432325953 3.63022088054647218 -2.28075678147272232 6.361362326477423500E-1:f=tf:r=d
+
    + +
  • Same as above but in zp format: +
    +
    aiir=k=0.79575848078096756:z=0.80918701+0.58773007i 0.80918701-0.58773007i 0.80884700+0.58784055i 0.80884700-0.58784055i:p=0.63892345+0.59951235i 0.63892345-0.59951235i 0.79582691+0.44198673i 0.79582691-0.44198673i:f=zp:r=s
+
    +
+ + +

8.22 alimiter

+ +

The limiter prevents an input signal from rising over a desired threshold. +This limiter uses lookahead technology to prevent your signal from distorting. +It means that there is a small delay after the signal is processed. Keep in mind +that the delay it produces is the attack time you set. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. Default is 1. +

+
+
level_out
+

Set output gain. Default is 1. +

+
+
limit
+

Don’t let signals above this level pass the limiter. Default is 1. +

+
+
attack
+

The limiter will reach its attenuation level in this amount of time in +milliseconds. Default is 5 milliseconds. +

+
+
release
+

Come back from limiting to attenuation 1.0 in this amount of milliseconds. +Default is 50 milliseconds. +

+
+
asc
+

When gain reduction is always needed ASC takes care of releasing to an +average reduction level rather than reaching a reduction of 0 in the release +time. +

+
+
asc_level
+

Select how much the release time is affected by ASC, 0 means nearly no changes +in release time while 1 produces higher release times. +

+
+
level
+

Auto level output signal. Default is enabled. +This normalizes audio back to 0dB if enabled. +

+
+ +

Depending on picked setting it is recommended to upsample input 2x or 4x times +with aresample before applying this filter. +

+ +

8.23 allpass

+ +

Apply a two-pole all-pass filter with central frequency (in Hz) +frequency, and filter-width width. +An all-pass filter changes the audio’s frequency to phase relationship +without changing its frequency to amplitude relationship. +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set frequency in Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+
order, o
+

Set the filter order, can be 1 or 2. Default is 2. +

+
+ + +

8.23.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change allpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change allpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change allpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change allpass mix. +Syntax for the command is : "mix" +

+
+ + +

8.24 aloop

+ +

Loop audio samples. +

+

The filter accepts the following options: +

+
+
loop
+

Set the number of loops. Setting this value to -1 will result in infinite loops. +Default is 0. +

+
+
size
+

Set maximal number of samples. Default is 0. +

+
+
start
+

Set first sample of loop. Default is 0. +

+
+ + +

8.25 amerge

+ +

Merge two or more audio streams into a single multi-channel stream. +

+

The filter accepts the following options: +

+
+
inputs
+

Set the number of inputs. Default is 2. +

+
+
+ +

If the channel layouts of the inputs are disjoint, and therefore compatible, +the channel layout of the output will be set accordingly and the channels +will be reordered as necessary. If the channel layouts of the inputs are not +disjoint, the output will have all the channels of the first input then all +the channels of the second input, in that order, and the channel layout of +the output will be the default value corresponding to the total number of +channels. +

+

For example, if the first input is in 2.1 (FL+FR+LF) and the second input +is FC+BL+BR, then the output will be in 5.1, with the channels in the +following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the +first input, b1 is the first channel of the second input). +

+

On the other hand, if both input are in stereo, the output channels will be +in the default order: a1, a2, b1, b2, and the channel layout will be +arbitrarily set to 4.0, which may or may not be the expected value. +

+

All inputs must have the same sample rate, and format. +

+

If inputs do not have the same duration, the output will stop with the +shortest. +

+ +

8.25.1 Examples

+ +
    +
  • Merge two mono files into a stereo stream: +
    +
    amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
+
    + +
  • Multiple merges assuming 1 video stream and 6 audio streams in input.mkv: +
    +
    ffmpeg -i input.mkv -filter_complex "[0:1][0:2][0:3][0:4][0:5][0:6] amerge=inputs=6" -c:a pcm_s16le output.mkv
+
    +
+ + +

8.26 amix

+ +

Mixes multiple audio inputs into a single output. +

+

Note that this filter only supports float samples (the amerge +and pan audio filters support many formats). If the amix +input has integer samples then aresample will be automatically +inserted to perform the conversion to float samples. +

+

For example +

+
ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
+
+

will mix 3 input audio streams to a single output with the same duration as the +first input and a dropout transition time of 3 seconds. +

+

It accepts the following parameters: +

+
inputs
+

The number of inputs. If unspecified, it defaults to 2. +

+
+
duration
+

How to determine the end-of-stream. +

+
longest
+

The duration of the longest input. (default) +

+
+
shortest
+

The duration of the shortest input. +

+
+
first
+

The duration of the first input. +

+
+
+ +
+
dropout_transition
+

The transition time, in seconds, for volume renormalization when an input +stream ends. The default value is 2 seconds. +

+
+
weights
+

Specify weight of each input audio stream as sequence. +Each weight is separated by space. By default all inputs have same weight. +

+
+ + +

8.26.1 Commands

+ +

This filter supports the following commands: +

+
weights
+

Syntax is same as option with same name. +

+
+ + +

8.27 amultiply

+ +

Multiply first audio stream with second audio stream and store result +in output audio stream. Multiplication is done by multiplying each +sample from first stream with sample at same position from second stream. +

+

With this element-wise multiplication one can create amplitude fades and +amplitude modulations. +

+ +

8.28 anequalizer

+ +

High-order parametric multiband equalizer for each channel. +

+

It accepts the following parameters: +

+
params
+
+

This option string is in format: +"cchn f=cf w=w g=g t=f | ..." +Each equalizer band is separated by ’|’. +

+
+
chn
+

Set channel number to which equalization will be applied. +If input doesn’t have that channel the entry is ignored. +

+
+
f
+

Set central frequency for band. +If input doesn’t have that frequency the entry is ignored. +

+
+
w
+

Set band width in hertz. +

+
+
g
+

Set band gain in dB. +

+
+
t
+

Set filter type for band, optional, can be: +

+
+
‘0’
+

Butterworth, this is default. +

+
+
‘1’
+

Chebyshev type 1. +

+
+
‘2’
+

Chebyshev type 2. +

+
+
+
+ +
+
curves
+

With this option activated frequency response of anequalizer is displayed +in video stream. +

+
+
size
+

Set video stream size. Only useful if curves option is activated. +

+
+
mgain
+

Set max gain that will be displayed. Only useful if curves option is activated. +Setting this to a reasonable value makes it possible to display gain which is derived from +neighbour bands which are too close to each other and thus produce higher gain +when both are activated. +

+
+
fscale
+

Set frequency scale used to draw frequency response in video output. +Can be linear or logarithmic. Default is logarithmic. +

+
+
colors
+

Set color for each channel curve which is going to be displayed in video stream. +This is list of color names separated by space or by ’|’. +Unrecognised or missing colors will be replaced by white color. +

+
+ + +

8.28.1 Examples

+ +
    +
  • Lower gain by 10 of central frequency 200Hz and width 100 Hz +for first 2 channels using Chebyshev type 1 filter: +
    +
    anequalizer=c0 f=200 w=100 g=-10 t=1|c1 f=200 w=100 g=-10 t=1
+
    +
+ + +

8.28.2 Commands

+ +

This filter supports the following commands: +

+
change
+

Alter existing filter parameters. +Syntax for the commands is : "fN|f=freq|w=width|g=gain" +

+

fN is existing filter number, starting from 0, if no such filter is available +error is returned. +freq set new frequency parameter. +width set new width parameter in herz. +gain set new gain parameter in dB. +

+

Full filter invocation with asendcmd may look like this: +asendcmd=c=’4.0 anequalizer change 0|f=200|w=50|g=1’,anequalizer=... +

+
+ + +

8.29 anlmdn

+ +

Reduce broadband noise in audio samples using Non-Local Means algorithm. +

+

Each sample is adjusted by looking for other samples with similar contexts. This +context similarity is defined by comparing their surrounding patches of size +p. Patches are searched in an area of r around the sample. +

+

The filter accepts the following options: +

+
+
s
+

Set denoising strength. Allowed range is from 0.00001 to 10. Default value is 0.00001. +

+
+
p
+

Set patch radius duration. Allowed range is from 1 to 100 milliseconds. +Default value is 2 milliseconds. +

+
+
r
+

Set research radius duration. Allowed range is from 2 to 300 milliseconds. +Default value is 6 milliseconds. +

+
+
o
+

Set the output mode. +

+

It accepts the following values: +

+
i
+

Pass input unchanged. +

+
+
o
+

Pass noise filtered out. +

+
+
n
+

Pass only noise. +

+

Default value is o. +

+
+ +
+
m
+

Set smooth factor. Default value is 11. Allowed range is from 1 to 15. +

+
+ + +

8.29.1 Commands

+ +

This filter supports the following commands: +

+
s
+

Change denoise strength. Argument is single float number. +Syntax for the command is : "s" +

+
+
o
+

Change output mode. +Syntax for the command is : "i", "o" or "n" string. +

+
+ + +

8.30 anlms

+

Apply Normalized Least-Mean-Squares algorithm to the first audio stream using the second audio stream. +

+

This adaptive filter is used to mimic a desired filter by finding the filter coefficients that +relate to producing the least mean square of the error signal (difference between the desired, +2nd input audio stream and the actual signal, the 1st input audio stream). +

+

A description of the accepted options follows. +

+
+
order
+

Set filter order. +

+
+
mu
+

Set filter mu. +

+
+
eps
+

Set the filter eps. +

+
+
leakage
+

Set the filter leakage. +

+
+
out_mode
+

It accepts the following values: +

+
i
+

Pass the 1st input. +

+
+
d
+

Pass the 2nd input. +

+
+
o
+

Pass filtered samples. +

+
+
n
+

Pass difference between desired and filtered samples. +

+

Default value is o. +

+
+
+
+ + +

8.30.1 Examples

+ +
    +
  • One of many usages of this filter is noise reduction, input audio is filtered +with same samples that are delayed by fixed amount, one such example for stereo audio is: +
    +
    asplit[a][b],[a]adelay=32S|32S[a],[b][a]anlms=order=128:leakage=0.0005:mu=.5:out_mode=o
+
    +
+ + +

8.30.2 Commands

+ +

This filter supports the same commands as options, excluding option order. +

+ +

8.31 anull

+ +

Pass the audio source unchanged to the output. +

+ +

8.32 apad

+ +

Pad the end of an audio stream with silence. +

+

This can be used together with ffmpeg -shortest to +extend audio streams to the same length as the video stream. +

+

A description of the accepted options follows. +

+
+
packet_size
+

Set silence packet size. Default value is 4096. +

+
+
pad_len
+

Set the number of samples of silence to add to the end. After the +value is reached, the stream is terminated. This option is mutually +exclusive with whole_len. +

+
+
whole_len
+

Set the minimum total number of samples in the output audio stream. If +the value is longer than the input audio length, silence is added to +the end, until the value is reached. This option is mutually exclusive +with pad_len. +

+
+
pad_dur
+

Specify the duration of samples of silence to add. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. Used only if set to non-zero value. +

+
+
whole_dur
+

Specify the minimum total duration in the output audio stream. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. Used only if set to non-zero value. If the value is longer than +the input audio length, silence is added to the end, until the value is reached. +This option is mutually exclusive with pad_dur +

+
+ +

If neither the pad_len nor the whole_len nor pad_dur +nor whole_dur option is set, the filter will add silence to the end of +the input stream indefinitely. +

+ +

8.32.1 Examples

+ +
    +
  • Add 1024 samples of silence to the end of the input: +
    +
    apad=pad_len=1024
+
    + +
  • Make sure the audio output will contain at least 10000 samples, pad +the input with silence if required: +
    +
    apad=whole_len=10000
+
    + +
  • Use ffmpeg to pad the audio input with silence, so that the +video stream will always result the shortest and will be converted +until the end in the output file when using the shortest +option: +
    +
    ffmpeg -i VIDEO -i AUDIO -filter_complex "[1:0]apad" -shortest OUTPUT
+
    +
+ + +

8.33 aphaser

+

Add a phasing effect to the input audio. +

+

A phaser filter creates series of peaks and troughs in the frequency spectrum. +The position of the peaks and troughs are modulated so that they vary over time, creating a sweeping effect. +

+

A description of the accepted parameters follows. +

+
+
in_gain
+

Set input gain. Default is 0.4. +

+
+
out_gain
+

Set output gain. Default is 0.74 +

+
+
delay
+

Set delay in milliseconds. Default is 3.0. +

+
+
decay
+

Set decay. Default is 0.4. +

+
+
speed
+

Set modulation speed in Hz. Default is 0.5. +

+
+
type
+

Set modulation type. Default is triangular. +

+

It accepts the following values: +

+
‘triangular, t’
+
‘sinusoidal, s’
+
+
+
+ + +

8.34 apulsator

+ +

Audio pulsator is something between an autopanner and a tremolo. +But it can produce funny stereo effects as well. Pulsator changes the volume +of the left and right channel based on a LFO (low frequency oscillator) with +different waveforms and shifted phases. +This filter have the ability to define an offset between left and right +channel. An offset of 0 means that both LFO shapes match each other. +The left and right channel are altered equally - a conventional tremolo. +An offset of 50% means that the shape of the right channel is exactly shifted +in phase (or moved backwards about half of the frequency) - pulsator acts as +an autopanner. At 1 both curves match again. Every setting in between moves the +phase shift gapless between all stages and produces some "bypassing" sounds with +sine and triangle waveforms. The more you set the offset near 1 (starting from +the 0.5) the faster the signal passes from the left to the right speaker. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. By default it is 1. Range is [0.015625 - 64]. +

+
+
level_out
+

Set output gain. By default it is 1. Range is [0.015625 - 64]. +

+
+
mode
+

Set waveform shape the LFO will use. Can be one of: sine, triangle, square, +sawup or sawdown. Default is sine. +

+
+
amount
+

Set modulation. Define how much of original signal is affected by the LFO. +

+
+
offset_l
+

Set left channel offset. Default is 0. Allowed range is [0 - 1]. +

+
+
offset_r
+

Set right channel offset. Default is 0.5. Allowed range is [0 - 1]. +

+
+
width
+

Set pulse width. Default is 1. Allowed range is [0 - 2]. +

+
+
timing
+

Set possible timing mode. Can be one of: bpm, ms or hz. Default is hz. +

+
+
bpm
+

Set bpm. Default is 120. Allowed range is [30 - 300]. Only used if timing +is set to bpm. +

+
+
ms
+

Set ms. Default is 500. Allowed range is [10 - 2000]. Only used if timing +is set to ms. +

+
+
hz
+

Set frequency in Hz. Default is 2. Allowed range is [0.01 - 100]. Only used +if timing is set to hz. +

+
+ + +

8.35 aresample

+ +

Resample the input audio to the specified parameters, using the +libswresample library. If none are specified then the filter will +automatically convert between its input and output. +

+

This filter is also able to stretch/squeeze the audio data to make it match +the timestamps or to inject silence / cut out audio to make it match the +timestamps, do a combination of both or do neither. +

+

The filter accepts the syntax +[sample_rate:]resampler_options, where sample_rate +expresses a sample rate and resampler_options is a list of +key=value pairs, separated by ":". See the +(ffmpeg-resampler)"Resampler Options" section in the +ffmpeg-resampler(1) manual +for the complete list of supported options. +

+ +

8.35.1 Examples

+ +
    +
  • Resample the input audio to 44100Hz: +
    +
    aresample=44100
+
    + +
  • Stretch/squeeze samples to the given timestamps, with a maximum of 1000 +samples per second compensation: +
    +
    aresample=async=1000
+
    +
+ + +

8.36 areverse

+ +

Reverse an audio clip. +

+

Warning: This filter requires memory to buffer the entire clip, so trimming +is suggested. +

+ +

8.36.1 Examples

+ +
    +
  • Take the first 5 seconds of a clip, and reverse it. +
    +
    atrim=end=5,areverse
+
    +
+ + +

8.37 arnndn

+ +

Reduce noise from speech using Recurrent Neural Networks. +

+

This filter accepts the following options: +

+
+
model, m
+

Set train model file to load. This option is always required. +

+
+ + +

8.38 asetnsamples

+ +

Set the number of samples per each output audio frame. +

+

The last output packet may contain a different number of samples, as +the filter will flush all the remaining samples when the input audio +signals its end. +

+

The filter accepts the following options: +

+
+
nb_out_samples, n
+

Set the number of frames per each output audio frame. The number is +intended as the number of samples per each channel. +Default value is 1024. +

+
+
pad, p
+

If set to 1, the filter will pad the last audio frame with zeroes, so +that the last frame will contain the same number of samples as the +previous ones. Default value is 1. +

+
+ +

For example, to set the number of per-frame samples to 1234 and +disable padding for the last frame, use: +

+
asetnsamples=n=1234:p=0
+
+ + +

8.39 asetrate

+ +

Set the sample rate without altering the PCM data. +This will result in a change of speed and pitch. +

+

The filter accepts the following options: +

+
+
sample_rate, r
+

Set the output sample rate. Default is 44100 Hz. +

+
+ + +

8.40 ashowinfo

+ +

Show a line containing various information for each input audio frame. +The input audio is not modified. +

+

The shown line contains a sequence of key/value pairs of the form +key:value. +

+

The following values are shown in the output: +

+
+
n
+

The (sequential) number of the input frame, starting from 0. +

+
+
pts
+

The presentation timestamp of the input frame, in time base units; the time base +depends on the filter input pad, and is usually 1/sample_rate. +

+
+
pts_time
+

The presentation timestamp of the input frame in seconds. +

+
+
pos
+

position of the frame in the input stream, -1 if this information in +unavailable and/or meaningless (for example in case of synthetic audio) +

+
+
fmt
+

The sample format. +

+
+
chlayout
+

The channel layout. +

+
+
rate
+

The sample rate for the audio frame. +

+
+
nb_samples
+

The number of samples (per channel) in the frame. +

+
+
checksum
+

The Adler-32 checksum (printed in hexadecimal) of the audio data. For planar +audio, the data is treated as if all the planes were concatenated. +

+
+
plane_checksums
+

A list of Adler-32 checksums for each data plane. +

+
+ + +

8.41 asoftclip

+

Apply audio soft clipping. +

+

Soft clipping is a type of distortion effect where the amplitude of a signal is saturated +along a smooth curve, rather than the abrupt shape of hard-clipping. +

+

This filter accepts the following options: +

+
+
type
+

Set type of soft-clipping. +

+

It accepts the following values: +

+
tanh
+
atan
+
cubic
+
exp
+
alg
+
quintic
+
sin
+
+ +
+
param
+

Set additional parameter which controls sigmoid function. +

+
+ + +

8.41.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

8.42 asr

+

Automatic Speech Recognition +

+

This filter uses PocketSphinx for speech recognition. To enable +compilation of this filter, you need to configure FFmpeg with +--enable-pocketsphinx. +

+

It accepts the following options: +

+
+
rate
+

Set sampling rate of input audio. Defaults is 16000. +This need to match speech models, otherwise one will get poor results. +

+
+
hmm
+

Set dictionary containing acoustic model files. +

+
+
dict
+

Set pronunciation dictionary. +

+
+
lm
+

Set language model file. +

+
+
lmctl
+

Set language model set. +

+
+
lmname
+

Set which language model to use. +

+
+
logfn
+

Set output for log messages. +

+
+ +

The filter exports recognized speech as the frame metadata lavfi.asr.text. +

+ +

8.43 astats

+ +

Display time domain statistical information about the audio channels. +Statistics are calculated and displayed for each audio channel and, +where applicable, an overall figure is also given. +

+

It accepts the following option: +

+
length
+

Short window length in seconds, used for peak and trough RMS measurement. +Default is 0.05 (50 milliseconds). Allowed range is [0.01 - 10]. +

+
+
metadata
+
+

Set metadata injection. All the metadata keys are prefixed with lavfi.astats.X, +where X is channel number starting from 1 or string Overall. Default is +disabled. +

+

Available keys for each channel are: +DC_offset +Min_level +Max_level +Min_difference +Max_difference +Mean_difference +RMS_difference +Peak_level +RMS_peak +RMS_trough +Crest_factor +Flat_factor +Peak_count +Noise_floor +Noise_floor_count +Bit_depth +Dynamic_range +Zero_crossings +Zero_crossings_rate +Number_of_NaNs +Number_of_Infs +Number_of_denormals +

+

and for Overall: +DC_offset +Min_level +Max_level +Min_difference +Max_difference +Mean_difference +RMS_difference +Peak_level +RMS_level +RMS_peak +RMS_trough +Flat_factor +Peak_count +Noise_floor +Noise_floor_count +Bit_depth +Number_of_samples +Number_of_NaNs +Number_of_Infs +Number_of_denormals +

+

For example full key look like this lavfi.astats.1.DC_offset or +this lavfi.astats.Overall.Peak_count. +

+

For description what each key means read below. +

+
+
reset
+

Set number of frame after which stats are going to be recalculated. +Default is disabled. +

+
+
measure_perchannel
+

Select the entries which need to be measured per channel. The metadata keys can +be used as flags, default is all which measures everything. +none disables all per channel measurement. +

+
+
measure_overall
+

Select the entries which need to be measured overall. The metadata keys can +be used as flags, default is all which measures everything. +none disables all overall measurement. +

+
+
+ +

A description of each shown parameter follows: +

+
+
DC offset
+

Mean amplitude displacement from zero. +

+
+
Min level
+

Minimal sample level. +

+
+
Max level
+

Maximal sample level. +

+
+
Min difference
+

Minimal difference between two consecutive samples. +

+
+
Max difference
+

Maximal difference between two consecutive samples. +

+
+
Mean difference
+

Mean difference between two consecutive samples. +The average of each difference between two consecutive samples. +

+
+
RMS difference
+

Root Mean Square difference between two consecutive samples. +

+
+
Peak level dB
+
RMS level dB
+

Standard peak and RMS level measured in dBFS. +

+
+
RMS peak dB
+
RMS trough dB
+

Peak and trough values for RMS level measured over a short window. +

+
+
Crest factor
+

Standard ratio of peak to RMS level (note: not in dB). +

+
+
Flat factor
+

Flatness (i.e. consecutive samples with the same value) of the signal at its peak levels +(i.e. either Min level or Max level). +

+
+
Peak count
+

Number of occasions (not the number of samples) that the signal attained either +Min level or Max level. +

+
+
Noise floor dB
+

Minimum local peak measured in dBFS over a short window. +

+
+
Noise floor count
+

Number of occasions (not the number of samples) that the signal attained +Noise floor. +

+
+
Bit depth
+

Overall bit depth of audio. Number of bits used for each sample. +

+
+
Dynamic range
+

Measured dynamic range of audio in dB. +

+
+
Zero crossings
+

Number of points where the waveform crosses the zero level axis. +

+
+
Zero crossings rate
+

Rate of Zero crossings and number of audio samples. +

+
+ + +

8.44 asubboost

+

Boost subwoofer frequencies. +

+

The filter accepts the following options: +

+
+
dry
+

Set dry gain, how much of original signal is kept. Allowed range is from 0 to 1. +Default value is 0.5. +

+
+
wet
+

Set wet gain, how much of filtered signal is kept. Allowed range is from 0 to 1. +Default value is 0.8. +

+
+
decay
+

Set delay line decay gain value. Allowed range is from 0 to 1. +Default value is 0.7. +

+
+
feedback
+

Set delay line feedback gain value. Allowed range is from 0 to 1. +Default value is 0.5. +

+
+
cutoff
+

Set cutoff frequency in herz. Allowed range is 50 to 900. +Default value is 100. +

+
+
slope
+

Set slope amount for cutoff frequency. Allowed range is 0.0001 to 1. +Default value is 0.5. +

+
+
delay
+

Set delay. Allowed range is from 1 to 100. +Default value is 20. +

+
+ + +

8.44.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

8.45 atempo

+ +

Adjust audio tempo. +

+

The filter accepts exactly one parameter, the audio tempo. If not +specified then the filter will assume nominal 1.0 tempo. Tempo must +be in the [0.5, 100.0] range. +

+

Note that tempo greater than 2 will skip some samples rather than +blend them in. If for any reason this is a concern it is always +possible to daisy-chain several instances of atempo to achieve the +desired product tempo. +

+ +

8.45.1 Examples

+ +
    +
  • Slow down audio to 80% tempo: +
    +
    atempo=0.8
+
    + +
  • To speed up audio to 300% tempo: +
    +
    atempo=3
+
    + +
  • To speed up audio to 300% tempo by daisy-chaining two atempo instances: +
    +
    atempo=sqrt(3),atempo=sqrt(3)
+
    +
+ + +

8.45.2 Commands

+ +

This filter supports the following commands: +

+
tempo
+

Change filter tempo scale factor. +Syntax for the command is : "tempo" +

+
+ + +

8.46 atrim

+ +

Trim the input so that the output contains one continuous subpart of the input. +

+

It accepts the following parameters: +

+
start
+

Timestamp (in seconds) of the start of the section to keep. I.e. the audio +sample with the timestamp start will be the first sample in the output. +

+
+
end
+

Specify time of the first audio sample that will be dropped, i.e. the +audio sample immediately preceding the one with the timestamp end will be +the last sample in the output. +

+
+
start_pts
+

Same as start, except this option sets the start timestamp in samples +instead of seconds. +

+
+
end_pts
+

Same as end, except this option sets the end timestamp in samples instead +of seconds. +

+
+
duration
+

The maximum duration of the output in seconds. +

+
+
start_sample
+

The number of the first sample that should be output. +

+
+
end_sample
+

The number of the first sample that should be dropped. +

+
+ +

start, end, and duration are expressed as time +duration specifications; see +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+

Note that the first two sets of the start/end options and the duration +option look at the frame timestamp, while the _sample options simply count the +samples that pass through the filter. So start/end_pts and start/end_sample will +give different results when the timestamps are wrong, inexact or do not start at +zero. Also note that this filter does not modify the timestamps. If you wish +to have the output timestamps start at zero, insert the asetpts filter after the +atrim filter. +

+

If multiple start or end options are set, this filter tries to be greedy and +keep all samples that match at least one of the specified constraints. To keep +only the part that matches all the constraints at once, chain multiple atrim +filters. +

+

The defaults are such that all the input is kept. So it is possible to set e.g. +just the end values to keep everything before the specified time. +

+

Examples: +

    +
  • Drop everything except the second minute of input: +
    +
    ffmpeg -i INPUT -af atrim=60:120
+
    + +
  • Keep only the first 1000 samples: +
    +
    ffmpeg -i INPUT -af atrim=end_sample=1000
+
    + +
+ + +

8.47 axcorrelate

+

Calculate normalized cross-correlation between two input audio streams. +

+

Resulted samples are always between -1 and 1 inclusive. +If result is 1 it means two input samples are highly correlated in that selected segment. +Result 0 means they are not correlated at all. +If result is -1 it means two input samples are out of phase, which means they cancel each +other. +

+

The filter accepts the following options: +

+
+
size
+

Set size of segment over which cross-correlation is calculated. +Default is 256. Allowed range is from 2 to 131072. +

+
+
algo
+

Set algorithm for cross-correlation. Can be slow or fast. +Default is slow. Fast algorithm assumes mean values over any given segment +are always zero and thus need much less calculations to make. +This is generally not true, but is valid for typical audio streams. +

+
+ + +

8.47.1 Examples

+ +
    +
  • Calculate correlation between channels in stereo audio stream: +
    +
    ffmpeg -i stereo.wav -af channelsplit,axcorrelate=size=1024:algo=fast correlation.wav
+
    +
+ + +

8.48 bandpass

+ +

Apply a two-pole Butterworth band-pass filter with central +frequency frequency, and (3dB-point) band-width width. +The csg option selects a constant skirt gain (peak gain = Q) +instead of the default: constant 0dB peak gain. +The filter roll off at 6dB per octave (20dB per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the filter’s central frequency. Default is 3000. +

+
+
csg
+

Constant skirt gain if set to 1. Defaults to 0. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

8.48.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change bandpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change bandpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change bandpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change bandpass mix. +Syntax for the command is : "mix" +

+
+ + +

8.49 bandreject

+ +

Apply a two-pole Butterworth band-reject filter with central +frequency frequency, and (3dB-point) band-width width. +The filter roll off at 6dB per octave (20dB per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the filter’s central frequency. Default is 3000. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

8.49.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change bandreject frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change bandreject width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change bandreject width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change bandreject mix. +Syntax for the command is : "mix" +

+
+ + +

8.50 bass, lowshelf

+ +

Boost or cut the bass (lower) frequencies of the audio using a two-pole +shelving filter with a response similar to that of a standard +hi-fi’s tone-controls. This is also known as shelving equalisation (EQ). +

+

The filter accepts the following options: +

+
+
gain, g
+

Give the gain at 0 Hz. Its useful range is about -20 +(for a large cut) to +20 (for a large boost). +Beware of clipping when using a positive gain. +

+
+
frequency, f
+

Set the filter’s central frequency and so can be used +to extend or reduce the frequency range to be boosted or cut. +The default value is 100 Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Determine how steep is the filter’s shelf transition. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

8.50.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change bass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change bass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change bass width. +Syntax for the command is : "width" +

+
+
gain, g
+

Change bass gain. +Syntax for the command is : "gain" +

+
+
mix, m
+

Change bass mix. +Syntax for the command is : "mix" +

+
+ + +

8.51 biquad

+ +

Apply a biquad IIR filter with the given coefficients. +Where b0, b1, b2 and a0, a1, a2 +are the numerator and denominator coefficients respectively. +and channels, c specify which channels to filter, by default all +available are filtered. +

+ +

8.51.1 Commands

+ +

This filter supports the following commands: +

+
a0
+
a1
+
a2
+
b0
+
b1
+
b2
+

Change biquad parameter. +Syntax for the command is : "value" +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

8.52 bs2b

+

Bauer stereo to binaural transformation, which improves headphone listening of +stereo audio records. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libbs2b. +

+

It accepts the following parameters: +

+
profile
+

Pre-defined crossfeed level. +

+
default
+

Default level (fcut=700, feed=50). +

+
+
cmoy
+

Chu Moy circuit (fcut=700, feed=60). +

+
+
jmeier
+

Jan Meier circuit (fcut=650, feed=95). +

+
+
+ +
+
fcut
+

Cut frequency (in Hz). +

+
+
feed
+

Feed level (in Hz). +

+
+
+ + +

8.53 channelmap

+ +

Remap input channels to new locations. +

+

It accepts the following parameters: +

+
map
+

Map channels from input to output. The argument is a ’|’-separated list of +mappings, each in the in_channel-out_channel or +in_channel form. in_channel can be either the name of the input +channel (e.g. FL for front left) or its index in the input channel layout. +out_channel is the name of the output channel or its index in the output +channel layout. If out_channel is not given then it is implicitly an +index, starting with zero and increasing by one for each mapping. +

+
+
channel_layout
+

The channel layout of the output stream. +

+
+ +

If no mapping is present, the filter will implicitly map input channels to +output channels, preserving indices. +

+ +

8.53.1 Examples

+ +
    +
  • For example, assuming a 5.1+downmix input MOV file, +
    +
    ffmpeg -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
+
    +

    will create an output WAV file tagged as stereo from the downmix channels of +the input. +

    +
  • To fix a 5.1 WAV improperly encoded in AAC’s native channel order +
    +
    ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:5.1' out.wav
+
    +
+ + +

8.54 channelsplit

+ +

Split each channel from an input audio stream into a separate output stream. +

+

It accepts the following parameters: +

+
channel_layout
+

The channel layout of the input stream. The default is "stereo". +

+
channels
+

A channel layout describing the channels to be extracted as separate output streams +or "all" to extract each input channel as a separate stream. The default is "all". +

+

Choosing channels not present in channel layout in the input will result in an error. +

+
+ + +

8.54.1 Examples

+ +
    +
  • For example, assuming a stereo input MP3 file, +
    +
    ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
+
    +

    will create an output Matroska file with two audio streams, one containing only +the left channel and the other the right channel. +

    +
  • Split a 5.1 WAV file into per-channel files: +
    +
    ffmpeg -i in.wav -filter_complex
+'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
+-map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
+front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
+side_right.wav
+
    + +
  • Extract only LFE from a 5.1 WAV file: +
    +
    ffmpeg -i in.wav -filter_complex 'channelsplit=channel_layout=5.1:channels=LFE[LFE]'
+-map '[LFE]' lfe.wav
+
    +
+ + +

8.55 chorus

+

Add a chorus effect to the audio. +

+

Can make a single vocal sound like a chorus, but can also be applied to instrumentation. +

+

Chorus resembles an echo effect with a short delay, but whereas with echo the delay is +constant, with chorus, it is varied using using sinusoidal or triangular modulation. +The modulation depth defines the range the modulated delay is played before or after +the delay. Hence the delayed sound will sound slower or faster, that is the delayed +sound tuned around the original one, like in a chorus where some vocals are slightly +off key. +

+

It accepts the following parameters: +

+
in_gain
+

Set input gain. Default is 0.4. +

+
+
out_gain
+

Set output gain. Default is 0.4. +

+
+
delays
+

Set delays. A typical delay is around 40ms to 60ms. +

+
+
decays
+

Set decays. +

+
+
speeds
+

Set speeds. +

+
+
depths
+

Set depths. +

+
+ + +

8.55.1 Examples

+ +
    +
  • A single delay: +
    +
    chorus=0.7:0.9:55:0.4:0.25:2
+
    + +
  • Two delays: +
    +
    chorus=0.6:0.9:50|60:0.4|0.32:0.25|0.4:2|1.3
+
    + +
  • Fuller sounding chorus with three delays: +
    +
    chorus=0.5:0.9:50|60|40:0.4|0.32|0.3:0.25|0.4|0.3:2|2.3|1.3
+
    +
+ + +

8.56 compand

+

Compress or expand the audio’s dynamic range. +

+

It accepts the following parameters: +

+
+
attacks
+
decays
+

A list of times in seconds for each channel over which the instantaneous level +of the input signal is averaged to determine its volume. attacks refers to +increase of volume and decays refers to decrease of volume. For most +situations, the attack time (response to the audio getting louder) should be +shorter than the decay time, because the human ear is more sensitive to sudden +loud audio than sudden soft audio. A typical value for attack is 0.3 seconds and +a typical value for decay is 0.8 seconds. +If specified number of attacks & decays is lower than number of channels, the last +set attack/decay will be used for all remaining channels. +

+
+
points
+

A list of points for the transfer function, specified in dB relative to the +maximum possible signal amplitude. Each key points list must be defined using +the following syntax: x0/y0|x1/y1|x2/y2|.... or +x0/y0 x1/y1 x2/y2 .... +

+

The input values must be in strictly increasing order but the transfer function +does not have to be monotonically rising. The point 0/0 is assumed but +may be overridden (by 0/out-dBn). Typical values for the transfer +function are -70/-70|-60/-20|1/0. +

+
+
soft-knee
+

Set the curve radius in dB for all joints. It defaults to 0.01. +

+
+
gain
+

Set the additional gain in dB to be applied at all points on the transfer +function. This allows for easy adjustment of the overall gain. +It defaults to 0. +

+
+
volume
+

Set an initial volume, in dB, to be assumed for each channel when filtering +starts. This permits the user to supply a nominal level initially, so that, for +example, a very large gain is not applied to initial signal levels before the +companding has begun to operate. A typical value for audio which is initially +quiet is -90 dB. It defaults to 0. +

+
+
delay
+

Set a delay, in seconds. The input audio is analyzed immediately, but audio is +delayed before being fed to the volume adjuster. Specifying a delay +approximately equal to the attack/decay times allows the filter to effectively +operate in predictive rather than reactive mode. It defaults to 0. +

+
+
+ + +

8.56.1 Examples

+ +
    +
  • Make music with both quiet and loud passages suitable for listening to in a +noisy environment: +
    +
    compand=.3|.3:1|1:-90/-60|-60/-40|-40/-30|-20/-20:6:0:-90:0.2
+
    + +

    Another example for audio with whisper and explosion parts: +

    +
    compand=0|0:1|1:-90/-900|-70/-70|-30/-9|0/-3:6:0:0:0
+
    + +
  • A noise gate for when the noise is at a lower level than the signal: +
    +
    compand=.1|.1:.2|.2:-900/-900|-50.1/-900|-50/-50:.01:0:-90:.1
+
    + +
  • Here is another noise gate, this time for when the noise is at a higher level +than the signal (making it, in some ways, similar to squelch): +
    +
    compand=.1|.1:.1|.1:-45.1/-45.1|-45/-900|0/-900:.01:45:-90:.1
+
    + +
  • 2:1 compression starting at -6dB: +
    +
    compand=points=-80/-80|-6/-6|0/-3.8|20/3.5
+
    + +
  • 2:1 compression starting at -9dB: +
    +
    compand=points=-80/-80|-9/-9|0/-5.3|20/2.9
+
    + +
  • 2:1 compression starting at -12dB: +
    +
    compand=points=-80/-80|-12/-12|0/-6.8|20/1.9
+
    + +
  • 2:1 compression starting at -18dB: +
    +
    compand=points=-80/-80|-18/-18|0/-9.8|20/0.7
+
    + +
  • 3:1 compression starting at -15dB: +
    +
    compand=points=-80/-80|-15/-15|0/-10.8|20/-5.2
+
    + +
  • Compressor/Gate: +
    +
    compand=points=-80/-105|-62/-80|-15.4/-15.4|0/-12|20/-7.6
+
    + +
  • Expander: +
    +
    compand=attacks=0:points=-80/-169|-54/-80|-49.5/-64.6|-41.1/-41.1|-25.8/-15|-10.8/-4.5|0/0|20/8.3
+
    + +
  • Hard limiter at -6dB: +
    +
    compand=attacks=0:points=-80/-80|-6/-6|20/-6
+
    + +
  • Hard limiter at -12dB: +
    +
    compand=attacks=0:points=-80/-80|-12/-12|20/-12
+
    + +
  • Hard noise gate at -35 dB: +
    +
    compand=attacks=0:points=-80/-115|-35.1/-80|-35/-35|20/20
+
    + +
  • Soft limiter: +
    +
    compand=attacks=0:points=-80/-80|-12.4/-12.4|-6/-8|0/-6.8|20/-2.8
+
    +
+ + +

8.57 compensationdelay

+ +

Compensation Delay Line is a metric based delay to compensate differing +positions of microphones or speakers. +

+

For example, you have recorded guitar with two microphones placed in +different locations. Because the front of sound wave has fixed speed in +normal conditions, the phasing of microphones can vary and depends on +their location and interposition. The best sound mix can be achieved when +these microphones are in phase (synchronized). Note that a distance of +~30 cm between microphones makes one microphone capture the signal in +antiphase to the other microphone. That makes the final mix sound moody. +This filter helps to solve phasing problems by adding different delays +to each microphone track and make them synchronized. +

+

The best result can be reached when you take one track as base and +synchronize other tracks one by one with it. +Remember that synchronization/delay tolerance depends on sample rate, too. +Higher sample rates will give more tolerance. +

+

The filter accepts the following parameters: +

+
+
mm
+

Set millimeters distance. This is compensation distance for fine tuning. +Default is 0. +

+
+
cm
+

Set cm distance. This is compensation distance for tightening distance setup. +Default is 0. +

+
+
m
+

Set meters distance. This is compensation distance for hard distance setup. +Default is 0. +

+
+
dry
+

Set dry amount. Amount of unprocessed (dry) signal. +Default is 0. +

+
+
wet
+

Set wet amount. Amount of processed (wet) signal. +Default is 1. +

+
+
temp
+

Set temperature in degrees Celsius. This is the temperature of the environment. +Default is 20. +

+
+ + +

8.58 crossfeed

+

Apply headphone crossfeed filter. +

+

Crossfeed is the process of blending the left and right channels of stereo +audio recording. +It is mainly used to reduce extreme stereo separation of low frequencies. +

+

The intent is to produce more speaker like sound to the listener. +

+

The filter accepts the following options: +

+
+
strength
+

Set strength of crossfeed. Default is 0.2. Allowed range is from 0 to 1. +This sets gain of low shelf filter for side part of stereo image. +Default is -6dB. Max allowed is -30db when strength is set to 1. +

+
+
range
+

Set soundstage wideness. Default is 0.5. Allowed range is from 0 to 1. +This sets cut off frequency of low shelf filter. Default is cut off near +1550 Hz. With range set to 1 cut off frequency is set to 2100 Hz. +

+
+
slope
+

Set curve slope of low shelf filter. Default is 0.5. +Allowed range is from 0.01 to 1. +

+
+
level_in
+

Set input gain. Default is 0.9. +

+
+
level_out
+

Set output gain. Default is 1. +

+
+ + +

8.58.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

8.59 crystalizer

+

Simple algorithm to expand audio dynamic range. +

+

The filter accepts the following options: +

+
+
i
+

Sets the intensity of effect (default: 2.0). Must be in range between 0.0 +(unchanged sound) to 10.0 (maximum effect). +

+
+
c
+

Enable clipping. By default is enabled. +

+
+ + +

8.59.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

8.60 dcshift

+

Apply a DC shift to the audio. +

+

This can be useful to remove a DC offset (caused perhaps by a hardware problem +in the recording chain) from the audio. The effect of a DC offset is reduced +headroom and hence volume. The astats filter can be used to determine if +a signal has a DC offset. +

+
+
shift
+

Set the DC shift, allowed range is [-1, 1]. It indicates the amount to shift +the audio. +

+
+
limitergain
+

Optional. It should have a value much less than 1 (e.g. 0.05 or 0.02) and is +used to prevent clipping. +

+
+ + +

8.61 deesser

+ +

Apply de-essing to the audio samples. +

+
+
i
+

Set intensity for triggering de-essing. Allowed range is from 0 to 1. +Default is 0. +

+
+
m
+

Set amount of ducking on treble part of sound. Allowed range is from 0 to 1. +Default is 0.5. +

+
+
f
+

How much of original frequency content to keep when de-essing. Allowed range is from 0 to 1. +Default is 0.5. +

+
+
s
+

Set the output mode. +

+

It accepts the following values: +

+
i
+

Pass input unchanged. +

+
+
o
+

Pass ess filtered out. +

+
+
e
+

Pass only ess. +

+

Default value is o. +

+
+ +
+
+ + +

8.62 drmeter

+

Measure audio dynamic range. +

+

DR values of 14 and higher is found in very dynamic material. DR of 8 to 13 +is found in transition material. And anything less that 8 have very poor dynamics +and is very compressed. +

+

The filter accepts the following options: +

+
+
length
+

Set window length in seconds used to split audio into segments of equal length. +Default is 3 seconds. +

+
+ + +

8.63 dynaudnorm

+

Dynamic Audio Normalizer. +

+

This filter applies a certain amount of gain to the input audio in order +to bring its peak magnitude to a target level (e.g. 0 dBFS). However, in +contrast to more "simple" normalization algorithms, the Dynamic Audio +Normalizer *dynamically* re-adjusts the gain factor to the input audio. +This allows for applying extra gain to the "quiet" sections of the audio +while avoiding distortions or clipping the "loud" sections. In other words: +The Dynamic Audio Normalizer will "even out" the volume of quiet and loud +sections, in the sense that the volume of each section is brought to the +same target level. Note, however, that the Dynamic Audio Normalizer achieves +this goal *without* applying "dynamic range compressing". It will retain 100% +of the dynamic range *within* each section of the audio file. +

+
+
framelen, f
+

Set the frame length in milliseconds. In range from 10 to 8000 milliseconds. +Default is 500 milliseconds. +The Dynamic Audio Normalizer processes the input audio in small chunks, +referred to as frames. This is required, because a peak magnitude has no +meaning for just a single sample value. Instead, we need to determine the +peak magnitude for a contiguous sequence of sample values. While a "standard" +normalizer would simply use the peak magnitude of the complete file, the +Dynamic Audio Normalizer determines the peak magnitude individually for each +frame. The length of a frame is specified in milliseconds. By default, the +Dynamic Audio Normalizer uses a frame length of 500 milliseconds, which has +been found to give good results with most files. +Note that the exact frame length, in number of samples, will be determined +automatically, based on the sampling rate of the individual input audio file. +

+
+
gausssize, g
+

Set the Gaussian filter window size. In range from 3 to 301, must be odd +number. Default is 31. +Probably the most important parameter of the Dynamic Audio Normalizer is the +window size of the Gaussian smoothing filter. The filter’s window size +is specified in frames, centered around the current frame. For the sake of +simplicity, this must be an odd number. Consequently, the default value of 31 +takes into account the current frame, as well as the 15 preceding frames and +the 15 subsequent frames. Using a larger window results in a stronger +smoothing effect and thus in less gain variation, i.e. slower gain +adaptation. Conversely, using a smaller window results in a weaker smoothing +effect and thus in more gain variation, i.e. faster gain adaptation. +In other words, the more you increase this value, the more the Dynamic Audio +Normalizer will behave like a "traditional" normalization filter. On the +contrary, the more you decrease this value, the more the Dynamic Audio +Normalizer will behave like a dynamic range compressor. +

+
+
peak, p
+

Set the target peak value. This specifies the highest permissible magnitude +level for the normalized audio input. This filter will try to approach the +target peak magnitude as closely as possible, but at the same time it also +makes sure that the normalized signal will never exceed the peak magnitude. +A frame’s maximum local gain factor is imposed directly by the target peak +magnitude. The default value is 0.95 and thus leaves a headroom of 5%*. +It is not recommended to go above this value. +

+
+
maxgain, m
+

Set the maximum gain factor. In range from 1.0 to 100.0. Default is 10.0. +The Dynamic Audio Normalizer determines the maximum possible (local) gain +factor for each input frame, i.e. the maximum gain factor that does not +result in clipping or distortion. The maximum gain factor is determined by +the frame’s highest magnitude sample. However, the Dynamic Audio Normalizer +additionally bounds the frame’s maximum gain factor by a predetermined +(global) maximum gain factor. This is done in order to avoid excessive gain +factors in "silent" or almost silent frames. By default, the maximum gain +factor is 10.0, For most inputs the default value should be sufficient and +it usually is not recommended to increase this value. Though, for input +with an extremely low overall volume level, it may be necessary to allow even +higher gain factors. Note, however, that the Dynamic Audio Normalizer does +not simply apply a "hard" threshold (i.e. cut off values above the threshold). +Instead, a "sigmoid" threshold function will be applied. This way, the +gain factors will smoothly approach the threshold value, but never exceed that +value. +

+
+
targetrms, r
+

Set the target RMS. In range from 0.0 to 1.0. Default is 0.0 - disabled. +By default, the Dynamic Audio Normalizer performs "peak" normalization. +This means that the maximum local gain factor for each frame is defined +(only) by the frame’s highest magnitude sample. This way, the samples can +be amplified as much as possible without exceeding the maximum signal +level, i.e. without clipping. Optionally, however, the Dynamic Audio +Normalizer can also take into account the frame’s root mean square, +abbreviated RMS. In electrical engineering, the RMS is commonly used to +determine the power of a time-varying signal. It is therefore considered +that the RMS is a better approximation of the "perceived loudness" than +just looking at the signal’s peak magnitude. Consequently, by adjusting all +frames to a constant RMS value, a uniform "perceived loudness" can be +established. If a target RMS value has been specified, a frame’s local gain +factor is defined as the factor that would result in exactly that RMS value. +Note, however, that the maximum local gain factor is still restricted by the +frame’s highest magnitude sample, in order to prevent clipping. +

+
+
coupling, n
+

Enable channels coupling. By default is enabled. +By default, the Dynamic Audio Normalizer will amplify all channels by the same +amount. This means the same gain factor will be applied to all channels, i.e. +the maximum possible gain factor is determined by the "loudest" channel. +However, in some recordings, it may happen that the volume of the different +channels is uneven, e.g. one channel may be "quieter" than the other one(s). +In this case, this option can be used to disable the channel coupling. This way, +the gain factor will be determined independently for each channel, depending +only on the individual channel’s highest magnitude sample. This allows for +harmonizing the volume of the different channels. +

+
+
correctdc, c
+

Enable DC bias correction. By default is disabled. +An audio signal (in the time domain) is a sequence of sample values. +In the Dynamic Audio Normalizer these sample values are represented in the +-1.0 to 1.0 range, regardless of the original input format. Normally, the +audio signal, or "waveform", should be centered around the zero point. +That means if we calculate the mean value of all samples in a file, or in a +single frame, then the result should be 0.0 or at least very close to that +value. If, however, there is a significant deviation of the mean value from +0.0, in either positive or negative direction, this is referred to as a +DC bias or DC offset. Since a DC bias is clearly undesirable, the Dynamic +Audio Normalizer provides optional DC bias correction. +With DC bias correction enabled, the Dynamic Audio Normalizer will determine +the mean value, or "DC correction" offset, of each input frame and subtract +that value from all of the frame’s sample values which ensures those samples +are centered around 0.0 again. Also, in order to avoid "gaps" at the frame +boundaries, the DC correction offset values will be interpolated smoothly +between neighbouring frames. +

+
+
altboundary, b
+

Enable alternative boundary mode. By default is disabled. +The Dynamic Audio Normalizer takes into account a certain neighbourhood +around each frame. This includes the preceding frames as well as the +subsequent frames. However, for the "boundary" frames, located at the very +beginning and at the very end of the audio file, not all neighbouring +frames are available. In particular, for the first few frames in the audio +file, the preceding frames are not known. And, similarly, for the last few +frames in the audio file, the subsequent frames are not known. Thus, the +question arises which gain factors should be assumed for the missing frames +in the "boundary" region. The Dynamic Audio Normalizer implements two modes +to deal with this situation. The default boundary mode assumes a gain factor +of exactly 1.0 for the missing frames, resulting in a smooth "fade in" and +"fade out" at the beginning and at the end of the input, respectively. +

+
+
compress, s
+

Set the compress factor. In range from 0.0 to 30.0. Default is 0.0. +By default, the Dynamic Audio Normalizer does not apply "traditional" +compression. This means that signal peaks will not be pruned and thus the +full dynamic range will be retained within each local neighbourhood. However, +in some cases it may be desirable to combine the Dynamic Audio Normalizer’s +normalization algorithm with a more "traditional" compression. +For this purpose, the Dynamic Audio Normalizer provides an optional compression +(thresholding) function. If (and only if) the compression feature is enabled, +all input frames will be processed by a soft knee thresholding function prior +to the actual normalization process. Put simply, the thresholding function is +going to prune all samples whose magnitude exceeds a certain threshold value. +However, the Dynamic Audio Normalizer does not simply apply a fixed threshold +value. Instead, the threshold value will be adjusted for each individual +frame. +In general, smaller parameters result in stronger compression, and vice versa. +Values below 3.0 are not recommended, because audible distortion may appear. +

+
+
threshold, t
+

Set the target threshold value. This specifies the lowest permissible +magnitude level for the audio input which will be normalized. +If input frame volume is above this value frame will be normalized. +Otherwise frame may not be normalized at all. The default value is set +to 0, which means all input frames will be normalized. +This option is mostly useful if digital noise is not wanted to be amplified. +

+
+ + +

8.63.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

8.64 earwax

+ +

Make audio easier to listen to on headphones. +

+

This filter adds ‘cues’ to 44.1kHz stereo (i.e. audio CD format) audio +so that when listened to on headphones the stereo image is moved from +inside your head (standard for headphones) to outside and in front of +the listener (standard for speakers). +

+

Ported from SoX. +

+ +

8.65 equalizer

+ +

Apply a two-pole peaking equalisation (EQ) filter. With this +filter, the signal-level at and around a selected frequency can +be increased or decreased, whilst (unlike bandpass and bandreject +filters) that at all other frequencies is unchanged. +

+

In order to produce complex equalisation curves, this filter can +be given several times, each with a different central frequency. +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the filter’s central frequency in Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
gain, g
+

Set the required gain or attenuation in dB. +Beware of clipping when using a positive gain. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

8.65.1 Examples

+
    +
  • Attenuate 10 dB at 1000 Hz, with a bandwidth of 200 Hz: +
    +
    equalizer=f=1000:t=h:width=200:g=-10
+
    + +
  • Apply 2 dB gain at 1000 Hz with Q 1 and attenuate 5 dB at 100 Hz with Q 2: +
    +
    equalizer=f=1000:t=q:w=1:g=2,equalizer=f=100:t=q:w=2:g=-5
+
    +
+ + +

8.65.2 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change equalizer frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change equalizer width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change equalizer width. +Syntax for the command is : "width" +

+
+
gain, g
+

Change equalizer gain. +Syntax for the command is : "gain" +

+
+
mix, m
+

Change equalizer mix. +Syntax for the command is : "mix" +

+
+ + +

8.66 extrastereo

+ +

Linearly increases the difference between left and right channels which +adds some sort of "live" effect to playback. +

+

The filter accepts the following options: +

+
+
m
+

Sets the difference coefficient (default: 2.5). 0.0 means mono sound +(average of both channels), with 1.0 sound will be unchanged, with +-1.0 left and right channels will be swapped. +

+
+
c
+

Enable clipping. By default is enabled. +

+
+ + +

8.66.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

8.67 firequalizer

+

Apply FIR Equalization using arbitrary frequency response. +

+

The filter accepts the following option: +

+
+
gain
+

Set gain curve equation (in dB). The expression can contain variables: +

+
f
+

the evaluated frequency +

+
sr
+

sample rate +

+
ch
+

channel number, set to 0 when multichannels evaluation is disabled +

+
chid
+

channel id, see libavutil/channel_layout.h, set to the first channel id when +multichannels evaluation is disabled +

+
chs
+

number of channels +

+
chlayout
+

channel_layout, see libavutil/channel_layout.h +

+
+
+

and functions: +

+
gain_interpolate(f)
+

interpolate gain on frequency f based on gain_entry +

+
cubic_interpolate(f)
+

same as gain_interpolate, but smoother +

+
+

This option is also available as command. Default is gain_interpolate(f). +

+
+
gain_entry
+

Set gain entry for gain_interpolate function. The expression can +contain functions: +

+
entry(f, g)
+

store gain entry at frequency f with value g +

+
+

This option is also available as command. +

+
+
delay
+

Set filter delay in seconds. Higher value means more accurate. +Default is 0.01. +

+
+
accuracy
+

Set filter accuracy in Hz. Lower value means more accurate. +Default is 5. +

+
+
wfunc
+

Set window function. Acceptable values are: +

+
rectangular
+

rectangular window, useful when gain curve is already smooth +

+
hann
+

hann window (default) +

+
hamming
+

hamming window +

+
blackman
+

blackman window +

+
nuttall3
+

3-terms continuous 1st derivative nuttall window +

+
mnuttall3
+

minimum 3-terms discontinuous nuttall window +

+
nuttall
+

4-terms continuous 1st derivative nuttall window +

+
bnuttall
+

minimum 4-terms discontinuous nuttall (blackman-nuttall) window +

+
bharris
+

blackman-harris window +

+
tukey
+

tukey window +

+
+ +
+
fixed
+

If enabled, use fixed number of audio samples. This improves speed when +filtering with large delay. Default is disabled. +

+
+
multi
+

Enable multichannels evaluation on gain. Default is disabled. +

+
+
zero_phase
+

Enable zero phase mode by subtracting timestamp to compensate delay. +Default is disabled. +

+
+
scale
+

Set scale used by gain. Acceptable values are: +

+
linlin
+

linear frequency, linear gain +

+
linlog
+

linear frequency, logarithmic (in dB) gain (default) +

+
loglin
+

logarithmic (in octave scale where 20 Hz is 0) frequency, linear gain +

+
loglog
+

logarithmic frequency, logarithmic gain +

+
+ +
+
dumpfile
+

Set file for dumping, suitable for gnuplot. +

+
+
dumpscale
+

Set scale for dumpfile. Acceptable values are same with scale option. +Default is linlog. +

+
+
fft2
+

Enable 2-channel convolution using complex FFT. This improves speed significantly. +Default is disabled. +

+
+
min_phase
+

Enable minimum phase impulse response. Default is disabled. +

+
+ + +

8.67.1 Examples

+
    +
  • lowpass at 1000 Hz: +
    +
    firequalizer=gain='if(lt(f,1000), 0, -INF)'
+
    +
  • lowpass at 1000 Hz with gain_entry: +
    +
    firequalizer=gain_entry='entry(1000,0); entry(1001, -INF)'
+
    +
  • custom equalization: +
    +
    firequalizer=gain_entry='entry(100,0); entry(400, -4); entry(1000, -6); entry(2000, 0)'
+
    +
  • higher delay with zero phase to compensate delay: +
    +
    firequalizer=delay=0.1:fixed=on:zero_phase=on
+
    +
  • lowpass on left channel, highpass on right channel: +
    +
    firequalizer=gain='if(eq(chid,1), gain_interpolate(f), if(eq(chid,2), gain_interpolate(1e6+f), 0))'
+:gain_entry='entry(1000, 0); entry(1001,-INF); entry(1e6+1000,0)':multi=on
+
    +
+ + +

8.68 flanger

+

Apply a flanging effect to the audio. +

+

The filter accepts the following options: +

+
+
delay
+

Set base delay in milliseconds. Range from 0 to 30. Default value is 0. +

+
+
depth
+

Set added sweep delay in milliseconds. Range from 0 to 10. Default value is 2. +

+
+
regen
+

Set percentage regeneration (delayed signal feedback). Range from -95 to 95. +Default value is 0. +

+
+
width
+

Set percentage of delayed signal mixed with original. Range from 0 to 100. +Default value is 71. +

+
+
speed
+

Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5. +

+
+
shape
+

Set swept wave shape, can be triangular or sinusoidal. +Default value is sinusoidal. +

+
+
phase
+

Set swept wave percentage-shift for multi channel. Range from 0 to 100. +Default value is 25. +

+
+
interp
+

Set delay-line interpolation, linear or quadratic. +Default is linear. +

+
+ + +

8.69 haas

+

Apply Haas effect to audio. +

+

Note that this makes most sense to apply on mono signals. +With this filter applied to mono signals it give some directionality and +stretches its stereo image. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input level. By default is 1, or 0dB +

+
+
level_out
+

Set output level. By default is 1, or 0dB. +

+
+
side_gain
+

Set gain applied to side part of signal. By default is 1. +

+
+
middle_source
+

Set kind of middle source. Can be one of the following: +

+
+
‘left’
+

Pick left channel. +

+
+
‘right’
+

Pick right channel. +

+
+
‘mid’
+

Pick middle part signal of stereo image. +

+
+
‘side’
+

Pick side part signal of stereo image. +

+
+ +
+
middle_phase
+

Change middle phase. By default is disabled. +

+
+
left_delay
+

Set left channel delay. By default is 2.05 milliseconds. +

+
+
left_balance
+

Set left channel balance. By default is -1. +

+
+
left_gain
+

Set left channel gain. By default is 1. +

+
+
left_phase
+

Change left phase. By default is disabled. +

+
+
right_delay
+

Set right channel delay. By defaults is 2.12 milliseconds. +

+
+
right_balance
+

Set right channel balance. By default is 1. +

+
+
right_gain
+

Set right channel gain. By default is 1. +

+
+
right_phase
+

Change right phase. By default is enabled. +

+
+ + +

8.70 hdcd

+ +

Decodes High Definition Compatible Digital (HDCD) data. A 16-bit PCM stream with +embedded HDCD codes is expanded into a 20-bit PCM stream. +

+

The filter supports the Peak Extend and Low-level Gain Adjustment features +of HDCD, and detects the Transient Filter flag. +

+
+
ffmpeg -i HDCD16.flac -af hdcd OUT24.flac
+
+ +

When using the filter with wav, note the default encoding for wav is 16-bit, +so the resulting 20-bit stream will be truncated back to 16-bit. Use something +like -acodec pcm_s24le after the filter to get 24-bit PCM output. +

+
ffmpeg -i HDCD16.wav -af hdcd OUT16.wav
+ffmpeg -i HDCD16.wav -af hdcd -c:a pcm_s24le OUT24.wav
+
+ +

The filter accepts the following options: +

+
+
disable_autoconvert
+

Disable any automatic format conversion or resampling in the filter graph. +

+
+
process_stereo
+

Process the stereo channels together. If target_gain does not match between +channels, consider it invalid and use the last valid target_gain. +

+
+
cdt_ms
+

Set the code detect timer period in ms. +

+
+
force_pe
+

Always extend peaks above -3dBFS even if PE isn’t signaled. +

+
+
analyze_mode
+

Replace audio with a solid tone and adjust the amplitude to signal some +specific aspect of the decoding process. The output file can be loaded in +an audio editor alongside the original to aid analysis. +

+

analyze_mode=pe:force_pe=true can be used to see all samples above the PE level. +

+

Modes are: +

+
‘0, off’
+

Disabled +

+
‘1, lle’
+

Gain adjustment level at each sample +

+
‘2, pe’
+

Samples where peak extend occurs +

+
‘3, cdt’
+

Samples where the code detect timer is active +

+
‘4, tgm’
+

Samples where the target gain does not match between channels +

+
+
+
+ + +

8.71 headphone

+ +

Apply head-related transfer functions (HRTFs) to create virtual +loudspeakers around the user for binaural listening via headphones. +The HRIRs are provided via additional streams, for each channel +one stereo input stream is needed. +

+

The filter accepts the following options: +

+
+
map
+

Set mapping of input streams for convolution. +The argument is a ’|’-separated list of channel names in order as they +are given as additional stream inputs for filter. +This also specify number of input streams. Number of input streams +must be not less than number of channels in first stream plus one. +

+
+
gain
+

Set gain applied to audio. Value is in dB. Default is 0. +

+
+
type
+

Set processing type. Can be time or freq. time is +processing audio in time domain which is slow. +freq is processing audio in frequency domain which is fast. +Default is freq. +

+
+
lfe
+

Set custom gain for LFE channels. Value is in dB. Default is 0. +

+
+
size
+

Set size of frame in number of samples which will be processed at once. +Default value is 1024. Allowed range is from 1024 to 96000. +

+
+
hrir
+

Set format of hrir stream. +Default value is stereo. Alternative value is multich. +If value is set to stereo, number of additional streams should +be greater or equal to number of input channels in first input stream. +Also each additional stream should have stereo number of channels. +If value is set to multich, number of additional streams should +be exactly one. Also number of input channels of additional stream +should be equal or greater than twice number of channels of first input +stream. +

+
+ + +

8.71.1 Examples

+ +
    +
  • Full example using wav files as coefficients with amovie filters for 7.1 downmix, +each amovie filter use stereo file with IR coefficients as input. +The files give coefficients for each position of virtual loudspeaker: +
    +
    ffmpeg -i input.wav
+-filter_complex "amovie=azi_270_ele_0_DFC.wav[sr];amovie=azi_90_ele_0_DFC.wav[sl];amovie=azi_225_ele_0_DFC.wav[br];amovie=azi_135_ele_0_DFC.wav[bl];amovie=azi_0_ele_0_DFC.wav,asplit[fc][lfe];amovie=azi_35_ele_0_DFC.wav[fl];amovie=azi_325_ele_0_DFC.wav[fr];[0:a][fl][fr][fc][lfe][bl][br][sl][sr]headphone=FL|FR|FC|LFE|BL|BR|SL|SR"
+output.wav
+
    + +
  • Full example using wav files as coefficients with amovie filters for 7.1 downmix, +but now in multich hrir format. +
    +
    ffmpeg -i input.wav -filter_complex "amovie=minp.wav[hrirs];[0:a][hrirs]headphone=map=FL|FR|FC|LFE|BL|BR|SL|SR:hrir=multich"
+output.wav
+
    +
+ + +

8.72 highpass

+ +

Apply a high-pass filter with 3dB point frequency. +The filter can be either single-pole, or double-pole (the default). +The filter roll off at 6dB per pole per octave (20dB per pole per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set frequency in Hz. Default is 3000. +

+
+
poles, p
+

Set number of poles. Default is 2. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +Applies only to double-pole filter. +The default is 0.707q and gives a Butterworth response. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

8.72.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change highpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change highpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change highpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change highpass mix. +Syntax for the command is : "mix" +

+
+ + +

8.73 join

+ +

Join multiple input streams into one multi-channel stream. +

+

It accepts the following parameters: +

+
inputs
+

The number of input streams. It defaults to 2. +

+
+
channel_layout
+

The desired output channel layout. It defaults to stereo. +

+
+
map
+

Map channels from inputs to output. The argument is a ’|’-separated list of +mappings, each in the input_idx.in_channel-out_channel +form. input_idx is the 0-based index of the input stream. in_channel +can be either the name of the input channel (e.g. FL for front left) or its +index in the specified input stream. out_channel is the name of the output +channel. +

+
+ +

The filter will attempt to guess the mappings when they are not specified +explicitly. It does so by first trying to find an unused matching input channel +and if that fails it picks the first unused input channel. +

+

Join 3 inputs (with properly set channel layouts): +

+
ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
+
+ +

Build a 5.1 output from 6 single-channel streams: +

+
ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
+'join=inputs=6:channel_layout=5.1:map=0.0-FL|1.0-FR|2.0-FC|3.0-SL|4.0-SR|5.0-LFE'
+out
+
+ + +

8.74 ladspa

+ +

Load a LADSPA (Linux Audio Developer’s Simple Plugin API) plugin. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-ladspa. +

+
+
file, f
+

Specifies the name of LADSPA plugin library to load. If the environment +variable LADSPA_PATH is defined, the LADSPA plugin is searched in +each one of the directories specified by the colon separated list in +LADSPA_PATH, otherwise in the standard LADSPA paths, which are in +this order: HOME/.ladspa/lib/, /usr/local/lib/ladspa/, +/usr/lib/ladspa/. +

+
+
plugin, p
+

Specifies the plugin within the library. Some libraries contain only +one plugin, but others contain many of them. If this is not set filter +will list all available plugins within the specified library. +

+
+
controls, c
+

Set the ’|’ separated list of controls which are zero or more floating point +values that determine the behavior of the loaded plugin (for example delay, +threshold or gain). +Controls need to be defined using the following syntax: +c0=value0|c1=value1|c2=value2|..., where +valuei is the value set on the i-th control. +Alternatively they can be also defined using the following syntax: +value0|value1|value2|..., where +valuei is the value set on the i-th control. +If controls is set to help, all available controls and +their valid ranges are printed. +

+
+
sample_rate, s
+

Specify the sample rate, default to 44100. Only used if plugin have +zero inputs. +

+
+
nb_samples, n
+

Set the number of samples per channel per each output frame, default +is 1024. Only used if plugin have zero inputs. +

+
+
duration, d
+

Set the minimum duration of the sourced audio. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +Note that the resulting duration may be greater than the specified duration, +as the generated audio is always cut at the end of a complete frame. +If not specified, or the expressed duration is negative, the audio is +supposed to be generated forever. +Only used if plugin have zero inputs. +

+
+
+ + +

8.74.1 Examples

+ +
    +
  • List all available plugins within amp (LADSPA example plugin) library: +
    +
    ladspa=file=amp
+
    + +
  • List all available controls and their valid ranges for vcf_notch +plugin from VCF library: +
    +
    ladspa=f=vcf:p=vcf_notch:c=help
+
    + +
  • Simulate low quality audio equipment using Computer Music Toolkit (CMT) +plugin library: +
    +
    ladspa=file=cmt:plugin=lofi:controls=c0=22|c1=12|c2=12
+
    + +
  • Add reverberation to the audio using TAP-plugins +(Tom’s Audio Processing plugins): +
    +
    ladspa=file=tap_reverb:tap_reverb
+
    + +
  • Generate white noise, with 0.2 amplitude: +
    +
    ladspa=file=cmt:noise_source_white:c=c0=.2
+
    + +
  • Generate 20 bpm clicks using plugin C* Click - Metronome from the +C* Audio Plugin Suite (CAPS) library: +
    +
    ladspa=file=caps:Click:c=c1=20'
+
    + +
  • Apply C* Eq10X2 - Stereo 10-band equaliser effect: +
    +
    ladspa=caps:Eq10X2:c=c0=-48|c9=-24|c3=12|c4=2
+
    + +
  • Increase volume by 20dB using fast lookahead limiter from Steve Harris +SWH Plugins collection: +
    +
    ladspa=fast_lookahead_limiter_1913:fastLookaheadLimiter:20|0|2
+
    + +
  • Attenuate low frequencies using Multiband EQ from Steve Harris +SWH Plugins collection: +
    +
    ladspa=mbeq_1197:mbeq:-24|-24|-24|0|0|0|0|0|0|0|0|0|0|0|0
+
    + +
  • Reduce stereo image using Narrower from the C* Audio Plugin Suite +(CAPS) library: +
    +
    ladspa=caps:Narrower
+
    + +
  • Another white noise, now using C* Audio Plugin Suite (CAPS) library: +
    +
    ladspa=caps:White:.2
+
    + +
  • Some fractal noise, using C* Audio Plugin Suite (CAPS) library: +
    +
    ladspa=caps:Fractal:c=c1=1
+
    + +
  • Dynamic volume normalization using VLevel plugin: +
    +
    ladspa=vlevel-ladspa:vlevel_mono
+
    +
+ + +

8.74.2 Commands

+ +

This filter supports the following commands: +

+
cN
+

Modify the N-th control value. +

+

If the specified value is not valid, it is ignored and prior one is kept. +

+
+ + +

8.75 loudnorm

+ +

EBU R128 loudness normalization. Includes both dynamic and linear normalization modes. +Support for both single pass (livestreams, files) and double pass (files) modes. +This algorithm can target IL, LRA, and maximum true peak. In dynamic mode, to accurately +detect true peaks, the audio stream will be upsampled to 192 kHz. +Use the -ar option or aresample filter to explicitly set an output sample rate. +

+

The filter accepts the following options: +

+
+
I, i
+

Set integrated loudness target. +Range is -70.0 - -5.0. Default value is -24.0. +

+
+
LRA, lra
+

Set loudness range target. +Range is 1.0 - 20.0. Default value is 7.0. +

+
+
TP, tp
+

Set maximum true peak. +Range is -9.0 - +0.0. Default value is -2.0. +

+
+
measured_I, measured_i
+

Measured IL of input file. +Range is -99.0 - +0.0. +

+
+
measured_LRA, measured_lra
+

Measured LRA of input file. +Range is 0.0 - 99.0. +

+
+
measured_TP, measured_tp
+

Measured true peak of input file. +Range is -99.0 - +99.0. +

+
+
measured_thresh
+

Measured threshold of input file. +Range is -99.0 - +0.0. +

+
+
offset
+

Set offset gain. Gain is applied before the true-peak limiter. +Range is -99.0 - +99.0. Default is +0.0. +

+
+
linear
+

Normalize by linearly scaling the source audio. +measured_I, measured_LRA, measured_TP, +and measured_thresh must all be specified. Target LRA shouldn’t +be lower than source LRA and the change in integrated loudness shouldn’t +result in a true peak which exceeds the target TP. If any of these +conditions aren’t met, normalization mode will revert to dynamic. +Options are true or false. Default is true. +

+
+
dual_mono
+

Treat mono input files as "dual-mono". If a mono file is intended for playback +on a stereo system, its EBU R128 measurement will be perceptually incorrect. +If set to true, this option will compensate for this effect. +Multi-channel input files are not affected by this option. +Options are true or false. Default is false. +

+
+
print_format
+

Set print format for stats. Options are summary, json, or none. +Default value is none. +

+
+ + +

8.76 lowpass

+ +

Apply a low-pass filter with 3dB point frequency. +The filter can be either single-pole or double-pole (the default). +The filter roll off at 6dB per pole per octave (20dB per pole per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set frequency in Hz. Default is 500. +

+
+
poles, p
+

Set number of poles. Default is 2. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +Applies only to double-pole filter. +The default is 0.707q and gives a Butterworth response. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

8.76.1 Examples

+
    +
  • Lowpass only LFE channel, it LFE is not present it does nothing: +
    +
    lowpass=c=LFE
+
    +
+ + +

8.76.2 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change lowpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change lowpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change lowpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change lowpass mix. +Syntax for the command is : "mix" +

+
+ + +

8.77 lv2

+ +

Load a LV2 (LADSPA Version 2) plugin. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-lv2. +

+
+
plugin, p
+

Specifies the plugin URI. You may need to escape ’:’. +

+
+
controls, c
+

Set the ’|’ separated list of controls which are zero or more floating point +values that determine the behavior of the loaded plugin (for example delay, +threshold or gain). +If controls is set to help, all available controls and +their valid ranges are printed. +

+
+
sample_rate, s
+

Specify the sample rate, default to 44100. Only used if plugin have +zero inputs. +

+
+
nb_samples, n
+

Set the number of samples per channel per each output frame, default +is 1024. Only used if plugin have zero inputs. +

+
+
duration, d
+

Set the minimum duration of the sourced audio. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +Note that the resulting duration may be greater than the specified duration, +as the generated audio is always cut at the end of a complete frame. +If not specified, or the expressed duration is negative, the audio is +supposed to be generated forever. +Only used if plugin have zero inputs. +

+
+ + +

8.77.1 Examples

+ +
    +
  • Apply bass enhancer plugin from Calf: +
    +
    lv2=p=http\\\\://calf.sourceforge.net/plugins/BassEnhancer:c=amount=2
+
    + +
  • Apply vinyl plugin from Calf: +
    +
    lv2=p=http\\\\://calf.sourceforge.net/plugins/Vinyl:c=drone=0.2|aging=0.5
+
    + +
  • Apply bit crusher plugin from ArtyFX: +
    +
    lv2=p=http\\\\://www.openavproductions.com/artyfx#bitta:c=crush=0.3
+
    +
+ + +

8.78 mcompand

+

Multiband Compress or expand the audio’s dynamic range. +

+

The input audio is divided into bands using 4th order Linkwitz-Riley IIRs. +This is akin to the crossover of a loudspeaker, and results in flat frequency +response when absent compander action. +

+

It accepts the following parameters: +

+
+
args
+

This option syntax is: +attack,decay,[attack,decay..] soft-knee points crossover_frequency [delay [initial_volume [gain]]] | attack,decay ... +For explanation of each item refer to compand filter documentation. +

+
+ + +

8.79 pan

+ +

Mix channels with specific gain levels. The filter accepts the output +channel layout followed by a set of channels definitions. +

+

This filter is also designed to efficiently remap the channels of an audio +stream. +

+

The filter accepts parameters of the form: +"l|outdef|outdef|..." +

+
+
l
+

output channel layout or number of channels +

+
+
outdef
+

output channel specification, of the form: +"out_name=[gain*]in_name[(+-)[gain*]in_name...]" +

+
+
out_name
+

output channel to define, either a channel name (FL, FR, etc.) or a channel +number (c0, c1, etc.) +

+
+
gain
+

multiplicative coefficient for the channel, 1 leaving the volume unchanged +

+
+
in_name
+

input channel to use, see out_name for details; it is not possible to mix +named and numbered input channels +

+
+ +

If the ‘=’ in a channel specification is replaced by ‘<’, then the gains for +that specification will be renormalized so that the total is 1, thus +avoiding clipping noise. +

+ +

8.79.1 Mixing examples

+ +

For example, if you want to down-mix from stereo to mono, but with a bigger +factor for the left channel: +

+
pan=1c|c0=0.9*c0+0.1*c1
+
+ +

A customized down-mix to stereo that works automatically for 3-, 4-, 5- and +7-channels surround: +

+
pan=stereo| FL < FL + 0.5*FC + 0.6*BL + 0.6*SL | FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
+
+ +

Note that ffmpeg integrates a default down-mix (and up-mix) system +that should be preferred (see "-ac" option) unless you have very specific +needs. +

+ +

8.79.2 Remapping examples

+ +

The channel remapping will be effective if, and only if: +

+
    +
  • gain coefficients are zeroes or ones, +
  • only one input per channel output, +
+ +

If all these conditions are satisfied, the filter will notify the user ("Pure +channel mapping detected"), and use an optimized and lossless method to do the +remapping. +

+

For example, if you have a 5.1 source and want a stereo audio stream by +dropping the extra channels: +

+
pan="stereo| c0=FL | c1=FR"
+
+ +

Given the same source, you can also switch front left and front right channels +and keep the input channel layout: +

+
pan="5.1| c0=c1 | c1=c0 | c2=c2 | c3=c3 | c4=c4 | c5=c5"
+
+ +

If the input is a stereo audio stream, you can mute the front left channel (and +still keep the stereo channel layout) with: +

+
pan="stereo|c1=c1"
+
+ +

Still with a stereo audio stream input, you can copy the right channel in both +front left and right: +

+
pan="stereo| c0=FR | c1=FR"
+
+ + +

8.80 replaygain

+ +

ReplayGain scanner filter. This filter takes an audio stream as an input and +outputs it unchanged. +At end of filtering it displays track_gain and track_peak. +

+ +

8.81 resample

+ +

Convert the audio sample format, sample rate and channel layout. It is +not meant to be used directly. +

+ +

8.82 rubberband

+

Apply time-stretching and pitch-shifting with librubberband. +

+

To enable compilation of this filter, you need to configure FFmpeg with +--enable-librubberband. +

+

The filter accepts the following options: +

+
+
tempo
+

Set tempo scale factor. +

+
+
pitch
+

Set pitch scale factor. +

+
+
transients
+

Set transients detector. +Possible values are: +

+
crisp
+
mixed
+
smooth
+
+ +
+
detector
+

Set detector. +Possible values are: +

+
compound
+
percussive
+
soft
+
+ +
+
phase
+

Set phase. +Possible values are: +

+
laminar
+
independent
+
+ +
+
window
+

Set processing window size. +Possible values are: +

+
standard
+
short
+
long
+
+ +
+
smoothing
+

Set smoothing. +Possible values are: +

+
off
+
on
+
+ +
+
formant
+

Enable formant preservation when shift pitching. +Possible values are: +

+
shifted
+
preserved
+
+ +
+
pitchq
+

Set pitch quality. +Possible values are: +

+
quality
+
speed
+
consistency
+
+ +
+
channels
+

Set channels. +Possible values are: +

+
apart
+
together
+
+
+
+ + +

8.82.1 Commands

+ +

This filter supports the following commands: +

+
tempo
+

Change filter tempo scale factor. +Syntax for the command is : "tempo" +

+
+
pitch
+

Change filter pitch scale factor. +Syntax for the command is : "pitch" +

+
+ + +

8.83 sidechaincompress

+ +

This filter acts like normal compressor but has the ability to compress +detected signal using second input signal. +It needs two input streams and returns one output stream. +First input stream will be processed depending on second stream signal. +The filtered signal then can be filtered with other filters in later stages of +processing. See pan and amerge filter. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. Default is 1. Range is between 0.015625 and 64. +

+
+
mode
+

Set mode of compressor operation. Can be upward or downward. +Default is downward. +

+
+
threshold
+

If a signal of second stream raises above this level it will affect the gain +reduction of first stream. +By default is 0.125. Range is between 0.00097563 and 1. +

+
+
ratio
+

Set a ratio about which the signal is reduced. 1:2 means that if the level +raised 4dB above the threshold, it will be only 2dB above after the reduction. +Default is 2. Range is between 1 and 20. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction starts. Default is 20. Range is between 0.01 and 2000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before +reduction is decreased again. Default is 250. Range is between 0.01 and 9000. +

+
+
makeup
+

Set the amount by how much signal will be amplified after processing. +Default is 1. Range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.82843. Range is between 1 and 8. +

+
+
link
+

Choose if the average level between all channels of side-chain stream +or the louder(maximum) channel of side-chain stream affects the +reduction. Default is average. +

+
+
detection
+

Should the exact signal be taken in case of peak or an RMS one in case +of rms. Default is rms which is mainly smoother. +

+
+
level_sc
+

Set sidechain gain. Default is 1. Range is between 0.015625 and 64. +

+
+
mix
+

How much to use compressed signal in output. Default is 1. +Range is between 0 and 1. +

+
+ + +

8.83.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

8.83.2 Examples

+ +
    +
  • Full ffmpeg example taking 2 audio inputs, 1st input to be compressed +depending on the signal of 2nd input and later compressed signal to be +merged with 2nd input: +
    +
    ffmpeg -i main.flac -i sidechain.flac -filter_complex "[1:a]asplit=2[sc][mix];[0:a][sc]sidechaincompress[compr];[compr][mix]amerge"
+
    +
+ + +

8.84 sidechaingate

+ +

A sidechain gate acts like a normal (wideband) gate but has the ability to +filter the detected signal before sending it to the gain reduction stage. +Normally a gate uses the full range signal to detect a level above the +threshold. +For example: If you cut all lower frequencies from your sidechain signal +the gate will decrease the volume of your track only if not enough highs +appear. With this technique you are able to reduce the resonation of a +natural drum or remove "rumbling" of muted strokes from a heavily distorted +guitar. +It needs two input streams and returns one output stream. +First input stream will be processed depending on second stream signal. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input level before filtering. +Default is 1. Allowed range is from 0.015625 to 64. +

+
+
mode
+

Set the mode of operation. Can be upward or downward. +Default is downward. If set to upward mode, higher parts of signal +will be amplified, expanding dynamic range in upward direction. +Otherwise, in case of downward lower parts of signal will be reduced. +

+
+
range
+

Set the level of gain reduction when the signal is below the threshold. +Default is 0.06125. Allowed range is from 0 to 1. +Setting this to 0 disables reduction and then filter behaves like expander. +

+
+
threshold
+

If a signal rises above this level the gain reduction is released. +Default is 0.125. Allowed range is from 0 to 1. +

+
+
ratio
+

Set a ratio about which the signal is reduced. +Default is 2. Allowed range is from 1 to 9000. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction stops. +Default is 20 milliseconds. Allowed range is from 0.01 to 9000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before the +reduction is increased again. Default is 250 milliseconds. +Allowed range is from 0.01 to 9000. +

+
+
makeup
+

Set amount of amplification of signal after processing. +Default is 1. Allowed range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.828427125. Allowed range is from 1 to 8. +

+
+
detection
+

Choose if exact signal should be taken for detection or an RMS like one. +Default is rms. Can be peak or rms. +

+
+
link
+

Choose if the average level between all channels or the louder channel affects +the reduction. +Default is average. Can be average or maximum. +

+
+
level_sc
+

Set sidechain gain. Default is 1. Range is from 0.015625 to 64. +

+
+ + +

8.85 silencedetect

+ +

Detect silence in an audio stream. +

+

This filter logs a message when it detects that the input audio volume is less +or equal to a noise tolerance value for a duration greater or equal to the +minimum detected noise duration. +

+

The printed times and duration are expressed in seconds. The +lavfi.silence_start or lavfi.silence_start.X metadata key +is set on the first frame whose timestamp equals or exceeds the detection +duration and it contains the timestamp of the first frame of the silence. +

+

The lavfi.silence_duration or lavfi.silence_duration.X +and lavfi.silence_end or lavfi.silence_end.X metadata +keys are set on the first frame after the silence. If mono is +enabled, and each channel is evaluated separately, the .X +suffixed keys are used, and X corresponds to the channel number. +

+

The filter accepts the following options: +

+
+
noise, n
+

Set noise tolerance. Can be specified in dB (in case "dB" is appended to the +specified value) or amplitude ratio. Default is -60dB, or 0.001. +

+
+
duration, d
+

Set silence duration until notification (default is 2 seconds). See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+
+
mono, m
+

Process each channel separately, instead of combined. By default is disabled. +

+
+ + +

8.85.1 Examples

+ +
    +
  • Detect 5 seconds of silence with -50dB noise tolerance: +
    +
    silencedetect=n=-50dB:d=5
+
    + +
  • Complete example with ffmpeg to detect silence with 0.0001 noise +tolerance in silence.mp3: +
    +
    ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
+
    +
+ + +

8.86 silenceremove

+ +

Remove silence from the beginning, middle or end of the audio. +

+

The filter accepts the following options: +

+
+
start_periods
+

This value is used to indicate if audio should be trimmed at beginning of +the audio. A value of zero indicates no silence should be trimmed from the +beginning. When specifying a non-zero value, it trims audio up until it +finds non-silence. Normally, when trimming silence from beginning of audio +the start_periods will be 1 but it can be increased to higher +values to trim all audio up to specific count of non-silence periods. +Default value is 0. +

+
+
start_duration
+

Specify the amount of time that non-silence must be detected before it stops +trimming audio. By increasing the duration, bursts of noises can be treated +as silence and trimmed off. Default value is 0. +

+
+
start_threshold
+

This indicates what sample value should be treated as silence. For digital +audio, a value of 0 may be fine but for audio recorded from analog, +you may wish to increase the value to account for background noise. +Can be specified in dB (in case "dB" is appended to the specified value) +or amplitude ratio. Default value is 0. +

+
+
start_silence
+

Specify max duration of silence at beginning that will be kept after +trimming. Default is 0, which is equal to trimming all samples detected +as silence. +

+
+
start_mode
+

Specify mode of detection of silence end in start of multi-channel audio. +Can be any or all. Default is any. +With any, any sample that is detected as non-silence will cause +stopped trimming of silence. +With all, only if all channels are detected as non-silence will cause +stopped trimming of silence. +

+
+
stop_periods
+

Set the count for trimming silence from the end of audio. +To remove silence from the middle of a file, specify a stop_periods +that is negative. This value is then treated as a positive value and is +used to indicate the effect should restart processing as specified by +start_periods, making it suitable for removing periods of silence +in the middle of the audio. +Default value is 0. +

+
+
stop_duration
+

Specify a duration of silence that must exist before audio is not copied any +more. By specifying a higher duration, silence that is wanted can be left in +the audio. +Default value is 0. +

+
+
stop_threshold
+

This is the same as start_threshold but for trimming silence from +the end of audio. +Can be specified in dB (in case "dB" is appended to the specified value) +or amplitude ratio. Default value is 0. +

+
+
stop_silence
+

Specify max duration of silence at end that will be kept after +trimming. Default is 0, which is equal to trimming all samples detected +as silence. +

+
+
stop_mode
+

Specify mode of detection of silence start in end of multi-channel audio. +Can be any or all. Default is any. +With any, any sample that is detected as non-silence will cause +stopped trimming of silence. +With all, only if all channels are detected as non-silence will cause +stopped trimming of silence. +

+
+
detection
+

Set how is silence detected. Can be rms or peak. Second is faster +and works better with digital silence which is exactly 0. +Default value is rms. +

+
+
window
+

Set duration in number of seconds used to calculate size of window in number +of samples for detecting silence. +Default value is 0.02. Allowed range is from 0 to 10. +

+
+ + +

8.86.1 Examples

+ +
    +
  • The following example shows how this filter can be used to start a recording +that does not contain the delay at the start which usually occurs between +pressing the record button and the start of the performance: +
    +
    silenceremove=start_periods=1:start_duration=5:start_threshold=0.02
+
    + +
  • Trim all silence encountered from beginning to end where there is more than 1 +second of silence in audio: +
    +
    silenceremove=stop_periods=-1:stop_duration=1:stop_threshold=-90dB
+
    + +
  • Trim all digital silence samples, using peak detection, from beginning to end +where there is more than 0 samples of digital silence in audio and digital +silence is detected in all channels at same positions in stream: +
    +
    silenceremove=window=0:detection=peak:stop_mode=all:start_mode=all:stop_periods=-1:stop_threshold=0
+
    +
+ + +

8.87 sofalizer

+ +

SOFAlizer uses head-related transfer functions (HRTFs) to create virtual +loudspeakers around the user for binaural listening via headphones (audio +formats up to 9 channels supported). +The HRTFs are stored in SOFA files (see http://www.sofacoustics.org/ for a database). +SOFAlizer is developed at the Acoustics Research Institute (ARI) of the +Austrian Academy of Sciences. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libmysofa. +

+

The filter accepts the following options: +

+
+
sofa
+

Set the SOFA file used for rendering. +

+
+
gain
+

Set gain applied to audio. Value is in dB. Default is 0. +

+
+
rotation
+

Set rotation of virtual loudspeakers in deg. Default is 0. +

+
+
elevation
+

Set elevation of virtual speakers in deg. Default is 0. +

+
+
radius
+

Set distance in meters between loudspeakers and the listener with near-field +HRTFs. Default is 1. +

+
+
type
+

Set processing type. Can be time or freq. time is +processing audio in time domain which is slow. +freq is processing audio in frequency domain which is fast. +Default is freq. +

+
+
speakers
+

Set custom positions of virtual loudspeakers. Syntax for this option is: +<CH> <AZIM> <ELEV>[|<CH> <AZIM> <ELEV>|...]. +Each virtual loudspeaker is described with short channel name following with +azimuth and elevation in degrees. +Each virtual loudspeaker description is separated by ’|’. +For example to override front left and front right channel positions use: +’speakers=FL 45 15|FR 345 15’. +Descriptions with unrecognised channel names are ignored. +

+
+
lfegain
+

Set custom gain for LFE channels. Value is in dB. Default is 0. +

+
+
framesize
+

Set custom frame size in number of samples. Default is 1024. +Allowed range is from 1024 to 96000. Only used if option ‘type’ +is set to freq. +

+
+
normalize
+

Should all IRs be normalized upon importing SOFA file. +By default is enabled. +

+
+
interpolate
+

Should nearest IRs be interpolated with neighbor IRs if exact position +does not match. By default is disabled. +

+
+
minphase
+

Minphase all IRs upon loading of SOFA file. By default is disabled. +

+
+
anglestep
+

Set neighbor search angle step. Only used if option interpolate is enabled. +

+
+
radstep
+

Set neighbor search radius step. Only used if option interpolate is enabled. +

+
+ + +

8.87.1 Examples

+ +
    +
  • Using ClubFritz6 sofa file: +
    +
    sofalizer=sofa=/path/to/ClubFritz6.sofa:type=freq:radius=1
+
    + +
  • Using ClubFritz12 sofa file and bigger radius with small rotation: +
    +
    sofalizer=sofa=/path/to/ClubFritz12.sofa:type=freq:radius=2:rotation=5
+
    + +
  • Similar as above but with custom speaker positions for front left, front right, back left and back right +and also with custom gain: +
    +
    "sofalizer=sofa=/path/to/ClubFritz6.sofa:type=freq:radius=2:speakers=FL 45|FR 315|BL 135|BR 225:gain=28"
+
    +
+ + +

8.88 stereotools

+ +

This filter has some handy utilities to manage stereo signals, for converting +M/S stereo recordings to L/R signal while having control over the parameters +or spreading the stereo image of master track. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input level before filtering for both channels. Defaults is 1. +Allowed range is from 0.015625 to 64. +

+
+
level_out
+

Set output level after filtering for both channels. Defaults is 1. +Allowed range is from 0.015625 to 64. +

+
+
balance_in
+

Set input balance between both channels. Default is 0. +Allowed range is from -1 to 1. +

+
+
balance_out
+

Set output balance between both channels. Default is 0. +Allowed range is from -1 to 1. +

+
+
softclip
+

Enable softclipping. Results in analog distortion instead of harsh digital 0dB +clipping. Disabled by default. +

+
+
mutel
+

Mute the left channel. Disabled by default. +

+
+
muter
+

Mute the right channel. Disabled by default. +

+
+
phasel
+

Change the phase of the left channel. Disabled by default. +

+
+
phaser
+

Change the phase of the right channel. Disabled by default. +

+
+
mode
+

Set stereo mode. Available values are: +

+
+
‘lr>lr’
+

Left/Right to Left/Right, this is default. +

+
+
‘lr>ms’
+

Left/Right to Mid/Side. +

+
+
‘ms>lr’
+

Mid/Side to Left/Right. +

+
+
‘lr>ll’
+

Left/Right to Left/Left. +

+
+
‘lr>rr’
+

Left/Right to Right/Right. +

+
+
‘lr>l+r’
+

Left/Right to Left + Right. +

+
+
‘lr>rl’
+

Left/Right to Right/Left. +

+
+
‘ms>ll’
+

Mid/Side to Left/Left. +

+
+
‘ms>rr’
+

Mid/Side to Right/Right. +

+
+ +
+
slev
+

Set level of side signal. Default is 1. +Allowed range is from 0.015625 to 64. +

+
+
sbal
+

Set balance of side signal. Default is 0. +Allowed range is from -1 to 1. +

+
+
mlev
+

Set level of the middle signal. Default is 1. +Allowed range is from 0.015625 to 64. +

+
+
mpan
+

Set middle signal pan. Default is 0. Allowed range is from -1 to 1. +

+
+
base
+

Set stereo base between mono and inversed channels. Default is 0. +Allowed range is from -1 to 1. +

+
+
delay
+

Set delay in milliseconds how much to delay left from right channel and +vice versa. Default is 0. Allowed range is from -20 to 20. +

+
+
sclevel
+

Set S/C level. Default is 1. Allowed range is from 1 to 100. +

+
+
phase
+

Set the stereo phase in degrees. Default is 0. Allowed range is from 0 to 360. +

+
+
bmode_in, bmode_out
+

Set balance mode for balance_in/balance_out option. +

+

Can be one of the following: +

+
+
‘balance’
+

Classic balance mode. Attenuate one channel at time. +Gain is raised up to 1. +

+
+
‘amplitude’
+

Similar as classic mode above but gain is raised up to 2. +

+
+
‘power’
+

Equal power distribution, from -6dB to +6dB range. +

+
+
+
+ + +

8.88.1 Examples

+ +
    +
  • Apply karaoke like effect: +
    +
    stereotools=mlev=0.015625
+
    + +
  • Convert M/S signal to L/R: +
    +
    "stereotools=mode=ms>lr"
+
    +
+ + +

8.89 stereowiden

+ +

This filter enhance the stereo effect by suppressing signal common to both +channels and by delaying the signal of left into right and vice versa, +thereby widening the stereo effect. +

+

The filter accepts the following options: +

+
+
delay
+

Time in milliseconds of the delay of left signal into right and vice versa. +Default is 20 milliseconds. +

+
+
feedback
+

Amount of gain in delayed signal into right and vice versa. Gives a delay +effect of left signal in right output and vice versa which gives widening +effect. Default is 0.3. +

+
+
crossfeed
+

Cross feed of left into right with inverted phase. This helps in suppressing +the mono. If the value is 1 it will cancel all the signal common to both +channels. Default is 0.3. +

+
+
drymix
+

Set level of input signal of original channel. Default is 0.8. +

+
+ + +

8.89.1 Commands

+ +

This filter supports the all above options except delay as commands. +

+ +

8.90 superequalizer

+

Apply 18 band equalizer. +

+

The filter accepts the following options: +

+
1b
+

Set 65Hz band gain. +

+
2b
+

Set 92Hz band gain. +

+
3b
+

Set 131Hz band gain. +

+
4b
+

Set 185Hz band gain. +

+
5b
+

Set 262Hz band gain. +

+
6b
+

Set 370Hz band gain. +

+
7b
+

Set 523Hz band gain. +

+
8b
+

Set 740Hz band gain. +

+
9b
+

Set 1047Hz band gain. +

+
10b
+

Set 1480Hz band gain. +

+
11b
+

Set 2093Hz band gain. +

+
12b
+

Set 2960Hz band gain. +

+
13b
+

Set 4186Hz band gain. +

+
14b
+

Set 5920Hz band gain. +

+
15b
+

Set 8372Hz band gain. +

+
16b
+

Set 11840Hz band gain. +

+
17b
+

Set 16744Hz band gain. +

+
18b
+

Set 20000Hz band gain. +

+
+ + +

8.91 surround

+

Apply audio surround upmix filter. +

+

This filter allows to produce multichannel output from audio stream. +

+

The filter accepts the following options: +

+
+
chl_out
+

Set output channel layout. By default, this is 5.1. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+
chl_in
+

Set input channel layout. By default, this is stereo. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+
level_in
+

Set input volume level. By default, this is 1. +

+
+
level_out
+

Set output volume level. By default, this is 1. +

+
+
lfe
+

Enable LFE channel output if output channel layout has it. By default, this is enabled. +

+
+
lfe_low
+

Set LFE low cut off frequency. By default, this is 128 Hz. +

+
+
lfe_high
+

Set LFE high cut off frequency. By default, this is 256 Hz. +

+
+
lfe_mode
+

Set LFE mode, can be add or sub. Default is add. +In add mode, LFE channel is created from input audio and added to output. +In sub mode, LFE channel is created from input audio and added to output but +also all non-LFE output channels are subtracted with output LFE channel. +

+
+
angle
+

Set angle of stereo surround transform, Allowed range is from 0 to 360. +Default is 90. +

+
+
fc_in
+

Set front center input volume. By default, this is 1. +

+
+
fc_out
+

Set front center output volume. By default, this is 1. +

+
+
fl_in
+

Set front left input volume. By default, this is 1. +

+
+
fl_out
+

Set front left output volume. By default, this is 1. +

+
+
fr_in
+

Set front right input volume. By default, this is 1. +

+
+
fr_out
+

Set front right output volume. By default, this is 1. +

+
+
sl_in
+

Set side left input volume. By default, this is 1. +

+
+
sl_out
+

Set side left output volume. By default, this is 1. +

+
+
sr_in
+

Set side right input volume. By default, this is 1. +

+
+
sr_out
+

Set side right output volume. By default, this is 1. +

+
+
bl_in
+

Set back left input volume. By default, this is 1. +

+
+
bl_out
+

Set back left output volume. By default, this is 1. +

+
+
br_in
+

Set back right input volume. By default, this is 1. +

+
+
br_out
+

Set back right output volume. By default, this is 1. +

+
+
bc_in
+

Set back center input volume. By default, this is 1. +

+
+
bc_out
+

Set back center output volume. By default, this is 1. +

+
+
lfe_in
+

Set LFE input volume. By default, this is 1. +

+
+
lfe_out
+

Set LFE output volume. By default, this is 1. +

+
+
allx
+

Set spread usage of stereo image across X axis for all channels. +

+
+
ally
+

Set spread usage of stereo image across Y axis for all channels. +

+
+
fcx, flx, frx, blx, brx, slx, srx, bcx
+

Set spread usage of stereo image across X axis for each channel. +

+
+
fcy, fly, fry, bly, bry, sly, sry, bcy
+

Set spread usage of stereo image across Y axis for each channel. +

+
+
win_size
+

Set window size. Allowed range is from 1024 to 65536. Default size is 4096. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann, hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+

Default is hann. +

+
+
overlap
+

Set window overlap. If set to 1, the recommended overlap for selected +window function will be picked. Default is 0.5. +

+
+ + +

8.92 treble, highshelf

+ +

Boost or cut treble (upper) frequencies of the audio using a two-pole +shelving filter with a response similar to that of a standard +hi-fi’s tone-controls. This is also known as shelving equalisation (EQ). +

+

The filter accepts the following options: +

+
+
gain, g
+

Give the gain at whichever is the lower of ~22 kHz and the +Nyquist frequency. Its useful range is about -20 (for a large cut) +to +20 (for a large boost). Beware of clipping when using a positive gain. +

+
+
frequency, f
+

Set the filter’s central frequency and so can be used +to extend or reduce the frequency range to be boosted or cut. +The default value is 3000 Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Determine how steep is the filter’s shelf transition. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

8.92.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change treble frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change treble width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change treble width. +Syntax for the command is : "width" +

+
+
gain, g
+

Change treble gain. +Syntax for the command is : "gain" +

+
+
mix, m
+

Change treble mix. +Syntax for the command is : "mix" +

+
+ + +

8.93 tremolo

+ +

Sinusoidal amplitude modulation. +

+

The filter accepts the following options: +

+
+
f
+

Modulation frequency in Hertz. Modulation frequencies in the subharmonic range +(20 Hz or lower) will result in a tremolo effect. +This filter may also be used as a ring modulator by specifying +a modulation frequency higher than 20 Hz. +Range is 0.1 - 20000.0. Default value is 5.0 Hz. +

+
+
d
+

Depth of modulation as a percentage. Range is 0.0 - 1.0. +Default value is 0.5. +

+
+ + +

8.94 vibrato

+ +

Sinusoidal phase modulation. +

+

The filter accepts the following options: +

+
+
f
+

Modulation frequency in Hertz. +Range is 0.1 - 20000.0. Default value is 5.0 Hz. +

+
+
d
+

Depth of modulation as a percentage. Range is 0.0 - 1.0. +Default value is 0.5. +

+
+ + +

8.95 volume

+ +

Adjust the input audio volume. +

+

It accepts the following parameters: +

+
volume
+

Set audio volume expression. +

+

Output values are clipped to the maximum value. +

+

The output audio volume is given by the relation: +

+
output_volume = volume * input_volume
+
+ +

The default value for volume is "1.0". +

+
+
precision
+

This parameter represents the mathematical precision. +

+

It determines which input sample formats will be allowed, which affects the +precision of the volume scaling. +

+
+
fixed
+

8-bit fixed-point; this limits input sample format to U8, S16, and S32. +

+
float
+

32-bit floating-point; this limits input sample format to FLT. (default) +

+
double
+

64-bit floating-point; this limits input sample format to DBL. +

+
+ +
+
replaygain
+

Choose the behaviour on encountering ReplayGain side data in input frames. +

+
+
drop
+

Remove ReplayGain side data, ignoring its contents (the default). +

+
+
ignore
+

Ignore ReplayGain side data, but leave it in the frame. +

+
+
track
+

Prefer the track gain, if present. +

+
+
album
+

Prefer the album gain, if present. +

+
+ +
+
replaygain_preamp
+

Pre-amplification gain in dB to apply to the selected replaygain gain. +

+

Default value for replaygain_preamp is 0.0. +

+
+
replaygain_noclip
+

Prevent clipping by limiting the gain applied. +

+

Default value for replaygain_noclip is 1. +

+
+
eval
+

Set when the volume expression is evaluated. +

+

It accepts the following values: +

+
‘once’
+

only evaluate expression once during the filter initialization, or +when the ‘volume’ command is sent +

+
+
‘frame’
+

evaluate expression for each incoming frame +

+
+ +

Default value is ‘once’. +

+
+ +

The volume expression can contain the following parameters. +

+
+
n
+

frame number (starting at zero) +

+
nb_channels
+

number of channels +

+
nb_consumed_samples
+

number of samples consumed by the filter +

+
nb_samples
+

number of samples in the current frame +

+
pos
+

original frame position in the file +

+
pts
+

frame PTS +

+
sample_rate
+

sample rate +

+
startpts
+

PTS at start of stream +

+
startt
+

time at start of stream +

+
t
+

frame time +

+
tb
+

timestamp timebase +

+
volume
+

last set volume value +

+
+ +

Note that when eval is set to ‘once’ only the +sample_rate and tb variables are available, all other +variables will evaluate to NAN. +

+ +

8.95.1 Commands

+ +

This filter supports the following commands: +

+
volume
+

Modify the volume expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

8.95.2 Examples

+ +
    +
  • Halve the input audio volume: +
    +
    volume=volume=0.5
+volume=volume=1/2
+volume=volume=-6.0206dB
+
    + +

    In all the above example the named key for volume can be +omitted, for example like in: +

    +
    volume=0.5
+
    + +
  • Increase input audio power by 6 decibels using fixed-point precision: +
    +
    volume=volume=6dB:precision=fixed
+
    + +
  • Fade volume after time 10 with an annihilation period of 5 seconds: +
    +
    volume='if(lt(t,10),1,max(1-(t-10)/5,0))':eval=frame
+
    +
+ + +

8.96 volumedetect

+ +

Detect the volume of the input video. +

+

The filter has no parameters. The input is not modified. Statistics about +the volume will be printed in the log when the input stream end is reached. +

+

In particular it will show the mean volume (root mean square), maximum +volume (on a per-sample basis), and the beginning of a histogram of the +registered volume values (from the maximum value to a cumulated 1/1000 of +the samples). +

+

All volumes are in decibels relative to the maximum PCM value. +

+ +

8.96.1 Examples

+ +

Here is an excerpt of the output: +

+
[Parsed_volumedetect_0  0xa23120] mean_volume: -27 dB
+[Parsed_volumedetect_0  0xa23120] max_volume: -4 dB
+[Parsed_volumedetect_0  0xa23120] histogram_4db: 6
+[Parsed_volumedetect_0  0xa23120] histogram_5db: 62
+[Parsed_volumedetect_0  0xa23120] histogram_6db: 286
+[Parsed_volumedetect_0  0xa23120] histogram_7db: 1042
+[Parsed_volumedetect_0  0xa23120] histogram_8db: 2551
+[Parsed_volumedetect_0  0xa23120] histogram_9db: 4609
+[Parsed_volumedetect_0  0xa23120] histogram_10db: 8409
+
+ +

It means that: +

    +
  • The mean square energy is approximately -27 dB, or 10^-2.7. +
  • The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB. +
  • There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc. +
+ +

In other words, raising the volume by +4 dB does not cause any clipping, +raising it by +5 dB causes clipping for 6 samples, etc. +

+ + +

9 Audio Sources

+ +

Below is a description of the currently available audio sources. +

+ +

9.1 abuffer

+ +

Buffer audio frames, and make them available to the filter chain. +

+

This source is mainly intended for a programmatic use, in particular +through the interface defined in libavfilter/asrc_abuffer.h. +

+

It accepts the following parameters: +

+
time_base
+

The timebase which will be used for timestamps of submitted frames. It must be +either a floating-point number or in numerator/denominator form. +

+
+
sample_rate
+

The sample rate of the incoming audio buffers. +

+
+
sample_fmt
+

The sample format of the incoming audio buffers. +Either a sample format name or its corresponding integer representation from +the enum AVSampleFormat in libavutil/samplefmt.h +

+
+
channel_layout
+

The channel layout of the incoming audio buffers. +Either a channel layout name from channel_layout_map in +libavutil/channel_layout.c or its corresponding integer representation +from the AV_CH_LAYOUT_* macros in libavutil/channel_layout.h +

+
+
channels
+

The number of channels of the incoming audio buffers. +If both channels and channel_layout are specified, then they +must be consistent. +

+
+
+ + +

9.1.1 Examples

+ +
+
abuffer=sample_rate=44100:sample_fmt=s16p:channel_layout=stereo
+
+ +

will instruct the source to accept planar 16bit signed stereo at 44100Hz. +Since the sample format with name "s16p" corresponds to the number +6 and the "stereo" channel layout corresponds to the value 0x3, this is +equivalent to: +

+
abuffer=sample_rate=44100:sample_fmt=6:channel_layout=0x3
+
+ + +

9.2 aevalsrc

+ +

Generate an audio signal specified by an expression. +

+

This source accepts in input one or more expressions (one for each +channel), which are evaluated and used to generate a corresponding +audio signal. +

+

This source accepts the following options: +

+
+
exprs
+

Set the ’|’-separated expressions list for each separate channel. In case the +channel_layout option is not specified, the selected channel layout +depends on the number of provided expressions. Otherwise the last +specified expression is applied to the remaining output channels. +

+
+
channel_layout, c
+

Set the channel layout. The number of channels in the specified layout +must be equal to the number of specified expressions. +

+
+
duration, d
+

Set the minimum duration of the sourced audio. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +Note that the resulting duration may be greater than the specified +duration, as the generated audio is always cut at the end of a +complete frame. +

+

If not specified, or the expressed duration is negative, the audio is +supposed to be generated forever. +

+
+
nb_samples, n
+

Set the number of samples per channel per each output frame, +default to 1024. +

+
+
sample_rate, s
+

Specify the sample rate, default to 44100. +

+
+ +

Each expression in exprs can contain the following constants: +

+
+
n
+

number of the evaluated sample, starting from 0 +

+
+
t
+

time of the evaluated sample expressed in seconds, starting from 0 +

+
+
s
+

sample rate +

+
+
+ + +

9.2.1 Examples

+ +
    +
  • Generate silence: +
    +
    aevalsrc=0
+
    + +
  • Generate a sin signal with frequency of 440 Hz, set sample rate to +8000 Hz: +
    +
    aevalsrc="sin(440*2*PI*t):s=8000"
+
    + +
  • Generate a two channels signal, specify the channel layout (Front +Center + Back Center) explicitly: +
    +
    aevalsrc="sin(420*2*PI*t)|cos(430*2*PI*t):c=FC|BC"
+
    + +
  • Generate white noise: +
    +
    aevalsrc="-2+random(0)"
+
    + +
  • Generate an amplitude modulated signal: +
    +
    aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
+
    + +
  • Generate 2.5 Hz binaural beats on a 360 Hz carrier: +
    +
    aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) | 0.1*sin(2*PI*(360+2.5/2)*t)"
+
    + +
+ + +

9.3 afirsrc

+ +

Generate a FIR coefficients using frequency sampling method. +

+

The resulting stream can be used with afir filter for filtering the audio signal. +

+

The filter accepts the following options: +

+
+
taps, t
+

Set number of filter coefficents in output audio stream. +Default value is 1025. +

+
+
frequency, f
+

Set frequency points from where magnitude and phase are set. +This must be in non decreasing order, and first element must be 0, while last element +must be 1. Elements are separated by white spaces. +

+
+
magnitude, m
+

Set magnitude value for every frequency point set by frequency. +Number of values must be same as number of frequency points. +Values are separated by white spaces. +

+
+
phase, p
+

Set phase value for every frequency point set by frequency. +Number of values must be same as number of frequency points. +Values are separated by white spaces. +

+
+
sample_rate, r
+

Set sample rate, default is 44100. +

+
+
nb_samples, n
+

Set number of samples per each frame. Default is 1024. +

+
+
win_func, w
+

Set window function. Default is blackman. +

+
+ + +

9.4 anullsrc

+ +

The null audio source, return unprocessed audio frames. It is mainly useful +as a template and to be employed in analysis / debugging tools, or as +the source for filters which ignore the input data (for example the sox +synth filter). +

+

This source accepts the following options: +

+
+
channel_layout, cl
+
+

Specifies the channel layout, and can be either an integer or a string +representing a channel layout. The default value of channel_layout +is "stereo". +

+

Check the channel_layout_map definition in +libavutil/channel_layout.c for the mapping between strings and +channel layout values. +

+
+
sample_rate, r
+

Specifies the sample rate, and defaults to 44100. +

+
+
nb_samples, n
+

Set the number of samples per requested frames. +

+
+
+ + +

9.4.1 Examples

+ +
    +
  • Set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO. +
    +
    anullsrc=r=48000:cl=4
+
    + +
  • Do the same operation with a more obvious syntax: +
    +
    anullsrc=r=48000:cl=mono
+
    +
+ +

All the parameters need to be explicitly defined. +

+ +

9.5 flite

+ +

Synthesize a voice utterance using the libflite library. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libflite. +

+

Note that versions of the flite library prior to 2.0 are not thread-safe. +

+

The filter accepts the following options: +

+
+
list_voices
+

If set to 1, list the names of the available voices and exit +immediately. Default value is 0. +

+
+
nb_samples, n
+

Set the maximum number of samples per frame. Default value is 512. +

+
+
textfile
+

Set the filename containing the text to speak. +

+
+
text
+

Set the text to speak. +

+
+
voice, v
+

Set the voice to use for the speech synthesis. Default value is +kal. See also the list_voices option. +

+
+ + +

9.5.1 Examples

+ +
    +
  • Read from file speech.txt, and synthesize the text using the +standard flite voice: +
    +
    flite=textfile=speech.txt
+
    + +
  • Read the specified text selecting the slt voice: +
    +
    flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
+
    + +
  • Input text to ffmpeg: +
    +
    ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
+
    + +
  • Make ffplay speak the specified text, using flite and +the lavfi device: +
    +
    ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
+
    +
+ +

For more information about libflite, check: +http://www.festvox.org/flite/ +

+ +

9.6 anoisesrc

+ +

Generate a noise audio signal. +

+

The filter accepts the following options: +

+
+
sample_rate, r
+

Specify the sample rate. Default value is 48000 Hz. +

+
+
amplitude, a
+

Specify the amplitude (0.0 - 1.0) of the generated audio stream. Default value +is 1.0. +

+
+
duration, d
+

Specify the duration of the generated audio stream. Not specifying this option +results in noise with an infinite length. +

+
+
color, colour, c
+

Specify the color of noise. Available noise colors are white, pink, brown, +blue, violet and velvet. Default color is white. +

+
+
seed, s
+

Specify a value used to seed the PRNG. +

+
+
nb_samples, n
+

Set the number of samples per each output frame, default is 1024. +

+
+ + +

9.6.1 Examples

+ +
    +
  • Generate 60 seconds of pink noise, with a 44.1 kHz sampling rate and an amplitude of 0.5: +
    +
    anoisesrc=d=60:c=pink:r=44100:a=0.5
+
    +
+ + +

9.7 hilbert

+ +

Generate odd-tap Hilbert transform FIR coefficients. +

+

The resulting stream can be used with afir filter for phase-shifting +the signal by 90 degrees. +

+

This is used in many matrix coding schemes and for analytic signal generation. +The process is often written as a multiplication by i (or j), the imaginary unit. +

+

The filter accepts the following options: +

+
+
sample_rate, s
+

Set sample rate, default is 44100. +

+
+
taps, t
+

Set length of FIR filter, default is 22051. +

+
+
nb_samples, n
+

Set number of samples per each frame. +

+
+
win_func, w
+

Set window function to be used when generating FIR coefficients. +

+
+ + +

9.8 sinc

+ +

Generate a sinc kaiser-windowed low-pass, high-pass, band-pass, or band-reject FIR coefficients. +

+

The resulting stream can be used with afir filter for filtering the audio signal. +

+

The filter accepts the following options: +

+
+
sample_rate, r
+

Set sample rate, default is 44100. +

+
+
nb_samples, n
+

Set number of samples per each frame. Default is 1024. +

+
+
hp
+

Set high-pass frequency. Default is 0. +

+
+
lp
+

Set low-pass frequency. Default is 0. +If high-pass frequency is lower than low-pass frequency and low-pass frequency +is higher than 0 then filter will create band-pass filter coefficients, +otherwise band-reject filter coefficients. +

+
+
phase
+

Set filter phase response. Default is 50. Allowed range is from 0 to 100. +

+
+
beta
+

Set Kaiser window beta. +

+
+
att
+

Set stop-band attenuation. Default is 120dB, allowed range is from 40 to 180 dB. +

+
+
round
+

Enable rounding, by default is disabled. +

+
+
hptaps
+

Set number of taps for high-pass filter. +

+
+
lptaps
+

Set number of taps for low-pass filter. +

+
+ + +

9.9 sine

+ +

Generate an audio signal made of a sine wave with amplitude 1/8. +

+

The audio signal is bit-exact. +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the carrier frequency. Default is 440 Hz. +

+
+
beep_factor, b
+

Enable a periodic beep every second with frequency beep_factor times +the carrier frequency. Default is 0, meaning the beep is disabled. +

+
+
sample_rate, r
+

Specify the sample rate, default is 44100. +

+
+
duration, d
+

Specify the duration of the generated audio stream. +

+
+
samples_per_frame
+

Set the number of samples per output frame. +

+

The expression can contain the following constants: +

+
+
n
+

The (sequential) number of the output audio frame, starting from 0. +

+
+
pts
+

The PTS (Presentation TimeStamp) of the output audio frame, +expressed in TB units. +

+
+
t
+

The PTS of the output audio frame, expressed in seconds. +

+
+
TB
+

The timebase of the output audio frames. +

+
+ +

Default is 1024. +

+
+ + +

9.9.1 Examples

+ +
    +
  • Generate a simple 440 Hz sine wave: +
    +
    sine
+
    + +
  • Generate a 220 Hz sine wave with a 880 Hz beep each second, for 5 seconds: +
    +
    sine=220:4:d=5
+sine=f=220:b=4:d=5
+sine=frequency=220:beep_factor=4:duration=5
+
    + +
  • Generate a 1 kHz sine wave following 1602,1601,1602,1601,1602 NTSC +pattern: +
    +
    sine=1000:samples_per_frame='st(0,mod(n,5)); 1602-not(not(eq(ld(0),1)+eq(ld(0),3)))'
+
    +
+ + + +

10 Audio Sinks

+ +

Below is a description of the currently available audio sinks. +

+ +

10.1 abuffersink

+ +

Buffer audio frames, and make them available to the end of filter chain. +

+

This sink is mainly intended for programmatic use, in particular +through the interface defined in libavfilter/buffersink.h +or the options system. +

+

It accepts a pointer to an AVABufferSinkContext structure, which +defines the incoming buffers’ formats, to be passed as the opaque +parameter to avfilter_init_filter for initialization. +

+

10.2 anullsink

+ +

Null audio sink; do absolutely nothing with the input audio. It is +mainly useful as a template and for use in analysis / debugging +tools. +

+ + +

11 Video Filters

+ +

When you configure your FFmpeg build, you can disable any of the +existing filters using --disable-filters. +The configure output will show the video filters included in your +build. +

+

Below is a description of the currently available video filters. +

+ +

11.1 addroi

+ +

Mark a region of interest in a video frame. +

+

The frame data is passed through unchanged, but metadata is attached +to the frame indicating regions of interest which can affect the +behaviour of later encoding. Multiple regions can be marked by +applying the filter multiple times. +

+
+
x
+

Region distance in pixels from the left edge of the frame. +

+
y
+

Region distance in pixels from the top edge of the frame. +

+
w
+

Region width in pixels. +

+
h
+

Region height in pixels. +

+

The parameters x, y, w and h are expressions, +and may contain the following variables: +

+
iw
+

Width of the input frame. +

+
ih
+

Height of the input frame. +

+
+ +
+
qoffset
+

Quantisation offset to apply within the region. +

+

This must be a real value in the range -1 to +1. A value of zero +indicates no quality change. A negative value asks for better quality +(less quantisation), while a positive value asks for worse quality +(greater quantisation). +

+

The range is calibrated so that the extreme values indicate the +largest possible offset - if the rest of the frame is encoded with the +worst possible quality, an offset of -1 indicates that this region +should be encoded with the best possible quality anyway. Intermediate +values are then interpolated in some codec-dependent way. +

+

For example, in 10-bit H.264 the quantisation parameter varies between +-12 and 51. A typical qoffset value of -1/10 therefore indicates that +this region should be encoded with a QP around one-tenth of the full +range better than the rest of the frame. So, if most of the frame +were to be encoded with a QP of around 30, this region would get a QP +of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3). +An extreme value of -1 would indicate that this region should be +encoded with the best possible quality regardless of the treatment of +the rest of the frame - that is, should be encoded at a QP of -12. +

+
clear
+

If set to true, remove any existing regions of interest marked on the +frame before adding the new one. +

+
+ + +

11.1.1 Examples

+ +
    +
  • Mark the centre quarter of the frame as interesting. +
    +
    addroi=iw/4:ih/4:iw/2:ih/2:-1/10
+
    +
  • Mark the 100-pixel-wide region on the left edge of the frame as very +uninteresting (to be encoded at much lower quality than the rest of +the frame). +
    +
    addroi=0:0:100:ih:+1/5
+
    +
+ + +

11.2 alphaextract

+ +

Extract the alpha component from the input as a grayscale video. This +is especially useful with the alphamerge filter. +

+ +

11.3 alphamerge

+ +

Add or replace the alpha component of the primary input with the +grayscale value of a second input. This is intended for use with +alphaextract to allow the transmission or storage of frame +sequences that have alpha in a format that doesn’t support an alpha +channel. +

+

For example, to reconstruct full frames from a normal YUV-encoded video +and a separate video created with alphaextract, you might use: +

+
movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
+
+ +

Since this filter is designed for reconstruction, it operates on frame +sequences without considering timestamps, and terminates when either +input reaches end of stream. This will cause problems if your encoding +pipeline drops frames. If you’re trying to apply an image as an +overlay to a video stream, consider the overlay filter instead. +

+ +

11.4 amplify

+ +

Amplify differences between current pixel and pixels of adjacent frames in +same pixel location. +

+

This filter accepts the following options: +

+
+
radius
+

Set frame radius. Default is 2. Allowed range is from 1 to 63. +For example radius of 3 will instruct filter to calculate average of 7 frames. +

+
+
factor
+

Set factor to amplify difference. Default is 2. Allowed range is from 0 to 65535. +

+
+
threshold
+

Set threshold for difference amplification. Any difference greater or equal to +this value will not alter source pixel. Default is 10. +Allowed range is from 0 to 65535. +

+
+
tolerance
+

Set tolerance for difference amplification. Any difference lower to +this value will not alter source pixel. Default is 0. +Allowed range is from 0 to 65535. +

+
+
low
+

Set lower limit for changing source pixel. Default is 65535. Allowed range is from 0 to 65535. +This option controls maximum possible value that will decrease source pixel value. +

+
+
high
+

Set high limit for changing source pixel. Default is 65535. Allowed range is from 0 to 65535. +This option controls maximum possible value that will increase source pixel value. +

+
+
planes
+

Set which planes to filter. Default is all. Allowed range is from 0 to 15. +

+
+ + +

11.4.1 Commands

+ +

This filter supports the following commands that corresponds to option of same name: +

+
factor
+
threshold
+
tolerance
+
low
+
high
+
planes
+
+ + +

11.5 ass

+ +

Same as the subtitles filter, except that it doesn’t require libavcodec +and libavformat to work. On the other hand, it is limited to ASS (Advanced +Substation Alpha) subtitles files. +

+

This filter accepts the following option in addition to the common options from +the subtitles filter: +

+
+
shaping
+

Set the shaping engine +

+

Available values are: +

+
‘auto’
+

The default libass shaping engine, which is the best available. +

+
‘simple’
+

Fast, font-agnostic shaper that can do only substitutions +

+
‘complex’
+

Slower shaper using OpenType for substitutions and positioning +

+
+ +

The default is auto. +

+
+ + +

11.6 atadenoise

+

Apply an Adaptive Temporal Averaging Denoiser to the video input. +

+

The filter accepts the following options: +

+
+
0a
+

Set threshold A for 1st plane. Default is 0.02. +Valid range is 0 to 0.3. +

+
+
0b
+

Set threshold B for 1st plane. Default is 0.04. +Valid range is 0 to 5. +

+
+
1a
+

Set threshold A for 2nd plane. Default is 0.02. +Valid range is 0 to 0.3. +

+
+
1b
+

Set threshold B for 2nd plane. Default is 0.04. +Valid range is 0 to 5. +

+
+
2a
+

Set threshold A for 3rd plane. Default is 0.02. +Valid range is 0 to 0.3. +

+
+
2b
+

Set threshold B for 3rd plane. Default is 0.04. +Valid range is 0 to 5. +

+

Threshold A is designed to react on abrupt changes in the input signal and +threshold B is designed to react on continuous changes in the input signal. +

+
+
s
+

Set number of frames filter will use for averaging. Default is 9. Must be odd +number in range [5, 129]. +

+
+
p
+

Set what planes of frame filter will use for averaging. Default is all. +

+
+
a
+

Set what variant of algorithm filter will use for averaging. Default is p parallel. +Alternatively can be set to s serial. +

+

Parallel can be faster then serial, while other way around is never true. +Parallel will abort early on first change being greater then thresholds, while serial +will continue processing other side of frames if they are equal or bellow thresholds. +

+
+ + +

11.6.1 Commands

+

This filter supports same commands as options except option s. +The command accepts the same syntax of the corresponding option. +

+ +

11.7 avgblur

+ +

Apply average blur filter. +

+

The filter accepts the following options: +

+
+
sizeX
+

Set horizontal radius size. +

+
+
planes
+

Set which planes to filter. By default all planes are filtered. +

+
+
sizeY
+

Set vertical radius size, if zero it will be same as sizeX. +Default is 0. +

+
+ + +

11.7.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.8 bbox

+ +

Compute the bounding box for the non-black pixels in the input frame +luminance plane. +

+

This filter computes the bounding box containing all the pixels with a +luminance value greater than the minimum allowed value. +The parameters describing the bounding box are printed on the filter +log. +

+

The filter accepts the following option: +

+
+
min_val
+

Set the minimal luminance value. Default is 16. +

+
+ + +

11.9 bilateral

+

Apply bilateral filter, spatial smoothing while preserving edges. +

+

The filter accepts the following options: +

+
sigmaS
+

Set sigma of gaussian function to calculate spatial weight. +Allowed range is 0 to 10. Default is 0.1. +

+
+
sigmaR
+

Set sigma of gaussian function to calculate range weight. +Allowed range is 0 to 1. Default is 0.1. +

+
+
planes
+

Set planes to filter. Default is first only. +

+
+ + +

11.10 bitplanenoise

+ +

Show and measure bit plane noise. +

+

The filter accepts the following options: +

+
+
bitplane
+

Set which plane to analyze. Default is 1. +

+
+
filter
+

Filter out noisy pixels from bitplane set above. +Default is disabled. +

+
+ + +

11.11 blackdetect

+ +

Detect video intervals that are (almost) completely black. Can be +useful to detect chapter transitions, commercials, or invalid +recordings. +

+

The filter outputs its detection analysis to both the log as well as +frame metadata. If a black segment of at least the specified minimum +duration is found, a line with the start and end timestamps as well +as duration is printed to the log with level info. In addition, +a log line with level debug is printed per frame showing the +black amount detected for that frame. +

+

The filter also attaches metadata to the first frame of a black +segment with key lavfi.black_start and to the first frame +after the black segment ends with key lavfi.black_end. The +value is the frame’s timestamp. This metadata is added regardless +of the minimum duration specified. +

+

The filter accepts the following options: +

+
+
black_min_duration, d
+

Set the minimum detected black duration expressed in seconds. It must +be a non-negative floating point number. +

+

Default value is 2.0. +

+
+
picture_black_ratio_th, pic_th
+

Set the threshold for considering a picture "black". +Express the minimum value for the ratio: +

+
nb_black_pixels / nb_pixels
+
+ +

for which a picture is considered black. +Default value is 0.98. +

+
+
pixel_black_th, pix_th
+

Set the threshold for considering a pixel "black". +

+

The threshold expresses the maximum pixel luminance value for which a +pixel is considered "black". The provided value is scaled according to +the following equation: +

+
absolute_threshold = luminance_minimum_value + pixel_black_th * luminance_range_size
+
+ +

luminance_range_size and luminance_minimum_value depend on +the input video format, the range is [0-255] for YUV full-range +formats and [16-235] for YUV non full-range formats. +

+

Default value is 0.10. +

+
+ +

The following example sets the maximum pixel threshold to the minimum +value, and detects only black intervals of 2 or more seconds: +

+
blackdetect=d=2:pix_th=0.00
+
+ + +

11.12 blackframe

+ +

Detect frames that are (almost) completely black. Can be useful to +detect chapter transitions or commercials. Output lines consist of +the frame number of the detected frame, the percentage of blackness, +the position in the file if known or -1 and the timestamp in seconds. +

+

In order to display the output lines, you need to set the loglevel at +least to the AV_LOG_INFO value. +

+

This filter exports frame metadata lavfi.blackframe.pblack. +The value represents the percentage of pixels in the picture that +are below the threshold value. +

+

It accepts the following parameters: +

+
+
amount
+

The percentage of the pixels that have to be below the threshold; it defaults to +98. +

+
+
threshold, thresh
+

The threshold below which a pixel value is considered black; it defaults to +32. +

+
+
+ + +

11.13 blend

+ +

Blend two video frames into each other. +

+

The blend filter takes two input streams and outputs one +stream, the first input is the "top" layer and second input is +"bottom" layer. By default, the output terminates when the longest input terminates. +

+

The tblend (time blend) filter takes two consecutive frames +from one single stream, and outputs the result obtained by blending +the new frame on top of the old frame. +

+

A description of the accepted options follows. +

+
+
c0_mode
+
c1_mode
+
c2_mode
+
c3_mode
+
all_mode
+

Set blend mode for specific pixel component or all pixel components in case +of all_mode. Default value is normal. +

+

Available values for component modes are: +

+
‘addition’
+
‘grainmerge’
+
‘and’
+
‘average’
+
‘burn’
+
‘darken’
+
‘difference’
+
‘grainextract’
+
‘divide’
+
‘dodge’
+
‘freeze’
+
‘exclusion’
+
‘extremity’
+
‘glow’
+
‘hardlight’
+
‘hardmix’
+
‘heat’
+
‘lighten’
+
‘linearlight’
+
‘multiply’
+
‘multiply128’
+
‘negation’
+
‘normal’
+
‘or’
+
‘overlay’
+
‘phoenix’
+
‘pinlight’
+
‘reflect’
+
‘screen’
+
‘softlight’
+
‘subtract’
+
‘vividlight’
+
‘xor’
+
+ +
+
c0_opacity
+
c1_opacity
+
c2_opacity
+
c3_opacity
+
all_opacity
+

Set blend opacity for specific pixel component or all pixel components in case +of all_opacity. Only used in combination with pixel component blend modes. +

+
+
c0_expr
+
c1_expr
+
c2_expr
+
c3_expr
+
all_expr
+

Set blend expression for specific pixel component or all pixel components in case +of all_expr. Note that related mode options will be ignored if those are set. +

+

The expressions can use the following variables: +

+
+
N
+

The sequential number of the filtered frame, starting from 0. +

+
+
X
+
Y
+

the coordinates of the current sample +

+
+
W
+
H
+

the width and height of currently filtered plane +

+
+
SW
+
SH
+

Width and height scale for the plane being filtered. It is the +ratio between the dimensions of the current plane to the luma plane, +e.g. for a yuv420p frame, the values are 1,1 for +the luma plane and 0.5,0.5 for the chroma planes. +

+
+
T
+

Time of the current frame, expressed in seconds. +

+
+
TOP, A
+

Value of pixel component at current location for first video frame (top layer). +

+
+
BOTTOM, B
+

Value of pixel component at current location for second video frame (bottom layer). +

+
+
+
+ +

The blend filter also supports the framesync options. +

+ +

11.13.1 Examples

+ +
    +
  • Apply transition from bottom layer to top layer in first 10 seconds: +
    +
    blend=all_expr='A*(if(gte(T,10),1,T/10))+B*(1-(if(gte(T,10),1,T/10)))'
+
    + +
  • Apply linear horizontal transition from top layer to bottom layer: +
    +
    blend=all_expr='A*(X/W)+B*(1-X/W)'
+
    + +
  • Apply 1x1 checkerboard effect: +
    +
    blend=all_expr='if(eq(mod(X,2),mod(Y,2)),A,B)'
+
    + +
  • Apply uncover left effect: +
    +
    blend=all_expr='if(gte(N*SW+X,W),A,B)'
+
    + +
  • Apply uncover down effect: +
    +
    blend=all_expr='if(gte(Y-N*SH,0),A,B)'
+
    + +
  • Apply uncover up-left effect: +
    +
    blend=all_expr='if(gte(T*SH*40+Y,H)*gte((T*40*SW+X)*W/H,W),A,B)'
+
    + +
  • Split diagonally video and shows top and bottom layer on each side: +
    +
    blend=all_expr='if(gt(X,Y*(W/H)),A,B)'
+
    + +
  • Display differences between the current and the previous frame: +
    +
    tblend=all_mode=grainextract
+
    +
+ + +

11.14 bm3d

+ +

Denoise frames using Block-Matching 3D algorithm. +

+

The filter accepts the following options. +

+
+
sigma
+

Set denoising strength. Default value is 1. +Allowed range is from 0 to 999.9. +The denoising algorithm is very sensitive to sigma, so adjust it +according to the source. +

+
+
block
+

Set local patch size. This sets dimensions in 2D. +

+
+
bstep
+

Set sliding step for processing blocks. Default value is 4. +Allowed range is from 1 to 64. +Smaller values allows processing more reference blocks and is slower. +

+
+
group
+

Set maximal number of similar blocks for 3rd dimension. Default value is 1. +When set to 1, no block matching is done. Larger values allows more blocks +in single group. +Allowed range is from 1 to 256. +

+
+
range
+

Set radius for search block matching. Default is 9. +Allowed range is from 1 to INT32_MAX. +

+
+
mstep
+

Set step between two search locations for block matching. Default is 1. +Allowed range is from 1 to 64. Smaller is slower. +

+
+
thmse
+

Set threshold of mean square error for block matching. Valid range is 0 to +INT32_MAX. +

+
+
hdthr
+

Set thresholding parameter for hard thresholding in 3D transformed domain. +Larger values results in stronger hard-thresholding filtering in frequency +domain. +

+
+
estim
+

Set filtering estimation mode. Can be basic or final. +Default is basic. +

+
+
ref
+

If enabled, filter will use 2nd stream for block matching. +Default is disabled for basic value of estim option, +and always enabled if value of estim is final. +

+
+
planes
+

Set planes to filter. Default is all available except alpha. +

+
+ + +

11.14.1 Examples

+ +
    +
  • Basic filtering with bm3d: +
    +
    bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic
+
    + +
  • Same as above, but filtering only luma: +
    +
    bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic:planes=1
+
    + +
  • Same as above, but with both estimation modes: +
    +
    split[a][b],[a]bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic[a],[b][a]bm3d=sigma=3:block=4:bstep=2:group=16:estim=final:ref=1
+
    + +
  • Same as above, but prefilter with nlmeans filter instead: +
    +
    split[a][b],[a]nlmeans=s=3:r=7:p=3[a],[b][a]bm3d=sigma=3:block=4:bstep=2:group=16:estim=final:ref=1
+
    +
+ + +

11.15 boxblur

+ +

Apply a boxblur algorithm to the input video. +

+

It accepts the following parameters: +

+
+
luma_radius, lr
+
luma_power, lp
+
chroma_radius, cr
+
chroma_power, cp
+
alpha_radius, ar
+
alpha_power, ap
+
+ +

A description of the accepted options follows. +

+
+
luma_radius, lr
+
chroma_radius, cr
+
alpha_radius, ar
+

Set an expression for the box radius in pixels used for blurring the +corresponding input plane. +

+

The radius value must be a non-negative number, and must not be +greater than the value of the expression min(w,h)/2 for the +luma and alpha planes, and of min(cw,ch)/2 for the chroma +planes. +

+

Default value for luma_radius is "2". If not specified, +chroma_radius and alpha_radius default to the +corresponding value set for luma_radius. +

+

The expressions can contain the following constants: +

+
w
+
h
+

The input width and height in pixels. +

+
+
cw
+
ch
+

The input chroma image width and height in pixels. +

+
+
hsub
+
vsub
+

The horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p", hsub is 2 and vsub is 1. +

+
+ +
+
luma_power, lp
+
chroma_power, cp
+
alpha_power, ap
+

Specify how many times the boxblur filter is applied to the +corresponding plane. +

+

Default value for luma_power is 2. If not specified, +chroma_power and alpha_power default to the +corresponding value set for luma_power. +

+

A value of 0 will disable the effect. +

+
+ + +

11.15.1 Examples

+ +
    +
  • Apply a boxblur filter with the luma, chroma, and alpha radii +set to 2: +
    +
    boxblur=luma_radius=2:luma_power=1
+boxblur=2:1
+
    + +
  • Set the luma radius to 2, and alpha and chroma radius to 0: +
    +
    boxblur=2:1:cr=0:ar=0
+
    + +
  • Set the luma and chroma radii to a fraction of the video dimension: +
    +
    boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
+
    +
+ + +

11.16 bwdif

+ +

Deinterlace the input video ("bwdif" stands for "Bob Weaver +Deinterlacing Filter"). +

+

Motion adaptive deinterlacing based on yadif with the use of w3fdif and cubic +interpolation algorithms. +It accepts the following parameters: +

+
+
mode
+

The interlacing mode to adopt. It accepts one of the following values: +

+
+
0, send_frame
+

Output one frame for each frame. +

+
1, send_field
+

Output one frame for each field. +

+
+ +

The default value is send_field. +

+
+
parity
+

The picture field parity assumed for the input interlaced video. It accepts one +of the following values: +

+
+
0, tff
+

Assume the top field is first. +

+
1, bff
+

Assume the bottom field is first. +

+
-1, auto
+

Enable automatic detection of field parity. +

+
+ +

The default value is auto. +If the interlacing is unknown or the decoder does not export this information, +top field first will be assumed. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following +values: +

+
+
0, all
+

Deinterlace all frames. +

+
1, interlaced
+

Only deinterlace frames marked as interlaced. +

+
+ +

The default value is all. +

+
+ + +

11.17 cas

+ +

Apply Contrast Adaptive Sharpen filter to video stream. +

+

The filter accepts the following options: +

+
+
strength
+

Set the sharpening strength. Default value is 0. +

+
+
planes
+

Set planes to filter. Default value is to filter all +planes except alpha plane. +

+
+ + +

11.18 chromahold

+

Remove all color information for all colors except for certain one. +

+

The filter accepts the following options: +

+
+
color
+

The color which will not be replaced with neutral chroma. +

+
+
similarity
+

Similarity percentage with the above color. +0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +0.0 makes pixels either fully gray, or not gray at all. +Higher values result in more preserved color. +

+
+
yuv
+

Signals that the color passed is already in YUV instead of RGB. +

+

Literal colors like "green" or "red" don’t make sense with this enabled anymore. +This can be used to pass exact YUV values as hexadecimal numbers. +

+
+ + +

11.18.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.19 chromakey

+

YUV colorspace color/chroma keying. +

+

The filter accepts the following options: +

+
+
color
+

The color which will be replaced with transparency. +

+
+
similarity
+

Similarity percentage with the key color. +

+

0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +

+

0.0 makes pixels either fully transparent, or not transparent at all. +

+

Higher values result in semi-transparent pixels, with a higher transparency +the more similar the pixels color is to the key color. +

+
+
yuv
+

Signals that the color passed is already in YUV instead of RGB. +

+

Literal colors like "green" or "red" don’t make sense with this enabled anymore. +This can be used to pass exact YUV values as hexadecimal numbers. +

+
+ + +

11.19.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.19.2 Examples

+ +
    +
  • Make every green pixel in the input image transparent: +
    +
    ffmpeg -i input.png -vf chromakey=green out.png
+
    + +
  • Overlay a greenscreen-video on top of a static black background. +
    +
    ffmpeg -f lavfi -i color=c=black:s=1280x720 -i video.mp4 -shortest -filter_complex "[1:v]chromakey=0x70de77:0.1:0.2[ckout];[0:v][ckout]overlay[out]" -map "[out]" output.mkv
+
    +
+ + +

11.20 chromashift

+

Shift chroma pixels horizontally and/or vertically. +

+

The filter accepts the following options: +

+
cbh
+

Set amount to shift chroma-blue horizontally. +

+
cbv
+

Set amount to shift chroma-blue vertically. +

+
crh
+

Set amount to shift chroma-red horizontally. +

+
crv
+

Set amount to shift chroma-red vertically. +

+
edge
+

Set edge mode, can be smear, default, or warp. +

+
+ + +

11.20.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

11.21 ciescope

+ +

Display CIE color diagram with pixels overlaid onto it. +

+

The filter accepts the following options: +

+
+
system
+

Set color system. +

+
+
‘ntsc, 470m’
+
‘ebu, 470bg’
+
‘smpte’
+
‘240m’
+
‘apple’
+
‘widergb’
+
‘cie1931’
+
‘rec709, hdtv’
+
‘uhdtv, rec2020’
+
‘dcip3’
+
+ +
+
cie
+

Set CIE system. +

+
+
‘xyy’
+
‘ucs’
+
‘luv’
+
+ +
+
gamuts
+

Set what gamuts to draw. +

+

See system option for available values. +

+
+
size, s
+

Set ciescope size, by default set to 512. +

+
+
intensity, i
+

Set intensity used to map input pixel values to CIE diagram. +

+
+
contrast
+

Set contrast used to draw tongue colors that are out of active color system gamut. +

+
+
corrgamma
+

Correct gamma displayed on scope, by default enabled. +

+
+
showwhite
+

Show white point on CIE diagram, by default disabled. +

+
+
gamma
+

Set input gamma. Used only with XYZ input color space. +

+
+ + +

11.22 codecview

+ +

Visualize information exported by some codecs. +

+

Some codecs can export information through frames using side-data or other +means. For example, some MPEG based codecs export motion vectors through the +export_mvs flag in the codec flags2 option. +

+

The filter accepts the following option: +

+
+
mv
+

Set motion vectors to visualize. +

+

Available flags for mv are: +

+
+
‘pf’
+

forward predicted MVs of P-frames +

+
‘bf’
+

forward predicted MVs of B-frames +

+
‘bb’
+

backward predicted MVs of B-frames +

+
+ +
+
qp
+

Display quantization parameters using the chroma planes. +

+
+
mv_type, mvt
+

Set motion vectors type to visualize. Includes MVs from all frames unless specified by frame_type option. +

+

Available flags for mv_type are: +

+
+
‘fp’
+

forward predicted MVs +

+
‘bp’
+

backward predicted MVs +

+
+ +
+
frame_type, ft
+

Set frame type to visualize motion vectors of. +

+

Available flags for frame_type are: +

+
+
‘if’
+

intra-coded frames (I-frames) +

+
‘pf’
+

predicted frames (P-frames) +

+
‘bf’
+

bi-directionally predicted frames (B-frames) +

+
+
+
+ + +

11.22.1 Examples

+ +
    +
  • Visualize forward predicted MVs of all frames using ffplay: +
    +
    ffplay -flags2 +export_mvs input.mp4 -vf codecview=mv_type=fp
+
    + +
  • Visualize multi-directionals MVs of P and B-Frames using ffplay: +
    +
    ffplay -flags2 +export_mvs input.mp4 -vf codecview=mv=pf+bf+bb
+
    +
+ + +

11.23 colorbalance

+

Modify intensity of primary colors (red, green and blue) of input frames. +

+

The filter allows an input frame to be adjusted in the shadows, midtones or highlights +regions for the red-cyan, green-magenta or blue-yellow balance. +

+

A positive adjustment value shifts the balance towards the primary color, a negative +value towards the complementary color. +

+

The filter accepts the following options: +

+
+
rs
+
gs
+
bs
+

Adjust red, green and blue shadows (darkest pixels). +

+
+
rm
+
gm
+
bm
+

Adjust red, green and blue midtones (medium pixels). +

+
+
rh
+
gh
+
bh
+

Adjust red, green and blue highlights (brightest pixels). +

+

Allowed ranges for options are [-1.0, 1.0]. Defaults are 0. +

+
+
pl
+

Preserve lightness when changing color balance. Default is disabled. +

+
+ + +

11.23.1 Examples

+ +
    +
  • Add red color cast to shadows: +
    +
    colorbalance=rs=.3
+
    +
+ + +

11.23.2 Commands

+ +

This filter supports the all above options as commands. +

+ +

11.24 colorchannelmixer

+ +

Adjust video input frames by re-mixing color channels. +

+

This filter modifies a color channel by adding the values associated to +the other channels of the same pixels. For example if the value to +modify is red, the output value will be: +

+
red=red*rr + blue*rb + green*rg + alpha*ra
+
+ +

The filter accepts the following options: +

+
+
rr
+
rg
+
rb
+
ra
+

Adjust contribution of input red, green, blue and alpha channels for output red channel. +Default is 1 for rr, and 0 for rg, rb and ra. +

+
+
gr
+
gg
+
gb
+
ga
+

Adjust contribution of input red, green, blue and alpha channels for output green channel. +Default is 1 for gg, and 0 for gr, gb and ga. +

+
+
br
+
bg
+
bb
+
ba
+

Adjust contribution of input red, green, blue and alpha channels for output blue channel. +Default is 1 for bb, and 0 for br, bg and ba. +

+
+
ar
+
ag
+
ab
+
aa
+

Adjust contribution of input red, green, blue and alpha channels for output alpha channel. +Default is 1 for aa, and 0 for ar, ag and ab. +

+

Allowed ranges for options are [-2.0, 2.0]. +

+
+ + +

11.24.1 Examples

+ +
    +
  • Convert source to grayscale: +
    +
    colorchannelmixer=.3:.4:.3:0:.3:.4:.3:0:.3:.4:.3
+
    +
  • Simulate sepia tones: +
    +
    colorchannelmixer=.393:.769:.189:0:.349:.686:.168:0:.272:.534:.131
+
    +
+ + +

11.24.2 Commands

+ +

This filter supports the all above options as commands. +

+ +

11.25 colorkey

+

RGB colorspace color keying. +

+

The filter accepts the following options: +

+
+
color
+

The color which will be replaced with transparency. +

+
+
similarity
+

Similarity percentage with the key color. +

+

0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +

+

0.0 makes pixels either fully transparent, or not transparent at all. +

+

Higher values result in semi-transparent pixels, with a higher transparency +the more similar the pixels color is to the key color. +

+
+ + +

11.25.1 Examples

+ +
    +
  • Make every green pixel in the input image transparent: +
    +
    ffmpeg -i input.png -vf colorkey=green out.png
+
    + +
  • Overlay a greenscreen-video on top of a static background image. +
    +
    ffmpeg -i background.png -i video.mp4 -filter_complex "[1:v]colorkey=0x3BBD1E:0.3:0.2[ckout];[0:v][ckout]overlay[out]" -map "[out]" output.flv
+
    +
+ + +

11.25.2 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.26 colorhold

+

Remove all color information for all RGB colors except for certain one. +

+

The filter accepts the following options: +

+
+
color
+

The color which will not be replaced with neutral gray. +

+
+
similarity
+

Similarity percentage with the above color. +0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. 0.0 makes pixels fully gray. +Higher values result in more preserved color. +

+
+ + +

11.26.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.27 colorlevels

+ +

Adjust video input frames using levels. +

+

The filter accepts the following options: +

+
+
rimin
+
gimin
+
bimin
+
aimin
+

Adjust red, green, blue and alpha input black point. +Allowed ranges for options are [-1.0, 1.0]. Defaults are 0. +

+
+
rimax
+
gimax
+
bimax
+
aimax
+

Adjust red, green, blue and alpha input white point. +Allowed ranges for options are [-1.0, 1.0]. Defaults are 1. +

+

Input levels are used to lighten highlights (bright tones), darken shadows +(dark tones), change the balance of bright and dark tones. +

+
+
romin
+
gomin
+
bomin
+
aomin
+

Adjust red, green, blue and alpha output black point. +Allowed ranges for options are [0, 1.0]. Defaults are 0. +

+
+
romax
+
gomax
+
bomax
+
aomax
+

Adjust red, green, blue and alpha output white point. +Allowed ranges for options are [0, 1.0]. Defaults are 1. +

+

Output levels allows manual selection of a constrained output level range. +

+
+ + +

11.27.1 Examples

+ +
    +
  • Make video output darker: +
    +
    colorlevels=rimin=0.058:gimin=0.058:bimin=0.058
+
    + +
  • Increase contrast: +
    +
    colorlevels=rimin=0.039:gimin=0.039:bimin=0.039:rimax=0.96:gimax=0.96:bimax=0.96
+
    + +
  • Make video output lighter: +
    +
    colorlevels=rimax=0.902:gimax=0.902:bimax=0.902
+
    + +
  • Increase brightness: +
    +
    colorlevels=romin=0.5:gomin=0.5:bomin=0.5
+
    +
+ + +

11.27.2 Commands

+ +

This filter supports the all above options as commands. +

+ +

11.28 colormatrix

+ +

Convert color matrix. +

+

The filter accepts the following options: +

+
+
src
+
dst
+

Specify the source and destination color matrix. Both values must be +specified. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘fcc’
+

FCC +

+
+
‘bt601’
+

BT.601 +

+
+
‘bt470’
+

BT.470 +

+
+
‘bt470bg’
+

BT.470BG +

+
+
‘smpte170m’
+

SMPTE-170M +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘bt2020’
+

BT.2020 +

+
+
+
+ +

For example to convert from BT.601 to SMPTE-240M, use the command: +

+
colormatrix=bt601:smpte240m
+
+ + +

11.29 colorspace

+ +

Convert colorspace, transfer characteristics or color primaries. +Input video needs to have an even size. +

+

The filter accepts the following options: +

+
+
+
all
+

Specify all color properties at once. +

+

The accepted values are: +

+
‘bt470m’
+

BT.470M +

+
+
‘bt470bg’
+

BT.470BG +

+
+
‘bt601-6-525’
+

BT.601-6 525 +

+
+
‘bt601-6-625’
+

BT.601-6 625 +

+
+
‘bt709’
+

BT.709 +

+
+
‘smpte170m’
+

SMPTE-170M +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘bt2020’
+

BT.2020 +

+
+
+ +
+
space
+

Specify output colorspace. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘fcc’
+

FCC +

+
+
‘bt470bg’
+

BT.470BG or BT.601-6 625 +

+
+
‘smpte170m’
+

SMPTE-170M or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘ycgco’
+

YCgCo +

+
+
‘bt2020ncl’
+

BT.2020 with non-constant luminance +

+
+
+ +
+
trc
+

Specify output transfer characteristics. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘bt470m’
+

BT.470M +

+
+
‘bt470bg’
+

BT.470BG +

+
+
‘gamma22’
+

Constant gamma of 2.2 +

+
+
‘gamma28’
+

Constant gamma of 2.8 +

+
+
‘smpte170m’
+

SMPTE-170M, BT.601-6 625 or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘srgb’
+

SRGB +

+
+
‘iec61966-2-1’
+

iec61966-2-1 +

+
+
‘iec61966-2-4’
+

iec61966-2-4 +

+
+
‘xvycc’
+

xvycc +

+
+
‘bt2020-10’
+

BT.2020 for 10-bits content +

+
+
‘bt2020-12’
+

BT.2020 for 12-bits content +

+
+
+ +
+
primaries
+

Specify output color primaries. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘bt470m’
+

BT.470M +

+
+
‘bt470bg’
+

BT.470BG or BT.601-6 625 +

+
+
‘smpte170m’
+

SMPTE-170M or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘film’
+

film +

+
+
‘smpte431’
+

SMPTE-431 +

+
+
‘smpte432’
+

SMPTE-432 +

+
+
‘bt2020’
+

BT.2020 +

+
+
‘jedec-p22’
+

JEDEC P22 phosphors +

+
+
+ +
+
range
+

Specify output color range. +

+

The accepted values are: +

+
‘tv’
+

TV (restricted) range +

+
+
‘mpeg’
+

MPEG (restricted) range +

+
+
‘pc’
+

PC (full) range +

+
+
‘jpeg’
+

JPEG (full) range +

+
+
+ +
+
format
+

Specify output color format. +

+

The accepted values are: +

+
‘yuv420p’
+

YUV 4:2:0 planar 8-bits +

+
+
‘yuv420p10’
+

YUV 4:2:0 planar 10-bits +

+
+
‘yuv420p12’
+

YUV 4:2:0 planar 12-bits +

+
+
‘yuv422p’
+

YUV 4:2:2 planar 8-bits +

+
+
‘yuv422p10’
+

YUV 4:2:2 planar 10-bits +

+
+
‘yuv422p12’
+

YUV 4:2:2 planar 12-bits +

+
+
‘yuv444p’
+

YUV 4:4:4 planar 8-bits +

+
+
‘yuv444p10’
+

YUV 4:4:4 planar 10-bits +

+
+
‘yuv444p12’
+

YUV 4:4:4 planar 12-bits +

+
+
+ +
+
fast
+

Do a fast conversion, which skips gamma/primary correction. This will take +significantly less CPU, but will be mathematically incorrect. To get output +compatible with that produced by the colormatrix filter, use fast=1. +

+
+
dither
+

Specify dithering mode. +

+

The accepted values are: +

+
‘none’
+

No dithering +

+
+
‘fsb’
+

Floyd-Steinberg dithering +

+
+ +
+
wpadapt
+

Whitepoint adaptation mode. +

+

The accepted values are: +

+
‘bradford’
+

Bradford whitepoint adaptation +

+
+
‘vonkries’
+

von Kries whitepoint adaptation +

+
+
‘identity’
+

identity whitepoint adaptation (i.e. no whitepoint adaptation) +

+
+ +
+
iall
+

Override all input properties at once. Same accepted values as all. +

+
+
ispace
+

Override input colorspace. Same accepted values as space. +

+
+
iprimaries
+

Override input color primaries. Same accepted values as primaries. +

+
+
itrc
+

Override input transfer characteristics. Same accepted values as trc. +

+
+
irange
+

Override input color range. Same accepted values as range. +

+
+
+ +

The filter converts the transfer characteristics, color space and color +primaries to the specified user values. The output value, if not specified, +is set to a default value based on the "all" property. If that property is +also not specified, the filter will log an error. The output color range and +format default to the same value as the input color range and format. The +input transfer characteristics, color space, color primaries and color range +should be set on the input data. If any of these are missing, the filter will +log an error and no conversion will take place. +

+

For example to convert the input to SMPTE-240M, use the command: +

+
colorspace=smpte240m
+
+ + +

11.30 convolution

+ +

Apply convolution of 3x3, 5x5, 7x7 or horizontal/vertical up to 49 elements. +

+

The filter accepts the following options: +

+
+
0m
+
1m
+
2m
+
3m
+

Set matrix for each plane. +Matrix is sequence of 9, 25 or 49 signed integers in square mode, +and from 1 to 49 odd number of signed integers in row mode. +

+
+
0rdiv
+
1rdiv
+
2rdiv
+
3rdiv
+

Set multiplier for calculated value for each plane. +If unset or 0, it will be sum of all matrix elements. +

+
+
0bias
+
1bias
+
2bias
+
3bias
+

Set bias for each plane. This value is added to the result of the multiplication. +Useful for making the overall image brighter or darker. Default is 0.0. +

+
+
0mode
+
1mode
+
2mode
+
3mode
+

Set matrix mode for each plane. Can be square, row or column. +Default is square. +

+
+ + +

11.30.1 Examples

+ +
    +
  • Apply sharpen: +
    +
    convolution="0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0"
+
    + +
  • Apply blur: +
    +
    convolution="1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1/9:1/9:1/9:1/9"
+
    + +
  • Apply edge enhance: +
    +
    convolution="0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:5:1:1:1:0:128:128:128"
+
    + +
  • Apply edge detect: +
    +
    convolution="0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:5:5:5:1:0:128:128:128"
+
    + +
  • Apply laplacian edge detector which includes diagonals: +
    +
    convolution="1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:5:5:5:1:0:128:128:0"
+
    + +
  • Apply emboss: +
    +
    convolution="-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2"
+
    +
+ + +

11.31 convolve

+ +

Apply 2D convolution of video stream in frequency domain using second stream +as impulse. +

+

The filter accepts the following options: +

+
+
planes
+

Set which planes to process. +

+
+
impulse
+

Set which impulse video frames will be processed, can be first +or all. Default is all. +

+
+ +

The convolve filter also supports the framesync options. +

+ +

11.32 copy

+ +

Copy the input video source unchanged to the output. This is mainly useful for +testing purposes. +

+ +

11.33 coreimage

+

Video filtering on GPU using Apple’s CoreImage API on OSX. +

+

Hardware acceleration is based on an OpenGL context. Usually, this means it is +processed by video hardware. However, software-based OpenGL implementations +exist which means there is no guarantee for hardware processing. It depends on +the respective OSX. +

+

There are many filters and image generators provided by Apple that come with a +large variety of options. The filter has to be referenced by its name along +with its options. +

+

The coreimage filter accepts the following options: +

+
list_filters
+

List all available filters and generators along with all their respective +options as well as possible minimum and maximum values along with the default +values. +

+
list_filters=true
+
+ +
+
filter
+

Specify all filters by their respective name and options. +Use list_filters to determine all valid filter names and options. +Numerical options are specified by a float value and are automatically clamped +to their respective value range. Vector and color options have to be specified +by a list of space separated float values. Character escaping has to be done. +A special option name default is available to use default options for a +filter. +

+

It is required to specify either default or at least one of the filter options. +All omitted options are used with their default values. +The syntax of the filter string is as follows: +

+
filter=<NAME>@<OPTION>=<VALUE>[@<OPTION>=<VALUE>][@...][#<NAME>@<OPTION>=<VALUE>[@<OPTION>=<VALUE>][@...]][#...]
+
+ +
+
output_rect
+

Specify a rectangle where the output of the filter chain is copied into the +input image. It is given by a list of space separated float values: +

+
output_rect=x\ y\ width\ height
+
+

If not given, the output rectangle equals the dimensions of the input image. +The output rectangle is automatically cropped at the borders of the input +image. Negative values are valid for each component. +

+
output_rect=25\ 25\ 100\ 100
+
+
+
+ +

Several filters can be chained for successive processing without GPU-HOST +transfers allowing for fast processing of complex filter chains. +Currently, only filters with zero (generators) or exactly one (filters) input +image and one output image are supported. Also, transition filters are not yet +usable as intended. +

+

Some filters generate output images with additional padding depending on the +respective filter kernel. The padding is automatically removed to ensure the +filter output has the same size as the input image. +

+

For image generators, the size of the output image is determined by the +previous output image of the filter chain or the input image of the whole +filterchain, respectively. The generators do not use the pixel information of +this image to generate their output. However, the generated output is +blended onto this image, resulting in partial or complete coverage of the +output image. +

+

The coreimagesrc video source can be used for generating input images +which are directly fed into the filter chain. By using it, providing input +images by another video source or an input video is not required. +

+ +

11.33.1 Examples

+ +
    +
  • List all filters available: +
    +
    coreimage=list_filters=true
+
    + +
  • Use the CIBoxBlur filter with default options to blur an image: +
    +
    coreimage=filter=CIBoxBlur@default
+
    + +
  • Use a filter chain with CISepiaTone at default values and CIVignetteEffect with +its center at 100x100 and a radius of 50 pixels: +
    +
    coreimage=filter=CIBoxBlur@default#CIVignetteEffect@inputCenter=100\ 100@inputRadius=50
+
    + +
  • Use nullsrc and CIQRCodeGenerator to create a QR code for the FFmpeg homepage, +given as complete and escaped command-line for Apple’s standard bash shell: +
    +
    ffmpeg -f lavfi -i nullsrc=s=100x100,coreimage=filter=CIQRCodeGenerator@inputMessage=https\\\\\://FFmpeg.org/@inputCorrectionLevel=H -frames:v 1 QRCode.png
+
    +
+ + +

11.34 cover_rect

+ +

Cover a rectangular object +

+

It accepts the following options: +

+
+
cover
+

Filepath of the optional cover image, needs to be in yuv420. +

+
+
mode
+

Set covering mode. +

+

It accepts the following values: +

+
‘cover’
+

cover it by the supplied image +

+
‘blur’
+

cover it by interpolating the surrounding pixels +

+
+ +

Default value is blur. +

+
+ + +

11.34.1 Examples

+ +
    +
  • Cover a rectangular object by the supplied image of a given video using ffmpeg: +
    +
    ffmpeg -i file.ts -vf find_rect=newref.pgm,cover_rect=cover.jpg:mode=cover new.mkv
+
    +
+ + +

11.35 crop

+ +

Crop the input video to given dimensions. +

+

It accepts the following parameters: +

+
+
w, out_w
+

The width of the output video. It defaults to iw. +This expression is evaluated only once during the filter +configuration, or when the ‘w’ or ‘out_w’ command is sent. +

+
+
h, out_h
+

The height of the output video. It defaults to ih. +This expression is evaluated only once during the filter +configuration, or when the ‘h’ or ‘out_h’ command is sent. +

+
+
x
+

The horizontal position, in the input video, of the left edge of the output +video. It defaults to (in_w-out_w)/2. +This expression is evaluated per-frame. +

+
+
y
+

The vertical position, in the input video, of the top edge of the output video. +It defaults to (in_h-out_h)/2. +This expression is evaluated per-frame. +

+
+
keep_aspect
+

If set to 1 will force the output display aspect ratio +to be the same of the input, by changing the output sample aspect +ratio. It defaults to 0. +

+
+
exact
+

Enable exact cropping. If enabled, subsampled videos will be cropped at exact +width/height/x/y as specified and will not be rounded to nearest smaller value. +It defaults to 0. +

+
+ +

The out_w, out_h, x, y parameters are +expressions containing the following constants: +

+
+
x
+
y
+

The computed values for x and y. They are evaluated for +each new frame. +

+
+
in_w
+
in_h
+

The input width and height. +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output (cropped) width and height. +

+
+
ow
+
oh
+

These are the same as out_w and out_h. +

+
+
a
+

same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (iw / ih) * sar +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
n
+

The number of the input frame, starting from 0. +

+
+
pos
+

the position in the file of the input frame, NAN if unknown +

+
+
t
+

The timestamp expressed in seconds. It’s NAN if the input timestamp is unknown. +

+
+
+ +

The expression for out_w may depend on the value of out_h, +and the expression for out_h may depend on out_w, but they +cannot depend on x and y, as x and y are +evaluated after out_w and out_h. +

+

The x and y parameters specify the expressions for the +position of the top-left corner of the output (non-cropped) area. They +are evaluated for each frame. If the evaluated value is not valid, it +is approximated to the nearest valid value. +

+

The expression for x may depend on y, and the expression +for y may depend on x. +

+ +

11.35.1 Examples

+ +
    +
  • Crop area with size 100x100 at position (12,34). +
    +
    crop=100:100:12:34
+
    + +

    Using named options, the example above becomes: +

    +
    crop=w=100:h=100:x=12:y=34
+
    + +
  • Crop the central input area with size 100x100: +
    +
    crop=100:100
+
    + +
  • Crop the central input area with size 2/3 of the input video: +
    +
    crop=2/3*in_w:2/3*in_h
+
    + +
  • Crop the input video central square: +
    +
    crop=out_w=in_h
+crop=in_h
+
    + +
  • Delimit the rectangle with the top-left corner placed at position +100:100 and the right-bottom corner corresponding to the right-bottom +corner of the input image. +
    +
    crop=in_w-100:in_h-100:100:100
+
    + +
  • Crop 10 pixels from the left and right borders, and 20 pixels from +the top and bottom borders +
    +
    crop=in_w-2*10:in_h-2*20
+
    + +
  • Keep only the bottom right quarter of the input image: +
    +
    crop=in_w/2:in_h/2:in_w/2:in_h/2
+
    + +
  • Crop height for getting Greek harmony: +
    +
    crop=in_w:1/PHI*in_w
+
    + +
  • Apply trembling effect: +
    +
    crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(n/10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(n/7)
+
    + +
  • Apply erratic camera effect depending on timestamp: +
    +
    crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(t*10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(t*13)"
+
    + +
  • Set x depending on the value of y: +
    +
    crop=in_w/2:in_h/2:y:10+10*sin(n/10)
+
    +
+ + +

11.35.2 Commands

+ +

This filter supports the following commands: +

+
w, out_w
+
h, out_h
+
x
+
y
+

Set width/height of the output video and the horizontal/vertical position +in the input video. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

11.36 cropdetect

+ +

Auto-detect the crop size. +

+

It calculates the necessary cropping parameters and prints the +recommended parameters via the logging system. The detected dimensions +correspond to the non-black area of the input video. +

+

It accepts the following parameters: +

+
+
limit
+

Set higher black value threshold, which can be optionally specified +from nothing (0) to everything (255 for 8-bit based formats). An intensity +value greater to the set value is considered non-black. It defaults to 24. +You can also specify a value between 0.0 and 1.0 which will be scaled depending +on the bitdepth of the pixel format. +

+
+
round
+

The value which the width/height should be divisible by. It defaults to +16. The offset is automatically adjusted to center the video. Use 2 to +get only even dimensions (needed for 4:2:2 video). 16 is best when +encoding to most video codecs. +

+
+
reset_count, reset
+

Set the counter that determines after how many frames cropdetect will +reset the previously detected largest video area and start over to +detect the current optimal crop area. Default value is 0. +

+

This can be useful when channel logos distort the video area. 0 +indicates ’never reset’, and returns the largest area encountered during +playback. +

+
+ + +

11.37 cue

+ +

Delay video filtering until a given wallclock timestamp. The filter first +passes on preroll amount of frames, then it buffers at most +buffer amount of frames and waits for the cue. After reaching the cue +it forwards the buffered frames and also any subsequent frames coming in its +input. +

+

The filter can be used synchronize the output of multiple ffmpeg processes for +realtime output devices like decklink. By putting the delay in the filtering +chain and pre-buffering frames the process can pass on data to output almost +immediately after the target wallclock timestamp is reached. +

+

Perfect frame accuracy cannot be guaranteed, but the result is good enough for +some use cases. +

+
+
cue
+

The cue timestamp expressed in a UNIX timestamp in microseconds. Default is 0. +

+
+
preroll
+

The duration of content to pass on as preroll expressed in seconds. Default is 0. +

+
+
buffer
+

The maximum duration of content to buffer before waiting for the cue expressed +in seconds. Default is 0. +

+
+
+ + +

11.38 curves

+ +

Apply color adjustments using curves. +

+

This filter is similar to the Adobe Photoshop and GIMP curves tools. Each +component (red, green and blue) has its values defined by N key points +tied from each other using a smooth curve. The x-axis represents the pixel +values from the input frame, and the y-axis the new pixel values to be set for +the output frame. +

+

By default, a component curve is defined by the two points (0;0) and +(1;1). This creates a straight line where each original pixel value is +"adjusted" to its own value, which means no change to the image. +

+

The filter allows you to redefine these two points and add some more. A new +curve (using a natural cubic spline interpolation) will be define to pass +smoothly through all these new coordinates. The new defined points needs to be +strictly increasing over the x-axis, and their x and y values must +be in the [0;1] interval. If the computed curves happened to go outside +the vector spaces, the values will be clipped accordingly. +

+

The filter accepts the following options: +

+
+
preset
+

Select one of the available color presets. This option can be used in addition +to the r, g, b parameters; in this case, the later +options takes priority on the preset values. +Available presets are: +

+
‘none’
+
‘color_negative’
+
‘cross_process’
+
‘darker’
+
‘increase_contrast’
+
‘lighter’
+
‘linear_contrast’
+
‘medium_contrast’
+
‘negative’
+
‘strong_contrast’
+
‘vintage’
+
+

Default is none. +

+
master, m
+

Set the master key points. These points will define a second pass mapping. It +is sometimes called a "luminance" or "value" mapping. It can be used with +r, g, b or all since it acts like a +post-processing LUT. +

+
red, r
+

Set the key points for the red component. +

+
green, g
+

Set the key points for the green component. +

+
blue, b
+

Set the key points for the blue component. +

+
all
+

Set the key points for all components (not including master). +Can be used in addition to the other key points component +options. In this case, the unset component(s) will fallback on this +all setting. +

+
psfile
+

Specify a Photoshop curves file (.acv) to import the settings from. +

+
plot
+

Save Gnuplot script of the curves in specified file. +

+
+ +

To avoid some filtergraph syntax conflicts, each key points list need to be +defined using the following syntax: x0/y0 x1/y1 x2/y2 .... +

+ +

11.38.1 Examples

+ +
    +
  • Increase slightly the middle level of blue: +
    +
    curves=blue='0/0 0.5/0.58 1/1'
+
    + +
  • Vintage effect: +
    +
    curves=r='0/0.11 .42/.51 1/0.95':g='0/0 0.50/0.48 1/1':b='0/0.22 .49/.44 1/0.8'
+
    +

    Here we obtain the following coordinates for each components: +

    +
    red
    +

    (0;0.11) (0.42;0.51) (1;0.95) +

    +
    green
    +

    (0;0) (0.50;0.48) (1;1) +

    +
    blue
    +

    (0;0.22) (0.49;0.44) (1;0.80) +

    +
    + +
  • The previous example can also be achieved with the associated built-in preset: +
    +
    curves=preset=vintage
+
    + +
  • Or simply: +
    +
    curves=vintage
+
    + +
  • Use a Photoshop preset and redefine the points of the green component: +
    +
    curves=psfile='MyCurvesPresets/purple.acv':green='0/0 0.45/0.53 1/1'
+
    + +
  • Check out the curves of the cross_process profile using ffmpeg +and gnuplot: +
    +
    ffmpeg -f lavfi -i color -vf curves=cross_process:plot=/tmp/curves.plt -frames:v 1 -f null -
+gnuplot -p /tmp/curves.plt
+
    +
+ + +

11.39 datascope

+ +

Video data analysis filter. +

+

This filter shows hexadecimal pixel values of part of video. +

+

The filter accepts the following options: +

+
+
size, s
+

Set output video size. +

+
+
x
+

Set x offset from where to pick pixels. +

+
+
y
+

Set y offset from where to pick pixels. +

+
+
mode
+

Set scope mode, can be one of the following: +

+
‘mono’
+

Draw hexadecimal pixel values with white color on black background. +

+
+
‘color’
+

Draw hexadecimal pixel values with input video pixel color on black +background. +

+
+
‘color2’
+

Draw hexadecimal pixel values on color background picked from input video, +the text color is picked in such way so its always visible. +

+
+ +
+
axis
+

Draw rows and columns numbers on left and top of video. +

+
+
opacity
+

Set background opacity. +

+
+
format
+

Set display number format. Can be hex, or dec. Default is hex. +

+
+ + +

11.40 dblur

+

Apply Directional blur filter. +

+

The filter accepts the following options: +

+
+
angle
+

Set angle of directional blur. Default is 45. +

+
+
radius
+

Set radius of directional blur. Default is 5. +

+
+
planes
+

Set which planes to filter. By default all planes are filtered. +

+
+ + +

11.40.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.41 dctdnoiz

+ +

Denoise frames using 2D DCT (frequency domain filtering). +

+

This filter is not designed for real time. +

+

The filter accepts the following options: +

+
+
sigma, s
+

Set the noise sigma constant. +

+

This sigma defines a hard threshold of 3 * sigma; every DCT +coefficient (absolute value) below this threshold with be dropped. +

+

If you need a more advanced filtering, see expr. +

+

Default is 0. +

+
+
overlap
+

Set number overlapping pixels for each block. Since the filter can be slow, you +may want to reduce this value, at the cost of a less effective filter and the +risk of various artefacts. +

+

If the overlapping value doesn’t permit processing the whole input width or +height, a warning will be displayed and according borders won’t be denoised. +

+

Default value is blocksize-1, which is the best possible setting. +

+
+
expr, e
+

Set the coefficient factor expression. +

+

For each coefficient of a DCT block, this expression will be evaluated as a +multiplier value for the coefficient. +

+

If this is option is set, the sigma option will be ignored. +

+

The absolute value of the coefficient can be accessed through the c +variable. +

+
+
n
+

Set the blocksize using the number of bits. 1<<n defines the +blocksize, which is the width and height of the processed blocks. +

+

The default value is 3 (8x8) and can be raised to 4 for a +blocksize of 16x16. Note that changing this setting has huge consequences +on the speed processing. Also, a larger block size does not necessarily means a +better de-noising. +

+
+ + +

11.41.1 Examples

+ +

Apply a denoise with a sigma of 4.5: +

+
dctdnoiz=4.5
+
+ +

The same operation can be achieved using the expression system: +

+
dctdnoiz=e='gte(c, 4.5*3)'
+
+ +

Violent denoise using a block size of 16x16: +

+
dctdnoiz=15:n=4
+
+ + +

11.42 deband

+ +

Remove banding artifacts from input video. +It works by replacing banded pixels with average value of referenced pixels. +

+

The filter accepts the following options: +

+
+
1thr
+
2thr
+
3thr
+
4thr
+

Set banding detection threshold for each plane. Default is 0.02. +Valid range is 0.00003 to 0.5. +If difference between current pixel and reference pixel is less than threshold, +it will be considered as banded. +

+
+
range, r
+

Banding detection range in pixels. Default is 16. If positive, random number +in range 0 to set value will be used. If negative, exact absolute value +will be used. +The range defines square of four pixels around current pixel. +

+
+
direction, d
+

Set direction in radians from which four pixel will be compared. If positive, +random direction from 0 to set direction will be picked. If negative, exact of +absolute value will be picked. For example direction 0, -PI or -2*PI radians +will pick only pixels on same row and -PI/2 will pick only pixels on same +column. +

+
+
blur, b
+

If enabled, current pixel is compared with average value of all four +surrounding pixels. The default is enabled. If disabled current pixel is +compared with all four surrounding pixels. The pixel is considered banded +if only all four differences with surrounding pixels are less than threshold. +

+
+
coupling, c
+

If enabled, current pixel is changed if and only if all pixel components are banded, +e.g. banding detection threshold is triggered for all color components. +The default is disabled. +

+
+ + +

11.43 deblock

+ +

Remove blocking artifacts from input video. +

+

The filter accepts the following options: +

+
+
filter
+

Set filter type, can be weak or strong. Default is strong. +This controls what kind of deblocking is applied. +

+
+
block
+

Set size of block, allowed range is from 4 to 512. Default is 8. +

+
+
alpha
+
beta
+
gamma
+
delta
+

Set blocking detection thresholds. Allowed range is 0 to 1. +Defaults are: 0.098 for alpha and 0.05 for the rest. +Using higher threshold gives more deblocking strength. +Setting alpha controls threshold detection at exact edge of block. +Remaining options controls threshold detection near the edge. Each one for +below/above or left/right. Setting any of those to 0 disables +deblocking. +

+
+
planes
+

Set planes to filter. Default is to filter all available planes. +

+
+ + +

11.43.1 Examples

+ +
    +
  • Deblock using weak filter and block size of 4 pixels. +
    +
    deblock=filter=weak:block=4
+
    + +
  • Deblock using strong filter, block size of 4 pixels and custom thresholds for +deblocking more edges. +
    +
    deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05
+
    + +
  • Similar as above, but filter only first plane. +
    +
    deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05:planes=1
+
    + +
  • Similar as above, but filter only second and third plane. +
    +
    deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05:planes=6
+
    +
+ + +

11.44 decimate

+ +

Drop duplicated frames at regular intervals. +

+

The filter accepts the following options: +

+
+
cycle
+

Set the number of frames from which one will be dropped. Setting this to +N means one frame in every batch of N frames will be dropped. +Default is 5. +

+
+
dupthresh
+

Set the threshold for duplicate detection. If the difference metric for a frame +is less than or equal to this value, then it is declared as duplicate. Default +is 1.1 +

+
+
scthresh
+

Set scene change threshold. Default is 15. +

+
+
blockx
+
blocky
+

Set the size of the x and y-axis blocks used during metric calculations. +Larger blocks give better noise suppression, but also give worse detection of +small movements. Must be a power of two. Default is 32. +

+
+
ppsrc
+

Mark main input as a pre-processed input and activate clean source input +stream. This allows the input to be pre-processed with various filters to help +the metrics calculation while keeping the frame selection lossless. When set to +1, the first stream is for the pre-processed input, and the second +stream is the clean source from where the kept frames are chosen. Default is +0. +

+
+
chroma
+

Set whether or not chroma is considered in the metric calculations. Default is +1. +

+
+ + +

11.45 deconvolve

+ +

Apply 2D deconvolution of video stream in frequency domain using second stream +as impulse. +

+

The filter accepts the following options: +

+
+
planes
+

Set which planes to process. +

+
+
impulse
+

Set which impulse video frames will be processed, can be first +or all. Default is all. +

+
+
noise
+

Set noise when doing divisions. Default is 0.0000001. Useful when width +and height are not same and not power of 2 or if stream prior to convolving +had noise. +

+
+ +

The deconvolve filter also supports the framesync options. +

+ +

11.46 dedot

+ +

Reduce cross-luminance (dot-crawl) and cross-color (rainbows) from video. +

+

It accepts the following options: +

+
+
m
+

Set mode of operation. Can be combination of dotcrawl for cross-luminance reduction and/or +rainbows for cross-color reduction. +

+
+
lt
+

Set spatial luma threshold. Lower values increases reduction of cross-luminance. +

+
+
tl
+

Set tolerance for temporal luma. Higher values increases reduction of cross-luminance. +

+
+
tc
+

Set tolerance for chroma temporal variation. Higher values increases reduction of cross-color. +

+
+
ct
+

Set temporal chroma threshold. Lower values increases reduction of cross-color. +

+
+ + +

11.47 deflate

+ +

Apply deflate effect to the video. +

+

This filter replaces the pixel by the local(3x3) average by taking into account +only values lower than the pixel. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+ + +

11.47.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

11.48 deflicker

+ +

Remove temporal frame luminance variations. +

+

It accepts the following options: +

+
+
size, s
+

Set moving-average filter size in frames. Default is 5. Allowed range is 2 - 129. +

+
+
mode, m
+

Set averaging mode to smooth temporal luminance variations. +

+

Available values are: +

+
‘am’
+

Arithmetic mean +

+
+
‘gm’
+

Geometric mean +

+
+
‘hm’
+

Harmonic mean +

+
+
‘qm’
+

Quadratic mean +

+
+
‘cm’
+

Cubic mean +

+
+
‘pm’
+

Power mean +

+
+
‘median’
+

Median +

+
+ +
+
bypass
+

Do not actually modify frame. Useful when one only wants metadata. +

+
+ + +

11.49 dejudder

+ +

Remove judder produced by partially interlaced telecined content. +

+

Judder can be introduced, for instance, by pullup filter. If the original +source was partially telecined content then the output of pullup,dejudder +will have a variable frame rate. May change the recorded frame rate of the +container. Aside from that change, this filter will not affect constant frame +rate video. +

+

The option available in this filter is: +

+
cycle
+

Specify the length of the window over which the judder repeats. +

+

Accepts any integer greater than 1. Useful values are: +

+
‘4’
+

If the original was telecined from 24 to 30 fps (Film to NTSC). +

+
+
‘5’
+

If the original was telecined from 25 to 30 fps (PAL to NTSC). +

+
+
‘20’
+

If a mixture of the two. +

+
+ +

The default is ‘4’. +

+
+ + +

11.50 delogo

+ +

Suppress a TV station logo by a simple interpolation of the surrounding +pixels. Just set a rectangle covering the logo and watch it disappear +(and sometimes something even uglier appear - your mileage may vary). +

+

It accepts the following parameters: +

+
x
+
y
+

Specify the top left corner coordinates of the logo. They must be +specified. +

+
+
w
+
h
+

Specify the width and height of the logo to clear. They must be +specified. +

+
+
band, t
+

Specify the thickness of the fuzzy edge of the rectangle (added to +w and h). The default value is 1. This option is +deprecated, setting higher values should no longer be necessary and +is not recommended. +

+
+
show
+

When set to 1, a green rectangle is drawn on the screen to simplify +finding the right x, y, w, and h parameters. +The default value is 0. +

+

The rectangle is drawn on the outermost pixels which will be (partly) +replaced with interpolated values. The values of the next pixels +immediately outside this rectangle in each direction will be used to +compute the interpolated pixel values inside the rectangle. +

+
+
+ + +

11.50.1 Examples

+ +
    +
  • Set a rectangle covering the area with top left corner coordinates 0,0 +and size 100x77, and a band of size 10: +
    +
    delogo=x=0:y=0:w=100:h=77:band=10
+
    + +
+ + +

11.51 derain

+ +

Remove the rain in the input image/video by applying the derain methods based on +convolutional neural networks. Supported models: +

+ + +

Training as well as model generation scripts are provided in +the repository at https://github.com/XueweiMeng/derain_filter.git. +

+

Native model files (.model) can be generated from TensorFlow model +files (.pb) by using tools/python/convert.py +

+

The filter accepts the following options: +

+
+
filter_type
+

Specify which filter to use. This option accepts the following values: +

+
+
‘derain’
+

Derain filter. To conduct derain filter, you need to use a derain model. +

+
+
‘dehaze’
+

Dehaze filter. To conduct dehaze filter, you need to use a dehaze model. +

+
+

Default value is ‘derain’. +

+
+
dnn_backend
+

Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +

+
+
‘native’
+

Native implementation of DNN loading and execution. +

+
+
‘tensorflow’
+

TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +https://www.tensorflow.org/install/install_c) and configure FFmpeg with +--enable-libtensorflow +

+
+

Default value is ‘native’. +

+
+
model
+

Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow and native +backend can load files for only its format. +

+
+ +

It can also be finished with dnn_processing filter. +

+ +

11.52 deshake

+ +

Attempt to fix small changes in horizontal and/or vertical shift. This +filter helps remove camera shake from hand-holding a camera, bumping a +tripod, moving on a vehicle, etc. +

+

The filter accepts the following options: +

+
+
x
+
y
+
w
+
h
+

Specify a rectangular area where to limit the search for motion +vectors. +If desired the search for motion vectors can be limited to a +rectangular area of the frame defined by its top left corner, width +and height. These parameters have the same meaning as the drawbox +filter which can be used to visualise the position of the bounding +box. +

+

This is useful when simultaneous movement of subjects within the frame +might be confused for camera motion by the motion vector search. +

+

If any or all of x, y, w and h are set to -1 +then the full frame is used. This allows later options to be set +without specifying the bounding box for the motion vector search. +

+

Default - search the whole frame. +

+
+
rx
+
ry
+

Specify the maximum extent of movement in x and y directions in the +range 0-64 pixels. Default 16. +

+
+
edge
+

Specify how to generate pixels to fill blanks at the edge of the +frame. Available values are: +

+
‘blank, 0’
+

Fill zeroes at blank locations +

+
‘original, 1’
+

Original image at blank locations +

+
‘clamp, 2’
+

Extruded edge value at blank locations +

+
‘mirror, 3’
+

Mirrored edge at blank locations +

+
+

Default value is ‘mirror’. +

+
+
blocksize
+

Specify the blocksize to use for motion search. Range 4-128 pixels, +default 8. +

+
+
contrast
+

Specify the contrast threshold for blocks. Only blocks with more than +the specified contrast (difference between darkest and lightest +pixels) will be considered. Range 1-255, default 125. +

+
+
search
+

Specify the search strategy. Available values are: +

+
‘exhaustive, 0’
+

Set exhaustive search +

+
‘less, 1’
+

Set less exhaustive search. +

+
+

Default value is ‘exhaustive’. +

+
+
filename
+

If set then a detailed log of the motion search is written to the +specified file. +

+
+
+ + +

11.53 despill

+ +

Remove unwanted contamination of foreground colors, caused by reflected color of +greenscreen or bluescreen. +

+

This filter accepts the following options: +

+
+
type
+

Set what type of despill to use. +

+
+
mix
+

Set how spillmap will be generated. +

+
+
expand
+

Set how much to get rid of still remaining spill. +

+
+
red
+

Controls amount of red in spill area. +

+
+
green
+

Controls amount of green in spill area. +Should be -1 for greenscreen. +

+
+
blue
+

Controls amount of blue in spill area. +Should be -1 for bluescreen. +

+
+
brightness
+

Controls brightness of spill area, preserving colors. +

+
+
alpha
+

Modify alpha from generated spillmap. +

+
+ + +

11.54 detelecine

+ +

Apply an exact inverse of the telecine operation. It requires a predefined +pattern specified using the pattern option which must be the same as that passed +to the telecine filter. +

+

This filter accepts the following options: +

+
+
first_field
+
+
‘top, t’
+

top field first +

+
‘bottom, b’
+

bottom field first +The default value is top. +

+
+ +
+
pattern
+

A string of numbers representing the pulldown pattern you wish to apply. +The default value is 23. +

+
+
start_frame
+

A number representing position of the first frame with respect to the telecine +pattern. This is to be used if the stream is cut. The default value is 0. +

+
+ + +

11.55 dilation

+ +

Apply dilation effect to the video. +

+

This filter replaces the pixel by the local(3x3) maximum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. Default is 255 i.e. all eight +pixels are used. +

+

Flags to local 3x3 coordinates maps like this: +

+

1 2 3 + 4 5 + 6 7 8 +

+
+ + +

11.55.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

11.56 displace

+ +

Displace pixels as indicated by second and third input stream. +

+

It takes three input streams and outputs one stream, the first input is the +source, and second and third input are displacement maps. +

+

The second input specifies how much to displace pixels along the +x-axis, while the third input specifies how much to displace pixels +along the y-axis. +If one of displacement map streams terminates, last frame from that +displacement map will be used. +

+

Note that once generated, displacements maps can be reused over and over again. +

+

A description of the accepted options follows. +

+
+
edge
+

Set displace behavior for pixels that are out of range. +

+

Available values are: +

+
‘blank’
+

Missing pixels are replaced by black pixels. +

+
+
‘smear’
+

Adjacent pixels will spread out to replace missing pixels. +

+
+
‘wrap’
+

Out of range pixels are wrapped so they point to pixels of other side. +

+
+
‘mirror’
+

Out of range pixels will be replaced with mirrored pixels. +

+
+

Default is ‘smear’. +

+
+
+ + +

11.56.1 Examples

+ +
    +
  • Add ripple effect to rgb input of video size hd720: +
    +
    ffmpeg -i INPUT -f lavfi -i nullsrc=s=hd720,lutrgb=128:128:128 -f lavfi -i nullsrc=s=hd720,geq='r=128+30*sin(2*PI*X/400+T):g=128+30*sin(2*PI*X/400+T):b=128+30*sin(2*PI*X/400+T)' -lavfi '[0][1][2]displace' OUTPUT
+
    + +
  • Add wave effect to rgb input of video size hd720: +
    +
    ffmpeg -i INPUT -f lavfi -i nullsrc=hd720,geq='r=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T)):g=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T)):b=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T))' -lavfi '[1]split[x][y],[0][x][y]displace' OUTPUT
+
    +
+ + +

11.57 dnn_processing

+ +

Do image processing with deep neural networks. It works together with another filter +which converts the pixel format of the Frame to what the dnn network requires. +

+

The filter accepts the following options: +

+
+
dnn_backend
+

Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +

+
+
‘native’
+

Native implementation of DNN loading and execution. +

+
+
‘tensorflow’
+

TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +https://www.tensorflow.org/install/install_c) and configure FFmpeg with +--enable-libtensorflow +

+
+ +

Default value is ‘native’. +

+
+
model
+

Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow and native +backend can load files for only its format. +

+

Native model file (.model) can be generated from TensorFlow model file (.pb) by using tools/python/convert.py +

+
+
input
+

Set the input name of the dnn network. +

+
+
output
+

Set the output name of the dnn network. +

+
+
+ + +

11.57.1 Examples

+ +
    +
  • Remove rain in rgb24 frame with can.pb (see derain filter): +
    +
    ./ffmpeg -i rain.jpg -vf format=rgb24,dnn_processing=dnn_backend=tensorflow:model=can.pb:input=x:output=y derain.jpg
+
    + +
  • Halve the pixel value of the frame with format gray32f: +
    +
    ffmpeg -i input.jpg -vf format=grayf32,dnn_processing=model=halve_gray_float.model:input=dnn_in:output=dnn_out:dnn_backend=native -y out.native.png
+
    + +
  • Handle the Y channel with srcnn.pb (see sr filter) for frame with yuv420p (planar YUV formats supported): +
    +
    ./ffmpeg -i 480p.jpg -vf format=yuv420p,scale=w=iw*2:h=ih*2,dnn_processing=dnn_backend=tensorflow:model=srcnn.pb:input=x:output=y -y srcnn.jpg
+
    + +
  • Handle the Y channel with espcn.pb (see sr filter), which changes frame size, for format yuv420p (planar YUV formats supported): +
    +
    ./ffmpeg -i 480p.jpg -vf format=yuv420p,dnn_processing=dnn_backend=tensorflow:model=espcn.pb:input=x:output=y -y tmp.espcn.jpg
+
    + +
+ + +

11.58 drawbox

+ +

Draw a colored box on the input image. +

+

It accepts the following parameters: +

+
+
x
+
y
+

The expressions which specify the top left corner coordinates of the box. It defaults to 0. +

+
+
width, w
+
height, h
+

The expressions which specify the width and height of the box; if 0 they are interpreted as +the input width and height. It defaults to 0. +

+
+
color, c
+

Specify the color of the box to write. For the general syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. If the special +value invert is used, the box edge color is the same as the +video with inverted luma. +

+
+
thickness, t
+

The expression which sets the thickness of the box edge. +A value of fill will create a filled box. Default value is 3. +

+

See below for the list of accepted constants. +

+
+
replace
+

Applicable if the input has alpha. With value 1, the pixels of the painted box +will overwrite the video’s color and alpha pixels. +Default is 0, which composites the box onto the input, leaving the video’s alpha intact. +

+
+ +

The parameters for x, y, w and h and t are expressions containing the +following constants: +

+
+
dar
+

The input display aspect ratio, it is the same as (w / h) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
in_h, ih
+
in_w, iw
+

The input width and height. +

+
+
sar
+

The input sample aspect ratio. +

+
+
x
+
y
+

The x and y offset coordinates where the box is drawn. +

+
+
w
+
h
+

The width and height of the drawn box. +

+
+
t
+

The thickness of the drawn box. +

+

These constants allow the x, y, w, h and t expressions to refer to +each other, so you may for example specify y=x/dar or h=w/dar. +

+
+
+ + +

11.58.1 Examples

+ +
    +
  • Draw a black box around the edge of the input image: +
    +
    drawbox
+
    + +
  • Draw a box with color red and an opacity of 50%: +
    +
    drawbox=10:20:200:60:red@0.5
+
    + +

    The previous example can be specified as: +

    +
    drawbox=x=10:y=20:w=200:h=60:color=red@0.5
+
    + +
  • Fill the box with pink color: +
    +
    drawbox=x=10:y=10:w=100:h=100:color=pink@0.5:t=fill
+
    + +
  • Draw a 2-pixel red 2.40:1 mask: +
    +
    drawbox=x=-t:y=0.5*(ih-iw/2.4)-t:w=iw+t*2:h=iw/2.4+t*2:t=2:c=red
+
    +
+ + +

11.58.2 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.59 drawgraph

+

Draw a graph using input video metadata. +

+

It accepts the following parameters: +

+
+
m1
+

Set 1st frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg1
+

Set 1st foreground color expression. +

+
+
m2
+

Set 2nd frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg2
+

Set 2nd foreground color expression. +

+
+
m3
+

Set 3rd frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg3
+

Set 3rd foreground color expression. +

+
+
m4
+

Set 4th frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg4
+

Set 4th foreground color expression. +

+
+
min
+

Set minimal value of metadata value. +

+
+
max
+

Set maximal value of metadata value. +

+
+
bg
+

Set graph background color. Default is white. +

+
+
mode
+

Set graph mode. +

+

Available values for mode is: +

+
‘bar’
+
‘dot’
+
‘line’
+
+ +

Default is line. +

+
+
slide
+

Set slide mode. +

+

Available values for slide is: +

+
‘frame’
+

Draw new frame when right border is reached. +

+
+
‘replace’
+

Replace old columns with new ones. +

+
+
‘scroll’
+

Scroll from right to left. +

+
+
‘rscroll’
+

Scroll from left to right. +

+
+
‘picture’
+

Draw single picture. +

+
+ +

Default is frame. +

+
+
size
+

Set size of graph video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +The default value is 900x256. +

+
+
rate, r
+

Set the output frame rate. Default value is 25. +

+

The foreground color expressions can use the following variables: +

+
MIN
+

Minimal value of metadata value. +

+
+
MAX
+

Maximal value of metadata value. +

+
+
VAL
+

Current metadata key value. +

+
+ +

The color is defined as 0xAABBGGRR. +

+
+ +

Example using metadata from signalstats filter: +

+
signalstats,drawgraph=lavfi.signalstats.YAVG:min=0:max=255
+
+ +

Example using metadata from ebur128 filter: +

+
ebur128=metadata=1,adrawgraph=lavfi.r128.M:min=-120:max=5
+
+ + +

11.60 drawgrid

+ +

Draw a grid on the input image. +

+

It accepts the following parameters: +

+
+
x
+
y
+

The expressions which specify the coordinates of some point of grid intersection (meant to configure offset). Both default to 0. +

+
+
width, w
+
height, h
+

The expressions which specify the width and height of the grid cell, if 0 they are interpreted as the +input width and height, respectively, minus thickness, so image gets +framed. Default to 0. +

+
+
color, c
+

Specify the color of the grid. For the general syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. If the special +value invert is used, the grid color is the same as the +video with inverted luma. +

+
+
thickness, t
+

The expression which sets the thickness of the grid line. Default value is 1. +

+

See below for the list of accepted constants. +

+
+
replace
+

Applicable if the input has alpha. With 1 the pixels of the painted grid +will overwrite the video’s color and alpha pixels. +Default is 0, which composites the grid onto the input, leaving the video’s alpha intact. +

+
+ +

The parameters for x, y, w and h and t are expressions containing the +following constants: +

+
+
dar
+

The input display aspect ratio, it is the same as (w / h) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
in_h, ih
+
in_w, iw
+

The input grid cell width and height. +

+
+
sar
+

The input sample aspect ratio. +

+
+
x
+
y
+

The x and y coordinates of some point of grid intersection (meant to configure offset). +

+
+
w
+
h
+

The width and height of the drawn cell. +

+
+
t
+

The thickness of the drawn cell. +

+

These constants allow the x, y, w, h and t expressions to refer to +each other, so you may for example specify y=x/dar or h=w/dar. +

+
+
+ + +

11.60.1 Examples

+ +
    +
  • Draw a grid with cell 100x100 pixels, thickness 2 pixels, with color red and an opacity of 50%: +
    +
    drawgrid=width=100:height=100:thickness=2:color=red@0.5
+
    + +
  • Draw a white 3x3 grid with an opacity of 50%: +
    +
    drawgrid=w=iw/3:h=ih/3:t=2:c=white@0.5
+
    +
+ + +

11.60.2 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.61 drawtext

+ +

Draw a text string or text from a specified file on top of a video, using the +libfreetype library. +

+

To enable compilation of this filter, you need to configure FFmpeg with +--enable-libfreetype. +To enable default font fallback and the font option you need to +configure FFmpeg with --enable-libfontconfig. +To enable the text_shaping option, you need to configure FFmpeg with +--enable-libfribidi. +

+ +

11.61.1 Syntax

+ +

It accepts the following parameters: +

+
+
box
+

Used to draw a box around text using the background color. +The value must be either 1 (enable) or 0 (disable). +The default value of box is 0. +

+
+
boxborderw
+

Set the width of the border to be drawn around the box using boxcolor. +The default value of boxborderw is 0. +

+
+
boxcolor
+

The color to be used for drawing box around text. For the syntax of this +option, check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+

The default value of boxcolor is "white". +

+
+
line_spacing
+

Set the line spacing in pixels of the border to be drawn around the box using box. +The default value of line_spacing is 0. +

+
+
borderw
+

Set the width of the border to be drawn around the text using bordercolor. +The default value of borderw is 0. +

+
+
bordercolor
+

Set the color to be used for drawing border around text. For the syntax of this +option, check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+

The default value of bordercolor is "black". +

+
+
expansion
+

Select how the text is expanded. Can be either none, +strftime (deprecated) or +normal (default). See the Text expansion section +below for details. +

+
+
basetime
+

Set a start time for the count. Value is in microseconds. Only applied +in the deprecated strftime expansion mode. To emulate in normal expansion +mode use the pts function, supplying the start time (in seconds) +as the second argument. +

+
+
fix_bounds
+

If true, check and fix text coords to avoid clipping. +

+
+
fontcolor
+

The color to be used for drawing fonts. For the syntax of this option, check +the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+

The default value of fontcolor is "black". +

+
+
fontcolor_expr
+

String which is expanded the same way as text to obtain dynamic +fontcolor value. By default this option has empty value and is not +processed. When this option is set, it overrides fontcolor option. +

+
+
font
+

The font family to be used for drawing text. By default Sans. +

+
+
fontfile
+

The font file to be used for drawing text. The path must be included. +This parameter is mandatory if the fontconfig support is disabled. +

+
+
alpha
+

Draw the text applying alpha blending. The value can +be a number between 0.0 and 1.0. +The expression accepts the same variables x, y as well. +The default value is 1. +Please see fontcolor_expr. +

+
+
fontsize
+

The font size to be used for drawing text. +The default value of fontsize is 16. +

+
+
text_shaping
+

If set to 1, attempt to shape the text (for example, reverse the order of +right-to-left text and join Arabic characters) before drawing it. +Otherwise, just draw the text exactly as given. +By default 1 (if supported). +

+
+
ft_load_flags
+

The flags to be used for loading the fonts. +

+

The flags map the corresponding flags supported by libfreetype, and are +a combination of the following values: +

+
default
+
no_scale
+
no_hinting
+
render
+
no_bitmap
+
vertical_layout
+
force_autohint
+
crop_bitmap
+
pedantic
+
ignore_global_advance_width
+
no_recurse
+
ignore_transform
+
monochrome
+
linear_design
+
no_autohint
+
+ +

Default value is "default". +

+

For more information consult the documentation for the FT_LOAD_* +libfreetype flags. +

+
+
shadowcolor
+

The color to be used for drawing a shadow behind the drawn text. For the +syntax of this option, check the (ffmpeg-utils)"Color" section in the +ffmpeg-utils manual. +

+

The default value of shadowcolor is "black". +

+
+
shadowx
+
shadowy
+

The x and y offsets for the text shadow position with respect to the +position of the text. They can be either positive or negative +values. The default value for both is "0". +

+
+
start_number
+

The starting frame number for the n/frame_num variable. The default value +is "0". +

+
+
tabsize
+

The size in number of spaces to use for rendering the tab. +Default value is 4. +

+
+
timecode
+

Set the initial timecode representation in "hh:mm:ss[:;.]ff" +format. It can be used with or without text parameter. timecode_rate +option must be specified. +

+
+
timecode_rate, rate, r
+

Set the timecode frame rate (timecode only). Value will be rounded to nearest +integer. Minimum value is "1". +Drop-frame timecode is supported for frame rates 30 & 60. +

+
+
tc24hmax
+

If set to 1, the output of the timecode option will wrap around at 24 hours. +Default is 0 (disabled). +

+
+
text
+

The text string to be drawn. The text must be a sequence of UTF-8 +encoded characters. +This parameter is mandatory if no file is specified with the parameter +textfile. +

+
+
textfile
+

A text file containing text to be drawn. The text must be a sequence +of UTF-8 encoded characters. +

+

This parameter is mandatory if no text string is specified with the +parameter text. +

+

If both text and textfile are specified, an error is thrown. +

+
+
reload
+

If set to 1, the textfile will be reloaded before each frame. +Be sure to update it atomically, or it may be read partially, or even fail. +

+
+
x
+
y
+

The expressions which specify the offsets where text will be drawn +within the video frame. They are relative to the top/left border of the +output image. +

+

The default value of x and y is "0". +

+

See below for the list of accepted constants and functions. +

+
+ +

The parameters for x and y are expressions containing the +following constants and functions: +

+
+
dar
+

input display aspect ratio, it is the same as (w / h) * sar +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
line_h, lh
+

the height of each text line +

+
+
main_h, h, H
+

the input height +

+
+
main_w, w, W
+

the input width +

+
+
max_glyph_a, ascent
+

the maximum distance from the baseline to the highest/upper grid +coordinate used to place a glyph outline point, for all the rendered +glyphs. +It is a positive value, due to the grid’s orientation with the Y axis +upwards. +

+
+
max_glyph_d, descent
+

the maximum distance from the baseline to the lowest grid coordinate +used to place a glyph outline point, for all the rendered glyphs. +This is a negative value, due to the grid’s orientation, with the Y axis +upwards. +

+
+
max_glyph_h
+

maximum glyph height, that is the maximum height for all the glyphs +contained in the rendered text, it is equivalent to ascent - +descent. +

+
+
max_glyph_w
+

maximum glyph width, that is the maximum width for all the glyphs +contained in the rendered text +

+
+
n
+

the number of input frame, starting from 0 +

+
+
rand(min, max)
+

return a random number included between min and max +

+
+
sar
+

The input sample aspect ratio. +

+
+
t
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+
text_h, th
+

the height of the rendered text +

+
+
text_w, tw
+

the width of the rendered text +

+
+
x
+
y
+

the x and y offset coordinates where the text is drawn. +

+

These parameters allow the x and y expressions to refer +to each other, so you can for example specify y=x/dar. +

+
+
pict_type
+

A one character description of the current frame’s picture type. +

+
+
pkt_pos
+

The current packet’s position in the input file or stream +(in bytes, from the start of the input). A value of -1 indicates +this info is not available. +

+
+
pkt_duration
+

The current packet’s duration, in seconds. +

+
+
pkt_size
+

The current packet’s size (in bytes). +

+
+ + +

11.61.2 Text expansion

+ +

If expansion is set to strftime, +the filter recognizes strftime() sequences in the provided text and +expands them accordingly. Check the documentation of strftime(). This +feature is deprecated. +

+

If expansion is set to none, the text is printed verbatim. +

+

If expansion is set to normal (which is the default), +the following expansion mechanism is used. +

+

The backslash character ‘\’, followed by any character, always expands to +the second character. +

+

Sequences of the form %{...} are expanded. The text between the +braces is a function name, possibly followed by arguments separated by ’:’. +If the arguments contain special characters or delimiters (’:’ or ’}’), +they should be escaped. +

+

Note that they probably must also be escaped as the value for the +text option in the filter argument string and as the filter +argument in the filtergraph description, and possibly also for the shell, +that makes up to four levels of escaping; using a text file avoids these +problems. +

+

The following functions are available: +

+
+
expr, e
+

The expression evaluation result. +

+

It must take one argument specifying the expression to be evaluated, +which accepts the same constants and functions as the x and +y values. Note that not all constants should be used, for +example the text size is not known when evaluating the expression, so +the constants text_w and text_h will have an undefined +value. +

+
+
expr_int_format, eif
+

Evaluate the expression’s value and output as formatted integer. +

+

The first argument is the expression to be evaluated, just as for the expr function. +The second argument specifies the output format. Allowed values are ‘x’, +‘X’, ‘d’ and ‘u’. They are treated exactly as in the +printf function. +The third parameter is optional and sets the number of positions taken by the output. +It can be used to add padding with zeros from the left. +

+
+
gmtime
+

The time at which the filter is running, expressed in UTC. +It can accept an argument: a strftime() format string. +

+
+
localtime
+

The time at which the filter is running, expressed in the local time zone. +It can accept an argument: a strftime() format string. +

+
+
metadata
+

Frame metadata. Takes one or two arguments. +

+

The first argument is mandatory and specifies the metadata key. +

+

The second argument is optional and specifies a default value, used when the +metadata key is not found or empty. +

+

Available metadata can be identified by inspecting entries +starting with TAG included within each frame section +printed by running ffprobe -show_frames. +

+

String metadata generated in filters leading to +the drawtext filter are also available. +

+
+
n, frame_num
+

The frame number, starting from 0. +

+
+
pict_type
+

A one character description of the current picture type. +

+
+
pts
+

The timestamp of the current frame. +It can take up to three arguments. +

+

The first argument is the format of the timestamp; it defaults to flt +for seconds as a decimal number with microsecond accuracy; hms stands +for a formatted [-]HH:MM:SS.mmm timestamp with millisecond accuracy. +gmtime stands for the timestamp of the frame formatted as UTC time; +localtime stands for the timestamp of the frame formatted as +local time zone time. +

+

The second argument is an offset added to the timestamp. +

+

If the format is set to hms, a third argument 24HH may be +supplied to present the hour part of the formatted timestamp in 24h format +(00-23). +

+

If the format is set to localtime or gmtime, +a third argument may be supplied: a strftime() format string. +By default, YYYY-MM-DD HH:MM:SS format will be used. +

+
+ + +

11.61.3 Commands

+ +

This filter supports altering parameters via commands: +

+
reinit
+

Alter existing filter parameters. +

+

Syntax for the argument is the same as for filter invocation, e.g. +

+
+
fontsize=56:fontcolor=green:text='Hello World'
+
+ +

Full filter invocation with sendcmd would look like this: +

+
+
sendcmd=c='56.0 drawtext reinit fontsize=56\:fontcolor=green\:text=Hello\\ World'
+
+
+
+ +

If the entire argument can’t be parsed or applied as valid values then the filter will +continue with its existing parameters. +

+ +

11.61.4 Examples

+ +
    +
  • Draw "Test Text" with font FreeSerif, using the default values for the +optional parameters. + +
    +
    drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
+
    + +
  • Draw ’Test Text’ with font FreeSerif of size 24 at position x=100 +and y=50 (counting from the top-left corner of the screen), text is +yellow with a red box around it. Both the text and the box have an +opacity of 20%. + +
    +
    drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
+          x=100: y=50: fontsize=24: fontcolor=yellow@0.2: box=1: boxcolor=red@0.2"
+
    + +

    Note that the double quotes are not necessary if spaces are not used +within the parameter list. +

    +
  • Show the text at the center of the video frame: +
    +
    drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h)/2"
+
    + +
  • Show the text at a random position, switching to a new position every 30 seconds: +
    +
    drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=if(eq(mod(t\,30)\,0)\,rand(0\,(w-text_w))\,x):y=if(eq(mod(t\,30)\,0)\,rand(0\,(h-text_h))\,y)"
+
    + +
  • Show a text line sliding from right to left in the last row of the video +frame. The file LONG_LINE is assumed to contain a single line +with no newlines. +
    +
    drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
+
    + +
  • Show the content of file CREDITS off the bottom of the frame and scroll up. +
    +
    drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
+
    + +
  • Draw a single green letter "g", at the center of the input video. +The glyph baseline is placed at half screen height. +
    +
    drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
+
    + +
  • Show text for 1 second every 3 seconds: +
    +
    drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:enable=lt(mod(t\,3)\,1):text='blink'"
+
    + +
  • Use fontconfig to set the font. Note that the colons need to be escaped. +
    +
    drawtext='fontfile=Linux Libertine O-40\:style=Semibold:text=FFmpeg'
+
    + +
  • Print the date of a real-time encoding (see strftime(3)): +
    +
    drawtext='fontfile=FreeSans.ttf:text=%{localtime\:%a %b %d %Y}'
+
    + +
  • Show text fading in and out (appearing/disappearing): +
    +
    #!/bin/sh
+DS=1.0 # display start
+DE=10.0 # display end
+FID=1.5 # fade in duration
+FOD=5 # fade out duration
+ffplay -f lavfi "color,drawtext=text=TEST:fontsize=50:fontfile=FreeSerif.ttf:fontcolor_expr=ff0000%{eif\\\\: clip(255*(1*between(t\\, $DS + $FID\\, $DE - $FOD) + ((t - $DS)/$FID)*between(t\\, $DS\\, $DS + $FID) + (-(t - $DE)/$FOD)*between(t\\, $DE - $FOD\\, $DE) )\\, 0\\, 255) \\\\: x\\\\: 2 }"
+
    + +
  • Horizontally align multiple separate texts. Note that max_glyph_a +and the fontsize value are included in the y offset. +
    +
    drawtext=fontfile=FreeSans.ttf:text=DOG:fontsize=24:x=10:y=20+24-max_glyph_a,
+drawtext=fontfile=FreeSans.ttf:text=cow:fontsize=24:x=80:y=20+24-max_glyph_a
+
    + +
  • Plot special lavf.image2dec.source_basename metadata onto each frame if +such metadata exists. Otherwise, plot the string "NA". Note that image2 demuxer +must have option -export_path_metadata 1 for the special metadata fields +to be available for filters. +
    +
    drawtext="fontsize=20:fontcolor=white:fontfile=FreeSans.ttf:text='%{metadata\:lavf.image2dec.source_basename\:NA}':x=10:y=10"
+
    + +
+ +

For more information about libfreetype, check: +http://www.freetype.org/. +

+

For more information about fontconfig, check: +http://freedesktop.org/software/fontconfig/fontconfig-user.html. +

+

For more information about libfribidi, check: +http://fribidi.org/. +

+ +

11.62 edgedetect

+ +

Detect and draw edges. The filter uses the Canny Edge Detection algorithm. +

+

The filter accepts the following options: +

+
+
low
+
high
+

Set low and high threshold values used by the Canny thresholding +algorithm. +

+

The high threshold selects the "strong" edge pixels, which are then +connected through 8-connectivity with the "weak" edge pixels selected +by the low threshold. +

+

low and high threshold values must be chosen in the range +[0,1], and low should be lesser or equal to high. +

+

Default value for low is 20/255, and default value for high +is 50/255. +

+
+
mode
+

Define the drawing mode. +

+
+
‘wires’
+

Draw white/gray wires on black background. +

+
+
‘colormix’
+

Mix the colors to create a paint/cartoon effect. +

+
+
‘canny’
+

Apply Canny edge detector on all selected planes. +

+
+

Default value is wires. +

+
+
planes
+

Select planes for filtering. By default all available planes are filtered. +

+
+ + +

11.62.1 Examples

+ +
    +
  • Standard edge detection with custom values for the hysteresis thresholding: +
    +
    edgedetect=low=0.1:high=0.4
+
    + +
  • Painting effect without thresholding: +
    +
    edgedetect=mode=colormix:high=0
+
    +
+ + +

11.63 elbg

+ +

Apply a posterize effect using the ELBG (Enhanced LBG) algorithm. +

+

For each input image, the filter will compute the optimal mapping from +the input to the output given the codebook length, that is the number +of distinct output colors. +

+

This filter accepts the following options. +

+
+
codebook_length, l
+

Set codebook length. The value must be a positive integer, and +represents the number of distinct output colors. Default value is 256. +

+
+
nb_steps, n
+

Set the maximum number of iterations to apply for computing the optimal +mapping. The higher the value the better the result and the higher the +computation time. Default value is 1. +

+
+
seed, s
+

Set a random seed, must be an integer included between 0 and +UINT32_MAX. If not specified, or if explicitly set to -1, the filter +will try to use a good random seed on a best effort basis. +

+
+
pal8
+

Set pal8 output pixel format. This option does not work with codebook +length greater than 256. +

+
+ + +

11.64 entropy

+ +

Measure graylevel entropy in histogram of color channels of video frames. +

+

It accepts the following parameters: +

+
+
mode
+

Can be either normal or diff. Default is normal. +

+

diff mode measures entropy of histogram delta values, absolute differences +between neighbour histogram values. +

+
+ + +

11.65 eq

+

Set brightness, contrast, saturation and approximate gamma adjustment. +

+

The filter accepts the following options: +

+
+
contrast
+

Set the contrast expression. The value must be a float value in range +-1000.0 to 1000.0. The default value is "1". +

+
+
brightness
+

Set the brightness expression. The value must be a float value in +range -1.0 to 1.0. The default value is "0". +

+
+
saturation
+

Set the saturation expression. The value must be a float in +range 0.0 to 3.0. The default value is "1". +

+
+
gamma
+

Set the gamma expression. The value must be a float in range +0.1 to 10.0. The default value is "1". +

+
+
gamma_r
+

Set the gamma expression for red. The value must be a float in +range 0.1 to 10.0. The default value is "1". +

+
+
gamma_g
+

Set the gamma expression for green. The value must be a float in range +0.1 to 10.0. The default value is "1". +

+
+
gamma_b
+

Set the gamma expression for blue. The value must be a float in range +0.1 to 10.0. The default value is "1". +

+
+
gamma_weight
+

Set the gamma weight expression. It can be used to reduce the effect +of a high gamma value on bright image areas, e.g. keep them from +getting overamplified and just plain white. The value must be a float +in range 0.0 to 1.0. A value of 0.0 turns the +gamma correction all the way down while 1.0 leaves it at its +full strength. Default is "1". +

+
+
eval
+

Set when the expressions for brightness, contrast, saturation and +gamma expressions are evaluated. +

+

It accepts the following values: +

+
‘init’
+

only evaluate expressions once during the filter initialization or +when a command is processed +

+
+
‘frame’
+

evaluate expressions for each incoming frame +

+
+ +

Default value is ‘init’. +

+
+ +

The expressions accept the following parameters: +

+
n
+

frame count of the input frame starting from 0 +

+
+
pos
+

byte position of the corresponding packet in the input file, NAN if +unspecified +

+
+
r
+

frame rate of the input video, NAN if the input frame rate is unknown +

+
+
t
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+ + +

11.65.1 Commands

+

The filter supports the following commands: +

+
+
contrast
+

Set the contrast expression. +

+
+
brightness
+

Set the brightness expression. +

+
+
saturation
+

Set the saturation expression. +

+
+
gamma
+

Set the gamma expression. +

+
+
gamma_r
+

Set the gamma_r expression. +

+
+
gamma_g
+

Set gamma_g expression. +

+
+
gamma_b
+

Set gamma_b expression. +

+
+
gamma_weight
+

Set gamma_weight expression. +

+

The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+
+ + +

11.66 erosion

+ +

Apply erosion effect to the video. +

+

This filter replaces the pixel by the local(3x3) minimum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. Default is 255 i.e. all eight +pixels are used. +

+

Flags to local 3x3 coordinates maps like this: +

+

1 2 3 + 4 5 + 6 7 8 +

+
+ + +

11.66.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

11.67 extractplanes

+ +

Extract color channel components from input video stream into +separate grayscale video streams. +

+

The filter accepts the following option: +

+
+
planes
+

Set plane(s) to extract. +

+

Available values for planes are: +

+
‘y’
+
‘u’
+
‘v’
+
‘a’
+
‘r’
+
‘g’
+
‘b’
+
+ +

Choosing planes not available in the input will result in an error. +That means you cannot select r, g, b planes +with y, u, v planes at same time. +

+
+ + +

11.67.1 Examples

+ +
    +
  • Extract luma, u and v color channel component from input video frame +into 3 grayscale outputs: +
    +
    ffmpeg -i video.avi -filter_complex 'extractplanes=y+u+v[y][u][v]' -map '[y]' y.avi -map '[u]' u.avi -map '[v]' v.avi
+
    +
+ + +

11.68 fade

+ +

Apply a fade-in/out effect to the input video. +

+

It accepts the following parameters: +

+
+
type, t
+

The effect type can be either "in" for a fade-in, or "out" for a fade-out +effect. +Default is in. +

+
+
start_frame, s
+

Specify the number of the frame to start applying the fade +effect at. Default is 0. +

+
+
nb_frames, n
+

The number of frames that the fade effect lasts. At the end of the +fade-in effect, the output video will have the same intensity as the input video. +At the end of the fade-out transition, the output video will be filled with the +selected color. +Default is 25. +

+
+
alpha
+

If set to 1, fade only alpha channel, if one exists on the input. +Default value is 0. +

+
+
start_time, st
+

Specify the timestamp (in seconds) of the frame to start to apply the fade +effect. If both start_frame and start_time are specified, the fade will start at +whichever comes last. Default is 0. +

+
+
duration, d
+

The number of seconds for which the fade effect has to last. At the end of the +fade-in effect the output video will have the same intensity as the input video, +at the end of the fade-out transition the output video will be filled with the +selected color. +If both duration and nb_frames are specified, duration is used. Default is 0 +(nb_frames is used by default). +

+
+
color, c
+

Specify the color of the fade. Default is "black". +

+
+ + +

11.68.1 Examples

+ +
    +
  • Fade in the first 30 frames of video: +
    +
    fade=in:0:30
+
    + +

    The command above is equivalent to: +

    +
    fade=t=in:s=0:n=30
+
    + +
  • Fade out the last 45 frames of a 200-frame video: +
    +
    fade=out:155:45
+fade=type=out:start_frame=155:nb_frames=45
+
    + +
  • Fade in the first 25 frames and fade out the last 25 frames of a 1000-frame video: +
    +
    fade=in:0:25, fade=out:975:25
+
    + +
  • Make the first 5 frames yellow, then fade in from frame 5-24: +
    +
    fade=in:5:20:color=yellow
+
    + +
  • Fade in alpha over first 25 frames of video: +
    +
    fade=in:0:25:alpha=1
+
    + +
  • Make the first 5.5 seconds black, then fade in for 0.5 seconds: +
    +
    fade=t=in:st=5.5:d=0.5
+
    + +
+ + +

11.69 fftdnoiz

+

Denoise frames using 3D FFT (frequency domain filtering). +

+

The filter accepts the following options: +

+
+
sigma
+

Set the noise sigma constant. This sets denoising strength. +Default value is 1. Allowed range is from 0 to 30. +Using very high sigma with low overlap may give blocking artifacts. +

+
+
amount
+

Set amount of denoising. By default all detected noise is reduced. +Default value is 1. Allowed range is from 0 to 1. +

+
+
block
+

Set size of block, Default is 4, can be 3, 4, 5 or 6. +Actual size of block in pixels is 2 to power of block, so by default +block size in pixels is 2^4 which is 16. +

+
+
overlap
+

Set block overlap. Default is 0.5. Allowed range is from 0.2 to 0.8. +

+
+
prev
+

Set number of previous frames to use for denoising. By default is set to 0. +

+
+
next
+

Set number of next frames to to use for denoising. By default is set to 0. +

+
+
planes
+

Set planes which will be filtered, by default are all available filtered +except alpha. +

+
+ + +

11.70 fftfilt

+

Apply arbitrary expressions to samples in frequency domain +

+
+
dc_Y
+

Adjust the dc value (gain) of the luma plane of the image. The filter +accepts an integer value in range 0 to 1000. The default +value is set to 0. +

+
+
dc_U
+

Adjust the dc value (gain) of the 1st chroma plane of the image. The +filter accepts an integer value in range 0 to 1000. The +default value is set to 0. +

+
+
dc_V
+

Adjust the dc value (gain) of the 2nd chroma plane of the image. The +filter accepts an integer value in range 0 to 1000. The +default value is set to 0. +

+
+
weight_Y
+

Set the frequency domain weight expression for the luma plane. +

+
+
weight_U
+

Set the frequency domain weight expression for the 1st chroma plane. +

+
+
weight_V
+

Set the frequency domain weight expression for the 2nd chroma plane. +

+
+
eval
+

Set when the expressions are evaluated. +

+

It accepts the following values: +

+
‘init’
+

Only evaluate expressions once during the filter initialization. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. +

+
+ +

Default value is ‘init’. +

+

The filter accepts the following variables: +

+
X
+
Y
+

The coordinates of the current sample. +

+
+
W
+
H
+

The width and height of the image. +

+
+
N
+

The number of input frame, starting from 0. +

+
+ + +

11.70.1 Examples

+ +
    +
  • High-pass: +
    +
    fftfilt=dc_Y=128:weight_Y='squish(1-(Y+X)/100)'
+
    + +
  • Low-pass: +
    +
    fftfilt=dc_Y=0:weight_Y='squish((Y+X)/100-1)'
+
    + +
  • Sharpen: +
    +
    fftfilt=dc_Y=0:weight_Y='1+squish(1-(Y+X)/100)'
+
    + +
  • Blur: +
    +
    fftfilt=dc_Y=0:weight_Y='exp(-4 * ((Y+X)/(W+H)))'
+
    + +
+ + +

11.71 field

+ +

Extract a single field from an interlaced image using stride +arithmetic to avoid wasting CPU time. The output frames are marked as +non-interlaced. +

+

The filter accepts the following options: +

+
+
type
+

Specify whether to extract the top (if the value is 0 or +top) or the bottom field (if the value is 1 or +bottom). +

+
+ + +

11.72 fieldhint

+ +

Create new frames by copying the top and bottom fields from surrounding frames +supplied as numbers by the hint file. +

+
+
hint
+

Set file containing hints: absolute/relative frame numbers. +

+

There must be one line for each frame in a clip. Each line must contain two +numbers separated by the comma, optionally followed by - or +. +Numbers supplied on each line of file can not be out of [N-1,N+1] where N +is current frame number for absolute mode or out of [-1, 1] range +for relative mode. First number tells from which frame to pick up top +field and second number tells from which frame to pick up bottom field. +

+

If optionally followed by + output frame will be marked as interlaced, +else if followed by - output frame will be marked as progressive, else +it will be marked same as input frame. +If optionally followed by t output frame will use only top field, or in +case of b it will use only bottom field. +If line starts with # or ; that line is skipped. +

+
+
mode
+

Can be item absolute or relative. Default is absolute. +

+
+ +

Example of first several lines of hint file for relative mode: +

+
0,0 - # first frame
+1,0 - # second frame, use third's frame top field and second's frame bottom field
+1,0 - # third frame, use fourth's frame top field and third's frame bottom field
+1,0 -
+0,0 -
+0,0 -
+1,0 -
+1,0 -
+1,0 -
+0,0 -
+0,0 -
+1,0 -
+1,0 -
+1,0 -
+0,0 -
+
+ + +

11.73 fieldmatch

+ +

Field matching filter for inverse telecine. It is meant to reconstruct the +progressive frames from a telecined stream. The filter does not drop duplicated +frames, so to achieve a complete inverse telecine fieldmatch needs to be +followed by a decimation filter such as decimate in the filtergraph. +

+

The separation of the field matching and the decimation is notably motivated by +the possibility of inserting a de-interlacing filter fallback between the two. +If the source has mixed telecined and real interlaced content, +fieldmatch will not be able to match fields for the interlaced parts. +But these remaining combed frames will be marked as interlaced, and thus can be +de-interlaced by a later filter such as yadif before decimation. +

+

In addition to the various configuration options, fieldmatch can take an +optional second stream, activated through the ppsrc option. If +enabled, the frames reconstruction will be based on the fields and frames from +this second stream. This allows the first input to be pre-processed in order to +help the various algorithms of the filter, while keeping the output lossless +(assuming the fields are matched properly). Typically, a field-aware denoiser, +or brightness/contrast adjustments can help. +

+

Note that this filter uses the same algorithms as TIVTC/TFM (AviSynth project) +and VIVTC/VFM (VapourSynth project). The later is a light clone of TFM from +which fieldmatch is based on. While the semantic and usage are very +close, some behaviour and options names can differ. +

+

The decimate filter currently only works for constant frame rate input. +If your input has mixed telecined (30fps) and progressive content with a lower +framerate like 24fps use the following filterchain to produce the necessary cfr +stream: dejudder,fps=30000/1001,fieldmatch,decimate. +

+

The filter accepts the following options: +

+
+
order
+

Specify the assumed field order of the input stream. Available values are: +

+
+
‘auto’
+

Auto detect parity (use FFmpeg’s internal parity value). +

+
‘bff’
+

Assume bottom field first. +

+
‘tff’
+

Assume top field first. +

+
+ +

Note that it is sometimes recommended not to trust the parity announced by the +stream. +

+

Default value is auto. +

+
+
mode
+

Set the matching mode or strategy to use. pc mode is the safest in the +sense that it won’t risk creating jerkiness due to duplicate frames when +possible, but if there are bad edits or blended fields it will end up +outputting combed frames when a good match might actually exist. On the other +hand, pcn_ub mode is the most risky in terms of creating jerkiness, +but will almost always find a good frame if there is one. The other values are +all somewhere in between pc and pcn_ub in terms of risking +jerkiness and creating duplicate frames versus finding good matches in sections +with bad edits, orphaned fields, blended fields, etc. +

+

More details about p/c/n/u/b are available in p/c/n/u/b meaning section. +

+

Available values are: +

+
+
‘pc’
+

2-way matching (p/c) +

+
‘pc_n’
+

2-way matching, and trying 3rd match if still combed (p/c + n) +

+
‘pc_u’
+

2-way matching, and trying 3rd match (same order) if still combed (p/c + u) +

+
‘pc_n_ub’
+

2-way matching, trying 3rd match if still combed, and trying 4th/5th matches if +still combed (p/c + n + u/b) +

+
‘pcn’
+

3-way matching (p/c/n) +

+
‘pcn_ub’
+

3-way matching, and trying 4th/5th matches if all 3 of the original matches are +detected as combed (p/c/n + u/b) +

+
+ +

The parenthesis at the end indicate the matches that would be used for that +mode assuming order=tff (and field on auto or +top). +

+

In terms of speed pc mode is by far the fastest and pcn_ub is +the slowest. +

+

Default value is pc_n. +

+
+
ppsrc
+

Mark the main input stream as a pre-processed input, and enable the secondary +input stream as the clean source to pick the fields from. See the filter +introduction for more details. It is similar to the clip2 feature from +VFM/TFM. +

+

Default value is 0 (disabled). +

+
+
field
+

Set the field to match from. It is recommended to set this to the same value as +order unless you experience matching failures with that setting. In +certain circumstances changing the field that is used to match from can have a +large impact on matching performance. Available values are: +

+
+
‘auto’
+

Automatic (same value as order). +

+
‘bottom’
+

Match from the bottom field. +

+
‘top’
+

Match from the top field. +

+
+ +

Default value is auto. +

+
+
mchroma
+

Set whether or not chroma is included during the match comparisons. In most +cases it is recommended to leave this enabled. You should set this to 0 +only if your clip has bad chroma problems such as heavy rainbowing or other +artifacts. Setting this to 0 could also be used to speed things up at +the cost of some accuracy. +

+

Default value is 1. +

+
+
y0
+
y1
+

These define an exclusion band which excludes the lines between y0 and +y1 from being included in the field matching decision. An exclusion +band can be used to ignore subtitles, a logo, or other things that may +interfere with the matching. y0 sets the starting scan line and +y1 sets the ending line; all lines in between y0 and +y1 (including y0 and y1) will be ignored. Setting +y0 and y1 to the same value will disable the feature. +y0 and y1 defaults to 0. +

+
+
scthresh
+

Set the scene change detection threshold as a percentage of maximum change on +the luma plane. Good values are in the [8.0, 14.0] range. Scene change +detection is only relevant in case combmatch=sc. The range for +scthresh is [0.0, 100.0]. +

+

Default value is 12.0. +

+
+
combmatch
+

When combatch is not none, fieldmatch will take into +account the combed scores of matches when deciding what match to use as the +final match. Available values are: +

+
+
‘none’
+

No final matching based on combed scores. +

+
‘sc’
+

Combed scores are only used when a scene change is detected. +

+
‘full’
+

Use combed scores all the time. +

+
+ +

Default is sc. +

+
+
combdbg
+

Force fieldmatch to calculate the combed metrics for certain matches and +print them. This setting is known as micout in TFM/VFM vocabulary. +Available values are: +

+
+
‘none’
+

No forced calculation. +

+
‘pcn’
+

Force p/c/n calculations. +

+
‘pcnub’
+

Force p/c/n/u/b calculations. +

+
+ +

Default value is none. +

+
+
cthresh
+

This is the area combing threshold used for combed frame detection. This +essentially controls how "strong" or "visible" combing must be to be detected. +Larger values mean combing must be more visible and smaller values mean combing +can be less visible or strong and still be detected. Valid settings are from +-1 (every pixel will be detected as combed) to 255 (no pixel will +be detected as combed). This is basically a pixel difference value. A good +range is [8, 12]. +

+

Default value is 9. +

+
+
chroma
+

Sets whether or not chroma is considered in the combed frame decision. Only +disable this if your source has chroma problems (rainbowing, etc.) that are +causing problems for the combed frame detection with chroma enabled. Actually, +using chroma=0 is usually more reliable, except for the case +where there is chroma only combing in the source. +

+

Default value is 0. +

+
+
blockx
+
blocky
+

Respectively set the x-axis and y-axis size of the window used during combed +frame detection. This has to do with the size of the area in which +combpel pixels are required to be detected as combed for a frame to be +declared combed. See the combpel parameter description for more info. +Possible values are any number that is a power of 2 starting at 4 and going up +to 512. +

+

Default value is 16. +

+
+
combpel
+

The number of combed pixels inside any of the blocky by +blockx size blocks on the frame for the frame to be detected as +combed. While cthresh controls how "visible" the combing must be, this +setting controls "how much" combing there must be in any localized area (a +window defined by the blockx and blocky settings) on the +frame. Minimum value is 0 and maximum is blocky x blockx (at +which point no frames will ever be detected as combed). This setting is known +as MI in TFM/VFM vocabulary. +

+

Default value is 80. +

+
+ + +

11.73.1 p/c/n/u/b meaning

+ + +

11.73.1.1 p/c/n

+ +

We assume the following telecined stream: +

+
+
Top fields:     1 2 2 3 4
+Bottom fields:  1 2 3 4 4
+
+ +

The numbers correspond to the progressive frame the fields relate to. Here, the +first two frames are progressive, the 3rd and 4th are combed, and so on. +

+

When fieldmatch is configured to run a matching from bottom +(field=bottom) this is how this input stream get transformed: +

+
+
Input stream:
+                T     1 2 2 3 4
+                B     1 2 3 4 4   <-- matching reference
+
+Matches:              c c n n c
+
+Output stream:
+                T     1 2 3 4 4
+                B     1 2 3 4 4
+
+ +

As a result of the field matching, we can see that some frames get duplicated. +To perform a complete inverse telecine, you need to rely on a decimation filter +after this operation. See for instance the decimate filter. +

+

The same operation now matching from top fields (field=top) +looks like this: +

+
+
Input stream:
+                T     1 2 2 3 4   <-- matching reference
+                B     1 2 3 4 4
+
+Matches:              c c p p c
+
+Output stream:
+                T     1 2 2 3 4
+                B     1 2 2 3 4
+
+ +

In these examples, we can see what p, c and n mean; +basically, they refer to the frame and field of the opposite parity: +

+
    +
  • p matches the field of the opposite parity in the previous frame +
  • c matches the field of the opposite parity in the current frame +
  • n matches the field of the opposite parity in the next frame +
+ + +

11.73.1.2 u/b

+ +

The u and b matching are a bit special in the sense that they match +from the opposite parity flag. In the following examples, we assume that we are +currently matching the 2nd frame (Top:2, bottom:2). According to the match, a +’x’ is placed above and below each matched fields. +

+

With bottom matching (field=bottom): +

+
Match:           c         p           n          b          u
+
+                 x       x               x        x          x
+  Top          1 2 2     1 2 2       1 2 2      1 2 2      1 2 2
+  Bottom       1 2 3     1 2 3       1 2 3      1 2 3      1 2 3
+                 x         x           x        x              x
+
+Output frames:
+                 2          1          2          2          2
+                 2          2          2          1          3
+
+ +

With top matching (field=top): +

+
Match:           c         p           n          b          u
+
+                 x         x           x        x              x
+  Top          1 2 2     1 2 2       1 2 2      1 2 2      1 2 2
+  Bottom       1 2 3     1 2 3       1 2 3      1 2 3      1 2 3
+                 x       x               x        x          x
+
+Output frames:
+                 2          2          2          1          2
+                 2          1          3          2          2
+
+ + +

11.73.2 Examples

+ +

Simple IVTC of a top field first telecined stream: +

+
fieldmatch=order=tff:combmatch=none, decimate
+
+ +

Advanced IVTC, with fallback on yadif for still combed frames: +

+
fieldmatch=order=tff:combmatch=full, yadif=deint=interlaced, decimate
+
+ + +

11.74 fieldorder

+ +

Transform the field order of the input video. +

+

It accepts the following parameters: +

+
+
order
+

The output field order. Valid values are tff for top field first or bff +for bottom field first. +

+
+ +

The default value is ‘tff’. +

+

The transformation is done by shifting the picture content up or down +by one line, and filling the remaining line with appropriate picture content. +This method is consistent with most broadcast field order converters. +

+

If the input video is not flagged as being interlaced, or it is already +flagged as being of the required output field order, then this filter does +not alter the incoming video. +

+

It is very useful when converting to or from PAL DV material, +which is bottom field first. +

+

For example: +

+
ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
+
+ + +

11.75 fifo, afifo

+ +

Buffer input images and send them when they are requested. +

+

It is mainly useful when auto-inserted by the libavfilter +framework. +

+

It does not take parameters. +

+ +

11.76 fillborders

+ +

Fill borders of the input video, without changing video stream dimensions. +Sometimes video can have garbage at the four edges and you may not want to +crop video input to keep size multiple of some number. +

+

This filter accepts the following options: +

+
+
left
+

Number of pixels to fill from left border. +

+
+
right
+

Number of pixels to fill from right border. +

+
+
top
+

Number of pixels to fill from top border. +

+
+
bottom
+

Number of pixels to fill from bottom border. +

+
+
mode
+

Set fill mode. +

+

It accepts the following values: +

+
‘smear’
+

fill pixels using outermost pixels +

+
+
‘mirror’
+

fill pixels using mirroring +

+
+
‘fixed’
+

fill pixels with constant value +

+
+ +

Default is smear. +

+
+
color
+

Set color for pixels in fixed mode. Default is black. +

+
+ + +

11.76.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.77 find_rect

+ +

Find a rectangular object +

+

It accepts the following options: +

+
+
object
+

Filepath of the object image, needs to be in gray8. +

+
+
threshold
+

Detection threshold, default is 0.5. +

+
+
mipmaps
+

Number of mipmaps, default is 3. +

+
+
xmin, ymin, xmax, ymax
+

Specifies the rectangle in which to search. +

+
+ + +

11.77.1 Examples

+ +
    +
  • Cover a rectangular object by the supplied image of a given video using ffmpeg: +
    +
    ffmpeg -i file.ts -vf find_rect=newref.pgm,cover_rect=cover.jpg:mode=cover new.mkv
+
    +
+ + +

11.78 floodfill

+ +

Flood area with values of same pixel components with another values. +

+

It accepts the following options: +

+
x
+

Set pixel x coordinate. +

+
+
y
+

Set pixel y coordinate. +

+
+
s0
+

Set source #0 component value. +

+
+
s1
+

Set source #1 component value. +

+
+
s2
+

Set source #2 component value. +

+
+
s3
+

Set source #3 component value. +

+
+
d0
+

Set destination #0 component value. +

+
+
d1
+

Set destination #1 component value. +

+
+
d2
+

Set destination #2 component value. +

+
+
d3
+

Set destination #3 component value. +

+
+ + +

11.79 format

+ +

Convert the input video to one of the specified pixel formats. +Libavfilter will try to pick one that is suitable as input to +the next filter. +

+

It accepts the following parameters: +

+
pix_fmts
+

A ’|’-separated list of pixel format names, such as +"pix_fmts=yuv420p|monow|rgb24". +

+
+
+ + +

11.79.1 Examples

+ +
    +
  • Convert the input video to the yuv420p format +
    +
    format=pix_fmts=yuv420p
+
    + +

    Convert the input video to any of the formats in the list +

    +
    format=pix_fmts=yuv420p|yuv444p|yuv410p
+
    +
+ + +

11.80 fps

+ +

Convert the video to specified constant frame rate by duplicating or dropping +frames as necessary. +

+

It accepts the following parameters: +

+
fps
+

The desired output frame rate. The default is 25. +

+
+
start_time
+

Assume the first PTS should be the given value, in seconds. This allows for +padding/trimming at the start of stream. By default, no assumption is made +about the first frame’s expected PTS, so no padding or trimming is done. +For example, this could be set to 0 to pad the beginning with duplicates of +the first frame if a video stream starts after the audio stream or to trim any +frames with a negative PTS. +

+
+
round
+

Timestamp (PTS) rounding method. +

+

Possible values are: +

+
zero
+

round towards 0 +

+
inf
+

round away from 0 +

+
down
+

round towards -infinity +

+
up
+

round towards +infinity +

+
near
+

round to nearest +

+
+

The default is near. +

+
+
eof_action
+

Action performed when reading the last frame. +

+

Possible values are: +

+
round
+

Use same timestamp rounding method as used for other frames. +

+
pass
+

Pass through last frame if input duration has not been reached yet. +

+
+

The default is round. +

+
+
+ +

Alternatively, the options can be specified as a flat string: +fps[:start_time[:round]]. +

+

See also the setpts filter. +

+ +

11.80.1 Examples

+ +
    +
  • A typical usage in order to set the fps to 25: +
    +
    fps=fps=25
+
    + +
  • Sets the fps to 24, using abbreviation and rounding method to round to nearest: +
    +
    fps=fps=film:round=near
+
    +
+ + +

11.81 framepack

+ +

Pack two different video streams into a stereoscopic video, setting proper +metadata on supported codecs. The two views should have the same size and +framerate and processing will stop when the shorter video ends. Please note +that you may conveniently adjust view properties with the scale and +fps filters. +

+

It accepts the following parameters: +

+
format
+

The desired packing format. Supported values are: +

+
+
sbs
+

The views are next to each other (default). +

+
+
tab
+

The views are on top of each other. +

+
+
lines
+

The views are packed by line. +

+
+
columns
+

The views are packed by column. +

+
+
frameseq
+

The views are temporally interleaved. +

+
+
+ +
+
+ +

Some examples: +

+
+
# Convert left and right views into a frame-sequential video
+ffmpeg -i LEFT -i RIGHT -filter_complex framepack=frameseq OUTPUT
+
+# Convert views into a side-by-side video with the same output resolution as the input
+ffmpeg -i LEFT -i RIGHT -filter_complex [0:v]scale=w=iw/2[left],[1:v]scale=w=iw/2[right],[left][right]framepack=sbs OUTPUT
+
+ + +

11.82 framerate

+ +

Change the frame rate by interpolating new video output frames from the source +frames. +

+

This filter is not designed to function correctly with interlaced media. If +you wish to change the frame rate of interlaced media then you are required +to deinterlace before this filter and re-interlace after this filter. +

+

A description of the accepted options follows. +

+
+
fps
+

Specify the output frames per second. This option can also be specified +as a value alone. The default is 50. +

+
+
interp_start
+

Specify the start of a range where the output frame will be created as a +linear interpolation of two frames. The range is [0-255], +the default is 15. +

+
+
interp_end
+

Specify the end of a range where the output frame will be created as a +linear interpolation of two frames. The range is [0-255], +the default is 240. +

+
+
scene
+

Specify the level at which a scene change is detected as a value between +0 and 100 to indicate a new scene; a low value reflects a low +probability for the current frame to introduce a new scene, while a higher +value means the current frame is more likely to be one. +The default is 8.2. +

+
+
flags
+

Specify flags influencing the filter process. +

+

Available value for flags is: +

+
+
scene_change_detect, scd
+

Enable scene change detection using the value of the option scene. +This flag is enabled by default. +

+
+
+
+ + +

11.83 framestep

+ +

Select one frame every N-th frame. +

+

This filter accepts the following option: +

+
step
+

Select frame after every step frames. +Allowed values are positive integers higher than 0. Default value is 1. +

+
+ + +

11.84 freezedetect

+ +

Detect frozen video. +

+

This filter logs a message and sets frame metadata when it detects that the +input video has no significant change in content during a specified duration. +Video freeze detection calculates the mean average absolute difference of all +the components of video frames and compares it to a noise floor. +

+

The printed times and duration are expressed in seconds. The +lavfi.freezedetect.freeze_start metadata key is set on the first frame +whose timestamp equals or exceeds the detection duration and it contains the +timestamp of the first frame of the freeze. The +lavfi.freezedetect.freeze_duration and +lavfi.freezedetect.freeze_end metadata keys are set on the first frame +after the freeze. +

+

The filter accepts the following options: +

+
+
noise, n
+

Set noise tolerance. Can be specified in dB (in case "dB" is appended to the +specified value) or as a difference ratio between 0 and 1. Default is -60dB, or +0.001. +

+
+
duration, d
+

Set freeze duration until notification (default is 2 seconds). +

+
+ + +

11.85 freezeframes

+ +

Freeze video frames. +

+

This filter freezes video frames using frame from 2nd input. +

+

The filter accepts the following options: +

+
+
first
+

Set number of first frame from which to start freeze. +

+
+
last
+

Set number of last frame from which to end freeze. +

+
+
replace
+

Set number of frame from 2nd input which will be used instead of replaced frames. +

+
+ + +

11.86 frei0r

+ +

Apply a frei0r effect to the input video. +

+

To enable the compilation of this filter, you need to install the frei0r +header and configure FFmpeg with --enable-frei0r. +

+

It accepts the following parameters: +

+
+
filter_name
+

The name of the frei0r effect to load. If the environment variable +FREI0R_PATH is defined, the frei0r effect is searched for in each of the +directories specified by the colon-separated list in FREI0R_PATH. +Otherwise, the standard frei0r paths are searched, in this order: +HOME/.frei0r-1/lib/, /usr/local/lib/frei0r-1/, +/usr/lib/frei0r-1/. +

+
+
filter_params
+

A ’|’-separated list of parameters to pass to the frei0r effect. +

+
+
+ +

A frei0r effect parameter can be a boolean (its value is either +"y" or "n"), a double, a color (specified as +R/G/B, where R, G, and B are floating point +numbers between 0.0 and 1.0, inclusive) or a color description as specified in the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual, +a position (specified as X/Y, where +X and Y are floating point numbers) and/or a string. +

+

The number and types of parameters depend on the loaded effect. If an +effect parameter is not specified, the default value is set. +

+ +

11.86.1 Examples

+ +
    +
  • Apply the distort0r effect, setting the first two double parameters: +
    +
    frei0r=filter_name=distort0r:filter_params=0.5|0.01
+
    + +
  • Apply the colordistance effect, taking a color as the first parameter: +
    +
    frei0r=colordistance:0.2/0.3/0.4
+frei0r=colordistance:violet
+frei0r=colordistance:0x112233
+
    + +
  • Apply the perspective effect, specifying the top left and top right image +positions: +
    +
    frei0r=perspective:0.2/0.2|0.8/0.2
+
    +
+ +

For more information, see +http://frei0r.dyne.org +

+ +

11.87 fspp

+ +

Apply fast and simple postprocessing. It is a faster version of spp. +

+

It splits (I)DCT into horizontal/vertical passes. Unlike the simple post- +processing filter, one of them is performed once per block, not per pixel. +This allows for much higher speed. +

+

The filter accepts the following options: +

+
+
quality
+

Set quality. This option defines the number of levels for averaging. It accepts +an integer in the range 4-5. Default value is 4. +

+
+
qp
+

Force a constant quantization parameter. It accepts an integer in range 0-63. +If not set, the filter will use the QP from the video stream (if available). +

+
+
strength
+

Set filter strength. It accepts an integer in range -15 to 32. Lower values mean +more details but also more artifacts, while higher values make the image smoother +but also blurrier. Default value is 0 − PSNR optimal. +

+
+
use_bframe_qp
+

Enable the use of the QP from the B-Frames if set to 1. Using this +option may cause flicker since the B-Frames have often larger QP. Default is +0 (not enabled). +

+
+
+ + +

11.88 gblur

+ +

Apply Gaussian blur filter. +

+

The filter accepts the following options: +

+
+
sigma
+

Set horizontal sigma, standard deviation of Gaussian blur. Default is 0.5. +

+
+
steps
+

Set number of steps for Gaussian approximation. Default is 1. +

+
+
planes
+

Set which planes to filter. By default all planes are filtered. +

+
+
sigmaV
+

Set vertical sigma, if negative it will be same as sigma. +Default is -1. +

+
+ + +

11.88.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.89 geq

+ +

Apply generic equation to each pixel. +

+

The filter accepts the following options: +

+
+
lum_expr, lum
+

Set the luminance expression. +

+
cb_expr, cb
+

Set the chrominance blue expression. +

+
cr_expr, cr
+

Set the chrominance red expression. +

+
alpha_expr, a
+

Set the alpha expression. +

+
red_expr, r
+

Set the red expression. +

+
green_expr, g
+

Set the green expression. +

+
blue_expr, b
+

Set the blue expression. +

+
+ +

The colorspace is selected according to the specified options. If one +of the lum_expr, cb_expr, or cr_expr +options is specified, the filter will automatically select a YCbCr +colorspace. If one of the red_expr, green_expr, or +blue_expr options is specified, it will select an RGB +colorspace. +

+

If one of the chrominance expression is not defined, it falls back on the other +one. If no alpha expression is specified it will evaluate to opaque value. +If none of chrominance expressions are specified, they will evaluate +to the luminance expression. +

+

The expressions can use the following variables and functions: +

+
+
N
+

The sequential number of the filtered frame, starting from 0. +

+
+
X
+
Y
+

The coordinates of the current sample. +

+
+
W
+
H
+

The width and height of the image. +

+
+
SW
+
SH
+

Width and height scale depending on the currently filtered plane. It is the +ratio between the corresponding luma plane number of pixels and the current +plane ones. E.g. for YUV4:2:0 the values are 1,1 for the luma plane, and +0.5,0.5 for chroma planes. +

+
+
T
+

Time of the current frame, expressed in seconds. +

+
+
p(x, y)
+

Return the value of the pixel at location (x,y) of the current +plane. +

+
+
lum(x, y)
+

Return the value of the pixel at location (x,y) of the luminance +plane. +

+
+
cb(x, y)
+

Return the value of the pixel at location (x,y) of the +blue-difference chroma plane. Return 0 if there is no such plane. +

+
+
cr(x, y)
+

Return the value of the pixel at location (x,y) of the +red-difference chroma plane. Return 0 if there is no such plane. +

+
+
r(x, y)
+
g(x, y)
+
b(x, y)
+

Return the value of the pixel at location (x,y) of the +red/green/blue component. Return 0 if there is no such component. +

+
+
alpha(x, y)
+

Return the value of the pixel at location (x,y) of the alpha +plane. Return 0 if there is no such plane. +

+
+
psum(x,y), lumsum(x, y), cbsum(x,y), crsum(x,y), rsum(x,y), gsum(x,y), bsum(x,y), alphasum(x,y)
+

Sum of sample values in the rectangle from (0,0) to (x,y), this allows obtaining +sums of samples within a rectangle. See the functions without the sum postfix. +

+
+
interpolation
+

Set one of interpolation methods: +

+
nearest, n
+
bilinear, b
+
+

Default is bilinear. +

+
+ +

For functions, if x and y are outside the area, the value will be +automatically clipped to the closer edge. +

+

Please note that this filter can use multiple threads in which case each slice +will have its own expression state. If you want to use only a single expression +state because your expressions depend on previous state then you should limit +the number of filter threads to 1. +

+ +

11.89.1 Examples

+ +
    +
  • Flip the image horizontally: +
    +
    geq=p(W-X\,Y)
+
    + +
  • Generate a bidimensional sine wave, with angle PI/3 and a +wavelength of 100 pixels: +
    +
    geq=128 + 100*sin(2*(PI/100)*(cos(PI/3)*(X-50*T) + sin(PI/3)*Y)):128:128
+
    + +
  • Generate a fancy enigmatic moving light: +
    +
    nullsrc=s=256x256,geq=random(1)/hypot(X-cos(N*0.07)*W/2-W/2\,Y-sin(N*0.09)*H/2-H/2)^2*1000000*sin(N*0.02):128:128
+
    + +
  • Generate a quick emboss effect: +
    +
    format=gray,geq=lum_expr='(p(X,Y)+(256-p(X-4,Y-4)))/2'
+
    + +
  • Modify RGB components depending on pixel position: +
    +
    geq=r='X/W*r(X,Y)':g='(1-X/W)*g(X,Y)':b='(H-Y)/H*b(X,Y)'
+
    + +
  • Create a radial gradient that is the same size as the input (also see +the vignette filter): +
    +
    geq=lum=255*gauss((X/W-0.5)*3)*gauss((Y/H-0.5)*3)/gauss(0)/gauss(0),format=gray
+
    +
+ + +

11.90 gradfun

+ +

Fix the banding artifacts that are sometimes introduced into nearly flat +regions by truncation to 8-bit color depth. +Interpolate the gradients that should go where the bands are, and +dither them. +

+

It is designed for playback only. Do not use it prior to +lossy compression, because compression tends to lose the dither and +bring back the bands. +

+

It accepts the following parameters: +

+
+
strength
+

The maximum amount by which the filter will change any one pixel. This is also +the threshold for detecting nearly flat regions. Acceptable values range from +.51 to 64; the default value is 1.2. Out-of-range values will be clipped to the +valid range. +

+
+
radius
+

The neighborhood to fit the gradient to. A larger radius makes for smoother +gradients, but also prevents the filter from modifying the pixels near detailed +regions. Acceptable values are 8-32; the default value is 16. Out-of-range +values will be clipped to the valid range. +

+
+
+ +

Alternatively, the options can be specified as a flat string: +strength[:radius] +

+ +

11.90.1 Examples

+ +
    +
  • Apply the filter with a 3.5 strength and radius of 8: +
    +
    gradfun=3.5:8
+
    + +
  • Specify radius, omitting the strength (which will fall-back to the default +value): +
    +
    gradfun=radius=8
+
    + +
+ + +

11.91 graphmonitor

+

Show various filtergraph stats. +

+

With this filter one can debug complete filtergraph. +Especially issues with links filling with queued frames. +

+

The filter accepts the following options: +

+
+
size, s
+

Set video output size. Default is hd720. +

+
+
opacity, o
+

Set video opacity. Default is 0.9. Allowed range is from 0 to 1. +

+
+
mode, m
+

Set output mode, can be fulll or compact. +In compact mode only filters with some queued frames have displayed stats. +

+
+
flags, f
+

Set flags which enable which stats are shown in video. +

+

Available values for flags are: +

+
‘queue’
+

Display number of queued frames in each link. +

+
+
‘frame_count_in’
+

Display number of frames taken from filter. +

+
+
‘frame_count_out’
+

Display number of frames given out from filter. +

+
+
‘pts’
+

Display current filtered frame pts. +

+
+
‘time’
+

Display current filtered frame time. +

+
+
‘timebase’
+

Display time base for filter link. +

+
+
‘format’
+

Display used format for filter link. +

+
+
‘size’
+

Display video size or number of audio channels in case of audio used by filter link. +

+
+
‘rate’
+

Display video frame rate or sample rate in case of audio used by filter link. +

+
+ +
+
rate, r
+

Set upper limit for video rate of output stream, Default value is 25. +This guarantee that output video frame rate will not be higher than this value. +

+
+ + +

11.92 greyedge

+

A color constancy variation filter which estimates scene illumination via grey edge algorithm +and corrects the scene colors accordingly. +

+

See: https://staff.science.uva.nl/th.gevers/pub/GeversTIP07.pdf +

+

The filter accepts the following options: +

+
+
difford
+

The order of differentiation to be applied on the scene. Must be chosen in the range +[0,2] and default value is 1. +

+
+
minknorm
+

The Minkowski parameter to be used for calculating the Minkowski distance. Must +be chosen in the range [0,20] and default value is 1. Set to 0 for getting +max value instead of calculating Minkowski distance. +

+
+
sigma
+

The standard deviation of Gaussian blur to be applied on the scene. Must be +chosen in the range [0,1024.0] and default value = 1. floor( sigma * break_off_sigma(3) ) +can’t be equal to 0 if difford is greater than 0. +

+
+ + +

11.92.1 Examples

+
    +
  • Grey Edge: +
    +
    greyedge=difford=1:minknorm=5:sigma=2
+
    + +
  • Max Edge: +
    +
    greyedge=difford=1:minknorm=0:sigma=2
+
    + +
+ + +

11.93 haldclut

+ +

Apply a Hald CLUT to a video stream. +

+

First input is the video stream to process, and second one is the Hald CLUT. +The Hald CLUT input can be a simple picture or a complete video stream. +

+

The filter accepts the following options: +

+
+
shortest
+

Force termination when the shortest input terminates. Default is 0. +

+
repeatlast
+

Continue applying the last CLUT after the end of the stream. A value of +0 disable the filter after the last frame of the CLUT is reached. +Default is 1. +

+
+ +

haldclut also has the same interpolation options as lut3d (both +filters share the same internals). +

+

This filter also supports the framesync options. +

+

More information about the Hald CLUT can be found on Eskil Steenberg’s website +(Hald CLUT author) at http://www.quelsolaar.com/technology/clut.html. +

+ +

11.93.1 Workflow examples

+ + +

11.93.1.1 Hald CLUT video stream

+ +

Generate an identity Hald CLUT stream altered with various effects: +

+
ffmpeg -f lavfi -i haldclutsrc=8 -vf "hue=H=2*PI*t:s=sin(2*PI*t)+1, curves=cross_process" -t 10 -c:v ffv1 clut.nut
+
+ +

Note: make sure you use a lossless codec. +

+

Then use it with haldclut to apply it on some random stream: +

+
ffmpeg -f lavfi -i mandelbrot -i clut.nut -filter_complex '[0][1] haldclut' -t 20 mandelclut.mkv
+
+ +

The Hald CLUT will be applied to the 10 first seconds (duration of +clut.nut), then the latest picture of that CLUT stream will be applied +to the remaining frames of the mandelbrot stream. +

+ +

11.93.1.2 Hald CLUT with preview

+ +

A Hald CLUT is supposed to be a squared image of Level*Level*Level by +Level*Level*Level pixels. For a given Hald CLUT, FFmpeg will select the +biggest possible square starting at the top left of the picture. The remaining +padding pixels (bottom or right) will be ignored. This area can be used to add +a preview of the Hald CLUT. +

+

Typically, the following generated Hald CLUT will be supported by the +haldclut filter: +

+
+
ffmpeg -f lavfi -i haldclutsrc=8 -vf "
+   pad=iw+320 [padded_clut];
+   smptebars=s=320x256, split [a][b];
+   [padded_clut][a] overlay=W-320:h, curves=color_negative [main];
+   [main][b] overlay=W-320" -frames:v 1 clut.png
+
+ +

It contains the original and a preview of the effect of the CLUT: SMPTE color +bars are displayed on the right-top, and below the same color bars processed by +the color changes. +

+

Then, the effect of this Hald CLUT can be visualized with: +

+
ffplay input.mkv -vf "movie=clut.png, [in] haldclut"
+
+ + +

11.94 hflip

+ +

Flip the input video horizontally. +

+

For example, to horizontally flip the input video with ffmpeg: +

+
ffmpeg -i in.avi -vf "hflip" out.avi
+
+ + +

11.95 histeq

+

This filter applies a global color histogram equalization on a +per-frame basis. +

+

It can be used to correct video that has a compressed range of pixel +intensities. The filter redistributes the pixel intensities to +equalize their distribution across the intensity range. It may be +viewed as an "automatically adjusting contrast filter". This filter is +useful only for correcting degraded or poorly captured source +video. +

+

The filter accepts the following options: +

+
+
strength
+

Determine the amount of equalization to be applied. As the strength +is reduced, the distribution of pixel intensities more-and-more +approaches that of the input frame. The value must be a float number +in the range [0,1] and defaults to 0.200. +

+
+
intensity
+

Set the maximum intensity that can generated and scale the output +values appropriately. The strength should be set as desired and then +the intensity can be limited if needed to avoid washing-out. The value +must be a float number in the range [0,1] and defaults to 0.210. +

+
+
antibanding
+

Set the antibanding level. If enabled the filter will randomly vary +the luminance of output pixels by a small amount to avoid banding of +the histogram. Possible values are none, weak or +strong. It defaults to none. +

+
+ + +

11.96 histogram

+ +

Compute and draw a color distribution histogram for the input video. +

+

The computed histogram is a representation of the color component +distribution in an image. +

+

Standard histogram displays the color components distribution in an image. +Displays color graph for each color component. Shows distribution of +the Y, U, V, A or R, G, B components, depending on input format, in the +current frame. Below each graph a color component scale meter is shown. +

+

The filter accepts the following options: +

+
+
level_height
+

Set height of level. Default value is 200. +Allowed range is [50, 2048]. +

+
+
scale_height
+

Set height of color scale. Default value is 12. +Allowed range is [0, 40]. +

+
+
display_mode
+

Set display mode. +It accepts the following values: +

+
‘stack’
+

Per color component graphs are placed below each other. +

+
+
‘parade’
+

Per color component graphs are placed side by side. +

+
+
‘overlay’
+

Presents information identical to that in the parade, except +that the graphs representing color components are superimposed directly +over one another. +

+
+

Default is stack. +

+
+
levels_mode
+

Set mode. Can be either linear, or logarithmic. +Default is linear. +

+
+
components
+

Set what color components to display. +Default is 7. +

+
+
fgopacity
+

Set foreground opacity. Default is 0.7. +

+
+
bgopacity
+

Set background opacity. Default is 0.5. +

+
+ + +

11.96.1 Examples

+ +
    +
  • Calculate and draw histogram: +
    +
    ffplay -i input -vf histogram
+
    + +
+ + +

11.97 hqdn3d

+ +

This is a high precision/quality 3d denoise filter. It aims to reduce +image noise, producing smooth images and making still images really +still. It should enhance compressibility. +

+

It accepts the following optional parameters: +

+
+
luma_spatial
+

A non-negative floating point number which specifies spatial luma strength. +It defaults to 4.0. +

+
+
chroma_spatial
+

A non-negative floating point number which specifies spatial chroma strength. +It defaults to 3.0*luma_spatial/4.0. +

+
+
luma_tmp
+

A floating point number which specifies luma temporal strength. It defaults to +6.0*luma_spatial/4.0. +

+
+
chroma_tmp
+

A floating point number which specifies chroma temporal strength. It defaults to +luma_tmp*chroma_spatial/luma_spatial. +

+
+ + +

11.97.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.98 hwdownload

+ +

Download hardware frames to system memory. +

+

The input must be in hardware frames, and the output a non-hardware format. +Not all formats will be supported on the output - it may be necessary to insert +an additional format filter immediately following in the graph to get +the output in a supported format. +

+ +

11.99 hwmap

+ +

Map hardware frames to system memory or to another device. +

+

This filter has several different modes of operation; which one is used depends +on the input and output formats: +

    +
  • Hardware frame input, normal frame output + +

    Map the input frames to system memory and pass them to the output. If the +original hardware frame is later required (for example, after overlaying +something else on part of it), the hwmap filter can be used again +in the next mode to retrieve it. +

  • Normal frame input, hardware frame output + +

    If the input is actually a software-mapped hardware frame, then unmap it - +that is, return the original hardware frame. +

    +

    Otherwise, a device must be provided. Create new hardware surfaces on that +device for the output, then map them back to the software format at the input +and give those frames to the preceding filter. This will then act like the +hwupload filter, but may be able to avoid an additional copy when +the input is already in a compatible format. +

  • Hardware frame input and output + +

    A device must be supplied for the output, either directly or with the +derive_device option. The input and output devices must be of +different types and compatible - the exact meaning of this is +system-dependent, but typically it means that they must refer to the same +underlying hardware context (for example, refer to the same graphics card). +

    +

    If the input frames were originally created on the output device, then unmap +to retrieve the original frames. +

    +

    Otherwise, map the frames to the output device - create new hardware frames +on the output corresponding to the frames on the input. +

+ +

The following additional parameters are accepted: +

+
+
mode
+

Set the frame mapping mode. Some combination of: +

+
read
+

The mapped frame should be readable. +

+
write
+

The mapped frame should be writeable. +

+
overwrite
+

The mapping will always overwrite the entire frame. +

+

This may improve performance in some cases, as the original contents of the +frame need not be loaded. +

+
direct
+

The mapping must not involve any copying. +

+

Indirect mappings to copies of frames are created in some cases where either +direct mapping is not possible or it would have unexpected properties. +Setting this flag ensures that the mapping is direct and will fail if that is +not possible. +

+
+

Defaults to read+write if not specified. +

+
+
derive_device type
+

Rather than using the device supplied at initialisation, instead derive a new +device of type type from the device the input frames exist on. +

+
+
reverse
+

In a hardware to hardware mapping, map in reverse - create frames in the sink +and map them back to the source. This may be necessary in some cases where +a mapping in one direction is required but only the opposite direction is +supported by the devices being used. +

+

This option is dangerous - it may break the preceding filter in undefined +ways if there are any additional constraints on that filter’s output. +Do not use it without fully understanding the implications of its use. +

+
+ + +

11.100 hwupload

+ +

Upload system memory frames to hardware surfaces. +

+

The device to upload to must be supplied when the filter is initialised. If +using ffmpeg, select the appropriate device with the -filter_hw_device +option or with the derive_device option. The input and output devices +must be of different types and compatible - the exact meaning of this is +system-dependent, but typically it means that they must refer to the same +underlying hardware context (for example, refer to the same graphics card). +

+

The following additional parameters are accepted: +

+
+
derive_device type
+

Rather than using the device supplied at initialisation, instead derive a new +device of type type from the device the input frames exist on. +

+
+ + +

11.101 hwupload_cuda

+ +

Upload system memory frames to a CUDA device. +

+

It accepts the following optional parameters: +

+
+
device
+

The number of the CUDA device to use +

+
+ + +

11.102 hqx

+ +

Apply a high-quality magnification filter designed for pixel art. This filter +was originally created by Maxim Stepin. +

+

It accepts the following option: +

+
+
n
+

Set the scaling dimension: 2 for hq2x, 3 for +hq3x and 4 for hq4x. +Default is 3. +

+
+ + +

11.103 hstack

+

Stack input videos horizontally. +

+

All streams must be of same pixel format and of same height. +

+

Note that this filter is faster than using overlay and pad filter +to create same output. +

+

The filter accepts the following option: +

+
+
inputs
+

Set number of input streams. Default is 2. +

+
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+ + +

11.104 hue

+ +

Modify the hue and/or the saturation of the input. +

+

It accepts the following parameters: +

+
+
h
+

Specify the hue angle as a number of degrees. It accepts an expression, +and defaults to "0". +

+
+
s
+

Specify the saturation in the [-10,10] range. It accepts an expression and +defaults to "1". +

+
+
H
+

Specify the hue angle as a number of radians. It accepts an +expression, and defaults to "0". +

+
+
b
+

Specify the brightness in the [-10,10] range. It accepts an expression and +defaults to "0". +

+
+ +

h and H are mutually exclusive, and can’t be +specified at the same time. +

+

The b, h, H and s option values are +expressions containing the following constants: +

+
+
n
+

frame count of the input frame starting from 0 +

+
+
pts
+

presentation timestamp of the input frame expressed in time base units +

+
+
r
+

frame rate of the input video, NAN if the input frame rate is unknown +

+
+
t
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+
tb
+

time base of the input video +

+
+ + +

11.104.1 Examples

+ +
    +
  • Set the hue to 90 degrees and the saturation to 1.0: +
    +
    hue=h=90:s=1
+
    + +
  • Same command but expressing the hue in radians: +
    +
    hue=H=PI/2:s=1
+
    + +
  • Rotate hue and make the saturation swing between 0 +and 2 over a period of 1 second: +
    +
    hue="H=2*PI*t: s=sin(2*PI*t)+1"
+
    + +
  • Apply a 3 seconds saturation fade-in effect starting at 0: +
    +
    hue="s=min(t/3\,1)"
+
    + +

    The general fade-in expression can be written as: +

    +
    hue="s=min(0\, max((t-START)/DURATION\, 1))"
+
    + +
  • Apply a 3 seconds saturation fade-out effect starting at 5 seconds: +
    +
    hue="s=max(0\, min(1\, (8-t)/3))"
+
    + +

    The general fade-out expression can be written as: +

    +
    hue="s=max(0\, min(1\, (START+DURATION-t)/DURATION))"
+
    + +
+ + +

11.104.2 Commands

+ +

This filter supports the following commands: +

+
b
+
s
+
h
+
H
+

Modify the hue and/or the saturation and/or brightness of the input video. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

11.105 hysteresis

+ +

Grow first stream into second stream by connecting components. +This makes it possible to build more robust edge masks. +

+

This filter accepts the following options: +

+
+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+
threshold
+

Set threshold which is used in filtering. If pixel component value is higher than +this value filter algorithm for connecting components is activated. +By default value is 0. +

+
+ +

The hysteresis filter also supports the framesync options. +

+ +

11.106 idet

+ +

Detect video interlacing type. +

+

This filter tries to detect if the input frames are interlaced, progressive, +top or bottom field first. It will also try to detect fields that are +repeated between adjacent frames (a sign of telecine). +

+

Single frame detection considers only immediately adjacent frames when classifying each frame. +Multiple frame detection incorporates the classification history of previous frames. +

+

The filter will log these metadata values: +

+
+
single.current_frame
+

Detected type of current frame using single-frame detection. One of: +“tff” (top field first), “bff” (bottom field first), +“progressive”, or “undetermined” +

+
+
single.tff
+

Cumulative number of frames detected as top field first using single-frame detection. +

+
+
multiple.tff
+

Cumulative number of frames detected as top field first using multiple-frame detection. +

+
+
single.bff
+

Cumulative number of frames detected as bottom field first using single-frame detection. +

+
+
multiple.current_frame
+

Detected type of current frame using multiple-frame detection. One of: +“tff” (top field first), “bff” (bottom field first), +“progressive”, or “undetermined” +

+
+
multiple.bff
+

Cumulative number of frames detected as bottom field first using multiple-frame detection. +

+
+
single.progressive
+

Cumulative number of frames detected as progressive using single-frame detection. +

+
+
multiple.progressive
+

Cumulative number of frames detected as progressive using multiple-frame detection. +

+
+
single.undetermined
+

Cumulative number of frames that could not be classified using single-frame detection. +

+
+
multiple.undetermined
+

Cumulative number of frames that could not be classified using multiple-frame detection. +

+
+
repeated.current_frame
+

Which field in the current frame is repeated from the last. One of “neither”, “top”, or “bottom”. +

+
+
repeated.neither
+

Cumulative number of frames with no repeated field. +

+
+
repeated.top
+

Cumulative number of frames with the top field repeated from the previous frame’s top field. +

+
+
repeated.bottom
+

Cumulative number of frames with the bottom field repeated from the previous frame’s bottom field. +

+
+ +

The filter accepts the following options: +

+
+
intl_thres
+

Set interlacing threshold. +

+
prog_thres
+

Set progressive threshold. +

+
rep_thres
+

Threshold for repeated field detection. +

+
half_life
+

Number of frames after which a given frame’s contribution to the +statistics is halved (i.e., it contributes only 0.5 to its +classification). The default of 0 means that all frames seen are given +full weight of 1.0 forever. +

+
analyze_interlaced_flag
+

When this is not 0 then idet will use the specified number of frames to determine +if the interlaced flag is accurate, it will not count undetermined frames. +If the flag is found to be accurate it will be used without any further +computations, if it is found to be inaccurate it will be cleared without any +further computations. This allows inserting the idet filter as a low computational +method to clean up the interlaced flag +

+
+ + +

11.107 il

+ +

Deinterleave or interleave fields. +

+

This filter allows one to process interlaced images fields without +deinterlacing them. Deinterleaving splits the input frame into 2 +fields (so called half pictures). Odd lines are moved to the top +half of the output image, even lines to the bottom half. +You can process (filter) them independently and then re-interleave them. +

+

The filter accepts the following options: +

+
+
luma_mode, l
+
chroma_mode, c
+
alpha_mode, a
+

Available values for luma_mode, chroma_mode and +alpha_mode are: +

+
+
‘none’
+

Do nothing. +

+
+
‘deinterleave, d’
+

Deinterleave fields, placing one above the other. +

+
+
‘interleave, i’
+

Interleave fields. Reverse the effect of deinterleaving. +

+
+

Default value is none. +

+
+
luma_swap, ls
+
chroma_swap, cs
+
alpha_swap, as
+

Swap luma/chroma/alpha fields. Exchange even & odd lines. Default value is 0. +

+
+ + +

11.107.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

11.108 inflate

+ +

Apply inflate effect to the video. +

+

This filter replaces the pixel by the local(3x3) average by taking into account +only values higher than the pixel. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+ + +

11.108.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

11.109 interlace

+ +

Simple interlacing filter from progressive contents. This interleaves upper (or +lower) lines from odd frames with lower (or upper) lines from even frames, +halving the frame rate and preserving image height. +

+
+
   Original        Original             New Frame
+   Frame 'j'      Frame 'j+1'             (tff)
+  ==========      ===========       ==================
+    Line 0  -------------------->    Frame 'j' Line 0
+    Line 1          Line 1  ---->   Frame 'j+1' Line 1
+    Line 2 --------------------->    Frame 'j' Line 2
+    Line 3          Line 3  ---->   Frame 'j+1' Line 3
+     ...             ...                   ...
+New Frame + 1 will be generated by Frame 'j+2' and Frame 'j+3' and so on
+
+ +

It accepts the following optional parameters: +

+
+
scan
+

This determines whether the interlaced frame is taken from the even +(tff - default) or odd (bff) lines of the progressive frame. +

+
+
lowpass
+

Vertical lowpass filter to avoid twitter interlacing and +reduce moire patterns. +

+
+
‘0, off’
+

Disable vertical lowpass filter +

+
+
‘1, linear’
+

Enable linear filter (default) +

+
+
‘2, complex’
+

Enable complex filter. This will slightly less reduce twitter and moire +but better retain detail and subjective sharpness impression. +

+
+
+
+
+ + +

11.110 kerndeint

+ +

Deinterlace input video by applying Donald Graft’s adaptive kernel +deinterling. Work on interlaced parts of a video to produce +progressive frames. +

+

The description of the accepted parameters follows. +

+
+
thresh
+

Set the threshold which affects the filter’s tolerance when +determining if a pixel line must be processed. It must be an integer +in the range [0,255] and defaults to 10. A value of 0 will result in +applying the process on every pixels. +

+
+
map
+

Paint pixels exceeding the threshold value to white if set to 1. +Default is 0. +

+
+
order
+

Set the fields order. Swap fields if set to 1, leave fields alone if +0. Default is 0. +

+
+
sharp
+

Enable additional sharpening if set to 1. Default is 0. +

+
+
twoway
+

Enable twoway sharpening if set to 1. Default is 0. +

+
+ + +

11.110.1 Examples

+ +
    +
  • Apply default values: +
    +
    kerndeint=thresh=10:map=0:order=0:sharp=0:twoway=0
+
    + +
  • Enable additional sharpening: +
    +
    kerndeint=sharp=1
+
    + +
  • Paint processed pixels in white: +
    +
    kerndeint=map=1
+
    +
+ + +

11.111 lagfun

+ +

Slowly update darker pixels. +

+

This filter makes short flashes of light appear longer. +This filter accepts the following options: +

+
+
decay
+

Set factor for decaying. Default is .95. Allowed range is from 0 to 1. +

+
+
planes
+

Set which planes to filter. Default is all. Allowed range is from 0 to 15. +

+
+ + +

11.112 lenscorrection

+ +

Correct radial lens distortion +

+

This filter can be used to correct for radial distortion as can result from the use +of wide angle lenses, and thereby re-rectify the image. To find the right parameters +one can use tools available for example as part of opencv or simply trial-and-error. +To use opencv use the calibration sample (under samples/cpp) from the opencv sources +and extract the k1 and k2 coefficients from the resulting matrix. +

+

Note that effectively the same filter is available in the open-source tools Krita and +Digikam from the KDE project. +

+

In contrast to the vignette filter, which can also be used to compensate lens errors, +this filter corrects the distortion of the image, whereas vignette corrects the +brightness distribution, so you may want to use both filters together in certain +cases, though you will have to take care of ordering, i.e. whether vignetting should +be applied before or after lens correction. +

+ +

11.112.1 Options

+ +

The filter accepts the following options: +

+
+
cx
+

Relative x-coordinate of the focal point of the image, and thereby the center of the +distortion. This value has a range [0,1] and is expressed as fractions of the image +width. Default is 0.5. +

+
cy
+

Relative y-coordinate of the focal point of the image, and thereby the center of the +distortion. This value has a range [0,1] and is expressed as fractions of the image +height. Default is 0.5. +

+
k1
+

Coefficient of the quadratic correction term. This value has a range [-1,1]. 0 means +no correction. Default is 0. +

+
k2
+

Coefficient of the double quadratic correction term. This value has a range [-1,1]. +0 means no correction. Default is 0. +

+
+ +

The formula that generates the correction is: +

+

r_src = r_tgt * (1 + k1 * (r_tgt / r_0)^2 + k2 * (r_tgt / r_0)^4) +

+

where r_0 is halve of the image diagonal and r_src and r_tgt are the +distances from the focal point in the source and target images, respectively. +

+ +

11.113 lensfun

+ +

Apply lens correction via the lensfun library (http://lensfun.sourceforge.net/). +

+

The lensfun filter requires the camera make, camera model, and lens model +to apply the lens correction. The filter will load the lensfun database and +query it to find the corresponding camera and lens entries in the database. As +long as these entries can be found with the given options, the filter can +perform corrections on frames. Note that incomplete strings will result in the +filter choosing the best match with the given options, and the filter will +output the chosen camera and lens models (logged with level "info"). You must +provide the make, camera model, and lens model as they are required. +

+

The filter accepts the following options: +

+
+
make
+

The make of the camera (for example, "Canon"). This option is required. +

+
+
model
+

The model of the camera (for example, "Canon EOS 100D"). This option is +required. +

+
+
lens_model
+

The model of the lens (for example, "Canon EF-S 18-55mm f/3.5-5.6 IS STM"). This +option is required. +

+
+
mode
+

The type of correction to apply. The following values are valid options: +

+
+
‘vignetting’
+

Enables fixing lens vignetting. +

+
+
‘geometry’
+

Enables fixing lens geometry. This is the default. +

+
+
‘subpixel’
+

Enables fixing chromatic aberrations. +

+
+
‘vig_geo’
+

Enables fixing lens vignetting and lens geometry. +

+
+
‘vig_subpixel’
+

Enables fixing lens vignetting and chromatic aberrations. +

+
+
‘distortion’
+

Enables fixing both lens geometry and chromatic aberrations. +

+
+
‘all’
+

Enables all possible corrections. +

+
+
+
+
focal_length
+

The focal length of the image/video (zoom; expected constant for video). For +example, a 18–55mm lens has focal length range of [18–55], so a value in that +range should be chosen when using that lens. Default 18. +

+
+
aperture
+

The aperture of the image/video (expected constant for video). Note that +aperture is only used for vignetting correction. Default 3.5. +

+
+
focus_distance
+

The focus distance of the image/video (expected constant for video). Note that +focus distance is only used for vignetting and only slightly affects the +vignetting correction process. If unknown, leave it at the default value (which +is 1000). +

+
+
scale
+

The scale factor which is applied after transformation. After correction the +video is no longer necessarily rectangular. This parameter controls how much of +the resulting image is visible. The value 0 means that a value will be chosen +automatically such that there is little or no unmapped area in the output +image. 1.0 means that no additional scaling is done. Lower values may result +in more of the corrected image being visible, while higher values may avoid +unmapped areas in the output. +

+
+
target_geometry
+

The target geometry of the output image/video. The following values are valid +options: +

+
+
‘rectilinear (default)’
+
‘fisheye’
+
‘panoramic’
+
‘equirectangular’
+
‘fisheye_orthographic’
+
‘fisheye_stereographic’
+
‘fisheye_equisolid’
+
‘fisheye_thoby’
+
+
+
reverse
+

Apply the reverse of image correction (instead of correcting distortion, apply +it). +

+
+
interpolation
+

The type of interpolation used when correcting distortion. The following values +are valid options: +

+
+
‘nearest’
+
‘linear (default)’
+
‘lanczos’
+
+
+
+ + +

11.113.1 Examples

+ +
    +
  • Apply lens correction with make "Canon", camera model "Canon EOS 100D", and lens +model "Canon EF-S 18-55mm f/3.5-5.6 IS STM" with focal length of "18" and +aperture of "8.0". + +
    +
    ffmpeg -i input.mov -vf lensfun=make=Canon:model="Canon EOS 100D":lens_model="Canon EF-S 18-55mm f/3.5-5.6 IS STM":focal_length=18:aperture=8 -c:v h264 -b:v 8000k output.mov
+
    + +
  • Apply the same as before, but only for the first 5 seconds of video. + +
    +
    ffmpeg -i input.mov -vf lensfun=make=Canon:model="Canon EOS 100D":lens_model="Canon EF-S 18-55mm f/3.5-5.6 IS STM":focal_length=18:aperture=8:enable='lte(t\,5)' -c:v h264 -b:v 8000k output.mov
+
    + +
+ + +

11.114 libvmaf

+ +

Obtain the VMAF (Video Multi-Method Assessment Fusion) +score between two input videos. +

+

The obtained VMAF score is printed through the logging system. +

+

It requires Netflix’s vmaf library (libvmaf) as a pre-requisite. +After installing the library it can be enabled using: +./configure --enable-libvmaf --enable-version3. +If no model path is specified it uses the default model: vmaf_v0.6.1.pkl. +

+

The filter has following options: +

+
+
model_path
+

Set the model path which is to be used for SVM. +Default value: "/usr/local/share/model/vmaf_v0.6.1.pkl" +

+
+
log_path
+

Set the file path to be used to store logs. +

+
+
log_fmt
+

Set the format of the log file (xml or json). +

+
+
enable_transform
+

This option can enable/disable the score_transform applied to the final predicted VMAF score, +if you have specified score_transform option in the input parameter file passed to run_vmaf_training.py +Default value: false +

+
+
phone_model
+

Invokes the phone model which will generate VMAF scores higher than in the +regular model, which is more suitable for laptop, TV, etc. viewing conditions. +Default value: false +

+
+
psnr
+

Enables computing psnr along with vmaf. +Default value: false +

+
+
ssim
+

Enables computing ssim along with vmaf. +Default value: false +

+
+
ms_ssim
+

Enables computing ms_ssim along with vmaf. +Default value: false +

+
+
pool
+

Set the pool method to be used for computing vmaf. +Options are min, harmonic_mean or mean (default). +

+
+
n_threads
+

Set number of threads to be used when computing vmaf. +Default value: 0, which makes use of all available logical processors. +

+
+
n_subsample
+

Set interval for frame subsampling used when computing vmaf. +Default value: 1 +

+
+
enable_conf_interval
+

Enables confidence interval. +Default value: false +

+
+ +

This filter also supports the framesync options. +

+ +

11.114.1 Examples

+
    +
  • On the below examples the input file main.mpg being processed is +compared with the reference file ref.mpg. + +
    +
    ffmpeg -i main.mpg -i ref.mpg -lavfi libvmaf -f null -
+
    + +
  • Example with options: +
    +
    ffmpeg -i main.mpg -i ref.mpg -lavfi libvmaf="psnr=1:log_fmt=json" -f null -
+
    + +
  • Example with options and different containers: +
    +
    ffmpeg -i main.mpg -i ref.mkv -lavfi "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]libvmaf=psnr=1:log_fmt=json" -f null -
+
    +
+ + +

11.115 limiter

+ +

Limits the pixel components values to the specified range [min, max]. +

+

The filter accepts the following options: +

+
+
min
+

Lower bound. Defaults to the lowest allowed value for the input. +

+
+
max
+

Upper bound. Defaults to the highest allowed value for the input. +

+
+
planes
+

Specify which planes will be processed. Defaults to all available. +

+
+ + +

11.116 loop

+ +

Loop video frames. +

+

The filter accepts the following options: +

+
+
loop
+

Set the number of loops. Setting this value to -1 will result in infinite loops. +Default is 0. +

+
+
size
+

Set maximal size in number of frames. Default is 0. +

+
+
start
+

Set first frame of loop. Default is 0. +

+
+ + +

11.116.1 Examples

+ +
    +
  • Loop single first frame infinitely: +
    +
    loop=loop=-1:size=1:start=0
+
    + +
  • Loop single first frame 10 times: +
    +
    loop=loop=10:size=1:start=0
+
    + +
  • Loop 10 first frames 5 times: +
    +
    loop=loop=5:size=10:start=0
+
    +
+ + +

11.117 lut1d

+ +

Apply a 1D LUT to an input video. +

+

The filter accepts the following options: +

+
+
file
+

Set the 1D LUT file name. +

+

Currently supported formats: +

+
‘cube’
+

Iridas +

+
‘csp’
+

cineSpace +

+
+ +
+
interp
+

Select interpolation mode. +

+

Available values are: +

+
+
‘nearest’
+

Use values from the nearest defined point. +

+
‘linear’
+

Interpolate values using the linear interpolation. +

+
‘cosine’
+

Interpolate values using the cosine interpolation. +

+
‘cubic’
+

Interpolate values using the cubic interpolation. +

+
‘spline’
+

Interpolate values using the spline interpolation. +

+
+
+
+ + +

11.118 lut3d

+ +

Apply a 3D LUT to an input video. +

+

The filter accepts the following options: +

+
+
file
+

Set the 3D LUT file name. +

+

Currently supported formats: +

+
‘3dl’
+

AfterEffects +

+
‘cube’
+

Iridas +

+
‘dat’
+

DaVinci +

+
‘m3d’
+

Pandora +

+
‘csp’
+

cineSpace +

+
+
+
interp
+

Select interpolation mode. +

+

Available values are: +

+
+
‘nearest’
+

Use values from the nearest defined point. +

+
‘trilinear’
+

Interpolate values using the 8 points defining a cube. +

+
‘tetrahedral’
+

Interpolate values using a tetrahedron. +

+
+
+
+ + +

11.119 lumakey

+ +

Turn certain luma values into transparency. +

+

The filter accepts the following options: +

+
+
threshold
+

Set the luma which will be used as base for transparency. +Default value is 0. +

+
+
tolerance
+

Set the range of luma values to be keyed out. +Default value is 0.01. +

+
+
softness
+

Set the range of softness. Default value is 0. +Use this to control gradual transition from zero to full transparency. +

+
+ + +

11.119.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.120 lut, lutrgb, lutyuv

+ +

Compute a look-up table for binding each pixel component input value +to an output value, and apply it to the input video. +

+

lutyuv applies a lookup table to a YUV input video, lutrgb +to an RGB input video. +

+

These filters accept the following parameters: +

+
c0
+

set first pixel component expression +

+
c1
+

set second pixel component expression +

+
c2
+

set third pixel component expression +

+
c3
+

set fourth pixel component expression, corresponds to the alpha component +

+
+
r
+

set red component expression +

+
g
+

set green component expression +

+
b
+

set blue component expression +

+
a
+

alpha component expression +

+
+
y
+

set Y/luminance component expression +

+
u
+

set U/Cb component expression +

+
v
+

set V/Cr component expression +

+
+ +

Each of them specifies the expression to use for computing the lookup table for +the corresponding pixel component values. +

+

The exact component associated to each of the c* options depends on the +format in input. +

+

The lut filter requires either YUV or RGB pixel formats in input, +lutrgb requires RGB pixel formats in input, and lutyuv requires YUV. +

+

The expressions can contain the following constants and functions: +

+
+
w
+
h
+

The input width and height. +

+
+
val
+

The input value for the pixel component. +

+
+
clipval
+

The input value, clipped to the minval-maxval range. +

+
+
maxval
+

The maximum value for the pixel component. +

+
+
minval
+

The minimum value for the pixel component. +

+
+
negval
+

The negated value for the pixel component value, clipped to the +minval-maxval range; it corresponds to the expression +"maxval-clipval+minval". +

+
+
clip(val)
+

The computed value in val, clipped to the +minval-maxval range. +

+
+
gammaval(gamma)
+

The computed gamma correction value of the pixel component value, +clipped to the minval-maxval range. It corresponds to the +expression +"pow((clipval-minval)/(maxval-minval)\,gamma)*(maxval-minval)+minval" +

+
+
+ +

All expressions default to "val". +

+ +

11.120.1 Examples

+ +
    +
  • Negate input video: +
    +
    lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
+lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
+
    + +

    The above is the same as: +

    +
    lutrgb="r=negval:g=negval:b=negval"
+lutyuv="y=negval:u=negval:v=negval"
+
    + +
  • Negate luminance: +
    +
    lutyuv=y=negval
+
    + +
  • Remove chroma components, turning the video into a graytone image: +
    +
    lutyuv="u=128:v=128"
+
    + +
  • Apply a luma burning effect: +
    +
    lutyuv="y=2*val"
+
    + +
  • Remove green and blue components: +
    +
    lutrgb="g=0:b=0"
+
    + +
  • Set a constant alpha channel value on input: +
    +
    format=rgba,lutrgb=a="maxval-minval/2"
+
    + +
  • Correct luminance gamma by a factor of 0.5: +
    +
    lutyuv=y=gammaval(0.5)
+
    + +
  • Discard least significant bits of luma: +
    +
    lutyuv=y='bitand(val, 128+64+32)'
+
    + +
  • Technicolor like effect: +
    +
    lutyuv=u='(val-maxval/2)*2+maxval/2':v='(val-maxval/2)*2+maxval/2'
+
    +
+ + +

11.121 lut2, tlut2

+ +

The lut2 filter takes two input streams and outputs one +stream. +

+

The tlut2 (time lut2) filter takes two consecutive frames +from one single stream. +

+

This filter accepts the following parameters: +

+
c0
+

set first pixel component expression +

+
c1
+

set second pixel component expression +

+
c2
+

set third pixel component expression +

+
c3
+

set fourth pixel component expression, corresponds to the alpha component +

+
+
d
+

set output bit depth, only available for lut2 filter. By default is 0, +which means bit depth is automatically picked from first input format. +

+
+ +

The lut2 filter also supports the framesync options. +

+

Each of them specifies the expression to use for computing the lookup table for +the corresponding pixel component values. +

+

The exact component associated to each of the c* options depends on the +format in inputs. +

+

The expressions can contain the following constants: +

+
+
w
+
h
+

The input width and height. +

+
+
x
+

The first input value for the pixel component. +

+
+
y
+

The second input value for the pixel component. +

+
+
bdx
+

The first input video bit depth. +

+
+
bdy
+

The second input video bit depth. +

+
+ +

All expressions default to "x". +

+ +

11.121.1 Examples

+ +
    +
  • Highlight differences between two RGB video streams: +
    +
    lut2='ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,0,pow(2,bdx)-1)'
+
    + +
  • Highlight differences between two YUV video streams: +
    +
    lut2='ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,pow(2,bdx-1),pow(2,bdx)-1):ifnot(x-y,pow(2,bdx-1),pow(2,bdx)-1)'
+
    + +
  • Show max difference between two video streams: +
    +
    lut2='if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1))):if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1))):if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1)))'
+
    +
+ + +

11.122 maskedclamp

+ +

Clamp the first input stream with the second input and third input stream. +

+

Returns the value of first stream to be between second input +stream - undershoot and third input stream + overshoot. +

+

This filter accepts the following options: +

+
undershoot
+

Default value is 0. +

+
+
overshoot
+

Default value is 0. +

+
+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

11.123 maskedmax

+ +

Merge the second and third input stream into output stream using absolute differences +between second input stream and first input stream and absolute difference between +third input stream and first input stream. The picked value will be from second input +stream if second absolute difference is greater than first one or from third input stream +otherwise. +

+

This filter accepts the following options: +

+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

11.124 maskedmerge

+ +

Merge the first input stream with the second input stream using per pixel +weights in the third input stream. +

+

A value of 0 in the third stream pixel component means that pixel component +from first stream is returned unchanged, while maximum value (eg. 255 for +8-bit videos) means that pixel component from second stream is returned +unchanged. Intermediate values define the amount of merging between both +input stream’s pixel components. +

+

This filter accepts the following options: +

+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

11.125 maskedmin

+ +

Merge the second and third input stream into output stream using absolute differences +between second input stream and first input stream and absolute difference between +third input stream and first input stream. The picked value will be from second input +stream if second absolute difference is less than first one or from third input stream +otherwise. +

+

This filter accepts the following options: +

+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

11.126 maskedthreshold

+

Pick pixels comparing absolute difference of two video streams with fixed +threshold. +

+

If absolute difference between pixel component of first and second video +stream is equal or lower than user supplied threshold than pixel component +from first video stream is picked, otherwise pixel component from second +video stream is picked. +

+

This filter accepts the following options: +

+
threshold
+

Set threshold used when picking pixels from absolute difference from two input +video streams. +

+
+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from second stream. +By default value 0xf, all planes will be processed. +

+
+ + +

11.127 maskfun

+

Create mask from input video. +

+

For example it is useful to create motion masks after tblend filter. +

+

This filter accepts the following options: +

+
+
low
+

Set low threshold. Any pixel component lower or exact than this value will be set to 0. +

+
+
high
+

Set high threshold. Any pixel component higher than this value will be set to max value +allowed for current pixel format. +

+
+
planes
+

Set planes to filter, by default all available planes are filtered. +

+
+
fill
+

Fill all frame pixels with this value. +

+
+
sum
+

Set max average pixel value for frame. If sum of all pixel components is higher that this +average, output frame will be completely filled with value set by fill option. +Typically useful for scene changes when used in combination with tblend filter. +

+
+ + +

11.128 mcdeint

+ +

Apply motion-compensation deinterlacing. +

+

It needs one field per frame as input and must thus be used together +with yadif=1/3 or equivalent. +

+

This filter accepts the following options: +

+
mode
+

Set the deinterlacing mode. +

+

It accepts one of the following values: +

+
‘fast’
+
‘medium’
+
‘slow’
+

use iterative motion estimation +

+
‘extra_slow’
+

like ‘slow’, but use multiple reference frames. +

+
+

Default value is ‘fast’. +

+
+
parity
+

Set the picture field parity assumed for the input video. It must be +one of the following values: +

+
+
‘0, tff’
+

assume top field first +

+
‘1, bff’
+

assume bottom field first +

+
+ +

Default value is ‘bff’. +

+
+
qp
+

Set per-block quantization parameter (QP) used by the internal +encoder. +

+

Higher values should result in a smoother motion vector field but less +optimal individual vectors. Default value is 1. +

+
+ + +

11.129 median

+ +

Pick median pixel from certain rectangle defined by radius. +

+

This filter accepts the following options: +

+
+
radius
+

Set horizontal radius size. Default value is 1. +Allowed range is integer from 1 to 127. +

+
+
planes
+

Set which planes to process. Default is 15, which is all available planes. +

+
+
radiusV
+

Set vertical radius size. Default value is 0. +Allowed range is integer from 0 to 127. +If it is 0, value will be picked from horizontal radius option. +

+
+
percentile
+

Set median percentile. Default value is 0.5. +Default value of 0.5 will pick always median values, while 0 will pick +minimum values, and 1 maximum values. +

+
+ + +

11.129.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.130 mergeplanes

+ +

Merge color channel components from several video streams. +

+

The filter accepts up to 4 input streams, and merge selected input +planes to the output video. +

+

This filter accepts the following options: +

+
mapping
+

Set input to output plane mapping. Default is 0. +

+

The mappings is specified as a bitmap. It should be specified as a +hexadecimal number in the form 0xAa[Bb[Cc[Dd]]]. ’Aa’ describes the +mapping for the first plane of the output stream. ’A’ sets the number of +the input stream to use (from 0 to 3), and ’a’ the plane number of the +corresponding input to use (from 0 to 3). The rest of the mappings is +similar, ’Bb’ describes the mapping for the output stream second +plane, ’Cc’ describes the mapping for the output stream third plane and +’Dd’ describes the mapping for the output stream fourth plane. +

+
+
format
+

Set output pixel format. Default is yuva444p. +

+
+ + +

11.130.1 Examples

+ +
    +
  • Merge three gray video streams of same width and height into single video stream: +
    +
    [a0][a1][a2]mergeplanes=0x001020:yuv444p
+
    + +
  • Merge 1st yuv444p stream and 2nd gray video stream into yuva444p video stream: +
    +
    [a0][a1]mergeplanes=0x00010210:yuva444p
+
    + +
  • Swap Y and A plane in yuva444p stream: +
    +
    format=yuva444p,mergeplanes=0x03010200:yuva444p
+
    + +
  • Swap U and V plane in yuv420p stream: +
    +
    format=yuv420p,mergeplanes=0x000201:yuv420p
+
    + +
  • Cast a rgb24 clip to yuv444p: +
    +
    format=rgb24,mergeplanes=0x000102:yuv444p
+
    +
+ + +

11.131 mestimate

+ +

Estimate and export motion vectors using block matching algorithms. +Motion vectors are stored in frame side data to be used by other filters. +

+

This filter accepts the following options: +

+
method
+

Specify the motion estimation method. Accepts one of the following values: +

+
+
‘esa’
+

Exhaustive search algorithm. +

+
‘tss’
+

Three step search algorithm. +

+
‘tdls’
+

Two dimensional logarithmic search algorithm. +

+
‘ntss’
+

New three step search algorithm. +

+
‘fss’
+

Four step search algorithm. +

+
‘ds’
+

Diamond search algorithm. +

+
‘hexbs’
+

Hexagon-based search algorithm. +

+
‘epzs’
+

Enhanced predictive zonal search algorithm. +

+
‘umh’
+

Uneven multi-hexagon search algorithm. +

+
+

Default value is ‘esa’. +

+
+
mb_size
+

Macroblock size. Default 16. +

+
+
search_param
+

Search parameter. Default 7. +

+
+ + +

11.132 midequalizer

+ +

Apply Midway Image Equalization effect using two video streams. +

+

Midway Image Equalization adjusts a pair of images to have the same +histogram, while maintaining their dynamics as much as possible. It’s +useful for e.g. matching exposures from a pair of stereo cameras. +

+

This filter has two inputs and one output, which must be of same pixel format, but +may be of different sizes. The output of filter is first input adjusted with +midway histogram of both inputs. +

+

This filter accepts the following option: +

+
+
planes
+

Set which planes to process. Default is 15, which is all available planes. +

+
+ + +

11.133 minterpolate

+ +

Convert the video to specified frame rate using motion interpolation. +

+

This filter accepts the following options: +

+
fps
+

Specify the output frame rate. This can be rational e.g. 60000/1001. Frames are dropped if fps is lower than source fps. Default 60. +

+
+
mi_mode
+

Motion interpolation mode. Following values are accepted: +

+
‘dup’
+

Duplicate previous or next frame for interpolating new ones. +

+
‘blend’
+

Blend source frames. Interpolated frame is mean of previous and next frames. +

+
‘mci’
+

Motion compensated interpolation. Following options are effective when this mode is selected: +

+
+
‘mc_mode’
+

Motion compensation mode. Following values are accepted: +

+
‘obmc’
+

Overlapped block motion compensation. +

+
‘aobmc’
+

Adaptive overlapped block motion compensation. Window weighting coefficients are controlled adaptively according to the reliabilities of the neighboring motion vectors to reduce oversmoothing. +

+
+

Default mode is ‘obmc’. +

+
+
‘me_mode’
+

Motion estimation mode. Following values are accepted: +

+
‘bidir’
+

Bidirectional motion estimation. Motion vectors are estimated for each source frame in both forward and backward directions. +

+
‘bilat’
+

Bilateral motion estimation. Motion vectors are estimated directly for interpolated frame. +

+
+

Default mode is ‘bilat’. +

+
+
‘me’
+

The algorithm to be used for motion estimation. Following values are accepted: +

+
‘esa’
+

Exhaustive search algorithm. +

+
‘tss’
+

Three step search algorithm. +

+
‘tdls’
+

Two dimensional logarithmic search algorithm. +

+
‘ntss’
+

New three step search algorithm. +

+
‘fss’
+

Four step search algorithm. +

+
‘ds’
+

Diamond search algorithm. +

+
‘hexbs’
+

Hexagon-based search algorithm. +

+
‘epzs’
+

Enhanced predictive zonal search algorithm. +

+
‘umh’
+

Uneven multi-hexagon search algorithm. +

+
+

Default algorithm is ‘epzs’. +

+
+
‘mb_size’
+

Macroblock size. Default 16. +

+
+
‘search_param’
+

Motion estimation search parameter. Default 32. +

+
+
‘vsbmc’
+

Enable variable-size block motion compensation. Motion estimation is applied with smaller block sizes at object boundaries in order to make the them less blur. Default is 0 (disabled). +

+
+
+
+ +
+
scd
+

Scene change detection method. Scene change leads motion vectors to be in random direction. Scene change detection replace interpolated frames by duplicate ones. May not be needed for other modes. Following values are accepted: +

+
‘none’
+

Disable scene change detection. +

+
‘fdiff’
+

Frame difference. Corresponding pixel values are compared and if it satisfies scd_threshold scene change is detected. +

+
+

Default method is ‘fdiff’. +

+
+
scd_threshold
+

Scene change detection threshold. Default is 10.. +

+
+ + +

11.134 mix

+ +

Mix several video input streams into one video stream. +

+

A description of the accepted options follows. +

+
+
nb_inputs
+

The number of inputs. If unspecified, it defaults to 2. +

+
+
weights
+

Specify weight of each input video stream as sequence. +Each weight is separated by space. If number of weights +is smaller than number of frames last specified +weight will be used for all remaining unset weights. +

+
+
scale
+

Specify scale, if it is set it will be multiplied with sum +of each weight multiplied with pixel values to give final destination +pixel value. By default scale is auto scaled to sum of weights. +

+
+
duration
+

Specify how end of stream is determined. +

+
‘longest’
+

The duration of the longest input. (default) +

+
+
‘shortest’
+

The duration of the shortest input. +

+
+
‘first’
+

The duration of the first input. +

+
+
+
+ + +

11.135 mpdecimate

+ +

Drop frames that do not differ greatly from the previous frame in +order to reduce frame rate. +

+

The main use of this filter is for very-low-bitrate encoding +(e.g. streaming over dialup modem), but it could in theory be used for +fixing movies that were inverse-telecined incorrectly. +

+

A description of the accepted options follows. +

+
+
max
+

Set the maximum number of consecutive frames which can be dropped (if +positive), or the minimum interval between dropped frames (if +negative). If the value is 0, the frame is dropped disregarding the +number of previous sequentially dropped frames. +

+

Default value is 0. +

+
+
hi
+
lo
+
frac
+

Set the dropping threshold values. +

+

Values for hi and lo are for 8x8 pixel blocks and +represent actual pixel value differences, so a threshold of 64 +corresponds to 1 unit of difference for each pixel, or the same spread +out differently over the block. +

+

A frame is a candidate for dropping if no 8x8 blocks differ by more +than a threshold of hi, and if no more than frac blocks (1 +meaning the whole image) differ by more than a threshold of lo. +

+

Default value for hi is 64*12, default value for lo is +64*5, and default value for frac is 0.33. +

+
+ + + +

11.136 negate

+ +

Negate (invert) the input video. +

+

It accepts the following option: +

+
+
negate_alpha
+

With value 1, it negates the alpha component, if present. Default value is 0. +

+
+ + +

11.137 nlmeans

+ +

Denoise frames using Non-Local Means algorithm. +

+

Each pixel is adjusted by looking for other pixels with similar contexts. This +context similarity is defined by comparing their surrounding patches of size +pxp. Patches are searched in an area of rxr +around the pixel. +

+

Note that the research area defines centers for patches, which means some +patches will be made of pixels outside that research area. +

+

The filter accepts the following options. +

+
+
s
+

Set denoising strength. Default is 1.0. Must be in range [1.0, 30.0]. +

+
+
p
+

Set patch size. Default is 7. Must be odd number in range [0, 99]. +

+
+
pc
+

Same as p but for chroma planes. +

+

The default value is 0 and means automatic. +

+
+
r
+

Set research size. Default is 15. Must be odd number in range [0, 99]. +

+
+
rc
+

Same as r but for chroma planes. +

+

The default value is 0 and means automatic. +

+
+ + +

11.138 nnedi

+ +

Deinterlace video using neural network edge directed interpolation. +

+

This filter accepts the following options: +

+
+
weights
+

Mandatory option, without binary file filter can not work. +Currently file can be found here: +https://github.com/dubhater/vapoursynth-nnedi3/blob/master/src/nnedi3_weights.bin +

+
+
deint
+

Set which frames to deinterlace, by default it is all. +Can be all or interlaced. +

+
+
field
+

Set mode of operation. +

+

Can be one of the following: +

+
+
‘af’
+

Use frame flags, both fields. +

+
‘a’
+

Use frame flags, single field. +

+
‘t’
+

Use top field only. +

+
‘b’
+

Use bottom field only. +

+
‘tf’
+

Use both fields, top first. +

+
‘bf’
+

Use both fields, bottom first. +

+
+ +
+
planes
+

Set which planes to process, by default filter process all frames. +

+
+
nsize
+

Set size of local neighborhood around each pixel, used by the predictor neural +network. +

+

Can be one of the following: +

+
+
‘s8x6’
+
‘s16x6’
+
‘s32x6’
+
‘s48x6’
+
‘s8x4’
+
‘s16x4’
+
‘s32x4’
+
+ +
+
nns
+

Set the number of neurons in predictor neural network. +Can be one of the following: +

+
+
‘n16’
+
‘n32’
+
‘n64’
+
‘n128’
+
‘n256’
+
+ +
+
qual
+

Controls the number of different neural network predictions that are blended +together to compute the final output value. Can be fast, default or +slow. +

+
+
etype
+

Set which set of weights to use in the predictor. +Can be one of the following: +

+
+
‘a’
+

weights trained to minimize absolute error +

+
‘s’
+

weights trained to minimize squared error +

+
+ +
+
pscrn
+

Controls whether or not the prescreener neural network is used to decide +which pixels should be processed by the predictor neural network and which +can be handled by simple cubic interpolation. +The prescreener is trained to know whether cubic interpolation will be +sufficient for a pixel or whether it should be predicted by the predictor nn. +The computational complexity of the prescreener nn is much less than that of +the predictor nn. Since most pixels can be handled by cubic interpolation, +using the prescreener generally results in much faster processing. +The prescreener is pretty accurate, so the difference between using it and not +using it is almost always unnoticeable. +

+

Can be one of the following: +

+
+
‘none’
+
‘original’
+
‘new’
+
+ +

Default is new. +

+
+
fapprox
+

Set various debugging flags. +

+
+ + +

11.139 noformat

+ +

Force libavfilter not to use any of the specified pixel formats for the +input to the next filter. +

+

It accepts the following parameters: +

+
pix_fmts
+

A ’|’-separated list of pixel format names, such as +pix_fmts=yuv420p|monow|rgb24". +

+
+
+ + +

11.139.1 Examples

+ +
    +
  • Force libavfilter to use a format different from yuv420p for the +input to the vflip filter: +
    +
    noformat=pix_fmts=yuv420p,vflip
+
    + +
  • Convert the input video to any of the formats not contained in the list: +
    +
    noformat=yuv420p|yuv444p|yuv410p
+
    +
+ + +

11.140 noise

+ +

Add noise on video input frame. +

+

The filter accepts the following options: +

+
+
all_seed
+
c0_seed
+
c1_seed
+
c2_seed
+
c3_seed
+

Set noise seed for specific pixel component or all pixel components in case +of all_seed. Default value is 123457. +

+
+
all_strength, alls
+
c0_strength, c0s
+
c1_strength, c1s
+
c2_strength, c2s
+
c3_strength, c3s
+

Set noise strength for specific pixel component or all pixel components in case +all_strength. Default value is 0. Allowed range is [0, 100]. +

+
+
all_flags, allf
+
c0_flags, c0f
+
c1_flags, c1f
+
c2_flags, c2f
+
c3_flags, c3f
+

Set pixel component flags or set flags for all components if all_flags. +Available values for component flags are: +

+
‘a’
+

averaged temporal noise (smoother) +

+
‘p’
+

mix random noise with a (semi)regular pattern +

+
‘t’
+

temporal noise (noise pattern changes between frames) +

+
‘u’
+

uniform noise (gaussian otherwise) +

+
+
+
+ + +

11.140.1 Examples

+ +

Add temporal and uniform noise to input video: +

+
noise=alls=20:allf=t+u
+
+ + +

11.141 normalize

+ +

Normalize RGB video (aka histogram stretching, contrast stretching). +See: https://en.wikipedia.org/wiki/Normalization_(image_processing) +

+

For each channel of each frame, the filter computes the input range and maps +it linearly to the user-specified output range. The output range defaults +to the full dynamic range from pure black to pure white. +

+

Temporal smoothing can be used on the input range to reduce flickering (rapid +changes in brightness) caused when small dark or bright objects enter or leave +the scene. This is similar to the auto-exposure (automatic gain control) on a +video camera, and, like a video camera, it may cause a period of over- or +under-exposure of the video. +

+

The R,G,B channels can be normalized independently, which may cause some +color shifting, or linked together as a single channel, which prevents +color shifting. Linked normalization preserves hue. Independent normalization +does not, so it can be used to remove some color casts. Independent and linked +normalization can be combined in any ratio. +

+

The normalize filter accepts the following options: +

+
+
blackpt
+
whitept
+

Colors which define the output range. The minimum input value is mapped to +the blackpt. The maximum input value is mapped to the whitept. +The defaults are black and white respectively. Specifying white for +blackpt and black for whitept will give color-inverted, +normalized video. Shades of grey can be used to reduce the dynamic range +(contrast). Specifying saturated colors here can create some interesting +effects. +

+
+
smoothing
+

The number of previous frames to use for temporal smoothing. The input range +of each channel is smoothed using a rolling average over the current frame +and the smoothing previous frames. The default is 0 (no temporal +smoothing). +

+
+
independence
+

Controls the ratio of independent (color shifting) channel normalization to +linked (color preserving) normalization. 0.0 is fully linked, 1.0 is fully +independent. Defaults to 1.0 (fully independent). +

+
+
strength
+

Overall strength of the filter. 1.0 is full strength. 0.0 is a rather +expensive no-op. Defaults to 1.0 (full strength). +

+
+
+ + +

11.141.1 Commands

+

This filter supports same commands as options, excluding smoothing option. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.141.2 Examples

+ +

Stretch video contrast to use the full dynamic range, with no temporal +smoothing; may flicker depending on the source content: +

+
normalize=blackpt=black:whitept=white:smoothing=0
+
+ +

As above, but with 50 frames of temporal smoothing; flicker should be +reduced, depending on the source content: +

+
normalize=blackpt=black:whitept=white:smoothing=50
+
+ +

As above, but with hue-preserving linked channel normalization: +

+
normalize=blackpt=black:whitept=white:smoothing=50:independence=0
+
+ +

As above, but with half strength: +

+
normalize=blackpt=black:whitept=white:smoothing=50:independence=0:strength=0.5
+
+ +

Map the darkest input color to red, the brightest input color to cyan: +

+
normalize=blackpt=red:whitept=cyan
+
+ + +

11.142 null

+ +

Pass the video source unchanged to the output. +

+ +

11.143 ocr

+

Optical Character Recognition +

+

This filter uses Tesseract for optical character recognition. To enable +compilation of this filter, you need to configure FFmpeg with +--enable-libtesseract. +

+

It accepts the following options: +

+
+
datapath
+

Set datapath to tesseract data. Default is to use whatever was +set at installation. +

+
+
language
+

Set language, default is "eng". +

+
+
whitelist
+

Set character whitelist. +

+
+
blacklist
+

Set character blacklist. +

+
+ +

The filter exports recognized text as the frame metadata lavfi.ocr.text. +The filter exports confidence of recognized words as the frame metadata lavfi.ocr.confidence. +

+ +

11.144 ocv

+ +

Apply a video transform using libopencv. +

+

To enable this filter, install the libopencv library and headers and +configure FFmpeg with --enable-libopencv. +

+

It accepts the following parameters: +

+
+
filter_name
+

The name of the libopencv filter to apply. +

+
+
filter_params
+

The parameters to pass to the libopencv filter. If not specified, the default +values are assumed. +

+
+
+ +

Refer to the official libopencv documentation for more precise +information: +http://docs.opencv.org/master/modules/imgproc/doc/filtering.html +

+

Several libopencv filters are supported; see the following subsections. +

+ +

11.144.1 dilate

+ +

Dilate an image by using a specific structuring element. +It corresponds to the libopencv function cvDilate. +

+

It accepts the parameters: struct_el|nb_iterations. +

+

struct_el represents a structuring element, and has the syntax: +colsxrows+anchor_xxanchor_y/shape +

+

cols and rows represent the number of columns and rows of +the structuring element, anchor_x and anchor_y the anchor +point, and shape the shape for the structuring element. shape +must be "rect", "cross", "ellipse", or "custom". +

+

If the value for shape is "custom", it must be followed by a +string of the form "=filename". The file with name +filename is assumed to represent a binary image, with each +printable character corresponding to a bright pixel. When a custom +shape is used, cols and rows are ignored, the number +or columns and rows of the read file are assumed instead. +

+

The default value for struct_el is "3x3+0x0/rect". +

+

nb_iterations specifies the number of times the transform is +applied to the image, and defaults to 1. +

+

Some examples: +

+
# Use the default values
+ocv=dilate
+
+# Dilate using a structuring element with a 5x5 cross, iterating two times
+ocv=filter_name=dilate:filter_params=5x5+2x2/cross|2
+
+# Read the shape from the file diamond.shape, iterating two times.
+# The file diamond.shape may contain a pattern of characters like this
+#   *
+#  ***
+# *****
+#  ***
+#   *
+# The specified columns and rows are ignored
+# but the anchor point coordinates are not
+ocv=dilate:0x0+2x2/custom=diamond.shape|2
+
+ + +

11.144.2 erode

+ +

Erode an image by using a specific structuring element. +It corresponds to the libopencv function cvErode. +

+

It accepts the parameters: struct_el:nb_iterations, +with the same syntax and semantics as the dilate filter. +

+ +

11.144.3 smooth

+ +

Smooth the input video. +

+

The filter takes the following parameters: +type|param1|param2|param3|param4. +

+

type is the type of smooth filter to apply, and must be one of +the following values: "blur", "blur_no_scale", "median", "gaussian", +or "bilateral". The default value is "gaussian". +

+

The meaning of param1, param2, param3, and param4 +depends on the smooth type. param1 and +param2 accept integer positive values or 0. param3 and +param4 accept floating point values. +

+

The default value for param1 is 3. The default value for the +other parameters is 0. +

+

These parameters correspond to the parameters assigned to the +libopencv function cvSmooth. +

+ +

11.145 oscilloscope

+ +

2D Video Oscilloscope. +

+

Useful to measure spatial impulse, step responses, chroma delays, etc. +

+

It accepts the following parameters: +

+
+
x
+

Set scope center x position. +

+
+
y
+

Set scope center y position. +

+
+
s
+

Set scope size, relative to frame diagonal. +

+
+
t
+

Set scope tilt/rotation. +

+
+
o
+

Set trace opacity. +

+
+
tx
+

Set trace center x position. +

+
+
ty
+

Set trace center y position. +

+
+
tw
+

Set trace width, relative to width of frame. +

+
+
th
+

Set trace height, relative to height of frame. +

+
+
c
+

Set which components to trace. By default it traces first three components. +

+
+
g
+

Draw trace grid. By default is enabled. +

+
+
st
+

Draw some statistics. By default is enabled. +

+
+
sc
+

Draw scope. By default is enabled. +

+
+ + +

11.145.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

11.145.2 Examples

+ +
    +
  • Inspect full first row of video frame. +
    +
    oscilloscope=x=0.5:y=0:s=1
+
    + +
  • Inspect full last row of video frame. +
    +
    oscilloscope=x=0.5:y=1:s=1
+
    + +
  • Inspect full 5th line of video frame of height 1080. +
    +
    oscilloscope=x=0.5:y=5/1080:s=1
+
    + +
  • Inspect full last column of video frame. +
    +
    oscilloscope=x=1:y=0.5:s=1:t=1
+
    + +
+ + +

11.146 overlay

+ +

Overlay one video on top of another. +

+

It takes two inputs and has one output. The first input is the "main" +video on which the second input is overlaid. +

+

It accepts the following parameters: +

+

A description of the accepted options follows. +

+
+
x
+
y
+

Set the expression for the x and y coordinates of the overlaid video +on the main video. Default value is "0" for both expressions. In case +the expression is invalid, it is set to a huge value (meaning that the +overlay will not be displayed within the output visible area). +

+
+
eof_action
+

See framesync. +

+
+
eval
+

Set when the expressions for x, and y are evaluated. +

+

It accepts the following values: +

+
‘init’
+

only evaluate expressions once during the filter initialization or +when a command is processed +

+
+
‘frame’
+

evaluate expressions for each incoming frame +

+
+ +

Default value is ‘frame’. +

+
+
shortest
+

See framesync. +

+
+
format
+

Set the format for the output video. +

+

It accepts the following values: +

+
‘yuv420’
+

force YUV420 output +

+
+
‘yuv422’
+

force YUV422 output +

+
+
‘yuv444’
+

force YUV444 output +

+
+
‘rgb’
+

force packed RGB output +

+
+
‘gbrp’
+

force planar RGB output +

+
+
‘auto’
+

automatically pick format +

+
+ +

Default value is ‘yuv420’. +

+
+
repeatlast
+

See framesync. +

+
+
alpha
+

Set format of alpha of the overlaid video, it can be straight or +premultiplied. Default is straight. +

+
+ +

The x, and y expressions can contain the following +parameters. +

+
+
main_w, W
+
main_h, H
+

The main input width and height. +

+
+
overlay_w, w
+
overlay_h, h
+

The overlay input width and height. +

+
+
x
+
y
+

The computed values for x and y. They are evaluated for +each new frame. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values of the output +format. For example for the pixel format "yuv422p" hsub is 2 and +vsub is 1. +

+
+
n
+

the number of input frame, starting from 0 +

+
+
pos
+

the position in the file of the input frame, NAN if unknown +

+
+
t
+

The timestamp, expressed in seconds. It’s NAN if the input timestamp is unknown. +

+
+
+ +

This filter also supports the framesync options. +

+

Note that the n, pos, t variables are available only +when evaluation is done per frame, and will evaluate to NAN +when eval is set to ‘init’. +

+

Be aware that frames are taken from each input video in timestamp +order, hence, if their initial timestamps differ, it is a good idea +to pass the two inputs through a setpts=PTS-STARTPTS filter to +have them begin in the same zero timestamp, as the example for +the movie filter does. +

+

You can chain together more overlays but you should test the +efficiency of such approach. +

+ +

11.146.1 Commands

+ +

This filter supports the following commands: +

+
x
+
y
+

Modify the x and y of the overlay input. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

11.146.2 Examples

+ +
    +
  • Draw the overlay at 10 pixels from the bottom right corner of the main +video: +
    +
    overlay=main_w-overlay_w-10:main_h-overlay_h-10
+
    + +

    Using named options the example above becomes: +

    +
    overlay=x=main_w-overlay_w-10:y=main_h-overlay_h-10
+
    + +
  • Insert a transparent PNG logo in the bottom left corner of the input, +using the ffmpeg tool with the -filter_complex option: +
    +
    ffmpeg -i input -i logo -filter_complex 'overlay=10:main_h-overlay_h-10' output
+
    + +
  • Insert 2 different transparent PNG logos (second logo on bottom +right corner) using the ffmpeg tool: +
    +
    ffmpeg -i input -i logo1 -i logo2 -filter_complex 'overlay=x=10:y=H-h-10,overlay=x=W-w-10:y=H-h-10' output
+
    + +
  • Add a transparent color layer on top of the main video; WxH +must specify the size of the main input to the overlay filter: +
    +
    color=color=red@.3:size=WxH [over]; [in][over] overlay [out]
+
    + +
  • Play an original video and a filtered version (here with the deshake +filter) side by side using the ffplay tool: +
    +
    ffplay input.avi -vf 'split[a][b]; [a]pad=iw*2:ih[src]; [b]deshake[filt]; [src][filt]overlay=w'
+
    + +

    The above command is the same as: +

    +
    ffplay input.avi -vf 'split[b], pad=iw*2[src], [b]deshake, [src]overlay=w'
+
    + +
  • Make a sliding overlay appearing from the left to the right top part of the +screen starting since time 2: +
    +
    overlay=x='if(gte(t,2), -w+(t-2)*20, NAN)':y=0
+
    + +
  • Compose output by putting two input videos side to side: +
    +
    ffmpeg -i left.avi -i right.avi -filter_complex "
+nullsrc=size=200x100 [background];
+[0:v] setpts=PTS-STARTPTS, scale=100x100 [left];
+[1:v] setpts=PTS-STARTPTS, scale=100x100 [right];
+[background][left]       overlay=shortest=1       [background+left];
+[background+left][right] overlay=shortest=1:x=100 [left+right]
+"
+
    + +
  • Mask 10-20 seconds of a video by applying the delogo filter to a section +
    +
    ffmpeg -i test.avi -codec:v:0 wmv2 -ar 11025 -b:v 9000k
+-vf '[in]split[split_main][split_delogo];[split_delogo]trim=start=360:end=371,delogo=0:0:640:480[delogoed];[split_main][delogoed]overlay=eof_action=pass[out]'
+masked.avi
+
    + +
  • Chain several overlays in cascade: +
    +
    nullsrc=s=200x200 [bg];
+testsrc=s=100x100, split=4 [in0][in1][in2][in3];
+[in0] lutrgb=r=0, [bg]   overlay=0:0     [mid0];
+[in1] lutrgb=g=0, [mid0] overlay=100:0   [mid1];
+[in2] lutrgb=b=0, [mid1] overlay=0:100   [mid2];
+[in3] null,       [mid2] overlay=100:100 [out0]
+
    + +
+ + +

11.147 overlay_cuda

+ +

Overlay one video on top of another. +

+

This is the CUDA cariant of the overlay filter. +It only accepts CUDA frames. The underlying input pixel formats have to match. +

+

It takes two inputs and has one output. The first input is the "main" +video on which the second input is overlaid. +

+

It accepts the following parameters: +

+
+
x
+
y
+

Set the x and y coordinates of the overlaid video on the main video. +Default value is "0" for both expressions. +

+
+
eof_action
+

See framesync. +

+
+
shortest
+

See framesync. +

+
+
repeatlast
+

See framesync. +

+
+
+ +

This filter also supports the framesync options. +

+ +

11.148 owdenoise

+ +

Apply Overcomplete Wavelet denoiser. +

+

The filter accepts the following options: +

+
+
depth
+

Set depth. +

+

Larger depth values will denoise lower frequency components more, but +slow down filtering. +

+

Must be an int in the range 8-16, default is 8. +

+
+
luma_strength, ls
+

Set luma strength. +

+

Must be a double value in the range 0-1000, default is 1.0. +

+
+
chroma_strength, cs
+

Set chroma strength. +

+

Must be a double value in the range 0-1000, default is 1.0. +

+
+ + +

11.149 pad

+ +

Add paddings to the input image, and place the original input at the +provided x, y coordinates. +

+

It accepts the following parameters: +

+
+
width, w
+
height, h
+

Specify an expression for the size of the output image with the +paddings added. If the value for width or height is 0, the +corresponding input size is used for the output. +

+

The width expression can reference the value set by the +height expression, and vice versa. +

+

The default value of width and height is 0. +

+
+
x
+
y
+

Specify the offsets to place the input image at within the padded area, +with respect to the top/left border of the output image. +

+

The x expression can reference the value set by the y +expression, and vice versa. +

+

The default value of x and y is 0. +

+

If x or y evaluate to a negative number, they’ll be changed +so the input image is centered on the padded area. +

+
+
color
+

Specify the color of the padded area. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. +

+

The default value of color is "black". +

+
+
eval
+

Specify when to evaluate width, height, x and y expression. +

+

It accepts the following values: +

+
+
‘init’
+

Only evaluate expressions once during the filter initialization or when +a command is processed. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. +

+
+
+ +

Default value is ‘init’. +

+
+
aspect
+

Pad to aspect instead to a resolution. +

+
+
+ +

The value for the width, height, x, and y +options are expressions containing the following constants: +

+
+
in_w
+
in_h
+

The input video width and height. +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output width and height (the size of the padded area), as +specified by the width and height expressions. +

+
+
ow
+
oh
+

These are the same as out_w and out_h. +

+
+
x
+
y
+

The x and y offsets as specified by the x and y +expressions, or NAN if not yet specified. +

+
+
a
+

same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (iw / ih) * sar +

+
+
hsub
+
vsub
+

The horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+ + +

11.149.1 Examples

+ +
    +
  • Add paddings with the color "violet" to the input video. The output video +size is 640x480, and the top-left corner of the input video is placed at +column 0, row 40 +
    +
    pad=640:480:0:40:violet
+
    + +

    The example above is equivalent to the following command: +

    +
    pad=width=640:height=480:x=0:y=40:color=violet
+
    + +
  • Pad the input to get an output with dimensions increased by 3/2, +and put the input video at the center of the padded area: +
    +
    pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • Pad the input to get a squared output with size equal to the maximum +value between the input width and height, and put the input video at +the center of the padded area: +
    +
    pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • Pad the input to get a final w/h ratio of 16:9: +
    +
    pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • In case of anamorphic video, in order to set the output display aspect +correctly, it is necessary to use sar in the expression, +according to the relation: +
    +
    (ih * X / ih) * sar = output_dar
+X = output_dar / sar
+
    + +

    Thus the previous example needs to be modified to: +

    +
    pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • Double the output size and put the input video in the bottom-right +corner of the output padded area: +
    +
    pad="2*iw:2*ih:ow-iw:oh-ih"
+
    +
+ + +

11.150 palettegen

+ +

Generate one palette for a whole video stream. +

+

It accepts the following options: +

+
+
max_colors
+

Set the maximum number of colors to quantize in the palette. +Note: the palette will still contain 256 colors; the unused palette entries +will be black. +

+
+
reserve_transparent
+

Create a palette of 255 colors maximum and reserve the last one for +transparency. Reserving the transparency color is useful for GIF optimization. +If not set, the maximum of colors in the palette will be 256. You probably want +to disable this option for a standalone image. +Set by default. +

+
+
transparency_color
+

Set the color that will be used as background for transparency. +

+
+
stats_mode
+

Set statistics mode. +

+

It accepts the following values: +

+
‘full’
+

Compute full frame histograms. +

+
‘diff’
+

Compute histograms only for the part that differs from previous frame. This +might be relevant to give more importance to the moving part of your input if +the background is static. +

+
‘single’
+

Compute new histogram for each frame. +

+
+ +

Default value is full. +

+
+ +

The filter also exports the frame metadata lavfi.color_quant_ratio +(nb_color_in / nb_color_out) which you can use to evaluate the degree of +color quantization of the palette. This information is also visible at +info logging level. +

+ +

11.150.1 Examples

+ +
    +
  • Generate a representative palette of a given video using ffmpeg: +
    +
    ffmpeg -i input.mkv -vf palettegen palette.png
+
    +
+ + +

11.151 paletteuse

+ +

Use a palette to downsample an input video stream. +

+

The filter takes two inputs: one video stream and a palette. The palette must +be a 256 pixels image. +

+

It accepts the following options: +

+
+
dither
+

Select dithering mode. Available algorithms are: +

+
‘bayer’
+

Ordered 8x8 bayer dithering (deterministic) +

+
‘heckbert’
+

Dithering as defined by Paul Heckbert in 1982 (simple error diffusion). +Note: this dithering is sometimes considered "wrong" and is included as a +reference. +

+
‘floyd_steinberg’
+

Floyd and Steingberg dithering (error diffusion) +

+
‘sierra2’
+

Frankie Sierra dithering v2 (error diffusion) +

+
‘sierra2_4a’
+

Frankie Sierra dithering v2 "Lite" (error diffusion) +

+
+ +

Default is sierra2_4a. +

+
+
bayer_scale
+

When bayer dithering is selected, this option defines the scale of the +pattern (how much the crosshatch pattern is visible). A low value means more +visible pattern for less banding, and higher value means less visible pattern +at the cost of more banding. +

+

The option must be an integer value in the range [0,5]. Default is 2. +

+
+
diff_mode
+

If set, define the zone to process +

+
+
‘rectangle’
+

Only the changing rectangle will be reprocessed. This is similar to GIF +cropping/offsetting compression mechanism. This option can be useful for speed +if only a part of the image is changing, and has use cases such as limiting the +scope of the error diffusal dither to the rectangle that bounds the +moving scene (it leads to more deterministic output if the scene doesn’t change +much, and as a result less moving noise and better GIF compression). +

+
+ +

Default is none. +

+
+
new
+

Take new palette for each output frame. +

+
+
alpha_threshold
+

Sets the alpha threshold for transparency. Alpha values above this threshold +will be treated as completely opaque, and values below this threshold will be +treated as completely transparent. +

+

The option must be an integer value in the range [0,255]. Default is 128. +

+
+ + +

11.151.1 Examples

+ +
    +
  • Use a palette (generated for example with palettegen) to encode a GIF +using ffmpeg: +
    +
    ffmpeg -i input.mkv -i palette.png -lavfi paletteuse output.gif
+
    +
+ + +

11.152 perspective

+ +

Correct perspective of video not recorded perpendicular to the screen. +

+

A description of the accepted parameters follows. +

+
+
x0
+
y0
+
x1
+
y1
+
x2
+
y2
+
x3
+
y3
+

Set coordinates expression for top left, top right, bottom left and bottom right corners. +Default values are 0:0:W:0:0:H:W:H with which perspective will remain unchanged. +If the sense option is set to source, then the specified points will be sent +to the corners of the destination. If the sense option is set to destination, +then the corners of the source will be sent to the specified coordinates. +

+

The expressions can use the following variables: +

+
+
W
+
H
+

the width and height of video frame. +

+
in
+

Input frame count. +

+
on
+

Output frame count. +

+
+ +
+
interpolation
+

Set interpolation for perspective correction. +

+

It accepts the following values: +

+
‘linear’
+
‘cubic’
+
+ +

Default value is ‘linear’. +

+
+
sense
+

Set interpretation of coordinate options. +

+

It accepts the following values: +

+
‘0, source’
+
+

Send point in the source specified by the given coordinates to +the corners of the destination. +

+
+
‘1, destination’
+
+

Send the corners of the source to the point in the destination specified +by the given coordinates. +

+

Default value is ‘source’. +

+
+ +
+
eval
+

Set when the expressions for coordinates x0,y0,...x3,y3 are evaluated. +

+

It accepts the following values: +

+
‘init’
+

only evaluate expressions once during the filter initialization or +when a command is processed +

+
+
‘frame’
+

evaluate expressions for each incoming frame +

+
+ +

Default value is ‘init’. +

+
+ + +

11.153 phase

+ +

Delay interlaced video by one field time so that the field order changes. +

+

The intended use is to fix PAL movies that have been captured with the +opposite field order to the film-to-video transfer. +

+

A description of the accepted parameters follows. +

+
+
mode
+

Set phase mode. +

+

It accepts the following values: +

+
‘t’
+

Capture field order top-first, transfer bottom-first. +Filter will delay the bottom field. +

+
+
‘b’
+

Capture field order bottom-first, transfer top-first. +Filter will delay the top field. +

+
+
‘p’
+

Capture and transfer with the same field order. This mode only exists +for the documentation of the other options to refer to, but if you +actually select it, the filter will faithfully do nothing. +

+
+
‘a’
+

Capture field order determined automatically by field flags, transfer +opposite. +Filter selects among ‘t’ and ‘b’ modes on a frame by frame +basis using field flags. If no field information is available, +then this works just like ‘u’. +

+
+
‘u’
+

Capture unknown or varying, transfer opposite. +Filter selects among ‘t’ and ‘b’ on a frame by frame basis by +analyzing the images and selecting the alternative that produces best +match between the fields. +

+
+
‘T’
+

Capture top-first, transfer unknown or varying. +Filter selects among ‘t’ and ‘p’ using image analysis. +

+
+
‘B’
+

Capture bottom-first, transfer unknown or varying. +Filter selects among ‘b’ and ‘p’ using image analysis. +

+
+
‘A’
+

Capture determined by field flags, transfer unknown or varying. +Filter selects among ‘t’, ‘b’ and ‘p’ using field flags and +image analysis. If no field information is available, then this works just +like ‘U’. This is the default mode. +

+
+
‘U’
+

Both capture and transfer unknown or varying. +Filter selects among ‘t’, ‘b’ and ‘p’ using image analysis only. +

+
+
+
+ + +

11.154 photosensitivity

+

Reduce various flashes in video, so to help users with epilepsy. +

+

It accepts the following options: +

+
frames, f
+

Set how many frames to use when filtering. Default is 30. +

+
+
threshold, t
+

Set detection threshold factor. Default is 1. +Lower is stricter. +

+
+
skip
+

Set how many pixels to skip when sampling frames. Default is 1. +Allowed range is from 1 to 1024. +

+
+
bypass
+

Leave frames unchanged. Default is disabled. +

+
+ + +

11.155 pixdesctest

+ +

Pixel format descriptor test filter, mainly useful for internal +testing. The output video should be equal to the input video. +

+

For example: +

+
format=monow, pixdesctest
+
+ +

can be used to test the monowhite pixel format descriptor definition. +

+ +

11.156 pixscope

+ +

Display sample values of color channels. Mainly useful for checking color +and levels. Minimum supported resolution is 640x480. +

+

The filters accept the following options: +

+
+
x
+

Set scope X position, relative offset on X axis. +

+
+
y
+

Set scope Y position, relative offset on Y axis. +

+
+
w
+

Set scope width. +

+
+
h
+

Set scope height. +

+
+
o
+

Set window opacity. This window also holds statistics about pixel area. +

+
+
wx
+

Set window X position, relative offset on X axis. +

+
+
wy
+

Set window Y position, relative offset on Y axis. +

+
+ + +

11.157 pp

+ +

Enable the specified chain of postprocessing subfilters using libpostproc. This +library should be automatically selected with a GPL build (--enable-gpl). +Subfilters must be separated by ’/’ and can be disabled by prepending a ’-’. +Each subfilter and some options have a short and a long name that can be used +interchangeably, i.e. dr/dering are the same. +

+

The filters accept the following options: +

+
+
subfilters
+

Set postprocessing subfilters string. +

+
+ +

All subfilters share common options to determine their scope: +

+
+
a/autoq
+

Honor the quality commands for this subfilter. +

+
+
c/chrom
+

Do chrominance filtering, too (default). +

+
+
y/nochrom
+

Do luminance filtering only (no chrominance). +

+
+
n/noluma
+

Do chrominance filtering only (no luminance). +

+
+ +

These options can be appended after the subfilter name, separated by a ’|’. +

+

Available subfilters are: +

+
+
hb/hdeblock[|difference[|flatness]]
+

Horizontal deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+ +
+
vb/vdeblock[|difference[|flatness]]
+

Vertical deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+ +
+
ha/hadeblock[|difference[|flatness]]
+

Accurate horizontal deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+ +
+
va/vadeblock[|difference[|flatness]]
+

Accurate vertical deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+
+
+ +

The horizontal and vertical deblocking filters share the difference and +flatness values so you cannot set different horizontal and vertical +thresholds. +

+
+
h1/x1hdeblock
+

Experimental horizontal deblocking filter +

+
+
v1/x1vdeblock
+

Experimental vertical deblocking filter +

+
+
dr/dering
+

Deringing filter +

+
+
tn/tmpnoise[|threshold1[|threshold2[|threshold3]]], temporal noise reducer
+
+
threshold1
+

larger -> stronger filtering +

+
threshold2
+

larger -> stronger filtering +

+
threshold3
+

larger -> stronger filtering +

+
+ +
+
al/autolevels[:f/fullyrange], automatic brightness / contrast correction
+
+
f/fullyrange
+

Stretch luminance to 0-255. +

+
+ +
+
lb/linblenddeint
+

Linear blend deinterlacing filter that deinterlaces the given block by +filtering all lines with a (1 2 1) filter. +

+
+
li/linipoldeint
+

Linear interpolating deinterlacing filter that deinterlaces the given block by +linearly interpolating every second line. +

+
+
ci/cubicipoldeint
+

Cubic interpolating deinterlacing filter deinterlaces the given block by +cubically interpolating every second line. +

+
+
md/mediandeint
+

Median deinterlacing filter that deinterlaces the given block by applying a +median filter to every second line. +

+
+
fd/ffmpegdeint
+

FFmpeg deinterlacing filter that deinterlaces the given block by filtering every +second line with a (-1 4 2 4 -1) filter. +

+
+
l5/lowpass5
+

Vertically applied FIR lowpass deinterlacing filter that deinterlaces the given +block by filtering all lines with a (-1 2 6 2 -1) filter. +

+
+
fq/forceQuant[|quantizer]
+

Overrides the quantizer table from the input with the constant quantizer you +specify. +

+
quantizer
+

Quantizer to use +

+
+ +
+
de/default
+

Default pp filter combination (hb|a,vb|a,dr|a) +

+
+
fa/fast
+

Fast pp filter combination (h1|a,v1|a,dr|a) +

+
+
ac
+

High quality pp filter combination (ha|a|128|7,va|a,dr|a) +

+
+ + +

11.157.1 Examples

+ +
    +
  • Apply horizontal and vertical deblocking, deringing and automatic +brightness/contrast: +
    +
    pp=hb/vb/dr/al
+
    + +
  • Apply default filters without brightness/contrast correction: +
    +
    pp=de/-al
+
    + +
  • Apply default filters and temporal denoiser: +
    +
    pp=default/tmpnoise|1|2|3
+
    + +
  • Apply deblocking on luminance only, and switch vertical deblocking on or off +automatically depending on available CPU time: +
    +
    pp=hb|y/vb|a
+
    +
+ + +

11.158 pp7

+

Apply Postprocessing filter 7. It is variant of the spp filter, +similar to spp = 6 with 7 point DCT, where only the center sample is +used after IDCT. +

+

The filter accepts the following options: +

+
+
qp
+

Force a constant quantization parameter. It accepts an integer in range +0 to 63. If not set, the filter will use the QP from the video stream +(if available). +

+
+
mode
+

Set thresholding mode. Available modes are: +

+
+
‘hard’
+

Set hard thresholding. +

+
‘soft’
+

Set soft thresholding (better de-ringing effect, but likely blurrier). +

+
‘medium’
+

Set medium thresholding (good results, default). +

+
+
+
+ + +

11.159 premultiply

+

Apply alpha premultiply effect to input video stream using first plane +of second stream as alpha. +

+

Both streams must have same dimensions and same pixel format. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
inplace
+

Do not require 2nd input for processing, instead use alpha plane from input stream. +

+
+ + +

11.160 prewitt

+

Apply prewitt operator to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +

+
+
delta
+

Set value which will be added to filtered result. +

+
+ + +

11.161 pseudocolor

+ +

Alter frame colors in video with pseudocolors. +

+

This filter accepts the following options: +

+
+
c0
+

set pixel first component expression +

+
+
c1
+

set pixel second component expression +

+
+
c2
+

set pixel third component expression +

+
+
c3
+

set pixel fourth component expression, corresponds to the alpha component +

+
+
i
+

set component to use as base for altering colors +

+
+ +

Each of them specifies the expression to use for computing the lookup table for +the corresponding pixel component values. +

+

The expressions can contain the following constants and functions: +

+
+
w
+
h
+

The input width and height. +

+
+
val
+

The input value for the pixel component. +

+
+
ymin, umin, vmin, amin
+

The minimum allowed component value. +

+
+
ymax, umax, vmax, amax
+

The maximum allowed component value. +

+
+ +

All expressions default to "val". +

+ +

11.161.1 Examples

+ +
    +
  • Change too high luma values to gradient: +
    +
    pseudocolor="'if(between(val,ymax,amax),lerp(ymin,ymax,(val-ymax)/(amax-ymax)),-1):if(between(val,ymax,amax),lerp(umax,umin,(val-ymax)/(amax-ymax)),-1):if(between(val,ymax,amax),lerp(vmin,vmax,(val-ymax)/(amax-ymax)),-1):-1'"
+
    +
+ + +

11.162 psnr

+ +

Obtain the average, maximum and minimum PSNR (Peak Signal to Noise +Ratio) between two input videos. +

+

This filter takes in input two input videos, the first input is +considered the "main" source and is passed unchanged to the +output. The second input is used as a "reference" video for computing +the PSNR. +

+

Both video inputs must have the same resolution and pixel format for +this filter to work correctly. Also it assumes that both inputs +have the same number of frames, which are compared one by one. +

+

The obtained average PSNR is printed through the logging system. +

+

The filter stores the accumulated MSE (mean squared error) of each +frame, and at the end of the processing it is averaged across all frames +equally, and the following formula is applied to obtain the PSNR: +

+
+
PSNR = 10*log10(MAX^2/MSE)
+
+ +

Where MAX is the average of the maximum values of each component of the +image. +

+

The description of the accepted parameters follows. +

+
+
stats_file, f
+

If specified the filter will use the named file to save the PSNR of +each individual frame. When filename equals "-" the data is sent to +standard output. +

+
+
stats_version
+

Specifies which version of the stats file format to use. Details of +each format are written below. +Default value is 1. +

+
+
stats_add_max
+

Determines whether the max value is output to the stats log. +Default value is 0. +Requires stats_version >= 2. If this is set and stats_version < 2, +the filter will return an error. +

+
+ +

This filter also supports the framesync options. +

+

The file printed if stats_file is selected, contains a sequence of +key/value pairs of the form key:value for each compared +couple of frames. +

+

If a stats_version greater than 1 is specified, a header line precedes +the list of per-frame-pair stats, with key value pairs following the frame +format with the following parameters: +

+
+
psnr_log_version
+

The version of the log file format. Will match stats_version. +

+
+
fields
+

A comma separated list of the per-frame-pair parameters included in +the log. +

+
+ +

A description of each shown per-frame-pair parameter follows: +

+
+
n
+

sequential number of the input frame, starting from 1 +

+
+
mse_avg
+

Mean Square Error pixel-by-pixel average difference of the compared +frames, averaged over all the image components. +

+
+
mse_y, mse_u, mse_v, mse_r, mse_g, mse_b, mse_a
+

Mean Square Error pixel-by-pixel average difference of the compared +frames for the component specified by the suffix. +

+
+
psnr_y, psnr_u, psnr_v, psnr_r, psnr_g, psnr_b, psnr_a
+

Peak Signal to Noise ratio of the compared frames for the component +specified by the suffix. +

+
+
max_avg, max_y, max_u, max_v
+

Maximum allowed value for each channel, and average over all +channels. +

+
+ + +

11.162.1 Examples

+
    +
  • For example: +
    +
    movie=ref_movie.mpg, setpts=PTS-STARTPTS [main];
+[main][ref] psnr="stats_file=stats.log" [out]
+
    + +

    On this example the input file being processed is compared with the +reference file ref_movie.mpg. The PSNR of each individual frame +is stored in stats.log. +

    +
  • Another example with different containers: +
    +
    ffmpeg -i main.mpg -i ref.mkv -lavfi  "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]psnr" -f null -
+
    +
+ + +

11.163 pullup

+ +

Pulldown reversal (inverse telecine) filter, capable of handling mixed +hard-telecine, 24000/1001 fps progressive, and 30000/1001 fps progressive +content. +

+

The pullup filter is designed to take advantage of future context in making +its decisions. This filter is stateless in the sense that it does not lock +onto a pattern to follow, but it instead looks forward to the following +fields in order to identify matches and rebuild progressive frames. +

+

To produce content with an even framerate, insert the fps filter after +pullup, use fps=24000/1001 if the input frame rate is 29.97fps, +fps=24 for 30fps and the (rare) telecined 25fps input. +

+

The filter accepts the following options: +

+
+
jl
+
jr
+
jt
+
jb
+

These options set the amount of "junk" to ignore at the left, right, top, and +bottom of the image, respectively. Left and right are in units of 8 pixels, +while top and bottom are in units of 2 lines. +The default is 8 pixels on each side. +

+
+
sb
+

Set the strict breaks. Setting this option to 1 will reduce the chances of +filter generating an occasional mismatched frame, but it may also cause an +excessive number of frames to be dropped during high motion sequences. +Conversely, setting it to -1 will make filter match fields more easily. +This may help processing of video where there is slight blurring between +the fields, but may also cause there to be interlaced frames in the output. +Default value is 0. +

+
+
mp
+

Set the metric plane to use. It accepts the following values: +

+
‘l’
+

Use luma plane. +

+
+
‘u’
+

Use chroma blue plane. +

+
+
‘v’
+

Use chroma red plane. +

+
+ +

This option may be set to use chroma plane instead of the default luma plane +for doing filter’s computations. This may improve accuracy on very clean +source material, but more likely will decrease accuracy, especially if there +is chroma noise (rainbow effect) or any grayscale video. +The main purpose of setting mp to a chroma plane is to reduce CPU +load and make pullup usable in realtime on slow machines. +

+
+ +

For best results (without duplicated frames in the output file) it is +necessary to change the output frame rate. For example, to inverse +telecine NTSC input: +

+
ffmpeg -i input -vf pullup -r 24000/1001 ...
+
+ + +

11.164 qp

+ +

Change video quantization parameters (QP). +

+

The filter accepts the following option: +

+
+
qp
+

Set expression for quantization parameter. +

+
+ +

The expression is evaluated through the eval API and can contain, among others, +the following constants: +

+
+
known
+

1 if index is not 129, 0 otherwise. +

+
+
qp
+

Sequential index starting from -129 to 128. +

+
+ + +

11.164.1 Examples

+ +
    +
  • Some equation like: +
    +
    qp=2+2*sin(PI*qp)
+
    +
+ + +

11.165 random

+ +

Flush video frames from internal cache of frames into a random order. +No frame is discarded. +Inspired by frei0r nervous filter. +

+
+
frames
+

Set size in number of frames of internal cache, in range from 2 to +512. Default is 30. +

+
+
seed
+

Set seed for random number generator, must be an integer included between +0 and UINT32_MAX. If not specified, or if explicitly set to +less than 0, the filter will try to use a good random seed on a +best effort basis. +

+
+ + +

11.166 readeia608

+ +

Read closed captioning (EIA-608) information from the top lines of a video frame. +

+

This filter adds frame metadata for lavfi.readeia608.X.cc and +lavfi.readeia608.X.line, where X is the number of the identified line +with EIA-608 data (starting from 0). A description of each metadata value follows: +

+
+
lavfi.readeia608.X.cc
+

The two bytes stored as EIA-608 data (printed in hexadecimal). +

+
+
lavfi.readeia608.X.line
+

The number of the line on which the EIA-608 data was identified and read. +

+
+ +

This filter accepts the following options: +

+
+
scan_min
+

Set the line to start scanning for EIA-608 data. Default is 0. +

+
+
scan_max
+

Set the line to end scanning for EIA-608 data. Default is 29. +

+
+
spw
+

Set the ratio of width reserved for sync code detection. +Default is 0.27. Allowed range is [0.1 - 0.7]. +

+
+
chp
+

Enable checking the parity bit. In the event of a parity error, the filter will output +0x00 for that character. Default is false. +

+
+
lp
+

Lowpass lines prior to further processing. Default is enabled. +

+
+ + +

11.166.1 Examples

+ +
    +
  • Output a csv with presentation time and the first two lines of identified EIA-608 captioning data. +
    +
    ffprobe -f lavfi -i movie=captioned_video.mov,readeia608 -show_entries frame=pkt_pts_time:frame_tags=lavfi.readeia608.0.cc,lavfi.readeia608.1.cc -of csv
+
    +
+ + +

11.167 readvitc

+ +

Read vertical interval timecode (VITC) information from the top lines of a +video frame. +

+

The filter adds frame metadata key lavfi.readvitc.tc_str with the +timecode value, if a valid timecode has been detected. Further metadata key +lavfi.readvitc.found is set to 0/1 depending on whether +timecode data has been found or not. +

+

This filter accepts the following options: +

+
+
scan_max
+

Set the maximum number of lines to scan for VITC data. If the value is set to +-1 the full video frame is scanned. Default is 45. +

+
+
thr_b
+

Set the luma threshold for black. Accepts float numbers in the range [0.0,1.0], +default value is 0.2. The value must be equal or less than thr_w. +

+
+
thr_w
+

Set the luma threshold for white. Accepts float numbers in the range [0.0,1.0], +default value is 0.6. The value must be equal or greater than thr_b. +

+
+ + +

11.167.1 Examples

+ +
    +
  • Detect and draw VITC data onto the video frame; if no valid VITC is detected, +draw --:--:--:-- as a placeholder: +
    +
    ffmpeg -i input.avi -filter:v 'readvitc,drawtext=fontfile=FreeMono.ttf:text=%{metadata\\:lavfi.readvitc.tc_str\\:--\\\\\\:--\\\\\\:--\\\\\\:--}:x=(w-tw)/2:y=400-ascent'
+
    +
+ + +

11.168 remap

+ +

Remap pixels using 2nd: Xmap and 3rd: Ymap input video stream. +

+

Destination pixel at position (X, Y) will be picked from source (x, y) position +where x = Xmap(X, Y) and y = Ymap(X, Y). If mapping values are out of range, zero +value for pixel will be used for destination pixel. +

+

Xmap and Ymap input video streams must be of same dimensions. Output video stream +will have Xmap/Ymap video stream dimensions. +Xmap and Ymap input video streams are 16bit depth, single channel. +

+
+
format
+

Specify pixel format of output from this filter. Can be color or gray. +Default is color. +

+
+
fill
+

Specify the color of the unmapped pixels. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. Default color is black. +

+
+ + +

11.169 removegrain

+ +

The removegrain filter is a spatial denoiser for progressive video. +

+
+
m0
+

Set mode for the first plane. +

+
+
m1
+

Set mode for the second plane. +

+
+
m2
+

Set mode for the third plane. +

+
+
m3
+

Set mode for the fourth plane. +

+
+ +

Range of mode is from 0 to 24. Description of each mode follows: +

+
+
0
+

Leave input plane unchanged. Default. +

+
+
1
+

Clips the pixel with the minimum and maximum of the 8 neighbour pixels. +

+
+
2
+

Clips the pixel with the second minimum and maximum of the 8 neighbour pixels. +

+
+
3
+

Clips the pixel with the third minimum and maximum of the 8 neighbour pixels. +

+
+
4
+

Clips the pixel with the fourth minimum and maximum of the 8 neighbour pixels. +This is equivalent to a median filter. +

+
+
5
+

Line-sensitive clipping giving the minimal change. +

+
+
6
+

Line-sensitive clipping, intermediate. +

+
+
7
+

Line-sensitive clipping, intermediate. +

+
+
8
+

Line-sensitive clipping, intermediate. +

+
+
9
+

Line-sensitive clipping on a line where the neighbours pixels are the closest. +

+
+
10
+

Replaces the target pixel with the closest neighbour. +

+
+
11
+

[1 2 1] horizontal and vertical kernel blur. +

+
+
12
+

Same as mode 11. +

+
+
13
+

Bob mode, interpolates top field from the line where the neighbours +pixels are the closest. +

+
+
14
+

Bob mode, interpolates bottom field from the line where the neighbours +pixels are the closest. +

+
+
15
+

Bob mode, interpolates top field. Same as 13 but with a more complicated +interpolation formula. +

+
+
16
+

Bob mode, interpolates bottom field. Same as 14 but with a more complicated +interpolation formula. +

+
+
17
+

Clips the pixel with the minimum and maximum of respectively the maximum and +minimum of each pair of opposite neighbour pixels. +

+
+
18
+

Line-sensitive clipping using opposite neighbours whose greatest distance from +the current pixel is minimal. +

+
+
19
+

Replaces the pixel with the average of its 8 neighbours. +

+
+
20
+

Averages the 9 pixels ([1 1 1] horizontal and vertical blur). +

+
+
21
+

Clips pixels using the averages of opposite neighbour. +

+
+
22
+

Same as mode 21 but simpler and faster. +

+
+
23
+

Small edge and halo removal, but reputed useless. +

+
+
24
+

Similar as 23. +

+
+ + +

11.170 removelogo

+ +

Suppress a TV station logo, using an image file to determine which +pixels comprise the logo. It works by filling in the pixels that +comprise the logo with neighboring pixels. +

+

The filter accepts the following options: +

+
+
filename, f
+

Set the filter bitmap file, which can be any image format supported by +libavformat. The width and height of the image file must match those of the +video stream being processed. +

+
+ +

Pixels in the provided bitmap image with a value of zero are not +considered part of the logo, non-zero pixels are considered part of +the logo. If you use white (255) for the logo and black (0) for the +rest, you will be safe. For making the filter bitmap, it is +recommended to take a screen capture of a black frame with the logo +visible, and then using a threshold filter followed by the erode +filter once or twice. +

+

If needed, little splotches can be fixed manually. Remember that if +logo pixels are not covered, the filter quality will be much +reduced. Marking too many pixels as part of the logo does not hurt as +much, but it will increase the amount of blurring needed to cover over +the image and will destroy more information than necessary, and extra +pixels will slow things down on a large logo. +

+ +

11.171 repeatfields

+ +

This filter uses the repeat_field flag from the Video ES headers and hard repeats +fields based on its value. +

+ +

11.172 reverse

+ +

Reverse a video clip. +

+

Warning: This filter requires memory to buffer the entire clip, so trimming +is suggested. +

+ +

11.172.1 Examples

+ +
    +
  • Take the first 5 seconds of a clip, and reverse it. +
    +
    trim=end=5,reverse
+
    +
+ + +

11.173 rgbashift

+

Shift R/G/B/A pixels horizontally and/or vertically. +

+

The filter accepts the following options: +

+
rh
+

Set amount to shift red horizontally. +

+
rv
+

Set amount to shift red vertically. +

+
gh
+

Set amount to shift green horizontally. +

+
gv
+

Set amount to shift green vertically. +

+
bh
+

Set amount to shift blue horizontally. +

+
bv
+

Set amount to shift blue vertically. +

+
ah
+

Set amount to shift alpha horizontally. +

+
av
+

Set amount to shift alpha vertically. +

+
edge
+

Set edge mode, can be smear, default, or warp. +

+
+ + +

11.173.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

11.174 roberts

+

Apply roberts cross operator to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +

+
+
delta
+

Set value which will be added to filtered result. +

+
+ + +

11.175 rotate

+ +

Rotate video by an arbitrary angle expressed in radians. +

+

The filter accepts the following options: +

+

A description of the optional parameters follows. +

+
angle, a
+

Set an expression for the angle by which to rotate the input video +clockwise, expressed as a number of radians. A negative value will +result in a counter-clockwise rotation. By default it is set to "0". +

+

This expression is evaluated for each frame. +

+
+
out_w, ow
+

Set the output width expression, default value is "iw". +This expression is evaluated just once during configuration. +

+
+
out_h, oh
+

Set the output height expression, default value is "ih". +This expression is evaluated just once during configuration. +

+
+
bilinear
+

Enable bilinear interpolation if set to 1, a value of 0 disables +it. Default value is 1. +

+
+
fillcolor, c
+

Set the color used to fill the output area not covered by the rotated +image. For the general syntax of this option, check the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +If the special value "none" is selected then no +background is printed (useful for example if the background is never shown). +

+

Default value is "black". +

+
+ +

The expressions for the angle and the output size can contain the +following constants and functions: +

+
+
n
+

sequential number of the input frame, starting from 0. It is always NAN +before the first frame is filtered. +

+
+
t
+

time in seconds of the input frame, it is set to 0 when the filter is +configured. It is always NAN before the first frame is filtered. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
in_w, iw
+
in_h, ih
+

the input video width and height +

+
+
out_w, ow
+
out_h, oh
+

the output width and height, that is the size of the padded area as +specified by the width and height expressions +

+
+
rotw(a)
+
roth(a)
+

the minimal width/height required for completely containing the input +video rotated by a radians. +

+

These are only available when computing the out_w and +out_h expressions. +

+
+ + +

11.175.1 Examples

+ +
    +
  • Rotate the input by PI/6 radians clockwise: +
    +
    rotate=PI/6
+
    + +
  • Rotate the input by PI/6 radians counter-clockwise: +
    +
    rotate=-PI/6
+
    + +
  • Rotate the input by 45 degrees clockwise: +
    +
    rotate=45*PI/180
+
    + +
  • Apply a constant rotation with period T, starting from an angle of PI/3: +
    +
    rotate=PI/3+2*PI*t/T
+
    + +
  • Make the input video rotation oscillating with a period of T +seconds and an amplitude of A radians: +
    +
    rotate=A*sin(2*PI/T*t)
+
    + +
  • Rotate the video, output size is chosen so that the whole rotating +input video is always completely contained in the output: +
    +
    rotate='2*PI*t:ow=hypot(iw,ih):oh=ow'
+
    + +
  • Rotate the video, reduce the output size so that no background is ever +shown: +
    +
    rotate=2*PI*t:ow='min(iw,ih)/sqrt(2)':oh=ow:c=none
+
    +
+ + +

11.175.2 Commands

+ +

The filter supports the following commands: +

+
+
a, angle
+

Set the angle expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

11.176 sab

+ +

Apply Shape Adaptive Blur. +

+

The filter accepts the following options: +

+
+
luma_radius, lr
+

Set luma blur filter strength, must be a value in range 0.1-4.0, default +value is 1.0. A greater value will result in a more blurred image, and +in slower processing. +

+
+
luma_pre_filter_radius, lpfr
+

Set luma pre-filter radius, must be a value in the 0.1-2.0 range, default +value is 1.0. +

+
+
luma_strength, ls
+

Set luma maximum difference between pixels to still be considered, must +be a value in the 0.1-100.0 range, default value is 1.0. +

+
+
chroma_radius, cr
+

Set chroma blur filter strength, must be a value in range -0.9-4.0. A +greater value will result in a more blurred image, and in slower +processing. +

+
+
chroma_pre_filter_radius, cpfr
+

Set chroma pre-filter radius, must be a value in the -0.9-2.0 range. +

+
+
chroma_strength, cs
+

Set chroma maximum difference between pixels to still be considered, +must be a value in the -0.9-100.0 range. +

+
+ +

Each chroma option value, if not explicitly specified, is set to the +corresponding luma option value. +

+ +

11.177 scale

+ +

Scale (resize) the input video, using the libswscale library. +

+

The scale filter forces the output display aspect ratio to be the same +of the input, by changing the output sample aspect ratio. +

+

If the input image format is different from the format requested by +the next filter, the scale filter will convert the input to the +requested format. +

+ +

11.177.1 Options

+

The filter accepts the following options, or any of the options +supported by the libswscale scaler. +

+

See (ffmpeg-scaler)the ffmpeg-scaler manual for +the complete list of scaler options. +

+
+
width, w
+
height, h
+

Set the output video dimension expression. Default value is the input +dimension. +

+

If the width or w value is 0, the input width is used for +the output. If the height or h value is 0, the input height +is used for the output. +

+

If one and only one of the values is -n with n >= 1, the scale filter +will use a value that maintains the aspect ratio of the input image, +calculated from the other specified dimension. After that it will, +however, make sure that the calculated dimension is divisible by n and +adjust the value if necessary. +

+

If both values are -n with n >= 1, the behavior will be identical to +both values being set to 0 as previously detailed. +

+

See below for the list of accepted constants for use in the dimension +expression. +

+
+
eval
+

Specify when to evaluate width and height expression. It accepts the following values: +

+
+
‘init’
+

Only evaluate expressions once during the filter initialization or when a command is processed. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. +

+
+
+ +

Default value is ‘init’. +

+ +
+
interl
+

Set the interlacing mode. It accepts the following values: +

+
+
‘1’
+

Force interlaced aware scaling. +

+
+
‘0’
+

Do not apply interlaced scaling. +

+
+
‘-1’
+

Select interlaced aware scaling depending on whether the source frames +are flagged as interlaced or not. +

+
+ +

Default value is ‘0’. +

+
+
flags
+

Set libswscale scaling flags. See +(ffmpeg-scaler)the ffmpeg-scaler manual for the +complete list of values. If not explicitly specified the filter applies +the default flags. +

+ +
+
param0, param1
+

Set libswscale input parameters for scaling algorithms that need them. See +(ffmpeg-scaler)the ffmpeg-scaler manual for the +complete documentation. If not explicitly specified the filter applies +empty parameters. +

+ + +
+
size, s
+

Set the video size. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
in_color_matrix
+
out_color_matrix
+

Set in/output YCbCr color space type. +

+

This allows the autodetected value to be overridden as well as allows forcing +a specific value used for the output and encoder. +

+

If not specified, the color space type depends on the pixel format. +

+

Possible values: +

+
+
‘auto’
+

Choose automatically. +

+
+
‘bt709’
+

Format conforming to International Telecommunication Union (ITU) +Recommendation BT.709. +

+
+
‘fcc’
+

Set color space conforming to the United States Federal Communications +Commission (FCC) Code of Federal Regulations (CFR) Title 47 (2003) 73.682 (a). +

+
+
‘bt601’
+
‘bt470’
+
‘smpte170m’
+

Set color space conforming to: +

+
    +
  • ITU Radiocommunication Sector (ITU-R) Recommendation BT.601 + +
  • ITU-R Rec. BT.470-6 (1998) Systems B, B1, and G + +
  • Society of Motion Picture and Television Engineers (SMPTE) ST 170:2004 + +
+ +
+
‘smpte240m’
+

Set color space conforming to SMPTE ST 240:1999. +

+
+
‘bt2020’
+

Set color space conforming to ITU-R BT.2020 non-constant luminance system. +

+
+ +
+
in_range
+
out_range
+

Set in/output YCbCr sample range. +

+

This allows the autodetected value to be overridden as well as allows forcing +a specific value used for the output and encoder. If not specified, the +range depends on the pixel format. Possible values: +

+
+
‘auto/unknown’
+

Choose automatically. +

+
+
‘jpeg/full/pc’
+

Set full range (0-255 in case of 8-bit luma). +

+
+
‘mpeg/limited/tv’
+

Set "MPEG" range (16-235 in case of 8-bit luma). +

+
+ +
+
force_original_aspect_ratio
+

Enable decreasing or increasing output video width or height if necessary to +keep the original aspect ratio. Possible values: +

+
+
‘disable’
+

Scale the video as specified and disable this feature. +

+
+
‘decrease’
+

The output video dimensions will automatically be decreased if needed. +

+
+
‘increase’
+

The output video dimensions will automatically be increased if needed. +

+
+
+ +

One useful instance of this option is that when you know a specific device’s +maximum allowed resolution, you can use this to limit the output video to +that, while retaining the aspect ratio. For example, device A allows +1280x720 playback, and your video is 1920x800. Using this option (set it to +decrease) and specifying 1280x720 to the command line makes the output +1280x533. +

+

Please note that this is a different thing than specifying -1 for w +or h, you still need to specify the output resolution for this option +to work. +

+
+
force_divisible_by
+

Ensures that both the output dimensions, width and height, are divisible by the +given integer when used together with force_original_aspect_ratio. This +works similar to using -n in the w and h options. +

+

This option respects the value set for force_original_aspect_ratio, +increasing or decreasing the resolution accordingly. The video’s aspect ratio +may be slightly modified. +

+

This option can be handy if you need to have a video fit within or exceed +a defined resolution using force_original_aspect_ratio but also have +encoder restrictions on width or height divisibility. +

+
+
+ +

The values of the w and h options are expressions +containing the following constants: +

+
+
in_w
+
in_h
+

The input width and height +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output (scaled) width and height +

+
+
ow
+
oh
+

These are the same as out_w and out_h +

+
+
a
+

The same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

The input display aspect ratio. Calculated from (iw / ih) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical input chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
ohsub
+
ovsub
+

horizontal and vertical output chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
n
+

The (sequential) number of the input frame, starting from 0. +Only available with eval=frame. +

+
+
t
+

The presentation timestamp of the input frame, expressed as a number of +seconds. Only available with eval=frame. +

+
+
pos
+

The position (byte offset) of the frame in the input stream, or NaN if +this information is unavailable and/or meaningless (for example in case of synthetic video). +Only available with eval=frame. +

+
+ + +

11.177.2 Examples

+ +
    +
  • Scale the input video to a size of 200x100 +
    +
    scale=w=200:h=100
+
    + +

    This is equivalent to: +

    +
    scale=200:100
+
    + +

    or: +

    +
    scale=200x100
+
    + +
  • Specify a size abbreviation for the output size: +
    +
    scale=qcif
+
    + +

    which can also be written as: +

    +
    scale=size=qcif
+
    + +
  • Scale the input to 2x: +
    +
    scale=w=2*iw:h=2*ih
+
    + +
  • The above is the same as: +
    +
    scale=2*in_w:2*in_h
+
    + +
  • Scale the input to 2x with forced interlaced scaling: +
    +
    scale=2*iw:2*ih:interl=1
+
    + +
  • Scale the input to half size: +
    +
    scale=w=iw/2:h=ih/2
+
    + +
  • Increase the width, and set the height to the same size: +
    +
    scale=3/2*iw:ow
+
    + +
  • Seek Greek harmony: +
    +
    scale=iw:1/PHI*iw
+scale=ih*PHI:ih
+
    + +
  • Increase the height, and set the width to 3/2 of the height: +
    +
    scale=w=3/2*oh:h=3/5*ih
+
    + +
  • Increase the size, making the size a multiple of the chroma +subsample values: +
    +
    scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
+
    + +
  • Increase the width to a maximum of 500 pixels, +keeping the same aspect ratio as the input: +
    +
    scale=w='min(500\, iw*3/2):h=-1'
+
    + +
  • Make pixels square by combining scale and setsar: +
    +
    scale='trunc(ih*dar):ih',setsar=1/1
+
    + +
  • Make pixels square by combining scale and setsar, +making sure the resulting resolution is even (required by some codecs): +
    +
    scale='trunc(ih*dar/2)*2:trunc(ih/2)*2',setsar=1/1
+
    +
+ + +

11.177.3 Commands

+ +

This filter supports the following commands: +

+
width, w
+
height, h
+

Set the output video dimension expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

11.178 scale_npp

+ +

Use the NVIDIA Performance Primitives (libnpp) to perform scaling and/or pixel +format conversion on CUDA video frames. Setting the output width and height +works in the same way as for the scale filter. +

+

The following additional options are accepted: +

+
format
+

The pixel format of the output CUDA frames. If set to the string "same" (the +default), the input format will be kept. Note that automatic format negotiation +and conversion is not yet supported for hardware frames +

+
+
interp_algo
+

The interpolation algorithm used for resizing. One of the following: +

+
nn
+

Nearest neighbour. +

+
+
linear
+
cubic
+
cubic2p_bspline
+

2-parameter cubic (B=1, C=0) +

+
+
cubic2p_catmullrom
+

2-parameter cubic (B=0, C=1/2) +

+
+
cubic2p_b05c03
+

2-parameter cubic (B=1/2, C=3/10) +

+
+
super
+

Supersampling +

+
+
lanczos
+
+ +
+
force_original_aspect_ratio
+

Enable decreasing or increasing output video width or height if necessary to +keep the original aspect ratio. Possible values: +

+
+
‘disable’
+

Scale the video as specified and disable this feature. +

+
+
‘decrease’
+

The output video dimensions will automatically be decreased if needed. +

+
+
‘increase’
+

The output video dimensions will automatically be increased if needed. +

+
+
+ +

One useful instance of this option is that when you know a specific device’s +maximum allowed resolution, you can use this to limit the output video to +that, while retaining the aspect ratio. For example, device A allows +1280x720 playback, and your video is 1920x800. Using this option (set it to +decrease) and specifying 1280x720 to the command line makes the output +1280x533. +

+

Please note that this is a different thing than specifying -1 for w +or h, you still need to specify the output resolution for this option +to work. +

+
+
force_divisible_by
+

Ensures that both the output dimensions, width and height, are divisible by the +given integer when used together with force_original_aspect_ratio. This +works similar to using -n in the w and h options. +

+

This option respects the value set for force_original_aspect_ratio, +increasing or decreasing the resolution accordingly. The video’s aspect ratio +may be slightly modified. +

+

This option can be handy if you need to have a video fit within or exceed +a defined resolution using force_original_aspect_ratio but also have +encoder restrictions on width or height divisibility. +

+
+
+ + +

11.179 scale2ref

+ +

Scale (resize) the input video, based on a reference video. +

+

See the scale filter for available options, scale2ref supports the same but +uses the reference video instead of the main input as basis. scale2ref also +supports the following additional constants for the w and +h options: +

+
+
main_w
+
main_h
+

The main input video’s width and height +

+
+
main_a
+

The same as main_w / main_h +

+
+
main_sar
+

The main input video’s sample aspect ratio +

+
+
main_dar, mdar
+

The main input video’s display aspect ratio. Calculated from +(main_w / main_h) * main_sar. +

+
+
main_hsub
+
main_vsub
+

The main input video’s horizontal and vertical chroma subsample values. +For example for the pixel format "yuv422p" hsub is 2 and vsub +is 1. +

+
+
main_n
+

The (sequential) number of the main input frame, starting from 0. +Only available with eval=frame. +

+
+
main_t
+

The presentation timestamp of the main input frame, expressed as a number of +seconds. Only available with eval=frame. +

+
+
main_pos
+

The position (byte offset) of the frame in the main input stream, or NaN if +this information is unavailable and/or meaningless (for example in case of synthetic video). +Only available with eval=frame. +

+
+ + +

11.179.1 Examples

+ +
    +
  • Scale a subtitle stream (b) to match the main video (a) in size before overlaying +
    +
    'scale2ref[b][a];[a][b]overlay'
+
    + +
  • Scale a logo to 1/10th the height of a video, while preserving its display aspect ratio. +
    +
    [logo-in][video-in]scale2ref=w=oh*mdar:h=ih/10[logo-out][video-out]
+
    +
+ + +

11.179.2 Commands

+ +

This filter supports the following commands: +

+
width, w
+
height, h
+

Set the output video dimension expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

11.180 scroll

+

Scroll input video horizontally and/or vertically by constant speed. +

+

The filter accepts the following options: +

+
horizontal, h
+

Set the horizontal scrolling speed. Default is 0. Allowed range is from -1 to 1. +Negative values changes scrolling direction. +

+
+
vertical, v
+

Set the vertical scrolling speed. Default is 0. Allowed range is from -1 to 1. +Negative values changes scrolling direction. +

+
+
hpos
+

Set the initial horizontal scrolling position. Default is 0. Allowed range is from 0 to 1. +

+
+
vpos
+

Set the initial vertical scrolling position. Default is 0. Allowed range is from 0 to 1. +

+
+ + +

11.180.1 Commands

+ +

This filter supports the following commands: +

+
horizontal, h
+

Set the horizontal scrolling speed. +

+
vertical, v
+

Set the vertical scrolling speed. +

+
+ + +

11.181 scdet

+ +

Detect video scene change. +

+

This filter sets frame metadata with mafd between frame, the scene score, and +forward the frame to the next filter, so they can use these metadata to detect +scene change or others. +

+

In addition, this filter logs a message and sets frame metadata when it detects +a scene change by threshold. +

+

lavfi.scd.mafd metadata keys are set with mafd for every frame. +

+

lavfi.scd.score metadata keys are set with scene change score for every frame +to detect scene change. +

+

lavfi.scd.time metadata keys are set with current filtered frame time which +detect scene change with threshold. +

+

The filter accepts the following options: +

+
+
threshold, t
+

Set the scene change detection threshold as a percentage of maximum change. Good +values are in the [8.0, 14.0] range. The range for threshold is +[0., 100.]. +

+

Default value is 10.. +

+
+
sc_pass, s
+

Set the flag to pass scene change frames to the next filter. Default value is 0 +You can enable it if you want to get snapshot of scene change frames only. +

+
+ + +

11.182 selectivecolor

+ +

Adjust cyan, magenta, yellow and black (CMYK) to certain ranges of colors (such +as "reds", "yellows", "greens", "cyans", ...). The adjustment range is defined +by the "purity" of the color (that is, how saturated it already is). +

+

This filter is similar to the Adobe Photoshop Selective Color tool. +

+

The filter accepts the following options: +

+
+
correction_method
+

Select color correction method. +

+

Available values are: +

+
‘absolute’
+

Specified adjustments are applied "as-is" (added/subtracted to original pixel +component value). +

+
‘relative’
+

Specified adjustments are relative to the original component value. +

+
+

Default is absolute. +

+
reds
+

Adjustments for red pixels (pixels where the red component is the maximum) +

+
yellows
+

Adjustments for yellow pixels (pixels where the blue component is the minimum) +

+
greens
+

Adjustments for green pixels (pixels where the green component is the maximum) +

+
cyans
+

Adjustments for cyan pixels (pixels where the red component is the minimum) +

+
blues
+

Adjustments for blue pixels (pixels where the blue component is the maximum) +

+
magentas
+

Adjustments for magenta pixels (pixels where the green component is the minimum) +

+
whites
+

Adjustments for white pixels (pixels where all components are greater than 128) +

+
neutrals
+

Adjustments for all pixels except pure black and pure white +

+
blacks
+

Adjustments for black pixels (pixels where all components are lesser than 128) +

+
psfile
+

Specify a Photoshop selective color file (.asv) to import the settings from. +

+
+ +

All the adjustment settings (reds, yellows, ...) accept up to +4 space separated floating point adjustment values in the [-1,1] range, +respectively to adjust the amount of cyan, magenta, yellow and black for the +pixels of its range. +

+ +

11.182.1 Examples

+ +
    +
  • Increase cyan by 50% and reduce yellow by 33% in every green areas, and +increase magenta by 27% in blue areas: +
    +
    selectivecolor=greens=.5 0 -.33 0:blues=0 .27
+
    + +
  • Use a Photoshop selective color preset: +
    +
    selectivecolor=psfile=MySelectiveColorPresets/Misty.asv
+
    +
+ + +

11.183 separatefields

+ +

The separatefields takes a frame-based video input and splits +each frame into its components fields, producing a new half height clip +with twice the frame rate and twice the frame count. +

+

This filter use field-dominance information in frame to decide which +of each pair of fields to place first in the output. +If it gets it wrong use setfield filter before separatefields filter. +

+ +

11.184 setdar, setsar

+ +

The setdar filter sets the Display Aspect Ratio for the filter +output video. +

+

This is done by changing the specified Sample (aka Pixel) Aspect +Ratio, according to the following equation: +

+
DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR
+
+ +

Keep in mind that the setdar filter does not modify the pixel +dimensions of the video frame. Also, the display aspect ratio set by +this filter may be changed by later filters in the filterchain, +e.g. in case of scaling or if another "setdar" or a "setsar" filter is +applied. +

+

The setsar filter sets the Sample (aka Pixel) Aspect Ratio for +the filter output video. +

+

Note that as a consequence of the application of this filter, the +output display aspect ratio will change according to the equation +above. +

+

Keep in mind that the sample aspect ratio set by the setsar +filter may be changed by later filters in the filterchain, e.g. if +another "setsar" or a "setdar" filter is applied. +

+

It accepts the following parameters: +

+
+
r, ratio, dar (setdar only), sar (setsar only)
+

Set the aspect ratio used by the filter. +

+

The parameter can be a floating point number string, an expression, or +a string of the form num:den, where num and +den are the numerator and denominator of the aspect ratio. If +the parameter is not specified, it is assumed the value "0". +In case the form "num:den" is used, the : character +should be escaped. +

+
+
max
+

Set the maximum integer value to use for expressing numerator and +denominator when reducing the expressed aspect ratio to a rational. +Default value is 100. +

+
+
+ +

The parameter sar is an expression containing +the following constants: +

+
+
E, PI, PHI
+

These are approximated values for the mathematical constants e +(Euler’s number), pi (Greek pi), and phi (the golden ratio). +

+
+
w, h
+

The input width and height. +

+
+
a
+

These are the same as w / h. +

+
+
sar
+

The input sample aspect ratio. +

+
+
dar
+

The input display aspect ratio. It is the same as +(w / h) * sar. +

+
+
hsub, vsub
+

Horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+ + +

11.184.1 Examples

+ +
    +
  • To change the display aspect ratio to 16:9, specify one of the following: +
    +
    setdar=dar=1.77777
+setdar=dar=16/9
+
    + +
  • To change the sample aspect ratio to 10:11, specify: +
    +
    setsar=sar=10/11
+
    + +
  • To set a display aspect ratio of 16:9, and specify a maximum integer value of +1000 in the aspect ratio reduction, use the command: +
    +
    setdar=ratio=16/9:max=1000
+
    + +
+ + +

11.185 setfield

+ +

Force field for the output video frame. +

+

The setfield filter marks the interlace type field for the +output frames. It does not change the input frame, but only sets the +corresponding property, which affects how the frame is treated by +following filters (e.g. fieldorder or yadif). +

+

The filter accepts the following options: +

+
+
mode
+

Available values are: +

+
+
‘auto’
+

Keep the same field property. +

+
+
‘bff’
+

Mark the frame as bottom-field-first. +

+
+
‘tff’
+

Mark the frame as top-field-first. +

+
+
‘prog’
+

Mark the frame as progressive. +

+
+
+
+ + +

11.186 setparams

+ +

Force frame parameter for the output video frame. +

+

The setparams filter marks interlace and color range for the +output frames. It does not change the input frame, but only sets the +corresponding property, which affects how the frame is treated by +filters/encoders. +

+
+
field_mode
+

Available values are: +

+
+
‘auto’
+

Keep the same field property (default). +

+
+
‘bff’
+

Mark the frame as bottom-field-first. +

+
+
‘tff’
+

Mark the frame as top-field-first. +

+
+
‘prog’
+

Mark the frame as progressive. +

+
+ +
+
range
+

Available values are: +

+
+
‘auto’
+

Keep the same color range property (default). +

+
+
‘unspecified, unknown’
+

Mark the frame as unspecified color range. +

+
+
‘limited, tv, mpeg’
+

Mark the frame as limited range. +

+
+
‘full, pc, jpeg’
+

Mark the frame as full range. +

+
+ +
+
color_primaries
+

Set the color primaries. +Available values are: +

+
+
‘auto’
+

Keep the same color primaries property (default). +

+
+
‘bt709’
+
‘unknown’
+
‘bt470m’
+
‘bt470bg’
+
‘smpte170m’
+
‘smpte240m’
+
‘film’
+
‘bt2020’
+
‘smpte428’
+
‘smpte431’
+
‘smpte432’
+
‘jedec-p22’
+
+ +
+
color_trc
+

Set the color transfer. +Available values are: +

+
+
‘auto’
+

Keep the same color trc property (default). +

+
+
‘bt709’
+
‘unknown’
+
‘bt470m’
+
‘bt470bg’
+
‘smpte170m’
+
‘smpte240m’
+
‘linear’
+
‘log100’
+
‘log316’
+
‘iec61966-2-4’
+
‘bt1361e’
+
‘iec61966-2-1’
+
‘bt2020-10’
+
‘bt2020-12’
+
‘smpte2084’
+
‘smpte428’
+
‘arib-std-b67’
+
+ +
+
colorspace
+

Set the colorspace. +Available values are: +

+
+
‘auto’
+

Keep the same colorspace property (default). +

+
+
‘gbr’
+
‘bt709’
+
‘unknown’
+
‘fcc’
+
‘bt470bg’
+
‘smpte170m’
+
‘smpte240m’
+
‘ycgco’
+
‘bt2020nc’
+
‘bt2020c’
+
‘smpte2085’
+
‘chroma-derived-nc’
+
‘chroma-derived-c’
+
‘ictcp’
+
+
+
+ + +

11.187 showinfo

+ +

Show a line containing various information for each input video frame. +The input video is not modified. +

+

This filter supports the following options: +

+
+
checksum
+

Calculate checksums of each plane. By default enabled. +

+
+ +

The shown line contains a sequence of key/value pairs of the form +key:value. +

+

The following values are shown in the output: +

+
+
n
+

The (sequential) number of the input frame, starting from 0. +

+
+
pts
+

The Presentation TimeStamp of the input frame, expressed as a number of +time base units. The time base unit depends on the filter input pad. +

+
+
pts_time
+

The Presentation TimeStamp of the input frame, expressed as a number of +seconds. +

+
+
pos
+

The position of the frame in the input stream, or -1 if this information is +unavailable and/or meaningless (for example in case of synthetic video). +

+
+
fmt
+

The pixel format name. +

+
+
sar
+

The sample aspect ratio of the input frame, expressed in the form +num/den. +

+
+
s
+

The size of the input frame. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
i
+

The type of interlaced mode ("P" for "progressive", "T" for top field first, "B" +for bottom field first). +

+
+
iskey
+

This is 1 if the frame is a key frame, 0 otherwise. +

+
+
type
+

The picture type of the input frame ("I" for an I-frame, "P" for a +P-frame, "B" for a B-frame, or "?" for an unknown type). +Also refer to the documentation of the AVPictureType enum and of +the av_get_picture_type_char function defined in +libavutil/avutil.h. +

+
+
checksum
+

The Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame. +

+
+
plane_checksum
+

The Adler-32 checksum (printed in hexadecimal) of each plane of the input frame, +expressed in the form "[c0 c1 c2 c3]". +

+
+
mean
+

The mean value of pixels in each plane of the input frame, expressed in the form +"[mean0 mean1 mean2 mean3]". +

+
+
stdev
+

The standard deviation of pixel values in each plane of the input frame, expressed +in the form "[stdev0 stdev1 stdev2 stdev3]". +

+
+
+ + +

11.188 showpalette

+ +

Displays the 256 colors palette of each frame. This filter is only relevant for +pal8 pixel format frames. +

+

It accepts the following option: +

+
+
s
+

Set the size of the box used to represent one palette color entry. Default is +30 (for a 30x30 pixel box). +

+
+ + +

11.189 shuffleframes

+ +

Reorder and/or duplicate and/or drop video frames. +

+

It accepts the following parameters: +

+
+
mapping
+

Set the destination indexes of input frames. +This is space or ’|’ separated list of indexes that maps input frames to output +frames. Number of indexes also sets maximal value that each index may have. +’-1’ index have special meaning and that is to drop frame. +

+
+ +

The first frame has the index 0. The default is to keep the input unchanged. +

+ +

11.189.1 Examples

+ +
    +
  • Swap second and third frame of every three frames of the input: +
    +
    ffmpeg -i INPUT -vf "shuffleframes=0 2 1" OUTPUT
+
    + +
  • Swap 10th and 1st frame of every ten frames of the input: +
    +
    ffmpeg -i INPUT -vf "shuffleframes=9 1 2 3 4 5 6 7 8 0" OUTPUT
+
    +
+ + +

11.190 shuffleplanes

+ +

Reorder and/or duplicate video planes. +

+

It accepts the following parameters: +

+
+
map0
+

The index of the input plane to be used as the first output plane. +

+
+
map1
+

The index of the input plane to be used as the second output plane. +

+
+
map2
+

The index of the input plane to be used as the third output plane. +

+
+
map3
+

The index of the input plane to be used as the fourth output plane. +

+
+
+ +

The first plane has the index 0. The default is to keep the input unchanged. +

+ +

11.190.1 Examples

+ +
    +
  • Swap the second and third planes of the input: +
    +
    ffmpeg -i INPUT -vf shuffleplanes=0:2:1:3 OUTPUT
+
    +
+ + +

11.191 signalstats

+

Evaluate various visual metrics that assist in determining issues associated +with the digitization of analog video media. +

+

By default the filter will log these metadata values: +

+
+
YMIN
+

Display the minimal Y value contained within the input frame. Expressed in +range of [0-255]. +

+
+
YLOW
+

Display the Y value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
YAVG
+

Display the average Y value within the input frame. Expressed in range of +[0-255]. +

+
+
YHIGH
+

Display the Y value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
YMAX
+

Display the maximum Y value contained within the input frame. Expressed in +range of [0-255]. +

+
+
UMIN
+

Display the minimal U value contained within the input frame. Expressed in +range of [0-255]. +

+
+
ULOW
+

Display the U value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
UAVG
+

Display the average U value within the input frame. Expressed in range of +[0-255]. +

+
+
UHIGH
+

Display the U value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
UMAX
+

Display the maximum U value contained within the input frame. Expressed in +range of [0-255]. +

+
+
VMIN
+

Display the minimal V value contained within the input frame. Expressed in +range of [0-255]. +

+
+
VLOW
+

Display the V value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
VAVG
+

Display the average V value within the input frame. Expressed in range of +[0-255]. +

+
+
VHIGH
+

Display the V value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
VMAX
+

Display the maximum V value contained within the input frame. Expressed in +range of [0-255]. +

+
+
SATMIN
+

Display the minimal saturation value contained within the input frame. +Expressed in range of [0-~181.02]. +

+
+
SATLOW
+

Display the saturation value at the 10% percentile within the input frame. +Expressed in range of [0-~181.02]. +

+
+
SATAVG
+

Display the average saturation value within the input frame. Expressed in range +of [0-~181.02]. +

+
+
SATHIGH
+

Display the saturation value at the 90% percentile within the input frame. +Expressed in range of [0-~181.02]. +

+
+
SATMAX
+

Display the maximum saturation value contained within the input frame. +Expressed in range of [0-~181.02]. +

+
+
HUEMED
+

Display the median value for hue within the input frame. Expressed in range of +[0-360]. +

+
+
HUEAVG
+

Display the average value for hue within the input frame. Expressed in range of +[0-360]. +

+
+
YDIF
+

Display the average of sample value difference between all values of the Y +plane in the current frame and corresponding values of the previous input frame. +Expressed in range of [0-255]. +

+
+
UDIF
+

Display the average of sample value difference between all values of the U +plane in the current frame and corresponding values of the previous input frame. +Expressed in range of [0-255]. +

+
+
VDIF
+

Display the average of sample value difference between all values of the V +plane in the current frame and corresponding values of the previous input frame. +Expressed in range of [0-255]. +

+
+
YBITDEPTH
+

Display bit depth of Y plane in current frame. +Expressed in range of [0-16]. +

+
+
UBITDEPTH
+

Display bit depth of U plane in current frame. +Expressed in range of [0-16]. +

+
+
VBITDEPTH
+

Display bit depth of V plane in current frame. +Expressed in range of [0-16]. +

+
+ +

The filter accepts the following options: +

+
+
stat
+
out
+
+

stat specify an additional form of image analysis. +out output video with the specified type of pixel highlighted. +

+

Both options accept the following values: +

+
+
‘tout’
+

Identify temporal outliers pixels. A temporal outlier is a pixel +unlike the neighboring pixels of the same field. Examples of temporal outliers +include the results of video dropouts, head clogs, or tape tracking issues. +

+
+
‘vrep’
+

Identify vertical line repetition. Vertical line repetition includes +similar rows of pixels within a frame. In born-digital video vertical line +repetition is common, but this pattern is uncommon in video digitized from an +analog source. When it occurs in video that results from the digitization of an +analog source it can indicate concealment from a dropout compensator. +

+
+
‘brng’
+

Identify pixels that fall outside of legal broadcast range. +

+
+ +
+
color, c
+

Set the highlight color for the out option. The default color is +yellow. +

+
+ + +

11.191.1 Examples

+ +
    +
  • Output data of various video metrics: +
    +
    ffprobe -f lavfi movie=example.mov,signalstats="stat=tout+vrep+brng" -show_frames
+
    + +
  • Output specific data about the minimum and maximum values of the Y plane per frame: +
    +
    ffprobe -f lavfi movie=example.mov,signalstats -show_entries frame_tags=lavfi.signalstats.YMAX,lavfi.signalstats.YMIN
+
    + +
  • Playback video while highlighting pixels that are outside of broadcast range in red. +
    +
    ffplay example.mov -vf signalstats="out=brng:color=red"
+
    + +
  • Playback video with signalstats metadata drawn over the frame. +
    +
    ffplay example.mov -vf signalstats=stat=brng+vrep+tout,drawtext=fontfile=FreeSerif.ttf:textfile=signalstat_drawtext.txt
+
    + +

    The contents of signalstat_drawtext.txt used in the command are: +

    +
    time %{pts:hms}
+Y (%{metadata:lavfi.signalstats.YMIN}-%{metadata:lavfi.signalstats.YMAX})
+U (%{metadata:lavfi.signalstats.UMIN}-%{metadata:lavfi.signalstats.UMAX})
+V (%{metadata:lavfi.signalstats.VMIN}-%{metadata:lavfi.signalstats.VMAX})
+saturation maximum: %{metadata:lavfi.signalstats.SATMAX}
+
+
    +
+ + +

11.192 signature

+ +

Calculates the MPEG-7 Video Signature. The filter can handle more than one +input. In this case the matching between the inputs can be calculated additionally. +The filter always passes through the first input. The signature of each stream can +be written into a file. +

+

It accepts the following options: +

+
+
detectmode
+

Enable or disable the matching process. +

+

Available values are: +

+
+
‘off’
+

Disable the calculation of a matching (default). +

+
‘full’
+

Calculate the matching for the whole video and output whether the whole video +matches or only parts. +

+
‘fast’
+

Calculate only until a matching is found or the video ends. Should be faster in +some cases. +

+
+ +
+
nb_inputs
+

Set the number of inputs. The option value must be a non negative integer. +Default value is 1. +

+
+
filename
+

Set the path to which the output is written. If there is more than one input, +the path must be a prototype, i.e. must contain %d or %0nd (where n is a positive +integer), that will be replaced with the input number. If no filename is +specified, no output will be written. This is the default. +

+
+
format
+

Choose the output format. +

+

Available values are: +

+
+
‘binary’
+

Use the specified binary representation (default). +

+
‘xml’
+

Use the specified xml representation. +

+
+ +
+
th_d
+

Set threshold to detect one word as similar. The option value must be an integer +greater than zero. The default value is 9000. +

+
+
th_dc
+

Set threshold to detect all words as similar. The option value must be an integer +greater than zero. The default value is 60000. +

+
+
th_xh
+

Set threshold to detect frames as similar. The option value must be an integer +greater than zero. The default value is 116. +

+
+
th_di
+

Set the minimum length of a sequence in frames to recognize it as matching +sequence. The option value must be a non negative integer value. +The default value is 0. +

+
+
th_it
+

Set the minimum relation, that matching frames to all frames must have. +The option value must be a double value between 0 and 1. The default value is 0.5. +

+
+ + +

11.192.1 Examples

+ +
    +
  • To calculate the signature of an input video and store it in signature.bin: +
    +
    ffmpeg -i input.mkv -vf signature=filename=signature.bin -map 0:v -f null -
+
    + +
  • To detect whether two videos match and store the signatures in XML format in +signature0.xml and signature1.xml: +
    +
    ffmpeg -i input1.mkv -i input2.mkv -filter_complex "[0:v][1:v] signature=nb_inputs=2:detectmode=full:format=xml:filename=signature%d.xml" -map :v -f null -
+
    + +
+ + +

11.193 smartblur

+ +

Blur the input video without impacting the outlines. +

+

It accepts the following options: +

+
+
luma_radius, lr
+

Set the luma radius. The option value must be a float number in +the range [0.1,5.0] that specifies the variance of the gaussian filter +used to blur the image (slower if larger). Default value is 1.0. +

+
+
luma_strength, ls
+

Set the luma strength. The option value must be a float number +in the range [-1.0,1.0] that configures the blurring. A value included +in [0.0,1.0] will blur the image whereas a value included in +[-1.0,0.0] will sharpen the image. Default value is 1.0. +

+
+
luma_threshold, lt
+

Set the luma threshold used as a coefficient to determine +whether a pixel should be blurred or not. The option value must be an +integer in the range [-30,30]. A value of 0 will filter all the image, +a value included in [0,30] will filter flat areas and a value included +in [-30,0] will filter edges. Default value is 0. +

+
+
chroma_radius, cr
+

Set the chroma radius. The option value must be a float number in +the range [0.1,5.0] that specifies the variance of the gaussian filter +used to blur the image (slower if larger). Default value is luma_radius. +

+
+
chroma_strength, cs
+

Set the chroma strength. The option value must be a float number +in the range [-1.0,1.0] that configures the blurring. A value included +in [0.0,1.0] will blur the image whereas a value included in +[-1.0,0.0] will sharpen the image. Default value is luma_strength. +

+
+
chroma_threshold, ct
+

Set the chroma threshold used as a coefficient to determine +whether a pixel should be blurred or not. The option value must be an +integer in the range [-30,30]. A value of 0 will filter all the image, +a value included in [0,30] will filter flat areas and a value included +in [-30,0] will filter edges. Default value is luma_threshold. +

+
+ +

If a chroma option is not explicitly set, the corresponding luma value +is set. +

+ +

11.194 sobel

+

Apply sobel operator to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +

+
+
delta
+

Set value which will be added to filtered result. +

+
+ + +

11.195 spp

+ +

Apply a simple postprocessing filter that compresses and decompresses the image +at several (or - in the case of quality level 6 - all) shifts +and average the results. +

+

The filter accepts the following options: +

+
+
quality
+

Set quality. This option defines the number of levels for averaging. It accepts +an integer in the range 0-6. If set to 0, the filter will have no +effect. A value of 6 means the higher quality. For each increment of +that value the speed drops by a factor of approximately 2. Default value is +3. +

+
+
qp
+

Force a constant quantization parameter. If not set, the filter will use the QP +from the video stream (if available). +

+
+
mode
+

Set thresholding mode. Available modes are: +

+
+
‘hard’
+

Set hard thresholding (default). +

+
‘soft’
+

Set soft thresholding (better de-ringing effect, but likely blurrier). +

+
+ +
+
use_bframe_qp
+

Enable the use of the QP from the B-Frames if set to 1. Using this +option may cause flicker since the B-Frames have often larger QP. Default is +0 (not enabled). +

+
+ + +

11.195.1 Commands

+ +

This filter supports the following commands: +

+
quality, level
+

Set quality level. The value max can be used to set the maximum level, +currently 6. +

+
+ + +

11.196 sr

+ +

Scale the input by applying one of the super-resolution methods based on +convolutional neural networks. Supported models: +

+ + +

Training scripts as well as scripts for model file (.pb) saving can be found at +https://github.com/XueweiMeng/sr/tree/sr_dnn_native. Original repository +is at https://github.com/HighVoltageRocknRoll/sr.git. +

+

Native model files (.model) can be generated from TensorFlow model +files (.pb) by using tools/python/convert.py +

+

The filter accepts the following options: +

+
+
dnn_backend
+

Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +

+
+
‘native’
+

Native implementation of DNN loading and execution. +

+
+
‘tensorflow’
+

TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +https://www.tensorflow.org/install/install_c) and configure FFmpeg with +--enable-libtensorflow +

+
+ +

Default value is ‘native’. +

+
+
model
+

Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow backend +can load files for both formats, while native backend can load files for only +its format. +

+
+
scale_factor
+

Set scale factor for SRCNN model. Allowed values are 2, 3 and 4. +Default value is 2. Scale factor is necessary for SRCNN model, because it accepts +input upscaled using bicubic upscaling with proper scale factor. +

+
+ +

This feature can also be finished with dnn_processing filter. +

+ +

11.197 ssim

+ +

Obtain the SSIM (Structural SImilarity Metric) between two input videos. +

+

This filter takes in input two input videos, the first input is +considered the "main" source and is passed unchanged to the +output. The second input is used as a "reference" video for computing +the SSIM. +

+

Both video inputs must have the same resolution and pixel format for +this filter to work correctly. Also it assumes that both inputs +have the same number of frames, which are compared one by one. +

+

The filter stores the calculated SSIM of each frame. +

+

The description of the accepted parameters follows. +

+
+
stats_file, f
+

If specified the filter will use the named file to save the SSIM of +each individual frame. When filename equals "-" the data is sent to +standard output. +

+
+ +

The file printed if stats_file is selected, contains a sequence of +key/value pairs of the form key:value for each compared +couple of frames. +

+

A description of each shown parameter follows: +

+
+
n
+

sequential number of the input frame, starting from 1 +

+
+
Y, U, V, R, G, B
+

SSIM of the compared frames for the component specified by the suffix. +

+
+
All
+

SSIM of the compared frames for the whole frame. +

+
+
dB
+

Same as above but in dB representation. +

+
+ +

This filter also supports the framesync options. +

+ +

11.197.1 Examples

+
    +
  • For example: +
    +
    movie=ref_movie.mpg, setpts=PTS-STARTPTS [main];
+[main][ref] ssim="stats_file=stats.log" [out]
+
    + +

    On this example the input file being processed is compared with the +reference file ref_movie.mpg. The SSIM of each individual frame +is stored in stats.log. +

    +
  • Another example with both psnr and ssim at same time: +
    +
    ffmpeg -i main.mpg -i ref.mpg -lavfi  "ssim;[0:v][1:v]psnr" -f null -
+
    + +
  • Another example with different containers: +
    +
    ffmpeg -i main.mpg -i ref.mkv -lavfi  "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]ssim" -f null -
+
    +
+ + +

11.198 stereo3d

+ +

Convert between different stereoscopic image formats. +

+

The filters accept the following options: +

+
+
in
+

Set stereoscopic image format of input. +

+

Available values for input image formats are: +

+
‘sbsl’
+

side by side parallel (left eye left, right eye right) +

+
+
‘sbsr’
+

side by side crosseye (right eye left, left eye right) +

+
+
‘sbs2l’
+

side by side parallel with half width resolution +(left eye left, right eye right) +

+
+
‘sbs2r’
+

side by side crosseye with half width resolution +(right eye left, left eye right) +

+
+
‘abl’
+
‘tbl’
+

above-below (left eye above, right eye below) +

+
+
‘abr’
+
‘tbr’
+

above-below (right eye above, left eye below) +

+
+
‘ab2l’
+
‘tb2l’
+

above-below with half height resolution +(left eye above, right eye below) +

+
+
‘ab2r’
+
‘tb2r’
+

above-below with half height resolution +(right eye above, left eye below) +

+
+
‘al’
+

alternating frames (left eye first, right eye second) +

+
+
‘ar’
+

alternating frames (right eye first, left eye second) +

+
+
‘irl’
+

interleaved rows (left eye has top row, right eye starts on next row) +

+
+
‘irr’
+

interleaved rows (right eye has top row, left eye starts on next row) +

+
+
‘icl’
+

interleaved columns, left eye first +

+
+
‘icr’
+

interleaved columns, right eye first +

+

Default value is ‘sbsl’. +

+
+ +
+
out
+

Set stereoscopic image format of output. +

+
+
‘sbsl’
+

side by side parallel (left eye left, right eye right) +

+
+
‘sbsr’
+

side by side crosseye (right eye left, left eye right) +

+
+
‘sbs2l’
+

side by side parallel with half width resolution +(left eye left, right eye right) +

+
+
‘sbs2r’
+

side by side crosseye with half width resolution +(right eye left, left eye right) +

+
+
‘abl’
+
‘tbl’
+

above-below (left eye above, right eye below) +

+
+
‘abr’
+
‘tbr’
+

above-below (right eye above, left eye below) +

+
+
‘ab2l’
+
‘tb2l’
+

above-below with half height resolution +(left eye above, right eye below) +

+
+
‘ab2r’
+
‘tb2r’
+

above-below with half height resolution +(right eye above, left eye below) +

+
+
‘al’
+

alternating frames (left eye first, right eye second) +

+
+
‘ar’
+

alternating frames (right eye first, left eye second) +

+
+
‘irl’
+

interleaved rows (left eye has top row, right eye starts on next row) +

+
+
‘irr’
+

interleaved rows (right eye has top row, left eye starts on next row) +

+
+
‘arbg’
+

anaglyph red/blue gray +(red filter on left eye, blue filter on right eye) +

+
+
‘argg’
+

anaglyph red/green gray +(red filter on left eye, green filter on right eye) +

+
+
‘arcg’
+

anaglyph red/cyan gray +(red filter on left eye, cyan filter on right eye) +

+
+
‘arch’
+

anaglyph red/cyan half colored +(red filter on left eye, cyan filter on right eye) +

+
+
‘arcc’
+

anaglyph red/cyan color +(red filter on left eye, cyan filter on right eye) +

+
+
‘arcd’
+

anaglyph red/cyan color optimized with the least squares projection of dubois +(red filter on left eye, cyan filter on right eye) +

+
+
‘agmg’
+

anaglyph green/magenta gray +(green filter on left eye, magenta filter on right eye) +

+
+
‘agmh’
+

anaglyph green/magenta half colored +(green filter on left eye, magenta filter on right eye) +

+
+
‘agmc’
+

anaglyph green/magenta colored +(green filter on left eye, magenta filter on right eye) +

+
+
‘agmd’
+

anaglyph green/magenta color optimized with the least squares projection of dubois +(green filter on left eye, magenta filter on right eye) +

+
+
‘aybg’
+

anaglyph yellow/blue gray +(yellow filter on left eye, blue filter on right eye) +

+
+
‘aybh’
+

anaglyph yellow/blue half colored +(yellow filter on left eye, blue filter on right eye) +

+
+
‘aybc’
+

anaglyph yellow/blue colored +(yellow filter on left eye, blue filter on right eye) +

+
+
‘aybd’
+

anaglyph yellow/blue color optimized with the least squares projection of dubois +(yellow filter on left eye, blue filter on right eye) +

+
+
‘ml’
+

mono output (left eye only) +

+
+
‘mr’
+

mono output (right eye only) +

+
+
‘chl’
+

checkerboard, left eye first +

+
+
‘chr’
+

checkerboard, right eye first +

+
+
‘icl’
+

interleaved columns, left eye first +

+
+
‘icr’
+

interleaved columns, right eye first +

+
+
‘hdmi’
+

HDMI frame pack +

+
+ +

Default value is ‘arcd’. +

+
+ + +

11.198.1 Examples

+ +
    +
  • Convert input video from side by side parallel to anaglyph yellow/blue dubois: +
    +
    stereo3d=sbsl:aybd
+
    + +
  • Convert input video from above below (left eye above, right eye below) to side by side crosseye. +
    +
    stereo3d=abl:sbsr
+
    +
+ + +

11.199 streamselect, astreamselect

+

Select video or audio streams. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of inputs. Default is 2. +

+
+
map
+

Set input indexes to remap to outputs. +

+
+ + +

11.199.1 Commands

+ +

The streamselect and astreamselect filter supports the following +commands: +

+
+
map
+

Set input indexes to remap to outputs. +

+
+ + +

11.199.2 Examples

+ +
    +
  • Select first 5 seconds 1st stream and rest of time 2nd stream: +
    +
    sendcmd='5.0 streamselect map 1',streamselect=inputs=2:map=0
+
    + +
  • Same as above, but for audio: +
    +
    asendcmd='5.0 astreamselect map 1',astreamselect=inputs=2:map=0
+
    +
+ + +

11.200 subtitles

+ +

Draw subtitles on top of input video using the libass library. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libass. This filter also requires a build with libavcodec and +libavformat to convert the passed subtitles file to ASS (Advanced Substation +Alpha) subtitles format. +

+

The filter accepts the following options: +

+
+
filename, f
+

Set the filename of the subtitle file to read. It must be specified. +

+
+
original_size
+

Specify the size of the original video, the video for which the ASS file +was composed. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Due to a misdesign in ASS aspect ratio arithmetic, this is necessary to +correctly scale the fonts if the aspect ratio has been changed. +

+
+
fontsdir
+

Set a directory path containing fonts that can be used by the filter. +These fonts will be used in addition to whatever the font provider uses. +

+
+
alpha
+

Process alpha channel, by default alpha channel is untouched. +

+
+
charenc
+

Set subtitles input character encoding. subtitles filter only. Only +useful if not UTF-8. +

+
+
stream_index, si
+

Set subtitles stream index. subtitles filter only. +

+
+
force_style
+

Override default style or script info parameters of the subtitles. It accepts a +string containing ASS style format KEY=VALUE couples separated by ",". +

+
+ +

If the first key is not specified, it is assumed that the first value +specifies the filename. +

+

For example, to render the file sub.srt on top of the input +video, use the command: +

+
subtitles=sub.srt
+
+ +

which is equivalent to: +

+
subtitles=filename=sub.srt
+
+ +

To render the default subtitles stream from file video.mkv, use: +

+
subtitles=video.mkv
+
+ +

To render the second subtitles stream from that file, use: +

+
subtitles=video.mkv:si=1
+
+ +

To make the subtitles stream from sub.srt appear in 80% transparent blue +DejaVu Serif, use: +

+
subtitles=sub.srt:force_style='FontName=DejaVu Serif,PrimaryColour=&HCCFF0000'
+
+ + +

11.201 super2xsai

+ +

Scale the input by 2x and smooth using the Super2xSaI (Scale and +Interpolate) pixel art scaling algorithm. +

+

Useful for enlarging pixel art images without reducing sharpness. +

+ +

11.202 swaprect

+ +

Swap two rectangular objects in video. +

+

This filter accepts the following options: +

+
+
w
+

Set object width. +

+
+
h
+

Set object height. +

+
+
x1
+

Set 1st rect x coordinate. +

+
+
y1
+

Set 1st rect y coordinate. +

+
+
x2
+

Set 2nd rect x coordinate. +

+
+
y2
+

Set 2nd rect y coordinate. +

+

All expressions are evaluated once for each frame. +

+
+ +

The all options are expressions containing the following constants: +

+
+
w
+
h
+

The input width and height. +

+
+
a
+

same as w / h +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (w / h) * sar +

+
+
n
+

The number of the input frame, starting from 0. +

+
+
t
+

The timestamp expressed in seconds. It’s NAN if the input timestamp is unknown. +

+
+
pos
+

the position in the file of the input frame, NAN if unknown +

+
+ + +

11.203 swapuv

+

Swap U & V plane. +

+ +

11.204 tblend

+

Blend successive video frames. +

+

See blend +

+ +

11.205 telecine

+ +

Apply telecine process to the video. +

+

This filter accepts the following options: +

+
+
first_field
+
+
‘top, t’
+

top field first +

+
‘bottom, b’
+

bottom field first +The default value is top. +

+
+ +
+
pattern
+

A string of numbers representing the pulldown pattern you wish to apply. +The default value is 23. +

+
+ +
+
Some typical patterns:
+
+NTSC output (30i):
+27.5p: 32222
+24p: 23 (classic)
+24p: 2332 (preferred)
+20p: 33
+18p: 334
+16p: 3444
+
+PAL output (25i):
+27.5p: 12222
+24p: 222222222223 ("Euro pulldown")
+16.67p: 33
+16p: 33333334
+
+ + +

11.206 thistogram

+ +

Compute and draw a color distribution histogram for the input video across time. +

+

Unlike histogram video filter which only shows histogram of single input frame +at certain time, this filter shows also past histograms of number of frames defined +by width option. +

+

The computed histogram is a representation of the color component +distribution in an image. +

+

The filter accepts the following options: +

+
+
width, w
+

Set width of single color component output. Default value is 0. +Value of 0 means width will be picked from input video. +This also set number of passed histograms to keep. +Allowed range is [0, 8192]. +

+
+
display_mode, d
+

Set display mode. +It accepts the following values: +

+
‘stack’
+

Per color component graphs are placed below each other. +

+
+
‘parade’
+

Per color component graphs are placed side by side. +

+
+
‘overlay’
+

Presents information identical to that in the parade, except +that the graphs representing color components are superimposed directly +over one another. +

+
+

Default is stack. +

+
+
levels_mode, m
+

Set mode. Can be either linear, or logarithmic. +Default is linear. +

+
+
components, c
+

Set what color components to display. +Default is 7. +

+
+
bgopacity, b
+

Set background opacity. Default is 0.9. +

+
+
envelope, e
+

Show envelope. Default is disabled. +

+
+
ecolor, ec
+

Set envelope color. Default is gold. +

+
+ + +

11.207 threshold

+ +

Apply threshold effect to video stream. +

+

This filter needs four video streams to perform thresholding. +First stream is stream we are filtering. +Second stream is holding threshold values, third stream is holding min values, +and last, fourth stream is holding max values. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+ +

For example if first stream pixel’s component value is less then threshold value +of pixel component from 2nd threshold stream, third stream value will picked, +otherwise fourth stream pixel component value will be picked. +

+

Using color source filter one can perform various types of thresholding: +

+ +

11.207.1 Examples

+ +
    +
  • Binary threshold, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=black -f lavfi -i color=white -lavfi threshold output.avi
+
    + +
  • Inverted binary threshold, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=white -f lavfi -i color=black -lavfi threshold output.avi
+
    + +
  • Truncate binary threshold, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -i 320x240.avi -f lavfi -i color=gray -lavfi threshold output.avi
+
    + +
  • Threshold to zero, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=white -i 320x240.avi -lavfi threshold output.avi
+
    + +
  • Inverted threshold to zero, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -i 320x240.avi -f lavfi -i color=white -lavfi threshold output.avi
+
    +
+ + +

11.208 thumbnail

+

Select the most representative frame in a given sequence of consecutive frames. +

+

The filter accepts the following options: +

+
+
n
+

Set the frames batch size to analyze; in a set of n frames, the filter +will pick one of them, and then handle the next batch of n frames until +the end. Default is 100. +

+
+ +

Since the filter keeps track of the whole frames sequence, a bigger n +value will result in a higher memory usage, so a high value is not recommended. +

+ +

11.208.1 Examples

+ +
    +
  • Extract one picture each 50 frames: +
    +
    thumbnail=50
+
    + +
  • Complete example of a thumbnail creation with ffmpeg: +
    +
    ffmpeg -i in.avi -vf thumbnail,scale=300:200 -frames:v 1 out.png
+
    +
+ + +

11.209 tile

+ +

Tile several successive frames together. +

+

The untile filter can do the reverse. +

+

The filter accepts the following options: +

+
+
layout
+

Set the grid size (i.e. the number of lines and columns). For the syntax of +this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
nb_frames
+

Set the maximum number of frames to render in the given area. It must be less +than or equal to wxh. The default value is 0, meaning all +the area will be used. +

+
+
margin
+

Set the outer border margin in pixels. +

+
+
padding
+

Set the inner border thickness (i.e. the number of pixels between frames). For +more advanced padding options (such as having different values for the edges), +refer to the pad video filter. +

+
+
color
+

Specify the color of the unused area. For the syntax of this option, check the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +The default value of color is "black". +

+
+
overlap
+

Set the number of frames to overlap when tiling several successive frames together. +The value must be between 0 and nb_frames - 1. +

+
+
init_padding
+

Set the number of frames to initially be empty before displaying first output frame. +This controls how soon will one get first output frame. +The value must be between 0 and nb_frames - 1. +

+
+ + +

11.209.1 Examples

+ +
    +
  • Produce 8x8 PNG tiles of all keyframes (-skip_frame nokey) in a movie: +
    +
    ffmpeg -skip_frame nokey -i file.avi -vf 'scale=128:72,tile=8x8' -an -vsync 0 keyframes%03d.png
+
    +

    The -vsync 0 is necessary to prevent ffmpeg from +duplicating each output frame to accommodate the originally detected frame +rate. +

    +
  • Display 5 pictures in an area of 3x2 frames, +with 7 pixels between them, and 2 pixels of initial margin, using +mixed flat and named options: +
    +
    tile=3x2:nb_frames=5:padding=7:margin=2
+
    +
+ + +

11.210 tinterlace

+ +

Perform various types of temporal field interlacing. +

+

Frames are counted starting from 1, so the first input frame is +considered odd. +

+

The filter accepts the following options: +

+
+
mode
+

Specify the mode of the interlacing. This option can also be specified +as a value alone. See below for a list of values for this option. +

+

Available values are: +

+
+
‘merge, 0’
+

Move odd frames into the upper field, even into the lower field, +generating a double height frame at half frame rate. +

+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+
+ +
+
‘drop_even, 1’
+

Only output odd frames, even frames are dropped, generating a frame with +unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111                           33333
+11111                           33333
+11111                           33333
+11111                           33333
+
+ +
+
‘drop_odd, 2’
+

Only output even frames, odd frames are dropped, generating a frame with +unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+                22222                           44444
+                22222                           44444
+                22222                           44444
+                22222                           44444
+
+ +
+
‘pad, 3’
+

Expand each frame to full height, but pad alternate lines with black, +generating a frame with double height at the same input frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111           .....           33333           .....
+.....           22222           .....           44444
+11111           .....           33333           .....
+.....           22222           .....           44444
+11111           .....           33333           .....
+.....           22222           .....           44444
+11111           .....           33333           .....
+.....           22222           .....           44444
+
+ + +
+
‘interleave_top, 4’
+

Interleave the upper field from odd frames with the lower field from +even frames, generating a frame with unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111<-         22222           33333<-         44444
+11111           22222<-         33333           44444<-
+11111<-         22222           33333<-         44444
+11111           22222<-         33333           44444<-
+
+Output:
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+
+ + +
+
‘interleave_bottom, 5’
+

Interleave the lower field from odd frames with the upper field from +even frames, generating a frame with unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222<-         33333           44444<-
+11111<-         22222           33333<-         44444
+11111           22222<-         33333           44444<-
+11111<-         22222           33333<-         44444
+
+Output:
+22222                           44444
+11111                           33333
+22222                           44444
+11111                           33333
+
+ + +
+
‘interlacex2, 6’
+

Double frame rate with unchanged height. Frames are inserted each +containing the second temporal field from the previous input frame and +the first temporal field from the next input frame. This mode relies on +the top_field_first flag. Useful for interlaced video displays with no +field synchronisation. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+ 11111           22222           33333           44444
+11111           22222           33333           44444
+ 11111           22222           33333           44444
+
+Output:
+11111   22222   22222   33333   33333   44444   44444
+ 11111   11111   22222   22222   33333   33333   44444
+11111   22222   22222   33333   33333   44444   44444
+ 11111   11111   22222   22222   33333   33333   44444
+
+ + +
+
‘mergex2, 7’
+

Move odd frames into the upper field, even into the lower field, +generating a double height frame at same frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111           33333           33333           55555
+22222           22222           44444           44444
+11111           33333           33333           55555
+22222           22222           44444           44444
+11111           33333           33333           55555
+22222           22222           44444           44444
+11111           33333           33333           55555
+22222           22222           44444           44444
+
+ +
+
+ +

Numeric values are deprecated but are accepted for backward +compatibility reasons. +

+

Default mode is merge. +

+
+
flags
+

Specify flags influencing the filter process. +

+

Available value for flags is: +

+
+
low_pass_filter, vlpf
+

Enable linear vertical low-pass filtering in the filter. +Vertical low-pass filtering is required when creating an interlaced +destination from a progressive source which contains high-frequency +vertical detail. Filtering will reduce interlace ’twitter’ and Moire +patterning. +

+
+
complex_filter, cvlpf
+

Enable complex vertical low-pass filtering. +This will slightly less reduce interlace ’twitter’ and Moire +patterning but better retain detail and subjective sharpness impression. +

+
+
bypass_il
+

Bypass already interlaced frames, only adjust the frame rate. +

+
+ +

Vertical low-pass filtering and bypassing already interlaced frames can only be +enabled for mode interleave_top and interleave_bottom. +

+
+
+ + +

11.211 tmedian

+

Pick median pixels from several successive input video frames. +

+

The filter accepts the following options: +

+
+
radius
+

Set radius of median filter. +Default is 1. Allowed range is from 1 to 127. +

+
+
planes
+

Set which planes to filter. Default value is 15, by which all planes are processed. +

+
+
percentile
+

Set median percentile. Default value is 0.5. +Default value of 0.5 will pick always median values, while 0 will pick +minimum values, and 1 maximum values. +

+
+ + +

11.212 tmix

+ +

Mix successive video frames. +

+

A description of the accepted options follows. +

+
+
frames
+

The number of successive frames to mix. If unspecified, it defaults to 3. +

+
+
weights
+

Specify weight of each input video frame. +Each weight is separated by space. If number of weights is smaller than +number of frames last specified weight will be used for all remaining +unset weights. +

+
+
scale
+

Specify scale, if it is set it will be multiplied with sum +of each weight multiplied with pixel values to give final destination +pixel value. By default scale is auto scaled to sum of weights. +

+
+ + +

11.212.1 Examples

+ +
    +
  • Average 7 successive frames: +
    +
    tmix=frames=7:weights="1 1 1 1 1 1 1"
+
    + +
  • Apply simple temporal convolution: +
    +
    tmix=frames=3:weights="-1 3 -1"
+
    + +
  • Similar as above but only showing temporal differences: +
    +
    tmix=frames=3:weights="-1 2 -1":scale=1
+
    +
+ + +

11.213 tonemap

+

Tone map colors from different dynamic ranges. +

+

This filter expects data in single precision floating point, as it needs to +operate on (and can output) out-of-range values. Another filter, such as +zscale, is needed to convert the resulting frame to a usable format. +

+

The tonemapping algorithms implemented only work on linear light, so input +data should be linearized beforehand (and possibly correctly tagged). +

+
+
ffmpeg -i INPUT -vf zscale=transfer=linear,tonemap=clip,zscale=transfer=bt709,format=yuv420p OUTPUT
+
+ + +

11.213.1 Options

+

The filter accepts the following options. +

+
+
tonemap
+

Set the tone map algorithm to use. +

+

Possible values are: +

+
none
+

Do not apply any tone map, only desaturate overbright pixels. +

+
+
clip
+

Hard-clip any out-of-range values. Use it for perfect color accuracy for +in-range values, while distorting out-of-range values. +

+
+
linear
+

Stretch the entire reference gamut to a linear multiple of the display. +

+
+
gamma
+

Fit a logarithmic transfer between the tone curves. +

+
+
reinhard
+

Preserve overall image brightness with a simple curve, using nonlinear +contrast, which results in flattening details and degrading color accuracy. +

+
+
hable
+

Preserve both dark and bright details better than reinhard, at the cost +of slightly darkening everything. Use it when detail preservation is more +important than color and brightness accuracy. +

+
+
mobius
+

Smoothly map out-of-range values, while retaining contrast and colors for +in-range material as much as possible. Use it when color accuracy is more +important than detail preservation. +

+
+ +

Default is none. +

+
+
param
+

Tune the tone mapping algorithm. +

+

This affects the following algorithms: +

+
none
+

Ignored. +

+
+
linear
+

Specifies the scale factor to use while stretching. +Default to 1.0. +

+
+
gamma
+

Specifies the exponent of the function. +Default to 1.8. +

+
+
clip
+

Specify an extra linear coefficient to multiply into the signal before clipping. +Default to 1.0. +

+
+
reinhard
+

Specify the local contrast coefficient at the display peak. +Default to 0.5, which means that in-gamut values will be about half as bright +as when clipping. +

+
+
hable
+

Ignored. +

+
+
mobius
+

Specify the transition point from linear to mobius transform. Every value +below this point is guaranteed to be mapped 1:1. The higher the value, the +more accurate the result will be, at the cost of losing bright details. +Default to 0.3, which due to the steep initial slope still preserves in-range +colors fairly accurately. +

+
+ +
+
desat
+

Apply desaturation for highlights that exceed this level of brightness. The +higher the parameter, the more color information will be preserved. This +setting helps prevent unnaturally blown-out colors for super-highlights, by +(smoothly) turning into white instead. This makes images feel more natural, +at the cost of reducing information about out-of-range colors. +

+

The default of 2.0 is somewhat conservative and will mostly just apply to +skies or directly sunlit surfaces. A setting of 0.0 disables this option. +

+

This option works only if the input frame has a supported color tag. +

+
+
peak
+

Override signal/nominal/reference peak with this value. Useful when the +embedded peak information in display metadata is not reliable or when tone +mapping from a lower range to a higher range. +

+
+ + +

11.214 tpad

+ +

Temporarily pad video frames. +

+

The filter accepts the following options: +

+
+
start
+

Specify number of delay frames before input video stream. Default is 0. +

+
+
stop
+

Specify number of padding frames after input video stream. +Set to -1 to pad indefinitely. Default is 0. +

+
+
start_mode
+

Set kind of frames added to beginning of stream. +Can be either add or clone. +With add frames of solid-color are added. +With clone frames are clones of first frame. +Default is add. +

+
+
stop_mode
+

Set kind of frames added to end of stream. +Can be either add or clone. +With add frames of solid-color are added. +With clone frames are clones of last frame. +Default is add. +

+
+
start_duration, stop_duration
+

Specify the duration of the start/stop delay. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +These options override start and stop. Default is 0. +

+
+
color
+

Specify the color of the padded area. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. +

+

The default value of color is "black". +

+
+ + +

11.215 transpose

+ +

Transpose rows with columns in the input video and optionally flip it. +

+

It accepts the following parameters: +

+
+
dir
+

Specify the transposition direction. +

+

Can assume the following values: +

+
‘0, 4, cclock_flip’
+

Rotate by 90 degrees counterclockwise and vertically flip (default), that is: +

+
L.R     L.l
+. . ->  . .
+l.r     R.r
+
+ +
+
‘1, 5, clock’
+

Rotate by 90 degrees clockwise, that is: +

+
L.R     l.L
+. . ->  . .
+l.r     r.R
+
+ +
+
‘2, 6, cclock’
+

Rotate by 90 degrees counterclockwise, that is: +

+
L.R     R.r
+. . ->  . .
+l.r     L.l
+
+ +
+
‘3, 7, clock_flip’
+

Rotate by 90 degrees clockwise and vertically flip, that is: +

+
L.R     r.R
+. . ->  . .
+l.r     l.L
+
+
+
+ +

For values between 4-7, the transposition is only done if the input +video geometry is portrait and not landscape. These values are +deprecated, the passthrough option should be used instead. +

+

Numerical values are deprecated, and should be dropped in favor of +symbolic constants. +

+
+
passthrough
+

Do not apply the transposition if the input geometry matches the one +specified by the specified value. It accepts the following values: +

+
‘none’
+

Always apply transposition. +

+
‘portrait’
+

Preserve portrait geometry (when height >= width). +

+
‘landscape’
+

Preserve landscape geometry (when width >= height). +

+
+ +

Default value is none. +

+
+ +

For example to rotate by 90 degrees clockwise and preserve portrait +layout: +

+
transpose=dir=1:passthrough=portrait
+
+ +

The command above can also be specified as: +

+
transpose=1:portrait
+
+ + +

11.216 transpose_npp

+ +

Transpose rows with columns in the input video and optionally flip it. +For more in depth examples see the transpose video filter, which shares mostly the same options. +

+

It accepts the following parameters: +

+
+
dir
+

Specify the transposition direction. +

+

Can assume the following values: +

+
‘cclock_flip’
+

Rotate by 90 degrees counterclockwise and vertically flip. (default) +

+
+
‘clock’
+

Rotate by 90 degrees clockwise. +

+
+
‘cclock’
+

Rotate by 90 degrees counterclockwise. +

+
+
‘clock_flip’
+

Rotate by 90 degrees clockwise and vertically flip. +

+
+ +
+
passthrough
+

Do not apply the transposition if the input geometry matches the one +specified by the specified value. It accepts the following values: +

+
‘none’
+

Always apply transposition. (default) +

+
‘portrait’
+

Preserve portrait geometry (when height >= width). +

+
‘landscape’
+

Preserve landscape geometry (when width >= height). +

+
+ +
+
+ + +

11.217 trim

+

Trim the input so that the output contains one continuous subpart of the input. +

+

It accepts the following parameters: +

+
start
+

Specify the time of the start of the kept section, i.e. the frame with the +timestamp start will be the first frame in the output. +

+
+
end
+

Specify the time of the first frame that will be dropped, i.e. the frame +immediately preceding the one with the timestamp end will be the last +frame in the output. +

+
+
start_pts
+

This is the same as start, except this option sets the start timestamp +in timebase units instead of seconds. +

+
+
end_pts
+

This is the same as end, except this option sets the end timestamp +in timebase units instead of seconds. +

+
+
duration
+

The maximum duration of the output in seconds. +

+
+
start_frame
+

The number of the first frame that should be passed to the output. +

+
+
end_frame
+

The number of the first frame that should be dropped. +

+
+ +

start, end, and duration are expressed as time +duration specifications; see +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

Note that the first two sets of the start/end options and the duration +option look at the frame timestamp, while the _frame variants simply count the +frames that pass through the filter. Also note that this filter does not modify +the timestamps. If you wish for the output timestamps to start at zero, insert a +setpts filter after the trim filter. +

+

If multiple start or end options are set, this filter tries to be greedy and +keep all the frames that match at least one of the specified constraints. To keep +only the part that matches all the constraints at once, chain multiple trim +filters. +

+

The defaults are such that all the input is kept. So it is possible to set e.g. +just the end values to keep everything before the specified time. +

+

Examples: +

    +
  • Drop everything except the second minute of input: +
    +
    ffmpeg -i INPUT -vf trim=60:120
+
    + +
  • Keep only the first second: +
    +
    ffmpeg -i INPUT -vf trim=duration=1
+
    + +
+ + +

11.218 unpremultiply

+

Apply alpha unpremultiply effect to input video stream using first plane +of second stream as alpha. +

+

Both streams must have same dimensions and same pixel format. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+

If the format has 1 or 2 components, then luma is bit 0. +If the format has 3 or 4 components: +for RGB formats bit 0 is green, bit 1 is blue and bit 2 is red; +for YUV formats bit 0 is luma, bit 1 is chroma-U and bit 2 is chroma-V. +If present, the alpha channel is always the last bit. +

+
+
inplace
+

Do not require 2nd input for processing, instead use alpha plane from input stream. +

+
+ + +

11.219 unsharp

+ +

Sharpen or blur the input video. +

+

It accepts the following parameters: +

+
+
luma_msize_x, lx
+

Set the luma matrix horizontal size. It must be an odd integer between +3 and 23. The default value is 5. +

+
+
luma_msize_y, ly
+

Set the luma matrix vertical size. It must be an odd integer between 3 +and 23. The default value is 5. +

+
+
luma_amount, la
+

Set the luma effect strength. It must be a floating point number, reasonable +values lay between -1.5 and 1.5. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+

Default value is 1.0. +

+
+
chroma_msize_x, cx
+

Set the chroma matrix horizontal size. It must be an odd integer +between 3 and 23. The default value is 5. +

+
+
chroma_msize_y, cy
+

Set the chroma matrix vertical size. It must be an odd integer +between 3 and 23. The default value is 5. +

+
+
chroma_amount, ca
+

Set the chroma effect strength. It must be a floating point number, reasonable +values lay between -1.5 and 1.5. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+

Default value is 0.0. +

+
+
+ +

All parameters are optional and default to the equivalent of the +string ’5:5:1.0:5:5:0.0’. +

+ +

11.219.1 Examples

+ +
    +
  • Apply strong luma sharpen effect: +
    +
    unsharp=luma_msize_x=7:luma_msize_y=7:luma_amount=2.5
+
    + +
  • Apply a strong blur of both luma and chroma parameters: +
    +
    unsharp=7:7:-2:7:7:-2
+
    +
+ + +

11.220 untile

+ +

Decompose a video made of tiled images into the individual images. +

+

The frame rate of the output video is the frame rate of the input video +multiplied by the number of tiles. +

+

This filter does the reverse of tile. +

+

The filter accepts the following options: +

+
+
layout
+

Set the grid size (i.e. the number of lines and columns). For the syntax of +this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+ + +

11.220.1 Examples

+ +
    +
  • Produce a 1-second video from a still image file made of 25 frames stacked +vertically, like an analogic film reel: +
    +
    ffmpeg -r 1 -i image.jpg -vf untile=1x25 movie.mkv
+
    +
+ + +

11.221 uspp

+ +

Apply ultra slow/simple postprocessing filter that compresses and decompresses +the image at several (or - in the case of quality level 8 - all) +shifts and average the results. +

+

The way this differs from the behavior of spp is that uspp actually encodes & +decodes each case with libavcodec Snow, whereas spp uses a simplified intra only 8x8 +DCT similar to MJPEG. +

+

The filter accepts the following options: +

+
+
quality
+

Set quality. This option defines the number of levels for averaging. It accepts +an integer in the range 0-8. If set to 0, the filter will have no +effect. A value of 8 means the higher quality. For each increment of +that value the speed drops by a factor of approximately 2. Default value is +3. +

+
+
qp
+

Force a constant quantization parameter. If not set, the filter will use the QP +from the video stream (if available). +

+
+ + +

11.222 v360

+ +

Convert 360 videos between various formats. +

+

The filter accepts the following options: +

+
+
input
+
output
+

Set format of the input/output video. +

+

Available formats: +

+
+
‘e’
+
‘equirect’
+

Equirectangular projection. +

+
+
‘c3x2’
+
‘c6x1’
+
‘c1x6’
+

Cubemap with 3x2/6x1/1x6 layout. +

+

Format specific options: +

+
+
in_pad
+
out_pad
+

Set padding proportion for the input/output cubemap. Values in decimals. +

+

Example values: +

+
‘0’
+

No padding. +

+
‘0.01’
+

1% of face is padding. For example, with 1920x1280 resolution face size would be 640x640 and padding would be 3 pixels from each side. (640 * 0.01 = 6 pixels) +

+
+ +

Default value is ‘0’. +Maximum value is ‘0.1’. +

+
+
fin_pad
+
fout_pad
+

Set fixed padding for the input/output cubemap. Values in pixels. +

+

Default value is ‘0’. If greater than zero it overrides other padding options. +

+
+
in_forder
+
out_forder
+

Set order of faces for the input/output cubemap. Choose one direction for each position. +

+

Designation of directions: +

+
‘r’
+

right +

+
‘l’
+

left +

+
‘u’
+

up +

+
‘d’
+

down +

+
‘f’
+

forward +

+
‘b’
+

back +

+
+ +

Default value is ‘rludfb’. +

+
+
in_frot
+
out_frot
+

Set rotation of faces for the input/output cubemap. Choose one angle for each position. +

+

Designation of angles: +

+
‘0’
+

0 degrees clockwise +

+
‘1’
+

90 degrees clockwise +

+
‘2’
+

180 degrees clockwise +

+
‘3’
+

270 degrees clockwise +

+
+ +

Default value is ‘000000’. +

+
+ +
+
‘eac’
+

Equi-Angular Cubemap. +

+
+
‘flat’
+
‘gnomonic’
+
‘rectilinear’
+

Regular video. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘dfisheye’
+

Dual fisheye. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘barrel’
+
‘fb’
+
‘barrelsplit’
+

Facebook’s 360 formats. +

+
+
‘sg’
+

Stereographic format. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘mercator’
+

Mercator format. +

+
+
‘ball’
+

Ball format, gives significant distortion toward the back. +

+
+
‘hammer’
+

Hammer-Aitoff map projection format. +

+
+
‘sinusoidal’
+

Sinusoidal map projection format. +

+
+
‘fisheye’
+

Fisheye projection. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘pannini’
+

Pannini projection. +

+

Format specific options: +

+
h_fov
+

Set output pannini parameter. +

+
+
ih_fov
+

Set input pannini parameter. +

+
+ +
+
‘cylindrical’
+

Cylindrical projection. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘perspective’
+

Perspective projection. (output only) +

+

Format specific options: +

+
v_fov
+

Set perspective parameter. +

+
+ +
+
‘tetrahedron’
+

Tetrahedron projection. +

+
+
‘tsp’
+

Truncated square pyramid projection. +

+
+
‘he’
+
‘hequirect’
+

Half equirectangular projection. +

+
+ +
+
interp
+

Set interpolation method.
+Note: more complex interpolation methods require much more memory to run. +

+

Available methods: +

+
+
‘near’
+
‘nearest’
+

Nearest neighbour. +

+
‘line’
+
‘linear’
+

Bilinear interpolation. +

+
‘lagrange9’
+

Lagrange9 interpolation. +

+
‘cube’
+
‘cubic’
+

Bicubic interpolation. +

+
‘lanc’
+
‘lanczos’
+

Lanczos interpolation. +

+
‘sp16’
+
‘spline16’
+

Spline16 interpolation. +

+
‘gauss’
+
‘gaussian’
+

Gaussian interpolation. +

+
+ +

Default value is ‘line’. +

+
+
w
+
h
+

Set the output video resolution. +

+

Default resolution depends on formats. +

+
+
in_stereo
+
out_stereo
+

Set the input/output stereo format. +

+
+
‘2d’
+

2D mono +

+
‘sbs’
+

Side by side +

+
‘tb’
+

Top bottom +

+
+ +

Default value is ‘2d’ for input and output format. +

+
+
yaw
+
pitch
+
roll
+

Set rotation for the output video. Values in degrees. +

+
+
rorder
+

Set rotation order for the output video. Choose one item for each position. +

+
+
‘y, Y’
+

yaw +

+
‘p, P’
+

pitch +

+
‘r, R’
+

roll +

+
+ +

Default value is ‘ypr’. +

+
+
h_flip
+
v_flip
+
d_flip
+

Flip the output video horizontally(swaps left-right)/vertically(swaps up-down)/in-depth(swaps back-forward). Boolean values. +

+
+
ih_flip
+
iv_flip
+

Set if input video is flipped horizontally/vertically. Boolean values. +

+
+
in_trans
+

Set if input video is transposed. Boolean value, by default disabled. +

+
+
out_trans
+

Set if output video needs to be transposed. Boolean value, by default disabled. +

+
+
alpha_mask
+

Build mask in alpha plane for all unmapped pixels by marking them fully transparent. Boolean value, by default disabled. +

+
+ + +

11.222.1 Examples

+ +
    +
  • Convert equirectangular video to cubemap with 3x2 layout and 1% padding using bicubic interpolation: +
    +
    ffmpeg -i input.mkv -vf v360=e:c3x2:cubic:out_pad=0.01 output.mkv
+
    +
  • Extract back view of Equi-Angular Cubemap: +
    +
    ffmpeg -i input.mkv -vf v360=eac:flat:yaw=180 output.mkv
+
    +
  • Convert transposed and horizontally flipped Equi-Angular Cubemap in side-by-side stereo format to equirectangular top-bottom stereo format: +
    +
    v360=eac:equirect:in_stereo=sbs:in_trans=1:ih_flip=1:out_stereo=tb
+
    +
+ + +

11.222.2 Commands

+ +

This filter supports subset of above options as commands. +

+ +

11.223 vaguedenoiser

+ +

Apply a wavelet based denoiser. +

+

It transforms each frame from the video input into the wavelet domain, +using Cohen-Daubechies-Feauveau 9/7. Then it applies some filtering to +the obtained coefficients. It does an inverse wavelet transform after. +Due to wavelet properties, it should give a nice smoothed result, and +reduced noise, without blurring picture features. +

+

This filter accepts the following options: +

+
+
threshold
+

The filtering strength. The higher, the more filtered the video will be. +Hard thresholding can use a higher threshold than soft thresholding +before the video looks overfiltered. Default value is 2. +

+
+
method
+

The filtering method the filter will use. +

+

It accepts the following values: +

+
‘hard’
+

All values under the threshold will be zeroed. +

+
+
‘soft’
+

All values under the threshold will be zeroed. All values above will be +reduced by the threshold. +

+
+
‘garrote’
+

Scales or nullifies coefficients - intermediary between (more) soft and +(less) hard thresholding. +

+
+ +

Default is garrote. +

+
+
nsteps
+

Number of times, the wavelet will decompose the picture. Picture can’t +be decomposed beyond a particular point (typically, 8 for a 640x480 +frame - as 2^9 = 512 > 480). Valid values are integers between 1 and 32. Default value is 6. +

+
+
percent
+

Partial of full denoising (limited coefficients shrinking), from 0 to 100. Default value is 85. +

+
+
planes
+

A list of the planes to process. By default all planes are processed. +

+
+
type
+

The threshold type the filter will use. +

+

It accepts the following values: +

+
‘universal’
+

Threshold used is same for all decompositions. +

+
+
‘bayes’
+

Threshold used depends also on each decomposition coefficients. +

+
+ +

Default is universal. +

+
+ + +

11.224 vectorscope

+ +

Display 2 color component values in the two dimensional graph (which is called +a vectorscope). +

+

This filter accepts the following options: +

+
+
mode, m
+

Set vectorscope mode. +

+

It accepts the following values: +

+
‘gray’
+
‘tint’
+

Gray values are displayed on graph, higher brightness means more pixels have +same component color value on location in graph. This is the default mode. +

+
+
‘color’
+

Gray values are displayed on graph. Surrounding pixels values which are not +present in video frame are drawn in gradient of 2 color components which are +set by option x and y. The 3rd color component is static. +

+
+
‘color2’
+

Actual color components values present in video frame are displayed on graph. +

+
+
‘color3’
+

Similar as color2 but higher frequency of same values x and y +on graph increases value of another color component, which is luminance by +default values of x and y. +

+
+
‘color4’
+

Actual colors present in video frame are displayed on graph. If two different +colors map to same position on graph then color with higher value of component +not present in graph is picked. +

+
+
‘color5’
+

Gray values are displayed on graph. Similar to color but with 3rd color +component picked from radial gradient. +

+
+ +
+
x
+

Set which color component will be represented on X-axis. Default is 1. +

+
+
y
+

Set which color component will be represented on Y-axis. Default is 2. +

+
+
intensity, i
+

Set intensity, used by modes: gray, color, color3 and color5 for increasing brightness +of color component which represents frequency of (X, Y) location in graph. +

+
+
envelope, e
+
+
‘none’
+

No envelope, this is default. +

+
+
‘instant’
+

Instant envelope, even darkest single pixel will be clearly highlighted. +

+
+
‘peak’
+

Hold maximum and minimum values presented in graph over time. This way you +can still spot out of range values without constantly looking at vectorscope. +

+
+
‘peak+instant’
+

Peak and instant envelope combined together. +

+
+ +
+
graticule, g
+

Set what kind of graticule to draw. +

+
‘none’
+
‘green’
+
‘color’
+
‘invert’
+
+ +
+
opacity, o
+

Set graticule opacity. +

+
+
flags, f
+

Set graticule flags. +

+
+
‘white’
+

Draw graticule for white point. +

+
+
‘black’
+

Draw graticule for black point. +

+
+
‘name’
+

Draw color points short names. +

+
+ +
+
bgopacity, b
+

Set background opacity. +

+
+
lthreshold, l
+

Set low threshold for color component not represented on X or Y axis. +Values lower than this value will be ignored. Default is 0. +Note this value is multiplied with actual max possible value one pixel component +can have. So for 8-bit input and low threshold value of 0.1 actual threshold +is 0.1 * 255 = 25. +

+
+
hthreshold, h
+

Set high threshold for color component not represented on X or Y axis. +Values higher than this value will be ignored. Default is 1. +Note this value is multiplied with actual max possible value one pixel component +can have. So for 8-bit input and high threshold value of 0.9 actual threshold +is 0.9 * 255 = 230. +

+
+
colorspace, c
+

Set what kind of colorspace to use when drawing graticule. +

+
‘auto’
+
‘601’
+
‘709’
+
+

Default is auto. +

+
+
tint0, t0
+
tint1, t1
+

Set color tint for gray/tint vectorscope mode. By default both options are zero. +This means no tint, and output will remain gray. +

+
+ + +

11.225 vidstabdetect

+ +

Analyze video stabilization/deshaking. Perform pass 1 of 2, see +vidstabtransform for pass 2. +

+

This filter generates a file with relative translation and rotation +transform information about subsequent frames, which is then used by +the vidstabtransform filter. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libvidstab. +

+

This filter accepts the following options: +

+
+
result
+

Set the path to the file used to write the transforms information. +Default value is transforms.trf. +

+
+
shakiness
+

Set how shaky the video is and how quick the camera is. It accepts an +integer in the range 1-10, a value of 1 means little shakiness, a +value of 10 means strong shakiness. Default value is 5. +

+
+
accuracy
+

Set the accuracy of the detection process. It must be a value in the +range 1-15. A value of 1 means low accuracy, a value of 15 means high +accuracy. Default value is 15. +

+
+
stepsize
+

Set stepsize of the search process. The region around minimum is +scanned with 1 pixel resolution. Default value is 6. +

+
+
mincontrast
+

Set minimum contrast. Below this value a local measurement field is +discarded. Must be a floating point value in the range 0-1. Default +value is 0.3. +

+
+
tripod
+

Set reference frame number for tripod mode. +

+

If enabled, the motion of the frames is compared to a reference frame +in the filtered stream, identified by the specified number. The idea +is to compensate all movements in a more-or-less static scene and keep +the camera view absolutely still. +

+

If set to 0, it is disabled. The frames are counted starting from 1. +

+
+
show
+

Show fields and transforms in the resulting frames. It accepts an +integer in the range 0-2. Default value is 0, which disables any +visualization. +

+
+ + +

11.225.1 Examples

+ +
    +
  • Use default values: +
    +
    vidstabdetect
+
    + +
  • Analyze strongly shaky movie and put the results in file +mytransforms.trf: +
    +
    vidstabdetect=shakiness=10:accuracy=15:result="mytransforms.trf"
+
    + +
  • Visualize the result of internal transformations in the resulting +video: +
    +
    vidstabdetect=show=1
+
    + +
  • Analyze a video with medium shakiness using ffmpeg: +
    +
    ffmpeg -i input -vf vidstabdetect=shakiness=5:show=1 dummy.avi
+
    +
+ + +

11.226 vidstabtransform

+ +

Video stabilization/deshaking: pass 2 of 2, +see vidstabdetect for pass 1. +

+

Read a file with transform information for each frame and +apply/compensate them. Together with the vidstabdetect +filter this can be used to deshake videos. See also +http://public.hronopik.de/vid.stab. It is important to also use +the unsharp filter, see below. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libvidstab. +

+ +

11.226.1 Options

+ +
+
input
+

Set path to the file used to read the transforms. Default value is +transforms.trf. +

+
+
smoothing
+

Set the number of frames (value*2 + 1) used for lowpass filtering the +camera movements. Default value is 10. +

+

For example a number of 10 means that 21 frames are used (10 in the +past and 10 in the future) to smoothen the motion in the video. A +larger value leads to a smoother video, but limits the acceleration of +the camera (pan/tilt movements). 0 is a special case where a static +camera is simulated. +

+
+
optalgo
+

Set the camera path optimization algorithm. +

+

Accepted values are: +

+
‘gauss’
+

gaussian kernel low-pass filter on camera motion (default) +

+
‘avg’
+

averaging on transformations +

+
+ +
+
maxshift
+

Set maximal number of pixels to translate frames. Default value is -1, +meaning no limit. +

+
+
maxangle
+

Set maximal angle in radians (degree*PI/180) to rotate frames. Default +value is -1, meaning no limit. +

+
+
crop
+

Specify how to deal with borders that may be visible due to movement +compensation. +

+

Available values are: +

+
‘keep’
+

keep image information from previous frame (default) +

+
‘black’
+

fill the border black +

+
+ +
+
invert
+

Invert transforms if set to 1. Default value is 0. +

+
+
relative
+

Consider transforms as relative to previous frame if set to 1, +absolute if set to 0. Default value is 0. +

+
+
zoom
+

Set percentage to zoom. A positive value will result in a zoom-in +effect, a negative value in a zoom-out effect. Default value is 0 (no +zoom). +

+
+
optzoom
+

Set optimal zooming to avoid borders. +

+

Accepted values are: +

+
‘0’
+

disabled +

+
‘1’
+

optimal static zoom value is determined (only very strong movements +will lead to visible borders) (default) +

+
‘2’
+

optimal adaptive zoom value is determined (no borders will be +visible), see zoomspeed +

+
+ +

Note that the value given at zoom is added to the one calculated here. +

+
+
zoomspeed
+

Set percent to zoom maximally each frame (enabled when +optzoom is set to 2). Range is from 0 to 5, default value is +0.25. +

+
+
interpol
+

Specify type of interpolation. +

+

Available values are: +

+
‘no’
+

no interpolation +

+
‘linear’
+

linear only horizontal +

+
‘bilinear’
+

linear in both directions (default) +

+
‘bicubic’
+

cubic in both directions (slow) +

+
+ +
+
tripod
+

Enable virtual tripod mode if set to 1, which is equivalent to +relative=0:smoothing=0. Default value is 0. +

+

Use also tripod option of vidstabdetect. +

+
+
debug
+

Increase log verbosity if set to 1. Also the detected global motions +are written to the temporary file global_motions.trf. Default +value is 0. +

+
+ + +

11.226.2 Examples

+ +
    +
  • Use ffmpeg for a typical stabilization with default values: +
    +
    ffmpeg -i inp.mpeg -vf vidstabtransform,unsharp=5:5:0.8:3:3:0.4 inp_stabilized.mpeg
+
    + +

    Note the use of the unsharp filter which is always recommended. +

    +
  • Zoom in a bit more and load transform data from a given file: +
    +
    vidstabtransform=zoom=5:input="mytransforms.trf"
+
    + +
  • Smoothen the video even more: +
    +
    vidstabtransform=smoothing=30
+
    +
+ + +

11.227 vflip

+ +

Flip the input video vertically. +

+

For example, to vertically flip a video with ffmpeg: +

+
ffmpeg -i in.avi -vf "vflip" out.avi
+
+ + +

11.228 vfrdet

+ +

Detect variable frame rate video. +

+

This filter tries to detect if the input is variable or constant frame rate. +

+

At end it will output number of frames detected as having variable delta pts, +and ones with constant delta pts. +If there was frames with variable delta, than it will also show min, max and +average delta encountered. +

+ +

11.229 vibrance

+ +

Boost or alter saturation. +

+

The filter accepts the following options: +

+
intensity
+

Set strength of boost if positive value or strength of alter if negative value. +Default is 0. Allowed range is from -2 to 2. +

+
+
rbal
+

Set the red balance. Default is 1. Allowed range is from -10 to 10. +

+
+
gbal
+

Set the green balance. Default is 1. Allowed range is from -10 to 10. +

+
+
bbal
+

Set the blue balance. Default is 1. Allowed range is from -10 to 10. +

+
+
rlum
+

Set the red luma coefficient. +

+
+
glum
+

Set the green luma coefficient. +

+
+
blum
+

Set the blue luma coefficient. +

+
+
alternate
+

If intensity is negative and this is set to 1, colors will change, +otherwise colors will be less saturated, more towards gray. +

+
+ + +

11.229.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

11.230 vignette

+ +

Make or reverse a natural vignetting effect. +

+

The filter accepts the following options: +

+
+
angle, a
+

Set lens angle expression as a number of radians. +

+

The value is clipped in the [0,PI/2] range. +

+

Default value: "PI/5" +

+
+
x0
+
y0
+

Set center coordinates expressions. Respectively "w/2" and "h/2" +by default. +

+
+
mode
+

Set forward/backward mode. +

+

Available modes are: +

+
‘forward’
+

The larger the distance from the central point, the darker the image becomes. +

+
+
‘backward’
+

The larger the distance from the central point, the brighter the image becomes. +This can be used to reverse a vignette effect, though there is no automatic +detection to extract the lens angle and other settings (yet). It can +also be used to create a burning effect. +

+
+ +

Default value is ‘forward’. +

+
+
eval
+

Set evaluation mode for the expressions (angle, x0, y0). +

+

It accepts the following values: +

+
‘init’
+

Evaluate expressions only once during the filter initialization. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. This is way slower than the +‘init’ mode since it requires all the scalers to be re-computed, but it +allows advanced dynamic expressions. +

+
+ +

Default value is ‘init’. +

+
+
dither
+

Set dithering to reduce the circular banding effects. Default is 1 +(enabled). +

+
+
aspect
+

Set vignette aspect. This setting allows one to adjust the shape of the vignette. +Setting this value to the SAR of the input will make a rectangular vignetting +following the dimensions of the video. +

+

Default is 1/1. +

+
+ + +

11.230.1 Expressions

+ +

The alpha, x0 and y0 expressions can contain the +following parameters. +

+
+
w
+
h
+

input width and height +

+
+
n
+

the number of input frame, starting from 0 +

+
+
pts
+

the PTS (Presentation TimeStamp) time of the filtered video frame, expressed in +TB units, NAN if undefined +

+
+
r
+

frame rate of the input video, NAN if the input frame rate is unknown +

+
+
t
+

the PTS (Presentation TimeStamp) of the filtered video frame, +expressed in seconds, NAN if undefined +

+
+
tb
+

time base of the input video +

+
+ + + +

11.230.2 Examples

+ +
    +
  • Apply simple strong vignetting effect: +
    +
    vignette=PI/4
+
    + +
  • Make a flickering vignetting: +
    +
    vignette='PI/4+random(1)*PI/50':eval=frame
+
    + +
+ + +

11.231 vmafmotion

+ +

Obtain the average VMAF motion score of a video. +It is one of the component metrics of VMAF. +

+

The obtained average motion score is printed through the logging system. +

+

The filter accepts the following options: +

+
+
stats_file
+

If specified, the filter will use the named file to save the motion score of +each frame with respect to the previous frame. +When filename equals "-" the data is sent to standard output. +

+
+ +

Example: +

+
ffmpeg -i ref.mpg -vf vmafmotion -f null -
+
+ + +

11.232 vstack

+

Stack input videos vertically. +

+

All streams must be of same pixel format and of same width. +

+

Note that this filter is faster than using overlay and pad filter +to create same output. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of input streams. Default is 2. +

+
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+ + +

11.233 w3fdif

+ +

Deinterlace the input video ("w3fdif" stands for "Weston 3 Field +Deinterlacing Filter"). +

+

Based on the process described by Martin Weston for BBC R&D, and +implemented based on the de-interlace algorithm written by Jim +Easterbrook for BBC R&D, the Weston 3 field deinterlacing filter +uses filter coefficients calculated by BBC R&D. +

+

This filter uses field-dominance information in frame to decide which +of each pair of fields to place first in the output. +If it gets it wrong use setfield filter before w3fdif filter. +

+

There are two sets of filter coefficients, so called "simple" +and "complex". Which set of filter coefficients is used can +be set by passing an optional parameter: +

+
+
filter
+

Set the interlacing filter coefficients. Accepts one of the following values: +

+
+
‘simple’
+

Simple filter coefficient set. +

+
‘complex’
+

More-complex filter coefficient set. +

+
+

Default value is ‘complex’. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following values: +

+
+
‘all’
+

Deinterlace all frames, +

+
‘interlaced’
+

Only deinterlace frames marked as interlaced. +

+
+ +

Default value is ‘all’. +

+
+ + +

11.234 waveform

+

Video waveform monitor. +

+

The waveform monitor plots color component intensity. By default luminance +only. Each column of the waveform corresponds to a column of pixels in the +source video. +

+

It accepts the following options: +

+
+
mode, m
+

Can be either row, or column. Default is column. +In row mode, the graph on the left side represents color component value 0 and +the right side represents value = 255. In column mode, the top side represents +color component value = 0 and bottom side represents value = 255. +

+
+
intensity, i
+

Set intensity. Smaller values are useful to find out how many values of the same +luminance are distributed across input rows/columns. +Default value is 0.04. Allowed range is [0, 1]. +

+
+
mirror, r
+

Set mirroring mode. 0 means unmirrored, 1 means mirrored. +In mirrored mode, higher values will be represented on the left +side for row mode and at the top for column mode. Default is +1 (mirrored). +

+
+
display, d
+

Set display mode. +It accepts the following values: +

+
‘overlay’
+

Presents information identical to that in the parade, except +that the graphs representing color components are superimposed directly +over one another. +

+

This display mode makes it easier to spot relative differences or similarities +in overlapping areas of the color components that are supposed to be identical, +such as neutral whites, grays, or blacks. +

+
+
‘stack’
+

Display separate graph for the color components side by side in +row mode or one below the other in column mode. +

+
+
‘parade’
+

Display separate graph for the color components side by side in +column mode or one below the other in row mode. +

+

Using this display mode makes it easy to spot color casts in the highlights +and shadows of an image, by comparing the contours of the top and the bottom +graphs of each waveform. Since whites, grays, and blacks are characterized +by exactly equal amounts of red, green, and blue, neutral areas of the picture +should display three waveforms of roughly equal width/height. If not, the +correction is easy to perform by making level adjustments the three waveforms. +

+
+

Default is stack. +

+
+
components, c
+

Set which color components to display. Default is 1, which means only luminance +or red color component if input is in RGB colorspace. If is set for example to +7 it will display all 3 (if) available color components. +

+
+
envelope, e
+
+
‘none’
+

No envelope, this is default. +

+
+
‘instant’
+

Instant envelope, minimum and maximum values presented in graph will be easily +visible even with small step value. +

+
+
‘peak’
+

Hold minimum and maximum values presented in graph across time. This way you +can still spot out of range values without constantly looking at waveforms. +

+
+
‘peak+instant’
+

Peak and instant envelope combined together. +

+
+ +
+
filter, f
+
+
‘lowpass’
+

No filtering, this is default. +

+
+
‘flat’
+

Luma and chroma combined together. +

+
+
‘aflat’
+

Similar as above, but shows difference between blue and red chroma. +

+
+
‘xflat’
+

Similar as above, but use different colors. +

+
+
‘yflat’
+

Similar as above, but again with different colors. +

+
+
‘chroma’
+

Displays only chroma. +

+
+
‘color’
+

Displays actual color value on waveform. +

+
+
‘acolor’
+

Similar as above, but with luma showing frequency of chroma values. +

+
+ +
+
graticule, g
+

Set which graticule to display. +

+
+
‘none’
+

Do not display graticule. +

+
+
‘green’
+

Display green graticule showing legal broadcast ranges. +

+
+
‘orange’
+

Display orange graticule showing legal broadcast ranges. +

+
+
‘invert’
+

Display invert graticule showing legal broadcast ranges. +

+
+ +
+
opacity, o
+

Set graticule opacity. +

+
+
flags, fl
+

Set graticule flags. +

+
+
‘numbers’
+

Draw numbers above lines. By default enabled. +

+
+
‘dots’
+

Draw dots instead of lines. +

+
+ +
+
scale, s
+

Set scale used for displaying graticule. +

+
+
‘digital’
+
‘millivolts’
+
‘ire’
+
+

Default is digital. +

+
+
bgopacity, b
+

Set background opacity. +

+
+
tint0, t0
+
tint1, t1
+

Set tint for output. +Only used with lowpass filter and when display is not overlay and input +pixel formats are not RGB. +

+
+ + +

11.235 weave, doubleweave

+ +

The weave takes a field-based video input and join +each two sequential fields into single frame, producing a new double +height clip with half the frame rate and half the frame count. +

+

The doubleweave works same as weave but without +halving frame rate and frame count. +

+

It accepts the following option: +

+
+
first_field
+

Set first field. Available values are: +

+
+
‘top, t’
+

Set the frame as top-field-first. +

+
+
‘bottom, b’
+

Set the frame as bottom-field-first. +

+
+
+
+ + +

11.235.1 Examples

+ +
    +
  • Interlace video using select and separatefields filter: +
    +
    separatefields,select=eq(mod(n,4),0)+eq(mod(n,4),3),weave
+
    +
+ + +

11.236 xbr

+

Apply the xBR high-quality magnification filter which is designed for pixel +art. It follows a set of edge-detection rules, see +https://forums.libretro.com/t/xbr-algorithm-tutorial/123. +

+

It accepts the following option: +

+
+
n
+

Set the scaling dimension: 2 for 2xBR, 3 for +3xBR and 4 for 4xBR. +Default is 3. +

+
+ + +

11.237 xfade

+ +

Apply cross fade from one input video stream to another input video stream. +The cross fade is applied for specified duration. +

+

The filter accepts the following options: +

+
+
transition
+

Set one of available transition effects: +

+
+
‘custom’
+
‘fade’
+
‘wipeleft’
+
‘wiperight’
+
‘wipeup’
+
‘wipedown’
+
‘slideleft’
+
‘slideright’
+
‘slideup’
+
‘slidedown’
+
‘circlecrop’
+
‘rectcrop’
+
‘distance’
+
‘fadeblack’
+
‘fadewhite’
+
‘radial’
+
‘smoothleft’
+
‘smoothright’
+
‘smoothup’
+
‘smoothdown’
+
‘circleopen’
+
‘circleclose’
+
‘vertopen’
+
‘vertclose’
+
‘horzopen’
+
‘horzclose’
+
‘dissolve’
+
‘pixelize’
+
‘diagtl’
+
‘diagtr’
+
‘diagbl’
+
‘diagbr’
+
‘hlslice’
+
‘hrslice’
+
‘vuslice’
+
‘vdslice’
+
+

Default transition effect is fade. +

+
+
duration
+

Set cross fade duration in seconds. +Default duration is 1 second. +

+
+
offset
+

Set cross fade start relative to first input stream in seconds. +Default offset is 0. +

+
+
expr
+

Set expression for custom transition effect. +

+

The expressions can use the following variables and functions: +

+
+
X
+
Y
+

The coordinates of the current sample. +

+
+
W
+
H
+

The width and height of the image. +

+
+
P
+

Progress of transition effect. +

+
+
PLANE
+

Currently processed plane. +

+
+
A
+

Return value of first input at current location and plane. +

+
+
B
+

Return value of second input at current location and plane. +

+
+
a0(x, y)
+
a1(x, y)
+
a2(x, y)
+
a3(x, y)
+

Return the value of the pixel at location (x,y) of the +first/second/third/fourth component of first input. +

+
+
b0(x, y)
+
b1(x, y)
+
b2(x, y)
+
b3(x, y)
+

Return the value of the pixel at location (x,y) of the +first/second/third/fourth component of second input. +

+
+
+
+ + +

11.237.1 Examples

+ +
    +
  • Cross fade from one input video to another input video, with fade transition and duration of transition +of 2 seconds starting at offset of 5 seconds: +
    +
    ffmpeg -i first.mp4 -i second.mp4 -filter_complex xfade=transition=fade:duration=2:offset=5 output.mp4
+
    +
+ + +

11.238 xmedian

+

Pick median pixels from several input videos. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of inputs. +Default is 3. Allowed range is from 3 to 255. +If number of inputs is even number, than result will be mean value between two median values. +

+
+
planes
+

Set which planes to filter. Default value is 15, by which all planes are processed. +

+
+
percentile
+

Set median percentile. Default value is 0.5. +Default value of 0.5 will pick always median values, while 0 will pick +minimum values, and 1 maximum values. +

+
+ + +

11.239 xstack

+

Stack video inputs into custom layout. +

+

All streams must be of same pixel format. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of input streams. Default is 2. +

+
+
layout
+

Specify layout of inputs. +This option requires the desired layout configuration to be explicitly set by the user. +This sets position of each video input in output. Each input +is separated by ’|’. +The first number represents the column, and the second number represents the row. +Numbers start at 0 and are separated by ’_’. Optionally one can use wX and hX, +where X is video input from which to take width or height. +Multiple values can be used when separated by ’+’. In such +case values are summed together. +

+

Note that if inputs are of different sizes gaps may appear, as not all of +the output video frame will be filled. Similarly, videos can overlap each +other if their position doesn’t leave enough space for the full frame of +adjoining videos. +

+

For 2 inputs, a default layout of 0_0|w0_0 is set. In all other cases, +a layout must be set by the user. +

+
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+
fill
+

If set to valid color, all unused pixels will be filled with that color. +By default fill is set to none, so it is disabled. +

+
+ + +

11.239.1 Examples

+ +
    +
  • Display 4 inputs into 2x2 grid. + +

    Layout: +

    +
    input1(0, 0)  | input3(w0, 0)
+input2(0, h0) | input4(w0, h0)
+
    + +
    +
    xstack=inputs=4:layout=0_0|0_h0|w0_0|w0_h0
+
    + +

    Note that if inputs are of different sizes, gaps or overlaps may occur. +

    +
  • Display 4 inputs into 1x4 grid. + +

    Layout: +

    +
    input1(0, 0)
+input2(0, h0)
+input3(0, h0+h1)
+input4(0, h0+h1+h2)
+
    + +
    +
    xstack=inputs=4:layout=0_0|0_h0|0_h0+h1|0_h0+h1+h2
+
    + +

    Note that if inputs are of different widths, unused space will appear. +

    +
  • Display 9 inputs into 3x3 grid. + +

    Layout: +

    +
    input1(0, 0)       | input4(w0, 0)      | input7(w0+w3, 0)
+input2(0, h0)      | input5(w0, h0)     | input8(w0+w3, h0)
+input3(0, h0+h1)   | input6(w0, h0+h1)  | input9(w0+w3, h0+h1)
+
    + +
    +
    xstack=inputs=9:layout=0_0|0_h0|0_h0+h1|w0_0|w0_h0|w0_h0+h1|w0+w3_0|w0+w3_h0|w0+w3_h0+h1
+
    + +

    Note that if inputs are of different sizes, gaps or overlaps may occur. +

    +
  • Display 16 inputs into 4x4 grid. + +

    Layout: +

    +
    input1(0, 0)       | input5(w0, 0)       | input9 (w0+w4, 0)       | input13(w0+w4+w8, 0)
+input2(0, h0)      | input6(w0, h0)      | input10(w0+w4, h0)      | input14(w0+w4+w8, h0)
+input3(0, h0+h1)   | input7(w0, h0+h1)   | input11(w0+w4, h0+h1)   | input15(w0+w4+w8, h0+h1)
+input4(0, h0+h1+h2)| input8(w0, h0+h1+h2)| input12(w0+w4, h0+h1+h2)| input16(w0+w4+w8, h0+h1+h2)
+
    + +
    +
    xstack=inputs=16:layout=0_0|0_h0|0_h0+h1|0_h0+h1+h2|w0_0|w0_h0|w0_h0+h1|w0_h0+h1+h2|w0+w4_0|
+w0+w4_h0|w0+w4_h0+h1|w0+w4_h0+h1+h2|w0+w4+w8_0|w0+w4+w8_h0|w0+w4+w8_h0+h1|w0+w4+w8_h0+h1+h2
+
    + +

    Note that if inputs are of different sizes, gaps or overlaps may occur. +

    +
+ + +

11.240 yadif

+ +

Deinterlace the input video ("yadif" means "yet another deinterlacing +filter"). +

+

It accepts the following parameters: +

+ +
+
mode
+

The interlacing mode to adopt. It accepts one of the following values: +

+
+
0, send_frame
+

Output one frame for each frame. +

+
1, send_field
+

Output one frame for each field. +

+
2, send_frame_nospatial
+

Like send_frame, but it skips the spatial interlacing check. +

+
3, send_field_nospatial
+

Like send_field, but it skips the spatial interlacing check. +

+
+ +

The default value is send_frame. +

+
+
parity
+

The picture field parity assumed for the input interlaced video. It accepts one +of the following values: +

+
+
0, tff
+

Assume the top field is first. +

+
1, bff
+

Assume the bottom field is first. +

+
-1, auto
+

Enable automatic detection of field parity. +

+
+ +

The default value is auto. +If the interlacing is unknown or the decoder does not export this information, +top field first will be assumed. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following +values: +

+
+
0, all
+

Deinterlace all frames. +

+
1, interlaced
+

Only deinterlace frames marked as interlaced. +

+
+ +

The default value is all. +

+
+ + +

11.241 yadif_cuda

+ +

Deinterlace the input video using the yadif algorithm, but implemented +in CUDA so that it can work as part of a GPU accelerated pipeline with nvdec +and/or nvenc. +

+

It accepts the following parameters: +

+ +
+
mode
+

The interlacing mode to adopt. It accepts one of the following values: +

+
+
0, send_frame
+

Output one frame for each frame. +

+
1, send_field
+

Output one frame for each field. +

+
2, send_frame_nospatial
+

Like send_frame, but it skips the spatial interlacing check. +

+
3, send_field_nospatial
+

Like send_field, but it skips the spatial interlacing check. +

+
+ +

The default value is send_frame. +

+
+
parity
+

The picture field parity assumed for the input interlaced video. It accepts one +of the following values: +

+
+
0, tff
+

Assume the top field is first. +

+
1, bff
+

Assume the bottom field is first. +

+
-1, auto
+

Enable automatic detection of field parity. +

+
+ +

The default value is auto. +If the interlacing is unknown or the decoder does not export this information, +top field first will be assumed. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following +values: +

+
+
0, all
+

Deinterlace all frames. +

+
1, interlaced
+

Only deinterlace frames marked as interlaced. +

+
+ +

The default value is all. +

+
+ + +

11.242 yaepblur

+ +

Apply blur filter while preserving edges ("yaepblur" means "yet another edge preserving blur filter"). +The algorithm is described in +"J. S. Lee, Digital image enhancement and noise filtering by use of local statistics, IEEE Trans. Pattern Anal. Mach. Intell. PAMI-2, 1980." +

+

It accepts the following parameters: +

+
+
radius, r
+

Set the window radius. Default value is 3. +

+
+
planes, p
+

Set which planes to filter. Default is only the first plane. +

+
+
sigma, s
+

Set blur strength. Default value is 128. +

+
+ + +

11.242.1 Commands

+

This filter supports same commands as options. +

+ +

11.243 zoompan

+ +

Apply Zoom & Pan effect. +

+

This filter accepts the following options: +

+
+
zoom, z
+

Set the zoom expression. Range is 1-10. Default is 1. +

+
+
x
+
y
+

Set the x and y expression. Default is 0. +

+
+
d
+

Set the duration expression in number of frames. +This sets for how many number of frames effect will last for +single input image. +

+
+
s
+

Set the output image size, default is ’hd720’. +

+
+
fps
+

Set the output frame rate, default is ’25’. +

+
+ +

Each expression can contain the following constants: +

+
+
in_w, iw
+

Input width. +

+
+
in_h, ih
+

Input height. +

+
+
out_w, ow
+

Output width. +

+
+
out_h, oh
+

Output height. +

+
+
in
+

Input frame count. +

+
+
on
+

Output frame count. +

+
+
x
+
y
+

Last calculated ’x’ and ’y’ position from ’x’ and ’y’ expression +for current input frame. +

+
+
px
+
py
+

’x’ and ’y’ of last output frame of previous input frame or 0 when there was +not yet such frame (first input frame). +

+
+
zoom
+

Last calculated zoom from ’z’ expression for current input frame. +

+
+
pzoom
+

Last calculated zoom of last output frame of previous input frame. +

+
+
duration
+

Number of output frames for current input frame. Calculated from ’d’ expression +for each input frame. +

+
+
pduration
+

number of output frames created for previous input frame +

+
+
a
+

Rational number: input width / input height +

+
+
sar
+

sample aspect ratio +

+
+
dar
+

display aspect ratio +

+
+
+ + +

11.243.1 Examples

+ +
    +
  • Zoom-in up to 1.5 and pan at same time to some spot near center of picture: +
    +
    zoompan=z='min(zoom+0.0015,1.5)':d=700:x='if(gte(zoom,1.5),x,x+1/a)':y='if(gte(zoom,1.5),y,y+1)':s=640x360
+
    + +
  • Zoom-in up to 1.5 and pan always at center of picture: +
    +
    zoompan=z='min(zoom+0.0015,1.5)':d=700:x='iw/2-(iw/zoom/2)':y='ih/2-(ih/zoom/2)'
+
    + +
  • Same as above but without pausing: +
    +
    zoompan=z='min(max(zoom,pzoom)+0.0015,1.5)':d=1:x='iw/2-(iw/zoom/2)':y='ih/2-(ih/zoom/2)'
+
    +
+ + +

11.244 zscale

+

Scale (resize) the input video, using the z.lib library: +https://github.com/sekrit-twc/zimg. To enable compilation of this +filter, you need to configure FFmpeg with --enable-libzimg. +

+

The zscale filter forces the output display aspect ratio to be the same +as the input, by changing the output sample aspect ratio. +

+

If the input image format is different from the format requested by +the next filter, the zscale filter will convert the input to the +requested format. +

+ +

11.244.1 Options

+

The filter accepts the following options. +

+
+
width, w
+
height, h
+

Set the output video dimension expression. Default value is the input +dimension. +

+

If the width or w value is 0, the input width is used for +the output. If the height or h value is 0, the input height +is used for the output. +

+

If one and only one of the values is -n with n >= 1, the zscale filter +will use a value that maintains the aspect ratio of the input image, +calculated from the other specified dimension. After that it will, +however, make sure that the calculated dimension is divisible by n and +adjust the value if necessary. +

+

If both values are -n with n >= 1, the behavior will be identical to +both values being set to 0 as previously detailed. +

+

See below for the list of accepted constants for use in the dimension +expression. +

+
+
size, s
+

Set the video size. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
dither, d
+

Set the dither type. +

+

Possible values are: +

+
none
+
ordered
+
random
+
error_diffusion
+
+ +

Default is none. +

+
+
filter, f
+

Set the resize filter type. +

+

Possible values are: +

+
point
+
bilinear
+
bicubic
+
spline16
+
spline36
+
lanczos
+
+ +

Default is bilinear. +

+
+
range, r
+

Set the color range. +

+

Possible values are: +

+
input
+
limited
+
full
+
+ +

Default is same as input. +

+
+
primaries, p
+

Set the color primaries. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
170m
+
240m
+
2020
+
+ +

Default is same as input. +

+
+
transfer, t
+

Set the transfer characteristics. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
601
+
linear
+
2020_10
+
2020_12
+
smpte2084
+
iec61966-2-1
+
arib-std-b67
+
+ +

Default is same as input. +

+
+
matrix, m
+

Set the colorspace matrix. +

+

Possible value are: +

+
input
+
709
+
unspecified
+
470bg
+
170m
+
2020_ncl
+
2020_cl
+
+ +

Default is same as input. +

+
+
rangein, rin
+

Set the input color range. +

+

Possible values are: +

+
input
+
limited
+
full
+
+ +

Default is same as input. +

+
+
primariesin, pin
+

Set the input color primaries. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
170m
+
240m
+
2020
+
+ +

Default is same as input. +

+
+
transferin, tin
+

Set the input transfer characteristics. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
601
+
linear
+
2020_10
+
2020_12
+
+ +

Default is same as input. +

+
+
matrixin, min
+

Set the input colorspace matrix. +

+

Possible value are: +

+
input
+
709
+
unspecified
+
470bg
+
170m
+
2020_ncl
+
2020_cl
+
+ +
+
chromal, c
+

Set the output chroma location. +

+

Possible values are: +

+
input
+
left
+
center
+
topleft
+
top
+
bottomleft
+
bottom
+
+ +
+
chromalin, cin
+

Set the input chroma location. +

+

Possible values are: +

+
input
+
left
+
center
+
topleft
+
top
+
bottomleft
+
bottom
+
+ +
+
npl
+

Set the nominal peak luminance. +

+
+ +

The values of the w and h options are expressions +containing the following constants: +

+
+
in_w
+
in_h
+

The input width and height +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output (scaled) width and height +

+
+
ow
+
oh
+

These are the same as out_w and out_h +

+
+
a
+

The same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

The input display aspect ratio. Calculated from (iw / ih) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical input chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
ohsub
+
ovsub
+

horizontal and vertical output chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+ + +

11.244.2 Commands

+ +

This filter supports the following commands: +

+
width, w
+
height, h
+

Set the output video dimension expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + + +

12 OpenCL Video Filters

+ +

Below is a description of the currently available OpenCL video filters. +

+

To enable compilation of these filters you need to configure FFmpeg with +--enable-opencl. +

+

Running OpenCL filters requires you to initialize a hardware device and to pass that device to all filters in any filter graph. +

+
-init_hw_device opencl[=name][:device[,key=value...]]
+

Initialise a new hardware device of type opencl called name, using the +given device parameters. +

+
+
-filter_hw_device name
+

Pass the hardware device called name to all filters in any filter graph. +

+
+
+ +

For more detailed information see https://www.ffmpeg.org/ffmpeg.html#Advanced-Video-options +

+
    +
  • Example of choosing the first device on the second platform and running avgblur_opencl filter with default parameters on it. +
    +
    -init_hw_device opencl=gpu:1.0 -filter_hw_device gpu -i INPUT -vf "hwupload, avgblur_opencl, hwdownload" OUTPUT
+
    +
+ +

Since OpenCL filters are not able to access frame data in normal memory, all frame data needs to be uploaded(hwupload) to hardware surfaces connected to the appropriate device before being used and then downloaded(hwdownload) back to normal memory. Note that hwupload will upload to a surface with the same layout as the software frame, so it may be necessary to add a format filter immediately before to get the input into the right format and hwdownload does not support all formats on the output - it may be necessary to insert an additional format filter immediately following in the graph to get the output in a supported format. +

+ +

12.1 avgblur_opencl

+ +

Apply average blur filter. +

+

The filter accepts the following options: +

+
+
sizeX
+

Set horizontal radius size. +Range is [1, 1024] and default value is 1. +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
sizeY
+

Set vertical radius size. Range is [1, 1024] and default value is 0. If zero, sizeX value will be used. +

+
+ + +

12.1.1 Example

+ +
    +
  • Apply average blur filter with horizontal and vertical size of 3, setting each pixel of the output to the average value of the 7x7 region centered on it in the input. For pixels on the edges of the image, the region does not extend beyond the image boundaries, and so out-of-range coordinates are not used in the calculations. +
    +
    -i INPUT -vf "hwupload, avgblur_opencl=3, hwdownload" OUTPUT
+
    +
+ + +

12.2 boxblur_opencl

+ +

Apply a boxblur algorithm to the input video. +

+

It accepts the following parameters: +

+
+
luma_radius, lr
+
luma_power, lp
+
chroma_radius, cr
+
chroma_power, cp
+
alpha_radius, ar
+
alpha_power, ap
+
+ +

A description of the accepted options follows. +

+
+
luma_radius, lr
+
chroma_radius, cr
+
alpha_radius, ar
+

Set an expression for the box radius in pixels used for blurring the +corresponding input plane. +

+

The radius value must be a non-negative number, and must not be +greater than the value of the expression min(w,h)/2 for the +luma and alpha planes, and of min(cw,ch)/2 for the chroma +planes. +

+

Default value for luma_radius is "2". If not specified, +chroma_radius and alpha_radius default to the +corresponding value set for luma_radius. +

+

The expressions can contain the following constants: +

+
w
+
h
+

The input width and height in pixels. +

+
+
cw
+
ch
+

The input chroma image width and height in pixels. +

+
+
hsub
+
vsub
+

The horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p", hsub is 2 and vsub is 1. +

+
+ +
+
luma_power, lp
+
chroma_power, cp
+
alpha_power, ap
+

Specify how many times the boxblur filter is applied to the +corresponding plane. +

+

Default value for luma_power is 2. If not specified, +chroma_power and alpha_power default to the +corresponding value set for luma_power. +

+

A value of 0 will disable the effect. +

+
+ + +

12.2.1 Examples

+ +

Apply boxblur filter, setting each pixel of the output to the average value of box-radiuses luma_radius, chroma_radius, alpha_radius for each plane respectively. The filter will apply luma_power, chroma_power, alpha_power times onto the corresponding plane. For pixels on the edges of the image, the radius does not extend beyond the image boundaries, and so out-of-range coordinates are not used in the calculations. +

+
    +
  • Apply a boxblur filter with the luma, chroma, and alpha radius +set to 2 and luma, chroma, and alpha power set to 3. The filter will run 3 times with box-radius set to 2 for every plane of the image. +
    +
    -i INPUT -vf "hwupload, boxblur_opencl=luma_radius=2:luma_power=3, hwdownload" OUTPUT
+-i INPUT -vf "hwupload, boxblur_opencl=2:3, hwdownload" OUTPUT
+
    + +
  • Apply a boxblur filter with luma radius set to 2, luma_power to 1, chroma_radius to 4, chroma_power to 5, alpha_radius to 3 and alpha_power to 7. + +

    For the luma plane, a 2x2 box radius will be run once. +

    +

    For the chroma plane, a 4x4 box radius will be run 5 times. +

    +

    For the alpha plane, a 3x3 box radius will be run 7 times. +

    +
    -i INPUT -vf "hwupload, boxblur_opencl=2:1:4:5:3:7, hwdownload" OUTPUT
+
    +
+ + +

12.3 colorkey_opencl

+

RGB colorspace color keying. +

+

The filter accepts the following options: +

+
+
color
+

The color which will be replaced with transparency. +

+
+
similarity
+

Similarity percentage with the key color. +

+

0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +

+

0.0 makes pixels either fully transparent, or not transparent at all. +

+

Higher values result in semi-transparent pixels, with a higher transparency +the more similar the pixels color is to the key color. +

+
+ + +

12.3.1 Examples

+ +
    +
  • Make every semi-green pixel in the input transparent with some slight blending: +
    +
    -i INPUT -vf "hwupload, colorkey_opencl=green:0.3:0.1, hwdownload" OUTPUT
+
    +
+ + +

12.4 convolution_opencl

+ +

Apply convolution of 3x3, 5x5, 7x7 matrix. +

+

The filter accepts the following options: +

+
+
0m
+
1m
+
2m
+
3m
+

Set matrix for each plane. +Matrix is sequence of 9, 25 or 49 signed numbers. +Default value for each plane is 0 0 0 0 1 0 0 0 0. +

+
+
0rdiv
+
1rdiv
+
2rdiv
+
3rdiv
+

Set multiplier for calculated value for each plane. +If unset or 0, it will be sum of all matrix elements. +The option value must be a float number greater or equal to 0.0. Default value is 1.0. +

+
+
0bias
+
1bias
+
2bias
+
3bias
+

Set bias for each plane. This value is added to the result of the multiplication. +Useful for making the overall image brighter or darker. +The option value must be a float number greater or equal to 0.0. Default value is 0.0. +

+
+
+ + +

12.4.1 Examples

+ +
    +
  • Apply sharpen: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0, hwdownload" OUTPUT
+
    + +
  • Apply blur: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1/9:1/9:1/9:1/9, hwdownload" OUTPUT
+
    + +
  • Apply edge enhance: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:5:1:1:1:0:128:128:128, hwdownload" OUTPUT
+
    + +
  • Apply edge detect: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:5:5:5:1:0:128:128:128, hwdownload" OUTPUT
+
    + +
  • Apply laplacian edge detector which includes diagonals: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:5:5:5:1:0:128:128:0, hwdownload" OUTPUT
+
    + +
  • Apply emboss: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2, hwdownload" OUTPUT
+
    +
+ + +

12.5 erosion_opencl

+ +

Apply erosion effect to the video. +

+

This filter replaces the pixel by the local(3x3) minimum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane. Range is [0, 65535] and default value is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. +Range is [0, 255] and default value is 255, i.e. all eight pixels are used. +

+

Flags to local 3x3 coordinates region centered on x: +

+

1 2 3 +

+

4 x 5 +

+

6 7 8 +

+
+ + +

12.5.1 Example

+ +
    +
  • Apply erosion filter with threshold0 set to 30, threshold1 set 40, threshold2 set to 50 and coordinates set to 231, setting each pixel of the output to the local minimum between pixels: 1, 2, 3, 6, 7, 8 of the 3x3 region centered on it in the input. If the difference between input pixel and local minimum is more then threshold of the corresponding plane, output pixel will be set to input pixel - threshold of corresponding plane. +
    +
    -i INPUT -vf "hwupload, erosion_opencl=30:40:50:coordinates=231, hwdownload" OUTPUT
+
    +
+ + +

12.6 deshake_opencl

+

Feature-point based video stabilization filter. +

+

The filter accepts the following options: +

+
+
tripod
+

Simulates a tripod by preventing any camera movement whatsoever from the original frame. Defaults to 0. +

+
+
debug
+

Whether or not additional debug info should be displayed, both in the processed output and in the console. +

+

Note that in order to see console debug output you will also need to pass -v verbose to ffmpeg. +

+

Viewing point matches in the output video is only supported for RGB input. +

+

Defaults to 0. +

+
+
adaptive_crop
+

Whether or not to do a tiny bit of cropping at the borders to cut down on the amount of mirrored pixels. +

+

Defaults to 1. +

+
+
refine_features
+

Whether or not feature points should be refined at a sub-pixel level. +

+

This can be turned off for a slight performance gain at the cost of precision. +

+

Defaults to 1. +

+
+
smooth_strength
+

The strength of the smoothing applied to the camera path from 0.0 to 1.0. +

+

1.0 is the maximum smoothing strength while values less than that result in less smoothing. +

+

0.0 causes the filter to adaptively choose a smoothing strength on a per-frame basis. +

+

Defaults to 0.0. +

+
+
smooth_window_multiplier
+

Controls the size of the smoothing window (the number of frames buffered to determine motion information from). +

+

The size of the smoothing window is determined by multiplying the framerate of the video by this number. +

+

Acceptable values range from 0.1 to 10.0. +

+

Larger values increase the amount of motion data available for determining how to smooth the camera path, +potentially improving smoothness, but also increase latency and memory usage. +

+

Defaults to 2.0. +

+
+
+ + +

12.6.1 Examples

+ +
    +
  • Stabilize a video with a fixed, medium smoothing strength: +
    +
    -i INPUT -vf "hwupload, deshake_opencl=smooth_strength=0.5, hwdownload" OUTPUT
+
    + +
  • Stabilize a video with debugging (both in console and in rendered video): +
    +
    -i INPUT -filter_complex "[0:v]format=rgba, hwupload, deshake_opencl=debug=1, hwdownload, format=rgba, format=yuv420p" -v verbose OUTPUT
+
    +
+ + +

12.7 dilation_opencl

+ +

Apply dilation effect to the video. +

+

This filter replaces the pixel by the local(3x3) maximum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane. Range is [0, 65535] and default value is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. +Range is [0, 255] and default value is 255, i.e. all eight pixels are used. +

+

Flags to local 3x3 coordinates region centered on x: +

+

1 2 3 +

+

4 x 5 +

+

6 7 8 +

+
+ + +

12.7.1 Example

+ +
    +
  • Apply dilation filter with threshold0 set to 30, threshold1 set 40, threshold2 set to 50 and coordinates set to 231, setting each pixel of the output to the local maximum between pixels: 1, 2, 3, 6, 7, 8 of the 3x3 region centered on it in the input. If the difference between input pixel and local maximum is more then threshold of the corresponding plane, output pixel will be set to input pixel + threshold of corresponding plane. +
    +
    -i INPUT -vf "hwupload, dilation_opencl=30:40:50:coordinates=231, hwdownload" OUTPUT
+
    +
+ + +

12.8 nlmeans_opencl

+ +

Non-local Means denoise filter through OpenCL, this filter accepts same options as nlmeans. +

+ +

12.9 overlay_opencl

+ +

Overlay one video on top of another. +

+

It takes two inputs and has one output. The first input is the "main" video on which the second input is overlaid. +This filter requires same memory layout for all the inputs. So, format conversion may be needed. +

+

The filter accepts the following options: +

+
+
x
+

Set the x coordinate of the overlaid video on the main video. +Default value is 0. +

+
+
y
+

Set the y coordinate of the overlaid video on the main video. +Default value is 0. +

+
+
+ + +

12.9.1 Examples

+ +
    +
  • Overlay an image LOGO at the top-left corner of the INPUT video. Both inputs are yuv420p format. +
    +
    -i INPUT -i LOGO -filter_complex "[0:v]hwupload[a], [1:v]format=yuv420p, hwupload[b], [a][b]overlay_opencl, hwdownload" OUTPUT
+
    +
  • The inputs have same memory layout for color channels , the overlay has additional alpha plane, like INPUT is yuv420p, and the LOGO is yuva420p. +
    +
    -i INPUT -i LOGO -filter_complex "[0:v]hwupload[a], [1:v]format=yuva420p, hwupload[b], [a][b]overlay_opencl, hwdownload" OUTPUT
+
    + +
+ + +

12.10 pad_opencl

+ +

Add paddings to the input image, and place the original input at the +provided x, y coordinates. +

+

It accepts the following options: +

+
+
width, w
+
height, h
+

Specify an expression for the size of the output image with the +paddings added. If the value for width or height is 0, the +corresponding input size is used for the output. +

+

The width expression can reference the value set by the +height expression, and vice versa. +

+

The default value of width and height is 0. +

+
+
x
+
y
+

Specify the offsets to place the input image at within the padded area, +with respect to the top/left border of the output image. +

+

The x expression can reference the value set by the y +expression, and vice versa. +

+

The default value of x and y is 0. +

+

If x or y evaluate to a negative number, they’ll be changed +so the input image is centered on the padded area. +

+
+
color
+

Specify the color of the padded area. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. +

+
+
aspect
+

Pad to an aspect instead to a resolution. +

+
+ +

The value for the width, height, x, and y +options are expressions containing the following constants: +

+
+
in_w
+
in_h
+

The input video width and height. +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output width and height (the size of the padded area), as +specified by the width and height expressions. +

+
+
ow
+
oh
+

These are the same as out_w and out_h. +

+
+
x
+
y
+

The x and y offsets as specified by the x and y +expressions, or NAN if not yet specified. +

+
+
a
+

same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (iw / ih) * sar +

+
+ + +

12.11 prewitt_opencl

+ +

Apply the Prewitt operator (https://en.wikipedia.org/wiki/Prewitt_operator) to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +Range is [0.0, 65535] and default value is 1.0. +

+
+
delta
+

Set value which will be added to filtered result. +Range is [-65535, 65535] and default value is 0.0. +

+
+ + +

12.11.1 Example

+ +
    +
  • Apply the Prewitt operator with scale set to 2 and delta set to 10. +
    +
    -i INPUT -vf "hwupload, prewitt_opencl=scale=2:delta=10, hwdownload" OUTPUT
+
    +
+ + +

12.12 program_opencl

+ +

Filter video using an OpenCL program. +

+
+
source
+

OpenCL program source file. +

+
+
kernel
+

Kernel name in program. +

+
+
inputs
+

Number of inputs to the filter. Defaults to 1. +

+
+
size, s
+

Size of output frames. Defaults to the same as the first input. +

+
+
+ +

The program_opencl filter also supports the framesync options. +

+

The program source file must contain a kernel function with the given name, +which will be run once for each plane of the output. Each run on a plane +gets enqueued as a separate 2D global NDRange with one work-item for each +pixel to be generated. The global ID offset for each work-item is therefore +the coordinates of a pixel in the destination image. +

+

The kernel function needs to take the following arguments: +

    +
  • Destination image, __write_only image2d_t. + +

    This image will become the output; the kernel should write all of it. +

  • Frame index, unsigned int. + +

    This is a counter starting from zero and increasing by one for each frame. +

  • Source images, __read_only image2d_t. + +

    These are the most recent images on each input. The kernel may read from +them to generate the output, but they can’t be written to. +

+ +

Example programs: +

+
    +
  • Copy the input to the output (output must be the same size as the input). +
    __kernel void copy(__write_only image2d_t destination,
+                   unsigned int index,
+                   __read_only  image2d_t source)
+{
+    const sampler_t sampler = CLK_NORMALIZED_COORDS_FALSE;
+
+    int2 location = (int2)(get_global_id(0), get_global_id(1));
+
+    float4 value = read_imagef(source, sampler, location);
+
+    write_imagef(destination, location, value);
+}
+
    +
  • Apply a simple transformation, rotating the input by an amount increasing +with the index counter. Pixel values are linearly interpolated by the +sampler, and the output need not have the same dimensions as the input. +
    __kernel void rotate_image(__write_only image2d_t dst,
+                           unsigned int index,
+                           __read_only  image2d_t src)
+{
+    const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE |
+                               CLK_FILTER_LINEAR);
+
+    float angle = (float)index / 100.0f;
+
+    float2 dst_dim = convert_float2(get_image_dim(dst));
+    float2 src_dim = convert_float2(get_image_dim(src));
+
+    float2 dst_cen = dst_dim / 2.0f;
+    float2 src_cen = src_dim / 2.0f;
+
+    int2   dst_loc = (int2)(get_global_id(0), get_global_id(1));
+
+    float2 dst_pos = convert_float2(dst_loc) - dst_cen;
+    float2 src_pos = {
+        cos(angle) * dst_pos.x - sin(angle) * dst_pos.y,
+        sin(angle) * dst_pos.x + cos(angle) * dst_pos.y
+    };
+    src_pos = src_pos * src_dim / dst_dim;
+
+    float2 src_loc = src_pos + src_cen;
+
+    if (src_loc.x < 0.0f      || src_loc.y < 0.0f ||
+        src_loc.x > src_dim.x || src_loc.y > src_dim.y)
+        write_imagef(dst, dst_loc, 0.5f);
+    else
+        write_imagef(dst, dst_loc, read_imagef(src, sampler, src_loc));
+}
+
    +
  • Blend two inputs together, with the amount of each input used varying +with the index counter. +
    __kernel void blend_images(__write_only image2d_t dst,
+                           unsigned int index,
+                           __read_only  image2d_t src1,
+                           __read_only  image2d_t src2)
+{
+    const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE |
+                               CLK_FILTER_LINEAR);
+
+    float blend = (cos((float)index / 50.0f) + 1.0f) / 2.0f;
+
+    int2  dst_loc = (int2)(get_global_id(0), get_global_id(1));
+    int2 src1_loc = dst_loc * get_image_dim(src1) / get_image_dim(dst);
+    int2 src2_loc = dst_loc * get_image_dim(src2) / get_image_dim(dst);
+
+    float4 val1 = read_imagef(src1, sampler, src1_loc);
+    float4 val2 = read_imagef(src2, sampler, src2_loc);
+
+    write_imagef(dst, dst_loc, val1 * blend + val2 * (1.0f - blend));
+}
+
    +
+ + +

12.13 roberts_opencl

+

Apply the Roberts cross operator (https://en.wikipedia.org/wiki/Roberts_cross) to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +Range is [0.0, 65535] and default value is 1.0. +

+
+
delta
+

Set value which will be added to filtered result. +Range is [-65535, 65535] and default value is 0.0. +

+
+ + +

12.13.1 Example

+ +
    +
  • Apply the Roberts cross operator with scale set to 2 and delta set to 10 +
    +
    -i INPUT -vf "hwupload, roberts_opencl=scale=2:delta=10, hwdownload" OUTPUT
+
    +
+ + +

12.14 sobel_opencl

+ +

Apply the Sobel operator (https://en.wikipedia.org/wiki/Sobel_operator) to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +Range is [0.0, 65535] and default value is 1.0. +

+
+
delta
+

Set value which will be added to filtered result. +Range is [-65535, 65535] and default value is 0.0. +

+
+ + +

12.14.1 Example

+ +
    +
  • Apply sobel operator with scale set to 2 and delta set to 10 +
    +
    -i INPUT -vf "hwupload, sobel_opencl=scale=2:delta=10, hwdownload" OUTPUT
+
    +
+ + +

12.15 tonemap_opencl

+ +

Perform HDR(PQ/HLG) to SDR conversion with tone-mapping. +

+

It accepts the following parameters: +

+
+
tonemap
+

Specify the tone-mapping operator to be used. Same as tonemap option in tonemap. +

+
+
param
+

Tune the tone mapping algorithm. same as param option in tonemap. +

+
+
desat
+

Apply desaturation for highlights that exceed this level of brightness. The +higher the parameter, the more color information will be preserved. This +setting helps prevent unnaturally blown-out colors for super-highlights, by +(smoothly) turning into white instead. This makes images feel more natural, +at the cost of reducing information about out-of-range colors. +

+

The default value is 0.5, and the algorithm here is a little different from +the cpu version tonemap currently. A setting of 0.0 disables this option. +

+
+
threshold
+

The tonemapping algorithm parameters is fine-tuned per each scene. And a threshold +is used to detect whether the scene has changed or not. If the distance between +the current frame average brightness and the current running average exceeds +a threshold value, we would re-calculate scene average and peak brightness. +The default value is 0.2. +

+
+
format
+

Specify the output pixel format. +

+

Currently supported formats are: +

+
p010
+
nv12
+
+ +
+
range, r
+

Set the output color range. +

+

Possible values are: +

+
tv/mpeg
+
pc/jpeg
+
+ +

Default is same as input. +

+
+
primaries, p
+

Set the output color primaries. +

+

Possible values are: +

+
bt709
+
bt2020
+
+ +

Default is same as input. +

+
+
transfer, t
+

Set the output transfer characteristics. +

+

Possible values are: +

+
bt709
+
bt2020
+
+ +

Default is bt709. +

+
+
matrix, m
+

Set the output colorspace matrix. +

+

Possible value are: +

+
bt709
+
bt2020
+
+ +

Default is same as input. +

+
+
+ + +

12.15.1 Example

+ +
    +
  • Convert HDR(PQ/HLG) video to bt2020-transfer-characteristic p010 format using linear operator. +
    +
    -i INPUT -vf "format=p010,hwupload,tonemap_opencl=t=bt2020:tonemap=linear:format=p010,hwdownload,format=p010" OUTPUT
+
    +
+ + +

12.16 unsharp_opencl

+ +

Sharpen or blur the input video. +

+

It accepts the following parameters: +

+
+
luma_msize_x, lx
+

Set the luma matrix horizontal size. +Range is [1, 23] and default value is 5. +

+
+
luma_msize_y, ly
+

Set the luma matrix vertical size. +Range is [1, 23] and default value is 5. +

+
+
luma_amount, la
+

Set the luma effect strength. +Range is [-10, 10] and default value is 1.0. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+
+
chroma_msize_x, cx
+

Set the chroma matrix horizontal size. +Range is [1, 23] and default value is 5. +

+
+
chroma_msize_y, cy
+

Set the chroma matrix vertical size. +Range is [1, 23] and default value is 5. +

+
+
chroma_amount, ca
+

Set the chroma effect strength. +Range is [-10, 10] and default value is 0.0. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+
+
+ +

All parameters are optional and default to the equivalent of the +string ’5:5:1.0:5:5:0.0’. +

+ +

12.16.1 Examples

+ +
    +
  • Apply strong luma sharpen effect: +
    +
    -i INPUT -vf "hwupload, unsharp_opencl=luma_msize_x=7:luma_msize_y=7:luma_amount=2.5, hwdownload" OUTPUT
+
    + +
  • Apply a strong blur of both luma and chroma parameters: +
    +
    -i INPUT -vf "hwupload, unsharp_opencl=7:7:-2:7:7:-2, hwdownload" OUTPUT
+
    +
+ + +

12.17 xfade_opencl

+ +

Cross fade two videos with custom transition effect by using OpenCL. +

+

It accepts the following options: +

+
+
transition
+

Set one of possible transition effects. +

+
+
custom
+

Select custom transition effect, the actual transition description +will be picked from source and kernel options. +

+
+
fade
+
wipeleft
+
wiperight
+
wipeup
+
wipedown
+
slideleft
+
slideright
+
slideup
+
slidedown
+
+

Default transition is fade. +

+
+ +
+
source
+

OpenCL program source file for custom transition. +

+
+
kernel
+

Set name of kernel to use for custom transition from program source file. +

+
+
duration
+

Set duration of video transition. +

+
+
offset
+

Set time of start of transition relative to first video. +

+
+ +

The program source file must contain a kernel function with the given name, +which will be run once for each plane of the output. Each run on a plane +gets enqueued as a separate 2D global NDRange with one work-item for each +pixel to be generated. The global ID offset for each work-item is therefore +the coordinates of a pixel in the destination image. +

+

The kernel function needs to take the following arguments: +

    +
  • Destination image, __write_only image2d_t. + +

    This image will become the output; the kernel should write all of it. +

    +
  • First Source image, __read_only image2d_t. +Second Source image, __read_only image2d_t. + +

    These are the most recent images on each input. The kernel may read from +them to generate the output, but they can’t be written to. +

    +
  • Transition progress, float. This value is always between 0 and 1 inclusive. +
+ +

Example programs: +

+
    +
  • Apply dots curtain transition effect: +
    __kernel void blend_images(__write_only image2d_t dst,
+                           __read_only  image2d_t src1,
+                           __read_only  image2d_t src2,
+                           float progress)
+{
+    const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE |
+                               CLK_FILTER_LINEAR);
+    int2  p = (int2)(get_global_id(0), get_global_id(1));
+    float2 rp = (float2)(get_global_id(0), get_global_id(1));
+    float2 dim = (float2)(get_image_dim(src1).x, get_image_dim(src1).y);
+    rp = rp / dim;
+
+    float2 dots = (float2)(20.0, 20.0);
+    float2 center = (float2)(0,0);
+    float2 unused;
+
+    float4 val1 = read_imagef(src1, sampler, p);
+    float4 val2 = read_imagef(src2, sampler, p);
+    bool next = distance(fract(rp * dots, &unused), (float2)(0.5, 0.5)) < (progress / distance(rp, center));
+
+    write_imagef(dst, p, next ? val1 : val2);
+}
+
    +
+ + + +

13 VAAPI Video Filters

+ +

VAAPI Video filters are usually used with VAAPI decoder and VAAPI encoder. Below is a description of VAAPI video filters. +

+

To enable compilation of these filters you need to configure FFmpeg with +--enable-vaapi. +

+

To use vaapi filters, you need to setup the vaapi device correctly. For more information, please read https://trac.ffmpeg.org/wiki/Hardware/VAAPI +

+ +

13.1 tonemap_vaapi

+ +

Perform HDR(High Dynamic Range) to SDR(Standard Dynamic Range) conversion with tone-mapping. +It maps the dynamic range of HDR10 content to the SDR content. +It currently only accepts HDR10 as input. +

+

It accepts the following parameters: +

+
+
format
+

Specify the output pixel format. +

+

Currently supported formats are: +

+
p010
+
nv12
+
+ +

Default is nv12. +

+
+
primaries, p
+

Set the output color primaries. +

+

Default is same as input. +

+
+
transfer, t
+

Set the output transfer characteristics. +

+

Default is bt709. +

+
+
matrix, m
+

Set the output colorspace matrix. +

+

Default is same as input. +

+
+
+ + +

13.1.1 Example

+ +
    +
  • Convert HDR(HDR10) video to bt2020-transfer-characteristic p010 format +
    +
    tonemap_vaapi=format=p010:t=bt2020-10
+
    +
+ + + +

14 Video Sources

+ +

Below is a description of the currently available video sources. +

+ +

14.1 buffer

+ +

Buffer video frames, and make them available to the filter chain. +

+

This source is mainly intended for a programmatic use, in particular +through the interface defined in libavfilter/vsrc_buffer.h. +

+

It accepts the following parameters: +

+
+
video_size
+

Specify the size (width and height) of the buffered video frames. For the +syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
width
+

The input video width. +

+
+
height
+

The input video height. +

+
+
pix_fmt
+

A string representing the pixel format of the buffered video frames. +It may be a number corresponding to a pixel format, or a pixel format +name. +

+
+
time_base
+

Specify the timebase assumed by the timestamps of the buffered frames. +

+
+
frame_rate
+

Specify the frame rate expected for the video stream. +

+
+
pixel_aspect, sar
+

The sample (pixel) aspect ratio of the input video. +

+
+
sws_param
+

This option is deprecated and ignored. Prepend sws_flags=flags; +to the filtergraph description to specify swscale flags for automatically +inserted scalers. See Filtergraph syntax. +

+
+
hw_frames_ctx
+

When using a hardware pixel format, this should be a reference to an +AVHWFramesContext describing input frames. +

+
+ +

For example: +

+
buffer=width=320:height=240:pix_fmt=yuv410p:time_base=1/24:sar=1
+
+ +

will instruct the source to accept video frames with size 320x240 and +with format "yuv410p", assuming 1/24 as the timestamps timebase and +square pixels (1:1 sample aspect ratio). +Since the pixel format with name "yuv410p" corresponds to the number 6 +(check the enum AVPixelFormat definition in libavutil/pixfmt.h), +this example corresponds to: +

+
buffer=size=320x240:pixfmt=6:time_base=1/24:pixel_aspect=1/1
+
+ +

Alternatively, the options can be specified as a flat string, but this +syntax is deprecated: +

+

width:height:pix_fmt:time_base.num:time_base.den:pixel_aspect.num:pixel_aspect.den +

+ +

14.2 cellauto

+ +

Create a pattern generated by an elementary cellular automaton. +

+

The initial state of the cellular automaton can be defined through the +filename and pattern options. If such options are +not specified an initial state is created randomly. +

+

At each new frame a new row in the video is filled with the result of +the cellular automaton next generation. The behavior when the whole +frame is filled is defined by the scroll option. +

+

This source accepts the following options: +

+
+
filename, f
+

Read the initial cellular automaton state, i.e. the starting row, from +the specified file. +In the file, each non-whitespace character is considered an alive +cell, a newline will terminate the row, and further characters in the +file will be ignored. +

+
+
pattern, p
+

Read the initial cellular automaton state, i.e. the starting row, from +the specified string. +

+

Each non-whitespace character in the string is considered an alive +cell, a newline will terminate the row, and further characters in the +string will be ignored. +

+
+
rate, r
+

Set the video rate, that is the number of frames generated per second. +Default is 25. +

+
+
random_fill_ratio, ratio
+

Set the random fill ratio for the initial cellular automaton row. It +is a floating point number value ranging from 0 to 1, defaults to +1/PHI. +

+

This option is ignored when a file or a pattern is specified. +

+
+
random_seed, seed
+

Set the seed for filling randomly the initial row, must be an integer +included between 0 and UINT32_MAX. If not specified, or if explicitly +set to -1, the filter will try to use a good random seed on a best +effort basis. +

+
+
rule
+

Set the cellular automaton rule, it is a number ranging from 0 to 255. +Default value is 110. +

+
+
size, s
+

Set the size of the output video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+

If filename or pattern is specified, the size is set +by default to the width of the specified initial state row, and the +height is set to width * PHI. +

+

If size is set, it must contain the width of the specified +pattern string, and the specified pattern will be centered in the +larger row. +

+

If a filename or a pattern string is not specified, the size value +defaults to "320x518" (used for a randomly generated initial state). +

+
+
scroll
+

If set to 1, scroll the output upward when all the rows in the output +have been already filled. If set to 0, the new generated row will be +written over the top row just after the bottom row is filled. +Defaults to 1. +

+
+
start_full, full
+

If set to 1, completely fill the output with generated rows before +outputting the first frame. +This is the default behavior, for disabling set the value to 0. +

+
+
stitch
+

If set to 1, stitch the left and right row edges together. +This is the default behavior, for disabling set the value to 0. +

+
+ + +

14.2.1 Examples

+ +
    +
  • Read the initial state from pattern, and specify an output of +size 200x400. +
    +
    cellauto=f=pattern:s=200x400
+
    + +
  • Generate a random initial row with a width of 200 cells, with a fill +ratio of 2/3: +
    +
    cellauto=ratio=2/3:s=200x200
+
    + +
  • Create a pattern generated by rule 18 starting by a single alive cell +centered on an initial row with width 100: +
    +
    cellauto=p=@:s=100x400:full=0:rule=18
+
    + +
  • Specify a more elaborated initial pattern: +
    +
    cellauto=p='@@ @ @@':s=100x400:full=0:rule=18
+
    + +
+ + +

14.3 coreimagesrc

+

Video source generated on GPU using Apple’s CoreImage API on OSX. +

+

This video source is a specialized version of the coreimage video filter. +Use a core image generator at the beginning of the applied filterchain to +generate the content. +

+

The coreimagesrc video source accepts the following options: +

+
list_generators
+

List all available generators along with all their respective options as well as +possible minimum and maximum values along with the default values. +

+
list_generators=true
+
+ +
+
size, s
+

Specify the size of the sourced video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +The default value is 320x240. +

+
+
rate, r
+

Specify the frame rate of the sourced video, as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a floating point +number or a valid video frame rate abbreviation. The default value is +"25". +

+
+
sar
+

Set the sample aspect ratio of the sourced video. +

+
+
duration, d
+

Set the duration of the sourced video. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

If not specified, or the expressed duration is negative, the video is +supposed to be generated forever. +

+
+ +

Additionally, all options of the coreimage video filter are accepted. +A complete filterchain can be used for further processing of the +generated input without CPU-HOST transfer. See coreimage documentation +and examples for details. +

+ +

14.3.1 Examples

+ +
    +
  • Use CIQRCodeGenerator to create a QR code for the FFmpeg homepage, +given as complete and escaped command-line for Apple’s standard bash shell: +
    +
    ffmpeg -f lavfi -i coreimagesrc=s=100x100:filter=CIQRCodeGenerator@inputMessage=https\\\\\://FFmpeg.org/@inputCorrectionLevel=H -frames:v 1 QRCode.png
+
    +

    This example is equivalent to the QRCode example of coreimage without the +need for a nullsrc video source. +

+ + + +

14.4 gradients

+

Generate several gradients. +

+
+
size, s
+

Set frame size. For the syntax of this option, check the (ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual. Default value is "640x480". +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
c0, c1, c2, c3, c4, c5, c6, c7
+

Set 8 colors. Default values for colors is to pick random one. +

+
+
x0, y0, y0, y1
+

Set gradient line source and destination points. If negative or out of range, random ones +are picked. +

+
+
nb_colors, n
+

Set number of colors to use at once. Allowed range is from 2 to 8. Default value is 2. +

+
+
seed
+

Set seed for picking gradient line points. +

+
+ + + +

14.5 mandelbrot

+ +

Generate a Mandelbrot set fractal, and progressively zoom towards the +point specified with start_x and start_y. +

+

This source accepts the following options: +

+
+
end_pts
+

Set the terminal pts value. Default value is 400. +

+
+
end_scale
+

Set the terminal scale value. +Must be a floating point value. Default value is 0.3. +

+
+
inner
+

Set the inner coloring mode, that is the algorithm used to draw the +Mandelbrot fractal internal region. +

+

It shall assume one of the following values: +

+
black
+

Set black mode. +

+
convergence
+

Show time until convergence. +

+
mincol
+

Set color based on point closest to the origin of the iterations. +

+
period
+

Set period mode. +

+
+ +

Default value is mincol. +

+
+
bailout
+

Set the bailout value. Default value is 10.0. +

+
+
maxiter
+

Set the maximum of iterations performed by the rendering +algorithm. Default value is 7189. +

+
+
outer
+

Set outer coloring mode. +It shall assume one of following values: +

+
iteration_count
+

Set iteration count mode. +

+
normalized_iteration_count
+

set normalized iteration count mode. +

+
+

Default value is normalized_iteration_count. +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
size, s
+

Set frame size. For the syntax of this option, check the (ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual. Default value is "640x480". +

+
+
start_scale
+

Set the initial scale value. Default value is 3.0. +

+
+
start_x
+

Set the initial x position. Must be a floating point value between +-100 and 100. Default value is -0.743643887037158704752191506114774. +

+
+
start_y
+

Set the initial y position. Must be a floating point value between +-100 and 100. Default value is -0.131825904205311970493132056385139. +

+
+ + +

14.6 mptestsrc

+ +

Generate various test patterns, as generated by the MPlayer test filter. +

+

The size of the generated video is fixed, and is 256x256. +This source is useful in particular for testing encoding features. +

+

This source accepts the following options: +

+
+
rate, r
+

Specify the frame rate of the sourced video, as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a floating point +number or a valid video frame rate abbreviation. The default value is +"25". +

+
+
duration, d
+

Set the duration of the sourced video. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

If not specified, or the expressed duration is negative, the video is +supposed to be generated forever. +

+
+
test, t
+
+

Set the number or the name of the test to perform. Supported tests are: +

+
dc_luma
+
dc_chroma
+
freq_luma
+
freq_chroma
+
amp_luma
+
amp_chroma
+
cbp
+
mv
+
ring1
+
ring2
+
all
+
max_frames, m
+

Set the maximum number of frames generated for each test, default value is 30. +

+
+
+ +

Default value is "all", which will cycle through the list of all tests. +

+
+ +

Some examples: +

+
mptestsrc=t=dc_luma
+
+ +

will generate a "dc_luma" test pattern. +

+ +

14.7 frei0r_src

+ +

Provide a frei0r source. +

+

To enable compilation of this filter you need to install the frei0r +header and configure FFmpeg with --enable-frei0r. +

+

This source accepts the following parameters: +

+
+
size
+

The size of the video to generate. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
framerate
+

The framerate of the generated video. It may be a string of the form +num/den or a frame rate abbreviation. +

+
+
filter_name
+

The name to the frei0r source to load. For more information regarding frei0r and +how to set the parameters, read the frei0r section in the video filters +documentation. +

+
+
filter_params
+

A ’|’-separated list of parameters to pass to the frei0r source. +

+
+
+ +

For example, to generate a frei0r partik0l source with size 200x200 +and frame rate 10 which is overlaid on the overlay filter main input: +

+
frei0r_src=size=200x200:framerate=10:filter_name=partik0l:filter_params=1234 [overlay]; [in][overlay] overlay
+
+ + +

14.8 life

+ +

Generate a life pattern. +

+

This source is based on a generalization of John Conway’s life game. +

+

The sourced input represents a life grid, each pixel represents a cell +which can be in one of two possible states, alive or dead. Every cell +interacts with its eight neighbours, which are the cells that are +horizontally, vertically, or diagonally adjacent. +

+

At each interaction the grid evolves according to the adopted rule, +which specifies the number of neighbor alive cells which will make a +cell stay alive or born. The rule option allows one to specify +the rule to adopt. +

+

This source accepts the following options: +

+
+
filename, f
+

Set the file from which to read the initial grid state. In the file, +each non-whitespace character is considered an alive cell, and newline +is used to delimit the end of each row. +

+

If this option is not specified, the initial grid is generated +randomly. +

+
+
rate, r
+

Set the video rate, that is the number of frames generated per second. +Default is 25. +

+
+
random_fill_ratio, ratio
+

Set the random fill ratio for the initial random grid. It is a +floating point number value ranging from 0 to 1, defaults to 1/PHI. +It is ignored when a file is specified. +

+
+
random_seed, seed
+

Set the seed for filling the initial random grid, must be an integer +included between 0 and UINT32_MAX. If not specified, or if explicitly +set to -1, the filter will try to use a good random seed on a best +effort basis. +

+
+
rule
+

Set the life rule. +

+

A rule can be specified with a code of the kind "SNS/BNB", +where NS and NB are sequences of numbers in the range 0-8, +NS specifies the number of alive neighbor cells which make a +live cell stay alive, and NB the number of alive neighbor cells +which make a dead cell to become alive (i.e. to "born"). +"s" and "b" can be used in place of "S" and "B", respectively. +

+

Alternatively a rule can be specified by an 18-bits integer. The 9 +high order bits are used to encode the next cell state if it is alive +for each number of neighbor alive cells, the low order bits specify +the rule for "borning" new cells. Higher order bits encode for an +higher number of neighbor cells. +For example the number 6153 = (12<<9)+9 specifies a stay alive +rule of 12 and a born rule of 9, which corresponds to "S23/B03". +

+

Default value is "S23/B3", which is the original Conway’s game of life +rule, and will keep a cell alive if it has 2 or 3 neighbor alive +cells, and will born a new cell if there are three alive cells around +a dead cell. +

+
+
size, s
+

Set the size of the output video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+

If filename is specified, the size is set by default to the +same size of the input file. If size is set, it must contain +the size specified in the input file, and the initial grid defined in +that file is centered in the larger resulting area. +

+

If a filename is not specified, the size value defaults to "320x240" +(used for a randomly generated initial grid). +

+
+
stitch
+

If set to 1, stitch the left and right grid edges together, and the +top and bottom edges also. Defaults to 1. +

+
+
mold
+

Set cell mold speed. If set, a dead cell will go from death_color to +mold_color with a step of mold. mold can have a +value from 0 to 255. +

+
+
life_color
+

Set the color of living (or new born) cells. +

+
+
death_color
+

Set the color of dead cells. If mold is set, this is the first color +used to represent a dead cell. +

+
+
mold_color
+

Set mold color, for definitely dead and moldy cells. +

+

For the syntax of these 3 color options, check the (ffmpeg-utils)"Color" section in the +ffmpeg-utils manual. +

+
+ + +

14.8.1 Examples

+ +
    +
  • Read a grid from pattern, and center it on a grid of size +300x300 pixels: +
    +
    life=f=pattern:s=300x300
+
    + +
  • Generate a random grid of size 200x200, with a fill ratio of 2/3: +
    +
    life=ratio=2/3:s=200x200
+
    + +
  • Specify a custom rule for evolving a randomly generated grid: +
    +
    life=rule=S14/B34
+
    + +
  • Full example with slow death effect (mold) using ffplay: +
    +
    ffplay -f lavfi life=s=300x200:mold=10:r=60:ratio=0.1:death_color=#C83232:life_color=#00ff00,scale=1200:800:flags=16
+
    +
+ + +

14.9 allrgb, allyuv, color, haldclutsrc, nullsrc, pal75bars, pal100bars, rgbtestsrc, smptebars, smptehdbars, testsrc, testsrc2, yuvtestsrc

+ +

The allrgb source returns frames of size 4096x4096 of all rgb colors. +

+

The allyuv source returns frames of size 4096x4096 of all yuv colors. +

+

The color source provides an uniformly colored input. +

+

The haldclutsrc source provides an identity Hald CLUT. See also +haldclut filter. +

+

The nullsrc source returns unprocessed video frames. It is +mainly useful to be employed in analysis / debugging tools, or as the +source for filters which ignore the input data. +

+

The pal75bars source generates a color bars pattern, based on +EBU PAL recommendations with 75% color levels. +

+

The pal100bars source generates a color bars pattern, based on +EBU PAL recommendations with 100% color levels. +

+

The rgbtestsrc source generates an RGB test pattern useful for +detecting RGB vs BGR issues. You should see a red, green and blue +stripe from top to bottom. +

+

The smptebars source generates a color bars pattern, based on +the SMPTE Engineering Guideline EG 1-1990. +

+

The smptehdbars source generates a color bars pattern, based on +the SMPTE RP 219-2002. +

+

The testsrc source generates a test video pattern, showing a +color pattern, a scrolling gradient and a timestamp. This is mainly +intended for testing purposes. +

+

The testsrc2 source is similar to testsrc, but supports more +pixel formats instead of just rgb24. This allows using it as an +input for other tests without requiring a format conversion. +

+

The yuvtestsrc source generates an YUV test pattern. You should +see a y, cb and cr stripe from top to bottom. +

+

The sources accept the following parameters: +

+
+
level
+

Specify the level of the Hald CLUT, only available in the haldclutsrc +source. A level of N generates a picture of N*N*N by N*N*N +pixels to be used as identity matrix for 3D lookup tables. Each component is +coded on a 1/(N*N) scale. +

+
+
color, c
+

Specify the color of the source, only available in the color +source. For the syntax of this option, check the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+
+
size, s
+

Specify the size of the sourced video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +The default value is 320x240. +

+

This option is not available with the allrgb, allyuv, and +haldclutsrc filters. +

+
+
rate, r
+

Specify the frame rate of the sourced video, as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a floating point +number or a valid video frame rate abbreviation. The default value is +"25". +

+
+
duration, d
+

Set the duration of the sourced video. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

If not specified, or the expressed duration is negative, the video is +supposed to be generated forever. +

+
+
sar
+

Set the sample aspect ratio of the sourced video. +

+
+
alpha
+

Specify the alpha (opacity) of the background, only available in the +testsrc2 source. The value must be between 0 (fully transparent) and +255 (fully opaque, the default). +

+
+
decimals, n
+

Set the number of decimals to show in the timestamp, only available in the +testsrc source. +

+

The displayed timestamp value will correspond to the original +timestamp value multiplied by the power of 10 of the specified +value. Default value is 0. +

+
+ + +

14.9.1 Examples

+ +
    +
  • Generate a video with a duration of 5.3 seconds, with size +176x144 and a frame rate of 10 frames per second: +
    +
    testsrc=duration=5.3:size=qcif:rate=10
+
    + +
  • The following graph description will generate a red source +with an opacity of 0.2, with size "qcif" and a frame rate of 10 +frames per second: +
    +
    color=c=red@0.2:s=qcif:r=10
+
    + +
  • If the input content is to be ignored, nullsrc can be used. The +following command generates noise in the luminance plane by employing +the geq filter: +
    +
    nullsrc=s=256x256, geq=random(1)*255:128:128
+
    +
+ + +

14.9.2 Commands

+ +

The color source supports the following commands: +

+
+
c, color
+

Set the color of the created image. Accepts the same syntax of the +corresponding color option. +

+
+ + +

14.10 openclsrc

+ +

Generate video using an OpenCL program. +

+
+
source
+

OpenCL program source file. +

+
+
kernel
+

Kernel name in program. +

+
+
size, s
+

Size of frames to generate. This must be set. +

+
+
format
+

Pixel format to use for the generated frames. This must be set. +

+
+
rate, r
+

Number of frames generated every second. Default value is ’25’. +

+
+
+ +

For details of how the program loading works, see the program_opencl +filter. +

+

Example programs: +

+
    +
  • Generate a colour ramp by setting pixel values from the position of the pixel +in the output image. (Note that this will work with all pixel formats, but +the generated output will not be the same.) +
    __kernel void ramp(__write_only image2d_t dst,
+                   unsigned int index)
+{
+    int2 loc = (int2)(get_global_id(0), get_global_id(1));
+
+    float4 val;
+    val.xy = val.zw = convert_float2(loc) / convert_float2(get_image_dim(dst));
+
+    write_imagef(dst, loc, val);
+}
+
    +
  • Generate a Sierpinski carpet pattern, panning by a single pixel each frame. +
    __kernel void sierpinski_carpet(__write_only image2d_t dst,
+                                unsigned int index)
+{
+    int2 loc = (int2)(get_global_id(0), get_global_id(1));
+
+    float4 value = 0.0f;
+    int x = loc.x + index;
+    int y = loc.y + index;
+    while (x > 0 || y > 0) {
+        if (x % 3 == 1 && y % 3 == 1) {
+            value = 1.0f;
+            break;
+        }
+        x /= 3;
+        y /= 3;
+    }
+
+    write_imagef(dst, loc, value);
+}
+
    +
+ + +

14.11 sierpinski

+ +

Generate a Sierpinski carpet/triangle fractal, and randomly pan around. +

+

This source accepts the following options: +

+
+
size, s
+

Set frame size. For the syntax of this option, check the (ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual. Default value is "640x480". +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
seed
+

Set seed which is used for random panning. +

+
+
jump
+

Set max jump for single pan destination. Allowed range is from 1 to 10000. +

+
+
type
+

Set fractal type, can be default carpet or triangle. +

+
+ + + +

15 Video Sinks

+ +

Below is a description of the currently available video sinks. +

+ +

15.1 buffersink

+ +

Buffer video frames, and make them available to the end of the filter +graph. +

+

This sink is mainly intended for programmatic use, in particular +through the interface defined in libavfilter/buffersink.h +or the options system. +

+

It accepts a pointer to an AVBufferSinkContext structure, which +defines the incoming buffers’ formats, to be passed as the opaque +parameter to avfilter_init_filter for initialization. +

+ +

15.2 nullsink

+ +

Null video sink: do absolutely nothing with the input video. It is +mainly useful as a template and for use in analysis / debugging +tools. +

+ + +

16 Multimedia Filters

+ +

Below is a description of the currently available multimedia filters. +

+ +

16.1 abitscope

+ +

Convert input audio to a video output, displaying the audio bit scope. +

+

The filter accepts the following options: +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 1024x256. +

+
+
colors
+

Specify list of colors separated by space or by ’|’ which will be used to +draw channels. Unrecognized or missing colors will be replaced +by white color. +

+
+ + +

16.2 adrawgraph

+

Draw a graph using input audio metadata. +

+

See drawgraph +

+ +

16.3 agraphmonitor

+ +

See graphmonitor. +

+ +

16.4 ahistogram

+ +

Convert input audio to a video output, displaying the volume histogram. +

+

The filter accepts the following options: +

+
+
dmode
+

Specify how histogram is calculated. +

+

It accepts the following values: +

+
‘single’
+

Use single histogram for all channels. +

+
‘separate’
+

Use separate histogram for each channel. +

+
+

Default is single. +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is hd720. +

+
+
scale
+

Set display scale. +

+

It accepts the following values: +

+
‘log’
+

logarithmic +

+
‘sqrt’
+

square root +

+
‘cbrt’
+

cubic root +

+
‘lin’
+

linear +

+
‘rlog’
+

reverse logarithmic +

+
+

Default is log. +

+
+
ascale
+

Set amplitude scale. +

+

It accepts the following values: +

+
‘log’
+

logarithmic +

+
‘lin’
+

linear +

+
+

Default is log. +

+
+
acount
+

Set how much frames to accumulate in histogram. +Default is 1. Setting this to -1 accumulates all frames. +

+
+
rheight
+

Set histogram ratio of window height. +

+
+
slide
+

Set sonogram sliding. +

+

It accepts the following values: +

+
‘replace’
+

replace old rows with new ones. +

+
‘scroll’
+

scroll from top to bottom. +

+
+

Default is replace. +

+
+ + +

16.5 aphasemeter

+ +

Measures phase of input audio, which is exported as metadata lavfi.aphasemeter.phase, +representing mean phase of current audio frame. A video output can also be produced and is +enabled by default. The audio is passed through as first output. +

+

Audio will be rematrixed to stereo if it has a different channel layout. Phase value is in +range [-1, 1] where -1 means left and right channels are completely out of phase +and 1 means channels are in phase. +

+

The filter accepts the following options, all related to its video output: +

+
+
rate, r
+

Set the output frame rate. Default value is 25. +

+
+
size, s
+

Set the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 800x400. +

+
+
rc
+
gc
+
bc
+

Specify the red, green, blue contrast. Default values are 2, +7 and 1. +Allowed range is [0, 255]. +

+
+
mpc
+

Set color which will be used for drawing median phase. If color is +none which is default, no median phase value will be drawn. +

+
+
video
+

Enable video output. Default is enabled. +

+
+ + +

16.6 avectorscope

+ +

Convert input audio to a video output, representing the audio vector +scope. +

+

The filter is used to measure the difference between channels of stereo +audio stream. A monaural signal, consisting of identical left and right +signal, results in straight vertical line. Any stereo separation is visible +as a deviation from this line, creating a Lissajous figure. +If the straight (or deviation from it) but horizontal line appears this +indicates that the left and right channels are out of phase. +

+

The filter accepts the following options: +

+
+
mode, m
+

Set the vectorscope mode. +

+

Available values are: +

+
‘lissajous’
+

Lissajous rotated by 45 degrees. +

+
+
‘lissajous_xy’
+

Same as above but not rotated. +

+
+
‘polar’
+

Shape resembling half of circle. +

+
+ +

Default value is ‘lissajous’. +

+
+
size, s
+

Set the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 400x400. +

+
+
rate, r
+

Set the output frame rate. Default value is 25. +

+
+
rc
+
gc
+
bc
+
ac
+

Specify the red, green, blue and alpha contrast. Default values are 40, +160, 80 and 255. +Allowed range is [0, 255]. +

+
+
rf
+
gf
+
bf
+
af
+

Specify the red, green, blue and alpha fade. Default values are 15, +10, 5 and 5. +Allowed range is [0, 255]. +

+
+
zoom
+

Set the zoom factor. Default value is 1. Allowed range is [0, 10]. +Values lower than 1 will auto adjust zoom factor to maximal possible value. +

+
+
draw
+

Set the vectorscope drawing mode. +

+

Available values are: +

+
‘dot’
+

Draw dot for each sample. +

+
+
‘line’
+

Draw line between previous and current sample. +

+
+ +

Default value is ‘dot’. +

+
+
scale
+

Specify amplitude scale of audio samples. +

+

Available values are: +

+
‘lin’
+

Linear. +

+
+
‘sqrt’
+

Square root. +

+
+
‘cbrt’
+

Cubic root. +

+
+
‘log’
+

Logarithmic. +

+
+ +
+
swap
+

Swap left channel axis with right channel axis. +

+
+
mirror
+

Mirror axis. +

+
+
‘none’
+

No mirror. +

+
+
‘x’
+

Mirror only x axis. +

+
+
‘y’
+

Mirror only y axis. +

+
+
‘xy’
+

Mirror both axis. +

+
+ +
+
+ + +

16.6.1 Examples

+ +
    +
  • Complete example using ffplay: +
    +
    ffplay -f lavfi 'amovie=input.mp3, asplit [a][out1];
+             [a] avectorscope=zoom=1.3:rc=2:gc=200:bc=10:rf=1:gf=8:bf=7 [out0]'
+
    +
+ + +

16.7 bench, abench

+ +

Benchmark part of a filtergraph. +

+

The filter accepts the following options: +

+
+
action
+

Start or stop a timer. +

+

Available values are: +

+
‘start’
+

Get the current time, set it as frame metadata (using the key +lavfi.bench.start_time), and forward the frame to the next filter. +

+
+
‘stop’
+

Get the current time and fetch the lavfi.bench.start_time metadata from +the input frame metadata to get the time difference. Time difference, average, +maximum and minimum time (respectively t, avg, max and +min) are then printed. The timestamps are expressed in seconds. +

+
+
+
+ + +

16.7.1 Examples

+ +
    +
  • Benchmark selectivecolor filter: +
    +
    bench=start,selectivecolor=reds=-.2 .12 -.49,bench=stop
+
    +
+ + +

16.8 concat

+ +

Concatenate audio and video streams, joining them together one after the +other. +

+

The filter works on segments of synchronized video and audio streams. All +segments must have the same number of streams of each type, and that will +also be the number of streams at output. +

+

The filter accepts the following options: +

+
+
n
+

Set the number of segments. Default is 2. +

+
+
v
+

Set the number of output video streams, that is also the number of video +streams in each segment. Default is 1. +

+
+
a
+

Set the number of output audio streams, that is also the number of audio +streams in each segment. Default is 0. +

+
+
unsafe
+

Activate unsafe mode: do not fail if segments have a different format. +

+
+
+ +

The filter has v+a outputs: first v video outputs, then +a audio outputs. +

+

There are nx(v+a) inputs: first the inputs for the first +segment, in the same order as the outputs, then the inputs for the second +segment, etc. +

+

Related streams do not always have exactly the same duration, for various +reasons including codec frame size or sloppy authoring. For that reason, +related synchronized streams (e.g. a video and its audio track) should be +concatenated at once. The concat filter will use the duration of the longest +stream in each segment (except the last one), and if necessary pad shorter +audio streams with silence. +

+

For this filter to work correctly, all segments must start at timestamp 0. +

+

All corresponding streams must have the same parameters in all segments; the +filtering system will automatically select a common pixel format for video +streams, and a common sample format, sample rate and channel layout for +audio streams, but other settings, such as resolution, must be converted +explicitly by the user. +

+

Different frame rates are acceptable but will result in variable frame rate +at output; be sure to configure the output file to handle it. +

+ +

16.8.1 Examples

+ +
    +
  • Concatenate an opening, an episode and an ending, all in bilingual version +(video in stream 0, audio in streams 1 and 2): +
    +
    ffmpeg -i opening.mkv -i episode.mkv -i ending.mkv -filter_complex \
+  '[0:0] [0:1] [0:2] [1:0] [1:1] [1:2] [2:0] [2:1] [2:2]
+   concat=n=3:v=1:a=2 [v] [a1] [a2]' \
+  -map '[v]' -map '[a1]' -map '[a2]' output.mkv
+
    + +
  • Concatenate two parts, handling audio and video separately, using the +(a)movie sources, and adjusting the resolution: +
    +
    movie=part1.mp4, scale=512:288 [v1] ; amovie=part1.mp4 [a1] ;
+movie=part2.mp4, scale=512:288 [v2] ; amovie=part2.mp4 [a2] ;
+[v1] [v2] concat [outv] ; [a1] [a2] concat=v=0:a=1 [outa]
+
    +

    Note that a desync will happen at the stitch if the audio and video streams +do not have exactly the same duration in the first file. +

    +
+ + +

16.8.2 Commands

+ +

This filter supports the following commands: +

+
next
+

Close the current segment and step to the next one +

+
+ + +

16.9 ebur128

+ +

EBU R128 scanner filter. This filter takes an audio stream and analyzes its loudness +level. By default, it logs a message at a frequency of 10Hz with the +Momentary loudness (identified by M), Short-term loudness (S), +Integrated loudness (I) and Loudness Range (LRA). +

+

The filter can only analyze streams which have a sampling rate of 48000 Hz and whose +sample format is double-precision floating point. The input stream will be converted to +this specification, if needed. Users may need to insert aformat and/or aresample filters +after this filter to obtain the original parameters. +

+

The filter also has a video output (see the video option) with a real +time graph to observe the loudness evolution. The graphic contains the logged +message mentioned above, so it is not printed anymore when this option is set, +unless the verbose logging is set. The main graphing area contains the +short-term loudness (3 seconds of analysis), and the gauge on the right is for +the momentary loudness (400 milliseconds), but can optionally be configured +to instead display short-term loudness (see gauge). +

+

The green area marks a +/- 1LU target range around the target loudness +(-23LUFS by default, unless modified through target). +

+

More information about the Loudness Recommendation EBU R128 on +http://tech.ebu.ch/loudness. +

+

The filter accepts the following options: +

+
+
video
+

Activate the video output. The audio stream is passed unchanged whether this +option is set or no. The video stream will be the first output stream if +activated. Default is 0. +

+
+
size
+

Set the video size. This option is for video only. For the syntax of this +option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default and minimum resolution is 640x480. +

+
+
meter
+

Set the EBU scale meter. Default is 9. Common values are 9 and +18, respectively for EBU scale meter +9 and EBU scale meter +18. Any +other integer value between this range is allowed. +

+
+
metadata
+

Set metadata injection. If set to 1, the audio input will be segmented +into 100ms output frames, each of them containing various loudness information +in metadata. All the metadata keys are prefixed with lavfi.r128.. +

+

Default is 0. +

+
+
framelog
+

Force the frame logging level. +

+

Available values are: +

+
‘info’
+

information logging level +

+
‘verbose’
+

verbose logging level +

+
+ +

By default, the logging level is set to info. If the video or +the metadata options are set, it switches to verbose. +

+
+
peak
+

Set peak mode(s). +

+

Available modes can be cumulated (the option is a flag type). Possible +values are: +

+
‘none’
+

Disable any peak mode (default). +

+
‘sample’
+

Enable sample-peak mode. +

+

Simple peak mode looking for the higher sample value. It logs a message +for sample-peak (identified by SPK). +

+
‘true’
+

Enable true-peak mode. +

+

If enabled, the peak lookup is done on an over-sampled version of the input +stream for better peak accuracy. It logs a message for true-peak. +(identified by TPK) and true-peak per frame (identified by FTPK). +This mode requires a build with libswresample. +

+
+ +
+
dualmono
+

Treat mono input files as "dual mono". If a mono file is intended for playback +on a stereo system, its EBU R128 measurement will be perceptually incorrect. +If set to true, this option will compensate for this effect. +Multi-channel input files are not affected by this option. +

+
+
panlaw
+

Set a specific pan law to be used for the measurement of dual mono files. +This parameter is optional, and has a default value of -3.01dB. +

+
+
target
+

Set a specific target level (in LUFS) used as relative zero in the visualization. +This parameter is optional and has a default value of -23LUFS as specified +by EBU R128. However, material published online may prefer a level of -16LUFS +(e.g. for use with podcasts or video platforms). +

+
+
gauge
+

Set the value displayed by the gauge. Valid values are momentary and s +shortterm. By default the momentary value will be used, but in certain +scenarios it may be more useful to observe the short term value instead (e.g. +live mixing). +

+
+
scale
+

Sets the display scale for the loudness. Valid parameters are absolute +(in LUFS) or relative (LU) relative to the target. This only affects the +video output, not the summary or continuous log output. +

+
+ + +

16.9.1 Examples

+ +
    +
  • Real-time graph using ffplay, with a EBU scale meter +18: +
    +
    ffplay -f lavfi -i "amovie=input.mp3,ebur128=video=1:meter=18 [out0][out1]"
+
    + +
  • Run an analysis with ffmpeg: +
    +
    ffmpeg -nostats -i input.mp3 -filter_complex ebur128 -f null -
+
    +
+ + +

16.10 interleave, ainterleave

+ +

Temporally interleave frames from several inputs. +

+

interleave works with video inputs, ainterleave with audio. +

+

These filters read frames from several inputs and send the oldest +queued frame to the output. +

+

Input streams must have well defined, monotonically increasing frame +timestamp values. +

+

In order to submit one frame to output, these filters need to enqueue +at least one frame for each input, so they cannot work in case one +input is not yet terminated and will not receive incoming frames. +

+

For example consider the case when one input is a select filter +which always drops input frames. The interleave filter will keep +reading from that input, but it will never be able to send new frames +to output until the input sends an end-of-stream signal. +

+

Also, depending on inputs synchronization, the filters will drop +frames in case one input receives more frames than the other ones, and +the queue is already filled. +

+

These filters accept the following options: +

+
+
nb_inputs, n
+

Set the number of different inputs, it is 2 by default. +

+
+
duration
+

How to determine the end-of-stream. +

+
+
longest
+

The duration of the longest input. (default) +

+
+
shortest
+

The duration of the shortest input. +

+
+
first
+

The duration of the first input. +

+
+ +
+
+ + +

16.10.1 Examples

+ +
    +
  • Interleave frames belonging to different streams using ffmpeg: +
    +
    ffmpeg -i bambi.avi -i pr0n.mkv -filter_complex "[0:v][1:v] interleave" out.avi
+
    + +
  • Add flickering blur effect: +
    +
    select='if(gt(random(0), 0.2), 1, 2)':n=2 [tmp], boxblur=2:2, [tmp] interleave
+
    +
+ + +

16.11 metadata, ametadata

+ +

Manipulate frame metadata. +

+

This filter accepts the following options: +

+
+
mode
+

Set mode of operation of the filter. +

+

Can be one of the following: +

+
+
‘select’
+

If both value and key is set, select frames +which have such metadata. If only key is set, select +every frame that has such key in metadata. +

+
+
‘add’
+

Add new metadata key and value. If key is already available +do nothing. +

+
+
‘modify’
+

Modify value of already present key. +

+
+
‘delete’
+

If value is set, delete only keys that have such value. +Otherwise, delete key. If key is not set, delete all metadata values in +the frame. +

+
+
‘print’
+

Print key and its value if metadata was found. If key is not set print all +metadata values available in frame. +

+
+ +
+
key
+

Set key used with all modes. Must be set for all modes except print and delete. +

+
+
value
+

Set metadata value which will be used. This option is mandatory for +modify and add mode. +

+
+
function
+

Which function to use when comparing metadata value and value. +

+

Can be one of following: +

+
+
‘same_str’
+

Values are interpreted as strings, returns true if metadata value is same as value. +

+
+
‘starts_with’
+

Values are interpreted as strings, returns true if metadata value starts with +the value option string. +

+
+
‘less’
+

Values are interpreted as floats, returns true if metadata value is less than value. +

+
+
‘equal’
+

Values are interpreted as floats, returns true if value is equal with metadata value. +

+
+
‘greater’
+

Values are interpreted as floats, returns true if metadata value is greater than value. +

+
+
‘expr’
+

Values are interpreted as floats, returns true if expression from option expr +evaluates to true. +

+
+
‘ends_with’
+

Values are interpreted as strings, returns true if metadata value ends with +the value option string. +

+
+ +
+
expr
+

Set expression which is used when function is set to expr. +The expression is evaluated through the eval API and can contain the following +constants: +

+
+
VALUE1
+

Float representation of value from metadata key. +

+
+
VALUE2
+

Float representation of value as supplied by user in value option. +

+
+ +
+
file
+

If specified in print mode, output is written to the named file. Instead of +plain filename any writable url can be specified. Filename “-” is a shorthand +for standard output. If file option is not set, output is written to the log +with AV_LOG_INFO loglevel. +

+
+
direct
+

Reduces buffering in print mode when output is written to a URL set using file. +

+
+
+ + +

16.11.1 Examples

+ +
    +
  • Print all metadata values for frames with key lavfi.signalstats.YDIF with values +between 0 and 1. +
    +
    signalstats,metadata=print:key=lavfi.signalstats.YDIF:value=0:function=expr:expr='between(VALUE1,0,1)'
+
    +
  • Print silencedetect output to file metadata.txt. +
    +
    silencedetect,ametadata=mode=print:file=metadata.txt
+
    +
  • Direct all metadata to a pipe with file descriptor 4. +
    +
    metadata=mode=print:file='pipe\:4'
+
    +
+ + +

16.12 perms, aperms

+ +

Set read/write permissions for the output frames. +

+

These filters are mainly aimed at developers to test direct path in the +following filter in the filtergraph. +

+

The filters accept the following options: +

+
+
mode
+

Select the permissions mode. +

+

It accepts the following values: +

+
‘none’
+

Do nothing. This is the default. +

+
‘ro’
+

Set all the output frames read-only. +

+
‘rw’
+

Set all the output frames directly writable. +

+
‘toggle’
+

Make the frame read-only if writable, and writable if read-only. +

+
‘random’
+

Set each output frame read-only or writable randomly. +

+
+ +
+
seed
+

Set the seed for the random mode, must be an integer included between +0 and UINT32_MAX. If not specified, or if explicitly set to +-1, the filter will try to use a good random seed on a best effort +basis. +

+
+ +

Note: in case of auto-inserted filter between the permission filter and the +following one, the permission might not be received as expected in that +following filter. Inserting a format or aformat filter before the +perms/aperms filter can avoid this problem. +

+ +

16.13 realtime, arealtime

+ +

Slow down filtering to match real time approximately. +

+

These filters will pause the filtering for a variable amount of time to +match the output rate with the input timestamps. +They are similar to the re option to ffmpeg. +

+

They accept the following options: +

+
+
limit
+

Time limit for the pauses. Any pause longer than that will be considered +a timestamp discontinuity and reset the timer. Default is 2 seconds. +

+
speed
+

Speed factor for processing. The value must be a float larger than zero. +Values larger than 1.0 will result in faster than realtime processing, +smaller will slow processing down. The limit is automatically adapted +accordingly. Default is 1.0. +

+

A processing speed faster than what is possible without these filters cannot +be achieved. +

+
+ + +

16.14 select, aselect

+ +

Select frames to pass in output. +

+

This filter accepts the following options: +

+
+
expr, e
+

Set expression, which is evaluated for each input frame. +

+

If the expression is evaluated to zero, the frame is discarded. +

+

If the evaluation result is negative or NaN, the frame is sent to the +first output; otherwise it is sent to the output with index +ceil(val)-1, assuming that the input index starts from 0. +

+

For example a value of 1.2 corresponds to the output with index +ceil(1.2)-1 = 2-1 = 1, that is the second output. +

+
+
outputs, n
+

Set the number of outputs. The output to which to send the selected +frame is based on the result of the evaluation. Default value is 1. +

+
+ +

The expression can contain the following constants: +

+
+
n
+

The (sequential) number of the filtered frame, starting from 0. +

+
+
selected_n
+

The (sequential) number of the selected frame, starting from 0. +

+
+
prev_selected_n
+

The sequential number of the last selected frame. It’s NAN if undefined. +

+
+
TB
+

The timebase of the input timestamps. +

+
+
pts
+

The PTS (Presentation TimeStamp) of the filtered video frame, +expressed in TB units. It’s NAN if undefined. +

+
+
t
+

The PTS of the filtered video frame, +expressed in seconds. It’s NAN if undefined. +

+
+
prev_pts
+

The PTS of the previously filtered video frame. It’s NAN if undefined. +

+
+
prev_selected_pts
+

The PTS of the last previously filtered video frame. It’s NAN if undefined. +

+
+
prev_selected_t
+

The PTS of the last previously selected video frame, expressed in seconds. It’s NAN if undefined. +

+
+
start_pts
+

The PTS of the first video frame in the video. It’s NAN if undefined. +

+
+
start_t
+

The time of the first video frame in the video. It’s NAN if undefined. +

+
+
pict_type (video only)
+

The type of the filtered frame. It can assume one of the following +values: +

+
I
+
P
+
B
+
S
+
SI
+
SP
+
BI
+
+ +
+
interlace_type (video only)
+

The frame interlace type. It can assume one of the following values: +

+
PROGRESSIVE
+

The frame is progressive (not interlaced). +

+
TOPFIRST
+

The frame is top-field-first. +

+
BOTTOMFIRST
+

The frame is bottom-field-first. +

+
+ +
+
consumed_sample_n (audio only)
+

the number of selected samples before the current frame +

+
+
samples_n (audio only)
+

the number of samples in the current frame +

+
+
sample_rate (audio only)
+

the input sample rate +

+
+
key
+

This is 1 if the filtered frame is a key-frame, 0 otherwise. +

+
+
pos
+

the position in the file of the filtered frame, -1 if the information +is not available (e.g. for synthetic video) +

+
+
scene (video only)
+

value between 0 and 1 to indicate a new scene; a low value reflects a low +probability for the current frame to introduce a new scene, while a higher +value means the current frame is more likely to be one (see the example below) +

+
+
concatdec_select
+

The concat demuxer can select only part of a concat input file by setting an +inpoint and an outpoint, but the output packets may not be entirely contained +in the selected interval. By using this variable, it is possible to skip frames +generated by the concat demuxer which are not exactly contained in the selected +interval. +

+

This works by comparing the frame pts against the lavf.concat.start_time +and the lavf.concat.duration packet metadata values which are also +present in the decoded frames. +

+

The concatdec_select variable is -1 if the frame pts is at least +start_time and either the duration metadata is missing or the frame pts is less +than start_time + duration, 0 otherwise, and NaN if the start_time metadata is +missing. +

+

That basically means that an input frame is selected if its pts is within the +interval set by the concat demuxer. +

+
+
+ +

The default value of the select expression is "1". +

+ +

16.14.1 Examples

+ +
    +
  • Select all frames in input: +
    +
    select
+
    + +

    The example above is the same as: +

    +
    select=1
+
    + +
  • Skip all frames: +
    +
    select=0
+
    + +
  • Select only I-frames: +
    +
    select='eq(pict_type\,I)'
+
    + +
  • Select one frame every 100: +
    +
    select='not(mod(n\,100))'
+
    + +
  • Select only frames contained in the 10-20 time interval: +
    +
    select=between(t\,10\,20)
+
    + +
  • Select only I-frames contained in the 10-20 time interval: +
    +
    select=between(t\,10\,20)*eq(pict_type\,I)
+
    + +
  • Select frames with a minimum distance of 10 seconds: +
    +
    select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
+
    + +
  • Use aselect to select only audio frames with samples number > 100: +
    +
    aselect='gt(samples_n\,100)'
+
    + +
  • Create a mosaic of the first scenes: +
    +
    ffmpeg -i video.avi -vf select='gt(scene\,0.4)',scale=160:120,tile -frames:v 1 preview.png
+
    + +

    Comparing scene against a value between 0.3 and 0.5 is generally a sane +choice. +

    +
  • Send even and odd frames to separate outputs, and compose them: +
    +
    select=n=2:e='mod(n, 2)+1' [odd][even]; [odd] pad=h=2*ih [tmp]; [tmp][even] overlay=y=h
+
    + +
  • Select useful frames from an ffconcat file which is using inpoints and +outpoints but where the source files are not intra frame only. +
    +
    ffmpeg -copyts -vsync 0 -segment_time_metadata 1 -i input.ffconcat -vf select=concatdec_select -af aselect=concatdec_select output.avi
+
    +
+ + +

16.15 sendcmd, asendcmd

+ +

Send commands to filters in the filtergraph. +

+

These filters read commands to be sent to other filters in the +filtergraph. +

+

sendcmd must be inserted between two video filters, +asendcmd must be inserted between two audio filters, but apart +from that they act the same way. +

+

The specification of commands can be provided in the filter arguments +with the commands option, or in a file specified by the +filename option. +

+

These filters accept the following options: +

+
commands, c
+

Set the commands to be read and sent to the other filters. +

+
filename, f
+

Set the filename of the commands to be read and sent to the other +filters. +

+
+ + +

16.15.1 Commands syntax

+ +

A commands description consists of a sequence of interval +specifications, comprising a list of commands to be executed when a +particular event related to that interval occurs. The occurring event +is typically the current frame time entering or leaving a given time +interval. +

+

An interval is specified by the following syntax: +

+
START[-END] COMMANDS;
+
+ +

The time interval is specified by the START and END times. +END is optional and defaults to the maximum time. +

+

The current frame time is considered within the specified interval if +it is included in the interval [START, END), that is when +the time is greater or equal to START and is lesser than +END. +

+

COMMANDS consists of a sequence of one or more command +specifications, separated by ",", relating to that interval. The +syntax of a command specification is given by: +

+
[FLAGS] TARGET COMMAND ARG
+
+ +

FLAGS is optional and specifies the type of events relating to +the time interval which enable sending the specified command, and must +be a non-null sequence of identifier flags separated by "+" or "|" and +enclosed between "[" and "]". +

+

The following flags are recognized: +

+
enter
+

The command is sent when the current frame timestamp enters the +specified interval. In other words, the command is sent when the +previous frame timestamp was not in the given interval, and the +current is. +

+
+
leave
+

The command is sent when the current frame timestamp leaves the +specified interval. In other words, the command is sent when the +previous frame timestamp was in the given interval, and the +current is not. +

+
+
expr
+

The command ARG is interpreted as expression and result of +expression is passed as ARG. +

+

The expression is evaluated through the eval API and can contain the following +constants: +

+
+
POS
+

Original position in the file of the frame, or undefined if undefined +for the current frame. +

+
+
PTS
+

The presentation timestamp in input. +

+
+
N
+

The count of the input frame for video or audio, starting from 0. +

+
+
T
+

The time in seconds of the current frame. +

+
+
TS
+

The start time in seconds of the current command interval. +

+
+
TE
+

The end time in seconds of the current command interval. +

+
+
TI
+

The interpolated time of the current command interval, TI = (T - TS) / (TE - TS). +

+
+ +
+
+ +

If FLAGS is not specified, a default value of [enter] is +assumed. +

+

TARGET specifies the target of the command, usually the name of +the filter class or a specific filter instance name. +

+

COMMAND specifies the name of the command for the target filter. +

+

ARG is optional and specifies the optional list of argument for +the given COMMAND. +

+

Between one interval specification and another, whitespaces, or +sequences of characters starting with # until the end of line, +are ignored and can be used to annotate comments. +

+

A simplified BNF description of the commands specification syntax +follows: +

+
COMMAND_FLAG  ::= "enter" | "leave"
+COMMAND_FLAGS ::= COMMAND_FLAG [(+|"|")COMMAND_FLAG]
+COMMAND       ::= ["[" COMMAND_FLAGS "]"] TARGET COMMAND [ARG]
+COMMANDS      ::= COMMAND [,COMMANDS]
+INTERVAL      ::= START[-END] COMMANDS
+INTERVALS     ::= INTERVAL[;INTERVALS]
+
+ + +

16.15.2 Examples

+ +
    +
  • Specify audio tempo change at second 4: +
    +
    asendcmd=c='4.0 atempo tempo 1.5',atempo
+
    + +
  • Target a specific filter instance: +
    +
    asendcmd=c='4.0 atempo@my tempo 1.5',atempo@my
+
    + +
  • Specify a list of drawtext and hue commands in a file. +
    +
    # show text in the interval 5-10
+5.0-10.0 [enter] drawtext reinit 'fontfile=FreeSerif.ttf:text=hello world',
+         [leave] drawtext reinit 'fontfile=FreeSerif.ttf:text=';
+
+# desaturate the image in the interval 15-20
+15.0-20.0 [enter] hue s 0,
+          [enter] drawtext reinit 'fontfile=FreeSerif.ttf:text=nocolor',
+          [leave] hue s 1,
+          [leave] drawtext reinit 'fontfile=FreeSerif.ttf:text=color';
+
+# apply an exponential saturation fade-out effect, starting from time 25
+25 [enter] hue s exp(25-t)
+
    + +

    A filtergraph allowing to read and process the above command list +stored in a file test.cmd, can be specified with: +

    +
    sendcmd=f=test.cmd,drawtext=fontfile=FreeSerif.ttf:text='',hue
+
    +
+ + +

16.16 setpts, asetpts

+ +

Change the PTS (presentation timestamp) of the input frames. +

+

setpts works on video frames, asetpts on audio frames. +

+

This filter accepts the following options: +

+
+
expr
+

The expression which is evaluated for each frame to construct its timestamp. +

+
+
+ +

The expression is evaluated through the eval API and can contain the following +constants: +

+
+
FRAME_RATE, FR
+

frame rate, only defined for constant frame-rate video +

+
+
PTS
+

The presentation timestamp in input +

+
+
N
+

The count of the input frame for video or the number of consumed samples, +not including the current frame for audio, starting from 0. +

+
+
NB_CONSUMED_SAMPLES
+

The number of consumed samples, not including the current frame (only +audio) +

+
+
NB_SAMPLES, S
+

The number of samples in the current frame (only audio) +

+
+
SAMPLE_RATE, SR
+

The audio sample rate. +

+
+
STARTPTS
+

The PTS of the first frame. +

+
+
STARTT
+

the time in seconds of the first frame +

+
+
INTERLACED
+

State whether the current frame is interlaced. +

+
+
T
+

the time in seconds of the current frame +

+
+
POS
+

original position in the file of the frame, or undefined if undefined +for the current frame +

+
+
PREV_INPTS
+

The previous input PTS. +

+
+
PREV_INT
+

previous input time in seconds +

+
+
PREV_OUTPTS
+

The previous output PTS. +

+
+
PREV_OUTT
+

previous output time in seconds +

+
+
RTCTIME
+

The wallclock (RTC) time in microseconds. This is deprecated, use time(0) +instead. +

+
+
RTCSTART
+

The wallclock (RTC) time at the start of the movie in microseconds. +

+
+
TB
+

The timebase of the input timestamps. +

+
+
+ + +

16.16.1 Examples

+ +
    +
  • Start counting PTS from zero +
    +
    setpts=PTS-STARTPTS
+
    + +
  • Apply fast motion effect: +
    +
    setpts=0.5*PTS
+
    + +
  • Apply slow motion effect: +
    +
    setpts=2.0*PTS
+
    + +
  • Set fixed rate of 25 frames per second: +
    +
    setpts=N/(25*TB)
+
    + +
  • Set fixed rate 25 fps with some jitter: +
    +
    setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
+
    + +
  • Apply an offset of 10 seconds to the input PTS: +
    +
    setpts=PTS+10/TB
+
    + +
  • Generate timestamps from a "live source" and rebase onto the current timebase: +
    +
    setpts='(RTCTIME - RTCSTART) / (TB * 1000000)'
+
    + +
  • Generate timestamps by counting samples: +
    +
    asetpts=N/SR/TB
+
    + +
+ + +

16.17 setrange

+ +

Force color range for the output video frame. +

+

The setrange filter marks the color range property for the +output frames. It does not change the input frame, but only sets the +corresponding property, which affects how the frame is treated by +following filters. +

+

The filter accepts the following options: +

+
+
range
+

Available values are: +

+
+
‘auto’
+

Keep the same color range property. +

+
+
‘unspecified, unknown’
+

Set the color range as unspecified. +

+
+
‘limited, tv, mpeg’
+

Set the color range as limited. +

+
+
‘full, pc, jpeg’
+

Set the color range as full. +

+
+
+
+ + +

16.18 settb, asettb

+ +

Set the timebase to use for the output frames timestamps. +It is mainly useful for testing timebase configuration. +

+

It accepts the following parameters: +

+
+
expr, tb
+

The expression which is evaluated into the output timebase. +

+
+
+ +

The value for tb is an arithmetic expression representing a +rational. The expression can contain the constants "AVTB" (the default +timebase), "intb" (the input timebase) and "sr" (the sample rate, +audio only). Default value is "intb". +

+ +

16.18.1 Examples

+ +
    +
  • Set the timebase to 1/25: +
    +
    settb=expr=1/25
+
    + +
  • Set the timebase to 1/10: +
    +
    settb=expr=0.1
+
    + +
  • Set the timebase to 1001/1000: +
    +
    settb=1+0.001
+
    + +
  • Set the timebase to 2*intb: +
    +
    settb=2*intb
+
    + +
  • Set the default timebase value: +
    +
    settb=AVTB
+
    +
+ + +

16.19 showcqt

+

Convert input audio to a video output representing frequency spectrum +logarithmically using Brown-Puckette constant Q transform algorithm with +direct frequency domain coefficient calculation (but the transform itself +is not really constant Q, instead the Q factor is actually variable/clamped), +with musical tone scale, from E0 to D#10. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. It must be even. For the syntax of this option, +check the (ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 1920x1080. +

+
+
fps, rate, r
+

Set the output frame rate. Default value is 25. +

+
+
bar_h
+

Set the bargraph height. It must be even. Default value is -1 which +computes the bargraph height automatically. +

+
+
axis_h
+

Set the axis height. It must be even. Default value is -1 which computes +the axis height automatically. +

+
+
sono_h
+

Set the sonogram height. It must be even. Default value is -1 which +computes the sonogram height automatically. +

+
+
fullhd
+

Set the fullhd resolution. This option is deprecated, use size, s +instead. Default value is 1. +

+
+
sono_v, volume
+

Specify the sonogram volume expression. It can contain variables: +

+
bar_v
+

the bar_v evaluated expression +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option +

+
+

and functions: +

+
a_weighting(f)
+

A-weighting of equal loudness +

+
b_weighting(f)
+

B-weighting of equal loudness +

+
c_weighting(f)
+

C-weighting of equal loudness. +

+
+

Default value is 16. +

+
+
bar_v, volume2
+

Specify the bargraph volume expression. It can contain variables: +

+
sono_v
+

the sono_v evaluated expression +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option +

+
+

and functions: +

+
a_weighting(f)
+

A-weighting of equal loudness +

+
b_weighting(f)
+

B-weighting of equal loudness +

+
c_weighting(f)
+

C-weighting of equal loudness. +

+
+

Default value is sono_v. +

+
+
sono_g, gamma
+

Specify the sonogram gamma. Lower gamma makes the spectrum more contrast, +higher gamma makes the spectrum having more range. Default value is 3. +Acceptable range is [1, 7]. +

+
+
bar_g, gamma2
+

Specify the bargraph gamma. Default value is 1. Acceptable range is +[1, 7]. +

+
+
bar_t
+

Specify the bargraph transparency level. Lower value makes the bargraph sharper. +Default value is 1. Acceptable range is [0, 1]. +

+
+
timeclamp, tc
+

Specify the transform timeclamp. At low frequency, there is trade-off between +accuracy in time domain and frequency domain. If timeclamp is lower, +event in time domain is represented more accurately (such as fast bass drum), +otherwise event in frequency domain is represented more accurately +(such as bass guitar). Acceptable range is [0.002, 1]. Default value is 0.17. +

+
+
attack
+

Set attack time in seconds. The default is 0 (disabled). Otherwise, it +limits future samples by applying asymmetric windowing in time domain, useful +when low latency is required. Accepted range is [0, 1]. +

+
+
basefreq
+

Specify the transform base frequency. Default value is 20.01523126408007475, +which is frequency 50 cents below E0. Acceptable range is [10, 100000]. +

+
+
endfreq
+

Specify the transform end frequency. Default value is 20495.59681441799654, +which is frequency 50 cents above D#10. Acceptable range is [10, 100000]. +

+
+
coeffclamp
+

This option is deprecated and ignored. +

+
+
tlength
+

Specify the transform length in time domain. Use this option to control accuracy +trade-off between time domain and frequency domain at every frequency sample. +It can contain variables: +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option. +

+
+

Default value is 384*tc/(384+tc*f). +

+
+
count
+

Specify the transform count for every video frame. Default value is 6. +Acceptable range is [1, 30]. +

+
+
fcount
+

Specify the transform count for every single pixel. Default value is 0, +which makes it computed automatically. Acceptable range is [0, 10]. +

+
+
fontfile
+

Specify font file for use with freetype to draw the axis. If not specified, +use embedded font. Note that drawing with font file or embedded font is not +implemented with custom basefreq and endfreq, use axisfile +option instead. +

+
+
font
+

Specify fontconfig pattern. This has lower priority than fontfile. The +: in the pattern may be replaced by | to avoid unnecessary +escaping. +

+
+
fontcolor
+

Specify font color expression. This is arithmetic expression that should return +integer value 0xRRGGBB. It can contain variables: +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option +

+
+

and functions: +

+
midi(f)
+

midi number of frequency f, some midi numbers: E0(16), C1(24), C2(36), A4(69) +

+
r(x), g(x), b(x)
+

red, green, and blue value of intensity x. +

+
+

Default value is st(0, (midi(f)-59.5)/12); +st(1, if(between(ld(0),0,1), 0.5-0.5*cos(2*PI*ld(0)), 0)); +r(1-ld(1)) + b(ld(1)). +

+
+
axisfile
+

Specify image file to draw the axis. This option override fontfile and +fontcolor option. +

+
+
axis, text
+

Enable/disable drawing text to the axis. If it is set to 0, drawing to +the axis is disabled, ignoring fontfile and axisfile option. +Default value is 1. +

+
+
csp
+

Set colorspace. The accepted values are: +

+
‘unspecified’
+

Unspecified (default) +

+
+
‘bt709’
+

BT.709 +

+
+
‘fcc’
+

FCC +

+
+
‘bt470bg’
+

BT.470BG or BT.601-6 625 +

+
+
‘smpte170m’
+

SMPTE-170M or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘bt2020ncl’
+

BT.2020 with non-constant luminance +

+
+
+ +
+
cscheme
+

Set spectrogram color scheme. This is list of floating point values with format +left_r|left_g|left_b|right_r|right_g|right_b. +The default is 1|0.5|0|0|0.5|1. +

+
+
+ + +

16.19.1 Examples

+ +
    +
  • Playing audio while showing the spectrum: +
    +
    ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt [out0]'
+
    + +
  • Same as above, but with frame rate 30 fps: +
    +
    ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt=fps=30:count=5 [out0]'
+
    + +
  • Playing at 1280x720: +
    +
    ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt=s=1280x720:count=4 [out0]'
+
    + +
  • Disable sonogram display: +
    +
    sono_h=0
+
    + +
  • A1 and its harmonics: A1, A2, (near)E3, A3: +
    +
    ffplay -f lavfi 'aevalsrc=0.1*sin(2*PI*55*t)+0.1*sin(4*PI*55*t)+0.1*sin(6*PI*55*t)+0.1*sin(8*PI*55*t),
+                 asplit[a][out1]; [a] showcqt [out0]'
+
    + +
  • Same as above, but with more accuracy in frequency domain: +
    +
    ffplay -f lavfi 'aevalsrc=0.1*sin(2*PI*55*t)+0.1*sin(4*PI*55*t)+0.1*sin(6*PI*55*t)+0.1*sin(8*PI*55*t),
+                 asplit[a][out1]; [a] showcqt=timeclamp=0.5 [out0]'
+
    + +
  • Custom volume: +
    +
    bar_v=10:sono_v=bar_v*a_weighting(f)
+
    + +
  • Custom gamma, now spectrum is linear to the amplitude. +
    +
    bar_g=2:sono_g=2
+
    + +
  • Custom tlength equation: +
    +
    tc=0.33:tlength='st(0,0.17); 384*tc / (384 / ld(0) + tc*f /(1-ld(0))) + 384*tc / (tc*f / ld(0) + 384 /(1-ld(0)))'
+
    + +
  • Custom fontcolor and fontfile, C-note is colored green, others are colored blue: +
    +
    fontcolor='if(mod(floor(midi(f)+0.5),12), 0x0000FF, g(1))':fontfile=myfont.ttf
+
    + +
  • Custom font using fontconfig: +
    +
    font='Courier New,Monospace,mono|bold'
+
    + +
  • Custom frequency range with custom axis using image file: +
    +
    axisfile=myaxis.png:basefreq=40:endfreq=10000
+
    +
+ + +

16.20 showfreqs

+ +

Convert input audio to video output representing the audio power spectrum. +Audio amplitude is on Y-axis while frequency is on X-axis. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify size of video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default is 1024x512. +

+
+
mode
+

Set display mode. +This set how each frequency bin will be represented. +

+

It accepts the following values: +

+
‘line’
+
‘bar’
+
‘dot’
+
+

Default is bar. +

+
+
ascale
+

Set amplitude scale. +

+

It accepts the following values: +

+
‘lin’
+

Linear scale. +

+
+
‘sqrt’
+

Square root scale. +

+
+
‘cbrt’
+

Cubic root scale. +

+
+
‘log’
+

Logarithmic scale. +

+
+

Default is log. +

+
+
fscale
+

Set frequency scale. +

+

It accepts the following values: +

+
‘lin’
+

Linear scale. +

+
+
‘log’
+

Logarithmic scale. +

+
+
‘rlog’
+

Reverse logarithmic scale. +

+
+

Default is lin. +

+
+
win_size
+

Set window size. Allowed range is from 16 to 65536. +

+

Default is 2048 +

+
+
win_func
+

Set windowing function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+

Default is hanning. +

+
+
overlap
+

Set window overlap. In range [0, 1]. Default is 1, +which means optimal overlap for selected window function will be picked. +

+
+
averaging
+

Set time averaging. Setting this to 0 will display current maximal peaks. +Default is 1, which means time averaging is disabled. +

+
+
colors
+

Specify list of colors separated by space or by ’|’ which will be used to +draw channel frequencies. Unrecognized or missing colors will be replaced +by white color. +

+
+
cmode
+

Set channel display mode. +

+

It accepts the following values: +

+
‘combined’
+
‘separate’
+
+

Default is combined. +

+
+
minamp
+

Set minimum amplitude used in log amplitude scaler. +

+
+
+ + +

16.21 showspatial

+ +

Convert stereo input audio to a video output, representing the spatial relationship +between two channels. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 512x512. +

+
+
win_size
+

Set window size. Allowed range is from 1024 to 65536. Default size is 4096. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+ +

Default value is hann. +

+
+
overlap
+

Set ratio of overlap window. Default value is 0.5. +When value is 1 overlap is set to recommended size for specific +window function currently used. +

+
+ + +

16.22 showspectrum

+ +

Convert input audio to a video output, representing the audio frequency +spectrum. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 640x512. +

+
+
slide
+

Specify how the spectrum should slide along the window. +

+

It accepts the following values: +

+
‘replace’
+

the samples start again on the left when they reach the right +

+
‘scroll’
+

the samples scroll from right to left +

+
‘fullframe’
+

frames are only produced when the samples reach the right +

+
‘rscroll’
+

the samples scroll from left to right +

+
+ +

Default value is replace. +

+
+
mode
+

Specify display mode. +

+

It accepts the following values: +

+
‘combined’
+

all channels are displayed in the same row +

+
‘separate’
+

all channels are displayed in separate rows +

+
+ +

Default value is ‘combined’. +

+
+
color
+

Specify display color mode. +

+

It accepts the following values: +

+
‘channel’
+

each channel is displayed in a separate color +

+
‘intensity’
+

each channel is displayed using the same color scheme +

+
‘rainbow’
+

each channel is displayed using the rainbow color scheme +

+
‘moreland’
+

each channel is displayed using the moreland color scheme +

+
‘nebulae’
+

each channel is displayed using the nebulae color scheme +

+
‘fire’
+

each channel is displayed using the fire color scheme +

+
‘fiery’
+

each channel is displayed using the fiery color scheme +

+
‘fruit’
+

each channel is displayed using the fruit color scheme +

+
‘cool’
+

each channel is displayed using the cool color scheme +

+
‘magma’
+

each channel is displayed using the magma color scheme +

+
‘green’
+

each channel is displayed using the green color scheme +

+
‘viridis’
+

each channel is displayed using the viridis color scheme +

+
‘plasma’
+

each channel is displayed using the plasma color scheme +

+
‘cividis’
+

each channel is displayed using the cividis color scheme +

+
‘terrain’
+

each channel is displayed using the terrain color scheme +

+
+ +

Default value is ‘channel’. +

+
+
scale
+

Specify scale used for calculating intensity color values. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘sqrt’
+

square root, default +

+
‘cbrt’
+

cubic root +

+
‘log’
+

logarithmic +

+
‘4thrt’
+

4th root +

+
‘5thrt’
+

5th root +

+
+ +

Default value is ‘sqrt’. +

+
+
fscale
+

Specify frequency scale. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘log’
+

logarithmic +

+
+ +

Default value is ‘lin’. +

+
+
saturation
+

Set saturation modifier for displayed colors. Negative values provide +alternative color scheme. 0 is no saturation at all. +Saturation must be in [-10.0, 10.0] range. +Default value is 1. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+ +

Default value is hann. +

+
+
orientation
+

Set orientation of time vs frequency axis. Can be vertical or +horizontal. Default is vertical. +

+
+
overlap
+

Set ratio of overlap window. Default value is 0. +When value is 1 overlap is set to recommended size for specific +window function currently used. +

+
+
gain
+

Set scale gain for calculating intensity color values. +Default value is 1. +

+
+
data
+

Set which data to display. Can be magnitude, default or phase. +

+
+
rotation
+

Set color rotation, must be in [-1.0, 1.0] range. +Default value is 0. +

+
+
start
+

Set start frequency from which to display spectrogram. Default is 0. +

+
+
stop
+

Set stop frequency to which to display spectrogram. Default is 0. +

+
+
fps
+

Set upper frame rate limit. Default is auto, unlimited. +

+
+
legend
+

Draw time and frequency axes and legends. Default is disabled. +

+
+ +

The usage is very similar to the showwaves filter; see the examples in that +section. +

+ +

16.22.1 Examples

+ +
    +
  • Large window with logarithmic color scaling: +
    +
    showspectrum=s=1280x480:scale=log
+
    + +
  • Complete example for a colored and sliding spectrum per channel using ffplay: +
    +
    ffplay -f lavfi 'amovie=input.mp3, asplit [a][out1];
+             [a] showspectrum=mode=separate:color=intensity:slide=1:scale=cbrt [out0]'
+
    +
+ + +

16.23 showspectrumpic

+ +

Convert input audio to a single video frame, representing the audio frequency +spectrum. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 4096x2048. +

+
+
mode
+

Specify display mode. +

+

It accepts the following values: +

+
‘combined’
+

all channels are displayed in the same row +

+
‘separate’
+

all channels are displayed in separate rows +

+
+

Default value is ‘combined’. +

+
+
color
+

Specify display color mode. +

+

It accepts the following values: +

+
‘channel’
+

each channel is displayed in a separate color +

+
‘intensity’
+

each channel is displayed using the same color scheme +

+
‘rainbow’
+

each channel is displayed using the rainbow color scheme +

+
‘moreland’
+

each channel is displayed using the moreland color scheme +

+
‘nebulae’
+

each channel is displayed using the nebulae color scheme +

+
‘fire’
+

each channel is displayed using the fire color scheme +

+
‘fiery’
+

each channel is displayed using the fiery color scheme +

+
‘fruit’
+

each channel is displayed using the fruit color scheme +

+
‘cool’
+

each channel is displayed using the cool color scheme +

+
‘magma’
+

each channel is displayed using the magma color scheme +

+
‘green’
+

each channel is displayed using the green color scheme +

+
‘viridis’
+

each channel is displayed using the viridis color scheme +

+
‘plasma’
+

each channel is displayed using the plasma color scheme +

+
‘cividis’
+

each channel is displayed using the cividis color scheme +

+
‘terrain’
+

each channel is displayed using the terrain color scheme +

+
+

Default value is ‘intensity’. +

+
+
scale
+

Specify scale used for calculating intensity color values. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘sqrt’
+

square root, default +

+
‘cbrt’
+

cubic root +

+
‘log’
+

logarithmic +

+
‘4thrt’
+

4th root +

+
‘5thrt’
+

5th root +

+
+

Default value is ‘log’. +

+
+
fscale
+

Specify frequency scale. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘log’
+

logarithmic +

+
+ +

Default value is ‘lin’. +

+
+
saturation
+

Set saturation modifier for displayed colors. Negative values provide +alternative color scheme. 0 is no saturation at all. +Saturation must be in [-10.0, 10.0] range. +Default value is 1. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+

Default value is hann. +

+
+
orientation
+

Set orientation of time vs frequency axis. Can be vertical or +horizontal. Default is vertical. +

+
+
gain
+

Set scale gain for calculating intensity color values. +Default value is 1. +

+
+
legend
+

Draw time and frequency axes and legends. Default is enabled. +

+
+
rotation
+

Set color rotation, must be in [-1.0, 1.0] range. +Default value is 0. +

+
+
start
+

Set start frequency from which to display spectrogram. Default is 0. +

+
+
stop
+

Set stop frequency to which to display spectrogram. Default is 0. +

+
+ + +

16.23.1 Examples

+ +
    +
  • Extract an audio spectrogram of a whole audio track +in a 1024x1024 picture using ffmpeg: +
    +
    ffmpeg -i audio.flac -lavfi showspectrumpic=s=1024x1024 spectrogram.png
+
    +
+ + +

16.24 showvolume

+ +

Convert input audio volume to a video output. +

+

The filter accepts the following options: +

+
+
rate, r
+

Set video rate. +

+
+
b
+

Set border width, allowed range is [0, 5]. Default is 1. +

+
+
w
+

Set channel width, allowed range is [80, 8192]. Default is 400. +

+
+
h
+

Set channel height, allowed range is [1, 900]. Default is 20. +

+
+
f
+

Set fade, allowed range is [0, 1]. Default is 0.95. +

+
+
c
+

Set volume color expression. +

+

The expression can use the following variables: +

+
+
VOLUME
+

Current max volume of channel in dB. +

+
+
PEAK
+

Current peak. +

+
+
CHANNEL
+

Current channel number, starting from 0. +

+
+ +
+
t
+

If set, displays channel names. Default is enabled. +

+
+
v
+

If set, displays volume values. Default is enabled. +

+
+
o
+

Set orientation, can be horizontal: h or vertical: v, +default is h. +

+
+
s
+

Set step size, allowed range is [0, 5]. Default is 0, which means +step is disabled. +

+
+
p
+

Set background opacity, allowed range is [0, 1]. Default is 0. +

+
+
m
+

Set metering mode, can be peak: p or rms: r, +default is p. +

+
+
ds
+

Set display scale, can be linear: lin or log: log, +default is lin. +

+
+
dm
+

In second. +If set to > 0., display a line for the max level +in the previous seconds. +default is disabled: 0. +

+
+
dmc
+

The color of the max line. Use when dm option is set to > 0. +default is: orange +

+
+ + +

16.25 showwaves

+ +

Convert input audio to a video output, representing the samples waves. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 600x240. +

+
+
mode
+

Set display mode. +

+

Available values are: +

+
‘point’
+

Draw a point for each sample. +

+
+
‘line’
+

Draw a vertical line for each sample. +

+
+
‘p2p’
+

Draw a point for each sample and a line between them. +

+
+
‘cline’
+

Draw a centered vertical line for each sample. +

+
+ +

Default value is point. +

+
+
n
+

Set the number of samples which are printed on the same column. A +larger value will decrease the frame rate. Must be a positive +integer. This option can be set only if the value for rate +is not explicitly specified. +

+
+
rate, r
+

Set the (approximate) output frame rate. This is done by setting the +option n. Default value is "25". +

+
+
split_channels
+

Set if channels should be drawn separately or overlap. Default value is 0. +

+
+
colors
+

Set colors separated by ’|’ which are going to be used for drawing of each channel. +

+
+
scale
+

Set amplitude scale. +

+

Available values are: +

+
‘lin’
+

Linear. +

+
+
‘log’
+

Logarithmic. +

+
+
‘sqrt’
+

Square root. +

+
+
‘cbrt’
+

Cubic root. +

+
+ +

Default is linear. +

+
+
draw
+

Set the draw mode. This is mostly useful to set for high n. +

+

Available values are: +

+
‘scale’
+

Scale pixel values for each drawn sample. +

+
+
‘full’
+

Draw every sample directly. +

+
+ +

Default value is scale. +

+
+ + +

16.25.1 Examples

+ +
    +
  • Output the input file audio and the corresponding video representation +at the same time: +
    +
    amovie=a.mp3,asplit[out0],showwaves[out1]
+
    + +
  • Create a synthetic signal and show it with showwaves, forcing a +frame rate of 30 frames per second: +
    +
    aevalsrc=sin(1*2*PI*t)*sin(880*2*PI*t):cos(2*PI*200*t),asplit[out0],showwaves=r=30[out1]
+
    +
+ + +

16.26 showwavespic

+ +

Convert input audio to a single video frame, representing the samples waves. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 600x240. +

+
+
split_channels
+

Set if channels should be drawn separately or overlap. Default value is 0. +

+
+
colors
+

Set colors separated by ’|’ which are going to be used for drawing of each channel. +

+
+
scale
+

Set amplitude scale. +

+

Available values are: +

+
‘lin’
+

Linear. +

+
+
‘log’
+

Logarithmic. +

+
+
‘sqrt’
+

Square root. +

+
+
‘cbrt’
+

Cubic root. +

+
+ +

Default is linear. +

+
+
draw
+

Set the draw mode. +

+

Available values are: +

+
‘scale’
+

Scale pixel values for each drawn sample. +

+
+
‘full’
+

Draw every sample directly. +

+
+ +

Default value is scale. +

+
+ + +

16.26.1 Examples

+ +
    +
  • Extract a channel split representation of the wave form of a whole audio track +in a 1024x800 picture using ffmpeg: +
    +
    ffmpeg -i audio.flac -lavfi showwavespic=split_channels=1:s=1024x800 waveform.png
+
    +
+ + +

16.27 sidedata, asidedata

+ +

Delete frame side data, or select frames based on it. +

+

This filter accepts the following options: +

+
+
mode
+

Set mode of operation of the filter. +

+

Can be one of the following: +

+
+
‘select’
+

Select every frame with side data of type. +

+
+
‘delete’
+

Delete side data of type. If type is not set, delete all side +data in the frame. +

+
+
+ +
+
type
+

Set side data type used with all modes. Must be set for select mode. For +the list of frame side data types, refer to the AVFrameSideDataType enum +in libavutil/frame.h. For example, to choose +AV_FRAME_DATA_PANSCAN side data, you must specify PANSCAN. +

+
+
+ + +

16.28 spectrumsynth

+ +

Synthesize audio from 2 input video spectrums, first input stream represents +magnitude across time and second represents phase across time. +The filter will transform from frequency domain as displayed in videos back +to time domain as presented in audio output. +

+

This filter is primarily created for reversing processed showspectrum +filter outputs, but can synthesize sound from other spectrograms too. +But in such case results are going to be poor if the phase data is not +available, because in such cases phase data need to be recreated, usually +it’s just recreated from random noise. +For best results use gray only output (channel color mode in +showspectrum filter) and log scale for magnitude video and +lin scale for phase video. To produce phase, for 2nd video, use +data option. Inputs videos should generally use fullframe +slide mode as that saves resources needed for decoding video. +

+

The filter accepts the following options: +

+
+
sample_rate
+

Specify sample rate of output audio, the sample rate of audio from which +spectrum was generated may differ. +

+
+
channels
+

Set number of channels represented in input video spectrums. +

+
+
scale
+

Set scale which was used when generating magnitude input spectrum. +Can be lin or log. Default is log. +

+
+
slide
+

Set slide which was used when generating inputs spectrums. +Can be replace, scroll, fullframe or rscroll. +Default is fullframe. +

+
+
win_func
+

Set window function used for resynthesis. +

+
+
overlap
+

Set window overlap. In range [0, 1]. Default is 1, +which means optimal overlap for selected window function will be picked. +

+
+
orientation
+

Set orientation of input videos. Can be vertical or horizontal. +Default is vertical. +

+
+ + +

16.28.1 Examples

+ +
    +
  • First create magnitude and phase videos from audio, assuming audio is stereo with 44100 sample rate, +then resynthesize videos back to audio with spectrumsynth: +
    +
    ffmpeg -i input.flac -lavfi showspectrum=mode=separate:scale=log:overlap=0.875:color=channel:slide=fullframe:data=magnitude -an -c:v rawvideo magnitude.nut
+ffmpeg -i input.flac -lavfi showspectrum=mode=separate:scale=lin:overlap=0.875:color=channel:slide=fullframe:data=phase -an -c:v rawvideo phase.nut
+ffmpeg -i magnitude.nut -i phase.nut -lavfi spectrumsynth=channels=2:sample_rate=44100:win_func=hann:overlap=0.875:slide=fullframe output.flac
+
    +
+ + +

16.29 split, asplit

+ +

Split input into several identical outputs. +

+

asplit works with audio input, split with video. +

+

The filter accepts a single parameter which specifies the number of outputs. If +unspecified, it defaults to 2. +

+ +

16.29.1 Examples

+ +
    +
  • Create two separate outputs from the same input: +
    +
    [in] split [out0][out1]
+
    + +
  • To create 3 or more outputs, you need to specify the number of +outputs, like in: +
    +
    [in] asplit=3 [out0][out1][out2]
+
    + +
  • Create two separate outputs from the same input, one cropped and +one padded: +
    +
    [in] split [splitout1][splitout2];
+[splitout1] crop=100:100:0:0    [cropout];
+[splitout2] pad=200:200:100:100 [padout];
+
    + +
  • Create 5 copies of the input audio with ffmpeg: +
    +
    ffmpeg -i INPUT -filter_complex asplit=5 OUTPUT
+
    +
+ + +

16.30 zmq, azmq

+ +

Receive commands sent through a libzmq client, and forward them to +filters in the filtergraph. +

+

zmq and azmq work as a pass-through filters. zmq +must be inserted between two video filters, azmq between two +audio filters. Both are capable to send messages to any filter type. +

+

To enable these filters you need to install the libzmq library and +headers and configure FFmpeg with --enable-libzmq. +

+

For more information about libzmq see: +http://www.zeromq.org/ +

+

The zmq and azmq filters work as a libzmq server, which +receives messages sent through a network interface defined by the +bind_address (or the abbreviation "b") option. +Default value of this option is tcp://localhost:5555. You may +want to alter this value to your needs, but do not forget to escape any +’:’ signs (see filtergraph escaping). +

+

The received message must be in the form: +

+
TARGET COMMAND [ARG]
+
+ +

TARGET specifies the target of the command, usually the name of +the filter class or a specific filter instance name. The default +filter instance name uses the pattern ‘Parsed_<filter_name>_<index>’, +but you can override this by using the ‘filter_name@id’ syntax +(see Filtergraph syntax). +

+

COMMAND specifies the name of the command for the target filter. +

+

ARG is optional and specifies the optional argument list for the +given COMMAND. +

+

Upon reception, the message is processed and the corresponding command +is injected into the filtergraph. Depending on the result, the filter +will send a reply to the client, adopting the format: +

+
ERROR_CODE ERROR_REASON
+MESSAGE
+
+ +

MESSAGE is optional. +

+ +

16.30.1 Examples

+ +

Look at tools/zmqsend for an example of a zmq client which can +be used to send commands processed by these filters. +

+

Consider the following filtergraph generated by ffplay. +In this example the last overlay filter has an instance name. All other +filters will have default instance names. +

+
+
ffplay -dumpgraph 1 -f lavfi "
+color=s=100x100:c=red  [l];
+color=s=100x100:c=blue [r];
+nullsrc=s=200x100, zmq [bg];
+[bg][l]   overlay     [bg+l];
+[bg+l][r] overlay@my=x=100 "
+
+ +

To change the color of the left side of the video, the following +command can be used: +

+
echo Parsed_color_0 c yellow | tools/zmqsend
+
+ +

To change the right side: +

+
echo Parsed_color_1 c pink | tools/zmqsend
+
+ +

To change the position of the right side: +

+
echo overlay@my x 150 | tools/zmqsend
+
+ + + + +

17 Multimedia Sources

+ +

Below is a description of the currently available multimedia sources. +

+ +

17.1 amovie

+ +

This is the same as movie source, except it selects an audio +stream by default. +

+ +

17.2 movie

+ +

Read audio and/or video stream(s) from a movie container. +

+

It accepts the following parameters: +

+
+
filename
+

The name of the resource to read (not necessarily a file; it can also be a +device or a stream accessed through some protocol). +

+
+
format_name, f
+

Specifies the format assumed for the movie to read, and can be either +the name of a container or an input device. If not specified, the +format is guessed from movie_name or by probing. +

+
+
seek_point, sp
+

Specifies the seek point in seconds. The frames will be output +starting from this seek point. The parameter is evaluated with +av_strtod, so the numerical value may be suffixed by an IS +postfix. The default value is "0". +

+
+
streams, s
+

Specifies the streams to read. Several streams can be specified, +separated by "+". The source will then have as many outputs, in the +same order. The syntax is explained in the (ffmpeg)"Stream specifiers" +section in the ffmpeg manual. Two special names, "dv" and "da" specify +respectively the default (best suited) video and audio stream. Default +is "dv", or "da" if the filter is called as "amovie". +

+
+
stream_index, si
+

Specifies the index of the video stream to read. If the value is -1, +the most suitable video stream will be automatically selected. The default +value is "-1". Deprecated. If the filter is called "amovie", it will select +audio instead of video. +

+
+
loop
+

Specifies how many times to read the stream in sequence. +If the value is 0, the stream will be looped infinitely. +Default value is "1". +

+

Note that when the movie is looped the source timestamps are not +changed, so it will generate non monotonically increasing timestamps. +

+
+
discontinuity
+

Specifies the time difference between frames above which the point is +considered a timestamp discontinuity which is removed by adjusting the later +timestamps. +

+
+ +

It allows overlaying a second video on top of the main input of +a filtergraph, as shown in this graph: +

+
input -----------> deltapts0 --> overlay --> output
+                                    ^
+                                    |
+movie --> scale--> deltapts1 -------+
+
+ +

17.2.1 Examples

+ +
    +
  • Skip 3.2 seconds from the start of the AVI file in.avi, and overlay it +on top of the input labelled "in": +
    +
    movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [over];
+[in] setpts=PTS-STARTPTS [main];
+[main][over] overlay=16:16 [out]
+
    + +
  • Read from a video4linux2 device, and overlay it on top of the input +labelled "in": +
    +
    movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [over];
+[in] setpts=PTS-STARTPTS [main];
+[main][over] overlay=16:16 [out]
+
    + +
  • Read the first video stream and the audio stream with id 0x81 from +dvd.vob; the video is connected to the pad named "video" and the audio is +connected to the pad named "audio": +
    +
    movie=dvd.vob:s=v:0+#0x81 [video] [audio]
+
    +
+ + +

17.2.2 Commands

+ +

Both movie and amovie support the following commands: +

+
seek
+

Perform seek using "av_seek_frame". +The syntax is: seek stream_index|timestamp|flags +

    +
  • stream_index: If stream_index is -1, a default +stream is selected, and timestamp is automatically converted +from AV_TIME_BASE units to the stream specific time_base. +
  • timestamp: Timestamp in AVStream.time_base units +or, if no stream is specified, in AV_TIME_BASE units. +
  • flags: Flags which select direction and seeking mode. +
+ +
+
get_duration
+

Get movie duration in AV_TIME_BASE units. +

+
+
+ + + +

18 See Also

+ +

ffmpeg, ffplay, ffprobe, +libavfilter +

+ + +

19 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-formats.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-formats.html new file mode 100644 index 0000000..341cb43 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-formats.html @@ -0,0 +1,4359 @@ + + + + + + + FFmpeg Formats Documentation + + + + + + +
+

+ FFmpeg Formats Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

This document describes the supported formats (muxers and demuxers) +provided by the libavformat library. +

+ + +

2 Format Options

+ +

The libavformat library provides some generic global options, which +can be set on all the muxers and demuxers. In addition each muxer or +demuxer may support so-called private options, which are specific for +that component. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the +AVFormatContext options or using the libavutil/opt.h API +for programmatic use. +

+

The list of supported options follows: +

+
+
avioflags flags (input/output)
+

Possible values: +

+
‘direct’
+

Reduce buffering. +

+
+ +
+
probesize integer (input)
+

Set probing size in bytes, i.e. the size of the data to analyze to get +stream information. A higher value will enable detecting more +information in case it is dispersed into the stream, but will increase +latency. Must be an integer not lesser than 32. It is 5000000 by default. +

+
+
max_probe_packets integer (input)
+

Set the maximum number of buffered packets when probing a codec. +Default is 2500 packets. +

+
+
packetsize integer (output)
+

Set packet size. +

+
+
fflags flags
+

Set format flags. Some are implemented for a limited number of formats. +

+

Possible values for input files: +

+
‘discardcorrupt’
+

Discard corrupted packets. +

+
‘fastseek’
+

Enable fast, but inaccurate seeks for some formats. +

+
‘genpts’
+

Generate missing PTS if DTS is present. +

+
‘igndts’
+

Ignore DTS if PTS is set. Inert when nofillin is set. +

+
‘ignidx’
+

Ignore index. +

+
‘keepside (deprecated,inert)’
+
‘nobuffer’
+

Reduce the latency introduced by buffering during initial input streams analysis. +

+
‘nofillin’
+

Do not fill in missing values in packet fields that can be exactly calculated. +

+
‘noparse’
+

Disable AVParsers, this needs +nofillin too. +

+
‘sortdts’
+

Try to interleave output packets by DTS. At present, available only for AVIs with an index. +

+
+ +

Possible values for output files: +

+
‘autobsf’
+

Automatically apply bitstream filters as required by the output format. Enabled by default. +

+
‘bitexact’
+

Only write platform-, build- and time-independent data. +This ensures that file and data checksums are reproducible and match between +platforms. Its primary use is for regression testing. +

+
‘flush_packets’
+

Write out packets immediately. +

+
‘latm (deprecated,inert)’
+
‘shortest’
+

Stop muxing at the end of the shortest stream. +It may be needed to increase max_interleave_delta to avoid flushing the longer +streams before EOF. +

+
+ +
+
seek2any integer (input)
+

Allow seeking to non-keyframes on demuxer level when supported if set to 1. +Default is 0. +

+
+
analyzeduration integer (input)
+

Specify how many microseconds are analyzed to probe the input. A +higher value will enable detecting more accurate information, but will +increase latency. It defaults to 5,000,000 microseconds = 5 seconds. +

+
+
cryptokey hexadecimal string (input)
+

Set decryption key. +

+
+
indexmem integer (input)
+

Set max memory used for timestamp index (per stream). +

+
+
rtbufsize integer (input)
+

Set max memory used for buffering real-time frames. +

+
+
fdebug flags (input/output)
+

Print specific debug info. +

+

Possible values: +

+
‘ts’
+
+ +
+
max_delay integer (input/output)
+

Set maximum muxing or demuxing delay in microseconds. +

+
+
fpsprobesize integer (input)
+

Set number of frames used to probe fps. +

+
+
audio_preload integer (output)
+

Set microseconds by which audio packets should be interleaved earlier. +

+
+
chunk_duration integer (output)
+

Set microseconds for each chunk. +

+
+
chunk_size integer (output)
+

Set size in bytes for each chunk. +

+
+
err_detect, f_err_detect flags (input)
+

Set error detection flags. f_err_detect is deprecated and +should be used only via the ffmpeg tool. +

+

Possible values: +

+
‘crccheck’
+

Verify embedded CRCs. +

+
‘bitstream’
+

Detect bitstream specification deviations. +

+
‘buffer’
+

Detect improper bitstream length. +

+
‘explode’
+

Abort decoding on minor error detection. +

+
‘careful’
+

Consider things that violate the spec and have not been seen in the +wild as errors. +

+
‘compliant’
+

Consider all spec non compliancies as errors. +

+
‘aggressive’
+

Consider things that a sane encoder should not do as an error. +

+
+ +
+
max_interleave_delta integer (output)
+

Set maximum buffering duration for interleaving. The duration is +expressed in microseconds, and defaults to 10000000 (10 seconds). +

+

To ensure all the streams are interleaved correctly, libavformat will +wait until it has at least one packet for each stream before actually +writing any packets to the output file. When some streams are +"sparse" (i.e. there are large gaps between successive packets), this +can result in excessive buffering. +

+

This field specifies the maximum difference between the timestamps of the +first and the last packet in the muxing queue, above which libavformat +will output a packet regardless of whether it has queued a packet for all +the streams. +

+

If set to 0, libavformat will continue buffering packets until it has +a packet for each stream, regardless of the maximum timestamp +difference between the buffered packets. +

+
+
use_wallclock_as_timestamps integer (input)
+

Use wallclock as timestamps if set to 1. Default is 0. +

+
+
avoid_negative_ts integer (output)
+
+

Possible values: +

+
‘make_non_negative’
+

Shift timestamps to make them non-negative. +Also note that this affects only leading negative timestamps, and not +non-monotonic negative timestamps. +

+
‘make_zero’
+

Shift timestamps so that the first timestamp is 0. +

+
‘auto (default)’
+

Enables shifting when required by the target format. +

+
‘disabled’
+

Disables shifting of timestamp. +

+
+ +

When shifting is enabled, all output timestamps are shifted by the +same amount. Audio, video, and subtitles desynching and relative +timestamp differences are preserved compared to how they would have +been without shifting. +

+
+
skip_initial_bytes integer (input)
+

Set number of bytes to skip before reading header and frames if set to 1. +Default is 0. +

+
+
correct_ts_overflow integer (input)
+

Correct single timestamp overflows if set to 1. Default is 1. +

+
+
flush_packets integer (output)
+

Flush the underlying I/O stream after each packet. Default is -1 (auto), which +means that the underlying protocol will decide, 1 enables it, and has the +effect of reducing the latency, 0 disables it and may increase IO throughput in +some cases. +

+
+
output_ts_offset offset (output)
+

Set the output time offset. +

+

offset must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+

The offset is added by the muxer to the output timestamps. +

+

Specifying a positive offset means that the corresponding streams are +delayed bt the time duration specified in offset. Default value +is 0 (meaning that no offset is applied). +

+
+
format_whitelist list (input)
+

"," separated list of allowed demuxers. By default all are allowed. +

+
+
dump_separator string (input)
+

Separator used to separate the fields printed on the command line about the +Stream parameters. +For example, to separate the fields with newlines and indentation: +

+
ffprobe -dump_separator "
+                          "  -i ~/videos/matrixbench_mpeg2.mpg
+
+ +
+
max_streams integer (input)
+

Specifies the maximum number of streams. This can be used to reject files that +would require too many resources due to a large number of streams. +

+
+
skip_estimate_duration_from_pts bool (input)
+

Skip estimation of input duration when calculated using PTS. +At present, applicable for MPEG-PS and MPEG-TS. +

+
+
strict, f_strict integer (input/output)
+

Specify how strictly to follow the standards. f_strict is deprecated and +should be used only via the ffmpeg tool. +

+

Possible values: +

+
‘very’
+

strictly conform to an older more strict version of the spec or reference software +

+
‘strict’
+

strictly conform to all the things in the spec no matter what consequences +

+
‘normal’
+
‘unofficial’
+

allow unofficial extensions +

+
‘experimental’
+

allow non standardized experimental things, experimental +(unfinished/work in progress/not well tested) decoders and encoders. +Note: experimental decoders can pose a security risk, do not use this for +decoding untrusted input. +

+
+ +
+
+ + + +

2.1 Format stream specifiers

+ +

Format stream specifiers allow selection of one or more streams that +match specific properties. +

+

The exact semantics of stream specifiers is defined by the +avformat_match_stream_specifier() function declared in the +libavformat/avformat.h header and documented in the +(ffmpeg)Stream specifiers section in the ffmpeg(1) manual. +

+ +

3 Demuxers

+ +

Demuxers are configured elements in FFmpeg that can read the +multimedia streams from a particular type of file. +

+

When you configure your FFmpeg build, all the supported demuxers +are enabled by default. You can list all available ones using the +configure option --list-demuxers. +

+

You can disable all the demuxers using the configure option +--disable-demuxers, and selectively enable a single demuxer with +the option --enable-demuxer=DEMUXER, or disable it +with the option --disable-demuxer=DEMUXER. +

+

The option -demuxers of the ff* tools will display the list of +enabled demuxers. Use -formats to view a combined list of +enabled demuxers and muxers. +

+

The description of some of the currently available demuxers follows. +

+ +

3.1 aa

+ +

Audible Format 2, 3, and 4 demuxer. +

+

This demuxer is used to demux Audible Format 2, 3, and 4 (.aa) files. +

+ +

3.2 apng

+ +

Animated Portable Network Graphics demuxer. +

+

This demuxer is used to demux APNG files. +All headers, but the PNG signature, up to (but not including) the first +fcTL chunk are transmitted as extradata. +Frames are then split as being all the chunks between two fcTL ones, or +between the last fcTL and IEND chunks. +

+
+
-ignore_loop bool
+

Ignore the loop variable in the file if set. +

+
-max_fps int
+

Maximum framerate in frames per second (0 for no limit). +

+
-default_fps int
+

Default framerate in frames per second when none is specified in the file +(0 meaning as fast as possible). +

+
+ + +

3.3 asf

+ +

Advanced Systems Format demuxer. +

+

This demuxer is used to demux ASF files and MMS network streams. +

+
+
-no_resync_search bool
+

Do not try to resynchronize by looking for a certain optional start code. +

+
+ + +

3.4 concat

+ +

Virtual concatenation script demuxer. +

+

This demuxer reads a list of files and other directives from a text file and +demuxes them one after the other, as if all their packets had been muxed +together. +

+

The timestamps in the files are adjusted so that the first file starts at 0 +and each next file starts where the previous one finishes. Note that it is +done globally and may cause gaps if all streams do not have exactly the same +length. +

+

All files must have the same streams (same codecs, same time base, etc.). +

+

The duration of each file is used to adjust the timestamps of the next file: +if the duration is incorrect (because it was computed using the bit-rate or +because the file is truncated, for example), it can cause artifacts. The +duration directive can be used to override the duration stored in +each file. +

+ +

3.4.1 Syntax

+ +

The script is a text file in extended-ASCII, with one directive per line. +Empty lines, leading spaces and lines starting with ’#’ are ignored. The +following directive is recognized: +

+
+
file path
+

Path to a file to read; special characters and spaces must be escaped with +backslash or single quotes. +

+

All subsequent file-related directives apply to that file. +

+
+
ffconcat version 1.0
+

Identify the script type and version. It also sets the safe option +to 1 if it was -1. +

+

To make FFmpeg recognize the format automatically, this directive must +appear exactly as is (no extra space or byte-order-mark) on the very first +line of the script. +

+
+
duration dur
+

Duration of the file. This information can be specified from the file; +specifying it here may be more efficient or help if the information from the +file is not available or accurate. +

+

If the duration is set for all files, then it is possible to seek in the +whole concatenated video. +

+
+
inpoint timestamp
+

In point of the file. When the demuxer opens the file it instantly seeks to the +specified timestamp. Seeking is done so that all streams can be presented +successfully at In point. +

+

This directive works best with intra frame codecs, because for non-intra frame +ones you will usually get extra packets before the actual In point and the +decoded content will most likely contain frames before In point too. +

+

For each file, packets before the file In point will have timestamps less than +the calculated start timestamp of the file (negative in case of the first +file), and the duration of the files (if not specified by the duration +directive) will be reduced based on their specified In point. +

+

Because of potential packets before the specified In point, packet timestamps +may overlap between two concatenated files. +

+
+
outpoint timestamp
+

Out point of the file. When the demuxer reaches the specified decoding +timestamp in any of the streams, it handles it as an end of file condition and +skips the current and all the remaining packets from all streams. +

+

Out point is exclusive, which means that the demuxer will not output packets +with a decoding timestamp greater or equal to Out point. +

+

This directive works best with intra frame codecs and formats where all streams +are tightly interleaved. For non-intra frame codecs you will usually get +additional packets with presentation timestamp after Out point therefore the +decoded content will most likely contain frames after Out point too. If your +streams are not tightly interleaved you may not get all the packets from all +streams before Out point and you may only will be able to decode the earliest +stream until Out point. +

+

The duration of the files (if not specified by the duration +directive) will be reduced based on their specified Out point. +

+
+
file_packet_metadata key=value
+

Metadata of the packets of the file. The specified metadata will be set for +each file packet. You can specify this directive multiple times to add multiple +metadata entries. +

+
+
stream
+

Introduce a stream in the virtual file. +All subsequent stream-related directives apply to the last introduced +stream. +Some streams properties must be set in order to allow identifying the +matching streams in the subfiles. +If no streams are defined in the script, the streams from the first file are +copied. +

+
+
exact_stream_id id
+

Set the id of the stream. +If this directive is given, the string with the corresponding id in the +subfiles will be used. +This is especially useful for MPEG-PS (VOB) files, where the order of the +streams is not reliable. +

+
+
+ + +

3.4.2 Options

+ +

This demuxer accepts the following option: +

+
+
safe
+

If set to 1, reject unsafe file paths. A file path is considered safe if it +does not contain a protocol specification and is relative and all components +only contain characters from the portable character set (letters, digits, +period, underscore and hyphen) and have no period at the beginning of a +component. +

+

If set to 0, any file name is accepted. +

+

The default is 1. +

+

-1 is equivalent to 1 if the format was automatically +probed and 0 otherwise. +

+
+
auto_convert
+

If set to 1, try to perform automatic conversions on packet data to make the +streams concatenable. +The default is 1. +

+

Currently, the only conversion is adding the h264_mp4toannexb bitstream +filter to H.264 streams in MP4 format. This is necessary in particular if +there are resolution changes. +

+
+
segment_time_metadata
+

If set to 1, every packet will contain the lavf.concat.start_time and the +lavf.concat.duration packet metadata values which are the start_time and +the duration of the respective file segments in the concatenated output +expressed in microseconds. The duration metadata is only set if it is known +based on the concat file. +The default is 0. +

+
+
+ + +

3.4.3 Examples

+ +
    +
  • Use absolute filenames and include some comments: +
    +
    # my first filename
+file /mnt/share/file-1.wav
+# my second filename including whitespace
+file '/mnt/share/file 2.wav'
+# my third filename including whitespace plus single quote
+file '/mnt/share/file 3'\''.wav'
+
    + +
  • Allow for input format auto-probing, use safe filenames and set the duration of +the first file: +
    +
    ffconcat version 1.0
+
+file file-1.wav
+duration 20.0
+
+file subdir/file-2.wav
+
    +
+ + +

3.5 dash

+ +

Dynamic Adaptive Streaming over HTTP demuxer. +

+

This demuxer presents all AVStreams found in the manifest. +By setting the discard flags on AVStreams the caller can decide +which streams to actually receive. +Each stream mirrors the id and bandwidth properties from the +<Representation> as metadata keys named "id" and "variant_bitrate" respectively. +

+ +

3.6 flv, live_flv

+ +

Adobe Flash Video Format demuxer. +

+

This demuxer is used to demux FLV files and RTMP network streams. In case of live network streams, if you force format, you may use live_flv option instead of flv to survive timestamp discontinuities. +

+
+
ffmpeg -f flv -i myfile.flv ...
+ffmpeg -f live_flv -i rtmp://<any.server>/anything/key ....
+
+ + +
+
-flv_metadata bool
+

Allocate the streams according to the onMetaData array content. +

+
+
-flv_ignore_prevtag bool
+

Ignore the size of previous tag value. +

+
+
-flv_full_metadata bool
+

Output all context of the onMetadata. +

+
+ + +

3.7 gif

+ +

Animated GIF demuxer. +

+

It accepts the following options: +

+
+
min_delay
+

Set the minimum valid delay between frames in hundredths of seconds. +Range is 0 to 6000. Default value is 2. +

+
+
max_gif_delay
+

Set the maximum valid delay between frames in hundredth of seconds. +Range is 0 to 65535. Default value is 65535 (nearly eleven minutes), +the maximum value allowed by the specification. +

+
+
default_delay
+

Set the default delay between frames in hundredths of seconds. +Range is 0 to 6000. Default value is 10. +

+
+
ignore_loop
+

GIF files can contain information to loop a certain number of times (or +infinitely). If ignore_loop is set to 1, then the loop setting +from the input will be ignored and looping will not occur. If set to 0, +then looping will occur and will cycle the number of times according to +the GIF. Default value is 1. +

+
+ +

For example, with the overlay filter, place an infinitely looping GIF +over another video: +

+
ffmpeg -i input.mp4 -ignore_loop 0 -i input.gif -filter_complex overlay=shortest=1 out.mkv
+
+ +

Note that in the above example the shortest option for overlay filter is +used to end the output video at the length of the shortest input file, +which in this case is input.mp4 as the GIF in this example loops +infinitely. +

+ +

3.8 hls

+ +

HLS demuxer +

+

Apple HTTP Live Streaming demuxer. +

+

This demuxer presents all AVStreams from all variant streams. +The id field is set to the bitrate variant index number. By setting +the discard flags on AVStreams (by pressing ’a’ or ’v’ in ffplay), +the caller can decide which variant streams to actually receive. +The total bitrate of the variant that the stream belongs to is +available in a metadata key named "variant_bitrate". +

+

It accepts the following options: +

+
+
live_start_index
+

segment index to start live streams at (negative values are from the end). +

+
+
allowed_extensions
+

’,’ separated list of file extensions that hls is allowed to access. +

+
+
max_reload
+

Maximum number of times a insufficient list is attempted to be reloaded. +Default value is 1000. +

+
+
m3u8_hold_counters
+

The maximum number of times to load m3u8 when it refreshes without new segments. +Default value is 1000. +

+
+
http_persistent
+

Use persistent HTTP connections. Applicable only for HTTP streams. +Enabled by default. +

+
+
http_multiple
+

Use multiple HTTP connections for downloading HTTP segments. +Enabled by default for HTTP/1.1 servers. +

+
+
http_seekable
+

Use HTTP partial requests for downloading HTTP segments. +0 = disable, 1 = enable, -1 = auto, Default is auto. +

+
+ + +

3.9 image2

+ +

Image file demuxer. +

+

This demuxer reads from a list of image files specified by a pattern. +The syntax and meaning of the pattern is specified by the +option pattern_type. +

+

The pattern may contain a suffix which is used to automatically +determine the format of the images contained in the files. +

+

The size, the pixel format, and the format of each image must be the +same for all the files in the sequence. +

+

This demuxer accepts the following options: +

+
framerate
+

Set the frame rate for the video stream. It defaults to 25. +

+
loop
+

If set to 1, loop over the input. Default value is 0. +

+
pattern_type
+

Select the pattern type used to interpret the provided filename. +

+

pattern_type accepts one of the following values. +

+
none
+

Disable pattern matching, therefore the video will only contain the specified +image. You should use this option if you do not want to create sequences from +multiple images and your filenames may contain special pattern characters. +

+
sequence
+

Select a sequence pattern type, used to specify a sequence of files +indexed by sequential numbers. +

+

A sequence pattern may contain the string "%d" or "%0Nd", which +specifies the position of the characters representing a sequential +number in each filename matched by the pattern. If the form +"%d0Nd" is used, the string representing the number in each +filename is 0-padded and N is the total number of 0-padded +digits representing the number. The literal character ’%’ can be +specified in the pattern with the string "%%". +

+

If the sequence pattern contains "%d" or "%0Nd", the first filename of +the file list specified by the pattern must contain a number +inclusively contained between start_number and +start_number+start_number_range-1, and all the following +numbers must be sequential. +

+

For example the pattern "img-%03d.bmp" will match a sequence of +filenames of the form img-001.bmp, img-002.bmp, ..., +img-010.bmp, etc.; the pattern "i%%m%%g-%d.jpg" will match a +sequence of filenames of the form i%m%g-1.jpg, +i%m%g-2.jpg, ..., i%m%g-10.jpg, etc. +

+

Note that the pattern must not necessarily contain "%d" or +"%0Nd", for example to convert a single image file +img.jpeg you can employ the command: +

+
ffmpeg -i img.jpeg img.png
+
+ +
+
glob
+

Select a glob wildcard pattern type. +

+

The pattern is interpreted like a glob() pattern. This is only +selectable if libavformat was compiled with globbing support. +

+
+
glob_sequence (deprecated, will be removed)
+

Select a mixed glob wildcard/sequence pattern. +

+

If your version of libavformat was compiled with globbing support, and +the provided pattern contains at least one glob meta character among +%*?[]{} that is preceded by an unescaped "%", the pattern is +interpreted like a glob() pattern, otherwise it is interpreted +like a sequence pattern. +

+

All glob special characters %*?[]{} must be prefixed +with "%". To escape a literal "%" you shall use "%%". +

+

For example the pattern foo-%*.jpeg will match all the +filenames prefixed by "foo-" and terminating with ".jpeg", and +foo-%?%?%?.jpeg will match all the filenames prefixed with +"foo-", followed by a sequence of three characters, and terminating +with ".jpeg". +

+

This pattern type is deprecated in favor of glob and +sequence. +

+
+ +

Default value is glob_sequence. +

+
pixel_format
+

Set the pixel format of the images to read. If not specified the pixel +format is guessed from the first image file in the sequence. +

+
start_number
+

Set the index of the file matched by the image file pattern to start +to read from. Default value is 0. +

+
start_number_range
+

Set the index interval range to check when looking for the first image +file in the sequence, starting from start_number. Default value +is 5. +

+
ts_from_file
+

If set to 1, will set frame timestamp to modification time of image file. Note +that monotonity of timestamps is not provided: images go in the same order as +without this option. Default value is 0. +If set to 2, will set frame timestamp to the modification time of the image file in +nanosecond precision. +

+
video_size
+

Set the video size of the images to read. If not specified the video +size is guessed from the first image file in the sequence. +

+
export_path_metadata
+

If set to 1, will add two extra fields to the metadata found in input, making them +also available for other filters (see drawtext filter for examples). Default +value is 0. The extra fields are described below: +

+
lavf.image2dec.source_path
+

Corresponds to the full path to the input file being read. +

+
lavf.image2dec.source_basename
+

Corresponds to the name of the file being read. +

+
+ +
+
+ + +

3.9.1 Examples

+ +
    +
  • Use ffmpeg for creating a video from the images in the file +sequence img-001.jpeg, img-002.jpeg, ..., assuming an +input frame rate of 10 frames per second: +
    +
    ffmpeg -framerate 10 -i 'img-%03d.jpeg' out.mkv
+
    + +
  • As above, but start by reading from a file with index 100 in the sequence: +
    +
    ffmpeg -framerate 10 -start_number 100 -i 'img-%03d.jpeg' out.mkv
+
    + +
  • Read images matching the "*.png" glob pattern , that is all the files +terminating with the ".png" suffix: +
    +
    ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
+
    +
+ + +

3.10 libgme

+ +

The Game Music Emu library is a collection of video game music file emulators. +

+

See https://bitbucket.org/mpyne/game-music-emu/overview for more information. +

+

It accepts the following options: +

+
+
track_index
+

Set the index of which track to demux. The demuxer can only export one track. +Track indexes start at 0. Default is to pick the first track. Number of tracks +is exported as tracks metadata entry. +

+
+
sample_rate
+

Set the sampling rate of the exported track. Range is 1000 to 999999. Default is 44100. +

+
+
max_size (bytes)
+

The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size, +which in turn, acts as a ceiling for the size of files that can be read. +Default is 50 MiB. +

+
+
+ + +

3.11 libmodplug

+ +

ModPlug based module demuxer +

+

See https://github.com/Konstanty/libmodplug +

+

It will export one 2-channel 16-bit 44.1 kHz audio stream. +Optionally, a pal8 16-color video stream can be exported with or without printed metadata. +

+

It accepts the following options: +

+
+
noise_reduction
+

Apply a simple low-pass filter. Can be 1 (on) or 0 (off). Default is 0. +

+
+
reverb_depth
+

Set amount of reverb. Range 0-100. Default is 0. +

+
+
reverb_delay
+

Set delay in ms, clamped to 40-250 ms. Default is 0. +

+
+
bass_amount
+

Apply bass expansion a.k.a. XBass or megabass. Range is 0 (quiet) to 100 (loud). Default is 0. +

+
+
bass_range
+

Set cutoff i.e. upper-bound for bass frequencies. Range is 10-100 Hz. Default is 0. +

+
+
surround_depth
+

Apply a Dolby Pro-Logic surround effect. Range is 0 (quiet) to 100 (heavy). Default is 0. +

+
+
surround_delay
+

Set surround delay in ms, clamped to 5-40 ms. Default is 0. +

+
+
max_size
+

The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size, +which in turn, acts as a ceiling for the size of files that can be read. Range is 0 to 100 MiB. +0 removes buffer size limit (not recommended). Default is 5 MiB. +

+
+
video_stream_expr
+

String which is evaluated using the eval API to assign colors to the generated video stream. +Variables which can be used are x, y, w, h, t, speed, +tempo, order, pattern and row. +

+
+
video_stream
+

Generate video stream. Can be 1 (on) or 0 (off). Default is 0. +

+
+
video_stream_w
+

Set video frame width in ’chars’ where one char indicates 8 pixels. Range is 20-512. Default is 30. +

+
+
video_stream_h
+

Set video frame height in ’chars’ where one char indicates 8 pixels. Range is 20-512. Default is 30. +

+
+
video_stream_ptxt
+

Print metadata on video stream. Includes speed, tempo, order, pattern, +row and ts (time in ms). Can be 1 (on) or 0 (off). Default is 1. +

+
+
+ + +

3.12 libopenmpt

+ +

libopenmpt based module demuxer +

+

See https://lib.openmpt.org/libopenmpt/ for more information. +

+

Some files have multiple subsongs (tracks) this can be set with the subsong +option. +

+

It accepts the following options: +

+
+
subsong
+

Set the subsong index. This can be either ’all’, ’auto’, or the index of the +subsong. Subsong indexes start at 0. The default is ’auto’. +

+

The default value is to let libopenmpt choose. +

+
+
layout
+

Set the channel layout. Valid values are 1, 2, and 4 channel layouts. +The default value is STEREO. +

+
+
sample_rate
+

Set the sample rate for libopenmpt to output. +Range is from 1000 to INT_MAX. The value default is 48000. +

+
+ + +

3.13 mov/mp4/3gp

+ +

Demuxer for Quicktime File Format & ISO/IEC Base Media File Format (ISO/IEC 14496-12 or MPEG-4 Part 12, ISO/IEC 15444-12 or JPEG 2000 Part 12). +

+

Registered extensions: mov, mp4, m4a, 3gp, 3g2, mj2, psp, m4b, ism, ismv, isma, f4v +

+ +

3.13.1 Options

+ +

This demuxer accepts the following options: +

+
enable_drefs
+

Enable loading of external tracks, disabled by default. +Enabling this can theoretically leak information in some use cases. +

+
+
use_absolute_path
+

Allows loading of external tracks via absolute paths, disabled by default. +Enabling this poses a security risk. It should only be enabled if the source +is known to be non-malicious. +

+
+
seek_streams_individually
+

When seeking, identify the closest point in each stream individually and demux packets in +that stream from identified point. This can lead to a different sequence of packets compared +to demuxing linearly from the beginning. Default is true. +

+
+
ignore_editlist
+

Ignore any edit list atoms. The demuxer, by default, modifies the stream index to reflect the +timeline described by the edit list. Default is false. +

+
+
advanced_editlist
+

Modify the stream index to reflect the timeline described by the edit list. ignore_editlist +must be set to false for this option to be effective. +If both ignore_editlist and this option are set to false, then only the +start of the stream index is modified to reflect initial dwell time or starting timestamp +described by the edit list. Default is true. +

+
+
ignore_chapters
+

Don’t parse chapters. This includes GoPro ’HiLight’ tags/moments. Note that chapters are +only parsed when input is seekable. Default is false. +

+
+
use_mfra_for
+

For seekable fragmented input, set fragment’s starting timestamp from media fragment random access box, if present. +

+

Following options are available: +

+
‘auto’
+

Auto-detect whether to set mfra timestamps as PTS or DTS (default) +

+
+
‘dts’
+

Set mfra timestamps as DTS +

+
+
‘pts’
+

Set mfra timestamps as PTS +

+
+
‘0’
+

Don’t use mfra box to set timestamps +

+
+ +
+
export_all
+

Export unrecognized boxes within the udta box as metadata entries. The first four +characters of the box type are set as the key. Default is false. +

+
+
export_xmp
+

Export entire contents of XMP_ box and uuid box as a string with key xmp. Note that +if export_all is set and this option isn’t, the contents of XMP_ box are still exported +but with key XMP_. Default is false. +

+
+
activation_bytes
+

4-byte key required to decrypt Audible AAX and AAX+ files. See Audible AAX subsection below. +

+
+
audible_fixed_key
+

Fixed key used for handling Audible AAX/AAX+ files. It has been pre-set so should not be necessary to +specify. +

+
+
decryption_key
+

16-byte key, in hex, to decrypt files encrypted using ISO Common Encryption (CENC/AES-128 CTR; ISO/IEC 23001-7). +

+
+ + +

3.13.2 Audible AAX

+ +

Audible AAX files are encrypted M4B files, and they can be decrypted by specifying a 4 byte activation secret. +

+
ffmpeg -activation_bytes 1CEB00DA -i test.aax -vn -c:a copy output.mp4
+
+ + +

3.14 mpegts

+ +

MPEG-2 transport stream demuxer. +

+

This demuxer accepts the following options: +

+
resync_size
+

Set size limit for looking up a new synchronization. Default value is +65536. +

+
+
skip_unknown_pmt
+

Skip PMTs for programs not defined in the PAT. Default value is 0. +

+
+
fix_teletext_pts
+

Override teletext packet PTS and DTS values with the timestamps calculated +from the PCR of the first program which the teletext stream is part of and is +not discarded. Default value is 1, set this option to 0 if you want your +teletext packet PTS and DTS values untouched. +

+
+
ts_packetsize
+

Output option carrying the raw packet size in bytes. +Show the detected raw packet size, cannot be set by the user. +

+
+
scan_all_pmts
+

Scan and combine all PMTs. The value is an integer with value from -1 +to 1 (-1 means automatic setting, 1 means enabled, 0 means +disabled). Default value is -1. +

+
+
merge_pmt_versions
+

Re-use existing streams when a PMT’s version is updated and elementary +streams move to different PIDs. Default value is 0. +

+
+ + +

3.15 mpjpeg

+ +

MJPEG encapsulated in multi-part MIME demuxer. +

+

This demuxer allows reading of MJPEG, where each frame is represented as a part of +multipart/x-mixed-replace stream. +

+
strict_mime_boundary
+

Default implementation applies a relaxed standard to multi-part MIME boundary detection, +to prevent regression with numerous existing endpoints not generating a proper MIME +MJPEG stream. Turning this option on by setting it to 1 will result in a stricter check +of the boundary value. +

+
+ + +

3.16 rawvideo

+ +

Raw video demuxer. +

+

This demuxer allows one to read raw video data. Since there is no header +specifying the assumed video parameters, the user must specify them +in order to be able to decode the data correctly. +

+

This demuxer accepts the following options: +

+
framerate
+

Set input video frame rate. Default value is 25. +

+
+
pixel_format
+

Set the input video pixel format. Default value is yuv420p. +

+
+
video_size
+

Set the input video size. This value must be specified explicitly. +

+
+ +

For example to read a rawvideo file input.raw with +ffplay, assuming a pixel format of rgb24, a video +size of 320x240, and a frame rate of 10 images per second, use +the command: +

+
ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
+
+ + +

3.17 sbg

+ +

SBaGen script demuxer. +

+

This demuxer reads the script language used by SBaGen +http://uazu.net/sbagen/ to generate binaural beats sessions. A SBG +script looks like that: +

+
-SE
+a: 300-2.5/3 440+4.5/0
+b: 300-2.5/0 440+4.5/3
+off: -
+NOW      == a
++0:07:00 == b
++0:14:00 == a
++0:21:00 == b
++0:30:00    off
+
+ +

A SBG script can mix absolute and relative timestamps. If the script uses +either only absolute timestamps (including the script start time) or only +relative ones, then its layout is fixed, and the conversion is +straightforward. On the other hand, if the script mixes both kind of +timestamps, then the NOW reference for relative timestamps will be +taken from the current time of day at the time the script is read, and the +script layout will be frozen according to that reference. That means that if +the script is directly played, the actual times will match the absolute +timestamps up to the sound controller’s clock accuracy, but if the user +somehow pauses the playback or seeks, all times will be shifted accordingly. +

+ +

3.18 tedcaptions

+ +

JSON captions used for TED Talks. +

+

TED does not provide links to the captions, but they can be guessed from the +page. The file tools/bookmarklets.html from the FFmpeg source tree +contains a bookmarklet to expose them. +

+

This demuxer accepts the following option: +

+
start_time
+

Set the start time of the TED talk, in milliseconds. The default is 15000 +(15s). It is used to sync the captions with the downloadable videos, because +they include a 15s intro. +

+
+ +

Example: convert the captions to a format most players understand: +

+
ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
+
+ + +

3.19 vapoursynth

+ +

Vapoursynth wrapper. +

+

Due to security concerns, Vapoursynth scripts will not +be autodetected so the input format has to be forced. For ff* CLI tools, +add -f vapoursynth before the input -i yourscript.vpy. +

+

This demuxer accepts the following option: +

+
max_script_size
+

The demuxer buffers the entire script into memory. Adjust this value to set the maximum buffer size, +which in turn, acts as a ceiling for the size of scripts that can be read. +Default is 1 MiB. +

+
+ + +

4 Muxers

+ +

Muxers are configured elements in FFmpeg which allow writing +multimedia streams to a particular type of file. +

+

When you configure your FFmpeg build, all the supported muxers +are enabled by default. You can list all available muxers using the +configure option --list-muxers. +

+

You can disable all the muxers with the configure option +--disable-muxers and selectively enable / disable single muxers +with the options --enable-muxer=MUXER / +--disable-muxer=MUXER. +

+

The option -muxers of the ff* tools will display the list of +enabled muxers. Use -formats to view a combined list of +enabled demuxers and muxers. +

+

A description of some of the currently available muxers follows. +

+ +

4.1 aiff

+ +

Audio Interchange File Format muxer. +

+ +

4.1.1 Options

+ +

It accepts the following options: +

+
+
write_id3v2
+

Enable ID3v2 tags writing when set to 1. Default is 0 (disabled). +

+
+
id3v2_version
+

Select ID3v2 version to write. Currently only version 3 and 4 (aka. +ID3v2.3 and ID3v2.4) are supported. The default is version 4. +

+
+
+ + +

4.2 asf

+ +

Advanced Systems Format muxer. +

+

Note that Windows Media Audio (wma) and Windows Media Video (wmv) use this +muxer too. +

+ +

4.2.1 Options

+ +

It accepts the following options: +

+
+
packet_size
+

Set the muxer packet size. By tuning this setting you may reduce data +fragmentation or muxer overhead depending on your source. Default value is +3200, minimum is 100, maximum is 64k. +

+
+
+ + +

4.3 avi

+ +

Audio Video Interleaved muxer. +

+ +

4.3.1 Options

+ +

It accepts the following options: +

+
+
reserve_index_space
+

Reserve the specified amount of bytes for the OpenDML master index of each +stream within the file header. By default additional master indexes are +embedded within the data packets if there is no space left in the first master +index and are linked together as a chain of indexes. This index structure can +cause problems for some use cases, e.g. third-party software strictly relying +on the OpenDML index specification or when file seeking is slow. Reserving +enough index space in the file header avoids these problems. +

+

The required index space depends on the output file size and should be about 16 +bytes per gigabyte. When this option is omitted or set to zero the necessary +index space is guessed. +

+
+
write_channel_mask
+

Write the channel layout mask into the audio stream header. +

+

This option is enabled by default. Disabling the channel mask can be useful in +specific scenarios, e.g. when merging multiple audio streams into one for +compatibility with software that only supports a single audio stream in AVI +(see (ffmpeg-filters)the "amerge" section in the ffmpeg-filters manual). +

+
+
+ + +

4.4 chromaprint

+ +

Chromaprint fingerprinter. +

+

This muxer feeds audio data to the Chromaprint library, +which generates a fingerprint for the provided audio data. See https://acoustid.org/chromaprint +

+

It takes a single signed native-endian 16-bit raw audio stream of at most 2 channels. +

+ +

4.4.1 Options

+ +
+
silence_threshold
+

Threshold for detecting silence. Range is from -1 to 32767, where -1 disables +silence detection. Silence detection can only be used with version 3 of the +algorithm. +Silence detection must be disabled for use with the AcoustID service. Default is -1. +

+
+
algorithm
+

Version of algorithm to fingerprint with. Range is 0 to 4. +Version 3 enables silence detection. Default is 1. +

+
+
fp_format
+

Format to output the fingerprint as. Accepts the following options: +

+
‘raw’
+

Binary raw fingerprint +

+
+
‘compressed’
+

Binary compressed fingerprint +

+
+
‘base64’
+

Base64 compressed fingerprint (default) +

+
+
+ +
+
+ + +

4.5 crc

+ +

CRC (Cyclic Redundancy Check) testing format. +

+

This muxer computes and prints the Adler-32 CRC of all the input audio +and video frames. By default audio frames are converted to signed +16-bit raw audio and video frames to raw video before computing the +CRC. +

+

The output of the muxer consists of a single line of the form: +CRC=0xCRC, where CRC is a hexadecimal number 0-padded to +8 digits containing the CRC for all the decoded input frames. +

+

See also the framecrc muxer. +

+ +

4.5.1 Examples

+ +

For example to compute the CRC of the input, and store it in the file +out.crc: +

+
ffmpeg -i INPUT -f crc out.crc
+
+ +

You can print the CRC to stdout with the command: +

+
ffmpeg -i INPUT -f crc -
+
+ +

You can select the output format of each frame with ffmpeg by +specifying the audio and video codec and format. For example to +compute the CRC of the input audio converted to PCM unsigned 8-bit +and the input video converted to MPEG-2 video, use the command: +

+
ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f crc -
+
+ + +

4.6 flv

+ +

Adobe Flash Video Format muxer. +

+

This muxer accepts the following options: +

+
+
flvflags flags
+

Possible values: +

+
+
‘aac_seq_header_detect’
+

Place AAC sequence header based on audio stream data. +

+
+
‘no_sequence_end’
+

Disable sequence end tag. +

+
+
‘no_metadata’
+

Disable metadata tag. +

+
+
‘no_duration_filesize’
+

Disable duration and filesize in metadata when they are equal to zero +at the end of stream. (Be used to non-seekable living stream). +

+
+
‘add_keyframe_index’
+

Used to facilitate seeking; particularly for HTTP pseudo streaming. +

+
+
+
+ + +

4.7 dash

+ +

Dynamic Adaptive Streaming over HTTP (DASH) muxer that creates segments +and manifest files according to the MPEG-DASH standard ISO/IEC 23009-1:2014. +

+

For more information see: +

+ + +

It creates a MPD manifest file and segment files for each stream. +

+

The segment filename might contain pre-defined identifiers used with SegmentTemplate +as defined in section 5.3.9.4.4 of the standard. Available identifiers are "$RepresentationID$", +"$Number$", "$Bandwidth$" and "$Time$". +In addition to the standard identifiers, an ffmpeg-specific "$ext$" identifier is also supported. +When specified ffmpeg will replace $ext$ in the file name with muxing format’s extensions such as mp4, webm etc., +

+
+
ffmpeg -re -i <input> -map 0 -map 0 -c:a libfdk_aac -c:v libx264 \
+-b:v:0 800k -b:v:1 300k -s:v:1 320x170 -profile:v:1 baseline \
+-profile:v:0 main -bf 1 -keyint_min 120 -g 120 -sc_threshold 0 \
+-b_strategy 0 -ar:a:1 22050 -use_timeline 1 -use_template 1 \
+-window_size 5 -adaptation_sets "id=0,streams=v id=1,streams=a" \
+-f dash /path/to/out.mpd
+
+ +
+
min_seg_duration microseconds
+

This is a deprecated option to set the segment length in microseconds, use seg_duration instead. +

+
seg_duration duration
+

Set the segment length in seconds (fractional value can be set). The value is +treated as average segment duration when use_template is enabled and +

+
frag_duration duration
+

Set the length in seconds of fragments within segments (fractional value can be set). +

+
frag_type type
+

Set the type of interval for fragmentation. +

+
window_size size
+

Set the maximum number of segments kept in the manifest. +

+
extra_window_size size
+

Set the maximum number of segments kept outside of the manifest before removing from disk. +

+
remove_at_exit remove
+

Enable (1) or disable (0) removal of all segments when finished. +

+
use_template template
+

Enable (1) or disable (0) use of SegmentTemplate instead of SegmentList. +

+
use_timeline timeline
+

Enable (1) or disable (0) use of SegmentTimeline in SegmentTemplate. +

+
single_file single_file
+

Enable (1) or disable (0) storing all segments in one file, accessed using byte ranges. +

+
single_file_name file_name
+

DASH-templated name to be used for baseURL. Implies single_file set to "1". In the template, "$ext$" is replaced with the file name extension specific for the segment format. +

+
init_seg_name init_name
+

DASH-templated name to used for the initialization segment. Default is "init-stream$RepresentationID$.$ext$". "$ext$" is replaced with the file name extension specific for the segment format. +

+
media_seg_name segment_name
+

DASH-templated name to used for the media segments. Default is "chunk-stream$RepresentationID$-$Number%05d$.$ext$". "$ext$" is replaced with the file name extension specific for the segment format. +

+
utc_timing_url utc_url
+

URL of the page that will return the UTC timestamp in ISO format. Example: "https://time.akamai.com/?iso" +

+
method method
+

Use the given HTTP method to create output files. Generally set to PUT or POST. +

+
http_user_agent user_agent
+

Override User-Agent field in HTTP header. Applicable only for HTTP output. +

+
http_persistent http_persistent
+

Use persistent HTTP connections. Applicable only for HTTP output. +

+
hls_playlist hls_playlist
+

Generate HLS playlist files as well. The master playlist is generated with the filename master.m3u8. +One media playlist file is generated for each stream with filenames media_0.m3u8, media_1.m3u8, etc. +

+
streaming streaming
+

Enable (1) or disable (0) chunk streaming mode of output. In chunk streaming +mode, each frame will be a moof fragment which forms a chunk. +

+
adaptation_sets adaptation_sets
+

Assign streams to AdaptationSets. Syntax is "id=x,streams=a,b,c id=y,streams=d,e" with x and y being the IDs +of the adaptation sets and a,b,c,d and e are the indices of the mapped streams. +

+

To map all video (or audio) streams to an AdaptationSet, "v" (or "a") can be used as stream identifier instead of IDs. +

+

When no assignment is defined, this defaults to an AdaptationSet for each stream. +

+

Optional syntax is "id=x,seg_duration=x,frag_duration=x,frag_type=type,descriptor=descriptor_string,streams=a,b,c id=y,seg_duration=y,frag_type=type,streams=d,e" and so on, +descriptor is useful to the scheme defined by ISO/IEC 23009-1:2014/Amd.2:2015. +For example, -adaptation_sets "id=0,descriptor=<SupplementalProperty schemeIdUri=\"urn:mpeg:dash:srd:2014\" value=\"0,0,0,1,1,2,2\"/>,streams=v". +Please note that descriptor string should be a self-closing xml tag. +seg_duration, frag_duration and frag_type override the global option values for each adaptation set. +For example, -adaptation_sets "id=0,seg_duration=2,frag_duration=1,frag_type=duration,streams=v id=1,seg_duration=2,frag_type=none,streams=a" +type_id marks an adaptation set as containing streams meant to be used for Trick Mode for the referenced adaptation set. +For example, -adaptation_sets "id=0,seg_duration=2,frag_type=none,streams=0 id=1,seg_duration=10,frag_type=none,trick_id=0,streams=1" +

+
timeout timeout
+

Set timeout for socket I/O operations. Applicable only for HTTP output. +

+
index_correction index_correction
+

Enable (1) or Disable (0) segment index correction logic. Applicable only when +use_template is enabled and use_timeline is disabled. +

+

When enabled, the logic monitors the flow of segment indexes. If a streams’s +segment index value is not at the expected real time position, then the logic +corrects that index value. +

+

Typically this logic is needed in live streaming use cases. The network bandwidth +fluctuations are common during long run streaming. Each fluctuation can cause +the segment indexes fall behind the expected real time position. +

+
format_options options_list
+

Set container format (mp4/webm) options using a : separated list of +key=value parameters. Values containing : special characters must be +escaped. +

+
+
global_sidx global_sidx
+

Write global SIDX atom. Applicable only for single file, mp4 output, non-streaming mode. +

+
+
dash_segment_type dash_segment_type
+

Possible values: +

+
auto
+

If this flag is set, the dash segment files format will be selected based on the stream codec. This is the default mode. +

+
+
mp4
+

If this flag is set, the dash segment files will be in in ISOBMFF format. +

+
+
webm
+

If this flag is set, the dash segment files will be in in WebM format. +

+
+ +
+
ignore_io_errors ignore_io_errors
+

Ignore IO errors during open and write. Useful for long-duration runs with network output. +

+
+
lhls lhls
+

Enable Low-latency HLS(LHLS). Adds #EXT-X-PREFETCH tag with current segment’s URI. +Apple doesn’t have an official spec for LHLS. Meanwhile hls.js player folks are +trying to standardize a open LHLS spec. The draft spec is available in https://github.com/video-dev/hlsjs-rfcs/blob/lhls-spec/proposals/0001-lhls.md +This option will also try to comply with the above open spec, till Apple’s spec officially supports it. +Applicable only when streaming and hls_playlist options are enabled. +This is an experimental feature. +

+
+
ldash ldash
+

Enable Low-latency Dash by constraining the presence and values of some elements. +

+
+
master_m3u8_publish_rate master_m3u8_publish_rate
+

Publish master playlist repeatedly every after specified number of segment intervals. +

+
+
write_prft write_prft
+

Write Producer Reference Time elements on supported streams. This also enables writing +prft boxes in the underlying muxer. Applicable only when the utc_url option is enabled. +It’s set to auto by default, in which case the muxer will attempt to enable it only in modes +that require it. +

+
+
mpd_profile mpd_profile
+

Set one or more manifest profiles. +

+
+
http_opts http_opts
+

A :-separated list of key=value options to pass to the underlying HTTP +protocol. Applicable only for HTTP output. +

+
+
target_latency target_latency
+

Set an intended target latency in seconds (fractional value can be set) for serving. Applicable only when streaming and write_prft options are enabled. +This is an informative fields clients can use to measure the latency of the service. +

+
+
min_playback_rate min_playback_rate
+

Set the minimum playback rate indicated as appropriate for the purposes of automatically +adjusting playback latency and buffer occupancy during normal playback by clients. +

+
+
max_playback_rate max_playback_rate
+

Set the maximum playback rate indicated as appropriate for the purposes of automatically +adjusting playback latency and buffer occupancy during normal playback by clients. +

+
+
+ + +

4.8 framecrc

+ +

Per-packet CRC (Cyclic Redundancy Check) testing format. +

+

This muxer computes and prints the Adler-32 CRC for each audio +and video packet. By default audio frames are converted to signed +16-bit raw audio and video frames to raw video before computing the +CRC. +

+

The output of the muxer consists of a line for each audio and video +packet of the form: +

+
stream_index, packet_dts, packet_pts, packet_duration, packet_size, 0xCRC
+
+ +

CRC is a hexadecimal number 0-padded to 8 digits containing the +CRC of the packet. +

+ +

4.8.1 Examples

+ +

For example to compute the CRC of the audio and video frames in +INPUT, converted to raw audio and video packets, and store it +in the file out.crc: +

+
ffmpeg -i INPUT -f framecrc out.crc
+
+ +

To print the information to stdout, use the command: +

+
ffmpeg -i INPUT -f framecrc -
+
+ +

With ffmpeg, you can select the output format to which the +audio and video frames are encoded before computing the CRC for each +packet by specifying the audio and video codec. For example, to +compute the CRC of each decoded input audio frame converted to PCM +unsigned 8-bit and of each decoded input video frame converted to +MPEG-2 video, use the command: +

+
ffmpeg -i INPUT -c:a pcm_u8 -c:v mpeg2video -f framecrc -
+
+ +

See also the crc muxer. +

+ +

4.9 framehash

+ +

Per-packet hash testing format. +

+

This muxer computes and prints a cryptographic hash for each audio +and video packet. This can be used for packet-by-packet equality +checks without having to individually do a binary comparison on each. +

+

By default audio frames are converted to signed 16-bit raw audio and +video frames to raw video before computing the hash, but the output +of explicit conversions to other codecs can also be used. It uses the +SHA-256 cryptographic hash function by default, but supports several +other algorithms. +

+

The output of the muxer consists of a line for each audio and video +packet of the form: +

+
stream_index, packet_dts, packet_pts, packet_duration, packet_size, hash
+
+ +

hash is a hexadecimal number representing the computed hash +for the packet. +

+
+
hash algorithm
+

Use the cryptographic hash function specified by the string algorithm. +Supported values include MD5, murmur3, RIPEMD128, +RIPEMD160, RIPEMD256, RIPEMD320, SHA160, +SHA224, SHA256 (default), SHA512/224, SHA512/256, +SHA384, SHA512, CRC32 and adler32. +

+
+
+ + +

4.9.1 Examples

+ +

To compute the SHA-256 hash of the audio and video frames in INPUT, +converted to raw audio and video packets, and store it in the file +out.sha256: +

+
ffmpeg -i INPUT -f framehash out.sha256
+
+ +

To print the information to stdout, using the MD5 hash function, use +the command: +

+
ffmpeg -i INPUT -f framehash -hash md5 -
+
+ +

See also the hash muxer. +

+ +

4.10 framemd5

+ +

Per-packet MD5 testing format. +

+

This is a variant of the framehash muxer. Unlike that muxer, +it defaults to using the MD5 hash function. +

+ +

4.10.1 Examples

+ +

To compute the MD5 hash of the audio and video frames in INPUT, +converted to raw audio and video packets, and store it in the file +out.md5: +

+
ffmpeg -i INPUT -f framemd5 out.md5
+
+ +

To print the information to stdout, use the command: +

+
ffmpeg -i INPUT -f framemd5 -
+
+ +

See also the framehash and md5 muxers. +

+ +

4.11 gif

+ +

Animated GIF muxer. +

+

It accepts the following options: +

+
+
loop
+

Set the number of times to loop the output. Use -1 for no loop, 0 +for looping indefinitely (default). +

+
+
final_delay
+

Force the delay (expressed in centiseconds) after the last frame. Each frame +ends with a delay until the next frame. The default is -1, which is a +special value to tell the muxer to re-use the previous delay. In case of a +loop, you might want to customize this value to mark a pause for instance. +

+
+ +

For example, to encode a gif looping 10 times, with a 5 seconds delay between +the loops: +

+
ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
+
+ +

Note 1: if you wish to extract the frames into separate GIF files, you need to +force the image2 muxer: +

+
ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
+
+ +

Note 2: the GIF format has a very large time base: the delay between two frames +can therefore not be smaller than one centi second. +

+ +

4.12 hash

+ +

Hash testing format. +

+

This muxer computes and prints a cryptographic hash of all the input +audio and video frames. This can be used for equality checks without +having to do a complete binary comparison. +

+

By default audio frames are converted to signed 16-bit raw audio and +video frames to raw video before computing the hash, but the output +of explicit conversions to other codecs can also be used. Timestamps +are ignored. It uses the SHA-256 cryptographic hash function by default, +but supports several other algorithms. +

+

The output of the muxer consists of a single line of the form: +algo=hash, where algo is a short string representing +the hash function used, and hash is a hexadecimal number +representing the computed hash. +

+
+
hash algorithm
+

Use the cryptographic hash function specified by the string algorithm. +Supported values include MD5, murmur3, RIPEMD128, +RIPEMD160, RIPEMD256, RIPEMD320, SHA160, +SHA224, SHA256 (default), SHA512/224, SHA512/256, +SHA384, SHA512, CRC32 and adler32. +

+
+
+ + +

4.12.1 Examples

+ +

To compute the SHA-256 hash of the input converted to raw audio and +video, and store it in the file out.sha256: +

+
ffmpeg -i INPUT -f hash out.sha256
+
+ +

To print an MD5 hash to stdout use the command: +

+
ffmpeg -i INPUT -f hash -hash md5 -
+
+ +

See also the framehash muxer. +

+ +

4.13 hls

+ +

Apple HTTP Live Streaming muxer that segments MPEG-TS according to +the HTTP Live Streaming (HLS) specification. +

+

It creates a playlist file, and one or more segment files. The output filename +specifies the playlist filename. +

+

By default, the muxer creates a file for each segment produced. These files +have the same name as the playlist, followed by a sequential number and a +.ts extension. +

+

Make sure to require a closed GOP when encoding and to set the GOP +size to fit your segment time constraint. +

+

For example, to convert an input file with ffmpeg: +

+
ffmpeg -i in.mkv -c:v h264 -flags +cgop -g 30 -hls_time 1 out.m3u8
+
+

This example will produce the playlist, out.m3u8, and segment files: +out0.ts, out1.ts, out2.ts, etc. +

+

See also the segment muxer, which provides a more generic and +flexible implementation of a segmenter, and can be used to perform HLS +segmentation. +

+ +

4.13.1 Options

+ +

This muxer supports the following options: +

+
+
hls_init_time seconds
+

Set the initial target segment length in seconds. Default value is 0. +Segment will be cut on the next key frame after this time has passed on the first m3u8 list. +After the initial playlist is filled ffmpeg will cut segments +at duration equal to hls_time +

+
+
hls_time seconds
+

Set the target segment length in seconds. Default value is 2. +Segment will be cut on the next key frame after this time has passed. +

+
+
hls_list_size size
+

Set the maximum number of playlist entries. If set to 0 the list file +will contain all the segments. Default value is 5. +

+
+
hls_delete_threshold size
+

Set the number of unreferenced segments to keep on disk before hls_flags delete_segments +deletes them. Increase this to allow continue clients to download segments which +were recently referenced in the playlist. Default value is 1, meaning segments older than +hls_list_size+1 will be deleted. +

+
+
hls_ts_options options_list
+

Set output format options using a :-separated list of key=value +parameters. Values containing : special characters must be +escaped. +

+
+
hls_wrap wrap
+

This is a deprecated option, you can use hls_list_size +and hls_flags delete_segments instead it +

+

This option is useful to avoid to fill the disk with many segment +files, and limits the maximum number of segment files written to disk +to wrap. +

+ +
+
hls_start_number_source
+

Start the playlist sequence number (#EXT-X-MEDIA-SEQUENCE) according to the specified source. +Unless hls_flags single_file is set, it also specifies source of starting sequence numbers of +segment and subtitle filenames. In any case, if hls_flags append_list +is set and read playlist sequence number is greater than the specified start sequence number, +then that value will be used as start value. +

+

It accepts the following values: +

+
+
generic (default)
+

Set the starting sequence numbers according to start_number option value. +

+
+
epoch
+

The start number will be the seconds since epoch (1970-01-01 00:00:00) +

+
+
epoch_us
+

The start number will be the microseconds since epoch (1970-01-01 00:00:00) +

+
+
datetime
+

The start number will be based on the current date/time as YYYYmmddHHMMSS. e.g. 20161231235759. +

+
+
+ +
+
start_number number
+

Start the playlist sequence number (#EXT-X-MEDIA-SEQUENCE) from the specified number +when hls_start_number_source value is generic. (This is the default case.) +Unless hls_flags single_file is set, it also specifies starting sequence numbers of segment and subtitle filenames. +Default value is 0. +

+
+
hls_allow_cache allowcache
+

Explicitly set whether the client MAY (1) or MUST NOT (0) cache media segments. +

+
+
hls_base_url baseurl
+

Append baseurl to every entry in the playlist. +Useful to generate playlists with absolute paths. +

+

Note that the playlist sequence number must be unique for each segment +and it is not to be confused with the segment filename sequence number +which can be cyclic, for example if the wrap option is +specified. +

+
+
hls_segment_filename filename
+

Set the segment filename. Unless hls_flags single_file is set, +filename is used as a string format with the segment number: +

+
ffmpeg -i in.nut -hls_segment_filename 'file%03d.ts' out.m3u8
+
+

This example will produce the playlist, out.m3u8, and segment files: +file000.ts, file001.ts, file002.ts, etc. +

+

filename may contain full path or relative path specification, +but only the file name part without any path info will be contained in the m3u8 segment list. +Should a relative path be specified, the path of the created segment +files will be relative to the current working directory. +When strftime_mkdir is set, the whole expanded value of filename will be written into the m3u8 segment list. +

+

When var_stream_map is set with two or more variant streams, the +filename pattern must contain the string "%v", this string specifies +the position of variant stream index in the generated segment file names. +

+
ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
+  -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
+  -hls_segment_filename 'file_%v_%03d.ts' out_%v.m3u8
+
+

This example will produce the playlists segment file sets: +file_0_000.ts, file_0_001.ts, file_0_002.ts, etc. and +file_1_000.ts, file_1_001.ts, file_1_002.ts, etc. +

+

The string "%v" may be present in the filename or in the last directory name +containing the file, but only in one of them. (Additionally, %v may appear multiple times in the last +sub-directory or filename.) If the string %v is present in the directory name, then +sub-directories are created after expanding the directory name pattern. This +enables creation of segments corresponding to different variant streams in +subdirectories. +

+
ffmpeg -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
+  -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
+  -hls_segment_filename 'vs%v/file_%03d.ts' vs%v/out.m3u8
+
+

This example will produce the playlists segment file sets: +vs0/file_000.ts, vs0/file_001.ts, vs0/file_002.ts, etc. and +vs1/file_000.ts, vs1/file_001.ts, vs1/file_002.ts, etc. +

+
+
use_localtime
+

Same as strftime option, will be deprecated. +

+
+
strftime
+

Use strftime() on filename to expand the segment filename with localtime. +The segment number is also available in this mode, but to use it, you need to specify second_level_segment_index +hls_flag and %%d will be the specifier. +

+
ffmpeg -i in.nut -strftime 1 -hls_segment_filename 'file-%Y%m%d-%s.ts' out.m3u8
+
+

This example will produce the playlist, out.m3u8, and segment files: +file-20160215-1455569023.ts, file-20160215-1455569024.ts, etc. +Note: On some systems/environments, the %s specifier is not available. See + strftime() documentation. +

+
ffmpeg -i in.nut -strftime 1 -hls_flags second_level_segment_index -hls_segment_filename 'file-%Y%m%d-%%04d.ts' out.m3u8
+
+

This example will produce the playlist, out.m3u8, and segment files: +file-20160215-0001.ts, file-20160215-0002.ts, etc. +

+
+
use_localtime_mkdir
+

Same as strftime_mkdir option, will be deprecated . +

+
+
strftime_mkdir
+

Used together with -strftime_mkdir, it will create all subdirectories which +is expanded in filename. +

+
ffmpeg -i in.nut -strftime 1 -strftime_mkdir 1 -hls_segment_filename '%Y%m%d/file-%Y%m%d-%s.ts' out.m3u8
+
+

This example will create a directory 201560215 (if it does not exist), and then +produce the playlist, out.m3u8, and segment files: +20160215/file-20160215-1455569023.ts, 20160215/file-20160215-1455569024.ts, etc. +

+
+
ffmpeg -i in.nut -strftime 1 -strftime_mkdir 1 -hls_segment_filename '%Y/%m/%d/file-%Y%m%d-%s.ts' out.m3u8
+
+

This example will create a directory hierarchy 2016/02/15 (if any of them do not exist), and then +produce the playlist, out.m3u8, and segment files: +2016/02/15/file-20160215-1455569023.ts, 2016/02/15/file-20160215-1455569024.ts, etc. +

+ +
+
hls_key_info_file key_info_file
+

Use the information in key_info_file for segment encryption. The first +line of key_info_file specifies the key URI written to the playlist. The +key URL is used to access the encryption key during playback. The second line +specifies the path to the key file used to obtain the key during the encryption +process. The key file is read as a single packed array of 16 octets in binary +format. The optional third line specifies the initialization vector (IV) as a +hexadecimal string to be used instead of the segment sequence number (default) +for encryption. Changes to key_info_file will result in segment +encryption with the new key/IV and an entry in the playlist for the new key +URI/IV if hls_flags periodic_rekey is enabled. +

+

Key info file format: +

+
key URI
+key file path
+IV (optional)
+
+ +

Example key URIs: +

+
http://server/file.key
+/path/to/file.key
+file.key
+
+ +

Example key file paths: +

+
file.key
+/path/to/file.key
+
+ +

Example IV: +

+
0123456789ABCDEF0123456789ABCDEF
+
+ +

Key info file example: +

+
http://server/file.key
+/path/to/file.key
+0123456789ABCDEF0123456789ABCDEF
+
+ +

Example shell script: +

+
#!/bin/sh
+BASE_URL=${1:-'.'}
+openssl rand 16 > file.key
+echo $BASE_URL/file.key > file.keyinfo
+echo file.key >> file.keyinfo
+echo $(openssl rand -hex 16) >> file.keyinfo
+ffmpeg -f lavfi -re -i testsrc -c:v h264 -hls_flags delete_segments \
+  -hls_key_info_file file.keyinfo out.m3u8
+
+ +
+
-hls_enc enc
+

Enable (1) or disable (0) the AES128 encryption. +When enabled every segment generated is encrypted and the encryption key +is saved as playlist name.key. +

+
+
-hls_enc_key key
+

Hex-coded 16byte key to encrypt the segments, by default it +is randomly generated. +

+
+
-hls_enc_key_url keyurl
+

If set, keyurl is prepended instead of baseurl to the key filename +in the playlist. +

+
+
-hls_enc_iv iv
+

Hex-coded 16byte initialization vector for every segment instead +of the autogenerated ones. +

+
+
hls_segment_type flags
+

Possible values: +

+
+
‘mpegts’
+

Output segment files in MPEG-2 Transport Stream format. This is +compatible with all HLS versions. +

+
+
‘fmp4’
+

Output segment files in fragmented MP4 format, similar to MPEG-DASH. +fmp4 files may be used in HLS version 7 and above. +

+
+
+ +
+
hls_fmp4_init_filename filename
+

Set filename to the fragment files header file, default filename is init.mp4. +

+
+
hls_fmp4_init_resend
+

Resend init file after m3u8 file refresh every time, default is 0. +

+

When var_stream_map is set with two or more variant streams, the +filename pattern must contain the string "%v", this string specifies +the position of variant stream index in the generated init file names. +The string "%v" may be present in the filename or in the last directory name +containing the file. If the string is present in the directory name, then +sub-directories are created after expanding the directory name pattern. This +enables creation of init files corresponding to different variant streams in +subdirectories. +

+
+
hls_flags flags
+

Possible values: +

+
+
‘single_file’
+

If this flag is set, the muxer will store all segments in a single MPEG-TS +file, and will use byte ranges in the playlist. HLS playlists generated with +this way will have the version number 4. +For example: +

+
ffmpeg -i in.nut -hls_flags single_file out.m3u8
+
+

Will produce the playlist, out.m3u8, and a single segment file, +out.ts. +

+
+
‘delete_segments’
+

Segment files removed from the playlist are deleted after a period of time +equal to the duration of the segment plus the duration of the playlist. +

+
+
‘append_list’
+

Append new segments into the end of old segment list, +and remove the #EXT-X-ENDLIST from the old segment list. +

+
+
‘round_durations’
+

Round the duration info in the playlist file segment info to integer +values, instead of using floating point. +

+
+
‘discont_start’
+

Add the #EXT-X-DISCONTINUITY tag to the playlist, before the +first segment’s information. +

+
+
‘omit_endlist’
+

Do not append the EXT-X-ENDLIST tag at the end of the playlist. +

+
+
‘periodic_rekey’
+

The file specified by hls_key_info_file will be checked periodically and +detect updates to the encryption info. Be sure to replace this file atomically, +including the file containing the AES encryption key. +

+
+
‘independent_segments’
+

Add the #EXT-X-INDEPENDENT-SEGMENTS to playlists that has video segments +and when all the segments of that playlist are guaranteed to start with a Key frame. +

+
+
‘iframes_only’
+

Add the #EXT-X-I-FRAMES-ONLY to playlists that has video segments +and can play only I-frames in the #EXT-X-BYTERANGE mode. +

+
+
‘split_by_time’
+

Allow segments to start on frames other than keyframes. This improves +behavior on some players when the time between keyframes is inconsistent, +but may make things worse on others, and can cause some oddities during +seeking. This flag should be used with the hls_time option. +

+
+
‘program_date_time’
+

Generate EXT-X-PROGRAM-DATE-TIME tags. +

+
+
‘second_level_segment_index’
+

Makes it possible to use segment indexes as %%d in hls_segment_filename expression +besides date/time values when strftime is on. +To get fixed width numbers with trailing zeroes, %%0xd format is available where x is the required width. +

+
+
‘second_level_segment_size’
+

Makes it possible to use segment sizes (counted in bytes) as %%s in hls_segment_filename +expression besides date/time values when strftime is on. +To get fixed width numbers with trailing zeroes, %%0xs format is available where x is the required width. +

+
+
‘second_level_segment_duration’
+

Makes it possible to use segment duration (calculated in microseconds) as %%t in hls_segment_filename +expression besides date/time values when strftime is on. +To get fixed width numbers with trailing zeroes, %%0xt format is available where x is the required width. +

+
+
ffmpeg -i sample.mpeg \
+   -f hls -hls_time 3 -hls_list_size 5 \
+   -hls_flags second_level_segment_index+second_level_segment_size+second_level_segment_duration \
+   -strftime 1 -strftime_mkdir 1 -hls_segment_filename "segment_%Y%m%d%H%M%S_%%04d_%%08s_%%013t.ts" stream.m3u8
+
+

This will produce segments like this: +segment_20170102194334_0003_00122200_0000003000000.ts, segment_20170102194334_0004_00120072_0000003000000.ts etc. +

+
+
‘temp_file’
+

Write segment data to filename.tmp and rename to filename only once the segment is complete. A webserver +serving up segments can be configured to reject requests to *.tmp to prevent access to in-progress segments +before they have been added to the m3u8 playlist. This flag also affects how m3u8 playlist files are created. +If this flag is set, all playlist files will written into temporary file and renamed after they are complete, similarly as segments are handled. +But playlists with file protocol and with type (hls_playlist_type) other than vod +are always written into temporary file regardless of this flag. Master playlist files (master_pl_name), if any, with file protocol, +are always written into temporary file regardless of this flag if master_pl_publish_rate value is other than zero. +

+
+
+ +
+
hls_playlist_type event
+

Emit #EXT-X-PLAYLIST-TYPE:EVENT in the m3u8 header. Forces +hls_list_size to 0; the playlist can only be appended to. +

+
+
hls_playlist_type vod
+

Emit #EXT-X-PLAYLIST-TYPE:VOD in the m3u8 header. Forces +hls_list_size to 0; the playlist must not change. +

+
+
method
+

Use the given HTTP method to create the hls files. +

+
ffmpeg -re -i in.ts -f hls -method PUT http://example.com/live/out.m3u8
+
+

This example will upload all the mpegts segment files to the HTTP +server using the HTTP PUT method, and update the m3u8 files every +refresh times using the same method. +Note that the HTTP server must support the given method for uploading +files. +

+
+
http_user_agent
+

Override User-Agent field in HTTP header. Applicable only for HTTP output. +

+
+
var_stream_map
+

Map string which specifies how to group the audio, video and subtitle streams +into different variant streams. The variant stream groups are separated +by space. +Expected string format is like this "a:0,v:0 a:1,v:1 ....". Here a:, v:, s: are +the keys to specify audio, video and subtitle streams respectively. +Allowed values are 0 to 9 (limited just based on practical usage). +

+

When there are two or more variant streams, the output filename pattern must +contain the string "%v", this string specifies the position of variant stream +index in the output media playlist filenames. The string "%v" may be present in +the filename or in the last directory name containing the file. If the string is +present in the directory name, then sub-directories are created after expanding +the directory name pattern. This enables creation of variant streams in +subdirectories. +

+
+
ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
+  -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
+  http://example.com/live/out_%v.m3u8
+
+

This example creates two hls variant streams. The first variant stream will +contain video stream of bitrate 1000k and audio stream of bitrate 64k and the +second variant stream will contain video stream of bitrate 256k and audio +stream of bitrate 32k. Here, two media playlist with file names out_0.m3u8 and +out_1.m3u8 will be created. If you want something meaningful text instead of indexes +in result names, you may specify names for each or some of the variants +as in the following example. +

+ +
+
ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
+  -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0,name:my_hd v:1,a:1,name:my_sd" \
+  http://example.com/live/out_%v.m3u8
+
+ +

This example creates two hls variant streams as in the previous one. +But here, the two media playlist with file names out_my_hd.m3u8 and +out_my_sd.m3u8 will be created. +

+
+
ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k \
+  -map 0:v -map 0:a -map 0:v -f hls -var_stream_map "v:0 a:0 v:1" \
+  http://example.com/live/out_%v.m3u8
+
+

This example creates three hls variant streams. The first variant stream will +be a video only stream with video bitrate 1000k, the second variant stream will +be an audio only stream with bitrate 64k and the third variant stream will be a +video only stream with bitrate 256k. Here, three media playlist with file names +out_0.m3u8, out_1.m3u8 and out_2.m3u8 will be created. +

+
ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
+  -map 0:v -map 0:a -map 0:v -map 0:a -f hls -var_stream_map "v:0,a:0 v:1,a:1" \
+  http://example.com/live/vs_%v/out.m3u8
+
+

This example creates the variant streams in subdirectories. Here, the first +media playlist is created at http://example.com/live/vs_0/out.m3u8 and +the second one at http://example.com/live/vs_1/out.m3u8. +

+
ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k -b:v:1 3000k  \
+  -map 0:a -map 0:a -map 0:v -map 0:v -f hls \
+  -var_stream_map "a:0,agroup:aud_low a:1,agroup:aud_high v:0,agroup:aud_low v:1,agroup:aud_high" \
+  -master_pl_name master.m3u8 \
+  http://example.com/live/out_%v.m3u8
+
+

This example creates two audio only and two video only variant streams. In +addition to the #EXT-X-STREAM-INF tag for each variant stream in the master +playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams +and they are mapped to the two video only variant streams with audio group names +’aud_low’ and ’aud_high’. +

+

By default, a single hls variant containing all the encoded streams is created. +

+
+
ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k \
+  -map 0:a -map 0:a -map 0:v -f hls \
+  -var_stream_map "a:0,agroup:aud_low,default:yes a:1,agroup:aud_low v:0,agroup:aud_low" \
+  -master_pl_name master.m3u8 \
+  http://example.com/live/out_%v.m3u8
+
+

This example creates two audio only and one video only variant streams. In +addition to the #EXT-X-STREAM-INF tag for each variant stream in the master +playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams +and they are mapped to the one video only variant streams with audio group name +’aud_low’, and the audio group have default stat is NO or YES. +

+

By default, a single hls variant containing all the encoded streams is created. +

+
+
ffmpeg -re -i in.ts -b:a:0 32k -b:a:1 64k -b:v:0 1000k \
+  -map 0:a -map 0:a -map 0:v -f hls \
+  -var_stream_map "a:0,agroup:aud_low,default:yes,language:ENG a:1,agroup:aud_low,language:CHN v:0,agroup:aud_low" \
+  -master_pl_name master.m3u8 \
+  http://example.com/live/out_%v.m3u8
+
+

This example creates two audio only and one video only variant streams. In +addition to the #EXT-X-STREAM-INF tag for each variant stream in the master +playlist, #EXT-X-MEDIA tag is also added for the two audio only variant streams +and they are mapped to the one video only variant streams with audio group name +’aud_low’, and the audio group have default stat is NO or YES, and one audio +have and language is named ENG, the other audio language is named CHN. +

+

By default, a single hls variant containing all the encoded streams is created. +

+
+
ffmpeg -y -i input_with_subtitle.mkv \
+ -b:v:0 5250k -c:v h264 -pix_fmt yuv420p -profile:v main -level 4.1 \
+ -b:a:0 256k \
+ -c:s webvtt -c:a mp2 -ar 48000 -ac 2 -map 0:v -map 0:a:0 -map 0:s:0 \
+ -f hls -var_stream_map "v:0,a:0,s:0,sgroup:subtitle" \
+ -master_pl_name master.m3u8 -t 300 -hls_time 10 -hls_init_time 4 -hls_list_size \
+ 10 -master_pl_publish_rate 10  -hls_flags \
+ delete_segments+discont_start+split_by_time ./tmp/video.m3u8
+
+ +

This example adds #EXT-X-MEDIA tag with TYPE=SUBTITLES in +the master playlist with webvtt subtitle group name ’subtitle’. Please make sure +the input file has one text subtitle stream at least. +

+
+
cc_stream_map
+

Map string which specifies different closed captions groups and their +attributes. The closed captions stream groups are separated by space. +Expected string format is like this +"ccgroup:<group name>,instreamid:<INSTREAM-ID>,language:<language code> ....". +’ccgroup’ and ’instreamid’ are mandatory attributes. ’language’ is an optional +attribute. +The closed captions groups configured using this option are mapped to different +variant streams by providing the same ’ccgroup’ name in the +var_stream_map string. If var_stream_map is not set, then the +first available ccgroup in cc_stream_map is mapped to the output variant +stream. The examples for these two use cases are given below. +

+
+
ffmpeg -re -i in.ts -b:v 1000k -b:a 64k -a53cc 1 -f hls \
+  -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en" \
+  -master_pl_name master.m3u8 \
+  http://example.com/live/out.m3u8
+
+

This example adds #EXT-X-MEDIA tag with TYPE=CLOSED-CAPTIONS in +the master playlist with group name ’cc’, language ’en’ (english) and +INSTREAM-ID ’CC1’. Also, it adds CLOSED-CAPTIONS attribute with group +name ’cc’ for the output variant stream. +

+
ffmpeg -re -i in.ts -b:v:0 1000k -b:v:1 256k -b:a:0 64k -b:a:1 32k \
+  -a53cc:0 1 -a53cc:1 1\
+  -map 0:v -map 0:a -map 0:v -map 0:a -f hls \
+  -cc_stream_map "ccgroup:cc,instreamid:CC1,language:en ccgroup:cc,instreamid:CC2,language:sp" \
+  -var_stream_map "v:0,a:0,ccgroup:cc v:1,a:1,ccgroup:cc" \
+  -master_pl_name master.m3u8 \
+  http://example.com/live/out_%v.m3u8
+
+

This example adds two #EXT-X-MEDIA tags with TYPE=CLOSED-CAPTIONS in +the master playlist for the INSTREAM-IDs ’CC1’ and ’CC2’. Also, it adds +CLOSED-CAPTIONS attribute with group name ’cc’ for the two output variant +streams. +

+
+
master_pl_name
+

Create HLS master playlist with the given name. +

+
+
ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 http://example.com/live/out.m3u8
+
+

This example creates HLS master playlist with name master.m3u8 and it is +published at http://example.com/live/ +

+
+
master_pl_publish_rate
+

Publish master play list repeatedly every after specified number of segment intervals. +

+
+
ffmpeg -re -i in.ts -f hls -master_pl_name master.m3u8 \
+-hls_time 2 -master_pl_publish_rate 30 http://example.com/live/out.m3u8
+
+ +

This example creates HLS master playlist with name master.m3u8 and keep +publishing it repeatedly every after 30 segments i.e. every after 60s. +

+
+
http_persistent
+

Use persistent HTTP connections. Applicable only for HTTP output. +

+
+
timeout
+

Set timeout for socket I/O operations. Applicable only for HTTP output. +

+
+
-ignore_io_errors
+

Ignore IO errors during open, write and delete. Useful for long-duration runs with network output. +

+
+
headers
+

Set custom HTTP headers, can override built in default headers. Applicable only for HTTP output. +

+
+
+ + +

4.14 ico

+ +

ICO file muxer. +

+

Microsoft’s icon file format (ICO) has some strict limitations that should be noted: +

+
    +
  • Size cannot exceed 256 pixels in any dimension + +
  • Only BMP and PNG images can be stored + +
  • If a BMP image is used, it must be one of the following pixel formats: +
    +
    BMP Bit Depth      FFmpeg Pixel Format
+1bit               pal8
+4bit               pal8
+8bit               pal8
+16bit              rgb555le
+24bit              bgr24
+32bit              bgra
+
    + +
  • If a BMP image is used, it must use the BITMAPINFOHEADER DIB header + +
  • If a PNG image is used, it must use the rgba pixel format +
+ + +

4.15 image2

+ +

Image file muxer. +

+

The image file muxer writes video frames to image files. +

+

The output filenames are specified by a pattern, which can be used to +produce sequentially numbered series of files. +The pattern may contain the string "%d" or "%0Nd", this string +specifies the position of the characters representing a numbering in +the filenames. If the form "%0Nd" is used, the string +representing the number in each filename is 0-padded to N +digits. The literal character ’%’ can be specified in the pattern with +the string "%%". +

+

If the pattern contains "%d" or "%0Nd", the first filename of +the file list specified will contain the number 1, all the following +numbers will be sequential. +

+

The pattern may contain a suffix which is used to automatically +determine the format of the image files to write. +

+

For example the pattern "img-%03d.bmp" will specify a sequence of +filenames of the form img-001.bmp, img-002.bmp, ..., +img-010.bmp, etc. +The pattern "img%%-%d.jpg" will specify a sequence of filenames of the +form img%-1.jpg, img%-2.jpg, ..., img%-10.jpg, +etc. +

+

The image muxer supports the .Y.U.V image file format. This format is +special in that that each image frame consists of three files, for +each of the YUV420P components. To read or write this image file format, +specify the name of the ’.Y’ file. The muxer will automatically open the +’.U’ and ’.V’ files as required. +

+ +

4.15.1 Options

+ +
+
frame_pts
+

If set to 1, expand the filename with pts from pkt->pts. +Default value is 0. +

+
+
start_number
+

Start the sequence from the specified number. Default value is 1. +

+
+
update
+

If set to 1, the filename will always be interpreted as just a +filename, not a pattern, and the corresponding file will be continuously +overwritten with new images. Default value is 0. +

+
+
strftime
+

If set to 1, expand the filename with date and time information from +strftime(). Default value is 0. +

+
+
protocol_opts options_list
+

Set protocol options as a :-separated list of key=value parameters. Values +containing the : special character must be escaped. +

+
+
+ + +

4.15.2 Examples

+ +

The following example shows how to use ffmpeg for creating a +sequence of files img-001.jpeg, img-002.jpeg, ..., +taking one image every second from the input video: +

+
ffmpeg -i in.avi -vsync cfr -r 1 -f image2 'img-%03d.jpeg'
+
+ +

Note that with ffmpeg, if the format is not specified with the +-f option and the output filename specifies an image file +format, the image2 muxer is automatically selected, so the previous +command can be written as: +

+
ffmpeg -i in.avi -vsync cfr -r 1 'img-%03d.jpeg'
+
+ +

Note also that the pattern must not necessarily contain "%d" or +"%0Nd", for example to create a single image file +img.jpeg from the start of the input video you can employ the command: +

+
ffmpeg -i in.avi -f image2 -frames:v 1 img.jpeg
+
+ +

The strftime option allows you to expand the filename with +date and time information. Check the documentation of +the strftime() function for the syntax. +

+

For example to generate image files from the strftime() +"%Y-%m-%d_%H-%M-%S" pattern, the following ffmpeg command +can be used: +

+
ffmpeg -f v4l2 -r 1 -i /dev/video0 -f image2 -strftime 1 "%Y-%m-%d_%H-%M-%S.jpg"
+
+ +

You can set the file name with current frame’s PTS: +

+
ffmpeg -f v4l2 -r 1 -i /dev/video0 -copyts -f image2 -frame_pts true %d.jpg"
+
+ +

A more complex example is to publish contents of your desktop directly to a +WebDAV server every second: +

+
ffmpeg -f x11grab -framerate 1 -i :0.0 -q:v 6 -update 1 -protocol_opts method=PUT http://example.com/desktop.jpg
+
+ + +

4.16 matroska

+ +

Matroska container muxer. +

+

This muxer implements the matroska and webm container specs. +

+ +

4.16.1 Metadata

+ +

The recognized metadata settings in this muxer are: +

+
+
title
+

Set title name provided to a single track. This gets mapped to +the FileDescription element for a stream written as attachment. +

+
+
language
+

Specify the language of the track in the Matroska languages form. +

+

The language can be either the 3 letters bibliographic ISO-639-2 (ISO +639-2/B) form (like "fre" for French), or a language code mixed with a +country code for specialities in languages (like "fre-ca" for Canadian +French). +

+
+
stereo_mode
+

Set stereo 3D video layout of two views in a single video track. +

+

The following values are recognized: +

+
‘mono’
+

video is not stereo +

+
‘left_right’
+

Both views are arranged side by side, Left-eye view is on the left +

+
‘bottom_top’
+

Both views are arranged in top-bottom orientation, Left-eye view is at bottom +

+
‘top_bottom’
+

Both views are arranged in top-bottom orientation, Left-eye view is on top +

+
‘checkerboard_rl’
+

Each view is arranged in a checkerboard interleaved pattern, Left-eye view being first +

+
‘checkerboard_lr’
+

Each view is arranged in a checkerboard interleaved pattern, Right-eye view being first +

+
‘row_interleaved_rl’
+

Each view is constituted by a row based interleaving, Right-eye view is first row +

+
‘row_interleaved_lr’
+

Each view is constituted by a row based interleaving, Left-eye view is first row +

+
‘col_interleaved_rl’
+

Both views are arranged in a column based interleaving manner, Right-eye view is first column +

+
‘col_interleaved_lr’
+

Both views are arranged in a column based interleaving manner, Left-eye view is first column +

+
‘anaglyph_cyan_red’
+

All frames are in anaglyph format viewable through red-cyan filters +

+
‘right_left’
+

Both views are arranged side by side, Right-eye view is on the left +

+
‘anaglyph_green_magenta’
+

All frames are in anaglyph format viewable through green-magenta filters +

+
‘block_lr’
+

Both eyes laced in one Block, Left-eye view is first +

+
‘block_rl’
+

Both eyes laced in one Block, Right-eye view is first +

+
+
+
+ +

For example a 3D WebM clip can be created using the following command line: +

+
ffmpeg -i sample_left_right_clip.mpg -an -c:v libvpx -metadata stereo_mode=left_right -y stereo_clip.webm
+
+ + +

4.16.2 Options

+ +

This muxer supports the following options: +

+
+
reserve_index_space
+

By default, this muxer writes the index for seeking (called cues in Matroska +terms) at the end of the file, because it cannot know in advance how much space +to leave for the index at the beginning of the file. However for some use cases +– e.g. streaming where seeking is possible but slow – it is useful to put the +index at the beginning of the file. +

+

If this option is set to a non-zero value, the muxer will reserve a given amount +of space in the file header and then try to write the cues there when the muxing +finishes. If the reserved space does not suffice, no Cues will be written, the +file will be finalized and writing the trailer will return an error. +A safe size for most use cases should be about 50kB per hour of video. +

+

Note that cues are only written if the output is seekable and this option will +have no effect if it is not. +

+
default_mode
+

This option controls how the FlagDefault of the output tracks will be set. +It influences which tracks players should play by default. The default mode +is ‘infer’. +

+
‘infer’
+

In this mode, for each type of track (audio, video or subtitle), if there is +a track with disposition default of this type, then the first such track +(i.e. the one with the lowest index) will be marked as default; if no such +track exists, the first track of this type will be marked as default instead +(if existing). This ensures that the default flag is set in a sensible way even +if the input originated from containers that lack the concept of default tracks. +

+
‘infer_no_subs’
+

This mode is the same as infer except that if no subtitle track with +disposition default exists, no subtitle track will be marked as default. +

+
‘passthrough’
+

In this mode the FlagDefault is set if and only if the AV_DISPOSITION_DEFAULT +flag is set in the disposition of the corresponding stream. +

+
+
+
+ + +

4.17 md5

+ +

MD5 testing format. +

+

This is a variant of the hash muxer. Unlike that muxer, it +defaults to using the MD5 hash function. +

+ +

4.17.1 Examples

+ +

To compute the MD5 hash of the input converted to raw +audio and video, and store it in the file out.md5: +

+
ffmpeg -i INPUT -f md5 out.md5
+
+ +

You can print the MD5 to stdout with the command: +

+
ffmpeg -i INPUT -f md5 -
+
+ +

See also the hash and framemd5 muxers. +

+ +

4.18 mov, mp4, ismv

+ +

MOV/MP4/ISMV (Smooth Streaming) muxer. +

+

The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4 +file has all the metadata about all packets stored in one location +(written at the end of the file, it can be moved to the start for +better playback by adding faststart to the movflags, or +using the qt-faststart tool). A fragmented +file consists of a number of fragments, where packets and metadata +about these packets are stored together. Writing a fragmented +file has the advantage that the file is decodable even if the +writing is interrupted (while a normal MOV/MP4 is undecodable if +it is not properly finished), and it requires less memory when writing +very long files (since writing normal MOV/MP4 files stores info about +every single packet in memory until the file is closed). The downside +is that it is less compatible with other applications. +

+ +

4.18.1 Options

+ +

Fragmentation is enabled by setting one of the AVOptions that define +how to cut the file into fragments: +

+
+
-moov_size bytes
+

Reserves space for the moov atom at the beginning of the file instead of placing the +moov atom at the end. If the space reserved is insufficient, muxing will fail. +

+
-movflags frag_keyframe
+

Start a new fragment at each video keyframe. +

+
-frag_duration duration
+

Create fragments that are duration microseconds long. +

+
-frag_size size
+

Create fragments that contain up to size bytes of payload data. +

+
-movflags frag_custom
+

Allow the caller to manually choose when to cut fragments, by +calling av_write_frame(ctx, NULL) to write a fragment with +the packets written so far. (This is only useful with other +applications integrating libavformat, not from ffmpeg.) +

+
-min_frag_duration duration
+

Don’t create fragments that are shorter than duration microseconds long. +

+
+ +

If more than one condition is specified, fragments are cut when +one of the specified conditions is fulfilled. The exception to this is +-min_frag_duration, which has to be fulfilled for any of the other +conditions to apply. +

+

Additionally, the way the output file is written can be adjusted +through a few other options: +

+
+
-movflags empty_moov
+

Write an initial moov atom directly at the start of the file, without +describing any samples in it. Generally, an mdat/moov pair is written +at the start of the file, as a normal MOV/MP4 file, containing only +a short portion of the file. With this option set, there is no initial +mdat atom, and the moov atom only describes the tracks but has +a zero duration. +

+

This option is implicitly set when writing ismv (Smooth Streaming) files. +

+
-movflags separate_moof
+

Write a separate moof (movie fragment) atom for each track. Normally, +packets for all tracks are written in a moof atom (which is slightly +more efficient), but with this option set, the muxer writes one moof/mdat +pair for each track, making it easier to separate tracks. +

+

This option is implicitly set when writing ismv (Smooth Streaming) files. +

+
-movflags skip_sidx
+

Skip writing of sidx atom. When bitrate overhead due to sidx atom is high, +this option could be used for cases where sidx atom is not mandatory. +When global_sidx flag is enabled, this option will be ignored. +

+
-movflags faststart
+

Run a second pass moving the index (moov atom) to the beginning of the file. +This operation can take a while, and will not work in various situations such +as fragmented output, thus it is not enabled by default. +

+
-movflags rtphint
+

Add RTP hinting tracks to the output file. +

+
-movflags disable_chpl
+

Disable Nero chapter markers (chpl atom). Normally, both Nero chapters +and a QuickTime chapter track are written to the file. With this option +set, only the QuickTime chapter track will be written. Nero chapters can +cause failures when the file is reprocessed with certain tagging programs, like +mp3Tag 2.61a and iTunes 11.3, most likely other versions are affected as well. +

+
-movflags omit_tfhd_offset
+

Do not write any absolute base_data_offset in tfhd atoms. This avoids +tying fragments to absolute byte positions in the file/streams. +

+
-movflags default_base_moof
+

Similarly to the omit_tfhd_offset, this flag avoids writing the +absolute base_data_offset field in tfhd atoms, but does so by using +the new default-base-is-moof flag instead. This flag is new from +14496-12:2012. This may make the fragments easier to parse in certain +circumstances (avoiding basing track fragment location calculations +on the implicit end of the previous track fragment). +

+
-write_tmcd
+

Specify on to force writing a timecode track, off to disable it +and auto to write a timecode track only for mov and mp4 output (default). +

+
-movflags negative_cts_offsets
+

Enables utilization of version 1 of the CTTS box, in which the CTS offsets can +be negative. This enables the initial sample to have DTS/CTS of zero, and +reduces the need for edit lists for some cases such as video tracks with +B-frames. Additionally, eases conformance with the DASH-IF interoperability +guidelines. +

+

This option is implicitly set when writing ismv (Smooth Streaming) files. +

+
-write_prft
+

Write producer time reference box (PRFT) with a specified time source for the +NTP field in the PRFT box. Set value as ‘wallclock’ to specify timesource +as wallclock time and ‘pts’ to specify timesource as input packets’ PTS +values. +

+

Setting value to ‘pts’ is applicable only for a live encoding use case, +where PTS values are set as as wallclock time at the source. For example, an +encoding use case with decklink capture source where video_pts and +audio_pts are set to ‘abs_wallclock’. +

+
+ + +

4.18.2 Example

+ +

Smooth Streaming content can be pushed in real time to a publishing +point on IIS with this muxer. Example: +

+
ffmpeg -re <normal input/transcoding options> -movflags isml+frag_keyframe -f ismv http://server/publishingpoint.isml/Streams(Encoder1)
+
+ + +

4.19 mp3

+ +

The MP3 muxer writes a raw MP3 stream with the following optional features: +

    +
  • An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and +2.4 are supported, the id3v2_version private option controls which one is +used (3 or 4). Setting id3v2_version to 0 disables the ID3v2 header +completely. + +

    The muxer supports writing attached pictures (APIC frames) to the ID3v2 header. +The pictures are supplied to the muxer in form of a video stream with a single +packet. There can be any number of those streams, each will correspond to a +single APIC frame. The stream metadata tags title and comment map +to APIC description and picture type respectively. See +http://id3.org/id3v2.4.0-frames for allowed picture types. +

    +

    Note that the APIC frames must be written at the beginning, so the muxer will +buffer the audio frames until it gets all the pictures. It is therefore advised +to provide the pictures as soon as possible to avoid excessive buffering. +

    +
  • A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by +default, but will be written only if the output is seekable. The +write_xing private option can be used to disable it. The frame contains +various information that may be useful to the decoder, like the audio duration +or encoder delay. + +
  • A legacy ID3v1 tag at the end of the file (disabled by default). It may be +enabled with the write_id3v1 private option, but as its capabilities are +very limited, its usage is not recommended. +
+ +

Examples: +

+

Write an mp3 with an ID3v2.3 header and an ID3v1 footer: +

+
ffmpeg -i INPUT -id3v2_version 3 -write_id3v1 1 out.mp3
+
+ +

To attach a picture to an mp3 file select both the audio and the picture stream +with map: +

+
ffmpeg -i input.mp3 -i cover.png -c copy -map 0 -map 1
+-metadata:s:v title="Album cover" -metadata:s:v comment="Cover (Front)" out.mp3
+
+ +

Write a "clean" MP3 without any extra features: +

+
ffmpeg -i input.wav -write_xing 0 -id3v2_version 0 out.mp3
+
+ + +

4.20 mpegts

+ +

MPEG transport stream muxer. +

+

This muxer implements ISO 13818-1 and part of ETSI EN 300 468. +

+

The recognized metadata settings in mpegts muxer are service_provider +and service_name. If they are not set the default for +service_provider is ‘FFmpeg’ and the default for +service_name is ‘Service01’. +

+ +

4.20.1 Options

+ +

The muxer options are: +

+
+
mpegts_transport_stream_id integer
+

Set the ‘transport_stream_id’. This identifies a transponder in DVB. +Default is 0x0001. +

+
+
mpegts_original_network_id integer
+

Set the ‘original_network_id’. This is unique identifier of a +network in DVB. Its main use is in the unique identification of a service +through the path ‘Original_Network_ID, Transport_Stream_ID’. Default +is 0x0001. +

+
+
mpegts_service_id integer
+

Set the ‘service_id’, also known as program in DVB. Default is +0x0001. +

+
+
mpegts_service_type integer
+

Set the program ‘service_type’. Default is digital_tv. +Accepts the following options: +

+
‘hex_value’
+

Any hexadecimal value between 0x01 and 0xff as defined in +ETSI 300 468. +

+
‘digital_tv’
+

Digital TV service. +

+
‘digital_radio’
+

Digital Radio service. +

+
‘teletext’
+

Teletext service. +

+
‘advanced_codec_digital_radio’
+

Advanced Codec Digital Radio service. +

+
‘mpeg2_digital_hdtv’
+

MPEG2 Digital HDTV service. +

+
‘advanced_codec_digital_sdtv’
+

Advanced Codec Digital SDTV service. +

+
‘advanced_codec_digital_hdtv’
+

Advanced Codec Digital HDTV service. +

+
+ +
+
mpegts_pmt_start_pid integer
+

Set the first PID for PMTs. Default is 0x1000, minimum is 0x0020, +maximum is 0x1ffa. This option has no effect in m2ts mode where the PMT +PID is fixed 0x0100. +

+
+
mpegts_start_pid integer
+

Set the first PID for elementary streams. Default is 0x0100, minimum is +0x0020, maximum is 0x1ffa. This option has no effect in m2ts mode +where the elementary stream PIDs are fixed. +

+
+
mpegts_m2ts_mode boolean
+

Enable m2ts mode if set to 1. Default value is -1 which +disables m2ts mode. +

+
+
muxrate integer
+

Set a constant muxrate. Default is VBR. +

+
+
pes_payload_size integer
+

Set minimum PES packet payload in bytes. Default is 2930. +

+
+
mpegts_flags flags
+

Set mpegts flags. Accepts the following options: +

+
‘resend_headers’
+

Reemit PAT/PMT before writing the next packet. +

+
‘latm’
+

Use LATM packetization for AAC. +

+
‘pat_pmt_at_frames’
+

Reemit PAT and PMT at each video frame. +

+
‘system_b’
+

Conform to System B (DVB) instead of System A (ATSC). +

+
‘initial_discontinuity’
+

Mark the initial packet of each stream as discontinuity. +

+
+ +
+
mpegts_copyts boolean
+

Preserve original timestamps, if value is set to 1. Default value +is -1, which results in shifting timestamps so that they start from 0. +

+
+
omit_video_pes_length boolean
+

Omit the PES packet length for video packets. Default is 1 (true). +

+
+
pcr_period integer
+

Override the default PCR retransmission time in milliseconds. Default is +-1 which means that the PCR interval will be determined automatically: +20 ms is used for CBR streams, the highest multiple of the frame duration which +is less than 100 ms is used for VBR streams. +

+
+
pat_period duration
+

Maximum time in seconds between PAT/PMT tables. Default is 0.1. +

+
+
sdt_period duration
+

Maximum time in seconds between SDT tables. Default is 0.5. +

+
+
tables_version integer
+

Set PAT, PMT and SDT version (default 0, valid values are from 0 to 31, inclusively). +This option allows updating stream structure so that standard consumer may +detect the change. To do so, reopen output AVFormatContext (in case of API +usage) or restart ffmpeg instance, cyclically changing +tables_version value: +

+
+
ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
+ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
+...
+ffmpeg -i source3.ts -codec copy -f mpegts -tables_version 31 udp://1.1.1.1:1111
+ffmpeg -i source1.ts -codec copy -f mpegts -tables_version 0 udp://1.1.1.1:1111
+ffmpeg -i source2.ts -codec copy -f mpegts -tables_version 1 udp://1.1.1.1:1111
+...
+
+
+
+ + +

4.20.2 Example

+ +
+
ffmpeg -i file.mpg -c copy \
+     -mpegts_original_network_id 0x1122 \
+     -mpegts_transport_stream_id 0x3344 \
+     -mpegts_service_id 0x5566 \
+     -mpegts_pmt_start_pid 0x1500 \
+     -mpegts_start_pid 0x150 \
+     -metadata service_provider="Some provider" \
+     -metadata service_name="Some Channel" \
+     out.ts
+
+ + +

4.21 mxf, mxf_d10, mxf_opatom

+ +

MXF muxer. +

+ +

4.21.1 Options

+ +

The muxer options are: +

+
+
store_user_comments bool
+

Set if user comments should be stored if available or never. +IRT D-10 does not allow user comments. The default is thus to write them for +mxf and mxf_opatom but not for mxf_d10 +

+
+ + +

4.22 null

+ +

Null muxer. +

+

This muxer does not generate any output file, it is mainly useful for +testing or benchmarking purposes. +

+

For example to benchmark decoding with ffmpeg you can use the +command: +

+
ffmpeg -benchmark -i INPUT -f null out.null
+
+ +

Note that the above command does not read or write the out.null +file, but specifying the output file is required by the ffmpeg +syntax. +

+

Alternatively you can write the command as: +

+
ffmpeg -benchmark -i INPUT -f null -
+
+ + +

4.23 nut

+ +
+
-syncpoints flags
+

Change the syncpoint usage in nut: +

+
default use the normal low-overhead seeking aids.
+
none do not use the syncpoints at all, reducing the overhead but making the stream non-seekable;
+

Use of this option is not recommended, as the resulting files are very damage + sensitive and seeking is not possible. Also in general the overhead from + syncpoints is negligible. Note, -write_index 0 can be used to disable + all growing data tables, allowing to mux endless streams with limited memory + and without these disadvantages. +

+
timestamped extend the syncpoint with a wallclock field.
+
+

The none and timestamped flags are experimental. +

+
-write_index bool
+

Write index at the end, the default is to write an index. +

+
+ +
+
ffmpeg -i INPUT -f_strict experimental -syncpoints none - | processor
+
+ + +

4.24 ogg

+ +

Ogg container muxer. +

+
+
-page_duration duration
+

Preferred page duration, in microseconds. The muxer will attempt to create +pages that are approximately duration microseconds long. This allows the +user to compromise between seek granularity and container overhead. The default +is 1 second. A value of 0 will fill all segments, making pages as large as +possible. A value of 1 will effectively use 1 packet-per-page in most +situations, giving a small seek granularity at the cost of additional container +overhead. +

+
-serial_offset value
+

Serial value from which to set the streams serial number. +Setting it to different and sufficiently large values ensures that the produced +ogg files can be safely chained. +

+
+
+ + +

4.25 segment, stream_segment, ssegment

+ +

Basic stream segmenter. +

+

This muxer outputs streams to a number of separate files of nearly +fixed duration. Output filename pattern can be set in a fashion +similar to image2, or by using a strftime template if +the strftime option is enabled. +

+

stream_segment is a variant of the muxer used to write to +streaming output formats, i.e. which do not require global headers, +and is recommended for outputting e.g. to MPEG transport stream segments. +ssegment is a shorter alias for stream_segment. +

+

Every segment starts with a keyframe of the selected reference stream, +which is set through the reference_stream option. +

+

Note that if you want accurate splitting for a video file, you need to +make the input key frames correspond to the exact splitting times +expected by the segmenter, or the segment muxer will start the new +segment with the key frame found next after the specified start +time. +

+

The segment muxer works best with a single constant frame rate video. +

+

Optionally it can generate a list of the created segments, by setting +the option segment_list. The list type is specified by the +segment_list_type option. The entry filenames in the segment +list are set by default to the basename of the corresponding segment +files. +

+

See also the hls muxer, which provides a more specific +implementation for HLS segmentation. +

+ +

4.25.1 Options

+ +

The segment muxer supports the following options: +

+
+
increment_tc 1|0
+

if set to 1, increment timecode between each segment +If this is selected, the input need to have +a timecode in the first video stream. Default value is +0. +

+
+
reference_stream specifier
+

Set the reference stream, as specified by the string specifier. +If specifier is set to auto, the reference is chosen +automatically. Otherwise it must be a stream specifier (see the “Stream +specifiers” chapter in the ffmpeg manual) which specifies the +reference stream. The default value is auto. +

+
+
segment_format format
+

Override the inner container format, by default it is guessed by the filename +extension. +

+
+
segment_format_options options_list
+

Set output format options using a :-separated list of key=value +parameters. Values containing the : special character must be +escaped. +

+
+
segment_list name
+

Generate also a listfile named name. If not specified no +listfile is generated. +

+
+
segment_list_flags flags
+

Set flags affecting the segment list generation. +

+

It currently supports the following flags: +

+
‘cache’
+

Allow caching (only affects M3U8 list files). +

+
+
‘live’
+

Allow live-friendly file generation. +

+
+ +
+
segment_list_size size
+

Update the list file so that it contains at most size +segments. If 0 the list file will contain all the segments. Default +value is 0. +

+
+
segment_list_entry_prefix prefix
+

Prepend prefix to each entry. Useful to generate absolute paths. +By default no prefix is applied. +

+
+
segment_list_type type
+

Select the listing format. +

+

The following values are recognized: +

+
‘flat’
+

Generate a flat list for the created segments, one segment per line. +

+
+
‘csv, ext’
+

Generate a list for the created segments, one segment per line, +each line matching the format (comma-separated values): +

+
segment_filename,segment_start_time,segment_end_time
+
+ +

segment_filename is the name of the output file generated by the +muxer according to the provided pattern. CSV escaping (according to +RFC4180) is applied if required. +

+

segment_start_time and segment_end_time specify +the segment start and end time expressed in seconds. +

+

A list file with the suffix ".csv" or ".ext" will +auto-select this format. +

+

‘ext’ is deprecated in favor or ‘csv’. +

+
+
‘ffconcat’
+

Generate an ffconcat file for the created segments. The resulting file +can be read using the FFmpeg concat demuxer. +

+

A list file with the suffix ".ffcat" or ".ffconcat" will +auto-select this format. +

+
+
‘m3u8’
+

Generate an extended M3U8 file, version 3, compliant with +http://tools.ietf.org/id/draft-pantos-http-live-streaming. +

+

A list file with the suffix ".m3u8" will auto-select this format. +

+
+ +

If not specified the type is guessed from the list file name suffix. +

+
+
segment_time time
+

Set segment duration to time, the value must be a duration +specification. Default value is "2". See also the +segment_times option. +

+

Note that splitting may not be accurate, unless you force the +reference stream key-frames at the given time. See the introductory +notice and the examples below. +

+
+
segment_atclocktime 1|0
+

If set to "1" split at regular clock time intervals starting from 00:00 +o’clock. The time value specified in segment_time is +used for setting the length of the splitting interval. +

+

For example with segment_time set to "900" this makes it possible +to create files at 12:00 o’clock, 12:15, 12:30, etc. +

+

Default value is "0". +

+
+
segment_clocktime_offset duration
+

Delay the segment splitting times with the specified duration when using +segment_atclocktime. +

+

For example with segment_time set to "900" and +segment_clocktime_offset set to "300" this makes it possible to +create files at 12:05, 12:20, 12:35, etc. +

+

Default value is "0". +

+
+
segment_clocktime_wrap_duration duration
+

Force the segmenter to only start a new segment if a packet reaches the muxer +within the specified duration after the segmenting clock time. This way you +can make the segmenter more resilient to backward local time jumps, such as +leap seconds or transition to standard time from daylight savings time. +

+

Default is the maximum possible duration which means starting a new segment +regardless of the elapsed time since the last clock time. +

+
+
segment_time_delta delta
+

Specify the accuracy time when selecting the start time for a +segment, expressed as a duration specification. Default value is "0". +

+

When delta is specified a key-frame will start a new segment if its +PTS satisfies the relation: +

+
PTS >= start_time - time_delta
+
+ +

This option is useful when splitting video content, which is always +split at GOP boundaries, in case a key frame is found just before the +specified split time. +

+

In particular may be used in combination with the ffmpeg option +force_key_frames. The key frame times specified by +force_key_frames may not be set accurately because of rounding +issues, with the consequence that a key frame time may result set just +before the specified time. For constant frame rate videos a value of +1/(2*frame_rate) should address the worst case mismatch between +the specified time and the time set by force_key_frames. +

+
+
segment_times times
+

Specify a list of split points. times contains a list of comma +separated duration specifications, in increasing order. See also +the segment_time option. +

+
+
segment_frames frames
+

Specify a list of split video frame numbers. frames contains a +list of comma separated integer numbers, in increasing order. +

+

This option specifies to start a new segment whenever a reference +stream key frame is found and the sequential number (starting from 0) +of the frame is greater or equal to the next value in the list. +

+
+
segment_wrap limit
+

Wrap around segment index once it reaches limit. +

+
+
segment_start_number number
+

Set the sequence number of the first segment. Defaults to 0. +

+
+
strftime 1|0
+

Use the strftime function to define the name of the new +segments to write. If this is selected, the output segment name must +contain a strftime function template. Default value is +0. +

+
+
break_non_keyframes 1|0
+

If enabled, allow segments to start on frames other than keyframes. This +improves behavior on some players when the time between keyframes is +inconsistent, but may make things worse on others, and can cause some oddities +during seeking. Defaults to 0. +

+
+
reset_timestamps 1|0
+

Reset timestamps at the beginning of each segment, so that each segment +will start with near-zero timestamps. It is meant to ease the playback +of the generated segments. May not work with some combinations of +muxers/codecs. It is set to 0 by default. +

+
+
initial_offset offset
+

Specify timestamp offset to apply to the output packet timestamps. The +argument must be a time duration specification, and defaults to 0. +

+
+
write_empty_segments 1|0
+

If enabled, write an empty segment if there are no packets during the period a +segment would usually span. Otherwise, the segment will be filled with the next +packet written. Defaults to 0. +

+
+ +

Make sure to require a closed GOP when encoding and to set the GOP +size to fit your segment time constraint. +

+ +

4.25.2 Examples

+ +
    +
  • Remux the content of file in.mkv to a list of segments +out-000.nut, out-001.nut, etc., and write the list of +generated segments to out.list: +
    +
    ffmpeg -i in.mkv -codec hevc -flags +cgop -g 60 -map 0 -f segment -segment_list out.list out%03d.nut
+
    + +
  • Segment input and set output format options for the output segments: +
    +
    ffmpeg -i in.mkv -f segment -segment_time 10 -segment_format_options movflags=+faststart out%03d.mp4
+
    + +
  • Segment the input file according to the split points specified by the +segment_times option: +
    +
    ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 out%03d.nut
+
    + +
  • Use the ffmpeg force_key_frames +option to force key frames in the input at the specified location, together +with the segment option segment_time_delta to account for +possible roundings operated when setting key frame times. +
    +
    ffmpeg -i in.mkv -force_key_frames 1,2,3,5,8,13,21 -codec:v mpeg4 -codec:a pcm_s16le -map 0 \
+-f segment -segment_list out.csv -segment_times 1,2,3,5,8,13,21 -segment_time_delta 0.05 out%03d.nut
+
    +

    In order to force key frames on the input file, transcoding is +required. +

    +
  • Segment the input file by splitting the input file according to the +frame numbers sequence specified with the segment_frames option: +
    +
    ffmpeg -i in.mkv -codec copy -map 0 -f segment -segment_list out.csv -segment_frames 100,200,300,500,800 out%03d.nut
+
    + +
  • Convert the in.mkv to TS segments using the libx264 +and aac encoders: +
    +
    ffmpeg -i in.mkv -map 0 -codec:v libx264 -codec:a aac -f ssegment -segment_list out.list out%03d.ts
+
    + +
  • Segment the input file, and create an M3U8 live playlist (can be used +as live HLS source): +
    +
    ffmpeg -re -i in.mkv -codec copy -map 0 -f segment -segment_list playlist.m3u8 \
+-segment_list_flags +live -segment_time 10 out%03d.mkv
+
    +
+ + +

4.26 smoothstreaming

+ +

Smooth Streaming muxer generates a set of files (Manifest, chunks) suitable for serving with conventional web server. +

+
+
window_size
+

Specify the number of fragments kept in the manifest. Default 0 (keep all). +

+
+
extra_window_size
+

Specify the number of fragments kept outside of the manifest before removing from disk. Default 5. +

+
+
lookahead_count
+

Specify the number of lookahead fragments. Default 2. +

+
+
min_frag_duration
+

Specify the minimum fragment duration (in microseconds). Default 5000000. +

+
+
remove_at_exit
+

Specify whether to remove all fragments when finished. Default 0 (do not remove). +

+
+
+ + +

4.27 streamhash

+ +

Per stream hash testing format. +

+

This muxer computes and prints a cryptographic hash of all the input frames, +on a per-stream basis. This can be used for equality checks without having +to do a complete binary comparison. +

+

By default audio frames are converted to signed 16-bit raw audio and +video frames to raw video before computing the hash, but the output +of explicit conversions to other codecs can also be used. Timestamps +are ignored. It uses the SHA-256 cryptographic hash function by default, +but supports several other algorithms. +

+

The output of the muxer consists of one line per stream of the form: +streamindex,streamtype,algo=hash, where +streamindex is the index of the mapped stream, streamtype is a +single character indicating the type of stream, algo is a short string +representing the hash function used, and hash is a hexadecimal number +representing the computed hash. +

+
+
hash algorithm
+

Use the cryptographic hash function specified by the string algorithm. +Supported values include MD5, murmur3, RIPEMD128, +RIPEMD160, RIPEMD256, RIPEMD320, SHA160, +SHA224, SHA256 (default), SHA512/224, SHA512/256, +SHA384, SHA512, CRC32 and adler32. +

+
+
+ + +

4.27.1 Examples

+ +

To compute the SHA-256 hash of the input converted to raw audio and +video, and store it in the file out.sha256: +

+
ffmpeg -i INPUT -f streamhash out.sha256
+
+ +

To print an MD5 hash to stdout use the command: +

+
ffmpeg -i INPUT -f streamhash -hash md5 -
+
+ +

See also the hash and framehash muxers. +

+ +

4.28 fifo

+ +

The fifo pseudo-muxer allows the separation of encoding and muxing by using +first-in-first-out queue and running the actual muxer in a separate thread. This +is especially useful in combination with the tee muxer and can be used to +send data to several destinations with different reliability/writing speed/latency. +

+

API users should be aware that callback functions (interrupt_callback, +io_open and io_close) used within its AVFormatContext must be thread-safe. +

+

The behavior of the fifo muxer if the queue fills up or if the output fails is +selectable, +

+
    +
  • output can be transparently restarted with configurable delay between retries +based on real time or time of the processed stream. + +
  • encoding can be blocked during temporary failure, or continue transparently +dropping packets in case fifo queue fills up. + +
+ +
+
fifo_format
+

Specify the format name. Useful if it cannot be guessed from the +output name suffix. +

+
+
queue_size
+

Specify size of the queue (number of packets). Default value is 60. +

+
+
format_opts
+

Specify format options for the underlying muxer. Muxer options can be specified +as a list of key=value pairs separated by ’:’. +

+
+
drop_pkts_on_overflow bool
+

If set to 1 (true), in case the fifo queue fills up, packets will be dropped +rather than blocking the encoder. This makes it possible to continue streaming without +delaying the input, at the cost of omitting part of the stream. By default +this option is set to 0 (false), so in such cases the encoder will be blocked +until the muxer processes some of the packets and none of them is lost. +

+
+
attempt_recovery bool
+

If failure occurs, attempt to recover the output. This is especially useful +when used with network output, since it makes it possible to restart streaming transparently. +By default this option is set to 0 (false). +

+
+
max_recovery_attempts
+

Sets maximum number of successive unsuccessful recovery attempts after which +the output fails permanently. By default this option is set to 0 (unlimited). +

+
+
recovery_wait_time duration
+

Waiting time before the next recovery attempt after previous unsuccessful +recovery attempt. Default value is 5 seconds. +

+
+
recovery_wait_streamtime bool
+

If set to 0 (false), the real time is used when waiting for the recovery +attempt (i.e. the recovery will be attempted after at least +recovery_wait_time seconds). +If set to 1 (true), the time of the processed stream is taken into account +instead (i.e. the recovery will be attempted after at least recovery_wait_time +seconds of the stream is omitted). +By default, this option is set to 0 (false). +

+
+
recover_any_error bool
+

If set to 1 (true), recovery will be attempted regardless of type of the error +causing the failure. By default this option is set to 0 (false) and in case of +certain (usually permanent) errors the recovery is not attempted even when +attempt_recovery is set to 1. +

+
+
restart_with_keyframe bool
+

Specify whether to wait for the keyframe after recovering from +queue overflow or failure. This option is set to 0 (false) by default. +

+
+
+ + +

4.28.1 Examples

+ +
    +
  • Stream something to rtmp server, continue processing the stream at real-time +rate even in case of temporary failure (network outage) and attempt to recover +streaming every second indefinitely. +
    +
    ffmpeg -re -i ... -c:v libx264 -c:a aac -f fifo -fifo_format flv -map 0:v -map 0:a
+  -drop_pkts_on_overflow 1 -attempt_recovery 1 -recovery_wait_time 1 rtmp://example.com/live/stream_name
+
    + +
+ + +

4.29 tee

+ +

The tee muxer can be used to write the same data to several outputs, such as files or streams. +It can be used, for example, to stream a video over a network and save it to disk at the same time. +

+

It is different from specifying several outputs to the ffmpeg +command-line tool. With the tee muxer, the audio and video data will be encoded only once. +With conventional multiple outputs, multiple encoding operations in parallel are initiated, +which can be a very expensive process. The tee muxer is not useful when using the libavformat API +directly because it is then possible to feed the same packets to several muxers directly. +

+

Since the tee muxer does not represent any particular output format, ffmpeg cannot auto-select +output streams. So all streams intended for output must be specified using -map. See +the examples below. +

+

Some encoders may need different options depending on the output format; +the auto-detection of this can not work with the tee muxer, so they need to be explicitly specified. +The main example is the global_header flag. +

+

The slave outputs are specified in the file name given to the muxer, +separated by ’|’. If any of the slave name contains the ’|’ separator, +leading or trailing spaces or any special character, those must be +escaped (see (ffmpeg-utils)the "Quoting and escaping" +section in the ffmpeg-utils(1) manual). +

+ +

4.29.1 Options

+ +
+
use_fifo bool
+

If set to 1, slave outputs will be processed in separate threads using the fifo +muxer. This allows to compensate for different speed/latency/reliability of +outputs and setup transparent recovery. By default this feature is turned off. +

+
+
fifo_options
+

Options to pass to fifo pseudo-muxer instances. See fifo. +

+
+
+ +

Muxer options can be specified for each slave by prepending them as a list of +key=value pairs separated by ’:’, between square brackets. If +the options values contain a special character or the ’:’ separator, they +must be escaped; note that this is a second level escaping. +

+

The following special options are also recognized: +

+
f
+

Specify the format name. Required if it cannot be guessed from the +output URL. +

+
+
bsfs[/spec]
+

Specify a list of bitstream filters to apply to the specified +output. +

+

It is possible to specify to which streams a given bitstream filter +applies, by appending a stream specifier to the option separated by +/. spec must be a stream specifier (see Format stream specifiers). +

+

If the stream specifier is not specified, the bitstream filters will be +applied to all streams in the output. This will cause that output operation +to fail if the output contains streams to which the bitstream filter cannot +be applied e.g. h264_mp4toannexb being applied to an output containing an audio stream. +

+

Options for a bitstream filter must be specified in the form of opt=value. +

+

Several bitstream filters can be specified, separated by ",". +

+
+
use_fifo bool
+

This allows to override tee muxer use_fifo option for individual slave muxer. +

+
+
fifo_options
+

This allows to override tee muxer fifo_options for individual slave muxer. +See fifo. +

+
+
select
+

Select the streams that should be mapped to the slave output, +specified by a stream specifier. If not specified, this defaults to +all the mapped streams. This will cause that output operation to fail +if the output format does not accept all mapped streams. +

+

You may use multiple stream specifiers separated by commas (,) e.g.: a:0,v +

+
+
onfail
+

Specify behaviour on output failure. This can be set to either abort (which is +default) or ignore. abort will cause whole process to fail in case of failure +on this slave output. ignore will ignore failure on this output, so other outputs +will continue without being affected. +

+
+ + +

4.29.2 Examples

+ +
    +
  • Encode something and both archive it in a WebM file and stream it +as MPEG-TS over UDP: +
    +
    ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
+  "archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
+
    + +
  • As above, but continue streaming even if output to local file fails +(for example local drive fills up): +
    +
    ffmpeg -i ... -c:v libx264 -c:a mp2 -f tee -map 0:v -map 0:a
+  "[onfail=ignore]archive-20121107.mkv|[f=mpegts]udp://10.0.1.255:1234/"
+
    + +
  • Use ffmpeg to encode the input, and send the output +to three different destinations. The dump_extra bitstream +filter is used to add extradata information to all the output video +keyframes packets, as requested by the MPEG-TS format. The select +option is applied to out.aac in order to make it contain only +audio packets. +
    +
    ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
+       -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=a]out.aac"
+
    + +
  • As above, but select only stream a:1 for the audio output. Note +that a second level escaping must be performed, as ":" is a special +character used to separate options. +
    +
    ffmpeg -i ... -map 0 -flags +global_header -c:v libx264 -c:a aac
+       -f tee "[bsfs/v=dump_extra=freq=keyframe]out.ts|[movflags=+faststart]out.mp4|[select=\'a:1\']out.aac"
+
    +
+ + +

4.30 webm_dash_manifest

+ +

WebM DASH Manifest muxer. +

+

This muxer implements the WebM DASH Manifest specification to generate the DASH +manifest XML. It also supports manifest generation for DASH live streams. +

+

For more information see: +

+ + + +

4.30.1 Options

+ +

This muxer supports the following options: +

+
+
adaptation_sets
+

This option has the following syntax: "id=x,streams=a,b,c id=y,streams=d,e" where x and y are the +unique identifiers of the adaptation sets and a,b,c,d and e are the indices of the corresponding +audio and video streams. Any number of adaptation sets can be added using this option. +

+
+
live
+

Set this to 1 to create a live stream DASH Manifest. Default: 0. +

+
+
chunk_start_index
+

Start index of the first chunk. This will go in the ‘startNumber’ attribute +of the ‘SegmentTemplate’ element in the manifest. Default: 0. +

+
+
chunk_duration_ms
+

Duration of each chunk in milliseconds. This will go in the ‘duration’ +attribute of the ‘SegmentTemplate’ element in the manifest. Default: 1000. +

+
+
utc_timing_url
+

URL of the page that will return the UTC timestamp in ISO format. This will go +in the ‘value’ attribute of the ‘UTCTiming’ element in the manifest. +Default: None. +

+
+
time_shift_buffer_depth
+

Smallest time (in seconds) shifting buffer for which any Representation is +guaranteed to be available. This will go in the ‘timeShiftBufferDepth’ +attribute of the ‘MPD’ element. Default: 60. +

+
+
minimum_update_period
+

Minimum update period (in seconds) of the manifest. This will go in the +‘minimumUpdatePeriod’ attribute of the ‘MPD’ element. Default: 0. +

+
+
+ + +

4.30.2 Example

+
+
ffmpeg -f webm_dash_manifest -i video1.webm \
+       -f webm_dash_manifest -i video2.webm \
+       -f webm_dash_manifest -i audio1.webm \
+       -f webm_dash_manifest -i audio2.webm \
+       -map 0 -map 1 -map 2 -map 3 \
+       -c copy \
+       -f webm_dash_manifest \
+       -adaptation_sets "id=0,streams=0,1 id=1,streams=2,3" \
+       manifest.xml
+
+ + +

4.31 webm_chunk

+ +

WebM Live Chunk Muxer. +

+

This muxer writes out WebM headers and chunks as separate files which can be +consumed by clients that support WebM Live streams via DASH. +

+ +

4.31.1 Options

+ +

This muxer supports the following options: +

+
+
chunk_start_index
+

Index of the first chunk (defaults to 0). +

+
+
header
+

Filename of the header where the initialization data will be written. +

+
+
audio_chunk_duration
+

Duration of each audio chunk in milliseconds (defaults to 5000). +

+
+ + +

4.31.2 Example

+
+
ffmpeg -f v4l2 -i /dev/video0 \
+       -f alsa -i hw:0 \
+       -map 0:0 \
+       -c:v libvpx-vp9 \
+       -s 640x360 -keyint_min 30 -g 30 \
+       -f webm_chunk \
+       -header webm_live_video_360.hdr \
+       -chunk_start_index 1 \
+       webm_live_video_360_%d.chk \
+       -map 1:0 \
+       -c:a libvorbis \
+       -b:a 128k \
+       -f webm_chunk \
+       -header webm_live_audio_128.hdr \
+       -chunk_start_index 1 \
+       -audio_chunk_duration 1000 \
+       webm_live_audio_128_%d.chk
+
+ + +

5 Metadata

+ +

FFmpeg is able to dump metadata from media files into a simple UTF-8-encoded +INI-like text file and then load it back using the metadata muxer/demuxer. +

+

The file format is as follows: +

    +
  1. A file consists of a header and a number of metadata tags divided into sections, +each on its own line. + +
  2. The header is a ‘;FFMETADATA’ string, followed by a version number (now 1). + +
  3. Metadata tags are of the form ‘key=value’ + +
  4. Immediately after header follows global metadata + +
  5. After global metadata there may be sections with per-stream/per-chapter +metadata. + +
  6. A section starts with the section name in uppercase (i.e. STREAM or CHAPTER) in +brackets (‘[’, ‘]’) and ends with next section or end of file. + +
  7. At the beginning of a chapter section there may be an optional timebase to be +used for start/end values. It must be in form +‘TIMEBASE=num/den’, where num and den are +integers. If the timebase is missing then start/end times are assumed to +be in nanoseconds. + +

    Next a chapter section must contain chapter start and end times in form +‘START=num’, ‘END=num’, where num is a positive +integer. +

    +
  8. Empty lines and lines starting with ‘;’ or ‘#’ are ignored. + +
  9. Metadata keys or values containing special characters (‘=’, ‘;’, +‘#’, ‘\’ and a newline) must be escaped with a backslash ‘\’. + +
  10. Note that whitespace in metadata (e.g. ‘foo = bar’) is considered to be +a part of the tag (in the example above key is ‘foo ’, value is +‘ bar’). +
+ +

A ffmetadata file might look like this: +

+
;FFMETADATA1
+title=bike\\shed
+;this is a comment
+artist=FFmpeg troll team
+
+[CHAPTER]
+TIMEBASE=1/1000
+START=0
+#chapter ends at 0:01:00
+END=60000
+title=chapter \#1
+[STREAM]
+title=multi\
+line
+
+ +

By using the ffmetadata muxer and demuxer it is possible to extract +metadata from an input file to an ffmetadata file, and then transcode +the file into an output file with the edited ffmetadata file. +

+

Extracting an ffmetadata file with ffmpeg goes as follows: +

+
ffmpeg -i INPUT -f ffmetadata FFMETADATAFILE
+
+ +

Reinserting edited metadata information from the FFMETADATAFILE file can +be done as: +

+
ffmpeg -i INPUT -i FFMETADATAFILE -map_metadata 1 -codec copy OUTPUT
+
+ + + +

6 See Also

+ +

ffmpeg, ffplay, ffprobe, +libavformat +

+ + +

7 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-protocols.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-protocols.html new file mode 100644 index 0000000..41b0ea8 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-protocols.html @@ -0,0 +1,2208 @@ + + + + + + + FFmpeg Protocols Documentation + + + + + + +
+

+ FFmpeg Protocols Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

This document describes the input and output protocols provided by the +libavformat library. +

+ + +

2 Protocol Options

+ +

The libavformat library provides some generic global options, which +can be set on all the protocols. In addition each protocol may support +so-called private options, which are specific for that component. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the +AVFormatContext options or using the libavutil/opt.h API +for programmatic use. +

+

The list of supported options follows: +

+
+
protocol_whitelist list (input)
+

Set a ","-separated list of allowed protocols. "ALL" matches all protocols. Protocols +prefixed by "-" are disabled. +All protocols are allowed by default but protocols used by an another +protocol (nested protocols) are restricted to a per protocol subset. +

+
+ + + +

3 Protocols

+ +

Protocols are configured elements in FFmpeg that enable access to +resources that require specific protocols. +

+

When you configure your FFmpeg build, all the supported protocols are +enabled by default. You can list all available ones using the +configure option "–list-protocols". +

+

You can disable all the protocols using the configure option +"–disable-protocols", and selectively enable a protocol using the +option "–enable-protocol=PROTOCOL", or you can disable a +particular protocol using the option +"–disable-protocol=PROTOCOL". +

+

The option "-protocols" of the ff* tools will display the list of +supported protocols. +

+

All protocols accept the following options: +

+
+
rw_timeout
+

Maximum time to wait for (network) read/write operations to complete, +in microseconds. +

+
+ +

A description of the currently available protocols follows. +

+ +

3.1 amqp

+ +

Advanced Message Queueing Protocol (AMQP) version 0-9-1 is a broker based +publish-subscribe communication protocol. +

+

FFmpeg must be compiled with –enable-librabbitmq to support AMQP. A separate +AMQP broker must also be run. An example open-source AMQP broker is RabbitMQ. +

+

After starting the broker, an FFmpeg client may stream data to the broker using +the command: +

+
+
ffmpeg -re -i input -f mpegts amqp://[[user]:[password]@]hostname[:port]
+
+ +

Where hostname and port (default is 5672) is the address of the broker. The +client may also set a user/password for authentication. The default for both +fields is "guest". +

+

Muliple subscribers may stream from the broker using the command: +

+
ffplay amqp://[[user]:[password]@]hostname[:port]
+
+ +

In RabbitMQ all data published to the broker flows through a specific exchange, +and each subscribing client has an assigned queue/buffer. When a packet arrives +at an exchange, it may be copied to a client’s queue depending on the exchange +and routing_key fields. +

+

The following options are supported: +

+
+
exchange
+

Sets the exchange to use on the broker. RabbitMQ has several predefined +exchanges: "amq.direct" is the default exchange, where the publisher and +subscriber must have a matching routing_key; "amq.fanout" is the same as a +broadcast operation (i.e. the data is forwarded to all queues on the fanout +exchange independent of the routing_key); and "amq.topic" is similar to +"amq.direct", but allows for more complex pattern matching (refer to the RabbitMQ +documentation). +

+
+
routing_key
+

Sets the routing key. The default value is "amqp". The routing key is used on +the "amq.direct" and "amq.topic" exchanges to decide whether packets are written +to the queue of a subscriber. +

+
+
pkt_size
+

Maximum size of each packet sent/received to the broker. Default is 131072. +Minimum is 4096 and max is any large value (representable by an int). When +receiving packets, this sets an internal buffer size in FFmpeg. It should be +equal to or greater than the size of the published packets to the broker. Otherwise +the received message may be truncated causing decoding errors. +

+
+
connection_timeout
+

The timeout in seconds during the initial connection to the broker. The +default value is rw_timeout, or 5 seconds if rw_timeout is not set. +

+
+
+ + +

3.2 async

+ +

Asynchronous data filling wrapper for input stream. +

+

Fill data in a background thread, to decouple I/O operation from demux thread. +

+
+
async:URL
+async:http://host/resource
+async:cache:http://host/resource
+
+ + +

3.3 bluray

+ +

Read BluRay playlist. +

+

The accepted options are: +

+
angle
+

BluRay angle +

+
+
chapter
+

Start chapter (1...N) +

+
+
playlist
+

Playlist to read (BDMV/PLAYLIST/?????.mpls) +

+
+
+ +

Examples: +

+

Read longest playlist from BluRay mounted to /mnt/bluray: +

+
bluray:/mnt/bluray
+
+ +

Read angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapter 2: +

+
-playlist 4 -angle 2 -chapter 2 bluray:/mnt/bluray
+
+ + +

3.4 cache

+ +

Caching wrapper for input stream. +

+

Cache the input stream to temporary file. It brings seeking capability to live streams. +

+
+
cache:URL
+
+ + +

3.5 concat

+ +

Physical concatenation protocol. +

+

Read and seek from many resources in sequence as if they were +a unique resource. +

+

A URL accepted by this protocol has the syntax: +

+
concat:URL1|URL2|...|URLN
+
+ +

where URL1, URL2, ..., URLN are the urls of the +resource to be concatenated, each one possibly specifying a distinct +protocol. +

+

For example to read a sequence of files split1.mpeg, +split2.mpeg, split3.mpeg with ffplay use the +command: +

+
ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
+
+ +

Note that you may need to escape the character "|" which is special for +many shells. +

+ +

3.6 crypto

+ +

AES-encrypted stream reading protocol. +

+

The accepted options are: +

+
key
+

Set the AES decryption key binary block from given hexadecimal representation. +

+
+
iv
+

Set the AES decryption initialization vector binary block from given hexadecimal representation. +

+
+ +

Accepted URL formats: +

+
crypto:URL
+crypto+URL
+
+ + +

3.7 data

+ +

Data in-line in the URI. See http://en.wikipedia.org/wiki/Data_URI_scheme. +

+

For example, to convert a GIF file given inline with ffmpeg: +

+
ffmpeg -i "data:image/gif;base64,R0lGODdhCAAIAMIEAAAAAAAA//8AAP//AP///////////////ywAAAAACAAIAAADF0gEDLojDgdGiJdJqUX02iB4E8Q9jUMkADs=" smiley.png
+
+ + +

3.8 file

+ +

File access protocol. +

+

Read from or write to a file. +

+

A file URL can have the form: +

+
file:filename
+
+ +

where filename is the path of the file to read. +

+

An URL that does not have a protocol prefix will be assumed to be a +file URL. Depending on the build, an URL that looks like a Windows +path with the drive letter at the beginning will also be assumed to be +a file URL (usually not the case in builds for unix-like systems). +

+

For example to read from a file input.mpeg with ffmpeg +use the command: +

+
ffmpeg -i file:input.mpeg output.mpeg
+
+ +

This protocol accepts the following options: +

+
+
truncate
+

Truncate existing files on write, if set to 1. A value of 0 prevents +truncating. Default value is 1. +

+
+
blocksize
+

Set I/O operation maximum block size, in bytes. Default value is +INT_MAX, which results in not limiting the requested block size. +Setting this value reasonably low improves user termination request reaction +time, which is valuable for files on slow medium. +

+
+
follow
+

If set to 1, the protocol will retry reading at the end of the file, allowing +reading files that still are being written. In order for this to terminate, +you either need to use the rw_timeout option, or use the interrupt callback +(for API users). +

+
+
seekable
+

Controls if seekability is advertised on the file. 0 means non-seekable, -1 +means auto (seekable for normal files, non-seekable for named pipes). +

+

Many demuxers handle seekable and non-seekable resources differently, +overriding this might speed up opening certain files at the cost of losing some +features (e.g. accurate seeking). +

+
+ + +

3.9 ftp

+ +

FTP (File Transfer Protocol). +

+

Read from or write to remote resources using FTP protocol. +

+

Following syntax is required. +

+
ftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg
+
+ +

This protocol accepts the following options. +

+
+
timeout
+

Set timeout in microseconds of socket I/O operations used by the underlying low level +operation. By default it is set to -1, which means that the timeout is +not specified. +

+
+
ftp-user
+

Set a user to be used for authenticating to the FTP server. This is overridden by the +user in the FTP URL. +

+
+
ftp-password
+

Set a password to be used for authenticating to the FTP server. This is overridden by +the password in the FTP URL, or by ftp-anonymous-password if no user is set. +

+
+
ftp-anonymous-password
+

Password used when login as anonymous user. Typically an e-mail address +should be used. +

+
+
ftp-write-seekable
+

Control seekability of connection during encoding. If set to 1 the +resource is supposed to be seekable, if set to 0 it is assumed not +to be seekable. Default value is 0. +

+
+ +

NOTE: Protocol can be used as output, but it is recommended to not do +it, unless special care is taken (tests, customized server configuration +etc.). Different FTP servers behave in different way during seek +operation. ff* tools may produce incomplete content due to server limitations. +

+ +

3.10 gopher

+ +

Gopher protocol. +

+ +

3.11 hls

+ +

Read Apple HTTP Live Streaming compliant segmented stream as +a uniform one. The M3U8 playlists describing the segments can be +remote HTTP resources or local files, accessed using the standard +file protocol. +The nested protocol is declared by specifying +"+proto" after the hls URI scheme name, where proto +is either "file" or "http". +

+
+
hls+http://host/path/to/remote/resource.m3u8
+hls+file://path/to/local/resource.m3u8
+
+ +

Using this protocol is discouraged - the hls demuxer should work +just as well (if not, please report the issues) and is more complete. +To use the hls demuxer instead, simply use the direct URLs to the +m3u8 files. +

+ +

3.12 http

+ +

HTTP (Hyper Text Transfer Protocol). +

+

This protocol accepts the following options: +

+
+
seekable
+

Control seekability of connection. If set to 1 the resource is +supposed to be seekable, if set to 0 it is assumed not to be seekable, +if set to -1 it will try to autodetect if it is seekable. Default +value is -1. +

+
+
chunked_post
+

If set to 1 use chunked Transfer-Encoding for posts, default is 1. +

+
+
content_type
+

Set a specific content type for the POST messages or for listen mode. +

+
+
http_proxy
+

set HTTP proxy to tunnel through e.g. http://example.com:1234 +

+
+
headers
+

Set custom HTTP headers, can override built in default headers. The +value must be a string encoding the headers. +

+
+
multiple_requests
+

Use persistent connections if set to 1, default is 0. +

+
+
post_data
+

Set custom HTTP post data. +

+
+
referer
+

Set the Referer header. Include ’Referer: URL’ header in HTTP request. +

+
+
user_agent
+

Override the User-Agent header. If not specified the protocol will use a +string describing the libavformat build. ("Lavf/<version>") +

+
+
user-agent
+

This is a deprecated option, you can use user_agent instead it. +

+
+
timeout
+

Set timeout in microseconds of socket I/O operations used by the underlying low level +operation. By default it is set to -1, which means that the timeout is +not specified. +

+
+
reconnect_at_eof
+

If set then eof is treated like an error and causes reconnection, this is useful +for live / endless streams. +

+
+
reconnect_streamed
+

If set then even streamed/non seekable streams will be reconnected on errors. +

+
+
reconnect_delay_max
+

Sets the maximum delay in seconds after which to give up reconnecting +

+
+
mime_type
+

Export the MIME type. +

+
+
http_version
+

Exports the HTTP response version number. Usually "1.0" or "1.1". +

+
+
icy
+

If set to 1 request ICY (SHOUTcast) metadata from the server. If the server +supports this, the metadata has to be retrieved by the application by reading +the icy_metadata_headers and icy_metadata_packet options. +The default is 1. +

+
+
icy_metadata_headers
+

If the server supports ICY metadata, this contains the ICY-specific HTTP reply +headers, separated by newline characters. +

+
+
icy_metadata_packet
+

If the server supports ICY metadata, and icy was set to 1, this +contains the last non-empty metadata packet sent by the server. It should be +polled in regular intervals by applications interested in mid-stream metadata +updates. +

+
+
cookies
+

Set the cookies to be sent in future requests. The format of each cookie is the +same as the value of a Set-Cookie HTTP response field. Multiple cookies can be +delimited by a newline character. +

+
+
offset
+

Set initial byte offset. +

+
+
end_offset
+

Try to limit the request to bytes preceding this offset. +

+
+
method
+

When used as a client option it sets the HTTP method for the request. +

+

When used as a server option it sets the HTTP method that is going to be +expected from the client(s). +If the expected and the received HTTP method do not match the client will +be given a Bad Request response. +When unset the HTTP method is not checked for now. This will be replaced by +autodetection in the future. +

+
+
listen
+

If set to 1 enables experimental HTTP server. This can be used to send data when +used as an output option, or read data from a client with HTTP POST when used as +an input option. +If set to 2 enables experimental multi-client HTTP server. This is not yet implemented +in ffmpeg.c and thus must not be used as a command line option. +

+
# Server side (sending):
+ffmpeg -i somefile.ogg -c copy -listen 1 -f ogg http://server:port
+
+# Client side (receiving):
+ffmpeg -i http://server:port -c copy somefile.ogg
+
+# Client can also be done with wget:
+wget http://server:port -O somefile.ogg
+
+# Server side (receiving):
+ffmpeg -listen 1 -i http://server:port -c copy somefile.ogg
+
+# Client side (sending):
+ffmpeg -i somefile.ogg -chunked_post 0 -c copy -f ogg http://server:port
+
+# Client can also be done with wget:
+wget --post-file=somefile.ogg http://server:port
+
+ +
+
send_expect_100
+

Send an Expect: 100-continue header for POST. If set to 1 it will send, if set +to 0 it won’t, if set to -1 it will try to send if it is applicable. Default +value is -1. +

+
+
+ + +

3.12.1 HTTP Cookies

+ +

Some HTTP requests will be denied unless cookie values are passed in with the +request. The cookies option allows these cookies to be specified. At +the very least, each cookie must specify a value along with a path and domain. +HTTP requests that match both the domain and path will automatically include the +cookie value in the HTTP Cookie header field. Multiple cookies can be delimited +by a newline. +

+

The required syntax to play a stream specifying a cookie is: +

+
ffplay -cookies "nlqptid=nltid=tsn; path=/; domain=somedomain.com;" http://somedomain.com/somestream.m3u8
+
+ + +

3.13 Icecast

+ +

Icecast protocol (stream to Icecast servers) +

+

This protocol accepts the following options: +

+
+
ice_genre
+

Set the stream genre. +

+
+
ice_name
+

Set the stream name. +

+
+
ice_description
+

Set the stream description. +

+
+
ice_url
+

Set the stream website URL. +

+
+
ice_public
+

Set if the stream should be public. +The default is 0 (not public). +

+
+
user_agent
+

Override the User-Agent header. If not specified a string of the form +"Lavf/<version>" will be used. +

+
+
password
+

Set the Icecast mountpoint password. +

+
+
content_type
+

Set the stream content type. This must be set if it is different from +audio/mpeg. +

+
+
legacy_icecast
+

This enables support for Icecast versions < 2.4.0, that do not support the +HTTP PUT method but the SOURCE method. +

+
+
+ +
+
icecast://[username[:password]@]server:port/mountpoint
+
+ + +

3.14 mmst

+ +

MMS (Microsoft Media Server) protocol over TCP. +

+ +

3.15 mmsh

+ +

MMS (Microsoft Media Server) protocol over HTTP. +

+

The required syntax is: +

+
mmsh://server[:port][/app][/playpath]
+
+ + +

3.16 md5

+ +

MD5 output protocol. +

+

Computes the MD5 hash of the data to be written, and on close writes +this to the designated output or stdout if none is specified. It can +be used to test muxers without writing an actual file. +

+

Some examples follow. +

+
# Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
+ffmpeg -i input.flv -f avi -y md5:output.avi.md5
+
+# Write the MD5 hash of the encoded AVI file to stdout.
+ffmpeg -i input.flv -f avi -y md5:
+
+ +

Note that some formats (typically MOV) require the output protocol to +be seekable, so they will fail with the MD5 output protocol. +

+ +

3.17 pipe

+ +

UNIX pipe access protocol. +

+

Read and write from UNIX pipes. +

+

The accepted syntax is: +

+
pipe:[number]
+
+ +

number is the number corresponding to the file descriptor of the +pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr). If number +is not specified, by default the stdout file descriptor will be used +for writing, stdin for reading. +

+

For example to read from stdin with ffmpeg: +

+
cat test.wav | ffmpeg -i pipe:0
+# ...this is the same as...
+cat test.wav | ffmpeg -i pipe:
+
+ +

For writing to stdout with ffmpeg: +

+
ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
+# ...this is the same as...
+ffmpeg -i test.wav -f avi pipe: | cat > test.avi
+
+ +

This protocol accepts the following options: +

+
+
blocksize
+

Set I/O operation maximum block size, in bytes. Default value is +INT_MAX, which results in not limiting the requested block size. +Setting this value reasonably low improves user termination request reaction +time, which is valuable if data transmission is slow. +

+
+ +

Note that some formats (typically MOV), require the output protocol to +be seekable, so they will fail with the pipe output protocol. +

+ +

3.18 prompeg

+ +

Pro-MPEG Code of Practice #3 Release 2 FEC protocol. +

+

The Pro-MPEG CoP#3 FEC is a 2D parity-check forward error correction mechanism +for MPEG-2 Transport Streams sent over RTP. +

+

This protocol must be used in conjunction with the rtp_mpegts muxer and +the rtp protocol. +

+

The required syntax is: +

+
-f rtp_mpegts -fec prompeg=option=val... rtp://hostname:port
+
+ +

The destination UDP ports are port + 2 for the column FEC stream +and port + 4 for the row FEC stream. +

+

This protocol accepts the following options: +

+
l=n
+

The number of columns (4-20, LxD <= 100) +

+
+
d=n
+

The number of rows (4-20, LxD <= 100) +

+
+
+ +

Example usage: +

+
+
-f rtp_mpegts -fec prompeg=l=8:d=4 rtp://hostname:port
+
+ + +

3.19 rtmp

+ +

Real-Time Messaging Protocol. +

+

The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia +content across a TCP/IP network. +

+

The required syntax is: +

+
rtmp://[username:password@]server[:port][/app][/instance][/playpath]
+
+ +

The accepted parameters are: +

+
username
+

An optional username (mostly for publishing). +

+
+
password
+

An optional password (mostly for publishing). +

+
+
server
+

The address of the RTMP server. +

+
+
port
+

The number of the TCP port to use (by default is 1935). +

+
+
app
+

It is the name of the application to access. It usually corresponds to +the path where the application is installed on the RTMP server +(e.g. /ondemand/, /flash/live/, etc.). You can override +the value parsed from the URI through the rtmp_app option, too. +

+
+
playpath
+

It is the path or name of the resource to play with reference to the +application specified in app, may be prefixed by "mp4:". You +can override the value parsed from the URI through the rtmp_playpath +option, too. +

+
+
listen
+

Act as a server, listening for an incoming connection. +

+
+
timeout
+

Maximum time to wait for the incoming connection. Implies listen. +

+
+ +

Additionally, the following parameters can be set via command line options +(or in code via AVOptions): +

+
rtmp_app
+

Name of application to connect on the RTMP server. This option +overrides the parameter specified in the URI. +

+
+
rtmp_buffer
+

Set the client buffer time in milliseconds. The default is 3000. +

+
+
rtmp_conn
+

Extra arbitrary AMF connection parameters, parsed from a string, +e.g. like B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0. +Each value is prefixed by a single character denoting the type, +B for Boolean, N for number, S for string, O for object, or Z for null, +followed by a colon. For Booleans the data must be either 0 or 1 for +FALSE or TRUE, respectively. Likewise for Objects the data must be 0 or +1 to end or begin an object, respectively. Data items in subobjects may +be named, by prefixing the type with ’N’ and specifying the name before +the value (i.e. NB:myFlag:1). This option may be used multiple +times to construct arbitrary AMF sequences. +

+
+
rtmp_flashver
+

Version of the Flash plugin used to run the SWF player. The default +is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible; +<libavformat version>).) +

+
+
rtmp_flush_interval
+

Number of packets flushed in the same request (RTMPT only). The default +is 10. +

+
+
rtmp_live
+

Specify that the media is a live stream. No resuming or seeking in +live streams is possible. The default value is any, which means the +subscriber first tries to play the live stream specified in the +playpath. If a live stream of that name is not found, it plays the +recorded stream. The other possible values are live and +recorded. +

+
+
rtmp_pageurl
+

URL of the web page in which the media was embedded. By default no +value will be sent. +

+
+
rtmp_playpath
+

Stream identifier to play or to publish. This option overrides the +parameter specified in the URI. +

+
+
rtmp_subscribe
+

Name of live stream to subscribe to. By default no value will be sent. +It is only sent if the option is specified or if rtmp_live +is set to live. +

+
+
rtmp_swfhash
+

SHA256 hash of the decompressed SWF file (32 bytes). +

+
+
rtmp_swfsize
+

Size of the decompressed SWF file, required for SWFVerification. +

+
+
rtmp_swfurl
+

URL of the SWF player for the media. By default no value will be sent. +

+
+
rtmp_swfverify
+

URL to player swf file, compute hash/size automatically. +

+
+
rtmp_tcurl
+

URL of the target stream. Defaults to proto://host[:port]/app. +

+
+
+ +

For example to read with ffplay a multimedia resource named +"sample" from the application "vod" from an RTMP server "myserver": +

+
ffplay rtmp://myserver/vod/sample
+
+ +

To publish to a password protected server, passing the playpath and +app names separately: +

+
ffmpeg -re -i <input> -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@myserver/
+
+ + +

3.20 rtmpe

+ +

Encrypted Real-Time Messaging Protocol. +

+

The Encrypted Real-Time Messaging Protocol (RTMPE) is used for +streaming multimedia content within standard cryptographic primitives, +consisting of Diffie-Hellman key exchange and HMACSHA256, generating +a pair of RC4 keys. +

+ +

3.21 rtmps

+ +

Real-Time Messaging Protocol over a secure SSL connection. +

+

The Real-Time Messaging Protocol (RTMPS) is used for streaming +multimedia content across an encrypted connection. +

+ +

3.22 rtmpt

+ +

Real-Time Messaging Protocol tunneled through HTTP. +

+

The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used +for streaming multimedia content within HTTP requests to traverse +firewalls. +

+ +

3.23 rtmpte

+ +

Encrypted Real-Time Messaging Protocol tunneled through HTTP. +

+

The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE) +is used for streaming multimedia content within HTTP requests to traverse +firewalls. +

+ +

3.24 rtmpts

+ +

Real-Time Messaging Protocol tunneled through HTTPS. +

+

The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used +for streaming multimedia content within HTTPS requests to traverse +firewalls. +

+ +

3.25 libsmbclient

+ +

libsmbclient permits one to manipulate CIFS/SMB network resources. +

+

Following syntax is required. +

+
+
smb://[[domain:]user[:password@]]server[/share[/path[/file]]]
+
+ +

This protocol accepts the following options. +

+
+
timeout
+

Set timeout in milliseconds of socket I/O operations used by the underlying +low level operation. By default it is set to -1, which means that the timeout +is not specified. +

+
+
truncate
+

Truncate existing files on write, if set to 1. A value of 0 prevents +truncating. Default value is 1. +

+
+
workgroup
+

Set the workgroup used for making connections. By default workgroup is not specified. +

+
+
+ +

For more information see: http://www.samba.org/. +

+ +

3.26 libssh

+ +

Secure File Transfer Protocol via libssh +

+

Read from or write to remote resources using SFTP protocol. +

+

Following syntax is required. +

+
+
sftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg
+
+ +

This protocol accepts the following options. +

+
+
timeout
+

Set timeout of socket I/O operations used by the underlying low level +operation. By default it is set to -1, which means that the timeout +is not specified. +

+
+
truncate
+

Truncate existing files on write, if set to 1. A value of 0 prevents +truncating. Default value is 1. +

+
+
private_key
+

Specify the path of the file containing private key to use during authorization. +By default libssh searches for keys in the ~/.ssh/ directory. +

+
+
+ +

Example: Play a file stored on remote server. +

+
+
ffplay sftp://user:password@server_address:22/home/user/resource.mpeg
+
+ + +

3.27 librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte

+ +

Real-Time Messaging Protocol and its variants supported through +librtmp. +

+

Requires the presence of the librtmp headers and library during +configuration. You need to explicitly configure the build with +"–enable-librtmp". If enabled this will replace the native RTMP +protocol. +

+

This protocol provides most client functions and a few server +functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT), +encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled +variants of these encrypted types (RTMPTE, RTMPTS). +

+

The required syntax is: +

+
rtmp_proto://server[:port][/app][/playpath] options
+
+ +

where rtmp_proto is one of the strings "rtmp", "rtmpt", "rtmpe", +"rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and +server, port, app and playpath have the same +meaning as specified for the RTMP native protocol. +options contains a list of space-separated options of the form +key=val. +

+

See the librtmp manual page (man 3 librtmp) for more information. +

+

For example, to stream a file in real-time to an RTMP server using +ffmpeg: +

+
ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
+
+ +

To play the same stream using ffplay: +

+
ffplay "rtmp://myserver/live/mystream live=1"
+
+ + +

3.28 rtp

+ +

Real-time Transport Protocol. +

+

The required syntax for an RTP URL is: +rtp://hostname[:port][?option=val...] +

+

port specifies the RTP port to use. +

+

The following URL options are supported: +

+
+
ttl=n
+

Set the TTL (Time-To-Live) value (for multicast only). +

+
+
rtcpport=n
+

Set the remote RTCP port to n. +

+
+
localrtpport=n
+

Set the local RTP port to n. +

+
+
localrtcpport=n'
+

Set the local RTCP port to n. +

+
+
pkt_size=n
+

Set max packet size (in bytes) to n. +

+
+
connect=0|1
+

Do a connect() on the UDP socket (if set to 1) or not (if set +to 0). +

+
+
sources=ip[,ip]
+

List allowed source IP addresses. +

+
+
block=ip[,ip]
+

List disallowed (blocked) source IP addresses. +

+
+
write_to_source=0|1
+

Send packets to the source address of the latest received packet (if +set to 1) or to a default remote address (if set to 0). +

+
+
localport=n
+

Set the local RTP port to n. +

+

This is a deprecated option. Instead, localrtpport should be +used. +

+
+
+ +

Important notes: +

+
    +
  1. If rtcpport is not set the RTCP port will be set to the RTP +port value plus 1. + +
  2. If localrtpport (the local RTP port) is not set any available +port will be used for the local RTP and RTCP ports. + +
  3. If localrtcpport (the local RTCP port) is not set it will be +set to the local RTP port value plus 1. +
+ + +

3.29 rtsp

+ +

Real-Time Streaming Protocol. +

+

RTSP is not technically a protocol handler in libavformat, it is a demuxer +and muxer. The demuxer supports both normal RTSP (with data transferred +over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with +data transferred over RDT). +

+

The muxer can be used to send a stream using RTSP ANNOUNCE to a server +supporting it (currently Darwin Streaming Server and Mischa Spiegelmock’s +RTSP server). +

+

The required syntax for a RTSP url is: +

+
rtsp://hostname[:port]/path
+
+ +

Options can be set on the ffmpeg/ffplay command +line, or set in code via AVOptions or in +avformat_open_input. +

+

The following options are supported. +

+
+
initial_pause
+

Do not start playing the stream immediately if set to 1. Default value +is 0. +

+
+
rtsp_transport
+

Set RTSP transport protocols. +

+

It accepts the following values: +

+
‘udp’
+

Use UDP as lower transport protocol. +

+
+
‘tcp’
+

Use TCP (interleaving within the RTSP control channel) as lower +transport protocol. +

+
+
‘udp_multicast’
+

Use UDP multicast as lower transport protocol. +

+
+
‘http’
+

Use HTTP tunneling as lower transport protocol, which is useful for +passing proxies. +

+
+ +

Multiple lower transport protocols may be specified, in that case they are +tried one at a time (if the setup of one fails, the next one is tried). +For the muxer, only the ‘tcp’ and ‘udp’ options are supported. +

+
+
rtsp_flags
+

Set RTSP flags. +

+

The following values are accepted: +

+
‘filter_src’
+

Accept packets only from negotiated peer address and port. +

+
‘listen’
+

Act as a server, listening for an incoming connection. +

+
‘prefer_tcp’
+

Try TCP for RTP transport first, if TCP is available as RTSP RTP transport. +

+
+ +

Default value is ‘none’. +

+
+
allowed_media_types
+

Set media types to accept from the server. +

+

The following flags are accepted: +

+
‘video’
+
‘audio’
+
‘data’
+
+ +

By default it accepts all media types. +

+
+
min_port
+

Set minimum local UDP port. Default value is 5000. +

+
+
max_port
+

Set maximum local UDP port. Default value is 65000. +

+
+
timeout
+

Set maximum timeout (in seconds) to wait for incoming connections. +

+

A value of -1 means infinite (default). This option implies the +rtsp_flags set to ‘listen’. +

+
+
reorder_queue_size
+

Set number of packets to buffer for handling of reordered packets. +

+
+
stimeout
+

Set socket TCP I/O timeout in microseconds. +

+
+
user-agent
+

Override User-Agent header. If not specified, it defaults to the +libavformat identifier string. +

+
+ +

When receiving data over UDP, the demuxer tries to reorder received packets +(since they may arrive out of order, or packets may get lost totally). This +can be disabled by setting the maximum demuxing delay to zero (via +the max_delay field of AVFormatContext). +

+

When watching multi-bitrate Real-RTSP streams with ffplay, the +streams to display can be chosen with -vst n and +-ast n for video and audio respectively, and can be switched +on the fly by pressing v and a. +

+ +

3.29.1 Examples

+ +

The following examples all make use of the ffplay and +ffmpeg tools. +

+
    +
  • Watch a stream over UDP, with a max reordering delay of 0.5 seconds: +
    +
    ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
+
    + +
  • Watch a stream tunneled over HTTP: +
    +
    ffplay -rtsp_transport http rtsp://server/video.mp4
+
    + +
  • Send a stream in realtime to a RTSP server, for others to watch: +
    +
    ffmpeg -re -i input -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
+
    + +
  • Receive a stream in realtime: +
    +
    ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp output
+
    +
+ + +

3.30 sap

+ +

Session Announcement Protocol (RFC 2974). This is not technically a +protocol handler in libavformat, it is a muxer and demuxer. +It is used for signalling of RTP streams, by announcing the SDP for the +streams regularly on a separate port. +

+ +

3.30.1 Muxer

+ +

The syntax for a SAP url given to the muxer is: +

+
sap://destination[:port][?options]
+
+ +

The RTP packets are sent to destination on port port, +or to port 5004 if no port is specified. +options is a &-separated list. The following options +are supported: +

+
+
announce_addr=address
+

Specify the destination IP address for sending the announcements to. +If omitted, the announcements are sent to the commonly used SAP +announcement multicast address 224.2.127.254 (sap.mcast.net), or +ff0e::2:7ffe if destination is an IPv6 address. +

+
+
announce_port=port
+

Specify the port to send the announcements on, defaults to +9875 if not specified. +

+
+
ttl=ttl
+

Specify the time to live value for the announcements and RTP packets, +defaults to 255. +

+
+
same_port=0|1
+

If set to 1, send all RTP streams on the same port pair. If zero (the +default), all streams are sent on unique ports, with each stream on a +port 2 numbers higher than the previous. +VLC/Live555 requires this to be set to 1, to be able to receive the stream. +The RTP stack in libavformat for receiving requires all streams to be sent +on unique ports. +

+
+ +

Example command lines follow. +

+

To broadcast a stream on the local subnet, for watching in VLC: +

+
+
ffmpeg -re -i input -f sap sap://224.0.0.255?same_port=1
+
+ +

Similarly, for watching in ffplay: +

+
+
ffmpeg -re -i input -f sap sap://224.0.0.255
+
+ +

And for watching in ffplay, over IPv6: +

+
+
ffmpeg -re -i input -f sap sap://[ff0e::1:2:3:4]
+
+ + +

3.30.2 Demuxer

+ +

The syntax for a SAP url given to the demuxer is: +

+
sap://[address][:port]
+
+ +

address is the multicast address to listen for announcements on, +if omitted, the default 224.2.127.254 (sap.mcast.net) is used. port +is the port that is listened on, 9875 if omitted. +

+

The demuxers listens for announcements on the given address and port. +Once an announcement is received, it tries to receive that particular stream. +

+

Example command lines follow. +

+

To play back the first stream announced on the normal SAP multicast address: +

+
+
ffplay sap://
+
+ +

To play back the first stream announced on one the default IPv6 SAP multicast address: +

+
+
ffplay sap://[ff0e::2:7ffe]
+
+ + +

3.31 sctp

+ +

Stream Control Transmission Protocol. +

+

The accepted URL syntax is: +

+
sctp://host:port[?options]
+
+ +

The protocol accepts the following options: +

+
listen
+

If set to any value, listen for an incoming connection. Outgoing connection is done by default. +

+
+
max_streams
+

Set the maximum number of streams. By default no limit is set. +

+
+ + +

3.32 srt

+ +

Haivision Secure Reliable Transport Protocol via libsrt. +

+

The supported syntax for a SRT URL is: +

+
srt://hostname:port[?options]
+
+ +

options contains a list of &-separated options of the form +key=val. +

+

or +

+
+
options srt://hostname:port
+
+ +

options contains a list of ’-key val’ +options. +

+

This protocol accepts the following options. +

+
+
connect_timeout=milliseconds
+

Connection timeout; SRT cannot connect for RTT > 1500 msec +(2 handshake exchanges) with the default connect timeout of +3 seconds. This option applies to the caller and rendezvous +connection modes. The connect timeout is 10 times the value +set for the rendezvous mode (which can be used as a +workaround for this connection problem with earlier versions). +

+
+
ffs=bytes
+

Flight Flag Size (Window Size), in bytes. FFS is actually an +internal parameter and you should set it to not less than +recv_buffer_size and mss. The default value +is relatively large, therefore unless you set a very large receiver buffer, +you do not need to change this option. Default value is 25600. +

+
+
inputbw=bytes/seconds
+

Sender nominal input rate, in bytes per seconds. Used along with +oheadbw, when maxbw is set to relative (0), to +calculate maximum sending rate when recovery packets are sent +along with the main media stream: +inputbw * (100 + oheadbw) / 100 +if inputbw is not set while maxbw is set to +relative (0), the actual input rate is evaluated inside +the library. Default value is 0. +

+
+
iptos=tos
+

IP Type of Service. Applies to sender only. Default value is 0xB8. +

+
+
ipttl=ttl
+

IP Time To Live. Applies to sender only. Default value is 64. +

+
+
latency=microseconds
+

Timestamp-based Packet Delivery Delay. +Used to absorb bursts of missed packet retransmissions. +This flag sets both rcvlatency and peerlatency +to the same value. Note that prior to version 1.3.0 +this is the only flag to set the latency, however +this is effectively equivalent to setting peerlatency, +when side is sender and rcvlatency +when side is receiver, and the bidirectional stream +sending is not supported. +

+
+
listen_timeout=microseconds
+

Set socket listen timeout. +

+
+
maxbw=bytes/seconds
+

Maximum sending bandwidth, in bytes per seconds. +-1 infinite (CSRTCC limit is 30mbps) +0 relative to input rate (see inputbw) +>0 absolute limit value +Default value is 0 (relative) +

+
+
mode=caller|listener|rendezvous
+

Connection mode. +caller opens client connection. +listener starts server to listen for incoming connections. +rendezvous use Rendez-Vous connection mode. +Default value is caller. +

+
+
mss=bytes
+

Maximum Segment Size, in bytes. Used for buffer allocation +and rate calculation using a packet counter assuming fully +filled packets. The smallest MSS between the peers is +used. This is 1500 by default in the overall internet. +This is the maximum size of the UDP packet and can be +only decreased, unless you have some unusual dedicated +network settings. Default value is 1500. +

+
+
nakreport=1|0
+

If set to 1, Receiver will send ‘UMSG_LOSSREPORT‘ messages +periodically until a lost packet is retransmitted or +intentionally dropped. Default value is 1. +

+
+
oheadbw=percents
+

Recovery bandwidth overhead above input rate, in percents. +See inputbw. Default value is 25%. +

+
+
passphrase=string
+

HaiCrypt Encryption/Decryption Passphrase string, length +from 10 to 79 characters. The passphrase is the shared +secret between the sender and the receiver. It is used +to generate the Key Encrypting Key using PBKDF2 +(Password-Based Key Derivation Function). It is used +only if pbkeylen is non-zero. It is used on +the receiver only if the received data is encrypted. +The configured passphrase cannot be recovered (write-only). +

+
+
enforced_encryption=1|0
+

If true, both connection parties must have the same password +set (including empty, that is, with no encryption). If the +password doesn’t match or only one side is unencrypted, +the connection is rejected. Default is true. +

+
+
kmrefreshrate=packets
+

The number of packets to be transmitted after which the +encryption key is switched to a new key. Default is -1. +-1 means auto (0x1000000 in srt library). The range for +this option is integers in the 0 - INT_MAX. +

+
+
kmpreannounce=packets
+

The interval between when a new encryption key is sent and +when switchover occurs. This value also applies to the +subsequent interval between when switchover occurs and +when the old encryption key is decommissioned. Default is -1. +-1 means auto (0x1000 in srt library). The range for +this option is integers in the 0 - INT_MAX. +

+
+
payload_size=bytes
+

Sets the maximum declared size of a packet transferred +during the single call to the sending function in Live +mode. Use 0 if this value isn’t used (which is default in +file mode). +Default is -1 (automatic), which typically means MPEG-TS; +if you are going to use SRT +to send any different kind of payload, such as, for example, +wrapping a live stream in very small frames, then you can +use a bigger maximum frame size, though not greater than +1456 bytes. +

+
+
pkt_size=bytes
+

Alias for ‘payload_size’. +

+
+
peerlatency=microseconds
+

The latency value (as described in rcvlatency) that is +set by the sender side as a minimum value for the receiver. +

+
+
pbkeylen=bytes
+

Sender encryption key length, in bytes. +Only can be set to 0, 16, 24 and 32. +Enable sender encryption if not 0. +Not required on receiver (set to 0), +key size obtained from sender in HaiCrypt handshake. +Default value is 0. +

+
+
rcvlatency=microseconds
+

The time that should elapse since the moment when the +packet was sent and the moment when it’s delivered to +the receiver application in the receiving function. +This time should be a buffer time large enough to cover +the time spent for sending, unexpectedly extended RTT +time, and the time needed to retransmit the lost UDP +packet. The effective latency value will be the maximum +of this options’ value and the value of peerlatency +set by the peer side. Before version 1.3.0 this option +is only available as latency. +

+
+
recv_buffer_size=bytes
+

Set UDP receive buffer size, expressed in bytes. +

+
+
send_buffer_size=bytes
+

Set UDP send buffer size, expressed in bytes. +

+
+
timeout=microseconds
+

Set raise error timeouts for read, write and connect operations. Note that the +SRT library has internal timeouts which can be controlled separately, the +value set here is only a cap on those. +

+
+
tlpktdrop=1|0
+

Too-late Packet Drop. When enabled on receiver, it skips +missing packets that have not been delivered in time and +delivers the following packets to the application when +their time-to-play has come. It also sends a fake ACK to +the sender. When enabled on sender and enabled on the +receiving peer, the sender drops the older packets that +have no chance of being delivered in time. It was +automatically enabled in the sender if the receiver +supports it. +

+
+
sndbuf=bytes
+

Set send buffer size, expressed in bytes. +

+
+
rcvbuf=bytes
+

Set receive buffer size, expressed in bytes. +

+

Receive buffer must not be greater than ffs. +

+
+
lossmaxttl=packets
+

The value up to which the Reorder Tolerance may grow. When +Reorder Tolerance is > 0, then packet loss report is delayed +until that number of packets come in. Reorder Tolerance +increases every time a "belated" packet has come, but it +wasn’t due to retransmission (that is, when UDP packets tend +to come out of order), with the difference between the latest +sequence and this packet’s sequence, and not more than the +value of this option. By default it’s 0, which means that this +mechanism is turned off, and the loss report is always sent +immediately upon experiencing a "gap" in sequences. +

+
+
minversion
+

The minimum SRT version that is required from the peer. A connection +to a peer that does not satisfy the minimum version requirement +will be rejected. +

+

The version format in hex is 0xXXYYZZ for x.y.z in human readable +form. +

+
+
streamid=string
+

A string limited to 512 characters that can be set on the socket prior +to connecting. This stream ID will be able to be retrieved by the +listener side from the socket that is returned from srt_accept and +was connected by a socket with that set stream ID. SRT does not enforce +any special interpretation of the contents of this string. +This option doesn’t make sense in Rendezvous connection; the result +might be that simply one side will override the value from the other +side and it’s the matter of luck which one would win +

+
+
smoother=live|file
+

The type of Smoother used for the transmission for that socket, which +is responsible for the transmission and congestion control. The Smoother +type must be exactly the same on both connecting parties, otherwise +the connection is rejected. +

+
+
messageapi=1|0
+

When set, this socket uses the Message API, otherwise it uses Buffer +API. Note that in live mode (see transtype) there’s only +message API available. In File mode you can chose to use one of two modes: +

+

Stream API (default, when this option is false). In this mode you may +send as many data as you wish with one sending instruction, or even use +dedicated functions that read directly from a file. The internal facility +will take care of any speed and congestion control. When receiving, you +can also receive as many data as desired, the data not extracted will be +waiting for the next call. There is no boundary between data portions in +the Stream mode. +

+

Message API. In this mode your single sending instruction passes exactly +one piece of data that has boundaries (a message). Contrary to Live mode, +this message may span across multiple UDP packets and the only size +limitation is that it shall fit as a whole in the sending buffer. The +receiver shall use as large buffer as necessary to receive the message, +otherwise the message will not be given up. When the message is not +complete (not all packets received or there was a packet loss) it will +not be given up. +

+
+
transtype=live|file
+

Sets the transmission type for the socket, in particular, setting this +option sets multiple other parameters to their default values as required +for a particular transmission type. +

+

live: Set options as for live transmission. In this mode, you should +send by one sending instruction only so many data that fit in one UDP packet, +and limited to the value defined first in payload_size (1316 is +default in this mode). There is no speed control in this mode, only the +bandwidth control, if configured, in order to not exceed the bandwidth with +the overhead transmission (retransmitted and control packets). +

+

file: Set options as for non-live transmission. See messageapi +for further explanations +

+
+
linger=seconds
+

The number of seconds that the socket waits for unsent data when closing. +Default is -1. -1 means auto (off with 0 seconds in live mode, on with 180 +seconds in file mode). The range for this option is integers in the +0 - INT_MAX. +

+
+
+ +

For more information see: https://github.com/Haivision/srt. +

+ +

3.33 srtp

+ +

Secure Real-time Transport Protocol. +

+

The accepted options are: +

+
srtp_in_suite
+
srtp_out_suite
+

Select input and output encoding suites. +

+

Supported values: +

+
‘AES_CM_128_HMAC_SHA1_80’
+
‘SRTP_AES128_CM_HMAC_SHA1_80’
+
‘AES_CM_128_HMAC_SHA1_32’
+
‘SRTP_AES128_CM_HMAC_SHA1_32’
+
+ +
+
srtp_in_params
+
srtp_out_params
+

Set input and output encoding parameters, which are expressed by a +base64-encoded representation of a binary block. The first 16 bytes of +this binary block are used as master key, the following 14 bytes are +used as master salt. +

+
+ + +

3.34 subfile

+ +

Virtually extract a segment of a file or another stream. +The underlying stream must be seekable. +

+

Accepted options: +

+
start
+

Start offset of the extracted segment, in bytes. +

+
end
+

End offset of the extracted segment, in bytes. +If set to 0, extract till end of file. +

+
+ +

Examples: +

+

Extract a chapter from a DVD VOB file (start and end sectors obtained +externally and multiplied by 2048): +

+
subfile,,start,153391104,end,268142592,,:/media/dvd/VIDEO_TS/VTS_08_1.VOB
+
+ +

Play an AVI file directly from a TAR archive: +

+
subfile,,start,183241728,end,366490624,,:archive.tar
+
+ +

Play a MPEG-TS file from start offset till end: +

+
subfile,,start,32815239,end,0,,:video.ts
+
+ + +

3.35 tee

+ +

Writes the output to multiple protocols. The individual outputs are separated +by | +

+
+
tee:file://path/to/local/this.avi|file://path/to/local/that.avi
+
+ + +

3.36 tcp

+ +

Transmission Control Protocol. +

+

The required syntax for a TCP url is: +

+
tcp://hostname:port[?options]
+
+ +

options contains a list of &-separated options of the form +key=val. +

+

The list of supported options follows. +

+
+
listen=1|0
+

Listen for an incoming connection. Default value is 0. +

+
+
timeout=microseconds
+

Set raise error timeout, expressed in microseconds. +

+

This option is only relevant in read mode: if no data arrived in more +than this time interval, raise error. +

+
+
listen_timeout=milliseconds
+

Set listen timeout, expressed in milliseconds. +

+
+
recv_buffer_size=bytes
+

Set receive buffer size, expressed bytes. +

+
+
send_buffer_size=bytes
+

Set send buffer size, expressed bytes. +

+
+
tcp_nodelay=1|0
+

Set TCP_NODELAY to disable Nagle’s algorithm. Default value is 0. +

+
+
tcp_mss=bytes
+

Set maximum segment size for outgoing TCP packets, expressed in bytes. +

+
+ +

The following example shows how to setup a listening TCP connection +with ffmpeg, which is then accessed with ffplay: +

+
ffmpeg -i input -f format tcp://hostname:port?listen
+ffplay tcp://hostname:port
+
+ + +

3.37 tls

+ +

Transport Layer Security (TLS) / Secure Sockets Layer (SSL) +

+

The required syntax for a TLS/SSL url is: +

+
tls://hostname:port[?options]
+
+ +

The following parameters can be set via command line options +(or in code via AVOptions): +

+
+
ca_file, cafile=filename
+

A file containing certificate authority (CA) root certificates to treat +as trusted. If the linked TLS library contains a default this might not +need to be specified for verification to work, but not all libraries and +setups have defaults built in. +The file must be in OpenSSL PEM format. +

+
+
tls_verify=1|0
+

If enabled, try to verify the peer that we are communicating with. +Note, if using OpenSSL, this currently only makes sure that the +peer certificate is signed by one of the root certificates in the CA +database, but it does not validate that the certificate actually +matches the host name we are trying to connect to. (With other backends, +the host name is validated as well.) +

+

This is disabled by default since it requires a CA database to be +provided by the caller in many cases. +

+
+
cert_file, cert=filename
+

A file containing a certificate to use in the handshake with the peer. +(When operating as server, in listen mode, this is more often required +by the peer, while client certificates only are mandated in certain +setups.) +

+
+
key_file, key=filename
+

A file containing the private key for the certificate. +

+
+
listen=1|0
+

If enabled, listen for connections on the provided port, and assume +the server role in the handshake instead of the client role. +

+
+
+ +

Example command lines: +

+

To create a TLS/SSL server that serves an input stream. +

+
+
ffmpeg -i input -f format tls://hostname:port?listen&cert=server.crt&key=server.key
+
+ +

To play back a stream from the TLS/SSL server using ffplay: +

+
+
ffplay tls://hostname:port
+
+ + +

3.38 udp

+ +

User Datagram Protocol. +

+

The required syntax for an UDP URL is: +

+
udp://hostname:port[?options]
+
+ +

options contains a list of &-separated options of the form key=val. +

+

In case threading is enabled on the system, a circular buffer is used +to store the incoming data, which allows one to reduce loss of data due to +UDP socket buffer overruns. The fifo_size and +overrun_nonfatal options are related to this buffer. +

+

The list of supported options follows. +

+
+
buffer_size=size
+

Set the UDP maximum socket buffer size in bytes. This is used to set either +the receive or send buffer size, depending on what the socket is used for. +Default is 32 KB for output, 384 KB for input. See also fifo_size. +

+
+
bitrate=bitrate
+

If set to nonzero, the output will have the specified constant bitrate if the +input has enough packets to sustain it. +

+
+
burst_bits=bits
+

When using bitrate this specifies the maximum number of bits in +packet bursts. +

+
+
localport=port
+

Override the local UDP port to bind with. +

+
+
localaddr=addr
+

Local IP address of a network interface used for sending packets or joining +multicast groups. +

+
+
pkt_size=size
+

Set the size in bytes of UDP packets. +

+
+
reuse=1|0
+

Explicitly allow or disallow reusing UDP sockets. +

+
+
ttl=ttl
+

Set the time to live value (for multicast only). +

+
+
connect=1|0
+

Initialize the UDP socket with connect(). In this case, the +destination address can’t be changed with ff_udp_set_remote_url later. +If the destination address isn’t known at the start, this option can +be specified in ff_udp_set_remote_url, too. +This allows finding out the source address for the packets with getsockname, +and makes writes return with AVERROR(ECONNREFUSED) if "destination +unreachable" is received. +For receiving, this gives the benefit of only receiving packets from +the specified peer address/port. +

+
+
sources=address[,address]
+

Only receive packets sent from the specified addresses. In case of multicast, +also subscribe to multicast traffic coming from these addresses only. +

+
+
block=address[,address]
+

Ignore packets sent from the specified addresses. In case of multicast, also +exclude the source addresses in the multicast subscription. +

+
+
fifo_size=units
+

Set the UDP receiving circular buffer size, expressed as a number of +packets with size of 188 bytes. If not specified defaults to 7*4096. +

+
+
overrun_nonfatal=1|0
+

Survive in case of UDP receiving circular buffer overrun. Default +value is 0. +

+
+
timeout=microseconds
+

Set raise error timeout, expressed in microseconds. +

+

This option is only relevant in read mode: if no data arrived in more +than this time interval, raise error. +

+
+
broadcast=1|0
+

Explicitly allow or disallow UDP broadcasting. +

+

Note that broadcasting may not work properly on networks having +a broadcast storm protection. +

+
+ + +

3.38.1 Examples

+ +
    +
  • Use ffmpeg to stream over UDP to a remote endpoint: +
    +
    ffmpeg -i input -f format udp://hostname:port
+
    + +
  • Use ffmpeg to stream in mpegts format over UDP using 188 +sized UDP packets, using a large input buffer: +
    +
    ffmpeg -i input -f mpegts udp://hostname:port?pkt_size=188&buffer_size=65535
+
    + +
  • Use ffmpeg to receive over UDP from a remote endpoint: +
    +
    ffmpeg -i udp://[multicast-address]:port ...
+
    +
+ + +

3.39 unix

+ +

Unix local socket +

+

The required syntax for a Unix socket URL is: +

+
+
unix://filepath
+
+ +

The following parameters can be set via command line options +(or in code via AVOptions): +

+
+
timeout
+

Timeout in ms. +

+
listen
+

Create the Unix socket in listening mode. +

+
+ + +

3.40 zmq

+ +

ZeroMQ asynchronous messaging using the libzmq library. +

+

This library supports unicast streaming to multiple clients without relying on +an external server. +

+

The required syntax for streaming or connecting to a stream is: +

+
zmq:tcp://ip-address:port
+
+ +

Example: +Create a localhost stream on port 5555: +

+
ffmpeg -re -i input -f mpegts zmq:tcp://127.0.0.1:5555
+
+ +

Multiple clients may connect to the stream using: +

+
ffplay zmq:tcp://127.0.0.1:5555
+
+ +

Streaming to multiple clients is implemented using a ZeroMQ Pub-Sub pattern. +The server side binds to a port and publishes data. Clients connect to the +server (via IP address/port) and subscribe to the stream. The order in which +the server and client start generally does not matter. +

+

ffmpeg must be compiled with the –enable-libzmq option to support +this protocol. +

+

Options can be set on the ffmpeg/ffplay command +line. The following options are supported: +

+
+
pkt_size
+

Forces the maximum packet size for sending/receiving data. The default value is +131,072 bytes. On the server side, this sets the maximum size of sent packets +via ZeroMQ. On the clients, it sets an internal buffer size for receiving +packets. Note that pkt_size on the clients should be equal to or greater than +pkt_size on the server. Otherwise the received message may be truncated causing +decoding errors. +

+
+
+ + + + +

4 See Also

+ +

ffmpeg, ffplay, ffprobe, +libavformat +

+ + +

5 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-resampler.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-resampler.html new file mode 100644 index 0000000..b39b745 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-resampler.html @@ -0,0 +1,365 @@ + + + + + + + FFmpeg Resampler Documentation + + + + + + +
+

+ FFmpeg Resampler Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

The FFmpeg resampler provides a high-level interface to the +libswresample library audio resampling utilities. In particular it +allows one to perform audio resampling, audio channel layout rematrixing, +and convert audio format and packing layout. +

+ + +

2 Resampler Options

+ +

The audio resampler supports the following named options. +

+

Options may be set by specifying -option value in the +FFmpeg tools, option=value for the aresample filter, +by setting the value explicitly in the +SwrContext options or using the libavutil/opt.h API for +programmatic use. +

+
+
ich, in_channel_count
+

Set the number of input channels. Default value is 0. Setting this +value is not mandatory if the corresponding channel layout +in_channel_layout is set. +

+
+
och, out_channel_count
+

Set the number of output channels. Default value is 0. Setting this +value is not mandatory if the corresponding channel layout +out_channel_layout is set. +

+
+
uch, used_channel_count
+

Set the number of used input channels. Default value is 0. This option is +only used for special remapping. +

+
+
isr, in_sample_rate
+

Set the input sample rate. Default value is 0. +

+
+
osr, out_sample_rate
+

Set the output sample rate. Default value is 0. +

+
+
isf, in_sample_fmt
+

Specify the input sample format. It is set by default to none. +

+
+
osf, out_sample_fmt
+

Specify the output sample format. It is set by default to none. +

+
+
tsf, internal_sample_fmt
+

Set the internal sample format. Default value is none. +This will automatically be chosen when it is not explicitly set. +

+
+
icl, in_channel_layout
+
ocl, out_channel_layout
+

Set the input/output channel layout. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+
clev, center_mix_level
+

Set the center mix level. It is a value expressed in deciBel, and must be +in the interval [-32,32]. +

+
+
slev, surround_mix_level
+

Set the surround mix level. It is a value expressed in deciBel, and must +be in the interval [-32,32]. +

+
+
lfe_mix_level
+

Set LFE mix into non LFE level. It is used when there is a LFE input but no +LFE output. It is a value expressed in deciBel, and must +be in the interval [-32,32]. +

+
+
rmvol, rematrix_volume
+

Set rematrix volume. Default value is 1.0. +

+
+
rematrix_maxval
+

Set maximum output value for rematrixing. +This can be used to prevent clipping vs. preventing volume reduction. +A value of 1.0 prevents clipping. +

+
+
flags, swr_flags
+

Set flags used by the converter. Default value is 0. +

+

It supports the following individual flags: +

+
res
+

force resampling, this flag forces resampling to be used even when the +input and output sample rates match. +

+
+ +
+
dither_scale
+

Set the dither scale. Default value is 1. +

+
+
dither_method
+

Set dither method. Default value is 0. +

+

Supported values: +

+
‘rectangular’
+

select rectangular dither +

+
‘triangular’
+

select triangular dither +

+
‘triangular_hp’
+

select triangular dither with high pass +

+
‘lipshitz’
+

select Lipshitz noise shaping dither. +

+
‘shibata’
+

select Shibata noise shaping dither. +

+
‘low_shibata’
+

select low Shibata noise shaping dither. +

+
‘high_shibata’
+

select high Shibata noise shaping dither. +

+
‘f_weighted’
+

select f-weighted noise shaping dither +

+
‘modified_e_weighted’
+

select modified-e-weighted noise shaping dither +

+
‘improved_e_weighted’
+

select improved-e-weighted noise shaping dither +

+
+
+ +
+
resampler
+

Set resampling engine. Default value is swr. +

+

Supported values: +

+
‘swr’
+

select the native SW Resampler; filter options precision and cheby are not +applicable in this case. +

+
‘soxr’
+

select the SoX Resampler (where available); compensation, and filter options +filter_size, phase_shift, exact_rational, filter_type & kaiser_beta, are not +applicable in this case. +

+
+ +
+
filter_size
+

For swr only, set resampling filter size, default value is 32. +

+
+
phase_shift
+

For swr only, set resampling phase shift, default value is 10, and must be in +the interval [0,30]. +

+
+
linear_interp
+

Use linear interpolation when enabled (the default). Disable it if you want +to preserve speed instead of quality when exact_rational fails. +

+
+
exact_rational
+

For swr only, when enabled, try to use exact phase_count based on input and +output sample rate. However, if it is larger than 1 << phase_shift, +the phase_count will be 1 << phase_shift as fallback. Default is enabled. +

+
+
cutoff
+

Set cutoff frequency (swr: 6dB point; soxr: 0dB point) ratio; must be a float +value between 0 and 1. Default value is 0.97 with swr, and 0.91 with soxr +(which, with a sample-rate of 44100, preserves the entire audio band to 20kHz). +

+
+
precision
+

For soxr only, the precision in bits to which the resampled signal will be +calculated. The default value of 20 (which, with suitable dithering, is +appropriate for a destination bit-depth of 16) gives SoX’s ’High Quality’; a +value of 28 gives SoX’s ’Very High Quality’. +

+
+
cheby
+

For soxr only, selects passband rolloff none (Chebyshev) & higher-precision +approximation for ’irrational’ ratios. Default value is 0. +

+
+
async
+

For swr only, simple 1 parameter audio sync to timestamps using stretching, +squeezing, filling and trimming. Setting this to 1 will enable filling and +trimming, larger values represent the maximum amount in samples that the data +may be stretched or squeezed for each second. +Default value is 0, thus no compensation is applied to make the samples match +the audio timestamps. +

+
+
first_pts
+

For swr only, assume the first pts should be this value. The time unit is 1 / sample rate. +This allows for padding/trimming at the start of stream. By default, no +assumption is made about the first frame’s expected pts, so no padding or +trimming is done. For example, this could be set to 0 to pad the beginning with +silence if an audio stream starts after the video stream or to trim any samples +with a negative pts due to encoder delay. +

+
+
min_comp
+

For swr only, set the minimum difference between timestamps and audio data (in +seconds) to trigger stretching/squeezing/filling or trimming of the +data to make it match the timestamps. The default is that +stretching/squeezing/filling and trimming is disabled +(min_comp = FLT_MAX). +

+
+
min_hard_comp
+

For swr only, set the minimum difference between timestamps and audio data (in +seconds) to trigger adding/dropping samples to make it match the +timestamps. This option effectively is a threshold to select between +hard (trim/fill) and soft (squeeze/stretch) compensation. Note that +all compensation is by default disabled through min_comp. +The default is 0.1. +

+
+
comp_duration
+

For swr only, set duration (in seconds) over which data is stretched/squeezed +to make it match the timestamps. Must be a non-negative double float value, +default value is 1.0. +

+
+
max_soft_comp
+

For swr only, set maximum factor by which data is stretched/squeezed to make it +match the timestamps. Must be a non-negative double float value, default value +is 0. +

+
+
matrix_encoding
+

Select matrixed stereo encoding. +

+

It accepts the following values: +

+
‘none’
+

select none +

+
‘dolby’
+

select Dolby +

+
‘dplii’
+

select Dolby Pro Logic II +

+
+ +

Default value is none. +

+
+
filter_type
+

For swr only, select resampling filter type. This only affects resampling +operations. +

+

It accepts the following values: +

+
‘cubic’
+

select cubic +

+
‘blackman_nuttall’
+

select Blackman Nuttall windowed sinc +

+
‘kaiser’
+

select Kaiser windowed sinc +

+
+ +
+
kaiser_beta
+

For swr only, set Kaiser window beta value. Must be a double float value in the +interval [2,16], default value is 9. +

+
+
output_sample_bits
+

For swr only, set number of used output sample bits for dithering. Must be an integer in the +interval [0,64], default value is 0, which means it’s not used. +

+
+
+ + + +

3 See Also

+ +

ffmpeg, ffplay, ffprobe, +libswresample +

+ + +

4 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-scaler.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-scaler.html new file mode 100644 index 0000000..81e8345 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-scaler.html @@ -0,0 +1,257 @@ + + + + + + + FFmpeg Scaler Documentation + + + + + + +
+

+ FFmpeg Scaler Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

The FFmpeg rescaler provides a high-level interface to the libswscale +library image conversion utilities. In particular it allows one to perform +image rescaling and pixel format conversion. +

+ + +

2 Scaler Options

+ +

The video scaler supports the following named options. +

+

Options may be set by specifying -option value in the +FFmpeg tools, with a few API-only exceptions noted below. +For programmatic use, they can be set explicitly in the +SwsContext options or through the libavutil/opt.h API. +

+
+
+
+
sws_flags
+

Set the scaler flags. This is also used to set the scaling +algorithm. Only a single algorithm should be selected. Default +value is ‘bicubic’. +

+

It accepts the following values: +

+
‘fast_bilinear’
+

Select fast bilinear scaling algorithm. +

+
+
‘bilinear’
+

Select bilinear scaling algorithm. +

+
+
‘bicubic’
+

Select bicubic scaling algorithm. +

+
+
‘experimental’
+

Select experimental scaling algorithm. +

+
+
‘neighbor’
+

Select nearest neighbor rescaling algorithm. +

+
+
‘area’
+

Select averaging area rescaling algorithm. +

+
+
‘bicublin’
+

Select bicubic scaling algorithm for the luma component, bilinear for +chroma components. +

+
+
‘gauss’
+

Select Gaussian rescaling algorithm. +

+
+
‘sinc’
+

Select sinc rescaling algorithm. +

+
+
‘lanczos’
+

Select Lanczos rescaling algorithm. The default width (alpha) is 3 and can be +changed by setting param0. +

+
+
‘spline’
+

Select natural bicubic spline rescaling algorithm. +

+
+
‘print_info’
+

Enable printing/debug logging. +

+
+
‘accurate_rnd’
+

Enable accurate rounding. +

+
+
‘full_chroma_int’
+

Enable full chroma interpolation. +

+
+
‘full_chroma_inp’
+

Select full chroma input. +

+
+
‘bitexact’
+

Enable bitexact output. +

+
+ +
+
srcw (API only)
+

Set source width. +

+
+
srch (API only)
+

Set source height. +

+
+
dstw (API only)
+

Set destination width. +

+
+
dsth (API only)
+

Set destination height. +

+
+
src_format (API only)
+

Set source pixel format (must be expressed as an integer). +

+
+
dst_format (API only)
+

Set destination pixel format (must be expressed as an integer). +

+
+
src_range (boolean)
+

If value is set to 1, indicates source is full range. Default value is +0, which indicates source is limited range. +

+
+
dst_range (boolean)
+

If value is set to 1, enable full range for destination. Default value +is 0, which enables limited range. +

+
+
param0, param1
+

Set scaling algorithm parameters. The specified values are specific of +some scaling algorithms and ignored by others. The specified values +are floating point number values. +

+
+
sws_dither
+

Set the dithering algorithm. Accepts one of the following +values. Default value is ‘auto’. +

+
+
‘auto’
+

automatic choice +

+
+
‘none’
+

no dithering +

+
+
‘bayer’
+

bayer dither +

+
+
‘ed’
+

error diffusion dither +

+
+
‘a_dither’
+

arithmetic dither, based using addition +

+
+
‘x_dither’
+

arithmetic dither, based using xor (more random/less apparent patterning that +a_dither). +

+
+
+ +
+
alphablend
+

Set the alpha blending to use when the input has alpha but the output does not. +Default value is ‘none’. +

+
+
‘uniform_color’
+

Blend onto a uniform background color +

+
+
‘checkerboard’
+

Blend onto a checkerboard +

+
+
‘none’
+

No blending +

+
+
+ +
+
+ + + +

3 See Also

+ +

ffmpeg, ffplay, ffprobe, +libswscale +

+ + +

4 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-utils.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-utils.html new file mode 100644 index 0000000..d835bb2 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg-utils.html @@ -0,0 +1,1483 @@ + + + + + + + FFmpeg Utilities Documentation + + + + + + +
+

+ FFmpeg Utilities Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

This document describes some generic features and utilities provided +by the libavutil library. +

+ + +

2 Syntax

+ +

This section documents the syntax and formats employed by the FFmpeg +libraries and tools. +

+ +

2.1 Quoting and escaping

+ +

FFmpeg adopts the following quoting and escaping mechanism, unless +explicitly specified. The following rules are applied: +

+
    +
  • ‘'’ and ‘\’ are special characters (respectively used for +quoting and escaping). In addition to them, there might be other +special characters depending on the specific syntax where the escaping +and quoting are employed. + +
  • A special character is escaped by prefixing it with a ‘\’. + +
  • All characters enclosed between ‘''’ are included literally in the +parsed string. The quote character ‘'’ itself cannot be quoted, +so you may need to close the quote and escape it. + +
  • Leading and trailing whitespaces, unless escaped or quoted, are +removed from the parsed string. +
+ +

Note that you may need to add a second level of escaping when using +the command line or a script, which depends on the syntax of the +adopted shell language. +

+

The function av_get_token defined in +libavutil/avstring.h can be used to parse a token quoted or +escaped according to the rules defined above. +

+

The tool tools/ffescape in the FFmpeg source tree can be used +to automatically quote or escape a string in a script. +

+ +

2.1.1 Examples

+ +
    +
  • Escape the string Crime d'Amour containing the ' special +character: +
    +
    Crime d\'Amour
+
    + +
  • The string above contains a quote, so the ' needs to be escaped +when quoting it: +
    +
    'Crime d'\''Amour'
+
    + +
  • Include leading or trailing whitespaces using quoting: +
    +
    '  this string starts and ends with whitespaces  '
+
    + +
  • Escaping and quoting can be mixed together: +
    +
    ' The string '\'string\'' is a string '
+
    + +
  • To include a literal ‘\’ you can use either escaping or quoting: +
    +
    'c:\foo' can be written as c:\\foo
+
    +
+ + +

2.2 Date

+ +

The accepted syntax is: +

+
[(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH:MM:SS[.m...]]])|(HHMMSS[.m...]]]))[Z]
+now
+
+ +

If the value is "now" it takes the current time. +

+

Time is local time unless Z is appended, in which case it is +interpreted as UTC. +If the year-month-day part is not specified it takes the current +year-month-day. +

+ +

2.3 Time duration

+ +

There are two accepted syntaxes for expressing time duration. +

+
+
[-][HH:]MM:SS[.m...]
+
+ +

HH expresses the number of hours, MM the number of minutes +for a maximum of 2 digits, and SS the number of seconds for a +maximum of 2 digits. The m at the end expresses decimal value for +SS. +

+

or +

+
+
[-]S+[.m...]
+
+ +

S expresses the number of seconds, with the optional decimal part +m. +

+

In both expressions, the optional ‘-’ indicates negative duration. +

+ +

2.3.1 Examples

+ +

The following examples are all valid time duration: +

+
+
‘55’
+

55 seconds +

+
+
‘0.2’
+

0.2 seconds +

+
+
‘200ms’
+

200 milliseconds, that’s 0.2s +

+
+
‘200000us’
+

200000 microseconds, that’s 0.2s +

+
+
‘12:03:45’
+

12 hours, 03 minutes and 45 seconds +

+
+
‘23.189’
+

23.189 seconds +

+
+ + +

2.4 Video size

+

Specify the size of the sourced video, it may be a string of the form +widthxheight, or the name of a size abbreviation. +

+

The following abbreviations are recognized: +

+
‘ntsc’
+

720x480 +

+
‘pal’
+

720x576 +

+
‘qntsc’
+

352x240 +

+
‘qpal’
+

352x288 +

+
‘sntsc’
+

640x480 +

+
‘spal’
+

768x576 +

+
‘film’
+

352x240 +

+
‘ntsc-film’
+

352x240 +

+
‘sqcif’
+

128x96 +

+
‘qcif’
+

176x144 +

+
‘cif’
+

352x288 +

+
‘4cif’
+

704x576 +

+
‘16cif’
+

1408x1152 +

+
‘qqvga’
+

160x120 +

+
‘qvga’
+

320x240 +

+
‘vga’
+

640x480 +

+
‘svga’
+

800x600 +

+
‘xga’
+

1024x768 +

+
‘uxga’
+

1600x1200 +

+
‘qxga’
+

2048x1536 +

+
‘sxga’
+

1280x1024 +

+
‘qsxga’
+

2560x2048 +

+
‘hsxga’
+

5120x4096 +

+
‘wvga’
+

852x480 +

+
‘wxga’
+

1366x768 +

+
‘wsxga’
+

1600x1024 +

+
‘wuxga’
+

1920x1200 +

+
‘woxga’
+

2560x1600 +

+
‘wqsxga’
+

3200x2048 +

+
‘wquxga’
+

3840x2400 +

+
‘whsxga’
+

6400x4096 +

+
‘whuxga’
+

7680x4800 +

+
‘cga’
+

320x200 +

+
‘ega’
+

640x350 +

+
‘hd480’
+

852x480 +

+
‘hd720’
+

1280x720 +

+
‘hd1080’
+

1920x1080 +

+
‘2k’
+

2048x1080 +

+
‘2kflat’
+

1998x1080 +

+
‘2kscope’
+

2048x858 +

+
‘4k’
+

4096x2160 +

+
‘4kflat’
+

3996x2160 +

+
‘4kscope’
+

4096x1716 +

+
‘nhd’
+

640x360 +

+
‘hqvga’
+

240x160 +

+
‘wqvga’
+

400x240 +

+
‘fwqvga’
+

432x240 +

+
‘hvga’
+

480x320 +

+
‘qhd’
+

960x540 +

+
‘2kdci’
+

2048x1080 +

+
‘4kdci’
+

4096x2160 +

+
‘uhd2160’
+

3840x2160 +

+
‘uhd4320’
+

7680x4320 +

+
+ + +

2.5 Video rate

+ +

Specify the frame rate of a video, expressed as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a float +number or a valid video frame rate abbreviation. +

+

The following abbreviations are recognized: +

+
‘ntsc’
+

30000/1001 +

+
‘pal’
+

25/1 +

+
‘qntsc’
+

30000/1001 +

+
‘qpal’
+

25/1 +

+
‘sntsc’
+

30000/1001 +

+
‘spal’
+

25/1 +

+
‘film’
+

24/1 +

+
‘ntsc-film’
+

24000/1001 +

+
+ + +

2.6 Ratio

+ +

A ratio can be expressed as an expression, or in the form +numerator:denominator. +

+

Note that a ratio with infinite (1/0) or negative value is +considered valid, so you should check on the returned value if you +want to exclude those values. +

+

The undefined value can be expressed using the "0:0" string. +

+ +

2.7 Color

+ +

It can be the name of a color as defined below (case insensitive match) or a +[0x|#]RRGGBB[AA] sequence, possibly followed by @ and a string +representing the alpha component. +

+

The alpha component may be a string composed by "0x" followed by an +hexadecimal number or a decimal number between 0.0 and 1.0, which +represents the opacity value (‘0x00’ or ‘0.0’ means completely +transparent, ‘0xff’ or ‘1.0’ completely opaque). If the alpha +component is not specified then ‘0xff’ is assumed. +

+

The string ‘random’ will result in a random color. +

+

The following names of colors are recognized: +

+
‘AliceBlue’
+

0xF0F8FF +

+
‘AntiqueWhite’
+

0xFAEBD7 +

+
‘Aqua’
+

0x00FFFF +

+
‘Aquamarine’
+

0x7FFFD4 +

+
‘Azure’
+

0xF0FFFF +

+
‘Beige’
+

0xF5F5DC +

+
‘Bisque’
+

0xFFE4C4 +

+
‘Black’
+

0x000000 +

+
‘BlanchedAlmond’
+

0xFFEBCD +

+
‘Blue’
+

0x0000FF +

+
‘BlueViolet’
+

0x8A2BE2 +

+
‘Brown’
+

0xA52A2A +

+
‘BurlyWood’
+

0xDEB887 +

+
‘CadetBlue’
+

0x5F9EA0 +

+
‘Chartreuse’
+

0x7FFF00 +

+
‘Chocolate’
+

0xD2691E +

+
‘Coral’
+

0xFF7F50 +

+
‘CornflowerBlue’
+

0x6495ED +

+
‘Cornsilk’
+

0xFFF8DC +

+
‘Crimson’
+

0xDC143C +

+
‘Cyan’
+

0x00FFFF +

+
‘DarkBlue’
+

0x00008B +

+
‘DarkCyan’
+

0x008B8B +

+
‘DarkGoldenRod’
+

0xB8860B +

+
‘DarkGray’
+

0xA9A9A9 +

+
‘DarkGreen’
+

0x006400 +

+
‘DarkKhaki’
+

0xBDB76B +

+
‘DarkMagenta’
+

0x8B008B +

+
‘DarkOliveGreen’
+

0x556B2F +

+
‘Darkorange’
+

0xFF8C00 +

+
‘DarkOrchid’
+

0x9932CC +

+
‘DarkRed’
+

0x8B0000 +

+
‘DarkSalmon’
+

0xE9967A +

+
‘DarkSeaGreen’
+

0x8FBC8F +

+
‘DarkSlateBlue’
+

0x483D8B +

+
‘DarkSlateGray’
+

0x2F4F4F +

+
‘DarkTurquoise’
+

0x00CED1 +

+
‘DarkViolet’
+

0x9400D3 +

+
‘DeepPink’
+

0xFF1493 +

+
‘DeepSkyBlue’
+

0x00BFFF +

+
‘DimGray’
+

0x696969 +

+
‘DodgerBlue’
+

0x1E90FF +

+
‘FireBrick’
+

0xB22222 +

+
‘FloralWhite’
+

0xFFFAF0 +

+
‘ForestGreen’
+

0x228B22 +

+
‘Fuchsia’
+

0xFF00FF +

+
‘Gainsboro’
+

0xDCDCDC +

+
‘GhostWhite’
+

0xF8F8FF +

+
‘Gold’
+

0xFFD700 +

+
‘GoldenRod’
+

0xDAA520 +

+
‘Gray’
+

0x808080 +

+
‘Green’
+

0x008000 +

+
‘GreenYellow’
+

0xADFF2F +

+
‘HoneyDew’
+

0xF0FFF0 +

+
‘HotPink’
+

0xFF69B4 +

+
‘IndianRed’
+

0xCD5C5C +

+
‘Indigo’
+

0x4B0082 +

+
‘Ivory’
+

0xFFFFF0 +

+
‘Khaki’
+

0xF0E68C +

+
‘Lavender’
+

0xE6E6FA +

+
‘LavenderBlush’
+

0xFFF0F5 +

+
‘LawnGreen’
+

0x7CFC00 +

+
‘LemonChiffon’
+

0xFFFACD +

+
‘LightBlue’
+

0xADD8E6 +

+
‘LightCoral’
+

0xF08080 +

+
‘LightCyan’
+

0xE0FFFF +

+
‘LightGoldenRodYellow’
+

0xFAFAD2 +

+
‘LightGreen’
+

0x90EE90 +

+
‘LightGrey’
+

0xD3D3D3 +

+
‘LightPink’
+

0xFFB6C1 +

+
‘LightSalmon’
+

0xFFA07A +

+
‘LightSeaGreen’
+

0x20B2AA +

+
‘LightSkyBlue’
+

0x87CEFA +

+
‘LightSlateGray’
+

0x778899 +

+
‘LightSteelBlue’
+

0xB0C4DE +

+
‘LightYellow’
+

0xFFFFE0 +

+
‘Lime’
+

0x00FF00 +

+
‘LimeGreen’
+

0x32CD32 +

+
‘Linen’
+

0xFAF0E6 +

+
‘Magenta’
+

0xFF00FF +

+
‘Maroon’
+

0x800000 +

+
‘MediumAquaMarine’
+

0x66CDAA +

+
‘MediumBlue’
+

0x0000CD +

+
‘MediumOrchid’
+

0xBA55D3 +

+
‘MediumPurple’
+

0x9370D8 +

+
‘MediumSeaGreen’
+

0x3CB371 +

+
‘MediumSlateBlue’
+

0x7B68EE +

+
‘MediumSpringGreen’
+

0x00FA9A +

+
‘MediumTurquoise’
+

0x48D1CC +

+
‘MediumVioletRed’
+

0xC71585 +

+
‘MidnightBlue’
+

0x191970 +

+
‘MintCream’
+

0xF5FFFA +

+
‘MistyRose’
+

0xFFE4E1 +

+
‘Moccasin’
+

0xFFE4B5 +

+
‘NavajoWhite’
+

0xFFDEAD +

+
‘Navy’
+

0x000080 +

+
‘OldLace’
+

0xFDF5E6 +

+
‘Olive’
+

0x808000 +

+
‘OliveDrab’
+

0x6B8E23 +

+
‘Orange’
+

0xFFA500 +

+
‘OrangeRed’
+

0xFF4500 +

+
‘Orchid’
+

0xDA70D6 +

+
‘PaleGoldenRod’
+

0xEEE8AA +

+
‘PaleGreen’
+

0x98FB98 +

+
‘PaleTurquoise’
+

0xAFEEEE +

+
‘PaleVioletRed’
+

0xD87093 +

+
‘PapayaWhip’
+

0xFFEFD5 +

+
‘PeachPuff’
+

0xFFDAB9 +

+
‘Peru’
+

0xCD853F +

+
‘Pink’
+

0xFFC0CB +

+
‘Plum’
+

0xDDA0DD +

+
‘PowderBlue’
+

0xB0E0E6 +

+
‘Purple’
+

0x800080 +

+
‘Red’
+

0xFF0000 +

+
‘RosyBrown’
+

0xBC8F8F +

+
‘RoyalBlue’
+

0x4169E1 +

+
‘SaddleBrown’
+

0x8B4513 +

+
‘Salmon’
+

0xFA8072 +

+
‘SandyBrown’
+

0xF4A460 +

+
‘SeaGreen’
+

0x2E8B57 +

+
‘SeaShell’
+

0xFFF5EE +

+
‘Sienna’
+

0xA0522D +

+
‘Silver’
+

0xC0C0C0 +

+
‘SkyBlue’
+

0x87CEEB +

+
‘SlateBlue’
+

0x6A5ACD +

+
‘SlateGray’
+

0x708090 +

+
‘Snow’
+

0xFFFAFA +

+
‘SpringGreen’
+

0x00FF7F +

+
‘SteelBlue’
+

0x4682B4 +

+
‘Tan’
+

0xD2B48C +

+
‘Teal’
+

0x008080 +

+
‘Thistle’
+

0xD8BFD8 +

+
‘Tomato’
+

0xFF6347 +

+
‘Turquoise’
+

0x40E0D0 +

+
‘Violet’
+

0xEE82EE +

+
‘Wheat’
+

0xF5DEB3 +

+
‘White’
+

0xFFFFFF +

+
‘WhiteSmoke’
+

0xF5F5F5 +

+
‘Yellow’
+

0xFFFF00 +

+
‘YellowGreen’
+

0x9ACD32 +

+
+ + +

2.8 Channel Layout

+ +

A channel layout specifies the spatial disposition of the channels in +a multi-channel audio stream. To specify a channel layout, FFmpeg +makes use of a special syntax. +

+

Individual channels are identified by an id, as given by the table +below: +

+
‘FL’
+

front left +

+
‘FR’
+

front right +

+
‘FC’
+

front center +

+
‘LFE’
+

low frequency +

+
‘BL’
+

back left +

+
‘BR’
+

back right +

+
‘FLC’
+

front left-of-center +

+
‘FRC’
+

front right-of-center +

+
‘BC’
+

back center +

+
‘SL’
+

side left +

+
‘SR’
+

side right +

+
‘TC’
+

top center +

+
‘TFL’
+

top front left +

+
‘TFC’
+

top front center +

+
‘TFR’
+

top front right +

+
‘TBL’
+

top back left +

+
‘TBC’
+

top back center +

+
‘TBR’
+

top back right +

+
‘DL’
+

downmix left +

+
‘DR’
+

downmix right +

+
‘WL’
+

wide left +

+
‘WR’
+

wide right +

+
‘SDL’
+

surround direct left +

+
‘SDR’
+

surround direct right +

+
‘LFE2’
+

low frequency 2 +

+
+ +

Standard channel layout compositions can be specified by using the +following identifiers: +

+
‘mono’
+

FC +

+
‘stereo’
+

FL+FR +

+
‘2.1’
+

FL+FR+LFE +

+
‘3.0’
+

FL+FR+FC +

+
‘3.0(back)’
+

FL+FR+BC +

+
‘4.0’
+

FL+FR+FC+BC +

+
‘quad’
+

FL+FR+BL+BR +

+
‘quad(side)’
+

FL+FR+SL+SR +

+
‘3.1’
+

FL+FR+FC+LFE +

+
‘5.0’
+

FL+FR+FC+BL+BR +

+
‘5.0(side)’
+

FL+FR+FC+SL+SR +

+
‘4.1’
+

FL+FR+FC+LFE+BC +

+
‘5.1’
+

FL+FR+FC+LFE+BL+BR +

+
‘5.1(side)’
+

FL+FR+FC+LFE+SL+SR +

+
‘6.0’
+

FL+FR+FC+BC+SL+SR +

+
‘6.0(front)’
+

FL+FR+FLC+FRC+SL+SR +

+
‘hexagonal’
+

FL+FR+FC+BL+BR+BC +

+
‘6.1’
+

FL+FR+FC+LFE+BC+SL+SR +

+
‘6.1’
+

FL+FR+FC+LFE+BL+BR+BC +

+
‘6.1(front)’
+

FL+FR+LFE+FLC+FRC+SL+SR +

+
‘7.0’
+

FL+FR+FC+BL+BR+SL+SR +

+
‘7.0(front)’
+

FL+FR+FC+FLC+FRC+SL+SR +

+
‘7.1’
+

FL+FR+FC+LFE+BL+BR+SL+SR +

+
‘7.1(wide)’
+

FL+FR+FC+LFE+BL+BR+FLC+FRC +

+
‘7.1(wide-side)’
+

FL+FR+FC+LFE+FLC+FRC+SL+SR +

+
‘octagonal’
+

FL+FR+FC+BL+BR+BC+SL+SR +

+
‘hexadecagonal’
+

FL+FR+FC+BL+BR+BC+SL+SR+WL+WR+TBL+TBR+TBC+TFC+TFL+TFR +

+
‘downmix’
+

DL+DR +

+
+ +

A custom channel layout can be specified as a sequence of terms, separated by +’+’ or ’|’. Each term can be: +

    +
  • the name of a standard channel layout (e.g. ‘mono’, +‘stereo’, ‘4.0’, ‘quad’, ‘5.0’, etc.) + +
  • the name of a single channel (e.g. ‘FL’, ‘FR’, ‘FC’, ‘LFE’, etc.) + +
  • a number of channels, in decimal, followed by ’c’, yielding the default channel +layout for that number of channels (see the function +av_get_default_channel_layout). Note that not all channel counts have a +default layout. + +
  • a number of channels, in decimal, followed by ’C’, yielding an unknown channel +layout with the specified number of channels. Note that not all channel layout +specification strings support unknown channel layouts. + +
  • a channel layout mask, in hexadecimal starting with "0x" (see the +AV_CH_* macros in libavutil/channel_layout.h. +
+ +

Before libavutil version 53 the trailing character "c" to specify a number of +channels was optional, but now it is required, while a channel layout mask can +also be specified as a decimal number (if and only if not followed by "c" or "C"). +

+

See also the function av_get_channel_layout defined in +libavutil/channel_layout.h. +

+ +

3 Expression Evaluation

+ +

When evaluating an arithmetic expression, FFmpeg uses an internal +formula evaluator, implemented through the libavutil/eval.h +interface. +

+

An expression may contain unary, binary operators, constants, and +functions. +

+

Two expressions expr1 and expr2 can be combined to form +another expression "expr1;expr2". +expr1 and expr2 are evaluated in turn, and the new +expression evaluates to the value of expr2. +

+

The following binary operators are available: +, -, +*, /, ^. +

+

The following unary operators are available: +, -. +

+

The following functions are available: +

+
abs(x)
+

Compute absolute value of x. +

+
+
acos(x)
+

Compute arccosine of x. +

+
+
asin(x)
+

Compute arcsine of x. +

+
+
atan(x)
+

Compute arctangent of x. +

+
+
atan2(x, y)
+

Compute principal value of the arc tangent of y/x. +

+
+
between(x, min, max)
+

Return 1 if x is greater than or equal to min and lesser than or +equal to max, 0 otherwise. +

+
+
bitand(x, y)
+
bitor(x, y)
+

Compute bitwise and/or operation on x and y. +

+

The results of the evaluation of x and y are converted to +integers before executing the bitwise operation. +

+

Note that both the conversion to integer and the conversion back to +floating point can lose precision. Beware of unexpected results for +large numbers (usually 2^53 and larger). +

+
+
ceil(expr)
+

Round the value of expression expr upwards to the nearest +integer. For example, "ceil(1.5)" is "2.0". +

+
+
clip(x, min, max)
+

Return the value of x clipped between min and max. +

+
+
cos(x)
+

Compute cosine of x. +

+
+
cosh(x)
+

Compute hyperbolic cosine of x. +

+
+
eq(x, y)
+

Return 1 if x and y are equivalent, 0 otherwise. +

+
+
exp(x)
+

Compute exponential of x (with base e, the Euler’s number). +

+
+
floor(expr)
+

Round the value of expression expr downwards to the nearest +integer. For example, "floor(-1.5)" is "-2.0". +

+
+
gauss(x)
+

Compute Gauss function of x, corresponding to +exp(-x*x/2) / sqrt(2*PI). +

+
+
gcd(x, y)
+

Return the greatest common divisor of x and y. If both x and +y are 0 or either or both are less than zero then behavior is undefined. +

+
+
gt(x, y)
+

Return 1 if x is greater than y, 0 otherwise. +

+
+
gte(x, y)
+

Return 1 if x is greater than or equal to y, 0 otherwise. +

+
+
hypot(x, y)
+

This function is similar to the C function with the same name; it returns +"sqrt(x*x + y*y)", the length of the hypotenuse of a +right triangle with sides of length x and y, or the distance of the +point (x, y) from the origin. +

+
+
if(x, y)
+

Evaluate x, and if the result is non-zero return the result of +the evaluation of y, return 0 otherwise. +

+
+
if(x, y, z)
+

Evaluate x, and if the result is non-zero return the evaluation +result of y, otherwise the evaluation result of z. +

+
+
ifnot(x, y)
+

Evaluate x, and if the result is zero return the result of the +evaluation of y, return 0 otherwise. +

+
+
ifnot(x, y, z)
+

Evaluate x, and if the result is zero return the evaluation +result of y, otherwise the evaluation result of z. +

+
+
isinf(x)
+

Return 1.0 if x is +/-INFINITY, 0.0 otherwise. +

+
+
isnan(x)
+

Return 1.0 if x is NAN, 0.0 otherwise. +

+
+
ld(var)
+

Load the value of the internal variable with number +var, which was previously stored with st(var, expr). +The function returns the loaded value. +

+
+
lerp(x, y, z)
+

Return linear interpolation between x and y by amount of z. +

+
+
log(x)
+

Compute natural logarithm of x. +

+
+
lt(x, y)
+

Return 1 if x is lesser than y, 0 otherwise. +

+
+
lte(x, y)
+

Return 1 if x is lesser than or equal to y, 0 otherwise. +

+
+
max(x, y)
+

Return the maximum between x and y. +

+
+
min(x, y)
+

Return the minimum between x and y. +

+
+
mod(x, y)
+

Compute the remainder of division of x by y. +

+
+
not(expr)
+

Return 1.0 if expr is zero, 0.0 otherwise. +

+
+
pow(x, y)
+

Compute the power of x elevated y, it is equivalent to +"(x)^(y)". +

+
+
print(t)
+
print(t, l)
+

Print the value of expression t with loglevel l. If +l is not specified then a default log level is used. +Returns the value of the expression printed. +

+

Prints t with loglevel l +

+
+
random(x)
+

Return a pseudo random value between 0.0 and 1.0. x is the index of the +internal variable which will be used to save the seed/state. +

+
+
root(expr, max)
+

Find an input value for which the function represented by expr +with argument ld(0) is 0 in the interval 0..max. +

+

The expression in expr must denote a continuous function or the +result is undefined. +

+

ld(0) is used to represent the function input value, which means +that the given expression will be evaluated multiple times with +various input values that the expression can access through +ld(0). When the expression evaluates to 0 then the +corresponding input value will be returned. +

+
+
round(expr)
+

Round the value of expression expr to the nearest integer. For example, "round(1.5)" is "2.0". +

+
+
sgn(x)
+

Compute sign of x. +

+
+
sin(x)
+

Compute sine of x. +

+
+
sinh(x)
+

Compute hyperbolic sine of x. +

+
+
sqrt(expr)
+

Compute the square root of expr. This is equivalent to +"(expr)^.5". +

+
+
squish(x)
+

Compute expression 1/(1 + exp(4*x)). +

+
+
st(var, expr)
+

Store the value of the expression expr in an internal +variable. var specifies the number of the variable where to +store the value, and it is a value ranging from 0 to 9. The function +returns the value stored in the internal variable. +Note, Variables are currently not shared between expressions. +

+
+
tan(x)
+

Compute tangent of x. +

+
+
tanh(x)
+

Compute hyperbolic tangent of x. +

+
+
taylor(expr, x)
+
taylor(expr, x, id)
+

Evaluate a Taylor series at x, given an expression representing +the ld(id)-th derivative of a function at 0. +

+

When the series does not converge the result is undefined. +

+

ld(id) is used to represent the derivative order in expr, +which means that the given expression will be evaluated multiple times +with various input values that the expression can access through +ld(id). If id is not specified then 0 is assumed. +

+

Note, when you have the derivatives at y instead of 0, +taylor(expr, x-y) can be used. +

+
+
time(0)
+

Return the current (wallclock) time in seconds. +

+
+
trunc(expr)
+

Round the value of expression expr towards zero to the nearest +integer. For example, "trunc(-1.5)" is "-1.0". +

+
+
while(cond, expr)
+

Evaluate expression expr while the expression cond is +non-zero, and returns the value of the last expr evaluation, or +NAN if cond was always false. +

+
+ +

The following constants are available: +

+
PI
+

area of the unit disc, approximately 3.14 +

+
E
+

exp(1) (Euler’s number), approximately 2.718 +

+
PHI
+

golden ratio (1+sqrt(5))/2, approximately 1.618 +

+
+ +

Assuming that an expression is considered "true" if it has a non-zero +value, note that: +

+

* works like AND +

+

+ works like OR +

+

For example the construct: +

+
if (A AND B) then C
+
+

is equivalent to: +

+
if(A*B, C)
+
+ +

In your C code, you can extend the list of unary and binary functions, +and define recognized constants, so that they are available for your +expressions. +

+

The evaluator also recognizes the International System unit prefixes. +If ’i’ is appended after the prefix, binary prefixes are used, which +are based on powers of 1024 instead of powers of 1000. +The ’B’ postfix multiplies the value by 8, and can be appended after a +unit prefix or used alone. This allows using for example ’KB’, ’MiB’, +’G’ and ’B’ as number postfix. +

+

The list of available International System prefixes follows, with +indication of the corresponding powers of 10 and of 2. +

+
y
+

10^-24 / 2^-80 +

+
z
+

10^-21 / 2^-70 +

+
a
+

10^-18 / 2^-60 +

+
f
+

10^-15 / 2^-50 +

+
p
+

10^-12 / 2^-40 +

+
n
+

10^-9 / 2^-30 +

+
u
+

10^-6 / 2^-20 +

+
m
+

10^-3 / 2^-10 +

+
c
+

10^-2 +

+
d
+

10^-1 +

+
h
+

10^2 +

+
k
+

10^3 / 2^10 +

+
K
+

10^3 / 2^10 +

+
M
+

10^6 / 2^20 +

+
G
+

10^9 / 2^30 +

+
T
+

10^12 / 2^40 +

+
P
+

10^15 / 2^40 +

+
E
+

10^18 / 2^50 +

+
Z
+

10^21 / 2^60 +

+
Y
+

10^24 / 2^70 +

+
+ + + +

4 See Also

+ +

ffmpeg, ffplay, ffprobe, +libavutil +

+ + +

5 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg.html new file mode 100644 index 0000000..50ee961 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffmpeg.html @@ -0,0 +1,2719 @@ + + + + + + + ffmpeg Documentation + + + + + + +
+

+ ffmpeg Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Synopsis

+ +

ffmpeg [global_options] {[input_file_options] -i input_url} ... {[output_file_options] output_url} ... +

+ +

2 Description

+ +

ffmpeg is a very fast video and audio converter that can also grab from +a live audio/video source. It can also convert between arbitrary sample +rates and resize video on the fly with a high quality polyphase filter. +

+

ffmpeg reads from an arbitrary number of input "files" (which can be regular +files, pipes, network streams, grabbing devices, etc.), specified by the +-i option, and writes to an arbitrary number of output "files", which are +specified by a plain output url. Anything found on the command line which +cannot be interpreted as an option is considered to be an output url. +

+

Each input or output url can, in principle, contain any number of streams of +different types (video/audio/subtitle/attachment/data). The allowed number and/or +types of streams may be limited by the container format. Selecting which +streams from which inputs will go into which output is either done automatically +or with the -map option (see the Stream selection chapter). +

+

To refer to input files in options, you must use their indices (0-based). E.g. +the first input file is 0, the second is 1, etc. Similarly, streams +within a file are referred to by their indices. E.g. 2:3 refers to the +fourth stream in the third input file. Also see the Stream specifiers chapter. +

+

As a general rule, options are applied to the next specified +file. Therefore, order is important, and you can have the same +option on the command line multiple times. Each occurrence is +then applied to the next input or output file. +Exceptions from this rule are the global options (e.g. verbosity level), +which should be specified first. +

+

Do not mix input and output files – first specify all input files, then all +output files. Also do not mix options which belong to different files. All +options apply ONLY to the next input or output file and are reset between files. +

+
    +
  • To set the video bitrate of the output file to 64 kbit/s: +
    +
    ffmpeg -i input.avi -b:v 64k -bufsize 64k output.avi
+
    + +
  • To force the frame rate of the output file to 24 fps: +
    +
    ffmpeg -i input.avi -r 24 output.avi
+
    + +
  • To force the frame rate of the input file (valid for raw formats only) +to 1 fps and the frame rate of the output file to 24 fps: +
    +
    ffmpeg -r 1 -i input.m2v -r 24 output.avi
+
    +
+ +

The format option may be needed for raw input files. +

+ + +

3 Detailed description

+ +

The transcoding process in ffmpeg for each output can be described by +the following diagram: +

+
 _______              ______________
+|       |            |              |
+| input |  demuxer   | encoded data |   decoder
+| file  | ---------> | packets      | -----+
+|_______|            |______________|      |
+                                           v
+                                       _________
+                                      |         |
+                                      | decoded |
+                                      | frames  |
+                                      |_________|
+ ________             ______________       |
+|        |           |              |      |
+| output | <-------- | encoded data | <----+
+| file   |   muxer   | packets      |   encoder
+|________|           |______________|
+
+
+
+

ffmpeg calls the libavformat library (containing demuxers) to read +input files and get packets containing encoded data from them. When there are +multiple input files, ffmpeg tries to keep them synchronized by +tracking lowest timestamp on any active input stream. +

+

Encoded packets are then passed to the decoder (unless streamcopy is selected +for the stream, see further for a description). The decoder produces +uncompressed frames (raw video/PCM audio/...) which can be processed further by +filtering (see next section). After filtering, the frames are passed to the +encoder, which encodes them and outputs encoded packets. Finally those are +passed to the muxer, which writes the encoded packets to the output file. +

+ +

3.1 Filtering

+

Before encoding, ffmpeg can process raw audio and video frames using +filters from the libavfilter library. Several chained filters form a filter +graph. ffmpeg distinguishes between two types of filtergraphs: +simple and complex. +

+ +

3.1.1 Simple filtergraphs

+

Simple filtergraphs are those that have exactly one input and output, both of +the same type. In the above diagram they can be represented by simply inserting +an additional step between decoding and encoding: +

+
 _________                        ______________
+|         |                      |              |
+| decoded |                      | encoded data |
+| frames  |\                   _ | packets      |
+|_________| \                  /||______________|
+             \   __________   /
+  simple     _\||          | /  encoder
+  filtergraph   | filtered |/
+                | frames   |
+                |__________|
+
+
+

Simple filtergraphs are configured with the per-stream -filter option +(with -vf and -af aliases for video and audio respectively). +A simple filtergraph for video can look for example like this: +

+
 _______        _____________        _______        ________
+|       |      |             |      |       |      |        |
+| input | ---> | deinterlace | ---> | scale | ---> | output |
+|_______|      |_____________|      |_______|      |________|
+
+
+

Note that some filters change frame properties but not frame contents. E.g. the +fps filter in the example above changes number of frames, but does not +touch the frame contents. Another example is the setpts filter, which +only sets timestamps and otherwise passes the frames unchanged. +

+ +

3.1.2 Complex filtergraphs

+

Complex filtergraphs are those which cannot be described as simply a linear +processing chain applied to one stream. This is the case, for example, when the graph has +more than one input and/or output, or when output stream type is different from +input. They can be represented with the following diagram: +

+
 _________
+|         |
+| input 0 |\                    __________
+|_________| \                  |          |
+             \   _________    /| output 0 |
+              \ |         |  / |__________|
+ _________     \| complex | /
+|         |     |         |/
+| input 1 |---->| filter  |\
+|_________|     |         | \   __________
+               /| graph   |  \ |          |
+              / |         |   \| output 1 |
+ _________   /  |_________|    |__________|
+|         | /
+| input 2 |/
+|_________|
+
+
+

Complex filtergraphs are configured with the -filter_complex option. +Note that this option is global, since a complex filtergraph, by its nature, +cannot be unambiguously associated with a single stream or file. +

+

The -lavfi option is equivalent to -filter_complex. +

+

A trivial example of a complex filtergraph is the overlay filter, which +has two video inputs and one video output, containing one video overlaid on top +of the other. Its audio counterpart is the amix filter. +

+ +

3.2 Stream copy

+

Stream copy is a mode selected by supplying the copy parameter to the +-codec option. It makes ffmpeg omit the decoding and encoding +step for the specified stream, so it does only demuxing and muxing. It is useful +for changing the container format or modifying container-level metadata. The +diagram above will, in this case, simplify to this: +

+
 _______              ______________            ________
+|       |            |              |          |        |
+| input |  demuxer   | encoded data |  muxer   | output |
+| file  | ---------> | packets      | -------> | file   |
+|_______|            |______________|          |________|
+
+
+

Since there is no decoding or encoding, it is very fast and there is no quality +loss. However, it might not work in some cases because of many factors. Applying +filters is obviously also impossible, since filters work on uncompressed data. +

+ + +

4 Stream selection

+ +

ffmpeg provides the -map option for manual control of stream selection in each +output file. Users can skip -map and let ffmpeg perform automatic stream selection as +described below. The -vn / -an / -sn / -dn options can be used to skip inclusion of +video, audio, subtitle and data streams respectively, whether manually mapped or automatically +selected, except for those streams which are outputs of complex filtergraphs. +

+ +

4.1 Description

+

The sub-sections that follow describe the various rules that are involved in stream selection. +The examples that follow next show how these rules are applied in practice. +

+

While every effort is made to accurately reflect the behavior of the program, FFmpeg is under +continuous development and the code may have changed since the time of this writing. +

+ +

4.1.1 Automatic stream selection

+ +

In the absence of any map options for a particular output file, ffmpeg inspects the output +format to check which type of streams can be included in it, viz. video, audio and/or +subtitles. For each acceptable stream type, ffmpeg will pick one stream, when available, +from among all the inputs. +

+

It will select that stream based upon the following criteria: +

    +
  • for video, it is the stream with the highest resolution, +
  • for audio, it is the stream with the most channels, +
  • for subtitles, it is the first subtitle stream found but there’s a caveat. +The output format’s default subtitle encoder can be either text-based or image-based, +and only a subtitle stream of the same type will be chosen. +
+ +

In the case where several streams of the same type rate equally, the stream with the lowest +index is chosen. +

+

Data or attachment streams are not automatically selected and can only be included +using -map. +

+

4.1.2 Manual stream selection

+ +

When -map is used, only user-mapped streams are included in that output file, +with one possible exception for filtergraph outputs described below. +

+ +

4.1.3 Complex filtergraphs

+ +

If there are any complex filtergraph output streams with unlabeled pads, they will be added +to the first output file. This will lead to a fatal error if the stream type is not supported +by the output format. In the absence of the map option, the inclusion of these streams leads +to the automatic stream selection of their types being skipped. If map options are present, +these filtergraph streams are included in addition to the mapped streams. +

+

Complex filtergraph output streams with labeled pads must be mapped once and exactly once. +

+ +

4.1.4 Stream handling

+ +

Stream handling is independent of stream selection, with an exception for subtitles described +below. Stream handling is set via the -codec option addressed to streams within a +specific output file. In particular, codec options are applied by ffmpeg after the +stream selection process and thus do not influence the latter. If no -codec option is +specified for a stream type, ffmpeg will select the default encoder registered by the output +file muxer. +

+

An exception exists for subtitles. If a subtitle encoder is specified for an output file, the +first subtitle stream found of any type, text or image, will be included. ffmpeg does not validate +if the specified encoder can convert the selected stream or if the converted stream is acceptable +within the output format. This applies generally as well: when the user sets an encoder manually, +the stream selection process cannot check if the encoded stream can be muxed into the output file. +If it cannot, ffmpeg will abort and all output files will fail to be processed. +

+ +

4.2 Examples

+ +

The following examples illustrate the behavior, quirks and limitations of ffmpeg’s stream +selection methods. +

+

They assume the following three input files. +

+
+input file 'A.avi'
+      stream 0: video 640x360
+      stream 1: audio 2 channels
+
+input file 'B.mp4'
+      stream 0: video 1920x1080
+      stream 1: audio 2 channels
+      stream 2: subtitles (text)
+      stream 3: audio 5.1 channels
+      stream 4: subtitles (text)
+
+input file 'C.mkv'
+      stream 0: video 1280x720
+      stream 1: audio 2 channels
+      stream 2: subtitles (image)
+
+ +
+
ffmpeg -i A.avi -i B.mp4 out1.mkv out2.wav -map 1:a -c:a copy out3.mov
+
+

There are three output files specified, and for the first two, no -map options +are set, so ffmpeg will select streams for these two files automatically. +

+

out1.mkv is a Matroska container file and accepts video, audio and subtitle streams, +so ffmpeg will try to select one of each type.
+For video, it will select stream 0 from B.mp4, which has the highest +resolution among all the input video streams.
+For audio, it will select stream 3 from B.mp4, since it has the greatest +number of channels.
+For subtitles, it will select stream 2 from B.mp4, which is the first subtitle +stream from among A.avi and B.mp4. +

+

out2.wav accepts only audio streams, so only stream 3 from B.mp4 is +selected. +

+

For out3.mov, since a -map option is set, no automatic stream selection will +occur. The -map 1:a option will select all audio streams from the second input +B.mp4. No other streams will be included in this output file. +

+

For the first two outputs, all included streams will be transcoded. The encoders chosen will +be the default ones registered by each output format, which may not match the codec of the +selected input streams. +

+

For the third output, codec option for audio streams has been set +to copy, so no decoding-filtering-encoding operations will occur, or can occur. +Packets of selected streams shall be conveyed from the input file and muxed within the output +file. +

+ +
+
ffmpeg -i C.mkv out1.mkv -c:s dvdsub -an out2.mkv
+
+

Although out1.mkv is a Matroska container file which accepts subtitle streams, only a +video and audio stream shall be selected. The subtitle stream of C.mkv is image-based +and the default subtitle encoder of the Matroska muxer is text-based, so a transcode operation +for the subtitles is expected to fail and hence the stream isn’t selected. However, in +out2.mkv, a subtitle encoder is specified in the command and so, the subtitle stream is +selected, in addition to the video stream. The presence of -an disables audio stream +selection for out2.mkv. +

+ +
+
ffmpeg -i A.avi -i C.mkv -i B.mp4 -filter_complex "overlay" out1.mp4 out2.srt
+
+

A filtergraph is setup here using the -filter_complex option and consists of a single +video filter. The overlay filter requires exactly two video inputs, but none are +specified, so the first two available video streams are used, those of A.avi and +C.mkv. The output pad of the filter has no label and so is sent to the first output file +out1.mp4. Due to this, automatic selection of the video stream is skipped, which would +have selected the stream in B.mp4. The audio stream with most channels viz. stream 3 +in B.mp4, is chosen automatically. No subtitle stream is chosen however, since the MP4 +format has no default subtitle encoder registered, and the user hasn’t specified a subtitle encoder. +

+

The 2nd output file, out2.srt, only accepts text-based subtitle streams. So, even though +the first subtitle stream available belongs to C.mkv, it is image-based and hence skipped. +The selected stream, stream 2 in B.mp4, is the first text-based subtitle stream. +

+ +
+
ffmpeg -i A.avi -i B.mp4 -i C.mkv -filter_complex "[1:v]hue=s=0[outv];overlay;aresample" \
+       -map '[outv]' -an        out1.mp4 \
+                                out2.mkv \
+       -map '[outv]' -map 1:a:0 out3.mkv
+
+ +

The above command will fail, as the output pad labelled [outv] has been mapped twice. +None of the output files shall be processed. +

+
+
ffmpeg -i A.avi -i B.mp4 -i C.mkv -filter_complex "[1:v]hue=s=0[outv];overlay;aresample" \
+       -an        out1.mp4 \
+                  out2.mkv \
+       -map 1:a:0 out3.mkv
+
+ +

This command above will also fail as the hue filter output has a label, [outv], +and hasn’t been mapped anywhere. +

+

The command should be modified as follows, +

+
ffmpeg -i A.avi -i B.mp4 -i C.mkv -filter_complex "[1:v]hue=s=0,split=2[outv1][outv2];overlay;aresample" \
+        -map '[outv1]' -an        out1.mp4 \
+                                  out2.mkv \
+        -map '[outv2]' -map 1:a:0 out3.mkv
+
+

The video stream from B.mp4 is sent to the hue filter, whose output is cloned once using +the split filter, and both outputs labelled. Then a copy each is mapped to the first and third +output files. +

+

The overlay filter, requiring two video inputs, uses the first two unused video streams. Those +are the streams from A.avi and C.mkv. The overlay output isn’t labelled, so it is +sent to the first output file out1.mp4, regardless of the presence of the -map option. +

+

The aresample filter is sent the first unused audio stream, that of A.avi. Since this filter +output is also unlabelled, it too is mapped to the first output file. The presence of -an +only suppresses automatic or manual stream selection of audio streams, not outputs sent from +filtergraphs. Both these mapped streams shall be ordered before the mapped stream in out1.mp4. +

+

The video, audio and subtitle streams mapped to out2.mkv are entirely determined by +automatic stream selection. +

+

out3.mkv consists of the cloned video output from the hue filter and the first audio +stream from B.mp4. +
+

+ + +

5 Options

+ +

All the numerical options, if not specified otherwise, accept a string +representing a number as input, which may be followed by one of the SI +unit prefixes, for example: ’K’, ’M’, or ’G’. +

+

If ’i’ is appended to the SI unit prefix, the complete prefix will be +interpreted as a unit prefix for binary multiples, which are based on +powers of 1024 instead of powers of 1000. Appending ’B’ to the SI unit +prefix multiplies the value by 8. This allows using, for example: +’KB’, ’MiB’, ’G’ and ’B’ as number suffixes. +

+

Options which do not take arguments are boolean options, and set the +corresponding value to true. They can be set to false by prefixing +the option name with "no". For example using "-nofoo" +will set the boolean option with name "foo" to false. +

+ +

5.1 Stream specifiers

+

Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers +are used to precisely specify which stream(s) a given option belongs to. +

+

A stream specifier is a string generally appended to the option name and +separated from it by a colon. E.g. -codec:a:1 ac3 contains the +a:1 stream specifier, which matches the second audio stream. Therefore, it +would select the ac3 codec for the second audio stream. +

+

A stream specifier can match several streams, so that the option is applied to all +of them. E.g. the stream specifier in -b:a 128k matches all audio +streams. +

+

An empty stream specifier matches all streams. For example, -codec copy +or -codec: copy would copy all the streams without reencoding. +

+

Possible forms of stream specifiers are: +

+
stream_index
+

Matches the stream with this index. E.g. -threads:1 4 would set the +thread count for the second stream to 4. If stream_index is used as an +additional stream specifier (see below), then it selects stream number +stream_index from the matching streams. Stream numbering is based on the +order of the streams as detected by libavformat except when a program ID is +also specified. In this case it is based on the ordering of the streams in the +program. +

+
stream_type[:additional_stream_specifier]
+

stream_type is one of following: ’v’ or ’V’ for video, ’a’ for audio, ’s’ +for subtitle, ’d’ for data, and ’t’ for attachments. ’v’ matches all video +streams, ’V’ only matches video streams which are not attached pictures, video +thumbnails or cover arts. If additional_stream_specifier is used, then +it matches streams which both have this type and match the +additional_stream_specifier. Otherwise, it matches all streams of the +specified type. +

+
p:program_id[:additional_stream_specifier]
+

Matches streams which are in the program with the id program_id. If +additional_stream_specifier is used, then it matches streams which both +are part of the program and match the additional_stream_specifier. +

+
+
#stream_id or i:stream_id
+

Match the stream by stream id (e.g. PID in MPEG-TS container). +

+
m:key[:value]
+

Matches streams with the metadata tag key having the specified value. If +value is not given, matches streams that contain the given tag with any +value. +

+
u
+

Matches streams with usable configuration, the codec must be defined and the +essential information such as video dimension or audio sample rate must be present. +

+

Note that in ffmpeg, matching by metadata will only work properly for +input files. +

+
+ + +

5.2 Generic options

+ +

These options are shared amongst the ff* tools. +

+
+
-L
+

Show license. +

+
+
-h, -?, -help, --help [arg]
+

Show help. An optional parameter may be specified to print help about a specific +item. If no argument is specified, only basic (non advanced) tool +options are shown. +

+

Possible values of arg are: +

+
long
+

Print advanced tool options in addition to the basic tool options. +

+
+
full
+

Print complete list of options, including shared and private options +for encoders, decoders, demuxers, muxers, filters, etc. +

+
+
decoder=decoder_name
+

Print detailed information about the decoder named decoder_name. Use the +-decoders option to get a list of all decoders. +

+
+
encoder=encoder_name
+

Print detailed information about the encoder named encoder_name. Use the +-encoders option to get a list of all encoders. +

+
+
demuxer=demuxer_name
+

Print detailed information about the demuxer named demuxer_name. Use the +-formats option to get a list of all demuxers and muxers. +

+
+
muxer=muxer_name
+

Print detailed information about the muxer named muxer_name. Use the +-formats option to get a list of all muxers and demuxers. +

+
+
filter=filter_name
+

Print detailed information about the filter name filter_name. Use the +-filters option to get a list of all filters. +

+
+
bsf=bitstream_filter_name
+

Print detailed information about the bitstream filter name bitstream_filter_name. +Use the -bsfs option to get a list of all bitstream filters. +

+
+ +
+
-version
+

Show version. +

+
+
-formats
+

Show available formats (including devices). +

+
+
-demuxers
+

Show available demuxers. +

+
+
-muxers
+

Show available muxers. +

+
+
-devices
+

Show available devices. +

+
+
-codecs
+

Show all codecs known to libavcodec. +

+

Note that the term ’codec’ is used throughout this documentation as a shortcut +for what is more correctly called a media bitstream format. +

+
+
-decoders
+

Show available decoders. +

+
+
-encoders
+

Show all available encoders. +

+
+
-bsfs
+

Show available bitstream filters. +

+
+
-protocols
+

Show available protocols. +

+
+
-filters
+

Show available libavfilter filters. +

+
+
-pix_fmts
+

Show available pixel formats. +

+
+
-sample_fmts
+

Show available sample formats. +

+
+
-layouts
+

Show channel names and standard channel layouts. +

+
+
-colors
+

Show recognized color names. +

+
+
-sources device[,opt1=val1[,opt2=val2]...]
+

Show autodetected sources of the input device. +Some devices may provide system-dependent source names that cannot be autodetected. +The returned list cannot be assumed to be always complete. +

+
ffmpeg -sources pulse,server=192.168.0.4
+
+ +
+
-sinks device[,opt1=val1[,opt2=val2]...]
+

Show autodetected sinks of the output device. +Some devices may provide system-dependent sink names that cannot be autodetected. +The returned list cannot be assumed to be always complete. +

+
ffmpeg -sinks pulse,server=192.168.0.4
+
+ +
+
-loglevel [flags+]loglevel | -v [flags+]loglevel
+

Set logging level and flags used by the library. +

+

The optional flags prefix can consist of the following values: +

+
‘repeat’
+

Indicates that repeated log output should not be compressed to the first line +and the "Last message repeated n times" line will be omitted. +

+
‘level’
+

Indicates that log output should add a [level] prefix to each message +line. This can be used as an alternative to log coloring, e.g. when dumping the +log to file. +

+
+

Flags can also be used alone by adding a ’+’/’-’ prefix to set/reset a single +flag without affecting other flags or changing loglevel. When +setting both flags and loglevel, a ’+’ separator is expected +between the last flags value and before loglevel. +

+

loglevel is a string or a number containing one of the following values: +

+
‘quiet, -8’
+

Show nothing at all; be silent. +

+
‘panic, 0’
+

Only show fatal errors which could lead the process to crash, such as +an assertion failure. This is not currently used for anything. +

+
‘fatal, 8’
+

Only show fatal errors. These are errors after which the process absolutely +cannot continue. +

+
‘error, 16’
+

Show all errors, including ones which can be recovered from. +

+
‘warning, 24’
+

Show all warnings and errors. Any message related to possibly +incorrect or unexpected events will be shown. +

+
‘info, 32’
+

Show informative messages during processing. This is in addition to +warnings and errors. This is the default value. +

+
‘verbose, 40’
+

Same as info, except more verbose. +

+
‘debug, 48’
+

Show everything, including debugging information. +

+
‘trace, 56’
+
+ +

For example to enable repeated log output, add the level prefix, and set +loglevel to verbose: +

+
ffmpeg -loglevel repeat+level+verbose -i input output
+
+

Another example that enables repeated log output without affecting current +state of level prefix flag or loglevel: +

+
ffmpeg [...] -loglevel +repeat
+
+ +

By default the program logs to stderr. If coloring is supported by the +terminal, colors are used to mark errors and warnings. Log coloring +can be disabled setting the environment variable +AV_LOG_FORCE_NOCOLOR, or can be forced setting +the environment variable AV_LOG_FORCE_COLOR. +

+
+
-report
+

Dump full command line and log output to a file named +program-YYYYMMDD-HHMMSS.log in the current +directory. +This file can be useful for bug reports. +It also implies -loglevel debug. +

+

Setting the environment variable FFREPORT to any value has the +same effect. If the value is a ’:’-separated key=value sequence, these +options will affect the report; option values must be escaped if they +contain special characters or the options delimiter ’:’ (see the +“Quoting and escaping” section in the ffmpeg-utils manual). +

+

The following options are recognized: +

+
file
+

set the file name to use for the report; %p is expanded to the name +of the program, %t is expanded to a timestamp, %% is expanded +to a plain % +

+
level
+

set the log verbosity level using a numerical value (see -loglevel). +

+
+ +

For example, to output a report to a file named ffreport.log +using a log level of 32 (alias for log level info): +

+
+
FFREPORT=file=ffreport.log:level=32 ffmpeg -i input output
+
+ +

Errors in parsing the environment variable are not fatal, and will not +appear in the report. +

+
+
-hide_banner
+

Suppress printing banner. +

+

All FFmpeg tools will normally show a copyright notice, build options +and library versions. This option can be used to suppress printing +this information. +

+
+
-cpuflags flags (global)
+

Allows setting and clearing cpu flags. This option is intended +for testing. Do not use it unless you know what you’re doing. +

+
ffmpeg -cpuflags -sse+mmx ...
+ffmpeg -cpuflags mmx ...
+ffmpeg -cpuflags 0 ...
+
+

Possible flags for this option are: +

+
‘x86’
+
+
‘mmx’
+
‘mmxext’
+
‘sse’
+
‘sse2’
+
‘sse2slow’
+
‘sse3’
+
‘sse3slow’
+
‘ssse3’
+
‘atom’
+
‘sse4.1’
+
‘sse4.2’
+
‘avx’
+
‘avx2’
+
‘xop’
+
‘fma3’
+
‘fma4’
+
‘3dnow’
+
‘3dnowext’
+
‘bmi1’
+
‘bmi2’
+
‘cmov’
+
+
+
‘ARM’
+
+
‘armv5te’
+
‘armv6’
+
‘armv6t2’
+
‘vfp’
+
‘vfpv3’
+
‘neon’
+
‘setend’
+
+
+
‘AArch64’
+
+
‘armv8’
+
‘vfp’
+
‘neon’
+
+
+
‘PowerPC’
+
+
‘altivec’
+
+
+
‘Specific Processors’
+
+
‘pentium2’
+
‘pentium3’
+
‘pentium4’
+
‘k6’
+
‘k62’
+
‘athlon’
+
‘athlonxp’
+
‘k8’
+
+
+
+
+
+ + +

5.3 AVOptions

+ +

These options are provided directly by the libavformat, libavdevice and +libavcodec libraries. To see the list of available AVOptions, use the +-help option. They are separated into two categories: +

+
generic
+

These options can be set for any container, codec or device. Generic options +are listed under AVFormatContext options for containers/devices and under +AVCodecContext options for codecs. +

+
private
+

These options are specific to the given container, device or codec. Private +options are listed under their corresponding containers/devices/codecs. +

+
+ +

For example to write an ID3v2.3 header instead of a default ID3v2.4 to +an MP3 file, use the id3v2_version private option of the MP3 +muxer: +

+
ffmpeg -i input.flac -id3v2_version 3 out.mp3
+
+ +

All codec AVOptions are per-stream, and thus a stream specifier +should be attached to them: +

+
ffmpeg -i multichannel.mxf -map 0:v:0 -map 0:a:0 -map 0:a:0 -c:a:0 ac3 -b:a:0 640k -ac:a:1 2 -c:a:1 aac -b:2 128k out.mp4
+
+ +

In the above example, a multichannel audio stream is mapped twice for output. +The first instance is encoded with codec ac3 and bitrate 640k. +The second instance is downmixed to 2 channels and encoded with codec aac. A bitrate of 128k is specified for it using +absolute index of the output stream. +

+

Note: the -nooption syntax cannot be used for boolean +AVOptions, use -option 0/-option 1. +

+

Note: the old undocumented way of specifying per-stream AVOptions by +prepending v/a/s to the options name is now obsolete and will be +removed soon. +

+ +

5.4 Main options

+ +
+
-f fmt (input/output)
+

Force input or output file format. The format is normally auto detected for input +files and guessed from the file extension for output files, so this option is not +needed in most cases. +

+
+
-i url (input)
+

input file url +

+
+
-y (global)
+

Overwrite output files without asking. +

+
+
-n (global)
+

Do not overwrite output files, and exit immediately if a specified +output file already exists. +

+
+
-stream_loop number (input)
+

Set number of times input stream shall be looped. Loop 0 means no loop, +loop -1 means infinite loop. +

+
+
-c[:stream_specifier] codec (input/output,per-stream)
+
-codec[:stream_specifier] codec (input/output,per-stream)
+

Select an encoder (when used before an output file) or a decoder (when used +before an input file) for one or more streams. codec is the name of a +decoder/encoder or a special value copy (output only) to indicate that +the stream is not to be re-encoded. +

+

For example +

+
ffmpeg -i INPUT -map 0 -c:v libx264 -c:a copy OUTPUT
+
+

encodes all video streams with libx264 and copies all audio streams. +

+

For each stream, the last matching c option is applied, so +

+
ffmpeg -i INPUT -map 0 -c copy -c:v:1 libx264 -c:a:137 libvorbis OUTPUT
+
+

will copy all the streams except the second video, which will be encoded with +libx264, and the 138th audio, which will be encoded with libvorbis. +

+
+
-t duration (input/output)
+

When used as an input option (before -i), limit the duration of +data read from the input file. +

+

When used as an output option (before an output url), stop writing the +output after its duration reaches duration. +

+

duration must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+

-to and -t are mutually exclusive and -t has priority. +

+
+
-to position (input/output)
+

Stop writing the output or reading the input at position. +position must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+

-to and -t are mutually exclusive and -t has priority. +

+
+
-fs limit_size (output)
+

Set the file size limit, expressed in bytes. No further chunk of bytes is written +after the limit is exceeded. The size of the output file is slightly more than the +requested file size. +

+
+
-ss position (input/output)
+

When used as an input option (before -i), seeks in this input file to +position. Note that in most formats it is not possible to seek exactly, +so ffmpeg will seek to the closest seek point before position. +When transcoding and -accurate_seek is enabled (the default), this +extra segment between the seek point and position will be decoded and +discarded. When doing stream copy or when -noaccurate_seek is used, it +will be preserved. +

+

When used as an output option (before an output url), decodes but discards +input until the timestamps reach position. +

+

position must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+
+
-sseof position (input)
+
+

Like the -ss option but relative to the "end of file". That is negative +values are earlier in the file, 0 is at EOF. +

+
+
-itsoffset offset (input)
+

Set the input time offset. +

+

offset must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+

The offset is added to the timestamps of the input files. Specifying +a positive offset means that the corresponding streams are delayed by +the time duration specified in offset. +

+
+
-itsscale scale (input,per-stream)
+

Rescale input timestamps. scale should be a floating point number. +

+
+
-timestamp date (output)
+

Set the recording timestamp in the container. +

+

date must be a date specification, +see (ffmpeg-utils)the Date section in the ffmpeg-utils(1) manual. +

+
+
-metadata[:metadata_specifier] key=value (output,per-metadata)
+

Set a metadata key/value pair. +

+

An optional metadata_specifier may be given to set metadata +on streams, chapters or programs. See -map_metadata +documentation for details. +

+

This option overrides metadata set with -map_metadata. It is +also possible to delete metadata by using an empty value. +

+

For example, for setting the title in the output file: +

+
ffmpeg -i in.avi -metadata title="my title" out.flv
+
+ +

To set the language of the first audio stream: +

+
ffmpeg -i INPUT -metadata:s:a:0 language=eng OUTPUT
+
+ +
+
-disposition[:stream_specifier] value (output,per-stream)
+

Sets the disposition for a stream. +

+

This option overrides the disposition copied from the input stream. It is also +possible to delete the disposition by setting it to 0. +

+

The following dispositions are recognized: +

+
default
+
dub
+
original
+
comment
+
lyrics
+
karaoke
+
forced
+
hearing_impaired
+
visual_impaired
+
clean_effects
+
attached_pic
+
captions
+
descriptions
+
dependent
+
metadata
+
+ +

For example, to make the second audio stream the default stream: +

+
ffmpeg -i in.mkv -c copy -disposition:a:1 default out.mkv
+
+ +

To make the second subtitle stream the default stream and remove the default +disposition from the first subtitle stream: +

+
ffmpeg -i in.mkv -c copy -disposition:s:0 0 -disposition:s:1 default out.mkv
+
+ +

To add an embedded cover/thumbnail: +

+
ffmpeg -i in.mp4 -i IMAGE -map 0 -map 1 -c copy -c:v:1 png -disposition:v:1 attached_pic out.mp4
+
+ +

Not all muxers support embedded thumbnails, and those who do, only support a few formats, like JPEG or PNG. +

+
+
-program [title=title:][program_num=program_num:]st=stream[:st=stream...] (output)
+
+

Creates a program with the specified title, program_num and adds the specified +stream(s) to it. +

+
+
-target type (output)
+

Specify target file type (vcd, svcd, dvd, dv, +dv50). type may be prefixed with pal-, ntsc- or +film- to use the corresponding standard. All the format options +(bitrate, codecs, buffer sizes) are then set automatically. You can just type: +

+
+
ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
+
+ +

Nevertheless you can specify additional options as long as you know +they do not conflict with the standard, as in: +

+
+
ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
+
+ +
+
-dn (input/output)
+

As an input option, blocks all data streams of a file from being filtered or +being automatically selected or mapped for any output. See -discard +option to disable streams individually. +

+

As an output option, disables data recording i.e. automatic selection or +mapping of any data stream. For full manual control see the -map +option. +

+
+
-dframes number (output)
+

Set the number of data frames to output. This is an obsolete alias for +-frames:d, which you should use instead. +

+
+
-frames[:stream_specifier] framecount (output,per-stream)
+

Stop writing to the stream after framecount frames. +

+
+
-q[:stream_specifier] q (output,per-stream)
+
-qscale[:stream_specifier] q (output,per-stream)
+

Use fixed quality scale (VBR). The meaning of q/qscale is +codec-dependent. +If qscale is used without a stream_specifier then it applies only +to the video stream, this is to maintain compatibility with previous behavior +and as specifying the same codec specific value to 2 different codecs that is +audio and video generally is not what is intended when no stream_specifier is +used. +

+
+
-filter[:stream_specifier] filtergraph (output,per-stream)
+

Create the filtergraph specified by filtergraph and use it to +filter the stream. +

+

filtergraph is a description of the filtergraph to apply to +the stream, and must have a single input and a single output of the +same type of the stream. In the filtergraph, the input is associated +to the label in, and the output to the label out. See +the ffmpeg-filters manual for more information about the filtergraph +syntax. +

+

See the -filter_complex option if you +want to create filtergraphs with multiple inputs and/or outputs. +

+
+
-filter_script[:stream_specifier] filename (output,per-stream)
+

This option is similar to -filter, the only difference is that its +argument is the name of the file from which a filtergraph description is to be +read. +

+
+
-filter_threads nb_threads (global)
+

Defines how many threads are used to process a filter pipeline. Each pipeline +will produce a thread pool with this many threads available for parallel processing. +The default is the number of available CPUs. +

+
+
-pre[:stream_specifier] preset_name (output,per-stream)
+

Specify the preset for matching stream(s). +

+
+
-stats (global)
+

Print encoding progress/statistics. It is on by default, to explicitly +disable it you need to specify -nostats. +

+
+
-progress url (global)
+

Send program-friendly progress information to url. +

+

Progress information is written approximately every second and at the end of +the encoding process. It is made of "key=value" lines. key +consists of only alphanumeric characters. The last key of a sequence of +progress information is always "progress". +

+
+
-stdin
+

Enable interaction on standard input. On by default unless standard input is +used as an input. To explicitly disable interaction you need to specify +-nostdin. +

+

Disabling interaction on standard input is useful, for example, if +ffmpeg is in the background process group. Roughly the same result can +be achieved with ffmpeg ... < /dev/null but it requires a +shell. +

+
+
-debug_ts (global)
+

Print timestamp information. It is off by default. This option is +mostly useful for testing and debugging purposes, and the output +format may change from one version to another, so it should not be +employed by portable scripts. +

+

See also the option -fdebug ts. +

+
+
-attach filename (output)
+

Add an attachment to the output file. This is supported by a few formats +like Matroska for e.g. fonts used in rendering subtitles. Attachments +are implemented as a specific type of stream, so this option will add +a new stream to the file. It is then possible to use per-stream options +on this stream in the usual way. Attachment streams created with this +option will be created after all the other streams (i.e. those created +with -map or automatic mappings). +

+

Note that for Matroska you also have to set the mimetype metadata tag: +

+
ffmpeg -i INPUT -attach DejaVuSans.ttf -metadata:s:2 mimetype=application/x-truetype-font out.mkv
+
+

(assuming that the attachment stream will be third in the output file). +

+
+
-dump_attachment[:stream_specifier] filename (input,per-stream)
+

Extract the matching attachment stream into a file named filename. If +filename is empty, then the value of the filename metadata tag +will be used. +

+

E.g. to extract the first attachment to a file named ’out.ttf’: +

+
ffmpeg -dump_attachment:t:0 out.ttf -i INPUT
+
+

To extract all attachments to files determined by the filename tag: +

+
ffmpeg -dump_attachment:t "" -i INPUT
+
+ +

Technical note – attachments are implemented as codec extradata, so this +option can actually be used to extract extradata from any stream, not just +attachments. +

+
+
-noautorotate
+

Disable automatically rotating video based on file metadata. +

+
+
+ + +

5.5 Video Options

+ +
+
-vframes number (output)
+

Set the number of video frames to output. This is an obsolete alias for +-frames:v, which you should use instead. +

+
-r[:stream_specifier] fps (input/output,per-stream)
+

Set frame rate (Hz value, fraction or abbreviation). +

+

As an input option, ignore any timestamps stored in the file and instead +generate timestamps assuming constant frame rate fps. +This is not the same as the -framerate option used for some input formats +like image2 or v4l2 (it used to be the same in older versions of FFmpeg). +If in doubt use -framerate instead of the input option -r. +

+

As an output option, duplicate or drop input frames to achieve constant output +frame rate fps. +

+
+
-s[:stream_specifier] size (input/output,per-stream)
+

Set frame size. +

+

As an input option, this is a shortcut for the video_size private +option, recognized by some demuxers for which the frame size is either not +stored in the file or is configurable – e.g. raw video or video grabbers. +

+

As an output option, this inserts the scale video filter to the +end of the corresponding filtergraph. Please use the scale filter +directly to insert it at the beginning or some other place. +

+

The format is ‘wxh’ (default - same as source). +

+
+
-aspect[:stream_specifier] aspect (output,per-stream)
+

Set the video display aspect ratio specified by aspect. +

+

aspect can be a floating point number string, or a string of the +form num:den, where num and den are the +numerator and denominator of the aspect ratio. For example "4:3", +"16:9", "1.3333", and "1.7777" are valid argument values. +

+

If used together with -vcodec copy, it will affect the aspect ratio +stored at container level, but not the aspect ratio stored in encoded +frames, if it exists. +

+
+
-vn (input/output)
+

As an input option, blocks all video streams of a file from being filtered or +being automatically selected or mapped for any output. See -discard +option to disable streams individually. +

+

As an output option, disables video recording i.e. automatic selection or +mapping of any video stream. For full manual control see the -map +option. +

+
+
-vcodec codec (output)
+

Set the video codec. This is an alias for -codec:v. +

+
+
-pass[:stream_specifier] n (output,per-stream)
+

Select the pass number (1 or 2). It is used to do two-pass +video encoding. The statistics of the video are recorded in the first +pass into a log file (see also the option -passlogfile), +and in the second pass that log file is used to generate the video +at the exact requested bitrate. +On pass 1, you may just deactivate audio and set output to null, +examples for Windows and Unix: +

+
ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y NUL
+ffmpeg -i foo.mov -c:v libxvid -pass 1 -an -f rawvideo -y /dev/null
+
+ +
+
-passlogfile[:stream_specifier] prefix (output,per-stream)
+

Set two-pass log file name prefix to prefix, the default file name +prefix is “ffmpeg2pass”. The complete file name will be +PREFIX-N.log, where N is a number specific to the output +stream +

+
+
-vf filtergraph (output)
+

Create the filtergraph specified by filtergraph and use it to +filter the stream. +

+

This is an alias for -filter:v, see the -filter option. +

+
+ + +

5.6 Advanced Video options

+ +
+
-pix_fmt[:stream_specifier] format (input/output,per-stream)
+

Set pixel format. Use -pix_fmts to show all the supported +pixel formats. +If the selected pixel format can not be selected, ffmpeg will print a +warning and select the best pixel format supported by the encoder. +If pix_fmt is prefixed by a +, ffmpeg will exit with an error +if the requested pixel format can not be selected, and automatic conversions +inside filtergraphs are disabled. +If pix_fmt is a single +, ffmpeg selects the same pixel format +as the input (or graph output) and automatic conversions are disabled. +

+
+
-sws_flags flags (input/output)
+

Set SwScaler flags. +

+
+
-rc_override[:stream_specifier] override (output,per-stream)
+

Rate control override for specific intervals, formatted as "int,int,int" +list separated with slashes. Two first values are the beginning and +end frame numbers, last one is quantizer to use if positive, or quality +factor if negative. +

+
+
-ilme
+

Force interlacing support in encoder (MPEG-2 and MPEG-4 only). +Use this option if your input file is interlaced and you want +to keep the interlaced format for minimum losses. +The alternative is to deinterlace the input stream with +-deinterlace, but deinterlacing introduces losses. +

+
-psnr
+

Calculate PSNR of compressed frames. +

+
-vstats
+

Dump video coding statistics to vstats_HHMMSS.log. +

+
-vstats_file file
+

Dump video coding statistics to file. +

+
-vstats_version file
+

Specifies which version of the vstats format to use. Default is 2. +

+

version = 1 : +

+

frame= %5d q= %2.1f PSNR= %6.2f f_size= %6d s_size= %8.0fkB time= %0.3f br= %7.1fkbits/s avg_br= %7.1fkbits/s +

+

version > 1: +

+

out= %2d st= %2d frame= %5d q= %2.1f PSNR= %6.2f f_size= %6d s_size= %8.0fkB time= %0.3f br= %7.1fkbits/s avg_br= %7.1fkbits/s +

+
-top[:stream_specifier] n (output,per-stream)
+

top=1/bottom=0/auto=-1 field first +

+
-dc precision
+

Intra_dc_precision. +

+
-vtag fourcc/tag (output)
+

Force video tag/fourcc. This is an alias for -tag:v. +

+
-qphist (global)
+

Show QP histogram +

+
-vbsf bitstream_filter
+

Deprecated see -bsf +

+
+
-force_key_frames[:stream_specifier] time[,time...] (output,per-stream)
+
-force_key_frames[:stream_specifier] expr:expr (output,per-stream)
+
-force_key_frames[:stream_specifier] source (output,per-stream)
+
+

force_key_frames can take arguments of the following form: +

+
+
time[,time...]
+

If the argument consists of timestamps, ffmpeg will round the specified times to the nearest +output timestamp as per the encoder time base and force a keyframe at the first frame having +timestamp equal or greater than the computed timestamp. Note that if the encoder time base is too +coarse, then the keyframes may be forced on frames with timestamps lower than the specified time. +The default encoder time base is the inverse of the output framerate but may be set otherwise +via -enc_time_base. +

+

If one of the times is "chapters[delta]", it is expanded into +the time of the beginning of all chapters in the file, shifted by +delta, expressed as a time in seconds. +This option can be useful to ensure that a seek point is present at a +chapter mark or any other designated place in the output file. +

+

For example, to insert a key frame at 5 minutes, plus key frames 0.1 second +before the beginning of every chapter: +

+
-force_key_frames 0:05:00,chapters-0.1
+
+ +
+
expr:expr
+

If the argument is prefixed with expr:, the string expr +is interpreted like an expression and is evaluated for each frame. A +key frame is forced in case the evaluation is non-zero. +

+

The expression in expr can contain the following constants: +

+
n
+

the number of current processed frame, starting from 0 +

+
n_forced
+

the number of forced frames +

+
prev_forced_n
+

the number of the previous forced frame, it is NAN when no +keyframe was forced yet +

+
prev_forced_t
+

the time of the previous forced frame, it is NAN when no +keyframe was forced yet +

+
t
+

the time of the current processed frame +

+
+ +

For example to force a key frame every 5 seconds, you can specify: +

+
-force_key_frames expr:gte(t,n_forced*5)
+
+ +

To force a key frame 5 seconds after the time of the last forced one, +starting from second 13: +

+
-force_key_frames expr:if(isnan(prev_forced_t),gte(t,13),gte(t,prev_forced_t+5))
+
+ +
+
source
+

If the argument is source, ffmpeg will force a key frame if +the current frame being encoded is marked as a key frame in its source. +

+
+
+ +

Note that forcing too many keyframes is very harmful for the lookahead +algorithms of certain encoders: using fixed-GOP options or similar +would be more efficient. +

+
+
-copyinkf[:stream_specifier] (output,per-stream)
+

When doing stream copy, copy also non-key frames found at the +beginning. +

+
+
-init_hw_device type[=name][:device[,key=value...]]
+

Initialise a new hardware device of type type called name, using the +given device parameters. +If no name is specified it will receive a default name of the form "type%d". +

+

The meaning of device and the following arguments depends on the +device type: +

+
cuda
+

device is the number of the CUDA device. +

+
+
dxva2
+

device is the number of the Direct3D 9 display adapter. +

+
+
vaapi
+

device is either an X11 display name or a DRM render node. +If not specified, it will attempt to open the default X11 display ($DISPLAY) +and then the first DRM render node (/dev/dri/renderD128). +

+
+
vdpau
+

device is an X11 display name. +If not specified, it will attempt to open the default X11 display ($DISPLAY). +

+
+
qsv
+

device selects a value in ‘MFX_IMPL_*’. Allowed values are: +

+
auto
+
sw
+
hw
+
auto_any
+
hw_any
+
hw2
+
hw3
+
hw4
+
+

If not specified, ‘auto_any’ is used. +(Note that it may be easier to achieve the desired result for QSV by creating the +platform-appropriate subdevice (‘dxva2’ or ‘vaapi’) and then deriving a +QSV device from that.) +

+
+
opencl
+

device selects the platform and device as platform_index.device_index. +

+

The set of devices can also be filtered using the key-value pairs to find only +devices matching particular platform or device strings. +

+

The strings usable as filters are: +

+
platform_profile
+
platform_version
+
platform_name
+
platform_vendor
+
platform_extensions
+
device_name
+
device_vendor
+
driver_version
+
device_version
+
device_profile
+
device_extensions
+
device_type
+
+ +

The indices and filters must together uniquely select a device. +

+

Examples: +

+
-init_hw_device opencl:0.1
+

Choose the second device on the first platform. +

+
+
-init_hw_device opencl:,device_name=Foo9000
+

Choose the device with a name containing the string Foo9000. +

+
+
-init_hw_device opencl:1,device_type=gpu,device_extensions=cl_khr_fp16
+

Choose the GPU device on the second platform supporting the cl_khr_fp16 +extension. +

+
+ +
+
vulkan
+

If device is an integer, it selects the device by its index in a +system-dependent list of devices. If device is any other string, it +selects the first device with a name containing that string as a substring. +

+

The following options are recognized: +

+
debug
+

If set to 1, enables the validation layer, if installed. +

+
linear_images
+

If set to 1, images allocated by the hwcontext will be linear and locally mappable. +

+
instance_extensions
+

A plus separated list of additional instance extensions to enable. +

+
device_extensions
+

A plus separated list of additional device extensions to enable. +

+
+ +

Examples: +

+
-init_hw_device vulkan:1
+

Choose the second device on the system. +

+
+
-init_hw_device vulkan:RADV
+

Choose the first device with a name containing the string RADV. +

+
+
-init_hw_device vulkan:0,instance_extensions=VK_KHR_wayland_surface+VK_KHR_xcb_surface
+

Choose the first device and enable the Wayland and XCB instance extensions. +

+
+ +
+
+ +
+
-init_hw_device type[=name]@source
+

Initialise a new hardware device of type type called name, +deriving it from the existing device with the name source. +

+
+
-init_hw_device list
+

List all hardware device types supported in this build of ffmpeg. +

+
+
-filter_hw_device name
+

Pass the hardware device called name to all filters in any filter graph. +This can be used to set the device to upload to with the hwupload filter, +or the device to map to with the hwmap filter. Other filters may also +make use of this parameter when they require a hardware device. Note that this +is typically only required when the input is not already in hardware frames - +when it is, filters will derive the device they require from the context of the +frames they receive as input. +

+

This is a global setting, so all filters will receive the same device. +

+
+
-hwaccel[:stream_specifier] hwaccel (input,per-stream)
+

Use hardware acceleration to decode the matching stream(s). The allowed values +of hwaccel are: +

+
none
+

Do not use any hardware acceleration (the default). +

+
+
auto
+

Automatically select the hardware acceleration method. +

+
+
vdpau
+

Use VDPAU (Video Decode and Presentation API for Unix) hardware acceleration. +

+
+
dxva2
+

Use DXVA2 (DirectX Video Acceleration) hardware acceleration. +

+
+
vaapi
+

Use VAAPI (Video Acceleration API) hardware acceleration. +

+
+
qsv
+

Use the Intel QuickSync Video acceleration for video transcoding. +

+

Unlike most other values, this option does not enable accelerated decoding (that +is used automatically whenever a qsv decoder is selected), but accelerated +transcoding, without copying the frames into the system memory. +

+

For it to work, both the decoder and the encoder must support QSV acceleration +and no filters must be used. +

+
+ +

This option has no effect if the selected hwaccel is not available or not +supported by the chosen decoder. +

+

Note that most acceleration methods are intended for playback and will not be +faster than software decoding on modern CPUs. Additionally, ffmpeg +will usually need to copy the decoded frames from the GPU memory into the system +memory, resulting in further performance loss. This option is thus mainly +useful for testing. +

+
+
-hwaccel_device[:stream_specifier] hwaccel_device (input,per-stream)
+

Select a device to use for hardware acceleration. +

+

This option only makes sense when the -hwaccel option is also specified. +It can either refer to an existing device created with -init_hw_device +by name, or it can create a new device as if +‘-init_hw_device’ type:hwaccel_device +were called immediately before. +

+
+
-hwaccels
+

List all hardware acceleration methods supported in this build of ffmpeg. +

+
+
+ + +

5.7 Audio Options

+ +
+
-aframes number (output)
+

Set the number of audio frames to output. This is an obsolete alias for +-frames:a, which you should use instead. +

+
-ar[:stream_specifier] freq (input/output,per-stream)
+

Set the audio sampling frequency. For output streams it is set by +default to the frequency of the corresponding input stream. For input +streams this option only makes sense for audio grabbing devices and raw +demuxers and is mapped to the corresponding demuxer options. +

+
-aq q (output)
+

Set the audio quality (codec-specific, VBR). This is an alias for -q:a. +

+
-ac[:stream_specifier] channels (input/output,per-stream)
+

Set the number of audio channels. For output streams it is set by +default to the number of input audio channels. For input streams +this option only makes sense for audio grabbing devices and raw demuxers +and is mapped to the corresponding demuxer options. +

+
-an (input/output)
+

As an input option, blocks all audio streams of a file from being filtered or +being automatically selected or mapped for any output. See -discard +option to disable streams individually. +

+

As an output option, disables audio recording i.e. automatic selection or +mapping of any audio stream. For full manual control see the -map +option. +

+
-acodec codec (input/output)
+

Set the audio codec. This is an alias for -codec:a. +

+
-sample_fmt[:stream_specifier] sample_fmt (output,per-stream)
+

Set the audio sample format. Use -sample_fmts to get a list +of supported sample formats. +

+
+
-af filtergraph (output)
+

Create the filtergraph specified by filtergraph and use it to +filter the stream. +

+

This is an alias for -filter:a, see the -filter option. +

+
+ + +

5.8 Advanced Audio options

+ +
+
-atag fourcc/tag (output)
+

Force audio tag/fourcc. This is an alias for -tag:a. +

+
-absf bitstream_filter
+

Deprecated, see -bsf +

+
-guess_layout_max channels (input,per-stream)
+

If some input channel layout is not known, try to guess only if it +corresponds to at most the specified number of channels. For example, 2 +tells to ffmpeg to recognize 1 channel as mono and 2 channels as +stereo but not 6 channels as 5.1. The default is to always try to guess. Use +0 to disable all guessing. +

+
+ + +

5.9 Subtitle options

+ +
+
-scodec codec (input/output)
+

Set the subtitle codec. This is an alias for -codec:s. +

+
-sn (input/output)
+

As an input option, blocks all subtitle streams of a file from being filtered or +being automatically selected or mapped for any output. See -discard +option to disable streams individually. +

+

As an output option, disables subtitle recording i.e. automatic selection or +mapping of any subtitle stream. For full manual control see the -map +option. +

+
-sbsf bitstream_filter
+

Deprecated, see -bsf +

+
+ + +

5.10 Advanced Subtitle options

+ +
+
-fix_sub_duration
+

Fix subtitles durations. For each subtitle, wait for the next packet in the +same stream and adjust the duration of the first to avoid overlap. This is +necessary with some subtitles codecs, especially DVB subtitles, because the +duration in the original packet is only a rough estimate and the end is +actually marked by an empty subtitle frame. Failing to use this option when +necessary can result in exaggerated durations or muxing failures due to +non-monotonic timestamps. +

+

Note that this option will delay the output of all data until the next +subtitle packet is decoded: it may increase memory consumption and latency a +lot. +

+
+
-canvas_size size
+

Set the size of the canvas used to render subtitles. +

+
+
+ + +

5.11 Advanced options

+ +
+
-map [-]input_file_id[:stream_specifier][?][,sync_file_id[:stream_specifier]] | [linklabel] (output)
+
+

Designate one or more input streams as a source for the output file. Each input +stream is identified by the input file index input_file_id and +the input stream index input_stream_id within the input +file. Both indices start at 0. If specified, +sync_file_id:stream_specifier sets which input stream +is used as a presentation sync reference. +

+

The first -map option on the command line specifies the +source for output stream 0, the second -map option specifies +the source for output stream 1, etc. +

+

A - character before the stream identifier creates a "negative" mapping. +It disables matching streams from already created mappings. +

+

A trailing ? after the stream index will allow the map to be +optional: if the map matches no streams the map will be ignored instead +of failing. Note the map will still fail if an invalid input file index +is used; such as if the map refers to a non-existent input. +

+

An alternative [linklabel] form will map outputs from complex filter +graphs (see the -filter_complex option) to the output file. +linklabel must correspond to a defined output link label in the graph. +

+

For example, to map ALL streams from the first input file to output +

+
ffmpeg -i INPUT -map 0 output
+
+ +

For example, if you have two audio streams in the first input file, +these streams are identified by "0:0" and "0:1". You can use +-map to select which streams to place in an output file. For +example: +

+
ffmpeg -i INPUT -map 0:1 out.wav
+
+

will map the input stream in INPUT identified by "0:1" to +the (single) output stream in out.wav. +

+

For example, to select the stream with index 2 from input file +a.mov (specified by the identifier "0:2"), and stream with +index 6 from input b.mov (specified by the identifier "1:6"), +and copy them to the output file out.mov: +

+
ffmpeg -i a.mov -i b.mov -c copy -map 0:2 -map 1:6 out.mov
+
+ +

To select all video and the third audio stream from an input file: +

+
ffmpeg -i INPUT -map 0:v -map 0:a:2 OUTPUT
+
+ +

To map all the streams except the second audio, use negative mappings +

+
ffmpeg -i INPUT -map 0 -map -0:a:1 OUTPUT
+
+ +

To map the video and audio streams from the first input, and using the +trailing ?, ignore the audio mapping if no audio streams exist in +the first input: +

+
ffmpeg -i INPUT -map 0:v -map 0:a? OUTPUT
+
+ +

To pick the English audio stream: +

+
ffmpeg -i INPUT -map 0:m:language:eng OUTPUT
+
+ +

Note that using this option disables the default mappings for this output file. +

+
+
-ignore_unknown
+

Ignore input streams with unknown type instead of failing if copying +such streams is attempted. +

+
+
-copy_unknown
+

Allow input streams with unknown type to be copied instead of failing if copying +such streams is attempted. +

+
+
-map_channel [input_file_id.stream_specifier.channel_id|-1][?][:output_file_id.stream_specifier]
+

Map an audio channel from a given input to an output. If +output_file_id.stream_specifier is not set, the audio channel will +be mapped on all the audio streams. +

+

Using "-1" instead of +input_file_id.stream_specifier.channel_id will map a muted +channel. +

+

A trailing ? will allow the map_channel to be +optional: if the map_channel matches no channel the map_channel will be ignored instead +of failing. +

+

For example, assuming INPUT is a stereo audio file, you can switch the +two audio channels with the following command: +

+
ffmpeg -i INPUT -map_channel 0.0.1 -map_channel 0.0.0 OUTPUT
+
+ +

If you want to mute the first channel and keep the second: +

+
ffmpeg -i INPUT -map_channel -1 -map_channel 0.0.1 OUTPUT
+
+ +

The order of the "-map_channel" option specifies the order of the channels in +the output stream. The output channel layout is guessed from the number of +channels mapped (mono if one "-map_channel", stereo if two, etc.). Using "-ac" +in combination of "-map_channel" makes the channel gain levels to be updated if +input and output channel layouts don’t match (for instance two "-map_channel" +options and "-ac 6"). +

+

You can also extract each channel of an input to specific outputs; the following +command extracts two channels of the INPUT audio stream (file 0, stream 0) +to the respective OUTPUT_CH0 and OUTPUT_CH1 outputs: +

+
ffmpeg -i INPUT -map_channel 0.0.0 OUTPUT_CH0 -map_channel 0.0.1 OUTPUT_CH1
+
+ +

The following example splits the channels of a stereo input into two separate +streams, which are put into the same output file: +

+
ffmpeg -i stereo.wav -map 0:0 -map 0:0 -map_channel 0.0.0:0.0 -map_channel 0.0.1:0.1 -y out.ogg
+
+ +

Note that currently each output stream can only contain channels from a single +input stream; you can’t for example use "-map_channel" to pick multiple input +audio channels contained in different streams (from the same or different files) +and merge them into a single output stream. It is therefore not currently +possible, for example, to turn two separate mono streams into a single stereo +stream. However splitting a stereo stream into two single channel mono streams +is possible. +

+

If you need this feature, a possible workaround is to use the amerge +filter. For example, if you need to merge a media (here input.mkv) with 2 +mono audio streams into one single stereo channel audio stream (and keep the +video stream), you can use the following command: +

+
ffmpeg -i input.mkv -filter_complex "[0:1] [0:2] amerge" -c:a pcm_s16le -c:v copy output.mkv
+
+ +

To map the first two audio channels from the first input, and using the +trailing ?, ignore the audio channel mapping if the first input is +mono instead of stereo: +

+
ffmpeg -i INPUT -map_channel 0.0.0 -map_channel 0.0.1? OUTPUT
+
+ +
+
-map_metadata[:metadata_spec_out] infile[:metadata_spec_in] (output,per-metadata)
+

Set metadata information of the next output file from infile. Note that +those are file indices (zero-based), not filenames. +Optional metadata_spec_in/out parameters specify, which metadata to copy. +A metadata specifier can have the following forms: +

+
g
+

global metadata, i.e. metadata that applies to the whole file +

+
+
s[:stream_spec]
+

per-stream metadata. stream_spec is a stream specifier as described +in the Stream specifiers chapter. In an input metadata specifier, the first +matching stream is copied from. In an output metadata specifier, all matching +streams are copied to. +

+
+
c:chapter_index
+

per-chapter metadata. chapter_index is the zero-based chapter index. +

+
+
p:program_index
+

per-program metadata. program_index is the zero-based program index. +

+
+

If metadata specifier is omitted, it defaults to global. +

+

By default, global metadata is copied from the first input file, +per-stream and per-chapter metadata is copied along with streams/chapters. These +default mappings are disabled by creating any mapping of the relevant type. A negative +file index can be used to create a dummy mapping that just disables automatic copying. +

+

For example to copy metadata from the first stream of the input file to global metadata +of the output file: +

+
ffmpeg -i in.ogg -map_metadata 0:s:0 out.mp3
+
+ +

To do the reverse, i.e. copy global metadata to all audio streams: +

+
ffmpeg -i in.mkv -map_metadata:s:a 0:g out.mkv
+
+

Note that simple 0 would work as well in this example, since global +metadata is assumed by default. +

+
+
-map_chapters input_file_index (output)
+

Copy chapters from input file with index input_file_index to the next +output file. If no chapter mapping is specified, then chapters are copied from +the first input file with at least one chapter. Use a negative file index to +disable any chapter copying. +

+
+
-benchmark (global)
+

Show benchmarking information at the end of an encode. +Shows real, system and user time used and maximum memory consumption. +Maximum memory consumption is not supported on all systems, +it will usually display as 0 if not supported. +

+
-benchmark_all (global)
+

Show benchmarking information during the encode. +Shows real, system and user time used in various steps (audio/video encode/decode). +

+
-timelimit duration (global)
+

Exit after ffmpeg has been running for duration seconds in CPU user time. +

+
-dump (global)
+

Dump each input packet to stderr. +

+
-hex (global)
+

When dumping packets, also dump the payload. +

+
-re (input)
+

Read input at native frame rate. Mainly used to simulate a grab device, +or live input stream (e.g. when reading from a file). Should not be used +with actual grab devices or live input streams (where it can cause packet +loss). +By default ffmpeg attempts to read the input(s) as fast as possible. +This option will slow down the reading of the input(s) to the native frame rate +of the input(s). It is useful for real-time output (e.g. live streaming). +

+
-vsync parameter
+

Video sync method. +For compatibility reasons old values can be specified as numbers. +Newly added values will have to be specified as strings always. +

+
+
0, passthrough
+

Each frame is passed with its timestamp from the demuxer to the muxer. +

+
1, cfr
+

Frames will be duplicated and dropped to achieve exactly the requested +constant frame rate. +

+
2, vfr
+

Frames are passed through with their timestamp or dropped so as to +prevent 2 frames from having the same timestamp. +

+
drop
+

As passthrough but destroys all timestamps, making the muxer generate +fresh timestamps based on frame-rate. +

+
-1, auto
+

Chooses between 1 and 2 depending on muxer capabilities. This is the +default method. +

+
+ +

Note that the timestamps may be further modified by the muxer, after this. +For example, in the case that the format option avoid_negative_ts +is enabled. +

+

With -map you can select from which stream the timestamps should be +taken. You can leave either video or audio unchanged and sync the +remaining stream(s) to the unchanged one. +

+
+
-frame_drop_threshold parameter
+

Frame drop threshold, which specifies how much behind video frames can +be before they are dropped. In frame rate units, so 1.0 is one frame. +The default is -1.1. One possible usecase is to avoid framedrops in case +of noisy timestamps or to increase frame drop precision in case of exact +timestamps. +

+
+
-async samples_per_second
+

Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps, +the parameter is the maximum samples per second by which the audio is changed. +-async 1 is a special case where only the start of the audio stream is corrected +without any later correction. +

+

Note that the timestamps may be further modified by the muxer, after this. +For example, in the case that the format option avoid_negative_ts +is enabled. +

+

This option has been deprecated. Use the aresample audio filter instead. +

+
+
-copyts
+

Do not process input timestamps, but keep their values without trying +to sanitize them. In particular, do not remove the initial start time +offset value. +

+

Note that, depending on the vsync option or on specific muxer +processing (e.g. in case the format option avoid_negative_ts +is enabled) the output timestamps may mismatch with the input +timestamps even when this option is selected. +

+
+
-start_at_zero
+

When used with copyts, shift input timestamps so they start at zero. +

+

This means that using e.g. -ss 50 will make output timestamps start at +50 seconds, regardless of what timestamp the input file started at. +

+
+
-copytb mode
+

Specify how to set the encoder timebase when stream copying. mode is an +integer numeric value, and can assume one of the following values: +

+
+
1
+

Use the demuxer timebase. +

+

The time base is copied to the output encoder from the corresponding input +demuxer. This is sometimes required to avoid non monotonically increasing +timestamps when copying video streams with variable frame rate. +

+
+
0
+

Use the decoder timebase. +

+

The time base is copied to the output encoder from the corresponding input +decoder. +

+
+
-1
+

Try to make the choice automatically, in order to generate a sane output. +

+
+ +

Default value is -1. +

+
+
-enc_time_base[:stream_specifier] timebase (output,per-stream)
+

Set the encoder timebase. timebase is a floating point number, +and can assume one of the following values: +

+
+
0
+

Assign a default value according to the media type. +

+

For video - use 1/framerate, for audio - use 1/samplerate. +

+
+
-1
+

Use the input stream timebase when possible. +

+

If an input stream is not available, the default timebase will be used. +

+
+
>0
+

Use the provided number as the timebase. +

+

This field can be provided as a ratio of two integers (e.g. 1:24, 1:48000) +or as a floating point number (e.g. 0.04166, 2.0833e-5) +

+
+ +

Default value is 0. +

+
+
-bitexact (input/output)
+

Enable bitexact mode for (de)muxer and (de/en)coder +

+
-shortest (output)
+

Finish encoding when the shortest input stream ends. +

+
-dts_delta_threshold
+

Timestamp discontinuity delta threshold. +

+
-dts_error_threshold seconds
+

Timestamp error delta threshold. This threshold use to discard crazy/damaged +timestamps and the default is 30 hours which is arbitrarily picked and quite +conservative. +

+
-muxdelay seconds (output)
+

Set the maximum demux-decode delay. +

+
-muxpreload seconds (output)
+

Set the initial demux-decode delay. +

+
-streamid output-stream-index:new-value (output)
+

Assign a new stream-id value to an output stream. This option should be +specified prior to the output filename to which it applies. +For the situation where multiple output files exist, a streamid +may be reassigned to a different value. +

+

For example, to set the stream 0 PID to 33 and the stream 1 PID to 36 for +an output mpegts file: +

+
ffmpeg -i inurl -streamid 0:33 -streamid 1:36 out.ts
+
+ +
+
-bsf[:stream_specifier] bitstream_filters (output,per-stream)
+

Set bitstream filters for matching streams. bitstream_filters is +a comma-separated list of bitstream filters. Use the -bsfs option +to get the list of bitstream filters. +

+
ffmpeg -i h264.mp4 -c:v copy -bsf:v h264_mp4toannexb -an out.h264
+
+
+
ffmpeg -i file.mov -an -vn -bsf:s mov2textsub -c:s copy -f rawvideo sub.txt
+
+ +
+
-tag[:stream_specifier] codec_tag (input/output,per-stream)
+

Force a tag/fourcc for matching streams. +

+
+
-timecode hh:mm:ssSEPff
+

Specify Timecode for writing. SEP is ’:’ for non drop timecode and ’;’ +(or ’.’) for drop. +

+
ffmpeg -i input.mpg -timecode 01:02:03.04 -r 30000/1001 -s ntsc output.mpg
+
+ +
+
-filter_complex filtergraph (global)
+

Define a complex filtergraph, i.e. one with arbitrary number of inputs and/or +outputs. For simple graphs – those with one input and one output of the same +type – see the -filter options. filtergraph is a description of +the filtergraph, as described in the “Filtergraph syntax” section of the +ffmpeg-filters manual. +

+

Input link labels must refer to input streams using the +[file_index:stream_specifier] syntax (i.e. the same as -map +uses). If stream_specifier matches multiple streams, the first one will be +used. An unlabeled input will be connected to the first unused input stream of +the matching type. +

+

Output link labels are referred to with -map. Unlabeled outputs are +added to the first output file. +

+

Note that with this option it is possible to use only lavfi sources without +normal input files. +

+

For example, to overlay an image over video +

+
ffmpeg -i video.mkv -i image.png -filter_complex '[0:v][1:v]overlay[out]' -map
+'[out]' out.mkv
+
+

Here [0:v] refers to the first video stream in the first input file, +which is linked to the first (main) input of the overlay filter. Similarly the +first video stream in the second input is linked to the second (overlay) input +of overlay. +

+

Assuming there is only one video stream in each input file, we can omit input +labels, so the above is equivalent to +

+
ffmpeg -i video.mkv -i image.png -filter_complex 'overlay[out]' -map
+'[out]' out.mkv
+
+ +

Furthermore we can omit the output label and the single output from the filter +graph will be added to the output file automatically, so we can simply write +

+
ffmpeg -i video.mkv -i image.png -filter_complex 'overlay' out.mkv
+
+ +

To generate 5 seconds of pure red video using lavfi color source: +

+
ffmpeg -filter_complex 'color=c=red' -t 5 out.mkv
+
+ +
+
-filter_complex_threads nb_threads (global)
+

Defines how many threads are used to process a filter_complex graph. +Similar to filter_threads but used for -filter_complex graphs only. +The default is the number of available CPUs. +

+
+
-lavfi filtergraph (global)
+

Define a complex filtergraph, i.e. one with arbitrary number of inputs and/or +outputs. Equivalent to -filter_complex. +

+
+
-filter_complex_script filename (global)
+

This option is similar to -filter_complex, the only difference is that +its argument is the name of the file from which a complex filtergraph +description is to be read. +

+
+
-accurate_seek (input)
+

This option enables or disables accurate seeking in input files with the +-ss option. It is enabled by default, so seeking is accurate when +transcoding. Use -noaccurate_seek to disable it, which may be useful +e.g. when copying some streams and transcoding the others. +

+
+
-seek_timestamp (input)
+

This option enables or disables seeking by timestamp in input files with the +-ss option. It is disabled by default. If enabled, the argument +to the -ss option is considered an actual timestamp, and is not +offset by the start time of the file. This matters only for files which do +not start from timestamp 0, such as transport streams. +

+
+
-thread_queue_size size (input)
+

This option sets the maximum number of queued packets when reading from the +file or device. With low latency / high rate live streams, packets may be +discarded if they are not read in a timely manner; raising this value can +avoid it. +

+
+
-sdp_file file (global)
+

Print sdp information for an output stream to file. +This allows dumping sdp information when at least one output isn’t an +rtp stream. (Requires at least one of the output formats to be rtp). +

+
+
-discard (input)
+

Allows discarding specific streams or frames from streams. +Any input stream can be fully discarded, using value all whereas +selective discarding of frames from a stream occurs at the demuxer +and is not supported by all demuxers. +

+
+
none
+

Discard no frame. +

+
+
default
+

Default, which discards no frames. +

+
+
noref
+

Discard all non-reference frames. +

+
+
bidir
+

Discard all bidirectional frames. +

+
+
nokey
+

Discard all frames excepts keyframes. +

+
+
all
+

Discard all frames. +

+
+ +
+
-abort_on flags (global)
+

Stop and abort on various conditions. The following flags are available: +

+
+
empty_output
+

No packets were passed to the muxer, the output is empty. +

+
empty_output_stream
+

No packets were passed to the muxer in some of the output streams. +

+
+ +
+
-xerror (global)
+

Stop and exit on error +

+
+
-max_muxing_queue_size packets (output,per-stream)
+

When transcoding audio and/or video streams, ffmpeg will not begin writing into +the output until it has one packet for each such stream. While waiting for that +to happen, packets for other streams are buffered. This option sets the size of +this buffer, in packets, for the matching output stream. +

+

The default value of this option should be high enough for most uses, so only +touch this option if you are sure that you need it. +

+
+
+ +

As a special exception, you can use a bitmap subtitle stream as input: it +will be converted into a video with the same size as the largest video in +the file, or 720x576 if no video is present. Note that this is an +experimental and temporary solution. It will be removed once libavfilter has +proper support for subtitles. +

+

For example, to hardcode subtitles on top of a DVB-T recording stored in +MPEG-TS format, delaying the subtitles by 1 second: +

+
ffmpeg -i input.ts -filter_complex \
+  '[#0x2ef] setpts=PTS+1/TB [sub] ; [#0x2d0] [sub] overlay' \
+  -sn -map '#0x2dc' output.mkv
+
+

(0x2d0, 0x2dc and 0x2ef are the MPEG-TS PIDs of respectively the video, +audio and subtitles streams; 0:0, 0:3 and 0:7 would have worked too) +

+ +

5.12 Preset files

+

A preset file contains a sequence of option=value pairs, +one for each line, specifying a sequence of options which would be +awkward to specify on the command line. Lines starting with the hash +(’#’) character are ignored and are used to provide comments. Check +the presets directory in the FFmpeg source tree for examples. +

+

There are two types of preset files: ffpreset and avpreset files. +

+ +

5.12.1 ffpreset files

+

ffpreset files are specified with the vpre, apre, +spre, and fpre options. The fpre option takes the +filename of the preset instead of a preset name as input and can be +used for any kind of codec. For the vpre, apre, and +spre options, the options specified in a preset file are +applied to the currently selected codec of the same type as the preset +option. +

+

The argument passed to the vpre, apre, and spre +preset options identifies the preset file to use according to the +following rules: +

+

First ffmpeg searches for a file named arg.ffpreset in the +directories $FFMPEG_DATADIR (if set), and $HOME/.ffmpeg, and in +the datadir defined at configuration time (usually PREFIX/share/ffmpeg) +or in a ffpresets folder along the executable on win32, +in that order. For example, if the argument is libvpx-1080p, it will +search for the file libvpx-1080p.ffpreset. +

+

If no such file is found, then ffmpeg will search for a file named +codec_name-arg.ffpreset in the above-mentioned +directories, where codec_name is the name of the codec to which +the preset file options will be applied. For example, if you select +the video codec with -vcodec libvpx and use -vpre 1080p, +then it will search for the file libvpx-1080p.ffpreset. +

+ +

5.12.2 avpreset files

+

avpreset files are specified with the pre option. They work similar to +ffpreset files, but they only allow encoder- specific options. Therefore, an +option=value pair specifying an encoder cannot be used. +

+

When the pre option is specified, ffmpeg will look for files with the +suffix .avpreset in the directories $AVCONV_DATADIR (if set), and +$HOME/.avconv, and in the datadir defined at configuration time (usually +PREFIX/share/ffmpeg), in that order. +

+

First ffmpeg searches for a file named codec_name-arg.avpreset in +the above-mentioned directories, where codec_name is the name of the codec +to which the preset file options will be applied. For example, if you select the +video codec with -vcodec libvpx and use -pre 1080p, then it will +search for the file libvpx-1080p.avpreset. +

+

If no such file is found, then ffmpeg will search for a file named +arg.avpreset in the same directories. +

+ + +

6 Examples

+ + +

6.1 Video and Audio grabbing

+ +

If you specify the input format and device then ffmpeg can grab video +and audio directly. +

+
+
ffmpeg -f oss -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
+
+ +

Or with an ALSA audio source (mono input, card id 1) instead of OSS: +

+
ffmpeg -f alsa -ac 1 -i hw:1 -f video4linux2 -i /dev/video0 /tmp/out.mpg
+
+ +

Note that you must activate the right video source and channel before +launching ffmpeg with any TV viewer such as +xawtv by Gerd Knorr. You also +have to set the audio recording levels correctly with a +standard mixer. +

+ +

6.2 X11 grabbing

+ +

Grab the X11 display with ffmpeg via +

+
+
ffmpeg -f x11grab -video_size cif -framerate 25 -i :0.0 /tmp/out.mpg
+
+ +

0.0 is display.screen number of your X11 server, same as +the DISPLAY environment variable. +

+
+
ffmpeg -f x11grab -video_size cif -framerate 25 -i :0.0+10,20 /tmp/out.mpg
+
+ +

0.0 is display.screen number of your X11 server, same as the DISPLAY environment +variable. 10 is the x-offset and 20 the y-offset for the grabbing. +

+ +

6.3 Video and Audio file format conversion

+ +

Any supported file format and protocol can serve as input to ffmpeg: +

+

Examples: +

    +
  • You can use YUV files as input: + +
    +
    ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
+
    + +

    It will use the files: +

    +
    /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
+/tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
+
    + +

    The Y files use twice the resolution of the U and V files. They are +raw files, without header. They can be generated by all decent video +decoders. You must specify the size of the image with the -s option +if ffmpeg cannot guess it. +

    +
  • You can input from a raw YUV420P file: + +
    +
    ffmpeg -i /tmp/test.yuv /tmp/out.avi
+
    + +

    test.yuv is a file containing raw YUV planar data. Each frame is composed +of the Y plane followed by the U and V planes at half vertical and +horizontal resolution. +

    +
  • You can output to a raw YUV420P file: + +
    +
    ffmpeg -i mydivx.avi hugefile.yuv
+
    + +
  • You can set several input files and output files: + +
    +
    ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
+
    + +

    Converts the audio file a.wav and the raw YUV video file a.yuv +to MPEG file a.mpg. +

    +
  • You can also do audio and video conversions at the same time: + +
    +
    ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
+
    + +

    Converts a.wav to MPEG audio at 22050 Hz sample rate. +

    +
  • You can encode to several formats at the same time and define a +mapping from input stream to output streams: + +
    +
    ffmpeg -i /tmp/a.wav -map 0:a -b:a 64k /tmp/a.mp2 -map 0:a -b:a 128k /tmp/b.mp2
+
    + +

    Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. ’-map +file:index’ specifies which input stream is used for each output +stream, in the order of the definition of output streams. +

    +
  • You can transcode decrypted VOBs: + +
    +
    ffmpeg -i snatch_1.vob -f avi -c:v mpeg4 -b:v 800k -g 300 -bf 2 -c:a libmp3lame -b:a 128k snatch.avi
+
    + +

    This is a typical DVD ripping example; the input is a VOB file, the +output an AVI file with MPEG-4 video and MP3 audio. Note that in this +command we use B-frames so the MPEG-4 stream is DivX5 compatible, and +GOP size is 300 which means one intra frame every 10 seconds for 29.97fps +input video. Furthermore, the audio stream is MP3-encoded so you need +to enable LAME support by passing --enable-libmp3lame to configure. +The mapping is particularly useful for DVD transcoding +to get the desired audio language. +

    +

    NOTE: To see the supported input formats, use ffmpeg -demuxers. +

    +
  • You can extract images from a video, or create a video from many images: + +

    For extracting images from a video: +

    +
    ffmpeg -i foo.avi -r 1 -s WxH -f image2 foo-%03d.jpeg
+
    + +

    This will extract one video frame per second from the video and will +output them in files named foo-001.jpeg, foo-002.jpeg, +etc. Images will be rescaled to fit the new WxH values. +

    +

    If you want to extract just a limited number of frames, you can use the +above command in combination with the -frames:v or -t option, +or in combination with -ss to start extracting from a certain point in time. +

    +

    For creating a video from many images: +

    +
    ffmpeg -f image2 -framerate 12 -i foo-%03d.jpeg -s WxH foo.avi
+
    + +

    The syntax foo-%03d.jpeg specifies to use a decimal number +composed of three digits padded with zeroes to express the sequence +number. It is the same syntax supported by the C printf function, but +only formats accepting a normal integer are suitable. +

    +

    When importing an image sequence, -i also supports expanding +shell-like wildcard patterns (globbing) internally, by selecting the +image2-specific -pattern_type glob option. +

    +

    For example, for creating a video from filenames matching the glob pattern +foo-*.jpeg: +

    +
    ffmpeg -f image2 -pattern_type glob -framerate 12 -i 'foo-*.jpeg' -s WxH foo.avi
+
    + +
  • You can put many streams of the same type in the output: + +
    +
    ffmpeg -i test1.avi -i test2.avi -map 1:1 -map 1:0 -map 0:1 -map 0:0 -c copy -y test12.nut
+
    + +

    The resulting output file test12.nut will contain the first four streams +from the input files in reverse order. +

    +
  • To force CBR video output: +
    +
    ffmpeg -i myfile.avi -b 4000k -minrate 4000k -maxrate 4000k -bufsize 1835k out.m2v
+
    + +
  • The four options lmin, lmax, mblmin and mblmax use ’lambda’ units, +but you may use the QP2LAMBDA constant to easily convert from ’q’ units: +
    +
    ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
+
    + +
+ + + +

7 See Also

+ +

ffmpeg-all, +ffplay, ffprobe, +ffmpeg-utils, +ffmpeg-scaler, +ffmpeg-resampler, +ffmpeg-codecs, +ffmpeg-bitstream-filters, +ffmpeg-formats, +ffmpeg-devices, +ffmpeg-protocols, +ffmpeg-filters +

+ + +

8 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffplay-all.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffplay-all.html new file mode 100644 index 0000000..f9ac23f --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffplay-all.html @@ -0,0 +1,41095 @@ + + + + + + + ffplay Documentation + + + + + + +
+

+ ffplay Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Synopsis

+ +

ffplay [options] [input_url] +

+ +

2 Description

+ +

FFplay is a very simple and portable media player using the FFmpeg +libraries and the SDL library. It is mostly used as a testbed for the +various FFmpeg APIs. +

+ +

3 Options

+ +

All the numerical options, if not specified otherwise, accept a string +representing a number as input, which may be followed by one of the SI +unit prefixes, for example: ’K’, ’M’, or ’G’. +

+

If ’i’ is appended to the SI unit prefix, the complete prefix will be +interpreted as a unit prefix for binary multiples, which are based on +powers of 1024 instead of powers of 1000. Appending ’B’ to the SI unit +prefix multiplies the value by 8. This allows using, for example: +’KB’, ’MiB’, ’G’ and ’B’ as number suffixes. +

+

Options which do not take arguments are boolean options, and set the +corresponding value to true. They can be set to false by prefixing +the option name with "no". For example using "-nofoo" +will set the boolean option with name "foo" to false. +

+ +

3.1 Stream specifiers

+

Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers +are used to precisely specify which stream(s) a given option belongs to. +

+

A stream specifier is a string generally appended to the option name and +separated from it by a colon. E.g. -codec:a:1 ac3 contains the +a:1 stream specifier, which matches the second audio stream. Therefore, it +would select the ac3 codec for the second audio stream. +

+

A stream specifier can match several streams, so that the option is applied to all +of them. E.g. the stream specifier in -b:a 128k matches all audio +streams. +

+

An empty stream specifier matches all streams. For example, -codec copy +or -codec: copy would copy all the streams without reencoding. +

+

Possible forms of stream specifiers are: +

+
stream_index
+

Matches the stream with this index. E.g. -threads:1 4 would set the +thread count for the second stream to 4. If stream_index is used as an +additional stream specifier (see below), then it selects stream number +stream_index from the matching streams. Stream numbering is based on the +order of the streams as detected by libavformat except when a program ID is +also specified. In this case it is based on the ordering of the streams in the +program. +

+
stream_type[:additional_stream_specifier]
+

stream_type is one of following: ’v’ or ’V’ for video, ’a’ for audio, ’s’ +for subtitle, ’d’ for data, and ’t’ for attachments. ’v’ matches all video +streams, ’V’ only matches video streams which are not attached pictures, video +thumbnails or cover arts. If additional_stream_specifier is used, then +it matches streams which both have this type and match the +additional_stream_specifier. Otherwise, it matches all streams of the +specified type. +

+
p:program_id[:additional_stream_specifier]
+

Matches streams which are in the program with the id program_id. If +additional_stream_specifier is used, then it matches streams which both +are part of the program and match the additional_stream_specifier. +

+
+
#stream_id or i:stream_id
+

Match the stream by stream id (e.g. PID in MPEG-TS container). +

+
m:key[:value]
+

Matches streams with the metadata tag key having the specified value. If +value is not given, matches streams that contain the given tag with any +value. +

+
u
+

Matches streams with usable configuration, the codec must be defined and the +essential information such as video dimension or audio sample rate must be present. +

+

Note that in ffmpeg, matching by metadata will only work properly for +input files. +

+
+ + +

3.2 Generic options

+ +

These options are shared amongst the ff* tools. +

+
+
-L
+

Show license. +

+
+
-h, -?, -help, --help [arg]
+

Show help. An optional parameter may be specified to print help about a specific +item. If no argument is specified, only basic (non advanced) tool +options are shown. +

+

Possible values of arg are: +

+
long
+

Print advanced tool options in addition to the basic tool options. +

+
+
full
+

Print complete list of options, including shared and private options +for encoders, decoders, demuxers, muxers, filters, etc. +

+
+
decoder=decoder_name
+

Print detailed information about the decoder named decoder_name. Use the +-decoders option to get a list of all decoders. +

+
+
encoder=encoder_name
+

Print detailed information about the encoder named encoder_name. Use the +-encoders option to get a list of all encoders. +

+
+
demuxer=demuxer_name
+

Print detailed information about the demuxer named demuxer_name. Use the +-formats option to get a list of all demuxers and muxers. +

+
+
muxer=muxer_name
+

Print detailed information about the muxer named muxer_name. Use the +-formats option to get a list of all muxers and demuxers. +

+
+
filter=filter_name
+

Print detailed information about the filter name filter_name. Use the +-filters option to get a list of all filters. +

+
+
bsf=bitstream_filter_name
+

Print detailed information about the bitstream filter name bitstream_filter_name. +Use the -bsfs option to get a list of all bitstream filters. +

+
+ +
+
-version
+

Show version. +

+
+
-formats
+

Show available formats (including devices). +

+
+
-demuxers
+

Show available demuxers. +

+
+
-muxers
+

Show available muxers. +

+
+
-devices
+

Show available devices. +

+
+
-codecs
+

Show all codecs known to libavcodec. +

+

Note that the term ’codec’ is used throughout this documentation as a shortcut +for what is more correctly called a media bitstream format. +

+
+
-decoders
+

Show available decoders. +

+
+
-encoders
+

Show all available encoders. +

+
+
-bsfs
+

Show available bitstream filters. +

+
+
-protocols
+

Show available protocols. +

+
+
-filters
+

Show available libavfilter filters. +

+
+
-pix_fmts
+

Show available pixel formats. +

+
+
-sample_fmts
+

Show available sample formats. +

+
+
-layouts
+

Show channel names and standard channel layouts. +

+
+
-colors
+

Show recognized color names. +

+
+
-sources device[,opt1=val1[,opt2=val2]...]
+

Show autodetected sources of the input device. +Some devices may provide system-dependent source names that cannot be autodetected. +The returned list cannot be assumed to be always complete. +

+
ffmpeg -sources pulse,server=192.168.0.4
+
+ +
+
-sinks device[,opt1=val1[,opt2=val2]...]
+

Show autodetected sinks of the output device. +Some devices may provide system-dependent sink names that cannot be autodetected. +The returned list cannot be assumed to be always complete. +

+
ffmpeg -sinks pulse,server=192.168.0.4
+
+ +
+
-loglevel [flags+]loglevel | -v [flags+]loglevel
+

Set logging level and flags used by the library. +

+

The optional flags prefix can consist of the following values: +

+
‘repeat’
+

Indicates that repeated log output should not be compressed to the first line +and the "Last message repeated n times" line will be omitted. +

+
‘level’
+

Indicates that log output should add a [level] prefix to each message +line. This can be used as an alternative to log coloring, e.g. when dumping the +log to file. +

+
+

Flags can also be used alone by adding a ’+’/’-’ prefix to set/reset a single +flag without affecting other flags or changing loglevel. When +setting both flags and loglevel, a ’+’ separator is expected +between the last flags value and before loglevel. +

+

loglevel is a string or a number containing one of the following values: +

+
‘quiet, -8’
+

Show nothing at all; be silent. +

+
‘panic, 0’
+

Only show fatal errors which could lead the process to crash, such as +an assertion failure. This is not currently used for anything. +

+
‘fatal, 8’
+

Only show fatal errors. These are errors after which the process absolutely +cannot continue. +

+
‘error, 16’
+

Show all errors, including ones which can be recovered from. +

+
‘warning, 24’
+

Show all warnings and errors. Any message related to possibly +incorrect or unexpected events will be shown. +

+
‘info, 32’
+

Show informative messages during processing. This is in addition to +warnings and errors. This is the default value. +

+
‘verbose, 40’
+

Same as info, except more verbose. +

+
‘debug, 48’
+

Show everything, including debugging information. +

+
‘trace, 56’
+
+ +

For example to enable repeated log output, add the level prefix, and set +loglevel to verbose: +

+
ffmpeg -loglevel repeat+level+verbose -i input output
+
+

Another example that enables repeated log output without affecting current +state of level prefix flag or loglevel: +

+
ffmpeg [...] -loglevel +repeat
+
+ +

By default the program logs to stderr. If coloring is supported by the +terminal, colors are used to mark errors and warnings. Log coloring +can be disabled setting the environment variable +AV_LOG_FORCE_NOCOLOR, or can be forced setting +the environment variable AV_LOG_FORCE_COLOR. +

+
+
-report
+

Dump full command line and log output to a file named +program-YYYYMMDD-HHMMSS.log in the current +directory. +This file can be useful for bug reports. +It also implies -loglevel debug. +

+

Setting the environment variable FFREPORT to any value has the +same effect. If the value is a ’:’-separated key=value sequence, these +options will affect the report; option values must be escaped if they +contain special characters or the options delimiter ’:’ (see the +“Quoting and escaping” section in the ffmpeg-utils manual). +

+

The following options are recognized: +

+
file
+

set the file name to use for the report; %p is expanded to the name +of the program, %t is expanded to a timestamp, %% is expanded +to a plain % +

+
level
+

set the log verbosity level using a numerical value (see -loglevel). +

+
+ +

For example, to output a report to a file named ffreport.log +using a log level of 32 (alias for log level info): +

+
+
FFREPORT=file=ffreport.log:level=32 ffmpeg -i input output
+
+ +

Errors in parsing the environment variable are not fatal, and will not +appear in the report. +

+
+
-hide_banner
+

Suppress printing banner. +

+

All FFmpeg tools will normally show a copyright notice, build options +and library versions. This option can be used to suppress printing +this information. +

+
+
-cpuflags flags (global)
+

Allows setting and clearing cpu flags. This option is intended +for testing. Do not use it unless you know what you’re doing. +

+
ffmpeg -cpuflags -sse+mmx ...
+ffmpeg -cpuflags mmx ...
+ffmpeg -cpuflags 0 ...
+
+

Possible flags for this option are: +

+
‘x86’
+
+
‘mmx’
+
‘mmxext’
+
‘sse’
+
‘sse2’
+
‘sse2slow’
+
‘sse3’
+
‘sse3slow’
+
‘ssse3’
+
‘atom’
+
‘sse4.1’
+
‘sse4.2’
+
‘avx’
+
‘avx2’
+
‘xop’
+
‘fma3’
+
‘fma4’
+
‘3dnow’
+
‘3dnowext’
+
‘bmi1’
+
‘bmi2’
+
‘cmov’
+
+
+
‘ARM’
+
+
‘armv5te’
+
‘armv6’
+
‘armv6t2’
+
‘vfp’
+
‘vfpv3’
+
‘neon’
+
‘setend’
+
+
+
‘AArch64’
+
+
‘armv8’
+
‘vfp’
+
‘neon’
+
+
+
‘PowerPC’
+
+
‘altivec’
+
+
+
‘Specific Processors’
+
+
‘pentium2’
+
‘pentium3’
+
‘pentium4’
+
‘k6’
+
‘k62’
+
‘athlon’
+
‘athlonxp’
+
‘k8’
+
+
+
+
+
+ + +

3.3 AVOptions

+ +

These options are provided directly by the libavformat, libavdevice and +libavcodec libraries. To see the list of available AVOptions, use the +-help option. They are separated into two categories: +

+
generic
+

These options can be set for any container, codec or device. Generic options +are listed under AVFormatContext options for containers/devices and under +AVCodecContext options for codecs. +

+
private
+

These options are specific to the given container, device or codec. Private +options are listed under their corresponding containers/devices/codecs. +

+
+ +

For example to write an ID3v2.3 header instead of a default ID3v2.4 to +an MP3 file, use the id3v2_version private option of the MP3 +muxer: +

+
ffmpeg -i input.flac -id3v2_version 3 out.mp3
+
+ +

All codec AVOptions are per-stream, and thus a stream specifier +should be attached to them: +

+
ffmpeg -i multichannel.mxf -map 0:v:0 -map 0:a:0 -map 0:a:0 -c:a:0 ac3 -b:a:0 640k -ac:a:1 2 -c:a:1 aac -b:2 128k out.mp4
+
+ +

In the above example, a multichannel audio stream is mapped twice for output. +The first instance is encoded with codec ac3 and bitrate 640k. +The second instance is downmixed to 2 channels and encoded with codec aac. A bitrate of 128k is specified for it using +absolute index of the output stream. +

+

Note: the -nooption syntax cannot be used for boolean +AVOptions, use -option 0/-option 1. +

+

Note: the old undocumented way of specifying per-stream AVOptions by +prepending v/a/s to the options name is now obsolete and will be +removed soon. +

+ +

3.4 Main options

+ +
+
-x width
+

Force displayed width. +

+
-y height
+

Force displayed height. +

+
-s size
+

Set frame size (WxH or abbreviation), needed for videos which do +not contain a header with the frame size like raw YUV. This option +has been deprecated in favor of private options, try -video_size. +

+
-fs
+

Start in fullscreen mode. +

+
-an
+

Disable audio. +

+
-vn
+

Disable video. +

+
-sn
+

Disable subtitles. +

+
-ss pos
+

Seek to pos. Note that in most formats it is not possible to seek +exactly, so ffplay will seek to the nearest seek point to +pos. +

+

pos must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+
-t duration
+

Play duration seconds of audio/video. +

+

duration must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+
-bytes
+

Seek by bytes. +

+
-seek_interval
+

Set custom interval, in seconds, for seeking using left/right keys. Default is 10 seconds. +

+
-nodisp
+

Disable graphical display. +

+
-noborder
+

Borderless window. +

+
-alwaysontop
+

Window always on top. Available on: X11 with SDL >= 2.0.5, Windows SDL >= 2.0.6. +

+
-volume
+

Set the startup volume. 0 means silence, 100 means no volume reduction or +amplification. Negative values are treated as 0, values above 100 are treated +as 100. +

+
-f fmt
+

Force format. +

+
-window_title title
+

Set window title (default is the input filename). +

+
-left title
+

Set the x position for the left of the window (default is a centered window). +

+
-top title
+

Set the y position for the top of the window (default is a centered window). +

+
-loop number
+

Loops movie playback <number> times. 0 means forever. +

+
-showmode mode
+

Set the show mode to use. +Available values for mode are: +

+
‘0, video’
+

show video +

+
‘1, waves’
+

show audio waves +

+
‘2, rdft’
+

show audio frequency band using RDFT ((Inverse) Real Discrete Fourier Transform) +

+
+ +

Default value is "video", if video is not present or cannot be played +"rdft" is automatically selected. +

+

You can interactively cycle through the available show modes by +pressing the key w. +

+
+
-vf filtergraph
+

Create the filtergraph specified by filtergraph and use it to +filter the video stream. +

+

filtergraph is a description of the filtergraph to apply to +the stream, and must have a single video input and a single video +output. In the filtergraph, the input is associated to the label +in, and the output to the label out. See the +ffmpeg-filters manual for more information about the filtergraph +syntax. +

+

You can specify this parameter multiple times and cycle through the specified +filtergraphs along with the show modes by pressing the key w. +

+
+
-af filtergraph
+

filtergraph is a description of the filtergraph to apply to +the input audio. +Use the option "-filters" to show all the available filters (including +sources and sinks). +

+
+
-i input_url
+

Read input_url. +

+
+ + +

3.5 Advanced options

+
+
-pix_fmt format
+

Set pixel format. +This option has been deprecated in favor of private options, try -pixel_format. +

+
+
-stats
+

Print several playback statistics, in particular show the stream +duration, the codec parameters, the current position in the stream and +the audio/video synchronisation drift. It is shown by default, unless the +log level is lower than info. Its display can be forced by manually +specifying this option. To disable it, you need to specify -nostats. +

+
+
-fast
+

Non-spec-compliant optimizations. +

+
-genpts
+

Generate pts. +

+
-sync type
+

Set the master clock to audio (type=audio), video +(type=video) or external (type=ext). Default is audio. The +master clock is used to control audio-video synchronization. Most media +players use audio as master clock, but in some cases (streaming or high +quality broadcast) it is necessary to change that. This option is mainly +used for debugging purposes. +

+
-ast audio_stream_specifier
+

Select the desired audio stream using the given stream specifier. The stream +specifiers are described in the Stream specifiers chapter. If this option +is not specified, the "best" audio stream is selected in the program of the +already selected video stream. +

+
-vst video_stream_specifier
+

Select the desired video stream using the given stream specifier. The stream +specifiers are described in the Stream specifiers chapter. If this option +is not specified, the "best" video stream is selected. +

+
-sst subtitle_stream_specifier
+

Select the desired subtitle stream using the given stream specifier. The stream +specifiers are described in the Stream specifiers chapter. If this option +is not specified, the "best" subtitle stream is selected in the program of the +already selected video or audio stream. +

+
-autoexit
+

Exit when video is done playing. +

+
-exitonkeydown
+

Exit if any key is pressed. +

+
-exitonmousedown
+

Exit if any mouse button is pressed. +

+
+
-codec:media_specifier codec_name
+

Force a specific decoder implementation for the stream identified by +media_specifier, which can assume the values a (audio), +v (video), and s subtitle. +

+
+
-acodec codec_name
+

Force a specific audio decoder. +

+
+
-vcodec codec_name
+

Force a specific video decoder. +

+
+
-scodec codec_name
+

Force a specific subtitle decoder. +

+
+
-autorotate
+

Automatically rotate the video according to file metadata. Enabled by +default, use -noautorotate to disable it. +

+
+
-framedrop
+

Drop video frames if video is out of sync. Enabled by default if the master +clock is not set to video. Use this option to enable frame dropping for all +master clock sources, use -noframedrop to disable it. +

+
+
-infbuf
+

Do not limit the input buffer size, read as much data as possible from the +input as soon as possible. Enabled by default for realtime streams, where data +may be dropped if not read in time. Use this option to enable infinite buffers +for all inputs, use -noinfbuf to disable it. +

+
+
-filter_threads nb_threads
+

Defines how many threads are used to process a filter pipeline. Each pipeline +will produce a thread pool with this many threads available for parallel +processing. The default is 0 which means that the thread count will be +determined by the number of available CPUs. +

+
+
+ + +

3.6 While playing

+ +
+
q, ESC
+

Quit. +

+
+
f
+

Toggle full screen. +

+
+
p, SPC
+

Pause. +

+
+
m
+

Toggle mute. +

+
+
9, 0
+

Decrease and increase volume respectively. +

+
+
/, *
+

Decrease and increase volume respectively. +

+
+
a
+

Cycle audio channel in the current program. +

+
+
v
+

Cycle video channel. +

+
+
t
+

Cycle subtitle channel in the current program. +

+
+
c
+

Cycle program. +

+
+
w
+

Cycle video filters or show modes. +

+
+
s
+

Step to the next frame. +

+

Pause if the stream is not already paused, step to the next video +frame, and pause. +

+
+
left/right
+

Seek backward/forward 10 seconds. +

+
+
down/up
+

Seek backward/forward 1 minute. +

+
+
page down/page up
+

Seek to the previous/next chapter. +or if there are no chapters +Seek backward/forward 10 minutes. +

+
+
right mouse click
+

Seek to percentage in file corresponding to fraction of width. +

+
+
left mouse double-click
+

Toggle full screen. +

+
+
+ + + +

4 Syntax

+ +

This section documents the syntax and formats employed by the FFmpeg +libraries and tools. +

+ +

4.1 Quoting and escaping

+ +

FFmpeg adopts the following quoting and escaping mechanism, unless +explicitly specified. The following rules are applied: +

+
    +
  • ‘'’ and ‘\’ are special characters (respectively used for +quoting and escaping). In addition to them, there might be other +special characters depending on the specific syntax where the escaping +and quoting are employed. + +
  • A special character is escaped by prefixing it with a ‘\’. + +
  • All characters enclosed between ‘''’ are included literally in the +parsed string. The quote character ‘'’ itself cannot be quoted, +so you may need to close the quote and escape it. + +
  • Leading and trailing whitespaces, unless escaped or quoted, are +removed from the parsed string. +
+ +

Note that you may need to add a second level of escaping when using +the command line or a script, which depends on the syntax of the +adopted shell language. +

+

The function av_get_token defined in +libavutil/avstring.h can be used to parse a token quoted or +escaped according to the rules defined above. +

+

The tool tools/ffescape in the FFmpeg source tree can be used +to automatically quote or escape a string in a script. +

+ +

4.1.1 Examples

+ +
    +
  • Escape the string Crime d'Amour containing the ' special +character: +
    +
    Crime d\'Amour
+
    + +
  • The string above contains a quote, so the ' needs to be escaped +when quoting it: +
    +
    'Crime d'\''Amour'
+
    + +
  • Include leading or trailing whitespaces using quoting: +
    +
    '  this string starts and ends with whitespaces  '
+
    + +
  • Escaping and quoting can be mixed together: +
    +
    ' The string '\'string\'' is a string '
+
    + +
  • To include a literal ‘\’ you can use either escaping or quoting: +
    +
    'c:\foo' can be written as c:\\foo
+
    +
+ + +

4.2 Date

+ +

The accepted syntax is: +

+
[(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH:MM:SS[.m...]]])|(HHMMSS[.m...]]]))[Z]
+now
+
+ +

If the value is "now" it takes the current time. +

+

Time is local time unless Z is appended, in which case it is +interpreted as UTC. +If the year-month-day part is not specified it takes the current +year-month-day. +

+ +

4.3 Time duration

+ +

There are two accepted syntaxes for expressing time duration. +

+
+
[-][HH:]MM:SS[.m...]
+
+ +

HH expresses the number of hours, MM the number of minutes +for a maximum of 2 digits, and SS the number of seconds for a +maximum of 2 digits. The m at the end expresses decimal value for +SS. +

+

or +

+
+
[-]S+[.m...]
+
+ +

S expresses the number of seconds, with the optional decimal part +m. +

+

In both expressions, the optional ‘-’ indicates negative duration. +

+ +

4.3.1 Examples

+ +

The following examples are all valid time duration: +

+
+
‘55’
+

55 seconds +

+
+
‘0.2’
+

0.2 seconds +

+
+
‘200ms’
+

200 milliseconds, that’s 0.2s +

+
+
‘200000us’
+

200000 microseconds, that’s 0.2s +

+
+
‘12:03:45’
+

12 hours, 03 minutes and 45 seconds +

+
+
‘23.189’
+

23.189 seconds +

+
+ + +

4.4 Video size

+

Specify the size of the sourced video, it may be a string of the form +widthxheight, or the name of a size abbreviation. +

+

The following abbreviations are recognized: +

+
‘ntsc’
+

720x480 +

+
‘pal’
+

720x576 +

+
‘qntsc’
+

352x240 +

+
‘qpal’
+

352x288 +

+
‘sntsc’
+

640x480 +

+
‘spal’
+

768x576 +

+
‘film’
+

352x240 +

+
‘ntsc-film’
+

352x240 +

+
‘sqcif’
+

128x96 +

+
‘qcif’
+

176x144 +

+
‘cif’
+

352x288 +

+
‘4cif’
+

704x576 +

+
‘16cif’
+

1408x1152 +

+
‘qqvga’
+

160x120 +

+
‘qvga’
+

320x240 +

+
‘vga’
+

640x480 +

+
‘svga’
+

800x600 +

+
‘xga’
+

1024x768 +

+
‘uxga’
+

1600x1200 +

+
‘qxga’
+

2048x1536 +

+
‘sxga’
+

1280x1024 +

+
‘qsxga’
+

2560x2048 +

+
‘hsxga’
+

5120x4096 +

+
‘wvga’
+

852x480 +

+
‘wxga’
+

1366x768 +

+
‘wsxga’
+

1600x1024 +

+
‘wuxga’
+

1920x1200 +

+
‘woxga’
+

2560x1600 +

+
‘wqsxga’
+

3200x2048 +

+
‘wquxga’
+

3840x2400 +

+
‘whsxga’
+

6400x4096 +

+
‘whuxga’
+

7680x4800 +

+
‘cga’
+

320x200 +

+
‘ega’
+

640x350 +

+
‘hd480’
+

852x480 +

+
‘hd720’
+

1280x720 +

+
‘hd1080’
+

1920x1080 +

+
‘2k’
+

2048x1080 +

+
‘2kflat’
+

1998x1080 +

+
‘2kscope’
+

2048x858 +

+
‘4k’
+

4096x2160 +

+
‘4kflat’
+

3996x2160 +

+
‘4kscope’
+

4096x1716 +

+
‘nhd’
+

640x360 +

+
‘hqvga’
+

240x160 +

+
‘wqvga’
+

400x240 +

+
‘fwqvga’
+

432x240 +

+
‘hvga’
+

480x320 +

+
‘qhd’
+

960x540 +

+
‘2kdci’
+

2048x1080 +

+
‘4kdci’
+

4096x2160 +

+
‘uhd2160’
+

3840x2160 +

+
‘uhd4320’
+

7680x4320 +

+
+ + +

4.5 Video rate

+ +

Specify the frame rate of a video, expressed as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a float +number or a valid video frame rate abbreviation. +

+

The following abbreviations are recognized: +

+
‘ntsc’
+

30000/1001 +

+
‘pal’
+

25/1 +

+
‘qntsc’
+

30000/1001 +

+
‘qpal’
+

25/1 +

+
‘sntsc’
+

30000/1001 +

+
‘spal’
+

25/1 +

+
‘film’
+

24/1 +

+
‘ntsc-film’
+

24000/1001 +

+
+ + +

4.6 Ratio

+ +

A ratio can be expressed as an expression, or in the form +numerator:denominator. +

+

Note that a ratio with infinite (1/0) or negative value is +considered valid, so you should check on the returned value if you +want to exclude those values. +

+

The undefined value can be expressed using the "0:0" string. +

+ +

4.7 Color

+ +

It can be the name of a color as defined below (case insensitive match) or a +[0x|#]RRGGBB[AA] sequence, possibly followed by @ and a string +representing the alpha component. +

+

The alpha component may be a string composed by "0x" followed by an +hexadecimal number or a decimal number between 0.0 and 1.0, which +represents the opacity value (‘0x00’ or ‘0.0’ means completely +transparent, ‘0xff’ or ‘1.0’ completely opaque). If the alpha +component is not specified then ‘0xff’ is assumed. +

+

The string ‘random’ will result in a random color. +

+

The following names of colors are recognized: +

+
‘AliceBlue’
+

0xF0F8FF +

+
‘AntiqueWhite’
+

0xFAEBD7 +

+
‘Aqua’
+

0x00FFFF +

+
‘Aquamarine’
+

0x7FFFD4 +

+
‘Azure’
+

0xF0FFFF +

+
‘Beige’
+

0xF5F5DC +

+
‘Bisque’
+

0xFFE4C4 +

+
‘Black’
+

0x000000 +

+
‘BlanchedAlmond’
+

0xFFEBCD +

+
‘Blue’
+

0x0000FF +

+
‘BlueViolet’
+

0x8A2BE2 +

+
‘Brown’
+

0xA52A2A +

+
‘BurlyWood’
+

0xDEB887 +

+
‘CadetBlue’
+

0x5F9EA0 +

+
‘Chartreuse’
+

0x7FFF00 +

+
‘Chocolate’
+

0xD2691E +

+
‘Coral’
+

0xFF7F50 +

+
‘CornflowerBlue’
+

0x6495ED +

+
‘Cornsilk’
+

0xFFF8DC +

+
‘Crimson’
+

0xDC143C +

+
‘Cyan’
+

0x00FFFF +

+
‘DarkBlue’
+

0x00008B +

+
‘DarkCyan’
+

0x008B8B +

+
‘DarkGoldenRod’
+

0xB8860B +

+
‘DarkGray’
+

0xA9A9A9 +

+
‘DarkGreen’
+

0x006400 +

+
‘DarkKhaki’
+

0xBDB76B +

+
‘DarkMagenta’
+

0x8B008B +

+
‘DarkOliveGreen’
+

0x556B2F +

+
‘Darkorange’
+

0xFF8C00 +

+
‘DarkOrchid’
+

0x9932CC +

+
‘DarkRed’
+

0x8B0000 +

+
‘DarkSalmon’
+

0xE9967A +

+
‘DarkSeaGreen’
+

0x8FBC8F +

+
‘DarkSlateBlue’
+

0x483D8B +

+
‘DarkSlateGray’
+

0x2F4F4F +

+
‘DarkTurquoise’
+

0x00CED1 +

+
‘DarkViolet’
+

0x9400D3 +

+
‘DeepPink’
+

0xFF1493 +

+
‘DeepSkyBlue’
+

0x00BFFF +

+
‘DimGray’
+

0x696969 +

+
‘DodgerBlue’
+

0x1E90FF +

+
‘FireBrick’
+

0xB22222 +

+
‘FloralWhite’
+

0xFFFAF0 +

+
‘ForestGreen’
+

0x228B22 +

+
‘Fuchsia’
+

0xFF00FF +

+
‘Gainsboro’
+

0xDCDCDC +

+
‘GhostWhite’
+

0xF8F8FF +

+
‘Gold’
+

0xFFD700 +

+
‘GoldenRod’
+

0xDAA520 +

+
‘Gray’
+

0x808080 +

+
‘Green’
+

0x008000 +

+
‘GreenYellow’
+

0xADFF2F +

+
‘HoneyDew’
+

0xF0FFF0 +

+
‘HotPink’
+

0xFF69B4 +

+
‘IndianRed’
+

0xCD5C5C +

+
‘Indigo’
+

0x4B0082 +

+
‘Ivory’
+

0xFFFFF0 +

+
‘Khaki’
+

0xF0E68C +

+
‘Lavender’
+

0xE6E6FA +

+
‘LavenderBlush’
+

0xFFF0F5 +

+
‘LawnGreen’
+

0x7CFC00 +

+
‘LemonChiffon’
+

0xFFFACD +

+
‘LightBlue’
+

0xADD8E6 +

+
‘LightCoral’
+

0xF08080 +

+
‘LightCyan’
+

0xE0FFFF +

+
‘LightGoldenRodYellow’
+

0xFAFAD2 +

+
‘LightGreen’
+

0x90EE90 +

+
‘LightGrey’
+

0xD3D3D3 +

+
‘LightPink’
+

0xFFB6C1 +

+
‘LightSalmon’
+

0xFFA07A +

+
‘LightSeaGreen’
+

0x20B2AA +

+
‘LightSkyBlue’
+

0x87CEFA +

+
‘LightSlateGray’
+

0x778899 +

+
‘LightSteelBlue’
+

0xB0C4DE +

+
‘LightYellow’
+

0xFFFFE0 +

+
‘Lime’
+

0x00FF00 +

+
‘LimeGreen’
+

0x32CD32 +

+
‘Linen’
+

0xFAF0E6 +

+
‘Magenta’
+

0xFF00FF +

+
‘Maroon’
+

0x800000 +

+
‘MediumAquaMarine’
+

0x66CDAA +

+
‘MediumBlue’
+

0x0000CD +

+
‘MediumOrchid’
+

0xBA55D3 +

+
‘MediumPurple’
+

0x9370D8 +

+
‘MediumSeaGreen’
+

0x3CB371 +

+
‘MediumSlateBlue’
+

0x7B68EE +

+
‘MediumSpringGreen’
+

0x00FA9A +

+
‘MediumTurquoise’
+

0x48D1CC +

+
‘MediumVioletRed’
+

0xC71585 +

+
‘MidnightBlue’
+

0x191970 +

+
‘MintCream’
+

0xF5FFFA +

+
‘MistyRose’
+

0xFFE4E1 +

+
‘Moccasin’
+

0xFFE4B5 +

+
‘NavajoWhite’
+

0xFFDEAD +

+
‘Navy’
+

0x000080 +

+
‘OldLace’
+

0xFDF5E6 +

+
‘Olive’
+

0x808000 +

+
‘OliveDrab’
+

0x6B8E23 +

+
‘Orange’
+

0xFFA500 +

+
‘OrangeRed’
+

0xFF4500 +

+
‘Orchid’
+

0xDA70D6 +

+
‘PaleGoldenRod’
+

0xEEE8AA +

+
‘PaleGreen’
+

0x98FB98 +

+
‘PaleTurquoise’
+

0xAFEEEE +

+
‘PaleVioletRed’
+

0xD87093 +

+
‘PapayaWhip’
+

0xFFEFD5 +

+
‘PeachPuff’
+

0xFFDAB9 +

+
‘Peru’
+

0xCD853F +

+
‘Pink’
+

0xFFC0CB +

+
‘Plum’
+

0xDDA0DD +

+
‘PowderBlue’
+

0xB0E0E6 +

+
‘Purple’
+

0x800080 +

+
‘Red’
+

0xFF0000 +

+
‘RosyBrown’
+

0xBC8F8F +

+
‘RoyalBlue’
+

0x4169E1 +

+
‘SaddleBrown’
+

0x8B4513 +

+
‘Salmon’
+

0xFA8072 +

+
‘SandyBrown’
+

0xF4A460 +

+
‘SeaGreen’
+

0x2E8B57 +

+
‘SeaShell’
+

0xFFF5EE +

+
‘Sienna’
+

0xA0522D +

+
‘Silver’
+

0xC0C0C0 +

+
‘SkyBlue’
+

0x87CEEB +

+
‘SlateBlue’
+

0x6A5ACD +

+
‘SlateGray’
+

0x708090 +

+
‘Snow’
+

0xFFFAFA +

+
‘SpringGreen’
+

0x00FF7F +

+
‘SteelBlue’
+

0x4682B4 +

+
‘Tan’
+

0xD2B48C +

+
‘Teal’
+

0x008080 +

+
‘Thistle’
+

0xD8BFD8 +

+
‘Tomato’
+

0xFF6347 +

+
‘Turquoise’
+

0x40E0D0 +

+
‘Violet’
+

0xEE82EE +

+
‘Wheat’
+

0xF5DEB3 +

+
‘White’
+

0xFFFFFF +

+
‘WhiteSmoke’
+

0xF5F5F5 +

+
‘Yellow’
+

0xFFFF00 +

+
‘YellowGreen’
+

0x9ACD32 +

+
+ + +

4.8 Channel Layout

+ +

A channel layout specifies the spatial disposition of the channels in +a multi-channel audio stream. To specify a channel layout, FFmpeg +makes use of a special syntax. +

+

Individual channels are identified by an id, as given by the table +below: +

+
‘FL’
+

front left +

+
‘FR’
+

front right +

+
‘FC’
+

front center +

+
‘LFE’
+

low frequency +

+
‘BL’
+

back left +

+
‘BR’
+

back right +

+
‘FLC’
+

front left-of-center +

+
‘FRC’
+

front right-of-center +

+
‘BC’
+

back center +

+
‘SL’
+

side left +

+
‘SR’
+

side right +

+
‘TC’
+

top center +

+
‘TFL’
+

top front left +

+
‘TFC’
+

top front center +

+
‘TFR’
+

top front right +

+
‘TBL’
+

top back left +

+
‘TBC’
+

top back center +

+
‘TBR’
+

top back right +

+
‘DL’
+

downmix left +

+
‘DR’
+

downmix right +

+
‘WL’
+

wide left +

+
‘WR’
+

wide right +

+
‘SDL’
+

surround direct left +

+
‘SDR’
+

surround direct right +

+
‘LFE2’
+

low frequency 2 +

+
+ +

Standard channel layout compositions can be specified by using the +following identifiers: +

+
‘mono’
+

FC +

+
‘stereo’
+

FL+FR +

+
‘2.1’
+

FL+FR+LFE +

+
‘3.0’
+

FL+FR+FC +

+
‘3.0(back)’
+

FL+FR+BC +

+
‘4.0’
+

FL+FR+FC+BC +

+
‘quad’
+

FL+FR+BL+BR +

+
‘quad(side)’
+

FL+FR+SL+SR +

+
‘3.1’
+

FL+FR+FC+LFE +

+
‘5.0’
+

FL+FR+FC+BL+BR +

+
‘5.0(side)’
+

FL+FR+FC+SL+SR +

+
‘4.1’
+

FL+FR+FC+LFE+BC +

+
‘5.1’
+

FL+FR+FC+LFE+BL+BR +

+
‘5.1(side)’
+

FL+FR+FC+LFE+SL+SR +

+
‘6.0’
+

FL+FR+FC+BC+SL+SR +

+
‘6.0(front)’
+

FL+FR+FLC+FRC+SL+SR +

+
‘hexagonal’
+

FL+FR+FC+BL+BR+BC +

+
‘6.1’
+

FL+FR+FC+LFE+BC+SL+SR +

+
‘6.1’
+

FL+FR+FC+LFE+BL+BR+BC +

+
‘6.1(front)’
+

FL+FR+LFE+FLC+FRC+SL+SR +

+
‘7.0’
+

FL+FR+FC+BL+BR+SL+SR +

+
‘7.0(front)’
+

FL+FR+FC+FLC+FRC+SL+SR +

+
‘7.1’
+

FL+FR+FC+LFE+BL+BR+SL+SR +

+
‘7.1(wide)’
+

FL+FR+FC+LFE+BL+BR+FLC+FRC +

+
‘7.1(wide-side)’
+

FL+FR+FC+LFE+FLC+FRC+SL+SR +

+
‘octagonal’
+

FL+FR+FC+BL+BR+BC+SL+SR +

+
‘hexadecagonal’
+

FL+FR+FC+BL+BR+BC+SL+SR+WL+WR+TBL+TBR+TBC+TFC+TFL+TFR +

+
‘downmix’
+

DL+DR +

+
+ +

A custom channel layout can be specified as a sequence of terms, separated by +’+’ or ’|’. Each term can be: +

    +
  • the name of a standard channel layout (e.g. ‘mono’, +‘stereo’, ‘4.0’, ‘quad’, ‘5.0’, etc.) + +
  • the name of a single channel (e.g. ‘FL’, ‘FR’, ‘FC’, ‘LFE’, etc.) + +
  • a number of channels, in decimal, followed by ’c’, yielding the default channel +layout for that number of channels (see the function +av_get_default_channel_layout). Note that not all channel counts have a +default layout. + +
  • a number of channels, in decimal, followed by ’C’, yielding an unknown channel +layout with the specified number of channels. Note that not all channel layout +specification strings support unknown channel layouts. + +
  • a channel layout mask, in hexadecimal starting with "0x" (see the +AV_CH_* macros in libavutil/channel_layout.h. +
+ +

Before libavutil version 53 the trailing character "c" to specify a number of +channels was optional, but now it is required, while a channel layout mask can +also be specified as a decimal number (if and only if not followed by "c" or "C"). +

+

See also the function av_get_channel_layout defined in +libavutil/channel_layout.h. +

+ +

5 Expression Evaluation

+ +

When evaluating an arithmetic expression, FFmpeg uses an internal +formula evaluator, implemented through the libavutil/eval.h +interface. +

+

An expression may contain unary, binary operators, constants, and +functions. +

+

Two expressions expr1 and expr2 can be combined to form +another expression "expr1;expr2". +expr1 and expr2 are evaluated in turn, and the new +expression evaluates to the value of expr2. +

+

The following binary operators are available: +, -, +*, /, ^. +

+

The following unary operators are available: +, -. +

+

The following functions are available: +

+
abs(x)
+

Compute absolute value of x. +

+
+
acos(x)
+

Compute arccosine of x. +

+
+
asin(x)
+

Compute arcsine of x. +

+
+
atan(x)
+

Compute arctangent of x. +

+
+
atan2(x, y)
+

Compute principal value of the arc tangent of y/x. +

+
+
between(x, min, max)
+

Return 1 if x is greater than or equal to min and lesser than or +equal to max, 0 otherwise. +

+
+
bitand(x, y)
+
bitor(x, y)
+

Compute bitwise and/or operation on x and y. +

+

The results of the evaluation of x and y are converted to +integers before executing the bitwise operation. +

+

Note that both the conversion to integer and the conversion back to +floating point can lose precision. Beware of unexpected results for +large numbers (usually 2^53 and larger). +

+
+
ceil(expr)
+

Round the value of expression expr upwards to the nearest +integer. For example, "ceil(1.5)" is "2.0". +

+
+
clip(x, min, max)
+

Return the value of x clipped between min and max. +

+
+
cos(x)
+

Compute cosine of x. +

+
+
cosh(x)
+

Compute hyperbolic cosine of x. +

+
+
eq(x, y)
+

Return 1 if x and y are equivalent, 0 otherwise. +

+
+
exp(x)
+

Compute exponential of x (with base e, the Euler’s number). +

+
+
floor(expr)
+

Round the value of expression expr downwards to the nearest +integer. For example, "floor(-1.5)" is "-2.0". +

+
+
gauss(x)
+

Compute Gauss function of x, corresponding to +exp(-x*x/2) / sqrt(2*PI). +

+
+
gcd(x, y)
+

Return the greatest common divisor of x and y. If both x and +y are 0 or either or both are less than zero then behavior is undefined. +

+
+
gt(x, y)
+

Return 1 if x is greater than y, 0 otherwise. +

+
+
gte(x, y)
+

Return 1 if x is greater than or equal to y, 0 otherwise. +

+
+
hypot(x, y)
+

This function is similar to the C function with the same name; it returns +"sqrt(x*x + y*y)", the length of the hypotenuse of a +right triangle with sides of length x and y, or the distance of the +point (x, y) from the origin. +

+
+
if(x, y)
+

Evaluate x, and if the result is non-zero return the result of +the evaluation of y, return 0 otherwise. +

+
+
if(x, y, z)
+

Evaluate x, and if the result is non-zero return the evaluation +result of y, otherwise the evaluation result of z. +

+
+
ifnot(x, y)
+

Evaluate x, and if the result is zero return the result of the +evaluation of y, return 0 otherwise. +

+
+
ifnot(x, y, z)
+

Evaluate x, and if the result is zero return the evaluation +result of y, otherwise the evaluation result of z. +

+
+
isinf(x)
+

Return 1.0 if x is +/-INFINITY, 0.0 otherwise. +

+
+
isnan(x)
+

Return 1.0 if x is NAN, 0.0 otherwise. +

+
+
ld(var)
+

Load the value of the internal variable with number +var, which was previously stored with st(var, expr). +The function returns the loaded value. +

+
+
lerp(x, y, z)
+

Return linear interpolation between x and y by amount of z. +

+
+
log(x)
+

Compute natural logarithm of x. +

+
+
lt(x, y)
+

Return 1 if x is lesser than y, 0 otherwise. +

+
+
lte(x, y)
+

Return 1 if x is lesser than or equal to y, 0 otherwise. +

+
+
max(x, y)
+

Return the maximum between x and y. +

+
+
min(x, y)
+

Return the minimum between x and y. +

+
+
mod(x, y)
+

Compute the remainder of division of x by y. +

+
+
not(expr)
+

Return 1.0 if expr is zero, 0.0 otherwise. +

+
+
pow(x, y)
+

Compute the power of x elevated y, it is equivalent to +"(x)^(y)". +

+
+
print(t)
+
print(t, l)
+

Print the value of expression t with loglevel l. If +l is not specified then a default log level is used. +Returns the value of the expression printed. +

+

Prints t with loglevel l +

+
+
random(x)
+

Return a pseudo random value between 0.0 and 1.0. x is the index of the +internal variable which will be used to save the seed/state. +

+
+
root(expr, max)
+

Find an input value for which the function represented by expr +with argument ld(0) is 0 in the interval 0..max. +

+

The expression in expr must denote a continuous function or the +result is undefined. +

+

ld(0) is used to represent the function input value, which means +that the given expression will be evaluated multiple times with +various input values that the expression can access through +ld(0). When the expression evaluates to 0 then the +corresponding input value will be returned. +

+
+
round(expr)
+

Round the value of expression expr to the nearest integer. For example, "round(1.5)" is "2.0". +

+
+
sgn(x)
+

Compute sign of x. +

+
+
sin(x)
+

Compute sine of x. +

+
+
sinh(x)
+

Compute hyperbolic sine of x. +

+
+
sqrt(expr)
+

Compute the square root of expr. This is equivalent to +"(expr)^.5". +

+
+
squish(x)
+

Compute expression 1/(1 + exp(4*x)). +

+
+
st(var, expr)
+

Store the value of the expression expr in an internal +variable. var specifies the number of the variable where to +store the value, and it is a value ranging from 0 to 9. The function +returns the value stored in the internal variable. +Note, Variables are currently not shared between expressions. +

+
+
tan(x)
+

Compute tangent of x. +

+
+
tanh(x)
+

Compute hyperbolic tangent of x. +

+
+
taylor(expr, x)
+
taylor(expr, x, id)
+

Evaluate a Taylor series at x, given an expression representing +the ld(id)-th derivative of a function at 0. +

+

When the series does not converge the result is undefined. +

+

ld(id) is used to represent the derivative order in expr, +which means that the given expression will be evaluated multiple times +with various input values that the expression can access through +ld(id). If id is not specified then 0 is assumed. +

+

Note, when you have the derivatives at y instead of 0, +taylor(expr, x-y) can be used. +

+
+
time(0)
+

Return the current (wallclock) time in seconds. +

+
+
trunc(expr)
+

Round the value of expression expr towards zero to the nearest +integer. For example, "trunc(-1.5)" is "-1.0". +

+
+
while(cond, expr)
+

Evaluate expression expr while the expression cond is +non-zero, and returns the value of the last expr evaluation, or +NAN if cond was always false. +

+
+ +

The following constants are available: +

+
PI
+

area of the unit disc, approximately 3.14 +

+
E
+

exp(1) (Euler’s number), approximately 2.718 +

+
PHI
+

golden ratio (1+sqrt(5))/2, approximately 1.618 +

+
+ +

Assuming that an expression is considered "true" if it has a non-zero +value, note that: +

+

* works like AND +

+

+ works like OR +

+

For example the construct: +

+
if (A AND B) then C
+
+

is equivalent to: +

+
if(A*B, C)
+
+ +

In your C code, you can extend the list of unary and binary functions, +and define recognized constants, so that they are available for your +expressions. +

+

The evaluator also recognizes the International System unit prefixes. +If ’i’ is appended after the prefix, binary prefixes are used, which +are based on powers of 1024 instead of powers of 1000. +The ’B’ postfix multiplies the value by 8, and can be appended after a +unit prefix or used alone. This allows using for example ’KB’, ’MiB’, +’G’ and ’B’ as number postfix. +

+

The list of available International System prefixes follows, with +indication of the corresponding powers of 10 and of 2. +

+
y
+

10^-24 / 2^-80 +

+
z
+

10^-21 / 2^-70 +

+
a
+

10^-18 / 2^-60 +

+
f
+

10^-15 / 2^-50 +

+
p
+

10^-12 / 2^-40 +

+
n
+

10^-9 / 2^-30 +

+
u
+

10^-6 / 2^-20 +

+
m
+

10^-3 / 2^-10 +

+
c
+

10^-2 +

+
d
+

10^-1 +

+
h
+

10^2 +

+
k
+

10^3 / 2^10 +

+
K
+

10^3 / 2^10 +

+
M
+

10^6 / 2^20 +

+
G
+

10^9 / 2^30 +

+
T
+

10^12 / 2^40 +

+
P
+

10^15 / 2^40 +

+
E
+

10^18 / 2^50 +

+
Z
+

10^21 / 2^60 +

+
Y
+

10^24 / 2^70 +

+
+ + +

6 Codec Options

+ +

libavcodec provides some generic global options, which can be set on +all the encoders and decoders. In addition each codec may support +so-called private options, which are specific for a given codec. +

+

Sometimes, a global option may only affect a specific kind of codec, +and may be nonsensical or ignored by another, so you need to be aware +of the meaning of the specified options. Also some options are +meant only for decoding or encoding. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the +AVCodecContext options or using the libavutil/opt.h API +for programmatic use. +

+

The list of supported options follow: +

+
+
b integer (encoding,audio,video)
+

Set bitrate in bits/s. Default value is 200K. +

+
+
ab integer (encoding,audio)
+

Set audio bitrate (in bits/s). Default value is 128K. +

+
+
bt integer (encoding,video)
+

Set video bitrate tolerance (in bits/s). In 1-pass mode, bitrate +tolerance specifies how far ratecontrol is willing to deviate from the +target average bitrate value. This is not related to min/max +bitrate. Lowering tolerance too much has an adverse effect on quality. +

+
+
flags flags (decoding/encoding,audio,video,subtitles)
+

Set generic flags. +

+

Possible values: +

+
‘mv4’
+

Use four motion vector by macroblock (mpeg4). +

+
‘qpel’
+

Use 1/4 pel motion compensation. +

+
‘loop’
+

Use loop filter. +

+
‘qscale’
+

Use fixed qscale. +

+
‘pass1’
+

Use internal 2pass ratecontrol in first pass mode. +

+
‘pass2’
+

Use internal 2pass ratecontrol in second pass mode. +

+
‘gray’
+

Only decode/encode grayscale. +

+
‘emu_edge’
+

Do not draw edges. +

+
‘psnr’
+

Set error[?] variables during encoding. +

+
‘truncated’
+

Input bitstream might be randomly truncated. +

+
‘drop_changed’
+

Don’t output frames whose parameters differ from first decoded frame in stream. +Error AVERROR_INPUT_CHANGED is returned when a frame is dropped. +

+
+
‘ildct’
+

Use interlaced DCT. +

+
‘low_delay’
+

Force low delay. +

+
‘global_header’
+

Place global headers in extradata instead of every keyframe. +

+
‘bitexact’
+

Only write platform-, build- and time-independent data. (except (I)DCT). +This ensures that file and data checksums are reproducible and match between +platforms. Its primary use is for regression testing. +

+
‘aic’
+

Apply H263 advanced intra coding / mpeg4 ac prediction. +

+
‘cbp’
+

Deprecated, use mpegvideo private options instead. +

+
‘qprd’
+

Deprecated, use mpegvideo private options instead. +

+
‘ilme’
+

Apply interlaced motion estimation. +

+
‘cgop’
+

Use closed gop. +

+
‘output_corrupt’
+

Output even potentially corrupted frames. +

+
+ +
+
me_method integer (encoding,video)
+

Set motion estimation method. +

+

Possible values: +

+
‘zero’
+

zero motion estimation (fastest) +

+
‘full’
+

full motion estimation (slowest) +

+
‘epzs’
+

EPZS motion estimation (default) +

+
‘esa’
+

esa motion estimation (alias for full) +

+
‘tesa’
+

tesa motion estimation +

+
‘dia’
+

dia motion estimation (alias for epzs) +

+
‘log’
+

log motion estimation +

+
‘phods’
+

phods motion estimation +

+
‘x1’
+

X1 motion estimation +

+
‘hex’
+

hex motion estimation +

+
‘umh’
+

umh motion estimation +

+
‘iter’
+

iter motion estimation +

+
+ +
+
extradata_size integer
+

Set extradata size. +

+
+
time_base rational number
+

Set codec time base. +

+

It is the fundamental unit of time (in seconds) in terms of which +frame timestamps are represented. For fixed-fps content, timebase +should be 1 / frame_rate and timestamp increments should be +identically 1. +

+
+
g integer (encoding,video)
+

Set the group of picture (GOP) size. Default value is 12. +

+
+
ar integer (decoding/encoding,audio)
+

Set audio sampling rate (in Hz). +

+
+
ac integer (decoding/encoding,audio)
+

Set number of audio channels. +

+
+
cutoff integer (encoding,audio)
+

Set cutoff bandwidth. (Supported only by selected encoders, see +their respective documentation sections.) +

+
+
frame_size integer (encoding,audio)
+

Set audio frame size. +

+

Each submitted frame except the last must contain exactly frame_size +samples per channel. May be 0 when the codec has +CODEC_CAP_VARIABLE_FRAME_SIZE set, in that case the frame size is not +restricted. It is set by some decoders to indicate constant frame +size. +

+
+
frame_number integer
+

Set the frame number. +

+
+
delay integer
+
qcomp float (encoding,video)
+

Set video quantizer scale compression (VBR). It is used as a constant +in the ratecontrol equation. Recommended range for default rc_eq: +0.0-1.0. +

+
+
qblur float (encoding,video)
+

Set video quantizer scale blur (VBR). +

+
+
qmin integer (encoding,video)
+

Set min video quantizer scale (VBR). Must be included between -1 and +69, default value is 2. +

+
+
qmax integer (encoding,video)
+

Set max video quantizer scale (VBR). Must be included between -1 and +1024, default value is 31. +

+
+
qdiff integer (encoding,video)
+

Set max difference between the quantizer scale (VBR). +

+
+
bf integer (encoding,video)
+

Set max number of B frames between non-B-frames. +

+

Must be an integer between -1 and 16. 0 means that B-frames are +disabled. If a value of -1 is used, it will choose an automatic value +depending on the encoder. +

+

Default value is 0. +

+
+
b_qfactor float (encoding,video)
+

Set qp factor between P and B frames. +

+
+
rc_strategy integer (encoding,video)
+

Set ratecontrol method. +

+
+
b_strategy integer (encoding,video)
+

Set strategy to choose between I/P/B-frames. +

+
+
ps integer (encoding,video)
+

Set RTP payload size in bytes. +

+
+
mv_bits integer
+
header_bits integer
+
i_tex_bits integer
+
p_tex_bits integer
+
i_count integer
+
p_count integer
+
skip_count integer
+
misc_bits integer
+
frame_bits integer
+
codec_tag integer
+
bug flags (decoding,video)
+

Workaround not auto detected encoder bugs. +

+

Possible values: +

+
‘autodetect’
+
‘old_msmpeg4’
+

some old lavc generated msmpeg4v3 files (no autodetection) +

+
‘xvid_ilace’
+

Xvid interlacing bug (autodetected if fourcc==XVIX) +

+
‘ump4’
+

(autodetected if fourcc==UMP4) +

+
‘no_padding’
+

padding bug (autodetected) +

+
‘amv’
+
‘ac_vlc’
+

illegal vlc bug (autodetected per fourcc) +

+
‘qpel_chroma’
+
‘std_qpel’
+

old standard qpel (autodetected per fourcc/version) +

+
‘qpel_chroma2’
+
‘direct_blocksize’
+

direct-qpel-blocksize bug (autodetected per fourcc/version) +

+
‘edge’
+

edge padding bug (autodetected per fourcc/version) +

+
‘hpel_chroma’
+
‘dc_clip’
+
‘ms’
+

Workaround various bugs in microsoft broken decoders. +

+
‘trunc’
+

trancated frames +

+
+ +
+
lelim integer (encoding,video)
+

Set single coefficient elimination threshold for luminance (negative +values also consider DC coefficient). +

+
+
celim integer (encoding,video)
+

Set single coefficient elimination threshold for chrominance (negative +values also consider dc coefficient) +

+
+
strict integer (decoding/encoding,audio,video)
+

Specify how strictly to follow the standards. +

+

Possible values: +

+
‘very’
+

strictly conform to an older more strict version of the spec or reference software +

+
‘strict’
+

strictly conform to all the things in the spec no matter what consequences +

+
‘normal’
+
‘unofficial’
+

allow unofficial extensions +

+
‘experimental’
+

allow non standardized experimental things, experimental +(unfinished/work in progress/not well tested) decoders and encoders. +Note: experimental decoders can pose a security risk, do not use this for +decoding untrusted input. +

+
+ +
+
b_qoffset float (encoding,video)
+

Set QP offset between P and B frames. +

+
+
err_detect flags (decoding,audio,video)
+

Set error detection flags. +

+

Possible values: +

+
‘crccheck’
+

verify embedded CRCs +

+
‘bitstream’
+

detect bitstream specification deviations +

+
‘buffer’
+

detect improper bitstream length +

+
‘explode’
+

abort decoding on minor error detection +

+
‘ignore_err’
+

ignore decoding errors, and continue decoding. +This is useful if you want to analyze the content of a video and thus want +everything to be decoded no matter what. This option will not result in a video +that is pleasing to watch in case of errors. +

+
‘careful’
+

consider things that violate the spec and have not been seen in the wild as errors +

+
‘compliant’
+

consider all spec non compliancies as errors +

+
‘aggressive’
+

consider things that a sane encoder should not do as an error +

+
+ +
+
has_b_frames integer
+
block_align integer
+
mpeg_quant integer (encoding,video)
+

Use MPEG quantizers instead of H.263. +

+
+
qsquish float (encoding,video)
+

How to keep quantizer between qmin and qmax (0 = clip, 1 = use +differentiable function). +

+
+
rc_qmod_amp float (encoding,video)
+

Set experimental quantizer modulation. +

+
+
rc_qmod_freq integer (encoding,video)
+

Set experimental quantizer modulation. +

+
+
rc_override_count integer
+
rc_eq string (encoding,video)
+

Set rate control equation. When computing the expression, besides the +standard functions defined in the section ’Expression Evaluation’, the +following functions are available: bits2qp(bits), qp2bits(qp). Also +the following constants are available: iTex pTex tex mv fCode iCount +mcVar var isI isP isB avgQP qComp avgIITex avgPITex avgPPTex avgBPTex +avgTex. +

+
+
maxrate integer (encoding,audio,video)
+

Set max bitrate tolerance (in bits/s). Requires bufsize to be set. +

+
+
minrate integer (encoding,audio,video)
+

Set min bitrate tolerance (in bits/s). Most useful in setting up a CBR +encode. It is of little use elsewise. +

+
+
bufsize integer (encoding,audio,video)
+

Set ratecontrol buffer size (in bits). +

+
+
rc_buf_aggressivity float (encoding,video)
+

Currently useless. +

+
+
i_qfactor float (encoding,video)
+

Set QP factor between P and I frames. +

+
+
i_qoffset float (encoding,video)
+

Set QP offset between P and I frames. +

+
+
rc_init_cplx float (encoding,video)
+

Set initial complexity for 1-pass encoding. +

+
+
dct integer (encoding,video)
+

Set DCT algorithm. +

+

Possible values: +

+
‘auto’
+

autoselect a good one (default) +

+
‘fastint’
+

fast integer +

+
‘int’
+

accurate integer +

+
‘mmx’
+
‘altivec’
+
‘faan’
+

floating point AAN DCT +

+
+ +
+
lumi_mask float (encoding,video)
+

Compress bright areas stronger than medium ones. +

+
+
tcplx_mask float (encoding,video)
+

Set temporal complexity masking. +

+
+
scplx_mask float (encoding,video)
+

Set spatial complexity masking. +

+
+
p_mask float (encoding,video)
+

Set inter masking. +

+
+
dark_mask float (encoding,video)
+

Compress dark areas stronger than medium ones. +

+
+
idct integer (decoding/encoding,video)
+

Select IDCT implementation. +

+

Possible values: +

+
‘auto’
+
‘int’
+
‘simple’
+
‘simplemmx’
+
‘simpleauto’
+

Automatically pick a IDCT compatible with the simple one +

+
+
‘arm’
+
‘altivec’
+
‘sh4’
+
‘simplearm’
+
‘simplearmv5te’
+
‘simplearmv6’
+
‘simpleneon’
+
‘simplealpha’
+
‘ipp’
+
‘xvidmmx’
+
‘faani’
+

floating point AAN IDCT +

+
+ +
+
slice_count integer
+
ec flags (decoding,video)
+

Set error concealment strategy. +

+

Possible values: +

+
‘guess_mvs’
+

iterative motion vector (MV) search (slow) +

+
‘deblock’
+

use strong deblock filter for damaged MBs +

+
‘favor_inter’
+

favor predicting from the previous frame instead of the current +

+
+ +
+
bits_per_coded_sample integer
+
pred integer (encoding,video)
+

Set prediction method. +

+

Possible values: +

+
‘left’
+
‘plane’
+
‘median’
+
+ +
+
aspect rational number (encoding,video)
+

Set sample aspect ratio. +

+
+
sar rational number (encoding,video)
+

Set sample aspect ratio. Alias to aspect. +

+
+
debug flags (decoding/encoding,audio,video,subtitles)
+

Print specific debug info. +

+

Possible values: +

+
‘pict’
+

picture info +

+
‘rc’
+

rate control +

+
‘bitstream’
+
‘mb_type’
+

macroblock (MB) type +

+
‘qp’
+

per-block quantization parameter (QP) +

+
‘dct_coeff’
+
‘green_metadata’
+

display complexity metadata for the upcoming frame, GoP or for a given duration. +

+
+
‘skip’
+
‘startcode’
+
‘er’
+

error recognition +

+
‘mmco’
+

memory management control operations (H.264) +

+
‘bugs’
+
‘buffers’
+

picture buffer allocations +

+
‘thread_ops’
+

threading operations +

+
‘nomc’
+

skip motion compensation +

+
+ +
+
cmp integer (encoding,video)
+

Set full pel me compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
subcmp integer (encoding,video)
+

Set sub pel me compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
mbcmp integer (encoding,video)
+

Set macroblock compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
ildctcmp integer (encoding,video)
+

Set interlaced dct compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
dia_size integer (encoding,video)
+

Set diamond type & size for motion estimation. +

+
‘(1024, INT_MAX)’
+

full motion estimation(slowest) +

+
‘(768, 1024]’
+

umh motion estimation +

+
‘(512, 768]’
+

hex motion estimation +

+
‘(256, 512]’
+

l2s diamond motion estimation +

+
‘[2,256]’
+

var diamond motion estimation +

+
‘(-1, 2)’
+

small diamond motion estimation +

+
‘-1’
+

funny diamond motion estimation +

+
‘(INT_MIN, -1)’
+

sab diamond motion estimation +

+
+ +
+
last_pred integer (encoding,video)
+

Set amount of motion predictors from the previous frame. +

+
+
preme integer (encoding,video)
+

Set pre motion estimation. +

+
+
precmp integer (encoding,video)
+

Set pre motion estimation compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
pre_dia_size integer (encoding,video)
+

Set diamond type & size for motion estimation pre-pass. +

+
+
subq integer (encoding,video)
+

Set sub pel motion estimation quality. +

+
+
dtg_active_format integer
+
me_range integer (encoding,video)
+

Set limit motion vectors range (1023 for DivX player). +

+
+
ibias integer (encoding,video)
+

Set intra quant bias. +

+
+
pbias integer (encoding,video)
+

Set inter quant bias. +

+
+
color_table_id integer
+
global_quality integer (encoding,audio,video)
+
coder integer (encoding,video)
+
+

Possible values: +

+
‘vlc’
+

variable length coder / huffman coder +

+
‘ac’
+

arithmetic coder +

+
‘raw’
+

raw (no encoding) +

+
‘rle’
+

run-length coder +

+
‘deflate’
+

deflate-based coder +

+
+ +
+
context integer (encoding,video)
+

Set context model. +

+
+
slice_flags integer
+
mbd integer (encoding,video)
+

Set macroblock decision algorithm (high quality mode). +

+

Possible values: +

+
‘simple’
+

use mbcmp (default) +

+
‘bits’
+

use fewest bits +

+
‘rd’
+

use best rate distortion +

+
+ +
+
stream_codec_tag integer
+
sc_threshold integer (encoding,video)
+

Set scene change threshold. +

+
+
lmin integer (encoding,video)
+

Set min lagrange factor (VBR). +

+
+
lmax integer (encoding,video)
+

Set max lagrange factor (VBR). +

+
+
nr integer (encoding,video)
+

Set noise reduction. +

+
+
rc_init_occupancy integer (encoding,video)
+

Set number of bits which should be loaded into the rc buffer before +decoding starts. +

+
+
flags2 flags (decoding/encoding,audio,video,subtitles)
+
+

Possible values: +

+
‘fast’
+

Allow non spec compliant speedup tricks. +

+
‘noout’
+

Skip bitstream encoding. +

+
‘ignorecrop’
+

Ignore cropping information from sps. +

+
‘local_header’
+

Place global headers at every keyframe instead of in extradata. +

+
‘chunks’
+

Frame data might be split into multiple chunks. +

+
‘showall’
+

Show all frames before the first keyframe. +

+
‘export_mvs’
+

Export motion vectors into frame side-data (see AV_FRAME_DATA_MOTION_VECTORS) +for codecs that support it. See also doc/examples/export_mvs.c. +

+
‘skip_manual’
+

Do not skip samples and export skip information as frame side data. +

+
‘ass_ro_flush_noop’
+

Do not reset ASS ReadOrder field on flush. +

+
+ +
+
export_side_data flags (decoding/encoding,audio,video,subtitles)
+
+

Possible values: +

+
‘mvs’
+

Export motion vectors into frame side-data (see AV_FRAME_DATA_MOTION_VECTORS) +for codecs that support it. See also doc/examples/export_mvs.c. +

+
‘prft’
+

Export encoder Producer Reference Time into packet side-data (see AV_PKT_DATA_PRFT) +for codecs that support it. +

+
+ +
+
error integer (encoding,video)
+
qns integer (encoding,video)
+

Deprecated, use mpegvideo private options instead. +

+
+
threads integer (decoding/encoding,video)
+

Set the number of threads to be used, in case the selected codec +implementation supports multi-threading. +

+

Possible values: +

+
‘auto, 0’
+

automatically select the number of threads to set +

+
+ +

Default value is ‘auto’. +

+
+
me_threshold integer (encoding,video)
+

Set motion estimation threshold. +

+
+
mb_threshold integer (encoding,video)
+

Set macroblock threshold. +

+
+
dc integer (encoding,video)
+

Set intra_dc_precision. +

+
+
nssew integer (encoding,video)
+

Set nsse weight. +

+
+
skip_top integer (decoding,video)
+

Set number of macroblock rows at the top which are skipped. +

+
+
skip_bottom integer (decoding,video)
+

Set number of macroblock rows at the bottom which are skipped. +

+
+
profile integer (encoding,audio,video)
+
+

Set encoder codec profile. Default value is ‘unknown’. Encoder specific +profiles are documented in the relevant encoder documentation. +

+
+
level integer (encoding,audio,video)
+
+

Possible values: +

+
‘unknown’
+
+ +
+
lowres integer (decoding,audio,video)
+

Decode at 1= 1/2, 2=1/4, 3=1/8 resolutions. +

+
+
skip_threshold integer (encoding,video)
+

Set frame skip threshold. +

+
+
skip_factor integer (encoding,video)
+

Set frame skip factor. +

+
+
skip_exp integer (encoding,video)
+

Set frame skip exponent. +Negative values behave identical to the corresponding positive ones, except +that the score is normalized. +Positive values exist primarily for compatibility reasons and are not so useful. +

+
+
skipcmp integer (encoding,video)
+

Set frame skip compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
border_mask float (encoding,video)
+

Increase the quantizer for macroblocks close to borders. +

+
+
mblmin integer (encoding,video)
+

Set min macroblock lagrange factor (VBR). +

+
+
mblmax integer (encoding,video)
+

Set max macroblock lagrange factor (VBR). +

+
+
mepc integer (encoding,video)
+

Set motion estimation bitrate penalty compensation (1.0 = 256). +

+
+
skip_loop_filter integer (decoding,video)
+
skip_idct integer (decoding,video)
+
skip_frame integer (decoding,video)
+
+

Make decoder discard processing depending on the frame type selected +by the option value. +

+

skip_loop_filter skips frame loop filtering, skip_idct +skips frame IDCT/dequantization, skip_frame skips decoding. +

+

Possible values: +

+
‘none’
+

Discard no frame. +

+
+
‘default’
+

Discard useless frames like 0-sized frames. +

+
+
‘noref’
+

Discard all non-reference frames. +

+
+
‘bidir’
+

Discard all bidirectional frames. +

+
+
‘nokey’
+

Discard all frames excepts keyframes. +

+
+
‘nointra’
+

Discard all frames except I frames. +

+
+
‘all’
+

Discard all frames. +

+
+ +

Default value is ‘default’. +

+
+
bidir_refine integer (encoding,video)
+

Refine the two motion vectors used in bidirectional macroblocks. +

+
+
brd_scale integer (encoding,video)
+

Downscale frames for dynamic B-frame decision. +

+
+
keyint_min integer (encoding,video)
+

Set minimum interval between IDR-frames. +

+
+
refs integer (encoding,video)
+

Set reference frames to consider for motion compensation. +

+
+
chromaoffset integer (encoding,video)
+

Set chroma qp offset from luma. +

+
+
trellis integer (encoding,audio,video)
+

Set rate-distortion optimal quantization. +

+
+
mv0_threshold integer (encoding,video)
+
b_sensitivity integer (encoding,video)
+

Adjust sensitivity of b_frame_strategy 1. +

+
+
compression_level integer (encoding,audio,video)
+
min_prediction_order integer (encoding,audio)
+
max_prediction_order integer (encoding,audio)
+
timecode_frame_start integer (encoding,video)
+

Set GOP timecode frame start number, in non drop frame format. +

+
+
request_channels integer (decoding,audio)
+

Set desired number of audio channels. +

+
+
bits_per_raw_sample integer
+
channel_layout integer (decoding/encoding,audio)
+
+

Possible values: +

+
request_channel_layout integer (decoding,audio)
+
+

Possible values: +

+
rc_max_vbv_use float (encoding,video)
+
rc_min_vbv_use float (encoding,video)
+
ticks_per_frame integer (decoding/encoding,audio,video)
+
color_primaries integer (decoding/encoding,video)
+

Possible values: +

+
‘bt709’
+

BT.709 +

+
‘bt470m’
+

BT.470 M +

+
‘bt470bg’
+

BT.470 BG +

+
‘smpte170m’
+

SMPTE 170 M +

+
‘smpte240m’
+

SMPTE 240 M +

+
‘film’
+

Film +

+
‘bt2020’
+

BT.2020 +

+
‘smpte428’
+
‘smpte428_1’
+

SMPTE ST 428-1 +

+
‘smpte431’
+

SMPTE 431-2 +

+
‘smpte432’
+

SMPTE 432-1 +

+
‘jedec-p22’
+

JEDEC P22 +

+
+ +
+
color_trc integer (decoding/encoding,video)
+

Possible values: +

+
‘bt709’
+

BT.709 +

+
‘gamma22’
+

BT.470 M +

+
‘gamma28’
+

BT.470 BG +

+
‘smpte170m’
+

SMPTE 170 M +

+
‘smpte240m’
+

SMPTE 240 M +

+
‘linear’
+

Linear +

+
‘log’
+
‘log100’
+

Log +

+
‘log_sqrt’
+
‘log316’
+

Log square root +

+
‘iec61966_2_4’
+
‘iec61966-2-4’
+

IEC 61966-2-4 +

+
‘bt1361’
+
‘bt1361e’
+

BT.1361 +

+
‘iec61966_2_1’
+
‘iec61966-2-1’
+

IEC 61966-2-1 +

+
‘bt2020_10’
+
‘bt2020_10bit’
+

BT.2020 - 10 bit +

+
‘bt2020_12’
+
‘bt2020_12bit’
+

BT.2020 - 12 bit +

+
‘smpte2084’
+

SMPTE ST 2084 +

+
‘smpte428’
+
‘smpte428_1’
+

SMPTE ST 428-1 +

+
‘arib-std-b67’
+

ARIB STD-B67 +

+
+ +
+
colorspace integer (decoding/encoding,video)
+

Possible values: +

+
‘rgb’
+

RGB +

+
‘bt709’
+

BT.709 +

+
‘fcc’
+

FCC +

+
‘bt470bg’
+

BT.470 BG +

+
‘smpte170m’
+

SMPTE 170 M +

+
‘smpte240m’
+

SMPTE 240 M +

+
‘ycocg’
+

YCOCG +

+
‘bt2020nc’
+
‘bt2020_ncl’
+

BT.2020 NCL +

+
‘bt2020c’
+
‘bt2020_cl’
+

BT.2020 CL +

+
‘smpte2085’
+

SMPTE 2085 +

+
+ +
+
color_range integer (decoding/encoding,video)
+

If used as input parameter, it serves as a hint to the decoder, which +color_range the input has. +Possible values: +

+
‘tv’
+
‘mpeg’
+

MPEG (219*2^(n-8)) +

+
‘pc’
+
‘jpeg’
+

JPEG (2^n-1) +

+
+ +
+
chroma_sample_location integer (decoding/encoding,video)
+

Possible values: +

+
‘left’
+
‘center’
+
‘topleft’
+
‘top’
+
‘bottomleft’
+
‘bottom’
+
+ +
+
log_level_offset integer
+

Set the log level offset. +

+
+
slices integer (encoding,video)
+

Number of slices, used in parallelized encoding. +

+
+
thread_type flags (decoding/encoding,video)
+

Select which multithreading methods to use. +

+

Use of ‘frame’ will increase decoding delay by one frame per +thread, so clients which cannot provide future frames should not use +it. +

+

Possible values: +

+
‘slice’
+

Decode more than one part of a single frame at once. +

+

Multithreading using slices works only when the video was encoded with +slices. +

+
+
‘frame’
+

Decode more than one frame at once. +

+
+ +

Default value is ‘slice+frame’. +

+
+
audio_service_type integer (encoding,audio)
+

Set audio service type. +

+

Possible values: +

+
‘ma’
+

Main Audio Service +

+
‘ef’
+

Effects +

+
‘vi’
+

Visually Impaired +

+
‘hi’
+

Hearing Impaired +

+
‘di’
+

Dialogue +

+
‘co’
+

Commentary +

+
‘em’
+

Emergency +

+
‘vo’
+

Voice Over +

+
‘ka’
+

Karaoke +

+
+ +
+
request_sample_fmt sample_fmt (decoding,audio)
+

Set sample format audio decoders should prefer. Default value is +none. +

+
+
pkt_timebase rational number
+
sub_charenc encoding (decoding,subtitles)
+

Set the input subtitles character encoding. +

+
+
field_order field_order (video)
+

Set/override the field order of the video. +Possible values: +

+
‘progressive’
+

Progressive video +

+
‘tt’
+

Interlaced video, top field coded and displayed first +

+
‘bb’
+

Interlaced video, bottom field coded and displayed first +

+
‘tb’
+

Interlaced video, top coded first, bottom displayed first +

+
‘bt’
+

Interlaced video, bottom coded first, top displayed first +

+
+ +
+
skip_alpha bool (decoding,video)
+

Set to 1 to disable processing alpha (transparency). This works like the +‘gray’ flag in the flags option which skips chroma information +instead of alpha. Default is 0. +

+
+
codec_whitelist list (input)
+

"," separated list of allowed decoders. By default all are allowed. +

+
+
dump_separator string (input)
+

Separator used to separate the fields printed on the command line about the +Stream parameters. +For example, to separate the fields with newlines and indentation: +

+
ffprobe -dump_separator "
+                          "  -i ~/videos/matrixbench_mpeg2.mpg
+
+ +
+
max_pixels integer (decoding/encoding,video)
+

Maximum number of pixels per image. This value can be used to avoid out of +memory failures due to large images. +

+
+
apply_cropping bool (decoding,video)
+

Enable cropping if cropping parameters are multiples of the required +alignment for the left and top parameters. If the alignment is not met the +cropping will be partially applied to maintain alignment. +Default is 1 (enabled). +Note: The required alignment depends on if AV_CODEC_FLAG_UNALIGNED is set and the +CPU. AV_CODEC_FLAG_UNALIGNED cannot be changed from the command line. Also hardware +decoders will not apply left/top Cropping. +

+ +
+
+ + + +

7 Decoders

+ +

Decoders are configured elements in FFmpeg which allow the decoding of +multimedia streams. +

+

When you configure your FFmpeg build, all the supported native decoders +are enabled by default. Decoders requiring an external library must be enabled +manually via the corresponding --enable-lib option. You can list all +available decoders using the configure option --list-decoders. +

+

You can disable all the decoders with the configure option +--disable-decoders and selectively enable / disable single decoders +with the options --enable-decoder=DECODER / +--disable-decoder=DECODER. +

+

The option -decoders of the ff* tools will display the list of +enabled decoders. +

+ + +

8 Video Decoders

+ +

A description of some of the currently available video decoders +follows. +

+ +

8.1 rawvideo

+ +

Raw video decoder. +

+

This decoder decodes rawvideo streams. +

+ +

8.1.1 Options

+ +
+
top top_field_first
+

Specify the assumed field type of the input video. +

+
-1
+

the video is assumed to be progressive (default) +

+
0
+

bottom-field-first is assumed +

+
1
+

top-field-first is assumed +

+
+ +
+
+ + +

8.2 libdav1d

+ +

dav1d AV1 decoder. +

+

libdav1d allows libavcodec to decode the AOMedia Video 1 (AV1) codec. +Requires the presence of the libdav1d headers and library during configuration. +You need to explicitly configure the build with --enable-libdav1d. +

+ +

8.2.1 Options

+ +

The following options are supported by the libdav1d wrapper. +

+
+
framethreads
+

Set amount of frame threads to use during decoding. The default value is 0 (autodetect). +

+
+
tilethreads
+

Set amount of tile threads to use during decoding. The default value is 0 (autodetect). +

+
+
filmgrain
+

Apply film grain to the decoded video if present in the bitstream. Defaults to the +internal default of the library. +

+
+
oppoint
+

Select an operating point of a scalable AV1 bitstream (0 - 31). Defaults to the +internal default of the library. +

+
+
alllayers
+

Output all spatial layers of a scalable AV1 bitstream. The default value is false. +

+
+
+ + +

8.3 libdavs2

+ +

AVS2-P2/IEEE1857.4 video decoder wrapper. +

+

This decoder allows libavcodec to decode AVS2 streams with davs2 library. +

+ + +

9 Audio Decoders

+ +

A description of some of the currently available audio decoders +follows. +

+ +

9.1 ac3

+ +

AC-3 audio decoder. +

+

This decoder implements part of ATSC A/52:2010 and ETSI TS 102 366, as well as +the undocumented RealAudio 3 (a.k.a. dnet). +

+ +

9.1.1 AC-3 Decoder Options

+ +
+
-drc_scale value
+

Dynamic Range Scale Factor. The factor to apply to dynamic range values +from the AC-3 stream. This factor is applied exponentially. +There are 3 notable scale factor ranges: +

+
drc_scale == 0
+

DRC disabled. Produces full range audio. +

+
0 < drc_scale <= 1
+

DRC enabled. Applies a fraction of the stream DRC value. +Audio reproduction is between full range and full compression. +

+
drc_scale > 1
+

DRC enabled. Applies drc_scale asymmetrically. +Loud sounds are fully compressed. Soft sounds are enhanced. +

+
+ +
+
+ + +

9.2 flac

+ +

FLAC audio decoder. +

+

This decoder aims to implement the complete FLAC specification from Xiph. +

+ +

9.2.1 FLAC Decoder options

+ +
+
-use_buggy_lpc
+

The lavc FLAC encoder used to produce buggy streams with high lpc values +(like the default value). This option makes it possible to decode such streams +correctly by using lavc’s old buggy lpc logic for decoding. +

+
+
+ + +

9.3 ffwavesynth

+ +

Internal wave synthesizer. +

+

This decoder generates wave patterns according to predefined sequences. Its +use is purely internal and the format of the data it accepts is not publicly +documented. +

+ +

9.4 libcelt

+ +

libcelt decoder wrapper. +

+

libcelt allows libavcodec to decode the Xiph CELT ultra-low delay audio codec. +Requires the presence of the libcelt headers and library during configuration. +You need to explicitly configure the build with --enable-libcelt. +

+ +

9.5 libgsm

+ +

libgsm decoder wrapper. +

+

libgsm allows libavcodec to decode the GSM full rate audio codec. Requires +the presence of the libgsm headers and library during configuration. You need +to explicitly configure the build with --enable-libgsm. +

+

This decoder supports both the ordinary GSM and the Microsoft variant. +

+ +

9.6 libilbc

+ +

libilbc decoder wrapper. +

+

libilbc allows libavcodec to decode the Internet Low Bitrate Codec (iLBC) +audio codec. Requires the presence of the libilbc headers and library during +configuration. You need to explicitly configure the build with +--enable-libilbc. +

+ +

9.6.1 Options

+ +

The following option is supported by the libilbc wrapper. +

+
+
enhance
+
+

Enable the enhancement of the decoded audio when set to 1. The default +value is 0 (disabled). +

+
+
+ + +

9.7 libopencore-amrnb

+ +

libopencore-amrnb decoder wrapper. +

+

libopencore-amrnb allows libavcodec to decode the Adaptive Multi-Rate +Narrowband audio codec. Using it requires the presence of the +libopencore-amrnb headers and library during configuration. You need to +explicitly configure the build with --enable-libopencore-amrnb. +

+

An FFmpeg native decoder for AMR-NB exists, so users can decode AMR-NB +without this library. +

+ +

9.8 libopencore-amrwb

+ +

libopencore-amrwb decoder wrapper. +

+

libopencore-amrwb allows libavcodec to decode the Adaptive Multi-Rate +Wideband audio codec. Using it requires the presence of the +libopencore-amrwb headers and library during configuration. You need to +explicitly configure the build with --enable-libopencore-amrwb. +

+

An FFmpeg native decoder for AMR-WB exists, so users can decode AMR-WB +without this library. +

+ +

9.9 libopus

+ +

libopus decoder wrapper. +

+

libopus allows libavcodec to decode the Opus Interactive Audio Codec. +Requires the presence of the libopus headers and library during +configuration. You need to explicitly configure the build with +--enable-libopus. +

+

An FFmpeg native decoder for Opus exists, so users can decode Opus +without this library. +

+ + +

10 Subtitles Decoders

+ + +

10.1 libaribb24

+ +

ARIB STD-B24 caption decoder. +

+

Implements profiles A and C of the ARIB STD-B24 standard. +

+ +

10.1.1 libaribb24 Decoder Options

+ +
+
-aribb24-base-path path
+

Sets the base path for the libaribb24 library. This is utilized for reading of +configuration files (for custom unicode conversions), and for dumping of +non-text symbols as images under that location. +

+

Unset by default. +

+
+
-aribb24-skip-ruby-text boolean
+

Tells the decoder wrapper to skip text blocks that contain half-height ruby +text. +

+

Enabled by default. +

+
+
+ + +

10.2 dvbsub

+ + +

10.2.1 Options

+ +
+
compute_clut
+
+
-1
+

Compute clut if no matching CLUT is in the stream. +

+
0
+

Never compute CLUT +

+
1
+

Always compute CLUT and override the one provided in the stream. +

+
+
+
dvb_substream
+

Selects the dvb substream, or all substreams if -1 which is default. +

+
+
+ + +

10.3 dvdsub

+ +

This codec decodes the bitmap subtitles used in DVDs; the same subtitles can +also be found in VobSub file pairs and in some Matroska files. +

+ +

10.3.1 Options

+ +
+
palette
+

Specify the global palette used by the bitmaps. When stored in VobSub, the +palette is normally specified in the index file; in Matroska, the palette is +stored in the codec extra-data in the same format as in VobSub. In DVDs, the +palette is stored in the IFO file, and therefore not available when reading +from dumped VOB files. +

+

The format for this option is a string containing 16 24-bits hexadecimal +numbers (without 0x prefix) separated by commas, for example 0d00ee, +ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1, +7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b. +

+
+
ifo_palette
+

Specify the IFO file from which the global palette is obtained. +(experimental) +

+
+
forced_subs_only
+

Only decode subtitle entries marked as forced. Some titles have forced +and non-forced subtitles in the same track. Setting this flag to 1 +will only keep the forced subtitles. Default value is 0. +

+
+ + +

10.4 libzvbi-teletext

+ +

Libzvbi allows libavcodec to decode DVB teletext pages and DVB teletext +subtitles. Requires the presence of the libzvbi headers and library during +configuration. You need to explicitly configure the build with +--enable-libzvbi. +

+ +

10.4.1 Options

+ +
+
txt_page
+

List of teletext page numbers to decode. Pages that do not match the specified +list are dropped. You may use the special * string to match all pages, +or subtitle to match all subtitle pages. +Default value is *. +

+
txt_default_region
+

Set default character set used for decoding, a value between 0 and 87 (see +ETS 300 706, Section 15, Table 32). Default value is -1, which does not +override the libzvbi default. This option is needed for some legacy level 1.0 +transmissions which cannot signal the proper charset. +

+
txt_chop_top
+

Discards the top teletext line. Default value is 1. +

+
txt_format
+

Specifies the format of the decoded subtitles. +

+
bitmap
+

The default format, you should use this for teletext pages, because certain +graphics and colors cannot be expressed in simple text or even ASS. +

+
text
+

Simple text based output without formatting. +

+
ass
+

Formatted ASS output, subtitle pages and teletext pages are returned in +different styles, subtitle pages are stripped down to text, but an effort is +made to keep the text alignment and the formatting. +

+
+
+
txt_left
+

X offset of generated bitmaps, default is 0. +

+
txt_top
+

Y offset of generated bitmaps, default is 0. +

+
txt_chop_spaces
+

Chops leading and trailing spaces and removes empty lines from the generated +text. This option is useful for teletext based subtitles where empty spaces may +be present at the start or at the end of the lines or empty lines may be +present between the subtitle lines because of double-sized teletext characters. +Default value is 1. +

+
txt_duration
+

Sets the display duration of the decoded teletext pages or subtitles in +milliseconds. Default value is -1 which means infinity or until the next +subtitle event comes. +

+
txt_transparent
+

Force transparent background of the generated teletext bitmaps. Default value +is 0 which means an opaque background. +

+
txt_opacity
+

Sets the opacity (0-255) of the teletext background. If +txt_transparent is not set, it only affects characters between a start +box and an end box, typically subtitles. Default value is 0 if +txt_transparent is set, 255 otherwise. +

+
+
+ + +

11 Bitstream Filters

+ +

When you configure your FFmpeg build, all the supported bitstream +filters are enabled by default. You can list all available ones using +the configure option --list-bsfs. +

+

You can disable all the bitstream filters using the configure option +--disable-bsfs, and selectively enable any bitstream filter using +the option --enable-bsf=BSF, or you can disable a particular +bitstream filter using the option --disable-bsf=BSF. +

+

The option -bsfs of the ff* tools will display the list of +all the supported bitstream filters included in your build. +

+

The ff* tools have a -bsf option applied per stream, taking a +comma-separated list of filters, whose parameters follow the filter +name after a ’=’. +

+
+
ffmpeg -i INPUT -c:v copy -bsf:v filter1[=opt1=str1:opt2=str2][,filter2] OUTPUT
+
+ +

Below is a description of the currently available bitstream filters, +with their parameters, if any. +

+ +

11.1 aac_adtstoasc

+ +

Convert MPEG-2/4 AAC ADTS to an MPEG-4 Audio Specific Configuration +bitstream. +

+

This filter creates an MPEG-4 AudioSpecificConfig from an MPEG-2/4 +ADTS header and removes the ADTS header. +

+

This filter is required for example when copying an AAC stream from a +raw ADTS AAC or an MPEG-TS container to MP4A-LATM, to an FLV file, or +to MOV/MP4 files and related formats such as 3GP or M4A. Please note +that it is auto-inserted for MP4A-LATM and MOV/MP4 and related formats. +

+ +

11.2 av1_metadata

+ +

Modify metadata embedded in an AV1 stream. +

+
+
td
+

Insert or remove temporal delimiter OBUs in all temporal units of the +stream. +

+
+
‘insert’
+

Insert a TD at the beginning of every TU which does not already have one. +

+
‘remove’
+

Remove the TD from the beginning of every TU which has one. +

+
+ +
+
color_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the color description fields in the stream (see AV1 section 6.4.2). +

+
+
color_range
+

Set the color range in the stream (see AV1 section 6.4.2; note that +this cannot be set for streams using BT.709 primaries, sRGB transfer +characteristic and identity (RGB) matrix coefficients). +

+
‘tv’
+

Limited range. +

+
‘pc’
+

Full range. +

+
+ +
+
chroma_sample_position
+

Set the chroma sample location in the stream (see AV1 section 6.4.2). +This can only be set for 4:2:0 streams. +

+
+
‘vertical’
+

Left position (matching the default in MPEG-2 and H.264). +

+
‘colocated’
+

Top-left position. +

+
+ +
+
tick_rate
+

Set the tick rate (num_units_in_display_tick / time_scale) in +the timing info in the sequence header. +

+
num_ticks_per_picture
+

Set the number of ticks in each picture, to indicate that the stream +has a fixed framerate. Ignored if tick_rate is not also set. +

+
+
delete_padding
+

Deletes Padding OBUs. +

+
+
+ + +

11.3 chomp

+ +

Remove zero padding at the end of a packet. +

+ +

11.4 dca_core

+ +

Extract the core from a DCA/DTS stream, dropping extensions such as +DTS-HD. +

+ +

11.5 dump_extra

+ +

Add extradata to the beginning of the filtered packets except when +said packets already exactly begin with the extradata that is intended +to be added. +

+
+
freq
+

The additional argument specifies which packets should be filtered. +It accepts the values: +

+
‘k’
+
‘keyframe’
+

add extradata to all key packets +

+
+
‘e’
+
‘all’
+

add extradata to all packets +

+
+
+
+ +

If not specified it is assumed ‘k’. +

+

For example the following ffmpeg command forces a global +header (thus disabling individual packet headers) in the H.264 packets +generated by the libx264 encoder, but corrects them by adding +the header stored in extradata to the key packets: +

+
ffmpeg -i INPUT -map 0 -flags:v +global_header -c:v libx264 -bsf:v dump_extra out.ts
+
+ + +

11.6 eac3_core

+ +

Extract the core from a E-AC-3 stream, dropping extra channels. +

+ +

11.7 extract_extradata

+ +

Extract the in-band extradata. +

+

Certain codecs allow the long-term headers (e.g. MPEG-2 sequence headers, +or H.264/HEVC (VPS/)SPS/PPS) to be transmitted either "in-band" (i.e. as a part +of the bitstream containing the coded frames) or "out of band" (e.g. on the +container level). This latter form is called "extradata" in FFmpeg terminology. +

+

This bitstream filter detects the in-band headers and makes them available as +extradata. +

+
+
remove
+

When this option is enabled, the long-term headers are removed from the +bitstream after extraction. +

+
+ + +

11.8 filter_units

+ +

Remove units with types in or not in a given set from the stream. +

+
+
pass_types
+

List of unit types or ranges of unit types to pass through while removing +all others. This is specified as a ’|’-separated list of unit type values +or ranges of values with ’-’. +

+
+
remove_types
+

Identical to pass_types, except the units in the given set +removed and all others passed through. +

+
+ +

Extradata is unchanged by this transformation, but note that if the stream +contains inline parameter sets then the output may be unusable if they are +removed. +

+

For example, to remove all non-VCL NAL units from an H.264 stream: +

+
ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=pass_types=1-5' OUTPUT
+
+ +

To remove all AUDs, SEI and filler from an H.265 stream: +

+
ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=remove_types=35|38-40' OUTPUT
+
+ + +

11.9 hapqa_extract

+ +

Extract Rgb or Alpha part of an HAPQA file, without recompression, in order to create an HAPQ or an HAPAlphaOnly file. +

+
+
texture
+

Specifies the texture to keep. +

+
+
color
+
alpha
+
+ +
+
+ +

Convert HAPQA to HAPQ +

+
ffmpeg -i hapqa_inputfile.mov -c copy -bsf:v hapqa_extract=texture=color -tag:v HapY -metadata:s:v:0 encoder="HAPQ" hapq_file.mov
+
+ +

Convert HAPQA to HAPAlphaOnly +

+
ffmpeg -i hapqa_inputfile.mov -c copy -bsf:v hapqa_extract=texture=alpha -tag:v HapA -metadata:s:v:0 encoder="HAPAlpha Only" hapalphaonly_file.mov
+
+ + +

11.10 h264_metadata

+ +

Modify metadata embedded in an H.264 stream. +

+
+
aud
+

Insert or remove AUD NAL units in all access units of the stream. +

+
+
‘insert’
+
‘remove’
+
+ +
+
sample_aspect_ratio
+

Set the sample aspect ratio of the stream in the VUI parameters. +

+
+
overscan_appropriate_flag
+

Set whether the stream is suitable for display using overscan +or not (see H.264 section E.2.1). +

+
+
video_format
+
video_full_range_flag
+

Set the video format in the stream (see H.264 section E.2.1 and +table E-2). +

+
+
colour_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the colour description in the stream (see H.264 section E.2.1 +and tables E-3, E-4 and E-5). +

+
+
chroma_sample_loc_type
+

Set the chroma sample location in the stream (see H.264 section +E.2.1 and figure E-1). +

+
+
tick_rate
+

Set the tick rate (num_units_in_tick / time_scale) in the VUI +parameters. This is the smallest time unit representable in the +stream, and in many cases represents the field rate of the stream +(double the frame rate). +

+
fixed_frame_rate_flag
+

Set whether the stream has fixed framerate - typically this indicates +that the framerate is exactly half the tick rate, but the exact +meaning is dependent on interlacing and the picture structure (see +H.264 section E.2.1 and table E-6). +

+
+
crop_left
+
crop_right
+
crop_top
+
crop_bottom
+

Set the frame cropping offsets in the SPS. These values will replace +the current ones if the stream is already cropped. +

+

These fields are set in pixels. Note that some sizes may not be +representable if the chroma is subsampled or the stream is interlaced +(see H.264 section 7.4.2.1.1). +

+
+
sei_user_data
+

Insert a string as SEI unregistered user data. The argument must +be of the form UUID+string, where the UUID is as hex digits +possibly separated by hyphens, and the string can be anything. +

+

For example, ‘086f3693-b7b3-4f2c-9653-21492feee5b8+hello’ will +insert the string “hello” associated with the given UUID. +

+
+
delete_filler
+

Deletes both filler NAL units and filler SEI messages. +

+
+
level
+

Set the level in the SPS. Refer to H.264 section A.3 and tables A-1 +to A-5. +

+

The argument must be the name of a level (for example, ‘4.2’), a +level_idc value (for example, ‘42’), or the special name ‘auto’ +indicating that the filter should attempt to guess the level from the +input stream properties. +

+
+
+ + +

11.11 h264_mp4toannexb

+ +

Convert an H.264 bitstream from length prefixed mode to start code +prefixed mode (as defined in the Annex B of the ITU-T H.264 +specification). +

+

This is required by some streaming formats, typically the MPEG-2 +transport stream format (muxer mpegts). +

+

For example to remux an MP4 file containing an H.264 stream to mpegts +format with ffmpeg, you can use the command: +

+
+
ffmpeg -i INPUT.mp4 -codec copy -bsf:v h264_mp4toannexb OUTPUT.ts
+
+ +

Please note that this filter is auto-inserted for MPEG-TS (muxer +mpegts) and raw H.264 (muxer h264) output formats. +

+ +

11.12 h264_redundant_pps

+ +

This applies a specific fixup to some Blu-ray streams which contain +redundant PPSs modifying irrelevant parameters of the stream which +confuse other transformations which require correct extradata. +

+

A new single global PPS is created, and all of the redundant PPSs +within the stream are removed. +

+ +

11.13 hevc_metadata

+ +

Modify metadata embedded in an HEVC stream. +

+
+
aud
+

Insert or remove AUD NAL units in all access units of the stream. +

+
+
‘insert’
+
‘remove’
+
+ +
+
sample_aspect_ratio
+

Set the sample aspect ratio in the stream in the VUI parameters. +

+
+
video_format
+
video_full_range_flag
+

Set the video format in the stream (see H.265 section E.3.1 and +table E.2). +

+
+
colour_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the colour description in the stream (see H.265 section E.3.1 +and tables E.3, E.4 and E.5). +

+
+
chroma_sample_loc_type
+

Set the chroma sample location in the stream (see H.265 section +E.3.1 and figure E.1). +

+
+
tick_rate
+

Set the tick rate in the VPS and VUI parameters (num_units_in_tick / +time_scale). Combined with num_ticks_poc_diff_one, this can +set a constant framerate in the stream. Note that it is likely to be +overridden by container parameters when the stream is in a container. +

+
+
num_ticks_poc_diff_one
+

Set poc_proportional_to_timing_flag in VPS and VUI and use this value +to set num_ticks_poc_diff_one_minus1 (see H.265 sections 7.4.3.1 and +E.3.1). Ignored if tick_rate is not also set. +

+
+
crop_left
+
crop_right
+
crop_top
+
crop_bottom
+

Set the conformance window cropping offsets in the SPS. These values +will replace the current ones if the stream is already cropped. +

+

These fields are set in pixels. Note that some sizes may not be +representable if the chroma is subsampled (H.265 section 7.4.3.2.1). +

+
+
level
+

Set the level in the VPS and SPS. See H.265 section A.4 and tables +A.6 and A.7. +

+

The argument must be the name of a level (for example, ‘5.1’), a +general_level_idc value (for example, ‘153’ for level 5.1), +or the special name ‘auto’ indicating that the filter should +attempt to guess the level from the input stream properties. +

+
+
+ + +

11.14 hevc_mp4toannexb

+ +

Convert an HEVC/H.265 bitstream from length prefixed mode to start code +prefixed mode (as defined in the Annex B of the ITU-T H.265 +specification). +

+

This is required by some streaming formats, typically the MPEG-2 +transport stream format (muxer mpegts). +

+

For example to remux an MP4 file containing an HEVC stream to mpegts +format with ffmpeg, you can use the command: +

+
+
ffmpeg -i INPUT.mp4 -codec copy -bsf:v hevc_mp4toannexb OUTPUT.ts
+
+ +

Please note that this filter is auto-inserted for MPEG-TS (muxer +mpegts) and raw HEVC/H.265 (muxer h265 or +hevc) output formats. +

+ +

11.15 imxdump

+ +

Modifies the bitstream to fit in MOV and to be usable by the Final Cut +Pro decoder. This filter only applies to the mpeg2video codec, and is +likely not needed for Final Cut Pro 7 and newer with the appropriate +-tag:v. +

+

For example, to remux 30 MB/sec NTSC IMX to MOV: +

+
+
ffmpeg -i input.mxf -c copy -bsf:v imxdump -tag:v mx3n output.mov
+
+ + +

11.16 mjpeg2jpeg

+ +

Convert MJPEG/AVI1 packets to full JPEG/JFIF packets. +

+

MJPEG is a video codec wherein each video frame is essentially a +JPEG image. The individual frames can be extracted without loss, +e.g. by +

+
+
ffmpeg -i ../some_mjpeg.avi -c:v copy frames_%d.jpg
+
+ +

Unfortunately, these chunks are incomplete JPEG images, because +they lack the DHT segment required for decoding. Quoting from +http://www.digitalpreservation.gov/formats/fdd/fdd000063.shtml: +

+

Avery Lee, writing in the rec.video.desktop newsgroup in 2001, +commented that "MJPEG, or at least the MJPEG in AVIs having the +MJPG fourcc, is restricted JPEG with a fixed – and *omitted* – +Huffman table. The JPEG must be YCbCr colorspace, it must be 4:2:2, +and it must use basic Huffman encoding, not arithmetic or +progressive. . . . You can indeed extract the MJPEG frames and +decode them with a regular JPEG decoder, but you have to prepend +the DHT segment to them, or else the decoder won’t have any idea +how to decompress the data. The exact table necessary is given in +the OpenDML spec." +

+

This bitstream filter patches the header of frames extracted from an MJPEG +stream (carrying the AVI1 header ID and lacking a DHT segment) to +produce fully qualified JPEG images. +

+
+
ffmpeg -i mjpeg-movie.avi -c:v copy -bsf:v mjpeg2jpeg frame_%d.jpg
+exiftran -i -9 frame*.jpg
+ffmpeg -i frame_%d.jpg -c:v copy rotated.avi
+
+ + +

11.17 mjpegadump

+ +

Add an MJPEG A header to the bitstream, to enable decoding by +Quicktime. +

+ +

11.18 mov2textsub

+ +

Extract a representable text file from MOV subtitles, stripping the +metadata header from each subtitle packet. +

+

See also the text2movsub filter. +

+ +

11.19 mp3decomp

+ +

Decompress non-standard compressed MP3 audio headers. +

+ +

11.20 mpeg2_metadata

+ +

Modify metadata embedded in an MPEG-2 stream. +

+
+
display_aspect_ratio
+

Set the display aspect ratio in the stream. +

+

The following fixed values are supported: +

+
4/3
+
16/9
+
221/100
+
+

Any other value will result in square pixels being signalled instead +(see H.262 section 6.3.3 and table 6-3). +

+
+
frame_rate
+

Set the frame rate in the stream. This is constructed from a table +of known values combined with a small multiplier and divisor - if +the supplied value is not exactly representable, the nearest +representable value will be used instead (see H.262 section 6.3.3 +and table 6-4). +

+
+
video_format
+

Set the video format in the stream (see H.262 section 6.3.6 and +table 6-6). +

+
+
colour_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the colour description in the stream (see H.262 section 6.3.6 +and tables 6-7, 6-8 and 6-9). +

+
+
+ + +

11.21 mpeg4_unpack_bframes

+ +

Unpack DivX-style packed B-frames. +

+

DivX-style packed B-frames are not valid MPEG-4 and were only a +workaround for the broken Video for Windows subsystem. +They use more space, can cause minor AV sync issues, require more +CPU power to decode (unless the player has some decoded picture queue +to compensate the 2,0,2,0 frame per packet style) and cause +trouble if copied into a standard container like mp4 or mpeg-ps/ts, +because MPEG-4 decoders may not be able to decode them, since they are +not valid MPEG-4. +

+

For example to fix an AVI file containing an MPEG-4 stream with +DivX-style packed B-frames using ffmpeg, you can use the command: +

+
+
ffmpeg -i INPUT.avi -codec copy -bsf:v mpeg4_unpack_bframes OUTPUT.avi
+
+ + +

11.22 noise

+ +

Damages the contents of packets or simply drops them without damaging the +container. Can be used for fuzzing or testing error resilience/concealment. +

+

Parameters: +

+
amount
+

A numeral string, whose value is related to how often output bytes will +be modified. Therefore, values below or equal to 0 are forbidden, and +the lower the more frequent bytes will be modified, with 1 meaning +every byte is modified. +

+
dropamount
+

A numeral string, whose value is related to how often packets will be dropped. +Therefore, values below or equal to 0 are forbidden, and the lower the more +frequent packets will be dropped, with 1 meaning every packet is dropped. +

+
+ +

The following example applies the modification to every byte but does not drop +any packets. +

+
ffmpeg -i INPUT -c copy -bsf noise[=1] output.mkv
+
+ + +

11.23 null

+

This bitstream filter passes the packets through unchanged. +

+ +

11.24 pcm_rechunk

+ +

Repacketize PCM audio to a fixed number of samples per packet or a fixed packet +rate per second. This is similar to the (ffmpeg-filters)asetnsamples audio +filter but works on audio packets instead of audio frames. +

+
+
nb_out_samples, n
+

Set the number of samples per each output audio packet. The number is intended +as the number of samples per each channel. Default value is 1024. +

+
+
pad, p
+

If set to 1, the filter will pad the last audio packet with silence, so that it +will contain the same number of samples (or roughly the same number of samples, +see frame_rate) as the previous ones. Default value is 1. +

+
+
frame_rate, r
+

This option makes the filter output a fixed number of packets per second instead +of a fixed number of samples per packet. If the audio sample rate is not +divisible by the frame rate then the number of samples will not be constant but +will vary slightly so that each packet will start as close to the frame +boundary as possible. Using this option has precedence over nb_out_samples. +

+
+ +

You can generate the well known 1602-1601-1602-1601-1602 pattern of 48kHz audio +for NTSC frame rate using the frame_rate option. +

+
ffmpeg -f lavfi -i sine=r=48000:d=1 -c pcm_s16le -bsf pcm_rechunk=r=30000/1001 -f framecrc -
+
+ + +

11.25 prores_metadata

+ +

Modify color property metadata embedded in prores stream. +

+
+
color_primaries
+

Set the color primaries. +Available values are: +

+
+
‘auto’
+

Keep the same color primaries property (default). +

+
+
‘unknown’
+
‘bt709’
+
‘bt470bg’
+

BT601 625 +

+
+
‘smpte170m’
+

BT601 525 +

+
+
‘bt2020’
+
‘smpte431’
+

DCI P3 +

+
+
‘smpte432’
+

P3 D65 +

+
+
+ +
+
transfer_characteristics
+

Set the color transfer. +Available values are: +

+
+
‘auto’
+

Keep the same transfer characteristics property (default). +

+
+
‘unknown’
+
‘bt709’
+

BT 601, BT 709, BT 2020 +

+
‘smpte2084’
+

SMPTE ST 2084 +

+
‘arib-std-b67’
+

ARIB STD-B67 +

+
+ + +
+
matrix_coefficients
+

Set the matrix coefficient. +Available values are: +

+
+
‘auto’
+

Keep the same colorspace property (default). +

+
+
‘unknown’
+
‘bt709’
+
‘smpte170m’
+

BT 601 +

+
+
‘bt2020nc’
+
+
+
+ +

Set Rec709 colorspace for each frame of the file +

+
ffmpeg -i INPUT -c copy -bsf:v prores_metadata=color_primaries=bt709:color_trc=bt709:colorspace=bt709 output.mov
+
+ +

Set Hybrid Log-Gamma parameters for each frame of the file +

+
ffmpeg -i INPUT -c copy -bsf:v prores_metadata=color_primaries=bt2020:color_trc=arib-std-b67:colorspace=bt2020nc output.mov
+
+ + +

11.26 remove_extra

+ +

Remove extradata from packets. +

+

It accepts the following parameter: +

+
freq
+

Set which frame types to remove extradata from. +

+
+
‘k’
+

Remove extradata from non-keyframes only. +

+
+
‘keyframe’
+

Remove extradata from keyframes only. +

+
+
‘e, all’
+

Remove extradata from all frames. +

+
+
+
+
+ + +

11.27 text2movsub

+ +

Convert text subtitles to MOV subtitles (as used by the mov_text +codec) with metadata headers. +

+

See also the mov2textsub filter. +

+ +

11.28 trace_headers

+ +

Log trace output containing all syntax elements in the coded stream +headers (everything above the level of individual coded blocks). +This can be useful for debugging low-level stream issues. +

+

Supports AV1, H.264, H.265, (M)JPEG, MPEG-2 and VP9, but depending +on the build only a subset of these may be available. +

+ +

11.29 truehd_core

+ +

Extract the core from a TrueHD stream, dropping ATMOS data. +

+ +

11.30 vp9_metadata

+ +

Modify metadata embedded in a VP9 stream. +

+
+
color_space
+

Set the color space value in the frame header. Note that any frame +set to RGB will be implicitly set to PC range and that RGB is +incompatible with profiles 0 and 2. +

+
‘unknown’
+
‘bt601’
+
‘bt709’
+
‘smpte170’
+
‘smpte240’
+
‘bt2020’
+
‘rgb’
+
+ +
+
color_range
+

Set the color range value in the frame header. Note that any value +imposed by the color space will take precedence over this value. +

+
‘tv’
+
‘pc’
+
+
+
+ + +

11.31 vp9_superframe

+ +

Merge VP9 invisible (alt-ref) frames back into VP9 superframes. This +fixes merging of split/segmented VP9 streams where the alt-ref frame +was split from its visible counterpart. +

+ +

11.32 vp9_superframe_split

+ +

Split VP9 superframes into single frames. +

+ +

11.33 vp9_raw_reorder

+ +

Given a VP9 stream with correct timestamps but possibly out of order, +insert additional show-existing-frame packets to correct the ordering. +

+ +

12 Format Options

+ +

The libavformat library provides some generic global options, which +can be set on all the muxers and demuxers. In addition each muxer or +demuxer may support so-called private options, which are specific for +that component. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the +AVFormatContext options or using the libavutil/opt.h API +for programmatic use. +

+

The list of supported options follows: +

+
+
avioflags flags (input/output)
+

Possible values: +

+
‘direct’
+

Reduce buffering. +

+
+ +
+
probesize integer (input)
+

Set probing size in bytes, i.e. the size of the data to analyze to get +stream information. A higher value will enable detecting more +information in case it is dispersed into the stream, but will increase +latency. Must be an integer not lesser than 32. It is 5000000 by default. +

+
+
max_probe_packets integer (input)
+

Set the maximum number of buffered packets when probing a codec. +Default is 2500 packets. +

+
+
packetsize integer (output)
+

Set packet size. +

+
+
fflags flags
+

Set format flags. Some are implemented for a limited number of formats. +

+

Possible values for input files: +

+
‘discardcorrupt’
+

Discard corrupted packets. +

+
‘fastseek’
+

Enable fast, but inaccurate seeks for some formats. +

+
‘genpts’
+

Generate missing PTS if DTS is present. +

+
‘igndts’
+

Ignore DTS if PTS is set. Inert when nofillin is set. +

+
‘ignidx’
+

Ignore index. +

+
‘keepside (deprecated,inert)’
+
‘nobuffer’
+

Reduce the latency introduced by buffering during initial input streams analysis. +

+
‘nofillin’
+

Do not fill in missing values in packet fields that can be exactly calculated. +

+
‘noparse’
+

Disable AVParsers, this needs +nofillin too. +

+
‘sortdts’
+

Try to interleave output packets by DTS. At present, available only for AVIs with an index. +

+
+ +

Possible values for output files: +

+
‘autobsf’
+

Automatically apply bitstream filters as required by the output format. Enabled by default. +

+
‘bitexact’
+

Only write platform-, build- and time-independent data. +This ensures that file and data checksums are reproducible and match between +platforms. Its primary use is for regression testing. +

+
‘flush_packets’
+

Write out packets immediately. +

+
‘latm (deprecated,inert)’
+
‘shortest’
+

Stop muxing at the end of the shortest stream. +It may be needed to increase max_interleave_delta to avoid flushing the longer +streams before EOF. +

+
+ +
+
seek2any integer (input)
+

Allow seeking to non-keyframes on demuxer level when supported if set to 1. +Default is 0. +

+
+
analyzeduration integer (input)
+

Specify how many microseconds are analyzed to probe the input. A +higher value will enable detecting more accurate information, but will +increase latency. It defaults to 5,000,000 microseconds = 5 seconds. +

+
+
cryptokey hexadecimal string (input)
+

Set decryption key. +

+
+
indexmem integer (input)
+

Set max memory used for timestamp index (per stream). +

+
+
rtbufsize integer (input)
+

Set max memory used for buffering real-time frames. +

+
+
fdebug flags (input/output)
+

Print specific debug info. +

+

Possible values: +

+
‘ts’
+
+ +
+
max_delay integer (input/output)
+

Set maximum muxing or demuxing delay in microseconds. +

+
+
fpsprobesize integer (input)
+

Set number of frames used to probe fps. +

+
+
audio_preload integer (output)
+

Set microseconds by which audio packets should be interleaved earlier. +

+
+
chunk_duration integer (output)
+

Set microseconds for each chunk. +

+
+
chunk_size integer (output)
+

Set size in bytes for each chunk. +

+
+
err_detect, f_err_detect flags (input)
+

Set error detection flags. f_err_detect is deprecated and +should be used only via the ffmpeg tool. +

+

Possible values: +

+
‘crccheck’
+

Verify embedded CRCs. +

+
‘bitstream’
+

Detect bitstream specification deviations. +

+
‘buffer’
+

Detect improper bitstream length. +

+
‘explode’
+

Abort decoding on minor error detection. +

+
‘careful’
+

Consider things that violate the spec and have not been seen in the +wild as errors. +

+
‘compliant’
+

Consider all spec non compliancies as errors. +

+
‘aggressive’
+

Consider things that a sane encoder should not do as an error. +

+
+ +
+
max_interleave_delta integer (output)
+

Set maximum buffering duration for interleaving. The duration is +expressed in microseconds, and defaults to 10000000 (10 seconds). +

+

To ensure all the streams are interleaved correctly, libavformat will +wait until it has at least one packet for each stream before actually +writing any packets to the output file. When some streams are +"sparse" (i.e. there are large gaps between successive packets), this +can result in excessive buffering. +

+

This field specifies the maximum difference between the timestamps of the +first and the last packet in the muxing queue, above which libavformat +will output a packet regardless of whether it has queued a packet for all +the streams. +

+

If set to 0, libavformat will continue buffering packets until it has +a packet for each stream, regardless of the maximum timestamp +difference between the buffered packets. +

+
+
use_wallclock_as_timestamps integer (input)
+

Use wallclock as timestamps if set to 1. Default is 0. +

+
+
avoid_negative_ts integer (output)
+
+

Possible values: +

+
‘make_non_negative’
+

Shift timestamps to make them non-negative. +Also note that this affects only leading negative timestamps, and not +non-monotonic negative timestamps. +

+
‘make_zero’
+

Shift timestamps so that the first timestamp is 0. +

+
‘auto (default)’
+

Enables shifting when required by the target format. +

+
‘disabled’
+

Disables shifting of timestamp. +

+
+ +

When shifting is enabled, all output timestamps are shifted by the +same amount. Audio, video, and subtitles desynching and relative +timestamp differences are preserved compared to how they would have +been without shifting. +

+
+
skip_initial_bytes integer (input)
+

Set number of bytes to skip before reading header and frames if set to 1. +Default is 0. +

+
+
correct_ts_overflow integer (input)
+

Correct single timestamp overflows if set to 1. Default is 1. +

+
+
flush_packets integer (output)
+

Flush the underlying I/O stream after each packet. Default is -1 (auto), which +means that the underlying protocol will decide, 1 enables it, and has the +effect of reducing the latency, 0 disables it and may increase IO throughput in +some cases. +

+
+
output_ts_offset offset (output)
+

Set the output time offset. +

+

offset must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+

The offset is added by the muxer to the output timestamps. +

+

Specifying a positive offset means that the corresponding streams are +delayed bt the time duration specified in offset. Default value +is 0 (meaning that no offset is applied). +

+
+
format_whitelist list (input)
+

"," separated list of allowed demuxers. By default all are allowed. +

+
+
dump_separator string (input)
+

Separator used to separate the fields printed on the command line about the +Stream parameters. +For example, to separate the fields with newlines and indentation: +

+
ffprobe -dump_separator "
+                          "  -i ~/videos/matrixbench_mpeg2.mpg
+
+ +
+
max_streams integer (input)
+

Specifies the maximum number of streams. This can be used to reject files that +would require too many resources due to a large number of streams. +

+
+
skip_estimate_duration_from_pts bool (input)
+

Skip estimation of input duration when calculated using PTS. +At present, applicable for MPEG-PS and MPEG-TS. +

+
+
strict, f_strict integer (input/output)
+

Specify how strictly to follow the standards. f_strict is deprecated and +should be used only via the ffmpeg tool. +

+

Possible values: +

+
‘very’
+

strictly conform to an older more strict version of the spec or reference software +

+
‘strict’
+

strictly conform to all the things in the spec no matter what consequences +

+
‘normal’
+
‘unofficial’
+

allow unofficial extensions +

+
‘experimental’
+

allow non standardized experimental things, experimental +(unfinished/work in progress/not well tested) decoders and encoders. +Note: experimental decoders can pose a security risk, do not use this for +decoding untrusted input. +

+
+ +
+
+ + + +

12.1 Format stream specifiers

+ +

Format stream specifiers allow selection of one or more streams that +match specific properties. +

+

The exact semantics of stream specifiers is defined by the +avformat_match_stream_specifier() function declared in the +libavformat/avformat.h header and documented in the +(ffmpeg)Stream specifiers section in the ffmpeg(1) manual. +

+ +

13 Demuxers

+ +

Demuxers are configured elements in FFmpeg that can read the +multimedia streams from a particular type of file. +

+

When you configure your FFmpeg build, all the supported demuxers +are enabled by default. You can list all available ones using the +configure option --list-demuxers. +

+

You can disable all the demuxers using the configure option +--disable-demuxers, and selectively enable a single demuxer with +the option --enable-demuxer=DEMUXER, or disable it +with the option --disable-demuxer=DEMUXER. +

+

The option -demuxers of the ff* tools will display the list of +enabled demuxers. Use -formats to view a combined list of +enabled demuxers and muxers. +

+

The description of some of the currently available demuxers follows. +

+ +

13.1 aa

+ +

Audible Format 2, 3, and 4 demuxer. +

+

This demuxer is used to demux Audible Format 2, 3, and 4 (.aa) files. +

+ +

13.2 apng

+ +

Animated Portable Network Graphics demuxer. +

+

This demuxer is used to demux APNG files. +All headers, but the PNG signature, up to (but not including) the first +fcTL chunk are transmitted as extradata. +Frames are then split as being all the chunks between two fcTL ones, or +between the last fcTL and IEND chunks. +

+
+
-ignore_loop bool
+

Ignore the loop variable in the file if set. +

+
-max_fps int
+

Maximum framerate in frames per second (0 for no limit). +

+
-default_fps int
+

Default framerate in frames per second when none is specified in the file +(0 meaning as fast as possible). +

+
+ + +

13.3 asf

+ +

Advanced Systems Format demuxer. +

+

This demuxer is used to demux ASF files and MMS network streams. +

+
+
-no_resync_search bool
+

Do not try to resynchronize by looking for a certain optional start code. +

+
+ + +

13.4 concat

+ +

Virtual concatenation script demuxer. +

+

This demuxer reads a list of files and other directives from a text file and +demuxes them one after the other, as if all their packets had been muxed +together. +

+

The timestamps in the files are adjusted so that the first file starts at 0 +and each next file starts where the previous one finishes. Note that it is +done globally and may cause gaps if all streams do not have exactly the same +length. +

+

All files must have the same streams (same codecs, same time base, etc.). +

+

The duration of each file is used to adjust the timestamps of the next file: +if the duration is incorrect (because it was computed using the bit-rate or +because the file is truncated, for example), it can cause artifacts. The +duration directive can be used to override the duration stored in +each file. +

+ +

13.4.1 Syntax

+ +

The script is a text file in extended-ASCII, with one directive per line. +Empty lines, leading spaces and lines starting with ’#’ are ignored. The +following directive is recognized: +

+
+
file path
+

Path to a file to read; special characters and spaces must be escaped with +backslash or single quotes. +

+

All subsequent file-related directives apply to that file. +

+
+
ffconcat version 1.0
+

Identify the script type and version. It also sets the safe option +to 1 if it was -1. +

+

To make FFmpeg recognize the format automatically, this directive must +appear exactly as is (no extra space or byte-order-mark) on the very first +line of the script. +

+
+
duration dur
+

Duration of the file. This information can be specified from the file; +specifying it here may be more efficient or help if the information from the +file is not available or accurate. +

+

If the duration is set for all files, then it is possible to seek in the +whole concatenated video. +

+
+
inpoint timestamp
+

In point of the file. When the demuxer opens the file it instantly seeks to the +specified timestamp. Seeking is done so that all streams can be presented +successfully at In point. +

+

This directive works best with intra frame codecs, because for non-intra frame +ones you will usually get extra packets before the actual In point and the +decoded content will most likely contain frames before In point too. +

+

For each file, packets before the file In point will have timestamps less than +the calculated start timestamp of the file (negative in case of the first +file), and the duration of the files (if not specified by the duration +directive) will be reduced based on their specified In point. +

+

Because of potential packets before the specified In point, packet timestamps +may overlap between two concatenated files. +

+
+
outpoint timestamp
+

Out point of the file. When the demuxer reaches the specified decoding +timestamp in any of the streams, it handles it as an end of file condition and +skips the current and all the remaining packets from all streams. +

+

Out point is exclusive, which means that the demuxer will not output packets +with a decoding timestamp greater or equal to Out point. +

+

This directive works best with intra frame codecs and formats where all streams +are tightly interleaved. For non-intra frame codecs you will usually get +additional packets with presentation timestamp after Out point therefore the +decoded content will most likely contain frames after Out point too. If your +streams are not tightly interleaved you may not get all the packets from all +streams before Out point and you may only will be able to decode the earliest +stream until Out point. +

+

The duration of the files (if not specified by the duration +directive) will be reduced based on their specified Out point. +

+
+
file_packet_metadata key=value
+

Metadata of the packets of the file. The specified metadata will be set for +each file packet. You can specify this directive multiple times to add multiple +metadata entries. +

+
+
stream
+

Introduce a stream in the virtual file. +All subsequent stream-related directives apply to the last introduced +stream. +Some streams properties must be set in order to allow identifying the +matching streams in the subfiles. +If no streams are defined in the script, the streams from the first file are +copied. +

+
+
exact_stream_id id
+

Set the id of the stream. +If this directive is given, the string with the corresponding id in the +subfiles will be used. +This is especially useful for MPEG-PS (VOB) files, where the order of the +streams is not reliable. +

+
+
+ + +

13.4.2 Options

+ +

This demuxer accepts the following option: +

+
+
safe
+

If set to 1, reject unsafe file paths. A file path is considered safe if it +does not contain a protocol specification and is relative and all components +only contain characters from the portable character set (letters, digits, +period, underscore and hyphen) and have no period at the beginning of a +component. +

+

If set to 0, any file name is accepted. +

+

The default is 1. +

+

-1 is equivalent to 1 if the format was automatically +probed and 0 otherwise. +

+
+
auto_convert
+

If set to 1, try to perform automatic conversions on packet data to make the +streams concatenable. +The default is 1. +

+

Currently, the only conversion is adding the h264_mp4toannexb bitstream +filter to H.264 streams in MP4 format. This is necessary in particular if +there are resolution changes. +

+
+
segment_time_metadata
+

If set to 1, every packet will contain the lavf.concat.start_time and the +lavf.concat.duration packet metadata values which are the start_time and +the duration of the respective file segments in the concatenated output +expressed in microseconds. The duration metadata is only set if it is known +based on the concat file. +The default is 0. +

+
+
+ + +

13.4.3 Examples

+ +
    +
  • Use absolute filenames and include some comments: +
    +
    # my first filename
+file /mnt/share/file-1.wav
+# my second filename including whitespace
+file '/mnt/share/file 2.wav'
+# my third filename including whitespace plus single quote
+file '/mnt/share/file 3'\''.wav'
+
    + +
  • Allow for input format auto-probing, use safe filenames and set the duration of +the first file: +
    +
    ffconcat version 1.0
+
+file file-1.wav
+duration 20.0
+
+file subdir/file-2.wav
+
    +
+ + +

13.5 dash

+ +

Dynamic Adaptive Streaming over HTTP demuxer. +

+

This demuxer presents all AVStreams found in the manifest. +By setting the discard flags on AVStreams the caller can decide +which streams to actually receive. +Each stream mirrors the id and bandwidth properties from the +<Representation> as metadata keys named "id" and "variant_bitrate" respectively. +

+ +

13.6 flv, live_flv

+ +

Adobe Flash Video Format demuxer. +

+

This demuxer is used to demux FLV files and RTMP network streams. In case of live network streams, if you force format, you may use live_flv option instead of flv to survive timestamp discontinuities. +

+
+
ffmpeg -f flv -i myfile.flv ...
+ffmpeg -f live_flv -i rtmp://<any.server>/anything/key ....
+
+ + +
+
-flv_metadata bool
+

Allocate the streams according to the onMetaData array content. +

+
+
-flv_ignore_prevtag bool
+

Ignore the size of previous tag value. +

+
+
-flv_full_metadata bool
+

Output all context of the onMetadata. +

+
+ + +

13.7 gif

+ +

Animated GIF demuxer. +

+

It accepts the following options: +

+
+
min_delay
+

Set the minimum valid delay between frames in hundredths of seconds. +Range is 0 to 6000. Default value is 2. +

+
+
max_gif_delay
+

Set the maximum valid delay between frames in hundredth of seconds. +Range is 0 to 65535. Default value is 65535 (nearly eleven minutes), +the maximum value allowed by the specification. +

+
+
default_delay
+

Set the default delay between frames in hundredths of seconds. +Range is 0 to 6000. Default value is 10. +

+
+
ignore_loop
+

GIF files can contain information to loop a certain number of times (or +infinitely). If ignore_loop is set to 1, then the loop setting +from the input will be ignored and looping will not occur. If set to 0, +then looping will occur and will cycle the number of times according to +the GIF. Default value is 1. +

+
+ +

For example, with the overlay filter, place an infinitely looping GIF +over another video: +

+
ffmpeg -i input.mp4 -ignore_loop 0 -i input.gif -filter_complex overlay=shortest=1 out.mkv
+
+ +

Note that in the above example the shortest option for overlay filter is +used to end the output video at the length of the shortest input file, +which in this case is input.mp4 as the GIF in this example loops +infinitely. +

+ +

13.8 hls

+ +

HLS demuxer +

+

Apple HTTP Live Streaming demuxer. +

+

This demuxer presents all AVStreams from all variant streams. +The id field is set to the bitrate variant index number. By setting +the discard flags on AVStreams (by pressing ’a’ or ’v’ in ffplay), +the caller can decide which variant streams to actually receive. +The total bitrate of the variant that the stream belongs to is +available in a metadata key named "variant_bitrate". +

+

It accepts the following options: +

+
+
live_start_index
+

segment index to start live streams at (negative values are from the end). +

+
+
allowed_extensions
+

’,’ separated list of file extensions that hls is allowed to access. +

+
+
max_reload
+

Maximum number of times a insufficient list is attempted to be reloaded. +Default value is 1000. +

+
+
m3u8_hold_counters
+

The maximum number of times to load m3u8 when it refreshes without new segments. +Default value is 1000. +

+
+
http_persistent
+

Use persistent HTTP connections. Applicable only for HTTP streams. +Enabled by default. +

+
+
http_multiple
+

Use multiple HTTP connections for downloading HTTP segments. +Enabled by default for HTTP/1.1 servers. +

+
+
http_seekable
+

Use HTTP partial requests for downloading HTTP segments. +0 = disable, 1 = enable, -1 = auto, Default is auto. +

+
+ + +

13.9 image2

+ +

Image file demuxer. +

+

This demuxer reads from a list of image files specified by a pattern. +The syntax and meaning of the pattern is specified by the +option pattern_type. +

+

The pattern may contain a suffix which is used to automatically +determine the format of the images contained in the files. +

+

The size, the pixel format, and the format of each image must be the +same for all the files in the sequence. +

+

This demuxer accepts the following options: +

+
framerate
+

Set the frame rate for the video stream. It defaults to 25. +

+
loop
+

If set to 1, loop over the input. Default value is 0. +

+
pattern_type
+

Select the pattern type used to interpret the provided filename. +

+

pattern_type accepts one of the following values. +

+
none
+

Disable pattern matching, therefore the video will only contain the specified +image. You should use this option if you do not want to create sequences from +multiple images and your filenames may contain special pattern characters. +

+
sequence
+

Select a sequence pattern type, used to specify a sequence of files +indexed by sequential numbers. +

+

A sequence pattern may contain the string "%d" or "%0Nd", which +specifies the position of the characters representing a sequential +number in each filename matched by the pattern. If the form +"%d0Nd" is used, the string representing the number in each +filename is 0-padded and N is the total number of 0-padded +digits representing the number. The literal character ’%’ can be +specified in the pattern with the string "%%". +

+

If the sequence pattern contains "%d" or "%0Nd", the first filename of +the file list specified by the pattern must contain a number +inclusively contained between start_number and +start_number+start_number_range-1, and all the following +numbers must be sequential. +

+

For example the pattern "img-%03d.bmp" will match a sequence of +filenames of the form img-001.bmp, img-002.bmp, ..., +img-010.bmp, etc.; the pattern "i%%m%%g-%d.jpg" will match a +sequence of filenames of the form i%m%g-1.jpg, +i%m%g-2.jpg, ..., i%m%g-10.jpg, etc. +

+

Note that the pattern must not necessarily contain "%d" or +"%0Nd", for example to convert a single image file +img.jpeg you can employ the command: +

+
ffmpeg -i img.jpeg img.png
+
+ +
+
glob
+

Select a glob wildcard pattern type. +

+

The pattern is interpreted like a glob() pattern. This is only +selectable if libavformat was compiled with globbing support. +

+
+
glob_sequence (deprecated, will be removed)
+

Select a mixed glob wildcard/sequence pattern. +

+

If your version of libavformat was compiled with globbing support, and +the provided pattern contains at least one glob meta character among +%*?[]{} that is preceded by an unescaped "%", the pattern is +interpreted like a glob() pattern, otherwise it is interpreted +like a sequence pattern. +

+

All glob special characters %*?[]{} must be prefixed +with "%". To escape a literal "%" you shall use "%%". +

+

For example the pattern foo-%*.jpeg will match all the +filenames prefixed by "foo-" and terminating with ".jpeg", and +foo-%?%?%?.jpeg will match all the filenames prefixed with +"foo-", followed by a sequence of three characters, and terminating +with ".jpeg". +

+

This pattern type is deprecated in favor of glob and +sequence. +

+
+ +

Default value is glob_sequence. +

+
pixel_format
+

Set the pixel format of the images to read. If not specified the pixel +format is guessed from the first image file in the sequence. +

+
start_number
+

Set the index of the file matched by the image file pattern to start +to read from. Default value is 0. +

+
start_number_range
+

Set the index interval range to check when looking for the first image +file in the sequence, starting from start_number. Default value +is 5. +

+
ts_from_file
+

If set to 1, will set frame timestamp to modification time of image file. Note +that monotonity of timestamps is not provided: images go in the same order as +without this option. Default value is 0. +If set to 2, will set frame timestamp to the modification time of the image file in +nanosecond precision. +

+
video_size
+

Set the video size of the images to read. If not specified the video +size is guessed from the first image file in the sequence. +

+
export_path_metadata
+

If set to 1, will add two extra fields to the metadata found in input, making them +also available for other filters (see drawtext filter for examples). Default +value is 0. The extra fields are described below: +

+
lavf.image2dec.source_path
+

Corresponds to the full path to the input file being read. +

+
lavf.image2dec.source_basename
+

Corresponds to the name of the file being read. +

+
+ +
+
+ + +

13.9.1 Examples

+ +
    +
  • Use ffmpeg for creating a video from the images in the file +sequence img-001.jpeg, img-002.jpeg, ..., assuming an +input frame rate of 10 frames per second: +
    +
    ffmpeg -framerate 10 -i 'img-%03d.jpeg' out.mkv
+
    + +
  • As above, but start by reading from a file with index 100 in the sequence: +
    +
    ffmpeg -framerate 10 -start_number 100 -i 'img-%03d.jpeg' out.mkv
+
    + +
  • Read images matching the "*.png" glob pattern , that is all the files +terminating with the ".png" suffix: +
    +
    ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
+
    +
+ + +

13.10 libgme

+ +

The Game Music Emu library is a collection of video game music file emulators. +

+

See https://bitbucket.org/mpyne/game-music-emu/overview for more information. +

+

It accepts the following options: +

+
+
track_index
+

Set the index of which track to demux. The demuxer can only export one track. +Track indexes start at 0. Default is to pick the first track. Number of tracks +is exported as tracks metadata entry. +

+
+
sample_rate
+

Set the sampling rate of the exported track. Range is 1000 to 999999. Default is 44100. +

+
+
max_size (bytes)
+

The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size, +which in turn, acts as a ceiling for the size of files that can be read. +Default is 50 MiB. +

+
+
+ + +

13.11 libmodplug

+ +

ModPlug based module demuxer +

+

See https://github.com/Konstanty/libmodplug +

+

It will export one 2-channel 16-bit 44.1 kHz audio stream. +Optionally, a pal8 16-color video stream can be exported with or without printed metadata. +

+

It accepts the following options: +

+
+
noise_reduction
+

Apply a simple low-pass filter. Can be 1 (on) or 0 (off). Default is 0. +

+
+
reverb_depth
+

Set amount of reverb. Range 0-100. Default is 0. +

+
+
reverb_delay
+

Set delay in ms, clamped to 40-250 ms. Default is 0. +

+
+
bass_amount
+

Apply bass expansion a.k.a. XBass or megabass. Range is 0 (quiet) to 100 (loud). Default is 0. +

+
+
bass_range
+

Set cutoff i.e. upper-bound for bass frequencies. Range is 10-100 Hz. Default is 0. +

+
+
surround_depth
+

Apply a Dolby Pro-Logic surround effect. Range is 0 (quiet) to 100 (heavy). Default is 0. +

+
+
surround_delay
+

Set surround delay in ms, clamped to 5-40 ms. Default is 0. +

+
+
max_size
+

The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size, +which in turn, acts as a ceiling for the size of files that can be read. Range is 0 to 100 MiB. +0 removes buffer size limit (not recommended). Default is 5 MiB. +

+
+
video_stream_expr
+

String which is evaluated using the eval API to assign colors to the generated video stream. +Variables which can be used are x, y, w, h, t, speed, +tempo, order, pattern and row. +

+
+
video_stream
+

Generate video stream. Can be 1 (on) or 0 (off). Default is 0. +

+
+
video_stream_w
+

Set video frame width in ’chars’ where one char indicates 8 pixels. Range is 20-512. Default is 30. +

+
+
video_stream_h
+

Set video frame height in ’chars’ where one char indicates 8 pixels. Range is 20-512. Default is 30. +

+
+
video_stream_ptxt
+

Print metadata on video stream. Includes speed, tempo, order, pattern, +row and ts (time in ms). Can be 1 (on) or 0 (off). Default is 1. +

+
+
+ + +

13.12 libopenmpt

+ +

libopenmpt based module demuxer +

+

See https://lib.openmpt.org/libopenmpt/ for more information. +

+

Some files have multiple subsongs (tracks) this can be set with the subsong +option. +

+

It accepts the following options: +

+
+
subsong
+

Set the subsong index. This can be either ’all’, ’auto’, or the index of the +subsong. Subsong indexes start at 0. The default is ’auto’. +

+

The default value is to let libopenmpt choose. +

+
+
layout
+

Set the channel layout. Valid values are 1, 2, and 4 channel layouts. +The default value is STEREO. +

+
+
sample_rate
+

Set the sample rate for libopenmpt to output. +Range is from 1000 to INT_MAX. The value default is 48000. +

+
+ + +

13.13 mov/mp4/3gp

+ +

Demuxer for Quicktime File Format & ISO/IEC Base Media File Format (ISO/IEC 14496-12 or MPEG-4 Part 12, ISO/IEC 15444-12 or JPEG 2000 Part 12). +

+

Registered extensions: mov, mp4, m4a, 3gp, 3g2, mj2, psp, m4b, ism, ismv, isma, f4v +

+ +

13.13.1 Options

+ +

This demuxer accepts the following options: +

+
enable_drefs
+

Enable loading of external tracks, disabled by default. +Enabling this can theoretically leak information in some use cases. +

+
+
use_absolute_path
+

Allows loading of external tracks via absolute paths, disabled by default. +Enabling this poses a security risk. It should only be enabled if the source +is known to be non-malicious. +

+
+
seek_streams_individually
+

When seeking, identify the closest point in each stream individually and demux packets in +that stream from identified point. This can lead to a different sequence of packets compared +to demuxing linearly from the beginning. Default is true. +

+
+
ignore_editlist
+

Ignore any edit list atoms. The demuxer, by default, modifies the stream index to reflect the +timeline described by the edit list. Default is false. +

+
+
advanced_editlist
+

Modify the stream index to reflect the timeline described by the edit list. ignore_editlist +must be set to false for this option to be effective. +If both ignore_editlist and this option are set to false, then only the +start of the stream index is modified to reflect initial dwell time or starting timestamp +described by the edit list. Default is true. +

+
+
ignore_chapters
+

Don’t parse chapters. This includes GoPro ’HiLight’ tags/moments. Note that chapters are +only parsed when input is seekable. Default is false. +

+
+
use_mfra_for
+

For seekable fragmented input, set fragment’s starting timestamp from media fragment random access box, if present. +

+

Following options are available: +

+
‘auto’
+

Auto-detect whether to set mfra timestamps as PTS or DTS (default) +

+
+
‘dts’
+

Set mfra timestamps as DTS +

+
+
‘pts’
+

Set mfra timestamps as PTS +

+
+
‘0’
+

Don’t use mfra box to set timestamps +

+
+ +
+
export_all
+

Export unrecognized boxes within the udta box as metadata entries. The first four +characters of the box type are set as the key. Default is false. +

+
+
export_xmp
+

Export entire contents of XMP_ box and uuid box as a string with key xmp. Note that +if export_all is set and this option isn’t, the contents of XMP_ box are still exported +but with key XMP_. Default is false. +

+
+
activation_bytes
+

4-byte key required to decrypt Audible AAX and AAX+ files. See Audible AAX subsection below. +

+
+
audible_fixed_key
+

Fixed key used for handling Audible AAX/AAX+ files. It has been pre-set so should not be necessary to +specify. +

+
+
decryption_key
+

16-byte key, in hex, to decrypt files encrypted using ISO Common Encryption (CENC/AES-128 CTR; ISO/IEC 23001-7). +

+
+ + +

13.13.2 Audible AAX

+ +

Audible AAX files are encrypted M4B files, and they can be decrypted by specifying a 4 byte activation secret. +

+
ffmpeg -activation_bytes 1CEB00DA -i test.aax -vn -c:a copy output.mp4
+
+ + +

13.14 mpegts

+ +

MPEG-2 transport stream demuxer. +

+

This demuxer accepts the following options: +

+
resync_size
+

Set size limit for looking up a new synchronization. Default value is +65536. +

+
+
skip_unknown_pmt
+

Skip PMTs for programs not defined in the PAT. Default value is 0. +

+
+
fix_teletext_pts
+

Override teletext packet PTS and DTS values with the timestamps calculated +from the PCR of the first program which the teletext stream is part of and is +not discarded. Default value is 1, set this option to 0 if you want your +teletext packet PTS and DTS values untouched. +

+
+
ts_packetsize
+

Output option carrying the raw packet size in bytes. +Show the detected raw packet size, cannot be set by the user. +

+
+
scan_all_pmts
+

Scan and combine all PMTs. The value is an integer with value from -1 +to 1 (-1 means automatic setting, 1 means enabled, 0 means +disabled). Default value is -1. +

+
+
merge_pmt_versions
+

Re-use existing streams when a PMT’s version is updated and elementary +streams move to different PIDs. Default value is 0. +

+
+ + +

13.15 mpjpeg

+ +

MJPEG encapsulated in multi-part MIME demuxer. +

+

This demuxer allows reading of MJPEG, where each frame is represented as a part of +multipart/x-mixed-replace stream. +

+
strict_mime_boundary
+

Default implementation applies a relaxed standard to multi-part MIME boundary detection, +to prevent regression with numerous existing endpoints not generating a proper MIME +MJPEG stream. Turning this option on by setting it to 1 will result in a stricter check +of the boundary value. +

+
+ + +

13.16 rawvideo

+ +

Raw video demuxer. +

+

This demuxer allows one to read raw video data. Since there is no header +specifying the assumed video parameters, the user must specify them +in order to be able to decode the data correctly. +

+

This demuxer accepts the following options: +

+
framerate
+

Set input video frame rate. Default value is 25. +

+
+
pixel_format
+

Set the input video pixel format. Default value is yuv420p. +

+
+
video_size
+

Set the input video size. This value must be specified explicitly. +

+
+ +

For example to read a rawvideo file input.raw with +ffplay, assuming a pixel format of rgb24, a video +size of 320x240, and a frame rate of 10 images per second, use +the command: +

+
ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
+
+ + +

13.17 sbg

+ +

SBaGen script demuxer. +

+

This demuxer reads the script language used by SBaGen +http://uazu.net/sbagen/ to generate binaural beats sessions. A SBG +script looks like that: +

+
-SE
+a: 300-2.5/3 440+4.5/0
+b: 300-2.5/0 440+4.5/3
+off: -
+NOW      == a
++0:07:00 == b
++0:14:00 == a
++0:21:00 == b
++0:30:00    off
+
+ +

A SBG script can mix absolute and relative timestamps. If the script uses +either only absolute timestamps (including the script start time) or only +relative ones, then its layout is fixed, and the conversion is +straightforward. On the other hand, if the script mixes both kind of +timestamps, then the NOW reference for relative timestamps will be +taken from the current time of day at the time the script is read, and the +script layout will be frozen according to that reference. That means that if +the script is directly played, the actual times will match the absolute +timestamps up to the sound controller’s clock accuracy, but if the user +somehow pauses the playback or seeks, all times will be shifted accordingly. +

+ +

13.18 tedcaptions

+ +

JSON captions used for TED Talks. +

+

TED does not provide links to the captions, but they can be guessed from the +page. The file tools/bookmarklets.html from the FFmpeg source tree +contains a bookmarklet to expose them. +

+

This demuxer accepts the following option: +

+
start_time
+

Set the start time of the TED talk, in milliseconds. The default is 15000 +(15s). It is used to sync the captions with the downloadable videos, because +they include a 15s intro. +

+
+ +

Example: convert the captions to a format most players understand: +

+
ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
+
+ + +

13.19 vapoursynth

+ +

Vapoursynth wrapper. +

+

Due to security concerns, Vapoursynth scripts will not +be autodetected so the input format has to be forced. For ff* CLI tools, +add -f vapoursynth before the input -i yourscript.vpy. +

+

This demuxer accepts the following option: +

+
max_script_size
+

The demuxer buffers the entire script into memory. Adjust this value to set the maximum buffer size, +which in turn, acts as a ceiling for the size of scripts that can be read. +Default is 1 MiB. +

+
+ + +

14 Metadata

+ +

FFmpeg is able to dump metadata from media files into a simple UTF-8-encoded +INI-like text file and then load it back using the metadata muxer/demuxer. +

+

The file format is as follows: +

    +
  1. A file consists of a header and a number of metadata tags divided into sections, +each on its own line. + +
  2. The header is a ‘;FFMETADATA’ string, followed by a version number (now 1). + +
  3. Metadata tags are of the form ‘key=value’ + +
  4. Immediately after header follows global metadata + +
  5. After global metadata there may be sections with per-stream/per-chapter +metadata. + +
  6. A section starts with the section name in uppercase (i.e. STREAM or CHAPTER) in +brackets (‘[’, ‘]’) and ends with next section or end of file. + +
  7. At the beginning of a chapter section there may be an optional timebase to be +used for start/end values. It must be in form +‘TIMEBASE=num/den’, where num and den are +integers. If the timebase is missing then start/end times are assumed to +be in nanoseconds. + +

    Next a chapter section must contain chapter start and end times in form +‘START=num’, ‘END=num’, where num is a positive +integer. +

    +
  8. Empty lines and lines starting with ‘;’ or ‘#’ are ignored. + +
  9. Metadata keys or values containing special characters (‘=’, ‘;’, +‘#’, ‘\’ and a newline) must be escaped with a backslash ‘\’. + +
  10. Note that whitespace in metadata (e.g. ‘foo = bar’) is considered to be +a part of the tag (in the example above key is ‘foo ’, value is +‘ bar’). +
+ +

A ffmetadata file might look like this: +

+
;FFMETADATA1
+title=bike\\shed
+;this is a comment
+artist=FFmpeg troll team
+
+[CHAPTER]
+TIMEBASE=1/1000
+START=0
+#chapter ends at 0:01:00
+END=60000
+title=chapter \#1
+[STREAM]
+title=multi\
+line
+
+ +

By using the ffmetadata muxer and demuxer it is possible to extract +metadata from an input file to an ffmetadata file, and then transcode +the file into an output file with the edited ffmetadata file. +

+

Extracting an ffmetadata file with ffmpeg goes as follows: +

+
ffmpeg -i INPUT -f ffmetadata FFMETADATAFILE
+
+ +

Reinserting edited metadata information from the FFMETADATAFILE file can +be done as: +

+
ffmpeg -i INPUT -i FFMETADATAFILE -map_metadata 1 -codec copy OUTPUT
+
+ + +

15 Protocol Options

+ +

The libavformat library provides some generic global options, which +can be set on all the protocols. In addition each protocol may support +so-called private options, which are specific for that component. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the +AVFormatContext options or using the libavutil/opt.h API +for programmatic use. +

+

The list of supported options follows: +

+
+
protocol_whitelist list (input)
+

Set a ","-separated list of allowed protocols. "ALL" matches all protocols. Protocols +prefixed by "-" are disabled. +All protocols are allowed by default but protocols used by an another +protocol (nested protocols) are restricted to a per protocol subset. +

+
+ + + +

16 Protocols

+ +

Protocols are configured elements in FFmpeg that enable access to +resources that require specific protocols. +

+

When you configure your FFmpeg build, all the supported protocols are +enabled by default. You can list all available ones using the +configure option "–list-protocols". +

+

You can disable all the protocols using the configure option +"–disable-protocols", and selectively enable a protocol using the +option "–enable-protocol=PROTOCOL", or you can disable a +particular protocol using the option +"–disable-protocol=PROTOCOL". +

+

The option "-protocols" of the ff* tools will display the list of +supported protocols. +

+

All protocols accept the following options: +

+
+
rw_timeout
+

Maximum time to wait for (network) read/write operations to complete, +in microseconds. +

+
+ +

A description of the currently available protocols follows. +

+ +

16.1 amqp

+ +

Advanced Message Queueing Protocol (AMQP) version 0-9-1 is a broker based +publish-subscribe communication protocol. +

+

FFmpeg must be compiled with –enable-librabbitmq to support AMQP. A separate +AMQP broker must also be run. An example open-source AMQP broker is RabbitMQ. +

+

After starting the broker, an FFmpeg client may stream data to the broker using +the command: +

+
+
ffmpeg -re -i input -f mpegts amqp://[[user]:[password]@]hostname[:port]
+
+ +

Where hostname and port (default is 5672) is the address of the broker. The +client may also set a user/password for authentication. The default for both +fields is "guest". +

+

Muliple subscribers may stream from the broker using the command: +

+
ffplay amqp://[[user]:[password]@]hostname[:port]
+
+ +

In RabbitMQ all data published to the broker flows through a specific exchange, +and each subscribing client has an assigned queue/buffer. When a packet arrives +at an exchange, it may be copied to a client’s queue depending on the exchange +and routing_key fields. +

+

The following options are supported: +

+
+
exchange
+

Sets the exchange to use on the broker. RabbitMQ has several predefined +exchanges: "amq.direct" is the default exchange, where the publisher and +subscriber must have a matching routing_key; "amq.fanout" is the same as a +broadcast operation (i.e. the data is forwarded to all queues on the fanout +exchange independent of the routing_key); and "amq.topic" is similar to +"amq.direct", but allows for more complex pattern matching (refer to the RabbitMQ +documentation). +

+
+
routing_key
+

Sets the routing key. The default value is "amqp". The routing key is used on +the "amq.direct" and "amq.topic" exchanges to decide whether packets are written +to the queue of a subscriber. +

+
+
pkt_size
+

Maximum size of each packet sent/received to the broker. Default is 131072. +Minimum is 4096 and max is any large value (representable by an int). When +receiving packets, this sets an internal buffer size in FFmpeg. It should be +equal to or greater than the size of the published packets to the broker. Otherwise +the received message may be truncated causing decoding errors. +

+
+
connection_timeout
+

The timeout in seconds during the initial connection to the broker. The +default value is rw_timeout, or 5 seconds if rw_timeout is not set. +

+
+
+ + +

16.2 async

+ +

Asynchronous data filling wrapper for input stream. +

+

Fill data in a background thread, to decouple I/O operation from demux thread. +

+
+
async:URL
+async:http://host/resource
+async:cache:http://host/resource
+
+ + +

16.3 bluray

+ +

Read BluRay playlist. +

+

The accepted options are: +

+
angle
+

BluRay angle +

+
+
chapter
+

Start chapter (1...N) +

+
+
playlist
+

Playlist to read (BDMV/PLAYLIST/?????.mpls) +

+
+
+ +

Examples: +

+

Read longest playlist from BluRay mounted to /mnt/bluray: +

+
bluray:/mnt/bluray
+
+ +

Read angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapter 2: +

+
-playlist 4 -angle 2 -chapter 2 bluray:/mnt/bluray
+
+ + +

16.4 cache

+ +

Caching wrapper for input stream. +

+

Cache the input stream to temporary file. It brings seeking capability to live streams. +

+
+
cache:URL
+
+ + +

16.5 concat

+ +

Physical concatenation protocol. +

+

Read and seek from many resources in sequence as if they were +a unique resource. +

+

A URL accepted by this protocol has the syntax: +

+
concat:URL1|URL2|...|URLN
+
+ +

where URL1, URL2, ..., URLN are the urls of the +resource to be concatenated, each one possibly specifying a distinct +protocol. +

+

For example to read a sequence of files split1.mpeg, +split2.mpeg, split3.mpeg with ffplay use the +command: +

+
ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
+
+ +

Note that you may need to escape the character "|" which is special for +many shells. +

+ +

16.6 crypto

+ +

AES-encrypted stream reading protocol. +

+

The accepted options are: +

+
key
+

Set the AES decryption key binary block from given hexadecimal representation. +

+
+
iv
+

Set the AES decryption initialization vector binary block from given hexadecimal representation. +

+
+ +

Accepted URL formats: +

+
crypto:URL
+crypto+URL
+
+ + +

16.7 data

+ +

Data in-line in the URI. See http://en.wikipedia.org/wiki/Data_URI_scheme. +

+

For example, to convert a GIF file given inline with ffmpeg: +

+
ffmpeg -i "data:image/gif;base64,R0lGODdhCAAIAMIEAAAAAAAA//8AAP//AP///////////////ywAAAAACAAIAAADF0gEDLojDgdGiJdJqUX02iB4E8Q9jUMkADs=" smiley.png
+
+ + +

16.8 file

+ +

File access protocol. +

+

Read from or write to a file. +

+

A file URL can have the form: +

+
file:filename
+
+ +

where filename is the path of the file to read. +

+

An URL that does not have a protocol prefix will be assumed to be a +file URL. Depending on the build, an URL that looks like a Windows +path with the drive letter at the beginning will also be assumed to be +a file URL (usually not the case in builds for unix-like systems). +

+

For example to read from a file input.mpeg with ffmpeg +use the command: +

+
ffmpeg -i file:input.mpeg output.mpeg
+
+ +

This protocol accepts the following options: +

+
+
truncate
+

Truncate existing files on write, if set to 1. A value of 0 prevents +truncating. Default value is 1. +

+
+
blocksize
+

Set I/O operation maximum block size, in bytes. Default value is +INT_MAX, which results in not limiting the requested block size. +Setting this value reasonably low improves user termination request reaction +time, which is valuable for files on slow medium. +

+
+
follow
+

If set to 1, the protocol will retry reading at the end of the file, allowing +reading files that still are being written. In order for this to terminate, +you either need to use the rw_timeout option, or use the interrupt callback +(for API users). +

+
+
seekable
+

Controls if seekability is advertised on the file. 0 means non-seekable, -1 +means auto (seekable for normal files, non-seekable for named pipes). +

+

Many demuxers handle seekable and non-seekable resources differently, +overriding this might speed up opening certain files at the cost of losing some +features (e.g. accurate seeking). +

+
+ + +

16.9 ftp

+ +

FTP (File Transfer Protocol). +

+

Read from or write to remote resources using FTP protocol. +

+

Following syntax is required. +

+
ftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg
+
+ +

This protocol accepts the following options. +

+
+
timeout
+

Set timeout in microseconds of socket I/O operations used by the underlying low level +operation. By default it is set to -1, which means that the timeout is +not specified. +

+
+
ftp-user
+

Set a user to be used for authenticating to the FTP server. This is overridden by the +user in the FTP URL. +

+
+
ftp-password
+

Set a password to be used for authenticating to the FTP server. This is overridden by +the password in the FTP URL, or by ftp-anonymous-password if no user is set. +

+
+
ftp-anonymous-password
+

Password used when login as anonymous user. Typically an e-mail address +should be used. +

+
+
ftp-write-seekable
+

Control seekability of connection during encoding. If set to 1 the +resource is supposed to be seekable, if set to 0 it is assumed not +to be seekable. Default value is 0. +

+
+ +

NOTE: Protocol can be used as output, but it is recommended to not do +it, unless special care is taken (tests, customized server configuration +etc.). Different FTP servers behave in different way during seek +operation. ff* tools may produce incomplete content due to server limitations. +

+ +

16.10 gopher

+ +

Gopher protocol. +

+ +

16.11 hls

+ +

Read Apple HTTP Live Streaming compliant segmented stream as +a uniform one. The M3U8 playlists describing the segments can be +remote HTTP resources or local files, accessed using the standard +file protocol. +The nested protocol is declared by specifying +"+proto" after the hls URI scheme name, where proto +is either "file" or "http". +

+
+
hls+http://host/path/to/remote/resource.m3u8
+hls+file://path/to/local/resource.m3u8
+
+ +

Using this protocol is discouraged - the hls demuxer should work +just as well (if not, please report the issues) and is more complete. +To use the hls demuxer instead, simply use the direct URLs to the +m3u8 files. +

+ +

16.12 http

+ +

HTTP (Hyper Text Transfer Protocol). +

+

This protocol accepts the following options: +

+
+
seekable
+

Control seekability of connection. If set to 1 the resource is +supposed to be seekable, if set to 0 it is assumed not to be seekable, +if set to -1 it will try to autodetect if it is seekable. Default +value is -1. +

+
+
chunked_post
+

If set to 1 use chunked Transfer-Encoding for posts, default is 1. +

+
+
content_type
+

Set a specific content type for the POST messages or for listen mode. +

+
+
http_proxy
+

set HTTP proxy to tunnel through e.g. http://example.com:1234 +

+
+
headers
+

Set custom HTTP headers, can override built in default headers. The +value must be a string encoding the headers. +

+
+
multiple_requests
+

Use persistent connections if set to 1, default is 0. +

+
+
post_data
+

Set custom HTTP post data. +

+
+
referer
+

Set the Referer header. Include ’Referer: URL’ header in HTTP request. +

+
+
user_agent
+

Override the User-Agent header. If not specified the protocol will use a +string describing the libavformat build. ("Lavf/<version>") +

+
+
user-agent
+

This is a deprecated option, you can use user_agent instead it. +

+
+
timeout
+

Set timeout in microseconds of socket I/O operations used by the underlying low level +operation. By default it is set to -1, which means that the timeout is +not specified. +

+
+
reconnect_at_eof
+

If set then eof is treated like an error and causes reconnection, this is useful +for live / endless streams. +

+
+
reconnect_streamed
+

If set then even streamed/non seekable streams will be reconnected on errors. +

+
+
reconnect_delay_max
+

Sets the maximum delay in seconds after which to give up reconnecting +

+
+
mime_type
+

Export the MIME type. +

+
+
http_version
+

Exports the HTTP response version number. Usually "1.0" or "1.1". +

+
+
icy
+

If set to 1 request ICY (SHOUTcast) metadata from the server. If the server +supports this, the metadata has to be retrieved by the application by reading +the icy_metadata_headers and icy_metadata_packet options. +The default is 1. +

+
+
icy_metadata_headers
+

If the server supports ICY metadata, this contains the ICY-specific HTTP reply +headers, separated by newline characters. +

+
+
icy_metadata_packet
+

If the server supports ICY metadata, and icy was set to 1, this +contains the last non-empty metadata packet sent by the server. It should be +polled in regular intervals by applications interested in mid-stream metadata +updates. +

+
+
cookies
+

Set the cookies to be sent in future requests. The format of each cookie is the +same as the value of a Set-Cookie HTTP response field. Multiple cookies can be +delimited by a newline character. +

+
+
offset
+

Set initial byte offset. +

+
+
end_offset
+

Try to limit the request to bytes preceding this offset. +

+
+
method
+

When used as a client option it sets the HTTP method for the request. +

+

When used as a server option it sets the HTTP method that is going to be +expected from the client(s). +If the expected and the received HTTP method do not match the client will +be given a Bad Request response. +When unset the HTTP method is not checked for now. This will be replaced by +autodetection in the future. +

+
+
listen
+

If set to 1 enables experimental HTTP server. This can be used to send data when +used as an output option, or read data from a client with HTTP POST when used as +an input option. +If set to 2 enables experimental multi-client HTTP server. This is not yet implemented +in ffmpeg.c and thus must not be used as a command line option. +

+
# Server side (sending):
+ffmpeg -i somefile.ogg -c copy -listen 1 -f ogg http://server:port
+
+# Client side (receiving):
+ffmpeg -i http://server:port -c copy somefile.ogg
+
+# Client can also be done with wget:
+wget http://server:port -O somefile.ogg
+
+# Server side (receiving):
+ffmpeg -listen 1 -i http://server:port -c copy somefile.ogg
+
+# Client side (sending):
+ffmpeg -i somefile.ogg -chunked_post 0 -c copy -f ogg http://server:port
+
+# Client can also be done with wget:
+wget --post-file=somefile.ogg http://server:port
+
+ +
+
send_expect_100
+

Send an Expect: 100-continue header for POST. If set to 1 it will send, if set +to 0 it won’t, if set to -1 it will try to send if it is applicable. Default +value is -1. +

+
+
+ + +

16.12.1 HTTP Cookies

+ +

Some HTTP requests will be denied unless cookie values are passed in with the +request. The cookies option allows these cookies to be specified. At +the very least, each cookie must specify a value along with a path and domain. +HTTP requests that match both the domain and path will automatically include the +cookie value in the HTTP Cookie header field. Multiple cookies can be delimited +by a newline. +

+

The required syntax to play a stream specifying a cookie is: +

+
ffplay -cookies "nlqptid=nltid=tsn; path=/; domain=somedomain.com;" http://somedomain.com/somestream.m3u8
+
+ + +

16.13 Icecast

+ +

Icecast protocol (stream to Icecast servers) +

+

This protocol accepts the following options: +

+
+
ice_genre
+

Set the stream genre. +

+
+
ice_name
+

Set the stream name. +

+
+
ice_description
+

Set the stream description. +

+
+
ice_url
+

Set the stream website URL. +

+
+
ice_public
+

Set if the stream should be public. +The default is 0 (not public). +

+
+
user_agent
+

Override the User-Agent header. If not specified a string of the form +"Lavf/<version>" will be used. +

+
+
password
+

Set the Icecast mountpoint password. +

+
+
content_type
+

Set the stream content type. This must be set if it is different from +audio/mpeg. +

+
+
legacy_icecast
+

This enables support for Icecast versions < 2.4.0, that do not support the +HTTP PUT method but the SOURCE method. +

+
+
+ +
+
icecast://[username[:password]@]server:port/mountpoint
+
+ + +

16.14 mmst

+ +

MMS (Microsoft Media Server) protocol over TCP. +

+ +

16.15 mmsh

+ +

MMS (Microsoft Media Server) protocol over HTTP. +

+

The required syntax is: +

+
mmsh://server[:port][/app][/playpath]
+
+ + +

16.16 md5

+ +

MD5 output protocol. +

+

Computes the MD5 hash of the data to be written, and on close writes +this to the designated output or stdout if none is specified. It can +be used to test muxers without writing an actual file. +

+

Some examples follow. +

+
# Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
+ffmpeg -i input.flv -f avi -y md5:output.avi.md5
+
+# Write the MD5 hash of the encoded AVI file to stdout.
+ffmpeg -i input.flv -f avi -y md5:
+
+ +

Note that some formats (typically MOV) require the output protocol to +be seekable, so they will fail with the MD5 output protocol. +

+ +

16.17 pipe

+ +

UNIX pipe access protocol. +

+

Read and write from UNIX pipes. +

+

The accepted syntax is: +

+
pipe:[number]
+
+ +

number is the number corresponding to the file descriptor of the +pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr). If number +is not specified, by default the stdout file descriptor will be used +for writing, stdin for reading. +

+

For example to read from stdin with ffmpeg: +

+
cat test.wav | ffmpeg -i pipe:0
+# ...this is the same as...
+cat test.wav | ffmpeg -i pipe:
+
+ +

For writing to stdout with ffmpeg: +

+
ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
+# ...this is the same as...
+ffmpeg -i test.wav -f avi pipe: | cat > test.avi
+
+ +

This protocol accepts the following options: +

+
+
blocksize
+

Set I/O operation maximum block size, in bytes. Default value is +INT_MAX, which results in not limiting the requested block size. +Setting this value reasonably low improves user termination request reaction +time, which is valuable if data transmission is slow. +

+
+ +

Note that some formats (typically MOV), require the output protocol to +be seekable, so they will fail with the pipe output protocol. +

+ +

16.18 prompeg

+ +

Pro-MPEG Code of Practice #3 Release 2 FEC protocol. +

+

The Pro-MPEG CoP#3 FEC is a 2D parity-check forward error correction mechanism +for MPEG-2 Transport Streams sent over RTP. +

+

This protocol must be used in conjunction with the rtp_mpegts muxer and +the rtp protocol. +

+

The required syntax is: +

+
-f rtp_mpegts -fec prompeg=option=val... rtp://hostname:port
+
+ +

The destination UDP ports are port + 2 for the column FEC stream +and port + 4 for the row FEC stream. +

+

This protocol accepts the following options: +

+
l=n
+

The number of columns (4-20, LxD <= 100) +

+
+
d=n
+

The number of rows (4-20, LxD <= 100) +

+
+
+ +

Example usage: +

+
+
-f rtp_mpegts -fec prompeg=l=8:d=4 rtp://hostname:port
+
+ + +

16.19 rtmp

+ +

Real-Time Messaging Protocol. +

+

The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia +content across a TCP/IP network. +

+

The required syntax is: +

+
rtmp://[username:password@]server[:port][/app][/instance][/playpath]
+
+ +

The accepted parameters are: +

+
username
+

An optional username (mostly for publishing). +

+
+
password
+

An optional password (mostly for publishing). +

+
+
server
+

The address of the RTMP server. +

+
+
port
+

The number of the TCP port to use (by default is 1935). +

+
+
app
+

It is the name of the application to access. It usually corresponds to +the path where the application is installed on the RTMP server +(e.g. /ondemand/, /flash/live/, etc.). You can override +the value parsed from the URI through the rtmp_app option, too. +

+
+
playpath
+

It is the path or name of the resource to play with reference to the +application specified in app, may be prefixed by "mp4:". You +can override the value parsed from the URI through the rtmp_playpath +option, too. +

+
+
listen
+

Act as a server, listening for an incoming connection. +

+
+
timeout
+

Maximum time to wait for the incoming connection. Implies listen. +

+
+ +

Additionally, the following parameters can be set via command line options +(or in code via AVOptions): +

+
rtmp_app
+

Name of application to connect on the RTMP server. This option +overrides the parameter specified in the URI. +

+
+
rtmp_buffer
+

Set the client buffer time in milliseconds. The default is 3000. +

+
+
rtmp_conn
+

Extra arbitrary AMF connection parameters, parsed from a string, +e.g. like B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0. +Each value is prefixed by a single character denoting the type, +B for Boolean, N for number, S for string, O for object, or Z for null, +followed by a colon. For Booleans the data must be either 0 or 1 for +FALSE or TRUE, respectively. Likewise for Objects the data must be 0 or +1 to end or begin an object, respectively. Data items in subobjects may +be named, by prefixing the type with ’N’ and specifying the name before +the value (i.e. NB:myFlag:1). This option may be used multiple +times to construct arbitrary AMF sequences. +

+
+
rtmp_flashver
+

Version of the Flash plugin used to run the SWF player. The default +is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible; +<libavformat version>).) +

+
+
rtmp_flush_interval
+

Number of packets flushed in the same request (RTMPT only). The default +is 10. +

+
+
rtmp_live
+

Specify that the media is a live stream. No resuming or seeking in +live streams is possible. The default value is any, which means the +subscriber first tries to play the live stream specified in the +playpath. If a live stream of that name is not found, it plays the +recorded stream. The other possible values are live and +recorded. +

+
+
rtmp_pageurl
+

URL of the web page in which the media was embedded. By default no +value will be sent. +

+
+
rtmp_playpath
+

Stream identifier to play or to publish. This option overrides the +parameter specified in the URI. +

+
+
rtmp_subscribe
+

Name of live stream to subscribe to. By default no value will be sent. +It is only sent if the option is specified or if rtmp_live +is set to live. +

+
+
rtmp_swfhash
+

SHA256 hash of the decompressed SWF file (32 bytes). +

+
+
rtmp_swfsize
+

Size of the decompressed SWF file, required for SWFVerification. +

+
+
rtmp_swfurl
+

URL of the SWF player for the media. By default no value will be sent. +

+
+
rtmp_swfverify
+

URL to player swf file, compute hash/size automatically. +

+
+
rtmp_tcurl
+

URL of the target stream. Defaults to proto://host[:port]/app. +

+
+
+ +

For example to read with ffplay a multimedia resource named +"sample" from the application "vod" from an RTMP server "myserver": +

+
ffplay rtmp://myserver/vod/sample
+
+ +

To publish to a password protected server, passing the playpath and +app names separately: +

+
ffmpeg -re -i <input> -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@myserver/
+
+ + +

16.20 rtmpe

+ +

Encrypted Real-Time Messaging Protocol. +

+

The Encrypted Real-Time Messaging Protocol (RTMPE) is used for +streaming multimedia content within standard cryptographic primitives, +consisting of Diffie-Hellman key exchange and HMACSHA256, generating +a pair of RC4 keys. +

+ +

16.21 rtmps

+ +

Real-Time Messaging Protocol over a secure SSL connection. +

+

The Real-Time Messaging Protocol (RTMPS) is used for streaming +multimedia content across an encrypted connection. +

+ +

16.22 rtmpt

+ +

Real-Time Messaging Protocol tunneled through HTTP. +

+

The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used +for streaming multimedia content within HTTP requests to traverse +firewalls. +

+ +

16.23 rtmpte

+ +

Encrypted Real-Time Messaging Protocol tunneled through HTTP. +

+

The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE) +is used for streaming multimedia content within HTTP requests to traverse +firewalls. +

+ +

16.24 rtmpts

+ +

Real-Time Messaging Protocol tunneled through HTTPS. +

+

The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used +for streaming multimedia content within HTTPS requests to traverse +firewalls. +

+ +

16.25 libsmbclient

+ +

libsmbclient permits one to manipulate CIFS/SMB network resources. +

+

Following syntax is required. +

+
+
smb://[[domain:]user[:password@]]server[/share[/path[/file]]]
+
+ +

This protocol accepts the following options. +

+
+
timeout
+

Set timeout in milliseconds of socket I/O operations used by the underlying +low level operation. By default it is set to -1, which means that the timeout +is not specified. +

+
+
truncate
+

Truncate existing files on write, if set to 1. A value of 0 prevents +truncating. Default value is 1. +

+
+
workgroup
+

Set the workgroup used for making connections. By default workgroup is not specified. +

+
+
+ +

For more information see: http://www.samba.org/. +

+ +

16.26 libssh

+ +

Secure File Transfer Protocol via libssh +

+

Read from or write to remote resources using SFTP protocol. +

+

Following syntax is required. +

+
+
sftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg
+
+ +

This protocol accepts the following options. +

+
+
timeout
+

Set timeout of socket I/O operations used by the underlying low level +operation. By default it is set to -1, which means that the timeout +is not specified. +

+
+
truncate
+

Truncate existing files on write, if set to 1. A value of 0 prevents +truncating. Default value is 1. +

+
+
private_key
+

Specify the path of the file containing private key to use during authorization. +By default libssh searches for keys in the ~/.ssh/ directory. +

+
+
+ +

Example: Play a file stored on remote server. +

+
+
ffplay sftp://user:password@server_address:22/home/user/resource.mpeg
+
+ + +

16.27 librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte

+ +

Real-Time Messaging Protocol and its variants supported through +librtmp. +

+

Requires the presence of the librtmp headers and library during +configuration. You need to explicitly configure the build with +"–enable-librtmp". If enabled this will replace the native RTMP +protocol. +

+

This protocol provides most client functions and a few server +functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT), +encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled +variants of these encrypted types (RTMPTE, RTMPTS). +

+

The required syntax is: +

+
rtmp_proto://server[:port][/app][/playpath] options
+
+ +

where rtmp_proto is one of the strings "rtmp", "rtmpt", "rtmpe", +"rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and +server, port, app and playpath have the same +meaning as specified for the RTMP native protocol. +options contains a list of space-separated options of the form +key=val. +

+

See the librtmp manual page (man 3 librtmp) for more information. +

+

For example, to stream a file in real-time to an RTMP server using +ffmpeg: +

+
ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
+
+ +

To play the same stream using ffplay: +

+
ffplay "rtmp://myserver/live/mystream live=1"
+
+ + +

16.28 rtp

+ +

Real-time Transport Protocol. +

+

The required syntax for an RTP URL is: +rtp://hostname[:port][?option=val...] +

+

port specifies the RTP port to use. +

+

The following URL options are supported: +

+
+
ttl=n
+

Set the TTL (Time-To-Live) value (for multicast only). +

+
+
rtcpport=n
+

Set the remote RTCP port to n. +

+
+
localrtpport=n
+

Set the local RTP port to n. +

+
+
localrtcpport=n'
+

Set the local RTCP port to n. +

+
+
pkt_size=n
+

Set max packet size (in bytes) to n. +

+
+
connect=0|1
+

Do a connect() on the UDP socket (if set to 1) or not (if set +to 0). +

+
+
sources=ip[,ip]
+

List allowed source IP addresses. +

+
+
block=ip[,ip]
+

List disallowed (blocked) source IP addresses. +

+
+
write_to_source=0|1
+

Send packets to the source address of the latest received packet (if +set to 1) or to a default remote address (if set to 0). +

+
+
localport=n
+

Set the local RTP port to n. +

+

This is a deprecated option. Instead, localrtpport should be +used. +

+
+
+ +

Important notes: +

+
    +
  1. If rtcpport is not set the RTCP port will be set to the RTP +port value plus 1. + +
  2. If localrtpport (the local RTP port) is not set any available +port will be used for the local RTP and RTCP ports. + +
  3. If localrtcpport (the local RTCP port) is not set it will be +set to the local RTP port value plus 1. +
+ + +

16.29 rtsp

+ +

Real-Time Streaming Protocol. +

+

RTSP is not technically a protocol handler in libavformat, it is a demuxer +and muxer. The demuxer supports both normal RTSP (with data transferred +over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with +data transferred over RDT). +

+

The muxer can be used to send a stream using RTSP ANNOUNCE to a server +supporting it (currently Darwin Streaming Server and Mischa Spiegelmock’s +RTSP server). +

+

The required syntax for a RTSP url is: +

+
rtsp://hostname[:port]/path
+
+ +

Options can be set on the ffmpeg/ffplay command +line, or set in code via AVOptions or in +avformat_open_input. +

+

The following options are supported. +

+
+
initial_pause
+

Do not start playing the stream immediately if set to 1. Default value +is 0. +

+
+
rtsp_transport
+

Set RTSP transport protocols. +

+

It accepts the following values: +

+
‘udp’
+

Use UDP as lower transport protocol. +

+
+
‘tcp’
+

Use TCP (interleaving within the RTSP control channel) as lower +transport protocol. +

+
+
‘udp_multicast’
+

Use UDP multicast as lower transport protocol. +

+
+
‘http’
+

Use HTTP tunneling as lower transport protocol, which is useful for +passing proxies. +

+
+ +

Multiple lower transport protocols may be specified, in that case they are +tried one at a time (if the setup of one fails, the next one is tried). +For the muxer, only the ‘tcp’ and ‘udp’ options are supported. +

+
+
rtsp_flags
+

Set RTSP flags. +

+

The following values are accepted: +

+
‘filter_src’
+

Accept packets only from negotiated peer address and port. +

+
‘listen’
+

Act as a server, listening for an incoming connection. +

+
‘prefer_tcp’
+

Try TCP for RTP transport first, if TCP is available as RTSP RTP transport. +

+
+ +

Default value is ‘none’. +

+
+
allowed_media_types
+

Set media types to accept from the server. +

+

The following flags are accepted: +

+
‘video’
+
‘audio’
+
‘data’
+
+ +

By default it accepts all media types. +

+
+
min_port
+

Set minimum local UDP port. Default value is 5000. +

+
+
max_port
+

Set maximum local UDP port. Default value is 65000. +

+
+
timeout
+

Set maximum timeout (in seconds) to wait for incoming connections. +

+

A value of -1 means infinite (default). This option implies the +rtsp_flags set to ‘listen’. +

+
+
reorder_queue_size
+

Set number of packets to buffer for handling of reordered packets. +

+
+
stimeout
+

Set socket TCP I/O timeout in microseconds. +

+
+
user-agent
+

Override User-Agent header. If not specified, it defaults to the +libavformat identifier string. +

+
+ +

When receiving data over UDP, the demuxer tries to reorder received packets +(since they may arrive out of order, or packets may get lost totally). This +can be disabled by setting the maximum demuxing delay to zero (via +the max_delay field of AVFormatContext). +

+

When watching multi-bitrate Real-RTSP streams with ffplay, the +streams to display can be chosen with -vst n and +-ast n for video and audio respectively, and can be switched +on the fly by pressing v and a. +

+ +

16.29.1 Examples

+ +

The following examples all make use of the ffplay and +ffmpeg tools. +

+
    +
  • Watch a stream over UDP, with a max reordering delay of 0.5 seconds: +
    +
    ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
+
    + +
  • Watch a stream tunneled over HTTP: +
    +
    ffplay -rtsp_transport http rtsp://server/video.mp4
+
    + +
  • Send a stream in realtime to a RTSP server, for others to watch: +
    +
    ffmpeg -re -i input -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
+
    + +
  • Receive a stream in realtime: +
    +
    ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp output
+
    +
+ + +

16.30 sap

+ +

Session Announcement Protocol (RFC 2974). This is not technically a +protocol handler in libavformat, it is a muxer and demuxer. +It is used for signalling of RTP streams, by announcing the SDP for the +streams regularly on a separate port. +

+ +

16.30.1 Muxer

+ +

The syntax for a SAP url given to the muxer is: +

+
sap://destination[:port][?options]
+
+ +

The RTP packets are sent to destination on port port, +or to port 5004 if no port is specified. +options is a &-separated list. The following options +are supported: +

+
+
announce_addr=address
+

Specify the destination IP address for sending the announcements to. +If omitted, the announcements are sent to the commonly used SAP +announcement multicast address 224.2.127.254 (sap.mcast.net), or +ff0e::2:7ffe if destination is an IPv6 address. +

+
+
announce_port=port
+

Specify the port to send the announcements on, defaults to +9875 if not specified. +

+
+
ttl=ttl
+

Specify the time to live value for the announcements and RTP packets, +defaults to 255. +

+
+
same_port=0|1
+

If set to 1, send all RTP streams on the same port pair. If zero (the +default), all streams are sent on unique ports, with each stream on a +port 2 numbers higher than the previous. +VLC/Live555 requires this to be set to 1, to be able to receive the stream. +The RTP stack in libavformat for receiving requires all streams to be sent +on unique ports. +

+
+ +

Example command lines follow. +

+

To broadcast a stream on the local subnet, for watching in VLC: +

+
+
ffmpeg -re -i input -f sap sap://224.0.0.255?same_port=1
+
+ +

Similarly, for watching in ffplay: +

+
+
ffmpeg -re -i input -f sap sap://224.0.0.255
+
+ +

And for watching in ffplay, over IPv6: +

+
+
ffmpeg -re -i input -f sap sap://[ff0e::1:2:3:4]
+
+ + +

16.30.2 Demuxer

+ +

The syntax for a SAP url given to the demuxer is: +

+
sap://[address][:port]
+
+ +

address is the multicast address to listen for announcements on, +if omitted, the default 224.2.127.254 (sap.mcast.net) is used. port +is the port that is listened on, 9875 if omitted. +

+

The demuxers listens for announcements on the given address and port. +Once an announcement is received, it tries to receive that particular stream. +

+

Example command lines follow. +

+

To play back the first stream announced on the normal SAP multicast address: +

+
+
ffplay sap://
+
+ +

To play back the first stream announced on one the default IPv6 SAP multicast address: +

+
+
ffplay sap://[ff0e::2:7ffe]
+
+ + +

16.31 sctp

+ +

Stream Control Transmission Protocol. +

+

The accepted URL syntax is: +

+
sctp://host:port[?options]
+
+ +

The protocol accepts the following options: +

+
listen
+

If set to any value, listen for an incoming connection. Outgoing connection is done by default. +

+
+
max_streams
+

Set the maximum number of streams. By default no limit is set. +

+
+ + +

16.32 srt

+ +

Haivision Secure Reliable Transport Protocol via libsrt. +

+

The supported syntax for a SRT URL is: +

+
srt://hostname:port[?options]
+
+ +

options contains a list of &-separated options of the form +key=val. +

+

or +

+
+
options srt://hostname:port
+
+ +

options contains a list of ’-key val’ +options. +

+

This protocol accepts the following options. +

+
+
connect_timeout=milliseconds
+

Connection timeout; SRT cannot connect for RTT > 1500 msec +(2 handshake exchanges) with the default connect timeout of +3 seconds. This option applies to the caller and rendezvous +connection modes. The connect timeout is 10 times the value +set for the rendezvous mode (which can be used as a +workaround for this connection problem with earlier versions). +

+
+
ffs=bytes
+

Flight Flag Size (Window Size), in bytes. FFS is actually an +internal parameter and you should set it to not less than +recv_buffer_size and mss. The default value +is relatively large, therefore unless you set a very large receiver buffer, +you do not need to change this option. Default value is 25600. +

+
+
inputbw=bytes/seconds
+

Sender nominal input rate, in bytes per seconds. Used along with +oheadbw, when maxbw is set to relative (0), to +calculate maximum sending rate when recovery packets are sent +along with the main media stream: +inputbw * (100 + oheadbw) / 100 +if inputbw is not set while maxbw is set to +relative (0), the actual input rate is evaluated inside +the library. Default value is 0. +

+
+
iptos=tos
+

IP Type of Service. Applies to sender only. Default value is 0xB8. +

+
+
ipttl=ttl
+

IP Time To Live. Applies to sender only. Default value is 64. +

+
+
latency=microseconds
+

Timestamp-based Packet Delivery Delay. +Used to absorb bursts of missed packet retransmissions. +This flag sets both rcvlatency and peerlatency +to the same value. Note that prior to version 1.3.0 +this is the only flag to set the latency, however +this is effectively equivalent to setting peerlatency, +when side is sender and rcvlatency +when side is receiver, and the bidirectional stream +sending is not supported. +

+
+
listen_timeout=microseconds
+

Set socket listen timeout. +

+
+
maxbw=bytes/seconds
+

Maximum sending bandwidth, in bytes per seconds. +-1 infinite (CSRTCC limit is 30mbps) +0 relative to input rate (see inputbw) +>0 absolute limit value +Default value is 0 (relative) +

+
+
mode=caller|listener|rendezvous
+

Connection mode. +caller opens client connection. +listener starts server to listen for incoming connections. +rendezvous use Rendez-Vous connection mode. +Default value is caller. +

+
+
mss=bytes
+

Maximum Segment Size, in bytes. Used for buffer allocation +and rate calculation using a packet counter assuming fully +filled packets. The smallest MSS between the peers is +used. This is 1500 by default in the overall internet. +This is the maximum size of the UDP packet and can be +only decreased, unless you have some unusual dedicated +network settings. Default value is 1500. +

+
+
nakreport=1|0
+

If set to 1, Receiver will send ‘UMSG_LOSSREPORT‘ messages +periodically until a lost packet is retransmitted or +intentionally dropped. Default value is 1. +

+
+
oheadbw=percents
+

Recovery bandwidth overhead above input rate, in percents. +See inputbw. Default value is 25%. +

+
+
passphrase=string
+

HaiCrypt Encryption/Decryption Passphrase string, length +from 10 to 79 characters. The passphrase is the shared +secret between the sender and the receiver. It is used +to generate the Key Encrypting Key using PBKDF2 +(Password-Based Key Derivation Function). It is used +only if pbkeylen is non-zero. It is used on +the receiver only if the received data is encrypted. +The configured passphrase cannot be recovered (write-only). +

+
+
enforced_encryption=1|0
+

If true, both connection parties must have the same password +set (including empty, that is, with no encryption). If the +password doesn’t match or only one side is unencrypted, +the connection is rejected. Default is true. +

+
+
kmrefreshrate=packets
+

The number of packets to be transmitted after which the +encryption key is switched to a new key. Default is -1. +-1 means auto (0x1000000 in srt library). The range for +this option is integers in the 0 - INT_MAX. +

+
+
kmpreannounce=packets
+

The interval between when a new encryption key is sent and +when switchover occurs. This value also applies to the +subsequent interval between when switchover occurs and +when the old encryption key is decommissioned. Default is -1. +-1 means auto (0x1000 in srt library). The range for +this option is integers in the 0 - INT_MAX. +

+
+
payload_size=bytes
+

Sets the maximum declared size of a packet transferred +during the single call to the sending function in Live +mode. Use 0 if this value isn’t used (which is default in +file mode). +Default is -1 (automatic), which typically means MPEG-TS; +if you are going to use SRT +to send any different kind of payload, such as, for example, +wrapping a live stream in very small frames, then you can +use a bigger maximum frame size, though not greater than +1456 bytes. +

+
+
pkt_size=bytes
+

Alias for ‘payload_size’. +

+
+
peerlatency=microseconds
+

The latency value (as described in rcvlatency) that is +set by the sender side as a minimum value for the receiver. +

+
+
pbkeylen=bytes
+

Sender encryption key length, in bytes. +Only can be set to 0, 16, 24 and 32. +Enable sender encryption if not 0. +Not required on receiver (set to 0), +key size obtained from sender in HaiCrypt handshake. +Default value is 0. +

+
+
rcvlatency=microseconds
+

The time that should elapse since the moment when the +packet was sent and the moment when it’s delivered to +the receiver application in the receiving function. +This time should be a buffer time large enough to cover +the time spent for sending, unexpectedly extended RTT +time, and the time needed to retransmit the lost UDP +packet. The effective latency value will be the maximum +of this options’ value and the value of peerlatency +set by the peer side. Before version 1.3.0 this option +is only available as latency. +

+
+
recv_buffer_size=bytes
+

Set UDP receive buffer size, expressed in bytes. +

+
+
send_buffer_size=bytes
+

Set UDP send buffer size, expressed in bytes. +

+
+
timeout=microseconds
+

Set raise error timeouts for read, write and connect operations. Note that the +SRT library has internal timeouts which can be controlled separately, the +value set here is only a cap on those. +

+
+
tlpktdrop=1|0
+

Too-late Packet Drop. When enabled on receiver, it skips +missing packets that have not been delivered in time and +delivers the following packets to the application when +their time-to-play has come. It also sends a fake ACK to +the sender. When enabled on sender and enabled on the +receiving peer, the sender drops the older packets that +have no chance of being delivered in time. It was +automatically enabled in the sender if the receiver +supports it. +

+
+
sndbuf=bytes
+

Set send buffer size, expressed in bytes. +

+
+
rcvbuf=bytes
+

Set receive buffer size, expressed in bytes. +

+

Receive buffer must not be greater than ffs. +

+
+
lossmaxttl=packets
+

The value up to which the Reorder Tolerance may grow. When +Reorder Tolerance is > 0, then packet loss report is delayed +until that number of packets come in. Reorder Tolerance +increases every time a "belated" packet has come, but it +wasn’t due to retransmission (that is, when UDP packets tend +to come out of order), with the difference between the latest +sequence and this packet’s sequence, and not more than the +value of this option. By default it’s 0, which means that this +mechanism is turned off, and the loss report is always sent +immediately upon experiencing a "gap" in sequences. +

+
+
minversion
+

The minimum SRT version that is required from the peer. A connection +to a peer that does not satisfy the minimum version requirement +will be rejected. +

+

The version format in hex is 0xXXYYZZ for x.y.z in human readable +form. +

+
+
streamid=string
+

A string limited to 512 characters that can be set on the socket prior +to connecting. This stream ID will be able to be retrieved by the +listener side from the socket that is returned from srt_accept and +was connected by a socket with that set stream ID. SRT does not enforce +any special interpretation of the contents of this string. +This option doesn’t make sense in Rendezvous connection; the result +might be that simply one side will override the value from the other +side and it’s the matter of luck which one would win +

+
+
smoother=live|file
+

The type of Smoother used for the transmission for that socket, which +is responsible for the transmission and congestion control. The Smoother +type must be exactly the same on both connecting parties, otherwise +the connection is rejected. +

+
+
messageapi=1|0
+

When set, this socket uses the Message API, otherwise it uses Buffer +API. Note that in live mode (see transtype) there’s only +message API available. In File mode you can chose to use one of two modes: +

+

Stream API (default, when this option is false). In this mode you may +send as many data as you wish with one sending instruction, or even use +dedicated functions that read directly from a file. The internal facility +will take care of any speed and congestion control. When receiving, you +can also receive as many data as desired, the data not extracted will be +waiting for the next call. There is no boundary between data portions in +the Stream mode. +

+

Message API. In this mode your single sending instruction passes exactly +one piece of data that has boundaries (a message). Contrary to Live mode, +this message may span across multiple UDP packets and the only size +limitation is that it shall fit as a whole in the sending buffer. The +receiver shall use as large buffer as necessary to receive the message, +otherwise the message will not be given up. When the message is not +complete (not all packets received or there was a packet loss) it will +not be given up. +

+
+
transtype=live|file
+

Sets the transmission type for the socket, in particular, setting this +option sets multiple other parameters to their default values as required +for a particular transmission type. +

+

live: Set options as for live transmission. In this mode, you should +send by one sending instruction only so many data that fit in one UDP packet, +and limited to the value defined first in payload_size (1316 is +default in this mode). There is no speed control in this mode, only the +bandwidth control, if configured, in order to not exceed the bandwidth with +the overhead transmission (retransmitted and control packets). +

+

file: Set options as for non-live transmission. See messageapi +for further explanations +

+
+
linger=seconds
+

The number of seconds that the socket waits for unsent data when closing. +Default is -1. -1 means auto (off with 0 seconds in live mode, on with 180 +seconds in file mode). The range for this option is integers in the +0 - INT_MAX. +

+
+
+ +

For more information see: https://github.com/Haivision/srt. +

+ +

16.33 srtp

+ +

Secure Real-time Transport Protocol. +

+

The accepted options are: +

+
srtp_in_suite
+
srtp_out_suite
+

Select input and output encoding suites. +

+

Supported values: +

+
‘AES_CM_128_HMAC_SHA1_80’
+
‘SRTP_AES128_CM_HMAC_SHA1_80’
+
‘AES_CM_128_HMAC_SHA1_32’
+
‘SRTP_AES128_CM_HMAC_SHA1_32’
+
+ +
+
srtp_in_params
+
srtp_out_params
+

Set input and output encoding parameters, which are expressed by a +base64-encoded representation of a binary block. The first 16 bytes of +this binary block are used as master key, the following 14 bytes are +used as master salt. +

+
+ + +

16.34 subfile

+ +

Virtually extract a segment of a file or another stream. +The underlying stream must be seekable. +

+

Accepted options: +

+
start
+

Start offset of the extracted segment, in bytes. +

+
end
+

End offset of the extracted segment, in bytes. +If set to 0, extract till end of file. +

+
+ +

Examples: +

+

Extract a chapter from a DVD VOB file (start and end sectors obtained +externally and multiplied by 2048): +

+
subfile,,start,153391104,end,268142592,,:/media/dvd/VIDEO_TS/VTS_08_1.VOB
+
+ +

Play an AVI file directly from a TAR archive: +

+
subfile,,start,183241728,end,366490624,,:archive.tar
+
+ +

Play a MPEG-TS file from start offset till end: +

+
subfile,,start,32815239,end,0,,:video.ts
+
+ + +

16.35 tee

+ +

Writes the output to multiple protocols. The individual outputs are separated +by | +

+
+
tee:file://path/to/local/this.avi|file://path/to/local/that.avi
+
+ + +

16.36 tcp

+ +

Transmission Control Protocol. +

+

The required syntax for a TCP url is: +

+
tcp://hostname:port[?options]
+
+ +

options contains a list of &-separated options of the form +key=val. +

+

The list of supported options follows. +

+
+
listen=1|0
+

Listen for an incoming connection. Default value is 0. +

+
+
timeout=microseconds
+

Set raise error timeout, expressed in microseconds. +

+

This option is only relevant in read mode: if no data arrived in more +than this time interval, raise error. +

+
+
listen_timeout=milliseconds
+

Set listen timeout, expressed in milliseconds. +

+
+
recv_buffer_size=bytes
+

Set receive buffer size, expressed bytes. +

+
+
send_buffer_size=bytes
+

Set send buffer size, expressed bytes. +

+
+
tcp_nodelay=1|0
+

Set TCP_NODELAY to disable Nagle’s algorithm. Default value is 0. +

+
+
tcp_mss=bytes
+

Set maximum segment size for outgoing TCP packets, expressed in bytes. +

+
+ +

The following example shows how to setup a listening TCP connection +with ffmpeg, which is then accessed with ffplay: +

+
ffmpeg -i input -f format tcp://hostname:port?listen
+ffplay tcp://hostname:port
+
+ + +

16.37 tls

+ +

Transport Layer Security (TLS) / Secure Sockets Layer (SSL) +

+

The required syntax for a TLS/SSL url is: +

+
tls://hostname:port[?options]
+
+ +

The following parameters can be set via command line options +(or in code via AVOptions): +

+
+
ca_file, cafile=filename
+

A file containing certificate authority (CA) root certificates to treat +as trusted. If the linked TLS library contains a default this might not +need to be specified for verification to work, but not all libraries and +setups have defaults built in. +The file must be in OpenSSL PEM format. +

+
+
tls_verify=1|0
+

If enabled, try to verify the peer that we are communicating with. +Note, if using OpenSSL, this currently only makes sure that the +peer certificate is signed by one of the root certificates in the CA +database, but it does not validate that the certificate actually +matches the host name we are trying to connect to. (With other backends, +the host name is validated as well.) +

+

This is disabled by default since it requires a CA database to be +provided by the caller in many cases. +

+
+
cert_file, cert=filename
+

A file containing a certificate to use in the handshake with the peer. +(When operating as server, in listen mode, this is more often required +by the peer, while client certificates only are mandated in certain +setups.) +

+
+
key_file, key=filename
+

A file containing the private key for the certificate. +

+
+
listen=1|0
+

If enabled, listen for connections on the provided port, and assume +the server role in the handshake instead of the client role. +

+
+
+ +

Example command lines: +

+

To create a TLS/SSL server that serves an input stream. +

+
+
ffmpeg -i input -f format tls://hostname:port?listen&cert=server.crt&key=server.key
+
+ +

To play back a stream from the TLS/SSL server using ffplay: +

+
+
ffplay tls://hostname:port
+
+ + +

16.38 udp

+ +

User Datagram Protocol. +

+

The required syntax for an UDP URL is: +

+
udp://hostname:port[?options]
+
+ +

options contains a list of &-separated options of the form key=val. +

+

In case threading is enabled on the system, a circular buffer is used +to store the incoming data, which allows one to reduce loss of data due to +UDP socket buffer overruns. The fifo_size and +overrun_nonfatal options are related to this buffer. +

+

The list of supported options follows. +

+
+
buffer_size=size
+

Set the UDP maximum socket buffer size in bytes. This is used to set either +the receive or send buffer size, depending on what the socket is used for. +Default is 32 KB for output, 384 KB for input. See also fifo_size. +

+
+
bitrate=bitrate
+

If set to nonzero, the output will have the specified constant bitrate if the +input has enough packets to sustain it. +

+
+
burst_bits=bits
+

When using bitrate this specifies the maximum number of bits in +packet bursts. +

+
+
localport=port
+

Override the local UDP port to bind with. +

+
+
localaddr=addr
+

Local IP address of a network interface used for sending packets or joining +multicast groups. +

+
+
pkt_size=size
+

Set the size in bytes of UDP packets. +

+
+
reuse=1|0
+

Explicitly allow or disallow reusing UDP sockets. +

+
+
ttl=ttl
+

Set the time to live value (for multicast only). +

+
+
connect=1|0
+

Initialize the UDP socket with connect(). In this case, the +destination address can’t be changed with ff_udp_set_remote_url later. +If the destination address isn’t known at the start, this option can +be specified in ff_udp_set_remote_url, too. +This allows finding out the source address for the packets with getsockname, +and makes writes return with AVERROR(ECONNREFUSED) if "destination +unreachable" is received. +For receiving, this gives the benefit of only receiving packets from +the specified peer address/port. +

+
+
sources=address[,address]
+

Only receive packets sent from the specified addresses. In case of multicast, +also subscribe to multicast traffic coming from these addresses only. +

+
+
block=address[,address]
+

Ignore packets sent from the specified addresses. In case of multicast, also +exclude the source addresses in the multicast subscription. +

+
+
fifo_size=units
+

Set the UDP receiving circular buffer size, expressed as a number of +packets with size of 188 bytes. If not specified defaults to 7*4096. +

+
+
overrun_nonfatal=1|0
+

Survive in case of UDP receiving circular buffer overrun. Default +value is 0. +

+
+
timeout=microseconds
+

Set raise error timeout, expressed in microseconds. +

+

This option is only relevant in read mode: if no data arrived in more +than this time interval, raise error. +

+
+
broadcast=1|0
+

Explicitly allow or disallow UDP broadcasting. +

+

Note that broadcasting may not work properly on networks having +a broadcast storm protection. +

+
+ + +

16.38.1 Examples

+ +
    +
  • Use ffmpeg to stream over UDP to a remote endpoint: +
    +
    ffmpeg -i input -f format udp://hostname:port
+
    + +
  • Use ffmpeg to stream in mpegts format over UDP using 188 +sized UDP packets, using a large input buffer: +
    +
    ffmpeg -i input -f mpegts udp://hostname:port?pkt_size=188&buffer_size=65535
+
    + +
  • Use ffmpeg to receive over UDP from a remote endpoint: +
    +
    ffmpeg -i udp://[multicast-address]:port ...
+
    +
+ + +

16.39 unix

+ +

Unix local socket +

+

The required syntax for a Unix socket URL is: +

+
+
unix://filepath
+
+ +

The following parameters can be set via command line options +(or in code via AVOptions): +

+
+
timeout
+

Timeout in ms. +

+
listen
+

Create the Unix socket in listening mode. +

+
+ + +

16.40 zmq

+ +

ZeroMQ asynchronous messaging using the libzmq library. +

+

This library supports unicast streaming to multiple clients without relying on +an external server. +

+

The required syntax for streaming or connecting to a stream is: +

+
zmq:tcp://ip-address:port
+
+ +

Example: +Create a localhost stream on port 5555: +

+
ffmpeg -re -i input -f mpegts zmq:tcp://127.0.0.1:5555
+
+ +

Multiple clients may connect to the stream using: +

+
ffplay zmq:tcp://127.0.0.1:5555
+
+ +

Streaming to multiple clients is implemented using a ZeroMQ Pub-Sub pattern. +The server side binds to a port and publishes data. Clients connect to the +server (via IP address/port) and subscribe to the stream. The order in which +the server and client start generally does not matter. +

+

ffmpeg must be compiled with the –enable-libzmq option to support +this protocol. +

+

Options can be set on the ffmpeg/ffplay command +line. The following options are supported: +

+
+
pkt_size
+

Forces the maximum packet size for sending/receiving data. The default value is +131,072 bytes. On the server side, this sets the maximum size of sent packets +via ZeroMQ. On the clients, it sets an internal buffer size for receiving +packets. Note that pkt_size on the clients should be equal to or greater than +pkt_size on the server. Otherwise the received message may be truncated causing +decoding errors. +

+
+
+ + + +

17 Device Options

+ +

The libavdevice library provides the same interface as +libavformat. Namely, an input device is considered like a demuxer, and +an output device like a muxer, and the interface and generic device +options are the same provided by libavformat (see the ffmpeg-formats +manual). +

+

In addition each input or output device may support so-called private +options, which are specific for that component. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the device +AVFormatContext options or using the libavutil/opt.h API +for programmatic use. +

+ + +

18 Input Devices

+ +

Input devices are configured elements in FFmpeg which enable accessing +the data coming from a multimedia device attached to your system. +

+

When you configure your FFmpeg build, all the supported input devices +are enabled by default. You can list all available ones using the +configure option "–list-indevs". +

+

You can disable all the input devices using the configure option +"–disable-indevs", and selectively enable an input device using the +option "–enable-indev=INDEV", or you can disable a particular +input device using the option "–disable-indev=INDEV". +

+

The option "-devices" of the ff* tools will display the list of +supported input devices. +

+

A description of the currently available input devices follows. +

+ +

18.1 alsa

+ +

ALSA (Advanced Linux Sound Architecture) input device. +

+

To enable this input device during configuration you need libasound +installed on your system. +

+

This device allows capturing from an ALSA device. The name of the +device to capture has to be an ALSA card identifier. +

+

An ALSA identifier has the syntax: +

+
hw:CARD[,DEV[,SUBDEV]]
+
+ +

where the DEV and SUBDEV components are optional. +

+

The three arguments (in order: CARD,DEV,SUBDEV) +specify card number or identifier, device number and subdevice number +(-1 means any). +

+

To see the list of cards currently recognized by your system check the +files /proc/asound/cards and /proc/asound/devices. +

+

For example to capture with ffmpeg from an ALSA device with +card id 0, you may run the command: +

+
ffmpeg -f alsa -i hw:0 alsaout.wav
+
+ +

For more information see: +http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html +

+ +

18.1.1 Options

+ +
+
sample_rate
+

Set the sample rate in Hz. Default is 48000. +

+
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

18.2 android_camera

+ +

Android camera input device. +

+

This input devices uses the Android Camera2 NDK API which is +available on devices with API level 24+. The availability of +android_camera is autodetected during configuration. +

+

This device allows capturing from all cameras on an Android device, +which are integrated into the Camera2 NDK API. +

+

The available cameras are enumerated internally and can be selected +with the camera_index parameter. The input file string is +discarded. +

+

Generally the back facing camera has index 0 while the front facing +camera has index 1. +

+ +

18.2.1 Options

+ +
+
video_size
+

Set the video size given as a string such as 640x480 or hd720. +Falls back to the first available configuration reported by +Android if requested video size is not available or by default. +

+
+
framerate
+

Set the video framerate. +Falls back to the first available configuration reported by +Android if requested framerate is not available or by default (-1). +

+
+
camera_index
+

Set the index of the camera to use. Default is 0. +

+
+
input_queue_size
+

Set the maximum number of frames to buffer. Default is 5. +

+
+
+ + +

18.3 avfoundation

+ +

AVFoundation input device. +

+

AVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX >= 10.7 as well as on iOS. +

+

The input filename has to be given in the following syntax: +

+
-i "[[VIDEO]:[AUDIO]]"
+
+

The first entry selects the video input while the latter selects the audio input. +The stream has to be specified by the device name or the device index as shown by the device list. +Alternatively, the video and/or audio input device can be chosen by index using the + + -video_device_index <INDEX> + +and/or + + -audio_device_index <INDEX> + +, overriding any +device name or index given in the input filename. +

+

All available devices can be enumerated by using -list_devices true, listing +all device names and corresponding indices. +

+

There are two device name aliases: +

+
default
+

Select the AVFoundation default device of the corresponding type. +

+
+
none
+

Do not record the corresponding media type. +This is equivalent to specifying an empty device name or index. +

+
+
+ + +

18.3.1 Options

+ +

AVFoundation supports the following options: +

+
+
-list_devices <TRUE|FALSE>
+

If set to true, a list of all available input devices is given showing all +device names and indices. +

+
+
-video_device_index <INDEX>
+

Specify the video device by its index. Overrides anything given in the input filename. +

+
+
-audio_device_index <INDEX>
+

Specify the audio device by its index. Overrides anything given in the input filename. +

+
+
-pixel_format <FORMAT>
+

Request the video device to use a specific pixel format. +If the specified format is not supported, a list of available formats is given +and the first one in this list is used instead. Available pixel formats are: +monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0, + bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10, + yuv420p, nv12, yuyv422, gray +

+
+
-framerate
+

Set the grabbing frame rate. Default is ntsc, corresponding to a +frame rate of 30000/1001. +

+
+
-video_size
+

Set the video frame size. +

+
+
-capture_cursor
+

Capture the mouse pointer. Default is 0. +

+
+
-capture_mouse_clicks
+

Capture the screen mouse clicks. Default is 0. +

+
+
-capture_raw_data
+

Capture the raw device data. Default is 0. +Using this option may result in receiving the underlying data delivered to the AVFoundation framework. E.g. for muxed devices that sends raw DV data to the framework (like tape-based camcorders), setting this option to false results in extracted video frames captured in the designated pixel format only. Setting this option to true results in receiving the raw DV stream untouched. +

+
+ + +

18.3.2 Examples

+ +
    +
  • Print the list of AVFoundation supported devices and exit: +
    +
    $ ffmpeg -f avfoundation -list_devices true -i ""
+
    + +
  • Record video from video device 0 and audio from audio device 0 into out.avi: +
    +
    $ ffmpeg -f avfoundation -i "0:0" out.avi
+
    + +
  • Record video from video device 2 and audio from audio device 1 into out.avi: +
    +
    $ ffmpeg -f avfoundation -video_device_index 2 -i ":1" out.avi
+
    + +
  • Record video from the system default video device using the pixel format bgr0 and do not record any audio into out.avi: +
    +
    $ ffmpeg -f avfoundation -pixel_format bgr0 -i "default:none" out.avi
+
    + +
  • Record raw DV data from a suitable input device and write the output into out.dv: +
    +
    $ ffmpeg -f avfoundation -capture_raw_data true -i "zr100:none" out.dv
+
    + + +
+ + +

18.4 bktr

+ +

BSD video input device. +

+ +

18.4.1 Options

+ +
+
framerate
+

Set the frame rate. +

+
+
video_size
+

Set the video frame size. Default is vga. +

+
+
standard
+
+

Available values are: +

+
‘pal’
+
‘ntsc’
+
‘secam’
+
‘paln’
+
‘palm’
+
‘ntscj’
+
+ +
+
+ + +

18.5 decklink

+ +

The decklink input device provides capture capabilities for Blackmagic +DeckLink devices. +

+

To enable this input device, you need the Blackmagic DeckLink SDK and you +need to configure with the appropriate --extra-cflags +and --extra-ldflags. +On Windows, you need to run the IDL files through widl. +

+

DeckLink is very picky about the formats it supports. Pixel format of the +input can be set with raw_format. +Framerate and video size must be determined for your device with +-list_formats 1. Audio sample rate is always 48 kHz and the number +of channels can be 2, 8 or 16. Note that all audio channels are bundled in one single +audio track. +

+ +

18.5.1 Options

+ +
+
list_devices
+

If set to true, print a list of devices and exit. +Defaults to false. This option is deprecated, please use the +-sources option of ffmpeg to list the available input devices. +

+
+
list_formats
+

If set to true, print a list of supported formats and exit. +Defaults to false. +

+
+
format_code <FourCC>
+

This sets the input video format to the format given by the FourCC. To see +the supported values of your device(s) use list_formats. +Note that there is a FourCC 'pal ' that can also be used +as pal (3 letters). +Default behavior is autodetection of the input video format, if the hardware +supports it. +

+
+
raw_format
+

Set the pixel format of the captured video. +Available values are: +

+
‘uyvy422’
+
‘yuv422p10’
+
‘argb’
+
‘bgra’
+
‘rgb10’
+
+ +
+
teletext_lines
+

If set to nonzero, an additional teletext stream will be captured from the +vertical ancillary data. Both SD PAL (576i) and HD (1080i or 1080p) +sources are supported. In case of HD sources, OP47 packets are decoded. +

+

This option is a bitmask of the SD PAL VBI lines captured, specifically lines 6 +to 22, and lines 318 to 335. Line 6 is the LSB in the mask. Selected lines +which do not contain teletext information will be ignored. You can use the +special all constant to select all possible lines, or +standard to skip lines 6, 318 and 319, which are not compatible with +all receivers. +

+

For SD sources, ffmpeg needs to be compiled with --enable-libzvbi. For +HD sources, on older (pre-4K) DeckLink card models you have to capture in 10 +bit mode. +

+
+
channels
+

Defines number of audio channels to capture. Must be ‘2’, ‘8’ or ‘16’. +Defaults to ‘2’. +

+
+
duplex_mode
+

Sets the decklink device duplex mode. Must be ‘unset’, ‘half’ or ‘full’. +Defaults to ‘unset’. +

+
+
timecode_format
+

Timecode type to include in the frame and video stream metadata. Must be +‘none’, ‘rp188vitc’, ‘rp188vitc2’, ‘rp188ltc’, +‘rp188any’, ‘vitc’, ‘vitc2’, or ‘serial’. Defaults to +‘none’ (not included). +

+
+
video_input
+

Sets the video input source. Must be ‘unset’, ‘sdi’, ‘hdmi’, +‘optical_sdi’, ‘component’, ‘composite’ or ‘s_video’. +Defaults to ‘unset’. +

+
+
audio_input
+

Sets the audio input source. Must be ‘unset’, ‘embedded’, +‘aes_ebu’, ‘analog’, ‘analog_xlr’, ‘analog_rca’ or +‘microphone’. Defaults to ‘unset’. +

+
+
video_pts
+

Sets the video packet timestamp source. Must be ‘video’, ‘audio’, +‘reference’, ‘wallclock’ or ‘abs_wallclock’. +Defaults to ‘video’. +

+
+
audio_pts
+

Sets the audio packet timestamp source. Must be ‘video’, ‘audio’, +‘reference’, ‘wallclock’ or ‘abs_wallclock’. +Defaults to ‘audio’. +

+
+
draw_bars
+

If set to ‘true’, color bars are drawn in the event of a signal loss. +Defaults to ‘true’. +

+
+
queue_size
+

Sets maximum input buffer size in bytes. If the buffering reaches this value, +incoming frames will be dropped. +Defaults to ‘1073741824’. +

+
+
audio_depth
+

Sets the audio sample bit depth. Must be ‘16’ or ‘32’. +Defaults to ‘16’. +

+
+
decklink_copyts
+

If set to true, timestamps are forwarded as they are without removing +the initial offset. +Defaults to false. +

+
+
timestamp_align
+

Capture start time alignment in seconds. If set to nonzero, input frames are +dropped till the system timestamp aligns with configured value. +Alignment difference of up to one frame duration is tolerated. +This is useful for maintaining input synchronization across N different +hardware devices deployed for ’N-way’ redundancy. The system time of different +hardware devices should be synchronized with protocols such as NTP or PTP, +before using this option. +Note that this method is not foolproof. In some border cases input +synchronization may not happen due to thread scheduling jitters in the OS. +Either sync could go wrong by 1 frame or in a rarer case +timestamp_align seconds. +Defaults to ‘0’. +

+
+
wait_for_tc (bool)
+

Drop frames till a frame with timecode is received. Sometimes serial timecode +isn’t received with the first input frame. If that happens, the stored stream +timecode will be inaccurate. If this option is set to true, input frames +are dropped till a frame with timecode is received. +Option timecode_format must be specified. +Defaults to false. +

+
+
+ + +

18.5.2 Examples

+ +
    +
  • List input devices: +
    +
    ffmpeg -sources decklink
+
    + +
  • List supported formats: +
    +
    ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
+
    + +
  • Capture video clip at 1080i50: +
    +
    ffmpeg -format_code Hi50 -f decklink -i 'Intensity Pro' -c:a copy -c:v copy output.avi
+
    + +
  • Capture video clip at 1080i50 10 bit: +
    +
    ffmpeg -raw_format yuv422p10 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi
+
    + +
  • Capture video clip at 1080i50 with 16 audio channels: +
    +
    ffmpeg -channels 16 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi
+
    + +
+ + +

18.6 dshow

+ +

Windows DirectShow input device. +

+

DirectShow support is enabled when FFmpeg is built with the mingw-w64 project. +Currently only audio and video devices are supported. +

+

Multiple devices may be opened as separate inputs, but they may also be +opened on the same input, which should improve synchronism between them. +

+

The input name should be in the format: +

+
+
TYPE=NAME[:TYPE=NAME]
+
+ +

where TYPE can be either audio or video, +and NAME is the device’s name or alternative name.. +

+ +

18.6.1 Options

+ +

If no options are specified, the device’s defaults are used. +If the device does not support the requested options, it will +fail to open. +

+
+
video_size
+

Set the video size in the captured video. +

+
+
framerate
+

Set the frame rate in the captured video. +

+
+
sample_rate
+

Set the sample rate (in Hz) of the captured audio. +

+
+
sample_size
+

Set the sample size (in bits) of the captured audio. +

+
+
channels
+

Set the number of channels in the captured audio. +

+
+
list_devices
+

If set to true, print a list of devices and exit. +

+
+
list_options
+

If set to true, print a list of selected device’s options +and exit. +

+
+
video_device_number
+

Set video device number for devices with the same name (starts at 0, +defaults to 0). +

+
+
audio_device_number
+

Set audio device number for devices with the same name (starts at 0, +defaults to 0). +

+
+
pixel_format
+

Select pixel format to be used by DirectShow. This may only be set when +the video codec is not set or set to rawvideo. +

+
+
audio_buffer_size
+

Set audio device buffer size in milliseconds (which can directly +impact latency, depending on the device). +Defaults to using the audio device’s +default buffer size (typically some multiple of 500ms). +Setting this value too low can degrade performance. +See also +http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx +

+
+
video_pin_name
+

Select video capture pin to use by name or alternative name. +

+
+
audio_pin_name
+

Select audio capture pin to use by name or alternative name. +

+
+
crossbar_video_input_pin_number
+

Select video input pin number for crossbar device. This will be +routed to the crossbar device’s Video Decoder output pin. +Note that changing this value can affect future invocations +(sets a new default) until system reboot occurs. +

+
+
crossbar_audio_input_pin_number
+

Select audio input pin number for crossbar device. This will be +routed to the crossbar device’s Audio Decoder output pin. +Note that changing this value can affect future invocations +(sets a new default) until system reboot occurs. +

+
+
show_video_device_dialog
+

If set to true, before capture starts, popup a display dialog +to the end user, allowing them to change video filter properties +and configurations manually. +Note that for crossbar devices, adjusting values in this dialog +may be needed at times to toggle between PAL (25 fps) and NTSC (29.97) +input frame rates, sizes, interlacing, etc. Changing these values can +enable different scan rates/frame rates and avoiding green bars at +the bottom, flickering scan lines, etc. +Note that with some devices, changing these properties can also affect future +invocations (sets new defaults) until system reboot occurs. +

+
+
show_audio_device_dialog
+

If set to true, before capture starts, popup a display dialog +to the end user, allowing them to change audio filter properties +and configurations manually. +

+
+
show_video_crossbar_connection_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify crossbar pin routings, when it opens a video device. +

+
+
show_audio_crossbar_connection_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify crossbar pin routings, when it opens an audio device. +

+
+
show_analog_tv_tuner_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify TV channels and frequencies. +

+
+
show_analog_tv_tuner_audio_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify TV audio (like mono vs. stereo, Language A,B or C). +

+
+
audio_device_load
+

Load an audio capture filter device from file instead of searching +it by name. It may load additional parameters too, if the filter +supports the serialization of its properties to. +To use this an audio capture source has to be specified, but it can +be anything even fake one. +

+
+
audio_device_save
+

Save the currently used audio capture filter device and its +parameters (if the filter supports it) to a file. +If a file with the same name exists it will be overwritten. +

+
+
video_device_load
+

Load a video capture filter device from file instead of searching +it by name. It may load additional parameters too, if the filter +supports the serialization of its properties to. +To use this a video capture source has to be specified, but it can +be anything even fake one. +

+
+
video_device_save
+

Save the currently used video capture filter device and its +parameters (if the filter supports it) to a file. +If a file with the same name exists it will be overwritten. +

+
+
+ + +

18.6.2 Examples

+ +
    +
  • Print the list of DirectShow supported devices and exit: +
    +
    $ ffmpeg -list_devices true -f dshow -i dummy
+
    + +
  • Open video device Camera: +
    +
    $ ffmpeg -f dshow -i video="Camera"
+
    + +
  • Open second video device with name Camera: +
    +
    $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
+
    + +
  • Open video device Camera and audio device Microphone: +
    +
    $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
+
    + +
  • Print the list of supported options in selected device and exit: +
    +
    $ ffmpeg -list_options true -f dshow -i video="Camera"
+
    + +
  • Specify pin names to capture by name or alternative name, specify alternative device name: +
    +
    $ ffmpeg -f dshow -audio_pin_name "Audio Out" -video_pin_name 2 -i video=video="@device_pnp_\\?\pci#ven_1a0a&dev_6200&subsys_62021461&rev_01#4&e2c7dd6&0&00e1#{65e8773d-8f56-11d0-a3b9-00a0c9223196}\{ca465100-deb0-4d59-818f-8c477184adf6}":audio="Microphone"
+
    + +
  • Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup: +
    +
    $ ffmpeg -f dshow -show_video_device_dialog true -crossbar_video_input_pin_number 0
+     -crossbar_audio_input_pin_number 3 -i video="AVerMedia BDA Analog Capture":audio="AVerMedia BDA Analog Capture"
+
    + +
+ + +

18.7 fbdev

+ +

Linux framebuffer input device. +

+

The Linux framebuffer is a graphic hardware-independent abstraction +layer to show graphics on a computer monitor, typically on the +console. It is accessed through a file device node, usually +/dev/fb0. +

+

For more detailed information read the file +Documentation/fb/framebuffer.txt included in the Linux source tree. +

+

See also http://linux-fbdev.sourceforge.net/, and fbset(1). +

+

To record from the framebuffer device /dev/fb0 with +ffmpeg: +

+
ffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi
+
+ +

You can take a single screenshot image with the command: +

+
ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
+
+ + +

18.7.1 Options

+ +
+
framerate
+

Set the frame rate. Default is 25. +

+
+
+ + +

18.8 gdigrab

+ +

Win32 GDI-based screen capture device. +

+

This device allows you to capture a region of the display on Windows. +

+

There are two options for the input filename: +

+
desktop
+
+

or +

+
title=window_title
+
+ +

The first option will capture the entire desktop, or a fixed region of the +desktop. The second option will instead capture the contents of a single +window, regardless of its position on the screen. +

+

For example, to grab the entire desktop using ffmpeg: +

+
ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
+
+ +

Grab a 640x480 region at position 10,20: +

+
ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
+
+ +

Grab the contents of the window named "Calculator" +

+
ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
+
+ + +

18.8.1 Options

+ +
+
draw_mouse
+

Specify whether to draw the mouse pointer. Use the value 0 to +not draw the pointer. Default value is 1. +

+
+
framerate
+

Set the grabbing frame rate. Default value is ntsc, +corresponding to a frame rate of 30000/1001. +

+
+
show_region
+

Show grabbed region on screen. +

+

If show_region is specified with 1, then the grabbing +region will be indicated on screen. With this option, it is easy to +know what is being grabbed if only a portion of the screen is grabbed. +

+

Note that show_region is incompatible with grabbing the contents +of a single window. +

+

For example: +

+
ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
+
+ +
+
video_size
+

Set the video frame size. The default is to capture the full screen if desktop is selected, or the full window size if title=window_title is selected. +

+
+
offset_x
+

When capturing a region with video_size, set the distance from the left edge of the screen or desktop. +

+

Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned to the left of your primary monitor, you will need to use a negative offset_x value to move the region to that monitor. +

+
+
offset_y
+

When capturing a region with video_size, set the distance from the top edge of the screen or desktop. +

+

Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned above your primary monitor, you will need to use a negative offset_y value to move the region to that monitor. +

+
+
+ + +

18.9 iec61883

+ +

FireWire DV/HDV input device using libiec61883. +

+

To enable this input device, you need libiec61883, libraw1394 and +libavc1394 installed on your system. Use the configure option +--enable-libiec61883 to compile with the device enabled. +

+

The iec61883 capture device supports capturing from a video device +connected via IEEE1394 (FireWire), using libiec61883 and the new Linux +FireWire stack (juju). This is the default DV/HDV input method in Linux +Kernel 2.6.37 and later, since the old FireWire stack was removed. +

+

Specify the FireWire port to be used as input file, or "auto" +to choose the first port connected. +

+ +

18.9.1 Options

+ +
+
dvtype
+

Override autodetection of DV/HDV. This should only be used if auto +detection does not work, or if usage of a different device type +should be prohibited. Treating a DV device as HDV (or vice versa) will +not work and result in undefined behavior. +The values auto, dv and hdv are supported. +

+
+
dvbuffer
+

Set maximum size of buffer for incoming data, in frames. For DV, this +is an exact value. For HDV, it is not frame exact, since HDV does +not have a fixed frame size. +

+
+
dvguid
+

Select the capture device by specifying its GUID. Capturing will only +be performed from the specified device and fails if no device with the +given GUID is found. This is useful to select the input if multiple +devices are connected at the same time. +Look at /sys/bus/firewire/devices to find out the GUIDs. +

+
+
+ + +

18.9.2 Examples

+ +
    +
  • Grab and show the input of a FireWire DV/HDV device. +
    +
    ffplay -f iec61883 -i auto
+
    + +
  • Grab and record the input of a FireWire DV/HDV device, +using a packet buffer of 100000 packets if the source is HDV. +
    +
    ffmpeg -f iec61883 -i auto -dvbuffer 100000 out.mpg
+
    + +
+ + +

18.10 jack

+ +

JACK input device. +

+

To enable this input device during configuration you need libjack +installed on your system. +

+

A JACK input device creates one or more JACK writable clients, one for +each audio channel, with name client_name:input_N, where +client_name is the name provided by the application, and N +is a number which identifies the channel. +Each writable client will send the acquired data to the FFmpeg input +device. +

+

Once you have created one or more JACK readable clients, you need to +connect them to one or more JACK writable clients. +

+

To connect or disconnect JACK clients you can use the jack_connect +and jack_disconnect programs, or do it through a graphical interface, +for example with qjackctl. +

+

To list the JACK clients and their properties you can invoke the command +jack_lsp. +

+

Follows an example which shows how to capture a JACK readable client +with ffmpeg. +

+
# Create a JACK writable client with name "ffmpeg".
+$ ffmpeg -f jack -i ffmpeg -y out.wav
+
+# Start the sample jack_metro readable client.
+$ jack_metro -b 120 -d 0.2 -f 4000
+
+# List the current JACK clients.
+$ jack_lsp -c
+system:capture_1
+system:capture_2
+system:playback_1
+system:playback_2
+ffmpeg:input_1
+metro:120_bpm
+
+# Connect metro to the ffmpeg writable client.
+$ jack_connect metro:120_bpm ffmpeg:input_1
+
+ +

For more information read: +http://jackaudio.org/ +

+ +

18.10.1 Options

+ +
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

18.11 kmsgrab

+ +

KMS video input device. +

+

Captures the KMS scanout framebuffer associated with a specified CRTC or plane as a +DRM object that can be passed to other hardware functions. +

+

Requires either DRM master or CAP_SYS_ADMIN to run. +

+

If you don’t understand what all of that means, you probably don’t want this. Look at +x11grab instead. +

+ +

18.11.1 Options

+ +
+
device
+

DRM device to capture on. Defaults to /dev/dri/card0. +

+
+
format
+

Pixel format of the framebuffer. Defaults to bgr0. +

+
+
format_modifier
+

Format modifier to signal on output frames. This is necessary to import correctly into +some APIs, but can’t be autodetected. See the libdrm documentation for possible values. +

+
+
crtc_id
+

KMS CRTC ID to define the capture source. The first active plane on the given CRTC +will be used. +

+
+
plane_id
+

KMS plane ID to define the capture source. Defaults to the first active plane found if +neither crtc_id nor plane_id are specified. +

+
+
framerate
+

Framerate to capture at. This is not synchronised to any page flipping or framebuffer +changes - it just defines the interval at which the framebuffer is sampled. Sampling +faster than the framebuffer update rate will generate independent frames with the same +content. Defaults to 30. +

+
+
+ + +

18.11.2 Examples

+ +
    +
  • Capture from the first active plane, download the result to normal frames and encode. +This will only work if the framebuffer is both linear and mappable - if not, the result +may be scrambled or fail to download. +
    +
    ffmpeg -f kmsgrab -i - -vf 'hwdownload,format=bgr0' output.mp4
+
    + +
  • Capture from CRTC ID 42 at 60fps, map the result to VAAPI, convert to NV12 and encode as H.264. +
    +
    ffmpeg -crtc_id 42 -framerate 60 -f kmsgrab -i - -vf 'hwmap=derive_device=vaapi,scale_vaapi=w=1920:h=1080:format=nv12' -c:v h264_vaapi output.mp4
+
    + +
  • To capture only part of a plane the output can be cropped - this can be used to capture +a single window, as long as it has a known absolute position and size. For example, to +capture and encode the middle quarter of a 1920x1080 plane: +
    +
    ffmpeg -f kmsgrab -i - -vf 'hwmap=derive_device=vaapi,crop=960:540:480:270,scale_vaapi=960:540:nv12' -c:v h264_vaapi output.mp4
+
    + +
+ + +

18.12 lavfi

+ +

Libavfilter input virtual device. +

+

This input device reads data from the open output pads of a libavfilter +filtergraph. +

+

For each filtergraph open output, the input device will create a +corresponding stream which is mapped to the generated output. Currently +only video data is supported. The filtergraph is specified through the +option graph. +

+ +

18.12.1 Options

+ +
+
graph
+

Specify the filtergraph to use as input. Each video open output must be +labelled by a unique string of the form "outN", where N is a +number starting from 0 corresponding to the mapped input stream +generated by the device. +The first unlabelled output is automatically assigned to the "out0" +label, but all the others need to be specified explicitly. +

+

The suffix "+subcc" can be appended to the output label to create an extra +stream with the closed captions packets attached to that output +(experimental; only for EIA-608 / CEA-708 for now). +The subcc streams are created after all the normal streams, in the order of +the corresponding stream. +For example, if there is "out19+subcc", "out7+subcc" and up to "out42", the +stream #43 is subcc for stream #7 and stream #44 is subcc for stream #19. +

+

If not specified defaults to the filename specified for the input +device. +

+
+
graph_file
+

Set the filename of the filtergraph to be read and sent to the other +filters. Syntax of the filtergraph is the same as the one specified by +the option graph. +

+
+
dumpgraph
+

Dump graph to stderr. +

+
+
+ + +

18.12.2 Examples

+ +
    +
  • Create a color video stream and play it back with ffplay: +
    +
    ffplay -f lavfi -graph "color=c=pink [out0]" dummy
+
    + +
  • As the previous example, but use filename for specifying the graph +description, and omit the "out0" label: +
    +
    ffplay -f lavfi color=c=pink
+
    + +
  • Create three different video test filtered sources and play them: +
    +
    ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
+
    + +
  • Read an audio stream from a file using the amovie source and play it +back with ffplay: +
    +
    ffplay -f lavfi "amovie=test.wav"
+
    + +
  • Read an audio stream and a video stream and play it back with +ffplay: +
    +
    ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
+
    + +
  • Dump decoded frames to images and closed captions to a file (experimental): +
    +
    ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
+
    + +
+ + +

18.13 libcdio

+ +

Audio-CD input device based on libcdio. +

+

To enable this input device during configuration you need libcdio +installed on your system. It requires the configure option +--enable-libcdio. +

+

This device allows playing and grabbing from an Audio-CD. +

+

For example to copy with ffmpeg the entire Audio-CD in /dev/sr0, +you may run the command: +

+
ffmpeg -f libcdio -i /dev/sr0 cd.wav
+
+ + +

18.13.1 Options

+
+
speed
+

Set drive reading speed. Default value is 0. +

+

The speed is specified CD-ROM speed units. The speed is set through +the libcdio cdio_cddap_speed_set function. On many CD-ROM +drives, specifying a value too large will result in using the fastest +speed. +

+
+
paranoia_mode
+

Set paranoia recovery mode flags. It accepts one of the following values: +

+
+
‘disable’
+
‘verify’
+
‘overlap’
+
‘neverskip’
+
‘full’
+
+ +

Default value is ‘disable’. +

+

For more information about the available recovery modes, consult the +paranoia project documentation. +

+
+ + +

18.14 libdc1394

+ +

IIDC1394 input device, based on libdc1394 and libraw1394. +

+

Requires the configure option --enable-libdc1394. +

+ +

18.14.1 Options

+
+
framerate
+

Set the frame rate. Default is ntsc, corresponding to a frame +rate of 30000/1001. +

+
+
pixel_format
+

Select the pixel format. Default is uyvy422. +

+
+
video_size
+

Set the video size given as a string such as 640x480 or hd720. +Default is qvga. +

+
+ + +

18.15 openal

+ +

The OpenAL input device provides audio capture on all systems with a +working OpenAL 1.1 implementation. +

+

To enable this input device during configuration, you need OpenAL +headers and libraries installed on your system, and need to configure +FFmpeg with --enable-openal. +

+

OpenAL headers and libraries should be provided as part of your OpenAL +implementation, or as an additional download (an SDK). Depending on your +installation you may need to specify additional flags via the +--extra-cflags and --extra-ldflags for allowing the build +system to locate the OpenAL headers and libraries. +

+

An incomplete list of OpenAL implementations follows: +

+
+
Creative
+

The official Windows implementation, providing hardware acceleration +with supported devices and software fallback. +See http://openal.org/. +

+
OpenAL Soft
+

Portable, open source (LGPL) software implementation. Includes +backends for the most common sound APIs on the Windows, Linux, +Solaris, and BSD operating systems. +See http://kcat.strangesoft.net/openal.html. +

+
Apple
+

OpenAL is part of Core Audio, the official Mac OS X Audio interface. +See http://developer.apple.com/technologies/mac/audio-and-video.html +

+
+ +

This device allows one to capture from an audio input device handled +through OpenAL. +

+

You need to specify the name of the device to capture in the provided +filename. If the empty string is provided, the device will +automatically select the default device. You can get the list of the +supported devices by using the option list_devices. +

+ +

18.15.1 Options

+ +
+
channels
+

Set the number of channels in the captured audio. Only the values +1 (monaural) and 2 (stereo) are currently supported. +Defaults to 2. +

+
+
sample_size
+

Set the sample size (in bits) of the captured audio. Only the values +8 and 16 are currently supported. Defaults to +16. +

+
+
sample_rate
+

Set the sample rate (in Hz) of the captured audio. +Defaults to 44.1k. +

+
+
list_devices
+

If set to true, print a list of devices and exit. +Defaults to false. +

+
+
+ + +

18.15.2 Examples

+ +

Print the list of OpenAL supported devices and exit: +

+
$ ffmpeg -list_devices true -f openal -i dummy out.ogg
+
+ +

Capture from the OpenAL device DR-BT101 via PulseAudio: +

+
$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
+
+ +

Capture from the default device (note the empty string ” as filename): +

+
$ ffmpeg -f openal -i '' out.ogg
+
+ +

Capture from two devices simultaneously, writing to two different files, +within the same ffmpeg command: +

+
$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
+
+

Note: not all OpenAL implementations support multiple simultaneous capture - +try the latest OpenAL Soft if the above does not work. +

+ +

18.16 oss

+ +

Open Sound System input device. +

+

The filename to provide to the input device is the device node +representing the OSS input device, and is usually set to +/dev/dsp. +

+

For example to grab from /dev/dsp using ffmpeg use the +command: +

+
ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
+
+ +

For more information about OSS see: +http://manuals.opensound.com/usersguide/dsp.html +

+ +

18.16.1 Options

+ +
+
sample_rate
+

Set the sample rate in Hz. Default is 48000. +

+
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

18.17 pulse

+ +

PulseAudio input device. +

+

To enable this output device you need to configure FFmpeg with --enable-libpulse. +

+

The filename to provide to the input device is a source device or the +string "default" +

+

To list the PulseAudio source devices and their properties you can invoke +the command pactl list sources. +

+

More information about PulseAudio can be found on http://www.pulseaudio.org. +

+ +

18.17.1 Options

+
+
server
+

Connect to a specific PulseAudio server, specified by an IP address. +Default server is used when not provided. +

+
+
name
+

Specify the application name PulseAudio will use when showing active clients, +by default it is the LIBAVFORMAT_IDENT string. +

+
+
stream_name
+

Specify the stream name PulseAudio will use when showing active streams, +by default it is "record". +

+
+
sample_rate
+

Specify the samplerate in Hz, by default 48kHz is used. +

+
+
channels
+

Specify the channels in use, by default 2 (stereo) is set. +

+
+
frame_size
+

Specify the number of bytes per frame, by default it is set to 1024. +

+
+
fragment_size
+

Specify the minimal buffering fragment in PulseAudio, it will affect the +audio latency. By default it is unset. +

+
+
wallclock
+

Set the initial PTS using the current time. Default is 1. +

+
+
+ + +

18.17.2 Examples

+

Record a stream from default device: +

+
ffmpeg -f pulse -i default /tmp/pulse.wav
+
+ + +

18.18 sndio

+ +

sndio input device. +

+

To enable this input device during configuration you need libsndio +installed on your system. +

+

The filename to provide to the input device is the device node +representing the sndio input device, and is usually set to +/dev/audio0. +

+

For example to grab from /dev/audio0 using ffmpeg use the +command: +

+
ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
+
+ + +

18.18.1 Options

+ +
+
sample_rate
+

Set the sample rate in Hz. Default is 48000. +

+
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

18.19 video4linux2, v4l2

+ +

Video4Linux2 input video device. +

+

"v4l2" can be used as alias for "video4linux2". +

+

If FFmpeg is built with v4l-utils support (by using the +--enable-libv4l2 configure option), it is possible to use it with the +-use_libv4l2 input device option. +

+

The name of the device to grab is a file device node, usually Linux +systems tend to automatically create such nodes when the device +(e.g. an USB webcam) is plugged into the system, and has a name of the +kind /dev/videoN, where N is a number associated to +the device. +

+

Video4Linux2 devices usually support a limited set of +widthxheight sizes and frame rates. You can check which are +supported using -list_formats all for Video4Linux2 devices. +Some devices, like TV cards, support one or more standards. It is possible +to list all the supported standards using -list_standards all. +

+

The time base for the timestamps is 1 microsecond. Depending on the kernel +version and configuration, the timestamps may be derived from the real time +clock (origin at the Unix Epoch) or the monotonic clock (origin usually at +boot time, unaffected by NTP or manual changes to the clock). The +-timestamps abs or -ts abs option can be used to force +conversion into the real time clock. +

+

Some usage examples of the video4linux2 device with ffmpeg +and ffplay: +

    +
  • List supported formats for a video4linux2 device: +
    +
    ffplay -f video4linux2 -list_formats all /dev/video0
+
    + +
  • Grab and show the input of a video4linux2 device: +
    +
    ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
+
    + +
  • Grab and record the input of a video4linux2 device, leave the +frame rate and size as previously set: +
    +
    ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
+
    +
+ +

For more information about Video4Linux, check http://linuxtv.org/. +

+ +

18.19.1 Options

+ +
+
standard
+

Set the standard. Must be the name of a supported standard. To get a +list of the supported standards, use the list_standards +option. +

+
+
channel
+

Set the input channel number. Default to -1, which means using the +previously selected channel. +

+
+
video_size
+

Set the video frame size. The argument must be a string in the form +WIDTHxHEIGHT or a valid size abbreviation. +

+
+
pixel_format
+

Select the pixel format (only valid for raw video input). +

+
+
input_format
+

Set the preferred pixel format (for raw video) or a codec name. +This option allows one to select the input format, when several are +available. +

+
+
framerate
+

Set the preferred video frame rate. +

+
+
list_formats
+

List available formats (supported pixel formats, codecs, and frame +sizes) and exit. +

+

Available values are: +

+
‘all’
+

Show all available (compressed and non-compressed) formats. +

+
+
‘raw’
+

Show only raw video (non-compressed) formats. +

+
+
‘compressed’
+

Show only compressed formats. +

+
+ +
+
list_standards
+

List supported standards and exit. +

+

Available values are: +

+
‘all’
+

Show all supported standards. +

+
+ +
+
timestamps, ts
+

Set type of timestamps for grabbed frames. +

+

Available values are: +

+
‘default’
+

Use timestamps from the kernel. +

+
+
‘abs’
+

Use absolute timestamps (wall clock). +

+
+
‘mono2abs’
+

Force conversion from monotonic to absolute timestamps. +

+
+ +

Default value is default. +

+
+
use_libv4l2
+

Use libv4l2 (v4l-utils) conversion functions. Default is 0. +

+
+
+ + +

18.20 vfwcap

+ +

VfW (Video for Windows) capture input device. +

+

The filename passed as input is the capture driver number, ranging from +0 to 9. You may use "list" as filename to print a list of drivers. Any +other filename will be interpreted as device number 0. +

+ +

18.20.1 Options

+ +
+
video_size
+

Set the video frame size. +

+
+
framerate
+

Set the grabbing frame rate. Default value is ntsc, +corresponding to a frame rate of 30000/1001. +

+
+
+ + +

18.21 x11grab

+ +

X11 video input device. +

+

To enable this input device during configuration you need libxcb +installed on your system. It will be automatically detected during +configuration. +

+

This device allows one to capture a region of an X11 display. +

+

The filename passed as input has the syntax: +

+
[hostname]:display_number.screen_number[+x_offset,y_offset]
+
+ +

hostname:display_number.screen_number specifies the +X11 display name of the screen to grab from. hostname can be +omitted, and defaults to "localhost". The environment variable +DISPLAY contains the default display name. +

+

x_offset and y_offset specify the offsets of the grabbed +area with respect to the top-left border of the X11 screen. They +default to 0. +

+

Check the X11 documentation (e.g. man X) for more detailed +information. +

+

Use the xdpyinfo program for getting basic information about +the properties of your X11 display (e.g. grep for "name" or +"dimensions"). +

+

For example to grab from :0.0 using ffmpeg: +

+
ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +

Grab at position 10,20: +

+
ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
+
+ + +

18.21.1 Options

+ +
+
draw_mouse
+

Specify whether to draw the mouse pointer. A value of 0 specifies +not to draw the pointer. Default value is 1. +

+
+
follow_mouse
+

Make the grabbed area follow the mouse. The argument can be +centered or a number of pixels PIXELS. +

+

When it is specified with "centered", the grabbing region follows the mouse +pointer and keeps the pointer at the center of region; otherwise, the region +follows only when the mouse pointer reaches within PIXELS (greater than +zero) to the edge of region. +

+

For example: +

+
ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +

To follow only when the mouse pointer reaches within 100 pixels to edge: +

+
ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +
+
framerate
+

Set the grabbing frame rate. Default value is ntsc, +corresponding to a frame rate of 30000/1001. +

+
+
show_region
+

Show grabbed region on screen. +

+

If show_region is specified with 1, then the grabbing +region will be indicated on screen. With this option, it is easy to +know what is being grabbed if only a portion of the screen is grabbed. +

+
+
region_border
+

Set the region border thickness if -show_region 1 is used. +Range is 1 to 128 and default is 3 (XCB-based x11grab only). +

+

For example: +

+
ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
+
+ +

With follow_mouse: +

+
ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +
+
video_size
+

Set the video frame size. Default is the full desktop. +

+
+
grab_x
+
grab_y
+

Set the grabbing region coordinates. They are expressed as offset from +the top left corner of the X11 window and correspond to the +x_offset and y_offset parameters in the device name. The +default value for both options is 0. +

+
+ + +

19 Resampler Options

+ +

The audio resampler supports the following named options. +

+

Options may be set by specifying -option value in the +FFmpeg tools, option=value for the aresample filter, +by setting the value explicitly in the +SwrContext options or using the libavutil/opt.h API for +programmatic use. +

+
+
ich, in_channel_count
+

Set the number of input channels. Default value is 0. Setting this +value is not mandatory if the corresponding channel layout +in_channel_layout is set. +

+
+
och, out_channel_count
+

Set the number of output channels. Default value is 0. Setting this +value is not mandatory if the corresponding channel layout +out_channel_layout is set. +

+
+
uch, used_channel_count
+

Set the number of used input channels. Default value is 0. This option is +only used for special remapping. +

+
+
isr, in_sample_rate
+

Set the input sample rate. Default value is 0. +

+
+
osr, out_sample_rate
+

Set the output sample rate. Default value is 0. +

+
+
isf, in_sample_fmt
+

Specify the input sample format. It is set by default to none. +

+
+
osf, out_sample_fmt
+

Specify the output sample format. It is set by default to none. +

+
+
tsf, internal_sample_fmt
+

Set the internal sample format. Default value is none. +This will automatically be chosen when it is not explicitly set. +

+
+
icl, in_channel_layout
+
ocl, out_channel_layout
+

Set the input/output channel layout. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+
clev, center_mix_level
+

Set the center mix level. It is a value expressed in deciBel, and must be +in the interval [-32,32]. +

+
+
slev, surround_mix_level
+

Set the surround mix level. It is a value expressed in deciBel, and must +be in the interval [-32,32]. +

+
+
lfe_mix_level
+

Set LFE mix into non LFE level. It is used when there is a LFE input but no +LFE output. It is a value expressed in deciBel, and must +be in the interval [-32,32]. +

+
+
rmvol, rematrix_volume
+

Set rematrix volume. Default value is 1.0. +

+
+
rematrix_maxval
+

Set maximum output value for rematrixing. +This can be used to prevent clipping vs. preventing volume reduction. +A value of 1.0 prevents clipping. +

+
+
flags, swr_flags
+

Set flags used by the converter. Default value is 0. +

+

It supports the following individual flags: +

+
res
+

force resampling, this flag forces resampling to be used even when the +input and output sample rates match. +

+
+ +
+
dither_scale
+

Set the dither scale. Default value is 1. +

+
+
dither_method
+

Set dither method. Default value is 0. +

+

Supported values: +

+
‘rectangular’
+

select rectangular dither +

+
‘triangular’
+

select triangular dither +

+
‘triangular_hp’
+

select triangular dither with high pass +

+
‘lipshitz’
+

select Lipshitz noise shaping dither. +

+
‘shibata’
+

select Shibata noise shaping dither. +

+
‘low_shibata’
+

select low Shibata noise shaping dither. +

+
‘high_shibata’
+

select high Shibata noise shaping dither. +

+
‘f_weighted’
+

select f-weighted noise shaping dither +

+
‘modified_e_weighted’
+

select modified-e-weighted noise shaping dither +

+
‘improved_e_weighted’
+

select improved-e-weighted noise shaping dither +

+
+
+ +
+
resampler
+

Set resampling engine. Default value is swr. +

+

Supported values: +

+
‘swr’
+

select the native SW Resampler; filter options precision and cheby are not +applicable in this case. +

+
‘soxr’
+

select the SoX Resampler (where available); compensation, and filter options +filter_size, phase_shift, exact_rational, filter_type & kaiser_beta, are not +applicable in this case. +

+
+ +
+
filter_size
+

For swr only, set resampling filter size, default value is 32. +

+
+
phase_shift
+

For swr only, set resampling phase shift, default value is 10, and must be in +the interval [0,30]. +

+
+
linear_interp
+

Use linear interpolation when enabled (the default). Disable it if you want +to preserve speed instead of quality when exact_rational fails. +

+
+
exact_rational
+

For swr only, when enabled, try to use exact phase_count based on input and +output sample rate. However, if it is larger than 1 << phase_shift, +the phase_count will be 1 << phase_shift as fallback. Default is enabled. +

+
+
cutoff
+

Set cutoff frequency (swr: 6dB point; soxr: 0dB point) ratio; must be a float +value between 0 and 1. Default value is 0.97 with swr, and 0.91 with soxr +(which, with a sample-rate of 44100, preserves the entire audio band to 20kHz). +

+
+
precision
+

For soxr only, the precision in bits to which the resampled signal will be +calculated. The default value of 20 (which, with suitable dithering, is +appropriate for a destination bit-depth of 16) gives SoX’s ’High Quality’; a +value of 28 gives SoX’s ’Very High Quality’. +

+
+
cheby
+

For soxr only, selects passband rolloff none (Chebyshev) & higher-precision +approximation for ’irrational’ ratios. Default value is 0. +

+
+
async
+

For swr only, simple 1 parameter audio sync to timestamps using stretching, +squeezing, filling and trimming. Setting this to 1 will enable filling and +trimming, larger values represent the maximum amount in samples that the data +may be stretched or squeezed for each second. +Default value is 0, thus no compensation is applied to make the samples match +the audio timestamps. +

+
+
first_pts
+

For swr only, assume the first pts should be this value. The time unit is 1 / sample rate. +This allows for padding/trimming at the start of stream. By default, no +assumption is made about the first frame’s expected pts, so no padding or +trimming is done. For example, this could be set to 0 to pad the beginning with +silence if an audio stream starts after the video stream or to trim any samples +with a negative pts due to encoder delay. +

+
+
min_comp
+

For swr only, set the minimum difference between timestamps and audio data (in +seconds) to trigger stretching/squeezing/filling or trimming of the +data to make it match the timestamps. The default is that +stretching/squeezing/filling and trimming is disabled +(min_comp = FLT_MAX). +

+
+
min_hard_comp
+

For swr only, set the minimum difference between timestamps and audio data (in +seconds) to trigger adding/dropping samples to make it match the +timestamps. This option effectively is a threshold to select between +hard (trim/fill) and soft (squeeze/stretch) compensation. Note that +all compensation is by default disabled through min_comp. +The default is 0.1. +

+
+
comp_duration
+

For swr only, set duration (in seconds) over which data is stretched/squeezed +to make it match the timestamps. Must be a non-negative double float value, +default value is 1.0. +

+
+
max_soft_comp
+

For swr only, set maximum factor by which data is stretched/squeezed to make it +match the timestamps. Must be a non-negative double float value, default value +is 0. +

+
+
matrix_encoding
+

Select matrixed stereo encoding. +

+

It accepts the following values: +

+
‘none’
+

select none +

+
‘dolby’
+

select Dolby +

+
‘dplii’
+

select Dolby Pro Logic II +

+
+ +

Default value is none. +

+
+
filter_type
+

For swr only, select resampling filter type. This only affects resampling +operations. +

+

It accepts the following values: +

+
‘cubic’
+

select cubic +

+
‘blackman_nuttall’
+

select Blackman Nuttall windowed sinc +

+
‘kaiser’
+

select Kaiser windowed sinc +

+
+ +
+
kaiser_beta
+

For swr only, set Kaiser window beta value. Must be a double float value in the +interval [2,16], default value is 9. +

+
+
output_sample_bits
+

For swr only, set number of used output sample bits for dithering. Must be an integer in the +interval [0,64], default value is 0, which means it’s not used. +

+
+
+ + +

20 Scaler Options

+ +

The video scaler supports the following named options. +

+

Options may be set by specifying -option value in the +FFmpeg tools, with a few API-only exceptions noted below. +For programmatic use, they can be set explicitly in the +SwsContext options or through the libavutil/opt.h API. +

+
+
+
+
sws_flags
+

Set the scaler flags. This is also used to set the scaling +algorithm. Only a single algorithm should be selected. Default +value is ‘bicubic’. +

+

It accepts the following values: +

+
‘fast_bilinear’
+

Select fast bilinear scaling algorithm. +

+
+
‘bilinear’
+

Select bilinear scaling algorithm. +

+
+
‘bicubic’
+

Select bicubic scaling algorithm. +

+
+
‘experimental’
+

Select experimental scaling algorithm. +

+
+
‘neighbor’
+

Select nearest neighbor rescaling algorithm. +

+
+
‘area’
+

Select averaging area rescaling algorithm. +

+
+
‘bicublin’
+

Select bicubic scaling algorithm for the luma component, bilinear for +chroma components. +

+
+
‘gauss’
+

Select Gaussian rescaling algorithm. +

+
+
‘sinc’
+

Select sinc rescaling algorithm. +

+
+
‘lanczos’
+

Select Lanczos rescaling algorithm. The default width (alpha) is 3 and can be +changed by setting param0. +

+
+
‘spline’
+

Select natural bicubic spline rescaling algorithm. +

+
+
‘print_info’
+

Enable printing/debug logging. +

+
+
‘accurate_rnd’
+

Enable accurate rounding. +

+
+
‘full_chroma_int’
+

Enable full chroma interpolation. +

+
+
‘full_chroma_inp’
+

Select full chroma input. +

+
+
‘bitexact’
+

Enable bitexact output. +

+
+ +
+
srcw (API only)
+

Set source width. +

+
+
srch (API only)
+

Set source height. +

+
+
dstw (API only)
+

Set destination width. +

+
+
dsth (API only)
+

Set destination height. +

+
+
src_format (API only)
+

Set source pixel format (must be expressed as an integer). +

+
+
dst_format (API only)
+

Set destination pixel format (must be expressed as an integer). +

+
+
src_range (boolean)
+

If value is set to 1, indicates source is full range. Default value is +0, which indicates source is limited range. +

+
+
dst_range (boolean)
+

If value is set to 1, enable full range for destination. Default value +is 0, which enables limited range. +

+
+
param0, param1
+

Set scaling algorithm parameters. The specified values are specific of +some scaling algorithms and ignored by others. The specified values +are floating point number values. +

+
+
sws_dither
+

Set the dithering algorithm. Accepts one of the following +values. Default value is ‘auto’. +

+
+
‘auto’
+

automatic choice +

+
+
‘none’
+

no dithering +

+
+
‘bayer’
+

bayer dither +

+
+
‘ed’
+

error diffusion dither +

+
+
‘a_dither’
+

arithmetic dither, based using addition +

+
+
‘x_dither’
+

arithmetic dither, based using xor (more random/less apparent patterning that +a_dither). +

+
+
+ +
+
alphablend
+

Set the alpha blending to use when the input has alpha but the output does not. +Default value is ‘none’. +

+
+
‘uniform_color’
+

Blend onto a uniform background color +

+
+
‘checkerboard’
+

Blend onto a checkerboard +

+
+
‘none’
+

No blending +

+
+
+ +
+
+ + +

21 Filtering Introduction

+ +

Filtering in FFmpeg is enabled through the libavfilter library. +

+

In libavfilter, a filter can have multiple inputs and multiple +outputs. +To illustrate the sorts of things that are possible, we consider the +following filtergraph. +

+
                [main]
+input --> split ---------------------> overlay --> output
+            |                             ^
+            |[tmp]                  [flip]|
+            +-----> crop --> vflip -------+
+
+

This filtergraph splits the input stream in two streams, then sends one +stream through the crop filter and the vflip filter, before merging it +back with the other stream by overlaying it on top. You can use the +following command to achieve this: +

+
+
ffmpeg -i INPUT -vf "split [main][tmp]; [tmp] crop=iw:ih/2:0:0, vflip [flip]; [main][flip] overlay=0:H/2" OUTPUT
+
+ +

The result will be that the top half of the video is mirrored +onto the bottom half of the output video. +

+

Filters in the same linear chain are separated by commas, and distinct +linear chains of filters are separated by semicolons. In our example, +crop,vflip are in one linear chain, split and +overlay are separately in another. The points where the linear +chains join are labelled by names enclosed in square brackets. In the +example, the split filter generates two outputs that are associated to +the labels [main] and [tmp]. +

+

The stream sent to the second output of split, labelled as +[tmp], is processed through the crop filter, which crops +away the lower half part of the video, and then vertically flipped. The +overlay filter takes in input the first unchanged output of the +split filter (which was labelled as [main]), and overlay on its +lower half the output generated by the crop,vflip filterchain. +

+

Some filters take in input a list of parameters: they are specified +after the filter name and an equal sign, and are separated from each other +by a colon. +

+

There exist so-called source filters that do not have an +audio/video input, and sink filters that will not have audio/video +output. +

+ + +

22 graph2dot

+ +

The graph2dot program included in the FFmpeg tools +directory can be used to parse a filtergraph description and issue a +corresponding textual representation in the dot language. +

+

Invoke the command: +

+
graph2dot -h
+
+ +

to see how to use graph2dot. +

+

You can then pass the dot description to the dot program (from +the graphviz suite of programs) and obtain a graphical representation +of the filtergraph. +

+

For example the sequence of commands: +

+
echo GRAPH_DESCRIPTION | \
+tools/graph2dot -o graph.tmp && \
+dot -Tpng graph.tmp -o graph.png && \
+display graph.png
+
+ +

can be used to create and display an image representing the graph +described by the GRAPH_DESCRIPTION string. Note that this string must be +a complete self-contained graph, with its inputs and outputs explicitly defined. +For example if your command line is of the form: +

+
ffmpeg -i infile -vf scale=640:360 outfile
+
+

your GRAPH_DESCRIPTION string will need to be of the form: +

+
nullsrc,scale=640:360,nullsink
+
+

you may also need to set the nullsrc parameters and add a format +filter in order to simulate a specific input file. +

+ + +

23 Filtergraph description

+ +

A filtergraph is a directed graph of connected filters. It can contain +cycles, and there can be multiple links between a pair of +filters. Each link has one input pad on one side connecting it to one +filter from which it takes its input, and one output pad on the other +side connecting it to one filter accepting its output. +

+

Each filter in a filtergraph is an instance of a filter class +registered in the application, which defines the features and the +number of input and output pads of the filter. +

+

A filter with no input pads is called a "source", and a filter with no +output pads is called a "sink". +

+ +

23.1 Filtergraph syntax

+ +

A filtergraph has a textual representation, which is recognized by the +-filter/-vf/-af and +-filter_complex options in ffmpeg and +-vf/-af in ffplay, and by the +avfilter_graph_parse_ptr() function defined in +libavfilter/avfilter.h. +

+

A filterchain consists of a sequence of connected filters, each one +connected to the previous one in the sequence. A filterchain is +represented by a list of ","-separated filter descriptions. +

+

A filtergraph consists of a sequence of filterchains. A sequence of +filterchains is represented by a list of ";"-separated filterchain +descriptions. +

+

A filter is represented by a string of the form: +[in_link_1]...[in_link_N]filter_name@id=arguments[out_link_1]...[out_link_M] +

+

filter_name is the name of the filter class of which the +described filter is an instance of, and has to be the name of one of +the filter classes registered in the program optionally followed by "@id". +The name of the filter class is optionally followed by a string +"=arguments". +

+

arguments is a string which contains the parameters used to +initialize the filter instance. It may have one of two forms: +

    +
  • A ’:’-separated list of key=value pairs. + +
  • A ’:’-separated list of value. In this case, the keys are assumed to be +the option names in the order they are declared. E.g. the fade filter +declares three options in this order – type, start_frame and +nb_frames. Then the parameter list in:0:30 means that the value +in is assigned to the option type, 0 to +start_frame and 30 to nb_frames. + +
  • A ’:’-separated list of mixed direct value and long key=value +pairs. The direct value must precede the key=value pairs, and +follow the same constraints order of the previous point. The following +key=value pairs can be set in any preferred order. + +
+ +

If the option value itself is a list of items (e.g. the format filter +takes a list of pixel formats), the items in the list are usually separated by +‘|’. +

+

The list of arguments can be quoted using the character ‘'’ as initial +and ending mark, and the character ‘\’ for escaping the characters +within the quoted text; otherwise the argument string is considered +terminated when the next special character (belonging to the set +‘[]=;,’) is encountered. +

+

The name and arguments of the filter are optionally preceded and +followed by a list of link labels. +A link label allows one to name a link and associate it to a filter output +or input pad. The preceding labels in_link_1 +... in_link_N, are associated to the filter input pads, +the following labels out_link_1 ... out_link_M, are +associated to the output pads. +

+

When two link labels with the same name are found in the +filtergraph, a link between the corresponding input and output pad is +created. +

+

If an output pad is not labelled, it is linked by default to the first +unlabelled input pad of the next filter in the filterchain. +For example in the filterchain +

+
nullsrc, split[L1], [L2]overlay, nullsink
+
+

the split filter instance has two output pads, and the overlay filter +instance two input pads. The first output pad of split is labelled +"L1", the first input pad of overlay is labelled "L2", and the second +output pad of split is linked to the second input pad of overlay, +which are both unlabelled. +

+

In a filter description, if the input label of the first filter is not +specified, "in" is assumed; if the output label of the last filter is not +specified, "out" is assumed. +

+

In a complete filterchain all the unlabelled filter input and output +pads must be connected. A filtergraph is considered valid if all the +filter input and output pads of all the filterchains are connected. +

+

Libavfilter will automatically insert scale filters where format +conversion is required. It is possible to specify swscale flags +for those automatically inserted scalers by prepending +sws_flags=flags; +to the filtergraph description. +

+

Here is a BNF description of the filtergraph syntax: +

+
NAME             ::= sequence of alphanumeric characters and '_'
+FILTER_NAME      ::= NAME["@"NAME]
+LINKLABEL        ::= "[" NAME "]"
+LINKLABELS       ::= LINKLABEL [LINKLABELS]
+FILTER_ARGUMENTS ::= sequence of chars (possibly quoted)
+FILTER           ::= [LINKLABELS] FILTER_NAME ["=" FILTER_ARGUMENTS] [LINKLABELS]
+FILTERCHAIN      ::= FILTER [,FILTERCHAIN]
+FILTERGRAPH      ::= [sws_flags=flags;] FILTERCHAIN [;FILTERGRAPH]
+
+ + +

23.2 Notes on filtergraph escaping

+ +

Filtergraph description composition entails several levels of +escaping. See (ffmpeg-utils)the "Quoting and escaping" +section in the ffmpeg-utils(1) manual for more +information about the employed escaping procedure. +

+

A first level escaping affects the content of each filter option +value, which may contain the special character : used to +separate values, or one of the escaping characters \'. +

+

A second level escaping affects the whole filter description, which +may contain the escaping characters \' or the special +characters [],; used by the filtergraph description. +

+

Finally, when you specify a filtergraph on a shell commandline, you +need to perform a third level escaping for the shell special +characters contained within it. +

+

For example, consider the following string to be embedded in +the drawtext filter description text value: +

+
this is a 'string': may contain one, or more, special characters
+
+ +

This string contains the ' special escaping character, and the +: special character, so it needs to be escaped in this way: +

+
text=this is a \'string\'\: may contain one, or more, special characters
+
+ +

A second level of escaping is required when embedding the filter +description in a filtergraph description, in order to escape all the +filtergraph special characters. Thus the example above becomes: +

+
drawtext=text=this is a \\\'string\\\'\\: may contain one\, or more\, special characters
+
+

(note that in addition to the \' escaping special characters, +also , needs to be escaped). +

+

Finally an additional level of escaping is needed when writing the +filtergraph description in a shell command, which depends on the +escaping rules of the adopted shell. For example, assuming that +\ is special and needs to be escaped with another \, the +previous string will finally result in: +

+
-vf "drawtext=text=this is a \\\\\\'string\\\\\\'\\\\: may contain one\\, or more\\, special characters"
+
+ + +

24 Timeline editing

+ +

Some filters support a generic enable option. For the filters +supporting timeline editing, this option can be set to an expression which is +evaluated before sending a frame to the filter. If the evaluation is non-zero, +the filter will be enabled, otherwise the frame will be sent unchanged to the +next filter in the filtergraph. +

+

The expression accepts the following values: +

+
‘t’
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+
‘n’
+

sequential number of the input frame, starting from 0 +

+
+
‘pos’
+

the position in the file of the input frame, NAN if unknown +

+
+
‘w’
+
‘h’
+

width and height of the input frame if video +

+
+ +

Additionally, these filters support an enable command that can be used +to re-define the expression. +

+

Like any other filtering option, the enable option follows the same +rules. +

+

For example, to enable a blur filter (smartblur) from 10 seconds to 3 +minutes, and a curves filter starting at 3 seconds: +

+
smartblur = enable='between(t,10,3*60)',
+curves    = enable='gte(t,3)' : preset=cross_process
+
+ +

See ffmpeg -filters to view which filters have timeline support. +

+ + +

25 Changing options at runtime with a command

+ +

Some options can be changed during the operation of the filter using +a command. These options are marked ’T’ on the output of +ffmpeg -h filter=<name of filter>. +The name of the command is the name of the option and the argument is +the new value. +

+ +

26 Options for filters with several inputs (framesync)

+ +

Some filters with several inputs support a common set of options. +These options can only be set by name, not with the short notation. +

+
+
eof_action
+

The action to take when EOF is encountered on the secondary input; it accepts +one of the following values: +

+
+
repeat
+

Repeat the last frame (the default). +

+
endall
+

End both streams. +

+
pass
+

Pass the main input through. +

+
+ +
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+
repeatlast
+

If set to 1, force the filter to extend the last frame of secondary streams +until the end of the primary stream. A value of 0 disables this behavior. +Default value is 1. +

+
+ + + +

27 Audio Filters

+ +

When you configure your FFmpeg build, you can disable any of the +existing filters using --disable-filters. +The configure output will show the audio filters included in your +build. +

+

Below is a description of the currently available audio filters. +

+ +

27.1 acompressor

+ +

A compressor is mainly used to reduce the dynamic range of a signal. +Especially modern music is mostly compressed at a high ratio to +improve the overall loudness. It’s done to get the highest attention +of a listener, "fatten" the sound and bring more "power" to the track. +If a signal is compressed too much it may sound dull or "dead" +afterwards or it may start to "pump" (which could be a powerful effect +but can also destroy a track completely). +The right compression is the key to reach a professional sound and is +the high art of mixing and mastering. Because of its complex settings +it may take a long time to get the right feeling for this kind of effect. +

+

Compression is done by detecting the volume above a chosen level +threshold and dividing it by the factor set with ratio. +So if you set the threshold to -12dB and your signal reaches -6dB a ratio +of 2:1 will result in a signal at -9dB. Because an exact manipulation of +the signal would cause distortion of the waveform the reduction can be +levelled over the time. This is done by setting "Attack" and "Release". +attack determines how long the signal has to rise above the threshold +before any reduction will occur and release sets the time the signal +has to fall below the threshold to reduce the reduction again. Shorter signals +than the chosen attack time will be left untouched. +The overall reduction of the signal can be made up afterwards with the +makeup setting. So compressing the peaks of a signal about 6dB and +raising the makeup to this level results in a signal twice as loud than the +source. To gain a softer entry in the compression the knee flattens the +hard edge at the threshold in the range of the chosen decibels. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. Default is 1. Range is between 0.015625 and 64. +

+
+
mode
+

Set mode of compressor operation. Can be upward or downward. +Default is downward. +

+
+
threshold
+

If a signal of stream rises above this level it will affect the gain +reduction. +By default it is 0.125. Range is between 0.00097563 and 1. +

+
+
ratio
+

Set a ratio by which the signal is reduced. 1:2 means that if the level +rose 4dB above the threshold, it will be only 2dB above after the reduction. +Default is 2. Range is between 1 and 20. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction starts. Default is 20. Range is between 0.01 and 2000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before +reduction is decreased again. Default is 250. Range is between 0.01 and 9000. +

+
+
makeup
+

Set the amount by how much signal will be amplified after processing. +Default is 1. Range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.82843. Range is between 1 and 8. +

+
+
link
+

Choose if the average level between all channels of input stream +or the louder(maximum) channel of input stream affects the +reduction. Default is average. +

+
+
detection
+

Should the exact signal be taken in case of peak or an RMS one in case +of rms. Default is rms which is mostly smoother. +

+
+
mix
+

How much to use compressed signal in output. Default is 1. +Range is between 0 and 1. +

+
+ + +

27.1.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

27.2 acontrast

+

Simple audio dynamic range compression/expansion filter. +

+

The filter accepts the following options: +

+
+
contrast
+

Set contrast. Default is 33. Allowed range is between 0 and 100. +

+
+ + +

27.3 acopy

+ +

Copy the input audio source unchanged to the output. This is mainly useful for +testing purposes. +

+ +

27.4 acrossfade

+ +

Apply cross fade from one input audio stream to another input audio stream. +The cross fade is applied for specified duration near the end of first stream. +

+

The filter accepts the following options: +

+
+
nb_samples, ns
+

Specify the number of samples for which the cross fade effect has to last. +At the end of the cross fade effect the first input audio will be completely +silent. Default is 44100. +

+
+
duration, d
+

Specify the duration of the cross fade effect. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +By default the duration is determined by nb_samples. +If set this option is used instead of nb_samples. +

+
+
overlap, o
+

Should first stream end overlap with second stream start. Default is enabled. +

+
+
curve1
+

Set curve for cross fade transition for first stream. +

+
+
curve2
+

Set curve for cross fade transition for second stream. +

+

For description of available curve types see afade filter description. +

+
+ + +

27.4.1 Examples

+ +
    +
  • Cross fade from one input to another: +
    +
    ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:c1=exp:c2=exp output.flac
+
    + +
  • Cross fade from one input to another but without overlapping: +
    +
    ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:o=0:c1=exp:c2=exp output.flac
+
    +
+ + +

27.5 acrossover

+

Split audio stream into several bands. +

+

This filter splits audio stream into two or more frequency ranges. +Summing all streams back will give flat output. +

+

The filter accepts the following options: +

+
+
split
+

Set split frequencies. Those must be positive and increasing. +

+
+
order
+

Set filter order, can be 2nd, 4th or 8th. +Default is 4th. +

+
+ + +

27.6 acrusher

+ +

Reduce audio bit resolution. +

+

This filter is bit crusher with enhanced functionality. A bit crusher +is used to audibly reduce number of bits an audio signal is sampled +with. This doesn’t change the bit depth at all, it just produces the +effect. Material reduced in bit depth sounds more harsh and "digital". +This filter is able to even round to continuous values instead of discrete +bit depths. +Additionally it has a D/C offset which results in different crushing of +the lower and the upper half of the signal. +An Anti-Aliasing setting is able to produce "softer" crushing sounds. +

+

Another feature of this filter is the logarithmic mode. +This setting switches from linear distances between bits to logarithmic ones. +The result is a much more "natural" sounding crusher which doesn’t gate low +signals for example. The human ear has a logarithmic perception, +so this kind of crushing is much more pleasant. +Logarithmic crushing is also able to get anti-aliased. +

+

The filter accepts the following options: +

+
+
level_in
+

Set level in. +

+
+
level_out
+

Set level out. +

+
+
bits
+

Set bit reduction. +

+
+
mix
+

Set mixing amount. +

+
+
mode
+

Can be linear: lin or logarithmic: log. +

+
+
dc
+

Set DC. +

+
+
aa
+

Set anti-aliasing. +

+
+
samples
+

Set sample reduction. +

+
+
lfo
+

Enable LFO. By default disabled. +

+
+
lforange
+

Set LFO range. +

+
+
lforate
+

Set LFO rate. +

+
+ + +

27.7 acue

+ +

Delay audio filtering until a given wallclock timestamp. See the cue +filter. +

+ +

27.8 adeclick

+

Remove impulsive noise from input audio. +

+

Samples detected as impulsive noise are replaced by interpolated samples using +autoregressive modelling. +

+
+
w
+

Set window size, in milliseconds. Allowed range is from 10 to +100. Default value is 55 milliseconds. +This sets size of window which will be processed at once. +

+
+
o
+

Set window overlap, in percentage of window size. Allowed range is from +50 to 95. Default value is 75 percent. +Setting this to a very high value increases impulsive noise removal but makes +whole process much slower. +

+
+
a
+

Set autoregression order, in percentage of window size. Allowed range is from +0 to 25. Default value is 2 percent. This option also +controls quality of interpolated samples using neighbour good samples. +

+
+
t
+

Set threshold value. Allowed range is from 1 to 100. +Default value is 2. +This controls the strength of impulsive noise which is going to be removed. +The lower value, the more samples will be detected as impulsive noise. +

+
+
b
+

Set burst fusion, in percentage of window size. Allowed range is 0 to +10. Default value is 2. +If any two samples detected as noise are spaced less than this value then any +sample between those two samples will be also detected as noise. +

+
+
m
+

Set overlap method. +

+

It accepts the following values: +

+
a
+

Select overlap-add method. Even not interpolated samples are slightly +changed with this method. +

+
+
s
+

Select overlap-save method. Not interpolated samples remain unchanged. +

+
+ +

Default value is a. +

+
+ + +

27.9 adeclip

+

Remove clipped samples from input audio. +

+

Samples detected as clipped are replaced by interpolated samples using +autoregressive modelling. +

+
+
w
+

Set window size, in milliseconds. Allowed range is from 10 to 100. +Default value is 55 milliseconds. +This sets size of window which will be processed at once. +

+
+
o
+

Set window overlap, in percentage of window size. Allowed range is from 50 +to 95. Default value is 75 percent. +

+
+
a
+

Set autoregression order, in percentage of window size. Allowed range is from +0 to 25. Default value is 8 percent. This option also controls +quality of interpolated samples using neighbour good samples. +

+
+
t
+

Set threshold value. Allowed range is from 1 to 100. +Default value is 10. Higher values make clip detection less aggressive. +

+
+
n
+

Set size of histogram used to detect clips. Allowed range is from 100 to 9999. +Default value is 1000. Higher values make clip detection less aggressive. +

+
+
m
+

Set overlap method. +

+

It accepts the following values: +

+
a
+

Select overlap-add method. Even not interpolated samples are slightly changed +with this method. +

+
+
s
+

Select overlap-save method. Not interpolated samples remain unchanged. +

+
+ +

Default value is a. +

+
+ + +

27.10 adelay

+ +

Delay one or more audio channels. +

+

Samples in delayed channel are filled with silence. +

+

The filter accepts the following option: +

+
+
delays
+

Set list of delays in milliseconds for each channel separated by ’|’. +Unused delays will be silently ignored. If number of given delays is +smaller than number of channels all remaining channels will not be delayed. +If you want to delay exact number of samples, append ’S’ to number. +If you want instead to delay in seconds, append ’s’ to number. +

+
+
all
+

Use last set delay for all remaining channels. By default is disabled. +This option if enabled changes how option delays is interpreted. +

+
+ + +

27.10.1 Examples

+ +
    +
  • Delay first channel by 1.5 seconds, the third channel by 0.5 seconds and leave +the second channel (and any other channels that may be present) unchanged. +
    +
    adelay=1500|0|500
+
    + +
  • Delay second channel by 500 samples, the third channel by 700 samples and leave +the first channel (and any other channels that may be present) unchanged. +
    +
    adelay=0|500S|700S
+
    + +
  • Delay all channels by same number of samples: +
    +
    adelay=delays=64S:all=1
+
    +
+ + +

27.11 aderivative, aintegral

+ +

Compute derivative/integral of audio stream. +

+

Applying both filters one after another produces original audio. +

+ +

27.12 aecho

+ +

Apply echoing to the input audio. +

+

Echoes are reflected sound and can occur naturally amongst mountains +(and sometimes large buildings) when talking or shouting; digital echo +effects emulate this behaviour and are often used to help fill out the +sound of a single instrument or vocal. The time difference between the +original signal and the reflection is the delay, and the +loudness of the reflected signal is the decay. +Multiple echoes can have different delays and decays. +

+

A description of the accepted parameters follows. +

+
+
in_gain
+

Set input gain of reflected signal. Default is 0.6. +

+
+
out_gain
+

Set output gain of reflected signal. Default is 0.3. +

+
+
delays
+

Set list of time intervals in milliseconds between original signal and reflections +separated by ’|’. Allowed range for each delay is (0 - 90000.0]. +Default is 1000. +

+
+
decays
+

Set list of loudness of reflected signals separated by ’|’. +Allowed range for each decay is (0 - 1.0]. +Default is 0.5. +

+
+ + +

27.12.1 Examples

+ +
    +
  • Make it sound as if there are twice as many instruments as are actually playing: +
    +
    aecho=0.8:0.88:60:0.4
+
    + +
  • If delay is very short, then it sounds like a (metallic) robot playing music: +
    +
    aecho=0.8:0.88:6:0.4
+
    + +
  • A longer delay will sound like an open air concert in the mountains: +
    +
    aecho=0.8:0.9:1000:0.3
+
    + +
  • Same as above but with one more mountain: +
    +
    aecho=0.8:0.9:1000|1800:0.3|0.25
+
    +
+ + +

27.13 aemphasis

+

Audio emphasis filter creates or restores material directly taken from LPs or +emphased CDs with different filter curves. E.g. to store music on vinyl the +signal has to be altered by a filter first to even out the disadvantages of +this recording medium. +Once the material is played back the inverse filter has to be applied to +restore the distortion of the frequency response. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. +

+
+
level_out
+

Set output gain. +

+
+
mode
+

Set filter mode. For restoring material use reproduction mode, otherwise +use production mode. Default is reproduction mode. +

+
+
type
+

Set filter type. Selects medium. Can be one of the following: +

+
+
col
+

select Columbia. +

+
emi
+

select EMI. +

+
bsi
+

select BSI (78RPM). +

+
riaa
+

select RIAA. +

+
cd
+

select Compact Disc (CD). +

+
50fm
+

select 50µs (FM). +

+
75fm
+

select 75µs (FM). +

+
50kf
+

select 50µs (FM-KF). +

+
75kf
+

select 75µs (FM-KF). +

+
+
+
+ + +

27.14 aeval

+ +

Modify an audio signal according to the specified expressions. +

+

This filter accepts one or more expressions (one for each channel), +which are evaluated and used to modify a corresponding audio signal. +

+

It accepts the following parameters: +

+
+
exprs
+

Set the ’|’-separated expressions list for each separate channel. If +the number of input channels is greater than the number of +expressions, the last specified expression is used for the remaining +output channels. +

+
+
channel_layout, c
+

Set output channel layout. If not specified, the channel layout is +specified by the number of expressions. If set to ‘same’, it will +use by default the same input channel layout. +

+
+ +

Each expression in exprs can contain the following constants and functions: +

+
+
ch
+

channel number of the current expression +

+
+
n
+

number of the evaluated sample, starting from 0 +

+
+
s
+

sample rate +

+
+
t
+

time of the evaluated sample expressed in seconds +

+
+
nb_in_channels
+
nb_out_channels
+

input and output number of channels +

+
+
val(CH)
+

the value of input channel with number CH +

+
+ +

Note: this filter is slow. For faster processing you should use a +dedicated filter. +

+ +

27.14.1 Examples

+ +
    +
  • Half volume: +
    +
    aeval=val(ch)/2:c=same
+
    + +
  • Invert phase of the second channel: +
    +
    aeval=val(0)|-val(1)
+
    +
+ + +

27.15 afade

+ +

Apply fade-in/out effect to input audio. +

+

A description of the accepted parameters follows. +

+
+
type, t
+

Specify the effect type, can be either in for fade-in, or +out for a fade-out effect. Default is in. +

+
+
start_sample, ss
+

Specify the number of the start sample for starting to apply the fade +effect. Default is 0. +

+
+
nb_samples, ns
+

Specify the number of samples for which the fade effect has to last. At +the end of the fade-in effect the output audio will have the same +volume as the input audio, at the end of the fade-out transition +the output audio will be silence. Default is 44100. +

+
+
start_time, st
+

Specify the start time of the fade effect. Default is 0. +The value must be specified as a time duration; see +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +If set this option is used instead of start_sample. +

+
+
duration, d
+

Specify the duration of the fade effect. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +At the end of the fade-in effect the output audio will have the same +volume as the input audio, at the end of the fade-out transition +the output audio will be silence. +By default the duration is determined by nb_samples. +If set this option is used instead of nb_samples. +

+
+
curve
+

Set curve for fade transition. +

+

It accepts the following values: +

+
tri
+

select triangular, linear slope (default) +

+
qsin
+

select quarter of sine wave +

+
hsin
+

select half of sine wave +

+
esin
+

select exponential sine wave +

+
log
+

select logarithmic +

+
ipar
+

select inverted parabola +

+
qua
+

select quadratic +

+
cub
+

select cubic +

+
squ
+

select square root +

+
cbr
+

select cubic root +

+
par
+

select parabola +

+
exp
+

select exponential +

+
iqsin
+

select inverted quarter of sine wave +

+
ihsin
+

select inverted half of sine wave +

+
dese
+

select double-exponential seat +

+
desi
+

select double-exponential sigmoid +

+
losi
+

select logistic sigmoid +

+
nofade
+

no fade applied +

+
+
+
+ + +

27.15.1 Examples

+ +
    +
  • Fade in first 15 seconds of audio: +
    +
    afade=t=in:ss=0:d=15
+
    + +
  • Fade out last 25 seconds of a 900 seconds audio: +
    +
    afade=t=out:st=875:d=25
+
    +
+ + +

27.16 afftdn

+

Denoise audio samples with FFT. +

+

A description of the accepted parameters follows. +

+
+
nr
+

Set the noise reduction in dB, allowed range is 0.01 to 97. +Default value is 12 dB. +

+
+
nf
+

Set the noise floor in dB, allowed range is -80 to -20. +Default value is -50 dB. +

+
+
nt
+

Set the noise type. +

+

It accepts the following values: +

+
w
+

Select white noise. +

+
+
v
+

Select vinyl noise. +

+
+
s
+

Select shellac noise. +

+
+
c
+

Select custom noise, defined in bn option. +

+

Default value is white noise. +

+
+ +
+
bn
+

Set custom band noise for every one of 15 bands. +Bands are separated by ’ ’ or ’|’. +

+
+
rf
+

Set the residual floor in dB, allowed range is -80 to -20. +Default value is -38 dB. +

+
+
tn
+

Enable noise tracking. By default is disabled. +With this enabled, noise floor is automatically adjusted. +

+
+
tr
+

Enable residual tracking. By default is disabled. +

+
+
om
+

Set the output mode. +

+

It accepts the following values: +

+
i
+

Pass input unchanged. +

+
+
o
+

Pass noise filtered out. +

+
+
n
+

Pass only noise. +

+

Default value is o. +

+
+
+
+ + +

27.16.1 Commands

+ +

This filter supports the following commands: +

+
sample_noise, sn
+

Start or stop measuring noise profile. +Syntax for the command is : "start" or "stop" string. +After measuring noise profile is stopped it will be +automatically applied in filtering. +

+
+
noise_reduction, nr
+

Change noise reduction. Argument is single float number. +Syntax for the command is : "noise_reduction" +

+
+
noise_floor, nf
+

Change noise floor. Argument is single float number. +Syntax for the command is : "noise_floor" +

+
+
output_mode, om
+

Change output mode operation. +Syntax for the command is : "i", "o" or "n" string. +

+
+ + +

27.17 afftfilt

+

Apply arbitrary expressions to samples in frequency domain. +

+
+
real
+

Set frequency domain real expression for each separate channel separated +by ’|’. Default is "re". +If the number of input channels is greater than the number of +expressions, the last specified expression is used for the remaining +output channels. +

+
+
imag
+

Set frequency domain imaginary expression for each separate channel +separated by ’|’. Default is "im". +

+

Each expression in real and imag can contain the following +constants and functions: +

+
+
sr
+

sample rate +

+
+
b
+

current frequency bin number +

+
+
nb
+

number of available bins +

+
+
ch
+

channel number of the current expression +

+
+
chs
+

number of channels +

+
+
pts
+

current frame pts +

+
+
re
+

current real part of frequency bin of current channel +

+
+
im
+

current imaginary part of frequency bin of current channel +

+
+
real(b, ch)
+

Return the value of real part of frequency bin at location (bin,channel) +

+
+
imag(b, ch)
+

Return the value of imaginary part of frequency bin at location (bin,channel) +

+
+ +
+
win_size
+

Set window size. Allowed range is from 16 to 131072. +Default is 4096 +

+
+
win_func
+

Set window function. Default is hann. +

+
+
overlap
+

Set window overlap. If set to 1, the recommended overlap for selected +window function will be picked. Default is 0.75. +

+
+ + +

27.17.1 Examples

+ +
    +
  • Leave almost only low frequencies in audio: +
    +
    afftfilt="'real=re * (1-clip((b/nb)*b,0,1))':imag='im * (1-clip((b/nb)*b,0,1))'"
+
    + +
  • Apply robotize effect: +
    +
    afftfilt="real='hypot(re,im)*sin(0)':imag='hypot(re,im)*cos(0)':win_size=512:overlap=0.75"
+
    + +
  • Apply whisper effect: +
    +
    afftfilt="real='hypot(re,im)*cos((random(0)*2-1)*2*3.14)':imag='hypot(re,im)*sin((random(1)*2-1)*2*3.14)':win_size=128:overlap=0.8"
+
    +
+ + +

27.18 afir

+ +

Apply an arbitrary Finite Impulse Response filter. +

+

This filter is designed for applying long FIR filters, +up to 60 seconds long. +

+

It can be used as component for digital crossover filters, +room equalization, cross talk cancellation, wavefield synthesis, +auralization, ambiophonics, ambisonics and spatialization. +

+

This filter uses the streams higher than first one as FIR coefficients. +If the non-first stream holds a single channel, it will be used +for all input channels in the first stream, otherwise +the number of channels in the non-first stream must be same as +the number of channels in the first stream. +

+

It accepts the following parameters: +

+
+
dry
+

Set dry gain. This sets input gain. +

+
+
wet
+

Set wet gain. This sets final output gain. +

+
+
length
+

Set Impulse Response filter length. Default is 1, which means whole IR is processed. +

+
+
gtype
+

Enable applying gain measured from power of IR. +

+

Set which approach to use for auto gain measurement. +

+
+
none
+

Do not apply any gain. +

+
+
peak
+

select peak gain, very conservative approach. This is default value. +

+
+
dc
+

select DC gain, limited application. +

+
+
gn
+

select gain to noise approach, this is most popular one. +

+
+ +
+
irgain
+

Set gain to be applied to IR coefficients before filtering. +Allowed range is 0 to 1. This gain is applied after any gain applied with gtype option. +

+
+
irfmt
+

Set format of IR stream. Can be mono or input. +Default is input. +

+
+
maxir
+

Set max allowed Impulse Response filter duration in seconds. Default is 30 seconds. +Allowed range is 0.1 to 60 seconds. +

+
+
response
+

Show IR frequency response, magnitude(magenta), phase(green) and group delay(yellow) in additional video stream. +By default it is disabled. +

+
+
channel
+

Set for which IR channel to display frequency response. By default is first channel +displayed. This option is used only when response is enabled. +

+
+
size
+

Set video stream size. This option is used only when response is enabled. +

+
+
rate
+

Set video stream frame rate. This option is used only when response is enabled. +

+
+
minp
+

Set minimal partition size used for convolution. Default is 8192. +Allowed range is from 1 to 32768. +Lower values decreases latency at cost of higher CPU usage. +

+
+
maxp
+

Set maximal partition size used for convolution. Default is 8192. +Allowed range is from 8 to 32768. +Lower values may increase CPU usage. +

+
+
nbirs
+

Set number of input impulse responses streams which will be switchable at runtime. +Allowed range is from 1 to 32. Default is 1. +

+
+
ir
+

Set IR stream which will be used for convolution, starting from 0, should always be +lower than supplied value by nbirs option. Default is 0. +This option can be changed at runtime via commands. +

+
+ + +

27.18.1 Examples

+ +
    +
  • Apply reverb to stream using mono IR file as second input, complete command using ffmpeg: +
    +
    ffmpeg -i input.wav -i middle_tunnel_1way_mono.wav -lavfi afir output.wav
+
    +
+ + +

27.19 aformat

+ +

Set output format constraints for the input audio. The framework will +negotiate the most appropriate format to minimize conversions. +

+

It accepts the following parameters: +

+
sample_fmts, f
+

A ’|’-separated list of requested sample formats. +

+
+
sample_rates, r
+

A ’|’-separated list of requested sample rates. +

+
+
channel_layouts, cl
+

A ’|’-separated list of requested channel layouts. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+ +

If a parameter is omitted, all values are allowed. +

+

Force the output to either unsigned 8-bit or signed 16-bit stereo +

+
aformat=sample_fmts=u8|s16:channel_layouts=stereo
+
+ + +

27.20 agate

+ +

A gate is mainly used to reduce lower parts of a signal. This kind of signal +processing reduces disturbing noise between useful signals. +

+

Gating is done by detecting the volume below a chosen level threshold +and dividing it by the factor set with ratio. The bottom of the noise +floor is set via range. Because an exact manipulation of the signal +would cause distortion of the waveform the reduction can be levelled over +time. This is done by setting attack and release. +

+

attack determines how long the signal has to fall below the threshold +before any reduction will occur and release sets the time the signal +has to rise above the threshold to reduce the reduction again. +Shorter signals than the chosen attack time will be left untouched. +

+
+
level_in
+

Set input level before filtering. +Default is 1. Allowed range is from 0.015625 to 64. +

+
+
mode
+

Set the mode of operation. Can be upward or downward. +Default is downward. If set to upward mode, higher parts of signal +will be amplified, expanding dynamic range in upward direction. +Otherwise, in case of downward lower parts of signal will be reduced. +

+
+
range
+

Set the level of gain reduction when the signal is below the threshold. +Default is 0.06125. Allowed range is from 0 to 1. +Setting this to 0 disables reduction and then filter behaves like expander. +

+
+
threshold
+

If a signal rises above this level the gain reduction is released. +Default is 0.125. Allowed range is from 0 to 1. +

+
+
ratio
+

Set a ratio by which the signal is reduced. +Default is 2. Allowed range is from 1 to 9000. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction stops. +Default is 20 milliseconds. Allowed range is from 0.01 to 9000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before the +reduction is increased again. Default is 250 milliseconds. +Allowed range is from 0.01 to 9000. +

+
+
makeup
+

Set amount of amplification of signal after processing. +Default is 1. Allowed range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.828427125. Allowed range is from 1 to 8. +

+
+
detection
+

Choose if exact signal should be taken for detection or an RMS like one. +Default is rms. Can be peak or rms. +

+
+
link
+

Choose if the average level between all channels or the louder channel affects +the reduction. +Default is average. Can be average or maximum. +

+
+ + +

27.21 aiir

+ +

Apply an arbitrary Infinite Impulse Response filter. +

+

It accepts the following parameters: +

+
+
zeros, z
+

Set numerator/zeros coefficients. +

+
+
poles, p
+

Set denominator/poles coefficients. +

+
+
gains, k
+

Set channels gains. +

+
+
dry_gain
+

Set input gain. +

+
+
wet_gain
+

Set output gain. +

+
+
format, f
+

Set coefficients format. +

+
+
‘tf’
+

digital transfer function +

+
‘zp’
+

Z-plane zeros/poles, cartesian (default) +

+
‘pr’
+

Z-plane zeros/poles, polar radians +

+
‘pd’
+

Z-plane zeros/poles, polar degrees +

+
‘sp’
+

S-plane zeros/poles +

+
+ +
+
process, r
+

Set kind of processing. +Can be d - direct or s - serial cascading. Default is s. +

+
+
precision, e
+

Set filtering precision. +

+
+
‘dbl’
+

double-precision floating-point (default) +

+
‘flt’
+

single-precision floating-point +

+
‘i32’
+

32-bit integers +

+
‘i16’
+

16-bit integers +

+
+ +
+
normalize, n
+

Normalize filter coefficients, by default is enabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+
mix
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
response
+

Show IR frequency response, magnitude(magenta), phase(green) and group delay(yellow) in additional video stream. +By default it is disabled. +

+
+
channel
+

Set for which IR channel to display frequency response. By default is first channel +displayed. This option is used only when response is enabled. +

+
+
size
+

Set video stream size. This option is used only when response is enabled. +

+
+ +

Coefficients in tf format are separated by spaces and are in ascending +order. +

+

Coefficients in zp format are separated by spaces and order of coefficients +doesn’t matter. Coefficients in zp format are complex numbers with i +imaginary unit. +

+

Different coefficients and gains can be provided for every channel, in such case +use ’|’ to separate coefficients or gains. Last provided coefficients will be +used for all remaining channels. +

+ +

27.21.1 Examples

+ +
    +
  • Apply 2 pole elliptic notch at around 5000Hz for 48000 Hz sample rate: +
    +
    aiir=k=1:z=7.957584807809675810E-1 -2.575128568908332300 3.674839853930788710 -2.57512875289799137 7.957586296317130880E-1:p=1 -2.86950072432325953 3.63022088054647218 -2.28075678147272232 6.361362326477423500E-1:f=tf:r=d
+
    + +
  • Same as above but in zp format: +
    +
    aiir=k=0.79575848078096756:z=0.80918701+0.58773007i 0.80918701-0.58773007i 0.80884700+0.58784055i 0.80884700-0.58784055i:p=0.63892345+0.59951235i 0.63892345-0.59951235i 0.79582691+0.44198673i 0.79582691-0.44198673i:f=zp:r=s
+
    +
+ + +

27.22 alimiter

+ +

The limiter prevents an input signal from rising over a desired threshold. +This limiter uses lookahead technology to prevent your signal from distorting. +It means that there is a small delay after the signal is processed. Keep in mind +that the delay it produces is the attack time you set. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. Default is 1. +

+
+
level_out
+

Set output gain. Default is 1. +

+
+
limit
+

Don’t let signals above this level pass the limiter. Default is 1. +

+
+
attack
+

The limiter will reach its attenuation level in this amount of time in +milliseconds. Default is 5 milliseconds. +

+
+
release
+

Come back from limiting to attenuation 1.0 in this amount of milliseconds. +Default is 50 milliseconds. +

+
+
asc
+

When gain reduction is always needed ASC takes care of releasing to an +average reduction level rather than reaching a reduction of 0 in the release +time. +

+
+
asc_level
+

Select how much the release time is affected by ASC, 0 means nearly no changes +in release time while 1 produces higher release times. +

+
+
level
+

Auto level output signal. Default is enabled. +This normalizes audio back to 0dB if enabled. +

+
+ +

Depending on picked setting it is recommended to upsample input 2x or 4x times +with aresample before applying this filter. +

+ +

27.23 allpass

+ +

Apply a two-pole all-pass filter with central frequency (in Hz) +frequency, and filter-width width. +An all-pass filter changes the audio’s frequency to phase relationship +without changing its frequency to amplitude relationship. +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set frequency in Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+
order, o
+

Set the filter order, can be 1 or 2. Default is 2. +

+
+ + +

27.23.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change allpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change allpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change allpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change allpass mix. +Syntax for the command is : "mix" +

+
+ + +

27.24 aloop

+ +

Loop audio samples. +

+

The filter accepts the following options: +

+
+
loop
+

Set the number of loops. Setting this value to -1 will result in infinite loops. +Default is 0. +

+
+
size
+

Set maximal number of samples. Default is 0. +

+
+
start
+

Set first sample of loop. Default is 0. +

+
+ + +

27.25 amerge

+ +

Merge two or more audio streams into a single multi-channel stream. +

+

The filter accepts the following options: +

+
+
inputs
+

Set the number of inputs. Default is 2. +

+
+
+ +

If the channel layouts of the inputs are disjoint, and therefore compatible, +the channel layout of the output will be set accordingly and the channels +will be reordered as necessary. If the channel layouts of the inputs are not +disjoint, the output will have all the channels of the first input then all +the channels of the second input, in that order, and the channel layout of +the output will be the default value corresponding to the total number of +channels. +

+

For example, if the first input is in 2.1 (FL+FR+LF) and the second input +is FC+BL+BR, then the output will be in 5.1, with the channels in the +following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the +first input, b1 is the first channel of the second input). +

+

On the other hand, if both input are in stereo, the output channels will be +in the default order: a1, a2, b1, b2, and the channel layout will be +arbitrarily set to 4.0, which may or may not be the expected value. +

+

All inputs must have the same sample rate, and format. +

+

If inputs do not have the same duration, the output will stop with the +shortest. +

+ +

27.25.1 Examples

+ +
    +
  • Merge two mono files into a stereo stream: +
    +
    amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
+
    + +
  • Multiple merges assuming 1 video stream and 6 audio streams in input.mkv: +
    +
    ffmpeg -i input.mkv -filter_complex "[0:1][0:2][0:3][0:4][0:5][0:6] amerge=inputs=6" -c:a pcm_s16le output.mkv
+
    +
+ + +

27.26 amix

+ +

Mixes multiple audio inputs into a single output. +

+

Note that this filter only supports float samples (the amerge +and pan audio filters support many formats). If the amix +input has integer samples then aresample will be automatically +inserted to perform the conversion to float samples. +

+

For example +

+
ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
+
+

will mix 3 input audio streams to a single output with the same duration as the +first input and a dropout transition time of 3 seconds. +

+

It accepts the following parameters: +

+
inputs
+

The number of inputs. If unspecified, it defaults to 2. +

+
+
duration
+

How to determine the end-of-stream. +

+
longest
+

The duration of the longest input. (default) +

+
+
shortest
+

The duration of the shortest input. +

+
+
first
+

The duration of the first input. +

+
+
+ +
+
dropout_transition
+

The transition time, in seconds, for volume renormalization when an input +stream ends. The default value is 2 seconds. +

+
+
weights
+

Specify weight of each input audio stream as sequence. +Each weight is separated by space. By default all inputs have same weight. +

+
+ + +

27.26.1 Commands

+ +

This filter supports the following commands: +

+
weights
+

Syntax is same as option with same name. +

+
+ + +

27.27 amultiply

+ +

Multiply first audio stream with second audio stream and store result +in output audio stream. Multiplication is done by multiplying each +sample from first stream with sample at same position from second stream. +

+

With this element-wise multiplication one can create amplitude fades and +amplitude modulations. +

+ +

27.28 anequalizer

+ +

High-order parametric multiband equalizer for each channel. +

+

It accepts the following parameters: +

+
params
+
+

This option string is in format: +"cchn f=cf w=w g=g t=f | ..." +Each equalizer band is separated by ’|’. +

+
+
chn
+

Set channel number to which equalization will be applied. +If input doesn’t have that channel the entry is ignored. +

+
+
f
+

Set central frequency for band. +If input doesn’t have that frequency the entry is ignored. +

+
+
w
+

Set band width in hertz. +

+
+
g
+

Set band gain in dB. +

+
+
t
+

Set filter type for band, optional, can be: +

+
+
‘0’
+

Butterworth, this is default. +

+
+
‘1’
+

Chebyshev type 1. +

+
+
‘2’
+

Chebyshev type 2. +

+
+
+
+ +
+
curves
+

With this option activated frequency response of anequalizer is displayed +in video stream. +

+
+
size
+

Set video stream size. Only useful if curves option is activated. +

+
+
mgain
+

Set max gain that will be displayed. Only useful if curves option is activated. +Setting this to a reasonable value makes it possible to display gain which is derived from +neighbour bands which are too close to each other and thus produce higher gain +when both are activated. +

+
+
fscale
+

Set frequency scale used to draw frequency response in video output. +Can be linear or logarithmic. Default is logarithmic. +

+
+
colors
+

Set color for each channel curve which is going to be displayed in video stream. +This is list of color names separated by space or by ’|’. +Unrecognised or missing colors will be replaced by white color. +

+
+ + +

27.28.1 Examples

+ +
    +
  • Lower gain by 10 of central frequency 200Hz and width 100 Hz +for first 2 channels using Chebyshev type 1 filter: +
    +
    anequalizer=c0 f=200 w=100 g=-10 t=1|c1 f=200 w=100 g=-10 t=1
+
    +
+ + +

27.28.2 Commands

+ +

This filter supports the following commands: +

+
change
+

Alter existing filter parameters. +Syntax for the commands is : "fN|f=freq|w=width|g=gain" +

+

fN is existing filter number, starting from 0, if no such filter is available +error is returned. +freq set new frequency parameter. +width set new width parameter in herz. +gain set new gain parameter in dB. +

+

Full filter invocation with asendcmd may look like this: +asendcmd=c=’4.0 anequalizer change 0|f=200|w=50|g=1’,anequalizer=... +

+
+ + +

27.29 anlmdn

+ +

Reduce broadband noise in audio samples using Non-Local Means algorithm. +

+

Each sample is adjusted by looking for other samples with similar contexts. This +context similarity is defined by comparing their surrounding patches of size +p. Patches are searched in an area of r around the sample. +

+

The filter accepts the following options: +

+
+
s
+

Set denoising strength. Allowed range is from 0.00001 to 10. Default value is 0.00001. +

+
+
p
+

Set patch radius duration. Allowed range is from 1 to 100 milliseconds. +Default value is 2 milliseconds. +

+
+
r
+

Set research radius duration. Allowed range is from 2 to 300 milliseconds. +Default value is 6 milliseconds. +

+
+
o
+

Set the output mode. +

+

It accepts the following values: +

+
i
+

Pass input unchanged. +

+
+
o
+

Pass noise filtered out. +

+
+
n
+

Pass only noise. +

+

Default value is o. +

+
+ +
+
m
+

Set smooth factor. Default value is 11. Allowed range is from 1 to 15. +

+
+ + +

27.29.1 Commands

+ +

This filter supports the following commands: +

+
s
+

Change denoise strength. Argument is single float number. +Syntax for the command is : "s" +

+
+
o
+

Change output mode. +Syntax for the command is : "i", "o" or "n" string. +

+
+ + +

27.30 anlms

+

Apply Normalized Least-Mean-Squares algorithm to the first audio stream using the second audio stream. +

+

This adaptive filter is used to mimic a desired filter by finding the filter coefficients that +relate to producing the least mean square of the error signal (difference between the desired, +2nd input audio stream and the actual signal, the 1st input audio stream). +

+

A description of the accepted options follows. +

+
+
order
+

Set filter order. +

+
+
mu
+

Set filter mu. +

+
+
eps
+

Set the filter eps. +

+
+
leakage
+

Set the filter leakage. +

+
+
out_mode
+

It accepts the following values: +

+
i
+

Pass the 1st input. +

+
+
d
+

Pass the 2nd input. +

+
+
o
+

Pass filtered samples. +

+
+
n
+

Pass difference between desired and filtered samples. +

+

Default value is o. +

+
+
+
+ + +

27.30.1 Examples

+ +
    +
  • One of many usages of this filter is noise reduction, input audio is filtered +with same samples that are delayed by fixed amount, one such example for stereo audio is: +
    +
    asplit[a][b],[a]adelay=32S|32S[a],[b][a]anlms=order=128:leakage=0.0005:mu=.5:out_mode=o
+
    +
+ + +

27.30.2 Commands

+ +

This filter supports the same commands as options, excluding option order. +

+ +

27.31 anull

+ +

Pass the audio source unchanged to the output. +

+ +

27.32 apad

+ +

Pad the end of an audio stream with silence. +

+

This can be used together with ffmpeg -shortest to +extend audio streams to the same length as the video stream. +

+

A description of the accepted options follows. +

+
+
packet_size
+

Set silence packet size. Default value is 4096. +

+
+
pad_len
+

Set the number of samples of silence to add to the end. After the +value is reached, the stream is terminated. This option is mutually +exclusive with whole_len. +

+
+
whole_len
+

Set the minimum total number of samples in the output audio stream. If +the value is longer than the input audio length, silence is added to +the end, until the value is reached. This option is mutually exclusive +with pad_len. +

+
+
pad_dur
+

Specify the duration of samples of silence to add. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. Used only if set to non-zero value. +

+
+
whole_dur
+

Specify the minimum total duration in the output audio stream. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. Used only if set to non-zero value. If the value is longer than +the input audio length, silence is added to the end, until the value is reached. +This option is mutually exclusive with pad_dur +

+
+ +

If neither the pad_len nor the whole_len nor pad_dur +nor whole_dur option is set, the filter will add silence to the end of +the input stream indefinitely. +

+ +

27.32.1 Examples

+ +
    +
  • Add 1024 samples of silence to the end of the input: +
    +
    apad=pad_len=1024
+
    + +
  • Make sure the audio output will contain at least 10000 samples, pad +the input with silence if required: +
    +
    apad=whole_len=10000
+
    + +
  • Use ffmpeg to pad the audio input with silence, so that the +video stream will always result the shortest and will be converted +until the end in the output file when using the shortest +option: +
    +
    ffmpeg -i VIDEO -i AUDIO -filter_complex "[1:0]apad" -shortest OUTPUT
+
    +
+ + +

27.33 aphaser

+

Add a phasing effect to the input audio. +

+

A phaser filter creates series of peaks and troughs in the frequency spectrum. +The position of the peaks and troughs are modulated so that they vary over time, creating a sweeping effect. +

+

A description of the accepted parameters follows. +

+
+
in_gain
+

Set input gain. Default is 0.4. +

+
+
out_gain
+

Set output gain. Default is 0.74 +

+
+
delay
+

Set delay in milliseconds. Default is 3.0. +

+
+
decay
+

Set decay. Default is 0.4. +

+
+
speed
+

Set modulation speed in Hz. Default is 0.5. +

+
+
type
+

Set modulation type. Default is triangular. +

+

It accepts the following values: +

+
‘triangular, t’
+
‘sinusoidal, s’
+
+
+
+ + +

27.34 apulsator

+ +

Audio pulsator is something between an autopanner and a tremolo. +But it can produce funny stereo effects as well. Pulsator changes the volume +of the left and right channel based on a LFO (low frequency oscillator) with +different waveforms and shifted phases. +This filter have the ability to define an offset between left and right +channel. An offset of 0 means that both LFO shapes match each other. +The left and right channel are altered equally - a conventional tremolo. +An offset of 50% means that the shape of the right channel is exactly shifted +in phase (or moved backwards about half of the frequency) - pulsator acts as +an autopanner. At 1 both curves match again. Every setting in between moves the +phase shift gapless between all stages and produces some "bypassing" sounds with +sine and triangle waveforms. The more you set the offset near 1 (starting from +the 0.5) the faster the signal passes from the left to the right speaker. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. By default it is 1. Range is [0.015625 - 64]. +

+
+
level_out
+

Set output gain. By default it is 1. Range is [0.015625 - 64]. +

+
+
mode
+

Set waveform shape the LFO will use. Can be one of: sine, triangle, square, +sawup or sawdown. Default is sine. +

+
+
amount
+

Set modulation. Define how much of original signal is affected by the LFO. +

+
+
offset_l
+

Set left channel offset. Default is 0. Allowed range is [0 - 1]. +

+
+
offset_r
+

Set right channel offset. Default is 0.5. Allowed range is [0 - 1]. +

+
+
width
+

Set pulse width. Default is 1. Allowed range is [0 - 2]. +

+
+
timing
+

Set possible timing mode. Can be one of: bpm, ms or hz. Default is hz. +

+
+
bpm
+

Set bpm. Default is 120. Allowed range is [30 - 300]. Only used if timing +is set to bpm. +

+
+
ms
+

Set ms. Default is 500. Allowed range is [10 - 2000]. Only used if timing +is set to ms. +

+
+
hz
+

Set frequency in Hz. Default is 2. Allowed range is [0.01 - 100]. Only used +if timing is set to hz. +

+
+ + +

27.35 aresample

+ +

Resample the input audio to the specified parameters, using the +libswresample library. If none are specified then the filter will +automatically convert between its input and output. +

+

This filter is also able to stretch/squeeze the audio data to make it match +the timestamps or to inject silence / cut out audio to make it match the +timestamps, do a combination of both or do neither. +

+

The filter accepts the syntax +[sample_rate:]resampler_options, where sample_rate +expresses a sample rate and resampler_options is a list of +key=value pairs, separated by ":". See the +(ffmpeg-resampler)"Resampler Options" section in the +ffmpeg-resampler(1) manual +for the complete list of supported options. +

+ +

27.35.1 Examples

+ +
    +
  • Resample the input audio to 44100Hz: +
    +
    aresample=44100
+
    + +
  • Stretch/squeeze samples to the given timestamps, with a maximum of 1000 +samples per second compensation: +
    +
    aresample=async=1000
+
    +
+ + +

27.36 areverse

+ +

Reverse an audio clip. +

+

Warning: This filter requires memory to buffer the entire clip, so trimming +is suggested. +

+ +

27.36.1 Examples

+ +
    +
  • Take the first 5 seconds of a clip, and reverse it. +
    +
    atrim=end=5,areverse
+
    +
+ + +

27.37 arnndn

+ +

Reduce noise from speech using Recurrent Neural Networks. +

+

This filter accepts the following options: +

+
+
model, m
+

Set train model file to load. This option is always required. +

+
+ + +

27.38 asetnsamples

+ +

Set the number of samples per each output audio frame. +

+

The last output packet may contain a different number of samples, as +the filter will flush all the remaining samples when the input audio +signals its end. +

+

The filter accepts the following options: +

+
+
nb_out_samples, n
+

Set the number of frames per each output audio frame. The number is +intended as the number of samples per each channel. +Default value is 1024. +

+
+
pad, p
+

If set to 1, the filter will pad the last audio frame with zeroes, so +that the last frame will contain the same number of samples as the +previous ones. Default value is 1. +

+
+ +

For example, to set the number of per-frame samples to 1234 and +disable padding for the last frame, use: +

+
asetnsamples=n=1234:p=0
+
+ + +

27.39 asetrate

+ +

Set the sample rate without altering the PCM data. +This will result in a change of speed and pitch. +

+

The filter accepts the following options: +

+
+
sample_rate, r
+

Set the output sample rate. Default is 44100 Hz. +

+
+ + +

27.40 ashowinfo

+ +

Show a line containing various information for each input audio frame. +The input audio is not modified. +

+

The shown line contains a sequence of key/value pairs of the form +key:value. +

+

The following values are shown in the output: +

+
+
n
+

The (sequential) number of the input frame, starting from 0. +

+
+
pts
+

The presentation timestamp of the input frame, in time base units; the time base +depends on the filter input pad, and is usually 1/sample_rate. +

+
+
pts_time
+

The presentation timestamp of the input frame in seconds. +

+
+
pos
+

position of the frame in the input stream, -1 if this information in +unavailable and/or meaningless (for example in case of synthetic audio) +

+
+
fmt
+

The sample format. +

+
+
chlayout
+

The channel layout. +

+
+
rate
+

The sample rate for the audio frame. +

+
+
nb_samples
+

The number of samples (per channel) in the frame. +

+
+
checksum
+

The Adler-32 checksum (printed in hexadecimal) of the audio data. For planar +audio, the data is treated as if all the planes were concatenated. +

+
+
plane_checksums
+

A list of Adler-32 checksums for each data plane. +

+
+ + +

27.41 asoftclip

+

Apply audio soft clipping. +

+

Soft clipping is a type of distortion effect where the amplitude of a signal is saturated +along a smooth curve, rather than the abrupt shape of hard-clipping. +

+

This filter accepts the following options: +

+
+
type
+

Set type of soft-clipping. +

+

It accepts the following values: +

+
tanh
+
atan
+
cubic
+
exp
+
alg
+
quintic
+
sin
+
+ +
+
param
+

Set additional parameter which controls sigmoid function. +

+
+ + +

27.41.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

27.42 asr

+

Automatic Speech Recognition +

+

This filter uses PocketSphinx for speech recognition. To enable +compilation of this filter, you need to configure FFmpeg with +--enable-pocketsphinx. +

+

It accepts the following options: +

+
+
rate
+

Set sampling rate of input audio. Defaults is 16000. +This need to match speech models, otherwise one will get poor results. +

+
+
hmm
+

Set dictionary containing acoustic model files. +

+
+
dict
+

Set pronunciation dictionary. +

+
+
lm
+

Set language model file. +

+
+
lmctl
+

Set language model set. +

+
+
lmname
+

Set which language model to use. +

+
+
logfn
+

Set output for log messages. +

+
+ +

The filter exports recognized speech as the frame metadata lavfi.asr.text. +

+ +

27.43 astats

+ +

Display time domain statistical information about the audio channels. +Statistics are calculated and displayed for each audio channel and, +where applicable, an overall figure is also given. +

+

It accepts the following option: +

+
length
+

Short window length in seconds, used for peak and trough RMS measurement. +Default is 0.05 (50 milliseconds). Allowed range is [0.01 - 10]. +

+
+
metadata
+
+

Set metadata injection. All the metadata keys are prefixed with lavfi.astats.X, +where X is channel number starting from 1 or string Overall. Default is +disabled. +

+

Available keys for each channel are: +DC_offset +Min_level +Max_level +Min_difference +Max_difference +Mean_difference +RMS_difference +Peak_level +RMS_peak +RMS_trough +Crest_factor +Flat_factor +Peak_count +Noise_floor +Noise_floor_count +Bit_depth +Dynamic_range +Zero_crossings +Zero_crossings_rate +Number_of_NaNs +Number_of_Infs +Number_of_denormals +

+

and for Overall: +DC_offset +Min_level +Max_level +Min_difference +Max_difference +Mean_difference +RMS_difference +Peak_level +RMS_level +RMS_peak +RMS_trough +Flat_factor +Peak_count +Noise_floor +Noise_floor_count +Bit_depth +Number_of_samples +Number_of_NaNs +Number_of_Infs +Number_of_denormals +

+

For example full key look like this lavfi.astats.1.DC_offset or +this lavfi.astats.Overall.Peak_count. +

+

For description what each key means read below. +

+
+
reset
+

Set number of frame after which stats are going to be recalculated. +Default is disabled. +

+
+
measure_perchannel
+

Select the entries which need to be measured per channel. The metadata keys can +be used as flags, default is all which measures everything. +none disables all per channel measurement. +

+
+
measure_overall
+

Select the entries which need to be measured overall. The metadata keys can +be used as flags, default is all which measures everything. +none disables all overall measurement. +

+
+
+ +

A description of each shown parameter follows: +

+
+
DC offset
+

Mean amplitude displacement from zero. +

+
+
Min level
+

Minimal sample level. +

+
+
Max level
+

Maximal sample level. +

+
+
Min difference
+

Minimal difference between two consecutive samples. +

+
+
Max difference
+

Maximal difference between two consecutive samples. +

+
+
Mean difference
+

Mean difference between two consecutive samples. +The average of each difference between two consecutive samples. +

+
+
RMS difference
+

Root Mean Square difference between two consecutive samples. +

+
+
Peak level dB
+
RMS level dB
+

Standard peak and RMS level measured in dBFS. +

+
+
RMS peak dB
+
RMS trough dB
+

Peak and trough values for RMS level measured over a short window. +

+
+
Crest factor
+

Standard ratio of peak to RMS level (note: not in dB). +

+
+
Flat factor
+

Flatness (i.e. consecutive samples with the same value) of the signal at its peak levels +(i.e. either Min level or Max level). +

+
+
Peak count
+

Number of occasions (not the number of samples) that the signal attained either +Min level or Max level. +

+
+
Noise floor dB
+

Minimum local peak measured in dBFS over a short window. +

+
+
Noise floor count
+

Number of occasions (not the number of samples) that the signal attained +Noise floor. +

+
+
Bit depth
+

Overall bit depth of audio. Number of bits used for each sample. +

+
+
Dynamic range
+

Measured dynamic range of audio in dB. +

+
+
Zero crossings
+

Number of points where the waveform crosses the zero level axis. +

+
+
Zero crossings rate
+

Rate of Zero crossings and number of audio samples. +

+
+ + +

27.44 asubboost

+

Boost subwoofer frequencies. +

+

The filter accepts the following options: +

+
+
dry
+

Set dry gain, how much of original signal is kept. Allowed range is from 0 to 1. +Default value is 0.5. +

+
+
wet
+

Set wet gain, how much of filtered signal is kept. Allowed range is from 0 to 1. +Default value is 0.8. +

+
+
decay
+

Set delay line decay gain value. Allowed range is from 0 to 1. +Default value is 0.7. +

+
+
feedback
+

Set delay line feedback gain value. Allowed range is from 0 to 1. +Default value is 0.5. +

+
+
cutoff
+

Set cutoff frequency in herz. Allowed range is 50 to 900. +Default value is 100. +

+
+
slope
+

Set slope amount for cutoff frequency. Allowed range is 0.0001 to 1. +Default value is 0.5. +

+
+
delay
+

Set delay. Allowed range is from 1 to 100. +Default value is 20. +

+
+ + +

27.44.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

27.45 atempo

+ +

Adjust audio tempo. +

+

The filter accepts exactly one parameter, the audio tempo. If not +specified then the filter will assume nominal 1.0 tempo. Tempo must +be in the [0.5, 100.0] range. +

+

Note that tempo greater than 2 will skip some samples rather than +blend them in. If for any reason this is a concern it is always +possible to daisy-chain several instances of atempo to achieve the +desired product tempo. +

+ +

27.45.1 Examples

+ +
    +
  • Slow down audio to 80% tempo: +
    +
    atempo=0.8
+
    + +
  • To speed up audio to 300% tempo: +
    +
    atempo=3
+
    + +
  • To speed up audio to 300% tempo by daisy-chaining two atempo instances: +
    +
    atempo=sqrt(3),atempo=sqrt(3)
+
    +
+ + +

27.45.2 Commands

+ +

This filter supports the following commands: +

+
tempo
+

Change filter tempo scale factor. +Syntax for the command is : "tempo" +

+
+ + +

27.46 atrim

+ +

Trim the input so that the output contains one continuous subpart of the input. +

+

It accepts the following parameters: +

+
start
+

Timestamp (in seconds) of the start of the section to keep. I.e. the audio +sample with the timestamp start will be the first sample in the output. +

+
+
end
+

Specify time of the first audio sample that will be dropped, i.e. the +audio sample immediately preceding the one with the timestamp end will be +the last sample in the output. +

+
+
start_pts
+

Same as start, except this option sets the start timestamp in samples +instead of seconds. +

+
+
end_pts
+

Same as end, except this option sets the end timestamp in samples instead +of seconds. +

+
+
duration
+

The maximum duration of the output in seconds. +

+
+
start_sample
+

The number of the first sample that should be output. +

+
+
end_sample
+

The number of the first sample that should be dropped. +

+
+ +

start, end, and duration are expressed as time +duration specifications; see +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+

Note that the first two sets of the start/end options and the duration +option look at the frame timestamp, while the _sample options simply count the +samples that pass through the filter. So start/end_pts and start/end_sample will +give different results when the timestamps are wrong, inexact or do not start at +zero. Also note that this filter does not modify the timestamps. If you wish +to have the output timestamps start at zero, insert the asetpts filter after the +atrim filter. +

+

If multiple start or end options are set, this filter tries to be greedy and +keep all samples that match at least one of the specified constraints. To keep +only the part that matches all the constraints at once, chain multiple atrim +filters. +

+

The defaults are such that all the input is kept. So it is possible to set e.g. +just the end values to keep everything before the specified time. +

+

Examples: +

    +
  • Drop everything except the second minute of input: +
    +
    ffmpeg -i INPUT -af atrim=60:120
+
    + +
  • Keep only the first 1000 samples: +
    +
    ffmpeg -i INPUT -af atrim=end_sample=1000
+
    + +
+ + +

27.47 axcorrelate

+

Calculate normalized cross-correlation between two input audio streams. +

+

Resulted samples are always between -1 and 1 inclusive. +If result is 1 it means two input samples are highly correlated in that selected segment. +Result 0 means they are not correlated at all. +If result is -1 it means two input samples are out of phase, which means they cancel each +other. +

+

The filter accepts the following options: +

+
+
size
+

Set size of segment over which cross-correlation is calculated. +Default is 256. Allowed range is from 2 to 131072. +

+
+
algo
+

Set algorithm for cross-correlation. Can be slow or fast. +Default is slow. Fast algorithm assumes mean values over any given segment +are always zero and thus need much less calculations to make. +This is generally not true, but is valid for typical audio streams. +

+
+ + +

27.47.1 Examples

+ +
    +
  • Calculate correlation between channels in stereo audio stream: +
    +
    ffmpeg -i stereo.wav -af channelsplit,axcorrelate=size=1024:algo=fast correlation.wav
+
    +
+ + +

27.48 bandpass

+ +

Apply a two-pole Butterworth band-pass filter with central +frequency frequency, and (3dB-point) band-width width. +The csg option selects a constant skirt gain (peak gain = Q) +instead of the default: constant 0dB peak gain. +The filter roll off at 6dB per octave (20dB per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the filter’s central frequency. Default is 3000. +

+
+
csg
+

Constant skirt gain if set to 1. Defaults to 0. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

27.48.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change bandpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change bandpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change bandpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change bandpass mix. +Syntax for the command is : "mix" +

+
+ + +

27.49 bandreject

+ +

Apply a two-pole Butterworth band-reject filter with central +frequency frequency, and (3dB-point) band-width width. +The filter roll off at 6dB per octave (20dB per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the filter’s central frequency. Default is 3000. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

27.49.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change bandreject frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change bandreject width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change bandreject width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change bandreject mix. +Syntax for the command is : "mix" +

+
+ + +

27.50 bass, lowshelf

+ +

Boost or cut the bass (lower) frequencies of the audio using a two-pole +shelving filter with a response similar to that of a standard +hi-fi’s tone-controls. This is also known as shelving equalisation (EQ). +

+

The filter accepts the following options: +

+
+
gain, g
+

Give the gain at 0 Hz. Its useful range is about -20 +(for a large cut) to +20 (for a large boost). +Beware of clipping when using a positive gain. +

+
+
frequency, f
+

Set the filter’s central frequency and so can be used +to extend or reduce the frequency range to be boosted or cut. +The default value is 100 Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Determine how steep is the filter’s shelf transition. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

27.50.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change bass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change bass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change bass width. +Syntax for the command is : "width" +

+
+
gain, g
+

Change bass gain. +Syntax for the command is : "gain" +

+
+
mix, m
+

Change bass mix. +Syntax for the command is : "mix" +

+
+ + +

27.51 biquad

+ +

Apply a biquad IIR filter with the given coefficients. +Where b0, b1, b2 and a0, a1, a2 +are the numerator and denominator coefficients respectively. +and channels, c specify which channels to filter, by default all +available are filtered. +

+ +

27.51.1 Commands

+ +

This filter supports the following commands: +

+
a0
+
a1
+
a2
+
b0
+
b1
+
b2
+

Change biquad parameter. +Syntax for the command is : "value" +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

27.52 bs2b

+

Bauer stereo to binaural transformation, which improves headphone listening of +stereo audio records. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libbs2b. +

+

It accepts the following parameters: +

+
profile
+

Pre-defined crossfeed level. +

+
default
+

Default level (fcut=700, feed=50). +

+
+
cmoy
+

Chu Moy circuit (fcut=700, feed=60). +

+
+
jmeier
+

Jan Meier circuit (fcut=650, feed=95). +

+
+
+ +
+
fcut
+

Cut frequency (in Hz). +

+
+
feed
+

Feed level (in Hz). +

+
+
+ + +

27.53 channelmap

+ +

Remap input channels to new locations. +

+

It accepts the following parameters: +

+
map
+

Map channels from input to output. The argument is a ’|’-separated list of +mappings, each in the in_channel-out_channel or +in_channel form. in_channel can be either the name of the input +channel (e.g. FL for front left) or its index in the input channel layout. +out_channel is the name of the output channel or its index in the output +channel layout. If out_channel is not given then it is implicitly an +index, starting with zero and increasing by one for each mapping. +

+
+
channel_layout
+

The channel layout of the output stream. +

+
+ +

If no mapping is present, the filter will implicitly map input channels to +output channels, preserving indices. +

+ +

27.53.1 Examples

+ +
    +
  • For example, assuming a 5.1+downmix input MOV file, +
    +
    ffmpeg -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
+
    +

    will create an output WAV file tagged as stereo from the downmix channels of +the input. +

    +
  • To fix a 5.1 WAV improperly encoded in AAC’s native channel order +
    +
    ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:5.1' out.wav
+
    +
+ + +

27.54 channelsplit

+ +

Split each channel from an input audio stream into a separate output stream. +

+

It accepts the following parameters: +

+
channel_layout
+

The channel layout of the input stream. The default is "stereo". +

+
channels
+

A channel layout describing the channels to be extracted as separate output streams +or "all" to extract each input channel as a separate stream. The default is "all". +

+

Choosing channels not present in channel layout in the input will result in an error. +

+
+ + +

27.54.1 Examples

+ +
    +
  • For example, assuming a stereo input MP3 file, +
    +
    ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
+
    +

    will create an output Matroska file with two audio streams, one containing only +the left channel and the other the right channel. +

    +
  • Split a 5.1 WAV file into per-channel files: +
    +
    ffmpeg -i in.wav -filter_complex
+'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
+-map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
+front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
+side_right.wav
+
    + +
  • Extract only LFE from a 5.1 WAV file: +
    +
    ffmpeg -i in.wav -filter_complex 'channelsplit=channel_layout=5.1:channels=LFE[LFE]'
+-map '[LFE]' lfe.wav
+
    +
+ + +

27.55 chorus

+

Add a chorus effect to the audio. +

+

Can make a single vocal sound like a chorus, but can also be applied to instrumentation. +

+

Chorus resembles an echo effect with a short delay, but whereas with echo the delay is +constant, with chorus, it is varied using using sinusoidal or triangular modulation. +The modulation depth defines the range the modulated delay is played before or after +the delay. Hence the delayed sound will sound slower or faster, that is the delayed +sound tuned around the original one, like in a chorus where some vocals are slightly +off key. +

+

It accepts the following parameters: +

+
in_gain
+

Set input gain. Default is 0.4. +

+
+
out_gain
+

Set output gain. Default is 0.4. +

+
+
delays
+

Set delays. A typical delay is around 40ms to 60ms. +

+
+
decays
+

Set decays. +

+
+
speeds
+

Set speeds. +

+
+
depths
+

Set depths. +

+
+ + +

27.55.1 Examples

+ +
    +
  • A single delay: +
    +
    chorus=0.7:0.9:55:0.4:0.25:2
+
    + +
  • Two delays: +
    +
    chorus=0.6:0.9:50|60:0.4|0.32:0.25|0.4:2|1.3
+
    + +
  • Fuller sounding chorus with three delays: +
    +
    chorus=0.5:0.9:50|60|40:0.4|0.32|0.3:0.25|0.4|0.3:2|2.3|1.3
+
    +
+ + +

27.56 compand

+

Compress or expand the audio’s dynamic range. +

+

It accepts the following parameters: +

+
+
attacks
+
decays
+

A list of times in seconds for each channel over which the instantaneous level +of the input signal is averaged to determine its volume. attacks refers to +increase of volume and decays refers to decrease of volume. For most +situations, the attack time (response to the audio getting louder) should be +shorter than the decay time, because the human ear is more sensitive to sudden +loud audio than sudden soft audio. A typical value for attack is 0.3 seconds and +a typical value for decay is 0.8 seconds. +If specified number of attacks & decays is lower than number of channels, the last +set attack/decay will be used for all remaining channels. +

+
+
points
+

A list of points for the transfer function, specified in dB relative to the +maximum possible signal amplitude. Each key points list must be defined using +the following syntax: x0/y0|x1/y1|x2/y2|.... or +x0/y0 x1/y1 x2/y2 .... +

+

The input values must be in strictly increasing order but the transfer function +does not have to be monotonically rising. The point 0/0 is assumed but +may be overridden (by 0/out-dBn). Typical values for the transfer +function are -70/-70|-60/-20|1/0. +

+
+
soft-knee
+

Set the curve radius in dB for all joints. It defaults to 0.01. +

+
+
gain
+

Set the additional gain in dB to be applied at all points on the transfer +function. This allows for easy adjustment of the overall gain. +It defaults to 0. +

+
+
volume
+

Set an initial volume, in dB, to be assumed for each channel when filtering +starts. This permits the user to supply a nominal level initially, so that, for +example, a very large gain is not applied to initial signal levels before the +companding has begun to operate. A typical value for audio which is initially +quiet is -90 dB. It defaults to 0. +

+
+
delay
+

Set a delay, in seconds. The input audio is analyzed immediately, but audio is +delayed before being fed to the volume adjuster. Specifying a delay +approximately equal to the attack/decay times allows the filter to effectively +operate in predictive rather than reactive mode. It defaults to 0. +

+
+
+ + +

27.56.1 Examples

+ +
    +
  • Make music with both quiet and loud passages suitable for listening to in a +noisy environment: +
    +
    compand=.3|.3:1|1:-90/-60|-60/-40|-40/-30|-20/-20:6:0:-90:0.2
+
    + +

    Another example for audio with whisper and explosion parts: +

    +
    compand=0|0:1|1:-90/-900|-70/-70|-30/-9|0/-3:6:0:0:0
+
    + +
  • A noise gate for when the noise is at a lower level than the signal: +
    +
    compand=.1|.1:.2|.2:-900/-900|-50.1/-900|-50/-50:.01:0:-90:.1
+
    + +
  • Here is another noise gate, this time for when the noise is at a higher level +than the signal (making it, in some ways, similar to squelch): +
    +
    compand=.1|.1:.1|.1:-45.1/-45.1|-45/-900|0/-900:.01:45:-90:.1
+
    + +
  • 2:1 compression starting at -6dB: +
    +
    compand=points=-80/-80|-6/-6|0/-3.8|20/3.5
+
    + +
  • 2:1 compression starting at -9dB: +
    +
    compand=points=-80/-80|-9/-9|0/-5.3|20/2.9
+
    + +
  • 2:1 compression starting at -12dB: +
    +
    compand=points=-80/-80|-12/-12|0/-6.8|20/1.9
+
    + +
  • 2:1 compression starting at -18dB: +
    +
    compand=points=-80/-80|-18/-18|0/-9.8|20/0.7
+
    + +
  • 3:1 compression starting at -15dB: +
    +
    compand=points=-80/-80|-15/-15|0/-10.8|20/-5.2
+
    + +
  • Compressor/Gate: +
    +
    compand=points=-80/-105|-62/-80|-15.4/-15.4|0/-12|20/-7.6
+
    + +
  • Expander: +
    +
    compand=attacks=0:points=-80/-169|-54/-80|-49.5/-64.6|-41.1/-41.1|-25.8/-15|-10.8/-4.5|0/0|20/8.3
+
    + +
  • Hard limiter at -6dB: +
    +
    compand=attacks=0:points=-80/-80|-6/-6|20/-6
+
    + +
  • Hard limiter at -12dB: +
    +
    compand=attacks=0:points=-80/-80|-12/-12|20/-12
+
    + +
  • Hard noise gate at -35 dB: +
    +
    compand=attacks=0:points=-80/-115|-35.1/-80|-35/-35|20/20
+
    + +
  • Soft limiter: +
    +
    compand=attacks=0:points=-80/-80|-12.4/-12.4|-6/-8|0/-6.8|20/-2.8
+
    +
+ + +

27.57 compensationdelay

+ +

Compensation Delay Line is a metric based delay to compensate differing +positions of microphones or speakers. +

+

For example, you have recorded guitar with two microphones placed in +different locations. Because the front of sound wave has fixed speed in +normal conditions, the phasing of microphones can vary and depends on +their location and interposition. The best sound mix can be achieved when +these microphones are in phase (synchronized). Note that a distance of +~30 cm between microphones makes one microphone capture the signal in +antiphase to the other microphone. That makes the final mix sound moody. +This filter helps to solve phasing problems by adding different delays +to each microphone track and make them synchronized. +

+

The best result can be reached when you take one track as base and +synchronize other tracks one by one with it. +Remember that synchronization/delay tolerance depends on sample rate, too. +Higher sample rates will give more tolerance. +

+

The filter accepts the following parameters: +

+
+
mm
+

Set millimeters distance. This is compensation distance for fine tuning. +Default is 0. +

+
+
cm
+

Set cm distance. This is compensation distance for tightening distance setup. +Default is 0. +

+
+
m
+

Set meters distance. This is compensation distance for hard distance setup. +Default is 0. +

+
+
dry
+

Set dry amount. Amount of unprocessed (dry) signal. +Default is 0. +

+
+
wet
+

Set wet amount. Amount of processed (wet) signal. +Default is 1. +

+
+
temp
+

Set temperature in degrees Celsius. This is the temperature of the environment. +Default is 20. +

+
+ + +

27.58 crossfeed

+

Apply headphone crossfeed filter. +

+

Crossfeed is the process of blending the left and right channels of stereo +audio recording. +It is mainly used to reduce extreme stereo separation of low frequencies. +

+

The intent is to produce more speaker like sound to the listener. +

+

The filter accepts the following options: +

+
+
strength
+

Set strength of crossfeed. Default is 0.2. Allowed range is from 0 to 1. +This sets gain of low shelf filter for side part of stereo image. +Default is -6dB. Max allowed is -30db when strength is set to 1. +

+
+
range
+

Set soundstage wideness. Default is 0.5. Allowed range is from 0 to 1. +This sets cut off frequency of low shelf filter. Default is cut off near +1550 Hz. With range set to 1 cut off frequency is set to 2100 Hz. +

+
+
slope
+

Set curve slope of low shelf filter. Default is 0.5. +Allowed range is from 0.01 to 1. +

+
+
level_in
+

Set input gain. Default is 0.9. +

+
+
level_out
+

Set output gain. Default is 1. +

+
+ + +

27.58.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

27.59 crystalizer

+

Simple algorithm to expand audio dynamic range. +

+

The filter accepts the following options: +

+
+
i
+

Sets the intensity of effect (default: 2.0). Must be in range between 0.0 +(unchanged sound) to 10.0 (maximum effect). +

+
+
c
+

Enable clipping. By default is enabled. +

+
+ + +

27.59.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

27.60 dcshift

+

Apply a DC shift to the audio. +

+

This can be useful to remove a DC offset (caused perhaps by a hardware problem +in the recording chain) from the audio. The effect of a DC offset is reduced +headroom and hence volume. The astats filter can be used to determine if +a signal has a DC offset. +

+
+
shift
+

Set the DC shift, allowed range is [-1, 1]. It indicates the amount to shift +the audio. +

+
+
limitergain
+

Optional. It should have a value much less than 1 (e.g. 0.05 or 0.02) and is +used to prevent clipping. +

+
+ + +

27.61 deesser

+ +

Apply de-essing to the audio samples. +

+
+
i
+

Set intensity for triggering de-essing. Allowed range is from 0 to 1. +Default is 0. +

+
+
m
+

Set amount of ducking on treble part of sound. Allowed range is from 0 to 1. +Default is 0.5. +

+
+
f
+

How much of original frequency content to keep when de-essing. Allowed range is from 0 to 1. +Default is 0.5. +

+
+
s
+

Set the output mode. +

+

It accepts the following values: +

+
i
+

Pass input unchanged. +

+
+
o
+

Pass ess filtered out. +

+
+
e
+

Pass only ess. +

+

Default value is o. +

+
+ +
+
+ + +

27.62 drmeter

+

Measure audio dynamic range. +

+

DR values of 14 and higher is found in very dynamic material. DR of 8 to 13 +is found in transition material. And anything less that 8 have very poor dynamics +and is very compressed. +

+

The filter accepts the following options: +

+
+
length
+

Set window length in seconds used to split audio into segments of equal length. +Default is 3 seconds. +

+
+ + +

27.63 dynaudnorm

+

Dynamic Audio Normalizer. +

+

This filter applies a certain amount of gain to the input audio in order +to bring its peak magnitude to a target level (e.g. 0 dBFS). However, in +contrast to more "simple" normalization algorithms, the Dynamic Audio +Normalizer *dynamically* re-adjusts the gain factor to the input audio. +This allows for applying extra gain to the "quiet" sections of the audio +while avoiding distortions or clipping the "loud" sections. In other words: +The Dynamic Audio Normalizer will "even out" the volume of quiet and loud +sections, in the sense that the volume of each section is brought to the +same target level. Note, however, that the Dynamic Audio Normalizer achieves +this goal *without* applying "dynamic range compressing". It will retain 100% +of the dynamic range *within* each section of the audio file. +

+
+
framelen, f
+

Set the frame length in milliseconds. In range from 10 to 8000 milliseconds. +Default is 500 milliseconds. +The Dynamic Audio Normalizer processes the input audio in small chunks, +referred to as frames. This is required, because a peak magnitude has no +meaning for just a single sample value. Instead, we need to determine the +peak magnitude for a contiguous sequence of sample values. While a "standard" +normalizer would simply use the peak magnitude of the complete file, the +Dynamic Audio Normalizer determines the peak magnitude individually for each +frame. The length of a frame is specified in milliseconds. By default, the +Dynamic Audio Normalizer uses a frame length of 500 milliseconds, which has +been found to give good results with most files. +Note that the exact frame length, in number of samples, will be determined +automatically, based on the sampling rate of the individual input audio file. +

+
+
gausssize, g
+

Set the Gaussian filter window size. In range from 3 to 301, must be odd +number. Default is 31. +Probably the most important parameter of the Dynamic Audio Normalizer is the +window size of the Gaussian smoothing filter. The filter’s window size +is specified in frames, centered around the current frame. For the sake of +simplicity, this must be an odd number. Consequently, the default value of 31 +takes into account the current frame, as well as the 15 preceding frames and +the 15 subsequent frames. Using a larger window results in a stronger +smoothing effect and thus in less gain variation, i.e. slower gain +adaptation. Conversely, using a smaller window results in a weaker smoothing +effect and thus in more gain variation, i.e. faster gain adaptation. +In other words, the more you increase this value, the more the Dynamic Audio +Normalizer will behave like a "traditional" normalization filter. On the +contrary, the more you decrease this value, the more the Dynamic Audio +Normalizer will behave like a dynamic range compressor. +

+
+
peak, p
+

Set the target peak value. This specifies the highest permissible magnitude +level for the normalized audio input. This filter will try to approach the +target peak magnitude as closely as possible, but at the same time it also +makes sure that the normalized signal will never exceed the peak magnitude. +A frame’s maximum local gain factor is imposed directly by the target peak +magnitude. The default value is 0.95 and thus leaves a headroom of 5%*. +It is not recommended to go above this value. +

+
+
maxgain, m
+

Set the maximum gain factor. In range from 1.0 to 100.0. Default is 10.0. +The Dynamic Audio Normalizer determines the maximum possible (local) gain +factor for each input frame, i.e. the maximum gain factor that does not +result in clipping or distortion. The maximum gain factor is determined by +the frame’s highest magnitude sample. However, the Dynamic Audio Normalizer +additionally bounds the frame’s maximum gain factor by a predetermined +(global) maximum gain factor. This is done in order to avoid excessive gain +factors in "silent" or almost silent frames. By default, the maximum gain +factor is 10.0, For most inputs the default value should be sufficient and +it usually is not recommended to increase this value. Though, for input +with an extremely low overall volume level, it may be necessary to allow even +higher gain factors. Note, however, that the Dynamic Audio Normalizer does +not simply apply a "hard" threshold (i.e. cut off values above the threshold). +Instead, a "sigmoid" threshold function will be applied. This way, the +gain factors will smoothly approach the threshold value, but never exceed that +value. +

+
+
targetrms, r
+

Set the target RMS. In range from 0.0 to 1.0. Default is 0.0 - disabled. +By default, the Dynamic Audio Normalizer performs "peak" normalization. +This means that the maximum local gain factor for each frame is defined +(only) by the frame’s highest magnitude sample. This way, the samples can +be amplified as much as possible without exceeding the maximum signal +level, i.e. without clipping. Optionally, however, the Dynamic Audio +Normalizer can also take into account the frame’s root mean square, +abbreviated RMS. In electrical engineering, the RMS is commonly used to +determine the power of a time-varying signal. It is therefore considered +that the RMS is a better approximation of the "perceived loudness" than +just looking at the signal’s peak magnitude. Consequently, by adjusting all +frames to a constant RMS value, a uniform "perceived loudness" can be +established. If a target RMS value has been specified, a frame’s local gain +factor is defined as the factor that would result in exactly that RMS value. +Note, however, that the maximum local gain factor is still restricted by the +frame’s highest magnitude sample, in order to prevent clipping. +

+
+
coupling, n
+

Enable channels coupling. By default is enabled. +By default, the Dynamic Audio Normalizer will amplify all channels by the same +amount. This means the same gain factor will be applied to all channels, i.e. +the maximum possible gain factor is determined by the "loudest" channel. +However, in some recordings, it may happen that the volume of the different +channels is uneven, e.g. one channel may be "quieter" than the other one(s). +In this case, this option can be used to disable the channel coupling. This way, +the gain factor will be determined independently for each channel, depending +only on the individual channel’s highest magnitude sample. This allows for +harmonizing the volume of the different channels. +

+
+
correctdc, c
+

Enable DC bias correction. By default is disabled. +An audio signal (in the time domain) is a sequence of sample values. +In the Dynamic Audio Normalizer these sample values are represented in the +-1.0 to 1.0 range, regardless of the original input format. Normally, the +audio signal, or "waveform", should be centered around the zero point. +That means if we calculate the mean value of all samples in a file, or in a +single frame, then the result should be 0.0 or at least very close to that +value. If, however, there is a significant deviation of the mean value from +0.0, in either positive or negative direction, this is referred to as a +DC bias or DC offset. Since a DC bias is clearly undesirable, the Dynamic +Audio Normalizer provides optional DC bias correction. +With DC bias correction enabled, the Dynamic Audio Normalizer will determine +the mean value, or "DC correction" offset, of each input frame and subtract +that value from all of the frame’s sample values which ensures those samples +are centered around 0.0 again. Also, in order to avoid "gaps" at the frame +boundaries, the DC correction offset values will be interpolated smoothly +between neighbouring frames. +

+
+
altboundary, b
+

Enable alternative boundary mode. By default is disabled. +The Dynamic Audio Normalizer takes into account a certain neighbourhood +around each frame. This includes the preceding frames as well as the +subsequent frames. However, for the "boundary" frames, located at the very +beginning and at the very end of the audio file, not all neighbouring +frames are available. In particular, for the first few frames in the audio +file, the preceding frames are not known. And, similarly, for the last few +frames in the audio file, the subsequent frames are not known. Thus, the +question arises which gain factors should be assumed for the missing frames +in the "boundary" region. The Dynamic Audio Normalizer implements two modes +to deal with this situation. The default boundary mode assumes a gain factor +of exactly 1.0 for the missing frames, resulting in a smooth "fade in" and +"fade out" at the beginning and at the end of the input, respectively. +

+
+
compress, s
+

Set the compress factor. In range from 0.0 to 30.0. Default is 0.0. +By default, the Dynamic Audio Normalizer does not apply "traditional" +compression. This means that signal peaks will not be pruned and thus the +full dynamic range will be retained within each local neighbourhood. However, +in some cases it may be desirable to combine the Dynamic Audio Normalizer’s +normalization algorithm with a more "traditional" compression. +For this purpose, the Dynamic Audio Normalizer provides an optional compression +(thresholding) function. If (and only if) the compression feature is enabled, +all input frames will be processed by a soft knee thresholding function prior +to the actual normalization process. Put simply, the thresholding function is +going to prune all samples whose magnitude exceeds a certain threshold value. +However, the Dynamic Audio Normalizer does not simply apply a fixed threshold +value. Instead, the threshold value will be adjusted for each individual +frame. +In general, smaller parameters result in stronger compression, and vice versa. +Values below 3.0 are not recommended, because audible distortion may appear. +

+
+
threshold, t
+

Set the target threshold value. This specifies the lowest permissible +magnitude level for the audio input which will be normalized. +If input frame volume is above this value frame will be normalized. +Otherwise frame may not be normalized at all. The default value is set +to 0, which means all input frames will be normalized. +This option is mostly useful if digital noise is not wanted to be amplified. +

+
+ + +

27.63.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

27.64 earwax

+ +

Make audio easier to listen to on headphones. +

+

This filter adds ‘cues’ to 44.1kHz stereo (i.e. audio CD format) audio +so that when listened to on headphones the stereo image is moved from +inside your head (standard for headphones) to outside and in front of +the listener (standard for speakers). +

+

Ported from SoX. +

+ +

27.65 equalizer

+ +

Apply a two-pole peaking equalisation (EQ) filter. With this +filter, the signal-level at and around a selected frequency can +be increased or decreased, whilst (unlike bandpass and bandreject +filters) that at all other frequencies is unchanged. +

+

In order to produce complex equalisation curves, this filter can +be given several times, each with a different central frequency. +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the filter’s central frequency in Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
gain, g
+

Set the required gain or attenuation in dB. +Beware of clipping when using a positive gain. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

27.65.1 Examples

+
    +
  • Attenuate 10 dB at 1000 Hz, with a bandwidth of 200 Hz: +
    +
    equalizer=f=1000:t=h:width=200:g=-10
+
    + +
  • Apply 2 dB gain at 1000 Hz with Q 1 and attenuate 5 dB at 100 Hz with Q 2: +
    +
    equalizer=f=1000:t=q:w=1:g=2,equalizer=f=100:t=q:w=2:g=-5
+
    +
+ + +

27.65.2 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change equalizer frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change equalizer width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change equalizer width. +Syntax for the command is : "width" +

+
+
gain, g
+

Change equalizer gain. +Syntax for the command is : "gain" +

+
+
mix, m
+

Change equalizer mix. +Syntax for the command is : "mix" +

+
+ + +

27.66 extrastereo

+ +

Linearly increases the difference between left and right channels which +adds some sort of "live" effect to playback. +

+

The filter accepts the following options: +

+
+
m
+

Sets the difference coefficient (default: 2.5). 0.0 means mono sound +(average of both channels), with 1.0 sound will be unchanged, with +-1.0 left and right channels will be swapped. +

+
+
c
+

Enable clipping. By default is enabled. +

+
+ + +

27.66.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

27.67 firequalizer

+

Apply FIR Equalization using arbitrary frequency response. +

+

The filter accepts the following option: +

+
+
gain
+

Set gain curve equation (in dB). The expression can contain variables: +

+
f
+

the evaluated frequency +

+
sr
+

sample rate +

+
ch
+

channel number, set to 0 when multichannels evaluation is disabled +

+
chid
+

channel id, see libavutil/channel_layout.h, set to the first channel id when +multichannels evaluation is disabled +

+
chs
+

number of channels +

+
chlayout
+

channel_layout, see libavutil/channel_layout.h +

+
+
+

and functions: +

+
gain_interpolate(f)
+

interpolate gain on frequency f based on gain_entry +

+
cubic_interpolate(f)
+

same as gain_interpolate, but smoother +

+
+

This option is also available as command. Default is gain_interpolate(f). +

+
+
gain_entry
+

Set gain entry for gain_interpolate function. The expression can +contain functions: +

+
entry(f, g)
+

store gain entry at frequency f with value g +

+
+

This option is also available as command. +

+
+
delay
+

Set filter delay in seconds. Higher value means more accurate. +Default is 0.01. +

+
+
accuracy
+

Set filter accuracy in Hz. Lower value means more accurate. +Default is 5. +

+
+
wfunc
+

Set window function. Acceptable values are: +

+
rectangular
+

rectangular window, useful when gain curve is already smooth +

+
hann
+

hann window (default) +

+
hamming
+

hamming window +

+
blackman
+

blackman window +

+
nuttall3
+

3-terms continuous 1st derivative nuttall window +

+
mnuttall3
+

minimum 3-terms discontinuous nuttall window +

+
nuttall
+

4-terms continuous 1st derivative nuttall window +

+
bnuttall
+

minimum 4-terms discontinuous nuttall (blackman-nuttall) window +

+
bharris
+

blackman-harris window +

+
tukey
+

tukey window +

+
+ +
+
fixed
+

If enabled, use fixed number of audio samples. This improves speed when +filtering with large delay. Default is disabled. +

+
+
multi
+

Enable multichannels evaluation on gain. Default is disabled. +

+
+
zero_phase
+

Enable zero phase mode by subtracting timestamp to compensate delay. +Default is disabled. +

+
+
scale
+

Set scale used by gain. Acceptable values are: +

+
linlin
+

linear frequency, linear gain +

+
linlog
+

linear frequency, logarithmic (in dB) gain (default) +

+
loglin
+

logarithmic (in octave scale where 20 Hz is 0) frequency, linear gain +

+
loglog
+

logarithmic frequency, logarithmic gain +

+
+ +
+
dumpfile
+

Set file for dumping, suitable for gnuplot. +

+
+
dumpscale
+

Set scale for dumpfile. Acceptable values are same with scale option. +Default is linlog. +

+
+
fft2
+

Enable 2-channel convolution using complex FFT. This improves speed significantly. +Default is disabled. +

+
+
min_phase
+

Enable minimum phase impulse response. Default is disabled. +

+
+ + +

27.67.1 Examples

+
    +
  • lowpass at 1000 Hz: +
    +
    firequalizer=gain='if(lt(f,1000), 0, -INF)'
+
    +
  • lowpass at 1000 Hz with gain_entry: +
    +
    firequalizer=gain_entry='entry(1000,0); entry(1001, -INF)'
+
    +
  • custom equalization: +
    +
    firequalizer=gain_entry='entry(100,0); entry(400, -4); entry(1000, -6); entry(2000, 0)'
+
    +
  • higher delay with zero phase to compensate delay: +
    +
    firequalizer=delay=0.1:fixed=on:zero_phase=on
+
    +
  • lowpass on left channel, highpass on right channel: +
    +
    firequalizer=gain='if(eq(chid,1), gain_interpolate(f), if(eq(chid,2), gain_interpolate(1e6+f), 0))'
+:gain_entry='entry(1000, 0); entry(1001,-INF); entry(1e6+1000,0)':multi=on
+
    +
+ + +

27.68 flanger

+

Apply a flanging effect to the audio. +

+

The filter accepts the following options: +

+
+
delay
+

Set base delay in milliseconds. Range from 0 to 30. Default value is 0. +

+
+
depth
+

Set added sweep delay in milliseconds. Range from 0 to 10. Default value is 2. +

+
+
regen
+

Set percentage regeneration (delayed signal feedback). Range from -95 to 95. +Default value is 0. +

+
+
width
+

Set percentage of delayed signal mixed with original. Range from 0 to 100. +Default value is 71. +

+
+
speed
+

Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5. +

+
+
shape
+

Set swept wave shape, can be triangular or sinusoidal. +Default value is sinusoidal. +

+
+
phase
+

Set swept wave percentage-shift for multi channel. Range from 0 to 100. +Default value is 25. +

+
+
interp
+

Set delay-line interpolation, linear or quadratic. +Default is linear. +

+
+ + +

27.69 haas

+

Apply Haas effect to audio. +

+

Note that this makes most sense to apply on mono signals. +With this filter applied to mono signals it give some directionality and +stretches its stereo image. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input level. By default is 1, or 0dB +

+
+
level_out
+

Set output level. By default is 1, or 0dB. +

+
+
side_gain
+

Set gain applied to side part of signal. By default is 1. +

+
+
middle_source
+

Set kind of middle source. Can be one of the following: +

+
+
‘left’
+

Pick left channel. +

+
+
‘right’
+

Pick right channel. +

+
+
‘mid’
+

Pick middle part signal of stereo image. +

+
+
‘side’
+

Pick side part signal of stereo image. +

+
+ +
+
middle_phase
+

Change middle phase. By default is disabled. +

+
+
left_delay
+

Set left channel delay. By default is 2.05 milliseconds. +

+
+
left_balance
+

Set left channel balance. By default is -1. +

+
+
left_gain
+

Set left channel gain. By default is 1. +

+
+
left_phase
+

Change left phase. By default is disabled. +

+
+
right_delay
+

Set right channel delay. By defaults is 2.12 milliseconds. +

+
+
right_balance
+

Set right channel balance. By default is 1. +

+
+
right_gain
+

Set right channel gain. By default is 1. +

+
+
right_phase
+

Change right phase. By default is enabled. +

+
+ + +

27.70 hdcd

+ +

Decodes High Definition Compatible Digital (HDCD) data. A 16-bit PCM stream with +embedded HDCD codes is expanded into a 20-bit PCM stream. +

+

The filter supports the Peak Extend and Low-level Gain Adjustment features +of HDCD, and detects the Transient Filter flag. +

+
+
ffmpeg -i HDCD16.flac -af hdcd OUT24.flac
+
+ +

When using the filter with wav, note the default encoding for wav is 16-bit, +so the resulting 20-bit stream will be truncated back to 16-bit. Use something +like -acodec pcm_s24le after the filter to get 24-bit PCM output. +

+
ffmpeg -i HDCD16.wav -af hdcd OUT16.wav
+ffmpeg -i HDCD16.wav -af hdcd -c:a pcm_s24le OUT24.wav
+
+ +

The filter accepts the following options: +

+
+
disable_autoconvert
+

Disable any automatic format conversion or resampling in the filter graph. +

+
+
process_stereo
+

Process the stereo channels together. If target_gain does not match between +channels, consider it invalid and use the last valid target_gain. +

+
+
cdt_ms
+

Set the code detect timer period in ms. +

+
+
force_pe
+

Always extend peaks above -3dBFS even if PE isn’t signaled. +

+
+
analyze_mode
+

Replace audio with a solid tone and adjust the amplitude to signal some +specific aspect of the decoding process. The output file can be loaded in +an audio editor alongside the original to aid analysis. +

+

analyze_mode=pe:force_pe=true can be used to see all samples above the PE level. +

+

Modes are: +

+
‘0, off’
+

Disabled +

+
‘1, lle’
+

Gain adjustment level at each sample +

+
‘2, pe’
+

Samples where peak extend occurs +

+
‘3, cdt’
+

Samples where the code detect timer is active +

+
‘4, tgm’
+

Samples where the target gain does not match between channels +

+
+
+
+ + +

27.71 headphone

+ +

Apply head-related transfer functions (HRTFs) to create virtual +loudspeakers around the user for binaural listening via headphones. +The HRIRs are provided via additional streams, for each channel +one stereo input stream is needed. +

+

The filter accepts the following options: +

+
+
map
+

Set mapping of input streams for convolution. +The argument is a ’|’-separated list of channel names in order as they +are given as additional stream inputs for filter. +This also specify number of input streams. Number of input streams +must be not less than number of channels in first stream plus one. +

+
+
gain
+

Set gain applied to audio. Value is in dB. Default is 0. +

+
+
type
+

Set processing type. Can be time or freq. time is +processing audio in time domain which is slow. +freq is processing audio in frequency domain which is fast. +Default is freq. +

+
+
lfe
+

Set custom gain for LFE channels. Value is in dB. Default is 0. +

+
+
size
+

Set size of frame in number of samples which will be processed at once. +Default value is 1024. Allowed range is from 1024 to 96000. +

+
+
hrir
+

Set format of hrir stream. +Default value is stereo. Alternative value is multich. +If value is set to stereo, number of additional streams should +be greater or equal to number of input channels in first input stream. +Also each additional stream should have stereo number of channels. +If value is set to multich, number of additional streams should +be exactly one. Also number of input channels of additional stream +should be equal or greater than twice number of channels of first input +stream. +

+
+ + +

27.71.1 Examples

+ +
    +
  • Full example using wav files as coefficients with amovie filters for 7.1 downmix, +each amovie filter use stereo file with IR coefficients as input. +The files give coefficients for each position of virtual loudspeaker: +
    +
    ffmpeg -i input.wav
+-filter_complex "amovie=azi_270_ele_0_DFC.wav[sr];amovie=azi_90_ele_0_DFC.wav[sl];amovie=azi_225_ele_0_DFC.wav[br];amovie=azi_135_ele_0_DFC.wav[bl];amovie=azi_0_ele_0_DFC.wav,asplit[fc][lfe];amovie=azi_35_ele_0_DFC.wav[fl];amovie=azi_325_ele_0_DFC.wav[fr];[0:a][fl][fr][fc][lfe][bl][br][sl][sr]headphone=FL|FR|FC|LFE|BL|BR|SL|SR"
+output.wav
+
    + +
  • Full example using wav files as coefficients with amovie filters for 7.1 downmix, +but now in multich hrir format. +
    +
    ffmpeg -i input.wav -filter_complex "amovie=minp.wav[hrirs];[0:a][hrirs]headphone=map=FL|FR|FC|LFE|BL|BR|SL|SR:hrir=multich"
+output.wav
+
    +
+ + +

27.72 highpass

+ +

Apply a high-pass filter with 3dB point frequency. +The filter can be either single-pole, or double-pole (the default). +The filter roll off at 6dB per pole per octave (20dB per pole per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set frequency in Hz. Default is 3000. +

+
+
poles, p
+

Set number of poles. Default is 2. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +Applies only to double-pole filter. +The default is 0.707q and gives a Butterworth response. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

27.72.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change highpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change highpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change highpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change highpass mix. +Syntax for the command is : "mix" +

+
+ + +

27.73 join

+ +

Join multiple input streams into one multi-channel stream. +

+

It accepts the following parameters: +

+
inputs
+

The number of input streams. It defaults to 2. +

+
+
channel_layout
+

The desired output channel layout. It defaults to stereo. +

+
+
map
+

Map channels from inputs to output. The argument is a ’|’-separated list of +mappings, each in the input_idx.in_channel-out_channel +form. input_idx is the 0-based index of the input stream. in_channel +can be either the name of the input channel (e.g. FL for front left) or its +index in the specified input stream. out_channel is the name of the output +channel. +

+
+ +

The filter will attempt to guess the mappings when they are not specified +explicitly. It does so by first trying to find an unused matching input channel +and if that fails it picks the first unused input channel. +

+

Join 3 inputs (with properly set channel layouts): +

+
ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
+
+ +

Build a 5.1 output from 6 single-channel streams: +

+
ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
+'join=inputs=6:channel_layout=5.1:map=0.0-FL|1.0-FR|2.0-FC|3.0-SL|4.0-SR|5.0-LFE'
+out
+
+ + +

27.74 ladspa

+ +

Load a LADSPA (Linux Audio Developer’s Simple Plugin API) plugin. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-ladspa. +

+
+
file, f
+

Specifies the name of LADSPA plugin library to load. If the environment +variable LADSPA_PATH is defined, the LADSPA plugin is searched in +each one of the directories specified by the colon separated list in +LADSPA_PATH, otherwise in the standard LADSPA paths, which are in +this order: HOME/.ladspa/lib/, /usr/local/lib/ladspa/, +/usr/lib/ladspa/. +

+
+
plugin, p
+

Specifies the plugin within the library. Some libraries contain only +one plugin, but others contain many of them. If this is not set filter +will list all available plugins within the specified library. +

+
+
controls, c
+

Set the ’|’ separated list of controls which are zero or more floating point +values that determine the behavior of the loaded plugin (for example delay, +threshold or gain). +Controls need to be defined using the following syntax: +c0=value0|c1=value1|c2=value2|..., where +valuei is the value set on the i-th control. +Alternatively they can be also defined using the following syntax: +value0|value1|value2|..., where +valuei is the value set on the i-th control. +If controls is set to help, all available controls and +their valid ranges are printed. +

+
+
sample_rate, s
+

Specify the sample rate, default to 44100. Only used if plugin have +zero inputs. +

+
+
nb_samples, n
+

Set the number of samples per channel per each output frame, default +is 1024. Only used if plugin have zero inputs. +

+
+
duration, d
+

Set the minimum duration of the sourced audio. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +Note that the resulting duration may be greater than the specified duration, +as the generated audio is always cut at the end of a complete frame. +If not specified, or the expressed duration is negative, the audio is +supposed to be generated forever. +Only used if plugin have zero inputs. +

+
+
+ + +

27.74.1 Examples

+ +
    +
  • List all available plugins within amp (LADSPA example plugin) library: +
    +
    ladspa=file=amp
+
    + +
  • List all available controls and their valid ranges for vcf_notch +plugin from VCF library: +
    +
    ladspa=f=vcf:p=vcf_notch:c=help
+
    + +
  • Simulate low quality audio equipment using Computer Music Toolkit (CMT) +plugin library: +
    +
    ladspa=file=cmt:plugin=lofi:controls=c0=22|c1=12|c2=12
+
    + +
  • Add reverberation to the audio using TAP-plugins +(Tom’s Audio Processing plugins): +
    +
    ladspa=file=tap_reverb:tap_reverb
+
    + +
  • Generate white noise, with 0.2 amplitude: +
    +
    ladspa=file=cmt:noise_source_white:c=c0=.2
+
    + +
  • Generate 20 bpm clicks using plugin C* Click - Metronome from the +C* Audio Plugin Suite (CAPS) library: +
    +
    ladspa=file=caps:Click:c=c1=20'
+
    + +
  • Apply C* Eq10X2 - Stereo 10-band equaliser effect: +
    +
    ladspa=caps:Eq10X2:c=c0=-48|c9=-24|c3=12|c4=2
+
    + +
  • Increase volume by 20dB using fast lookahead limiter from Steve Harris +SWH Plugins collection: +
    +
    ladspa=fast_lookahead_limiter_1913:fastLookaheadLimiter:20|0|2
+
    + +
  • Attenuate low frequencies using Multiband EQ from Steve Harris +SWH Plugins collection: +
    +
    ladspa=mbeq_1197:mbeq:-24|-24|-24|0|0|0|0|0|0|0|0|0|0|0|0
+
    + +
  • Reduce stereo image using Narrower from the C* Audio Plugin Suite +(CAPS) library: +
    +
    ladspa=caps:Narrower
+
    + +
  • Another white noise, now using C* Audio Plugin Suite (CAPS) library: +
    +
    ladspa=caps:White:.2
+
    + +
  • Some fractal noise, using C* Audio Plugin Suite (CAPS) library: +
    +
    ladspa=caps:Fractal:c=c1=1
+
    + +
  • Dynamic volume normalization using VLevel plugin: +
    +
    ladspa=vlevel-ladspa:vlevel_mono
+
    +
+ + +

27.74.2 Commands

+ +

This filter supports the following commands: +

+
cN
+

Modify the N-th control value. +

+

If the specified value is not valid, it is ignored and prior one is kept. +

+
+ + +

27.75 loudnorm

+ +

EBU R128 loudness normalization. Includes both dynamic and linear normalization modes. +Support for both single pass (livestreams, files) and double pass (files) modes. +This algorithm can target IL, LRA, and maximum true peak. In dynamic mode, to accurately +detect true peaks, the audio stream will be upsampled to 192 kHz. +Use the -ar option or aresample filter to explicitly set an output sample rate. +

+

The filter accepts the following options: +

+
+
I, i
+

Set integrated loudness target. +Range is -70.0 - -5.0. Default value is -24.0. +

+
+
LRA, lra
+

Set loudness range target. +Range is 1.0 - 20.0. Default value is 7.0. +

+
+
TP, tp
+

Set maximum true peak. +Range is -9.0 - +0.0. Default value is -2.0. +

+
+
measured_I, measured_i
+

Measured IL of input file. +Range is -99.0 - +0.0. +

+
+
measured_LRA, measured_lra
+

Measured LRA of input file. +Range is 0.0 - 99.0. +

+
+
measured_TP, measured_tp
+

Measured true peak of input file. +Range is -99.0 - +99.0. +

+
+
measured_thresh
+

Measured threshold of input file. +Range is -99.0 - +0.0. +

+
+
offset
+

Set offset gain. Gain is applied before the true-peak limiter. +Range is -99.0 - +99.0. Default is +0.0. +

+
+
linear
+

Normalize by linearly scaling the source audio. +measured_I, measured_LRA, measured_TP, +and measured_thresh must all be specified. Target LRA shouldn’t +be lower than source LRA and the change in integrated loudness shouldn’t +result in a true peak which exceeds the target TP. If any of these +conditions aren’t met, normalization mode will revert to dynamic. +Options are true or false. Default is true. +

+
+
dual_mono
+

Treat mono input files as "dual-mono". If a mono file is intended for playback +on a stereo system, its EBU R128 measurement will be perceptually incorrect. +If set to true, this option will compensate for this effect. +Multi-channel input files are not affected by this option. +Options are true or false. Default is false. +

+
+
print_format
+

Set print format for stats. Options are summary, json, or none. +Default value is none. +

+
+ + +

27.76 lowpass

+ +

Apply a low-pass filter with 3dB point frequency. +The filter can be either single-pole or double-pole (the default). +The filter roll off at 6dB per pole per octave (20dB per pole per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set frequency in Hz. Default is 500. +

+
+
poles, p
+

Set number of poles. Default is 2. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +Applies only to double-pole filter. +The default is 0.707q and gives a Butterworth response. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

27.76.1 Examples

+
    +
  • Lowpass only LFE channel, it LFE is not present it does nothing: +
    +
    lowpass=c=LFE
+
    +
+ + +

27.76.2 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change lowpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change lowpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change lowpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change lowpass mix. +Syntax for the command is : "mix" +

+
+ + +

27.77 lv2

+ +

Load a LV2 (LADSPA Version 2) plugin. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-lv2. +

+
+
plugin, p
+

Specifies the plugin URI. You may need to escape ’:’. +

+
+
controls, c
+

Set the ’|’ separated list of controls which are zero or more floating point +values that determine the behavior of the loaded plugin (for example delay, +threshold or gain). +If controls is set to help, all available controls and +their valid ranges are printed. +

+
+
sample_rate, s
+

Specify the sample rate, default to 44100. Only used if plugin have +zero inputs. +

+
+
nb_samples, n
+

Set the number of samples per channel per each output frame, default +is 1024. Only used if plugin have zero inputs. +

+
+
duration, d
+

Set the minimum duration of the sourced audio. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +Note that the resulting duration may be greater than the specified duration, +as the generated audio is always cut at the end of a complete frame. +If not specified, or the expressed duration is negative, the audio is +supposed to be generated forever. +Only used if plugin have zero inputs. +

+
+ + +

27.77.1 Examples

+ +
    +
  • Apply bass enhancer plugin from Calf: +
    +
    lv2=p=http\\\\://calf.sourceforge.net/plugins/BassEnhancer:c=amount=2
+
    + +
  • Apply vinyl plugin from Calf: +
    +
    lv2=p=http\\\\://calf.sourceforge.net/plugins/Vinyl:c=drone=0.2|aging=0.5
+
    + +
  • Apply bit crusher plugin from ArtyFX: +
    +
    lv2=p=http\\\\://www.openavproductions.com/artyfx#bitta:c=crush=0.3
+
    +
+ + +

27.78 mcompand

+

Multiband Compress or expand the audio’s dynamic range. +

+

The input audio is divided into bands using 4th order Linkwitz-Riley IIRs. +This is akin to the crossover of a loudspeaker, and results in flat frequency +response when absent compander action. +

+

It accepts the following parameters: +

+
+
args
+

This option syntax is: +attack,decay,[attack,decay..] soft-knee points crossover_frequency [delay [initial_volume [gain]]] | attack,decay ... +For explanation of each item refer to compand filter documentation. +

+
+ + +

27.79 pan

+ +

Mix channels with specific gain levels. The filter accepts the output +channel layout followed by a set of channels definitions. +

+

This filter is also designed to efficiently remap the channels of an audio +stream. +

+

The filter accepts parameters of the form: +"l|outdef|outdef|..." +

+
+
l
+

output channel layout or number of channels +

+
+
outdef
+

output channel specification, of the form: +"out_name=[gain*]in_name[(+-)[gain*]in_name...]" +

+
+
out_name
+

output channel to define, either a channel name (FL, FR, etc.) or a channel +number (c0, c1, etc.) +

+
+
gain
+

multiplicative coefficient for the channel, 1 leaving the volume unchanged +

+
+
in_name
+

input channel to use, see out_name for details; it is not possible to mix +named and numbered input channels +

+
+ +

If the ‘=’ in a channel specification is replaced by ‘<’, then the gains for +that specification will be renormalized so that the total is 1, thus +avoiding clipping noise. +

+ +

27.79.1 Mixing examples

+ +

For example, if you want to down-mix from stereo to mono, but with a bigger +factor for the left channel: +

+
pan=1c|c0=0.9*c0+0.1*c1
+
+ +

A customized down-mix to stereo that works automatically for 3-, 4-, 5- and +7-channels surround: +

+
pan=stereo| FL < FL + 0.5*FC + 0.6*BL + 0.6*SL | FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
+
+ +

Note that ffmpeg integrates a default down-mix (and up-mix) system +that should be preferred (see "-ac" option) unless you have very specific +needs. +

+ +

27.79.2 Remapping examples

+ +

The channel remapping will be effective if, and only if: +

+
    +
  • gain coefficients are zeroes or ones, +
  • only one input per channel output, +
+ +

If all these conditions are satisfied, the filter will notify the user ("Pure +channel mapping detected"), and use an optimized and lossless method to do the +remapping. +

+

For example, if you have a 5.1 source and want a stereo audio stream by +dropping the extra channels: +

+
pan="stereo| c0=FL | c1=FR"
+
+ +

Given the same source, you can also switch front left and front right channels +and keep the input channel layout: +

+
pan="5.1| c0=c1 | c1=c0 | c2=c2 | c3=c3 | c4=c4 | c5=c5"
+
+ +

If the input is a stereo audio stream, you can mute the front left channel (and +still keep the stereo channel layout) with: +

+
pan="stereo|c1=c1"
+
+ +

Still with a stereo audio stream input, you can copy the right channel in both +front left and right: +

+
pan="stereo| c0=FR | c1=FR"
+
+ + +

27.80 replaygain

+ +

ReplayGain scanner filter. This filter takes an audio stream as an input and +outputs it unchanged. +At end of filtering it displays track_gain and track_peak. +

+ +

27.81 resample

+ +

Convert the audio sample format, sample rate and channel layout. It is +not meant to be used directly. +

+ +

27.82 rubberband

+

Apply time-stretching and pitch-shifting with librubberband. +

+

To enable compilation of this filter, you need to configure FFmpeg with +--enable-librubberband. +

+

The filter accepts the following options: +

+
+
tempo
+

Set tempo scale factor. +

+
+
pitch
+

Set pitch scale factor. +

+
+
transients
+

Set transients detector. +Possible values are: +

+
crisp
+
mixed
+
smooth
+
+ +
+
detector
+

Set detector. +Possible values are: +

+
compound
+
percussive
+
soft
+
+ +
+
phase
+

Set phase. +Possible values are: +

+
laminar
+
independent
+
+ +
+
window
+

Set processing window size. +Possible values are: +

+
standard
+
short
+
long
+
+ +
+
smoothing
+

Set smoothing. +Possible values are: +

+
off
+
on
+
+ +
+
formant
+

Enable formant preservation when shift pitching. +Possible values are: +

+
shifted
+
preserved
+
+ +
+
pitchq
+

Set pitch quality. +Possible values are: +

+
quality
+
speed
+
consistency
+
+ +
+
channels
+

Set channels. +Possible values are: +

+
apart
+
together
+
+
+
+ + +

27.82.1 Commands

+ +

This filter supports the following commands: +

+
tempo
+

Change filter tempo scale factor. +Syntax for the command is : "tempo" +

+
+
pitch
+

Change filter pitch scale factor. +Syntax for the command is : "pitch" +

+
+ + +

27.83 sidechaincompress

+ +

This filter acts like normal compressor but has the ability to compress +detected signal using second input signal. +It needs two input streams and returns one output stream. +First input stream will be processed depending on second stream signal. +The filtered signal then can be filtered with other filters in later stages of +processing. See pan and amerge filter. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. Default is 1. Range is between 0.015625 and 64. +

+
+
mode
+

Set mode of compressor operation. Can be upward or downward. +Default is downward. +

+
+
threshold
+

If a signal of second stream raises above this level it will affect the gain +reduction of first stream. +By default is 0.125. Range is between 0.00097563 and 1. +

+
+
ratio
+

Set a ratio about which the signal is reduced. 1:2 means that if the level +raised 4dB above the threshold, it will be only 2dB above after the reduction. +Default is 2. Range is between 1 and 20. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction starts. Default is 20. Range is between 0.01 and 2000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before +reduction is decreased again. Default is 250. Range is between 0.01 and 9000. +

+
+
makeup
+

Set the amount by how much signal will be amplified after processing. +Default is 1. Range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.82843. Range is between 1 and 8. +

+
+
link
+

Choose if the average level between all channels of side-chain stream +or the louder(maximum) channel of side-chain stream affects the +reduction. Default is average. +

+
+
detection
+

Should the exact signal be taken in case of peak or an RMS one in case +of rms. Default is rms which is mainly smoother. +

+
+
level_sc
+

Set sidechain gain. Default is 1. Range is between 0.015625 and 64. +

+
+
mix
+

How much to use compressed signal in output. Default is 1. +Range is between 0 and 1. +

+
+ + +

27.83.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

27.83.2 Examples

+ +
    +
  • Full ffmpeg example taking 2 audio inputs, 1st input to be compressed +depending on the signal of 2nd input and later compressed signal to be +merged with 2nd input: +
    +
    ffmpeg -i main.flac -i sidechain.flac -filter_complex "[1:a]asplit=2[sc][mix];[0:a][sc]sidechaincompress[compr];[compr][mix]amerge"
+
    +
+ + +

27.84 sidechaingate

+ +

A sidechain gate acts like a normal (wideband) gate but has the ability to +filter the detected signal before sending it to the gain reduction stage. +Normally a gate uses the full range signal to detect a level above the +threshold. +For example: If you cut all lower frequencies from your sidechain signal +the gate will decrease the volume of your track only if not enough highs +appear. With this technique you are able to reduce the resonation of a +natural drum or remove "rumbling" of muted strokes from a heavily distorted +guitar. +It needs two input streams and returns one output stream. +First input stream will be processed depending on second stream signal. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input level before filtering. +Default is 1. Allowed range is from 0.015625 to 64. +

+
+
mode
+

Set the mode of operation. Can be upward or downward. +Default is downward. If set to upward mode, higher parts of signal +will be amplified, expanding dynamic range in upward direction. +Otherwise, in case of downward lower parts of signal will be reduced. +

+
+
range
+

Set the level of gain reduction when the signal is below the threshold. +Default is 0.06125. Allowed range is from 0 to 1. +Setting this to 0 disables reduction and then filter behaves like expander. +

+
+
threshold
+

If a signal rises above this level the gain reduction is released. +Default is 0.125. Allowed range is from 0 to 1. +

+
+
ratio
+

Set a ratio about which the signal is reduced. +Default is 2. Allowed range is from 1 to 9000. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction stops. +Default is 20 milliseconds. Allowed range is from 0.01 to 9000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before the +reduction is increased again. Default is 250 milliseconds. +Allowed range is from 0.01 to 9000. +

+
+
makeup
+

Set amount of amplification of signal after processing. +Default is 1. Allowed range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.828427125. Allowed range is from 1 to 8. +

+
+
detection
+

Choose if exact signal should be taken for detection or an RMS like one. +Default is rms. Can be peak or rms. +

+
+
link
+

Choose if the average level between all channels or the louder channel affects +the reduction. +Default is average. Can be average or maximum. +

+
+
level_sc
+

Set sidechain gain. Default is 1. Range is from 0.015625 to 64. +

+
+ + +

27.85 silencedetect

+ +

Detect silence in an audio stream. +

+

This filter logs a message when it detects that the input audio volume is less +or equal to a noise tolerance value for a duration greater or equal to the +minimum detected noise duration. +

+

The printed times and duration are expressed in seconds. The +lavfi.silence_start or lavfi.silence_start.X metadata key +is set on the first frame whose timestamp equals or exceeds the detection +duration and it contains the timestamp of the first frame of the silence. +

+

The lavfi.silence_duration or lavfi.silence_duration.X +and lavfi.silence_end or lavfi.silence_end.X metadata +keys are set on the first frame after the silence. If mono is +enabled, and each channel is evaluated separately, the .X +suffixed keys are used, and X corresponds to the channel number. +

+

The filter accepts the following options: +

+
+
noise, n
+

Set noise tolerance. Can be specified in dB (in case "dB" is appended to the +specified value) or amplitude ratio. Default is -60dB, or 0.001. +

+
+
duration, d
+

Set silence duration until notification (default is 2 seconds). See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+
+
mono, m
+

Process each channel separately, instead of combined. By default is disabled. +

+
+ + +

27.85.1 Examples

+ +
    +
  • Detect 5 seconds of silence with -50dB noise tolerance: +
    +
    silencedetect=n=-50dB:d=5
+
    + +
  • Complete example with ffmpeg to detect silence with 0.0001 noise +tolerance in silence.mp3: +
    +
    ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
+
    +
+ + +

27.86 silenceremove

+ +

Remove silence from the beginning, middle or end of the audio. +

+

The filter accepts the following options: +

+
+
start_periods
+

This value is used to indicate if audio should be trimmed at beginning of +the audio. A value of zero indicates no silence should be trimmed from the +beginning. When specifying a non-zero value, it trims audio up until it +finds non-silence. Normally, when trimming silence from beginning of audio +the start_periods will be 1 but it can be increased to higher +values to trim all audio up to specific count of non-silence periods. +Default value is 0. +

+
+
start_duration
+

Specify the amount of time that non-silence must be detected before it stops +trimming audio. By increasing the duration, bursts of noises can be treated +as silence and trimmed off. Default value is 0. +

+
+
start_threshold
+

This indicates what sample value should be treated as silence. For digital +audio, a value of 0 may be fine but for audio recorded from analog, +you may wish to increase the value to account for background noise. +Can be specified in dB (in case "dB" is appended to the specified value) +or amplitude ratio. Default value is 0. +

+
+
start_silence
+

Specify max duration of silence at beginning that will be kept after +trimming. Default is 0, which is equal to trimming all samples detected +as silence. +

+
+
start_mode
+

Specify mode of detection of silence end in start of multi-channel audio. +Can be any or all. Default is any. +With any, any sample that is detected as non-silence will cause +stopped trimming of silence. +With all, only if all channels are detected as non-silence will cause +stopped trimming of silence. +

+
+
stop_periods
+

Set the count for trimming silence from the end of audio. +To remove silence from the middle of a file, specify a stop_periods +that is negative. This value is then treated as a positive value and is +used to indicate the effect should restart processing as specified by +start_periods, making it suitable for removing periods of silence +in the middle of the audio. +Default value is 0. +

+
+
stop_duration
+

Specify a duration of silence that must exist before audio is not copied any +more. By specifying a higher duration, silence that is wanted can be left in +the audio. +Default value is 0. +

+
+
stop_threshold
+

This is the same as start_threshold but for trimming silence from +the end of audio. +Can be specified in dB (in case "dB" is appended to the specified value) +or amplitude ratio. Default value is 0. +

+
+
stop_silence
+

Specify max duration of silence at end that will be kept after +trimming. Default is 0, which is equal to trimming all samples detected +as silence. +

+
+
stop_mode
+

Specify mode of detection of silence start in end of multi-channel audio. +Can be any or all. Default is any. +With any, any sample that is detected as non-silence will cause +stopped trimming of silence. +With all, only if all channels are detected as non-silence will cause +stopped trimming of silence. +

+
+
detection
+

Set how is silence detected. Can be rms or peak. Second is faster +and works better with digital silence which is exactly 0. +Default value is rms. +

+
+
window
+

Set duration in number of seconds used to calculate size of window in number +of samples for detecting silence. +Default value is 0.02. Allowed range is from 0 to 10. +

+
+ + +

27.86.1 Examples

+ +
    +
  • The following example shows how this filter can be used to start a recording +that does not contain the delay at the start which usually occurs between +pressing the record button and the start of the performance: +
    +
    silenceremove=start_periods=1:start_duration=5:start_threshold=0.02
+
    + +
  • Trim all silence encountered from beginning to end where there is more than 1 +second of silence in audio: +
    +
    silenceremove=stop_periods=-1:stop_duration=1:stop_threshold=-90dB
+
    + +
  • Trim all digital silence samples, using peak detection, from beginning to end +where there is more than 0 samples of digital silence in audio and digital +silence is detected in all channels at same positions in stream: +
    +
    silenceremove=window=0:detection=peak:stop_mode=all:start_mode=all:stop_periods=-1:stop_threshold=0
+
    +
+ + +

27.87 sofalizer

+ +

SOFAlizer uses head-related transfer functions (HRTFs) to create virtual +loudspeakers around the user for binaural listening via headphones (audio +formats up to 9 channels supported). +The HRTFs are stored in SOFA files (see http://www.sofacoustics.org/ for a database). +SOFAlizer is developed at the Acoustics Research Institute (ARI) of the +Austrian Academy of Sciences. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libmysofa. +

+

The filter accepts the following options: +

+
+
sofa
+

Set the SOFA file used for rendering. +

+
+
gain
+

Set gain applied to audio. Value is in dB. Default is 0. +

+
+
rotation
+

Set rotation of virtual loudspeakers in deg. Default is 0. +

+
+
elevation
+

Set elevation of virtual speakers in deg. Default is 0. +

+
+
radius
+

Set distance in meters between loudspeakers and the listener with near-field +HRTFs. Default is 1. +

+
+
type
+

Set processing type. Can be time or freq. time is +processing audio in time domain which is slow. +freq is processing audio in frequency domain which is fast. +Default is freq. +

+
+
speakers
+

Set custom positions of virtual loudspeakers. Syntax for this option is: +<CH> <AZIM> <ELEV>[|<CH> <AZIM> <ELEV>|...]. +Each virtual loudspeaker is described with short channel name following with +azimuth and elevation in degrees. +Each virtual loudspeaker description is separated by ’|’. +For example to override front left and front right channel positions use: +’speakers=FL 45 15|FR 345 15’. +Descriptions with unrecognised channel names are ignored. +

+
+
lfegain
+

Set custom gain for LFE channels. Value is in dB. Default is 0. +

+
+
framesize
+

Set custom frame size in number of samples. Default is 1024. +Allowed range is from 1024 to 96000. Only used if option ‘type’ +is set to freq. +

+
+
normalize
+

Should all IRs be normalized upon importing SOFA file. +By default is enabled. +

+
+
interpolate
+

Should nearest IRs be interpolated with neighbor IRs if exact position +does not match. By default is disabled. +

+
+
minphase
+

Minphase all IRs upon loading of SOFA file. By default is disabled. +

+
+
anglestep
+

Set neighbor search angle step. Only used if option interpolate is enabled. +

+
+
radstep
+

Set neighbor search radius step. Only used if option interpolate is enabled. +

+
+ + +

27.87.1 Examples

+ +
    +
  • Using ClubFritz6 sofa file: +
    +
    sofalizer=sofa=/path/to/ClubFritz6.sofa:type=freq:radius=1
+
    + +
  • Using ClubFritz12 sofa file and bigger radius with small rotation: +
    +
    sofalizer=sofa=/path/to/ClubFritz12.sofa:type=freq:radius=2:rotation=5
+
    + +
  • Similar as above but with custom speaker positions for front left, front right, back left and back right +and also with custom gain: +
    +
    "sofalizer=sofa=/path/to/ClubFritz6.sofa:type=freq:radius=2:speakers=FL 45|FR 315|BL 135|BR 225:gain=28"
+
    +
+ + +

27.88 stereotools

+ +

This filter has some handy utilities to manage stereo signals, for converting +M/S stereo recordings to L/R signal while having control over the parameters +or spreading the stereo image of master track. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input level before filtering for both channels. Defaults is 1. +Allowed range is from 0.015625 to 64. +

+
+
level_out
+

Set output level after filtering for both channels. Defaults is 1. +Allowed range is from 0.015625 to 64. +

+
+
balance_in
+

Set input balance between both channels. Default is 0. +Allowed range is from -1 to 1. +

+
+
balance_out
+

Set output balance between both channels. Default is 0. +Allowed range is from -1 to 1. +

+
+
softclip
+

Enable softclipping. Results in analog distortion instead of harsh digital 0dB +clipping. Disabled by default. +

+
+
mutel
+

Mute the left channel. Disabled by default. +

+
+
muter
+

Mute the right channel. Disabled by default. +

+
+
phasel
+

Change the phase of the left channel. Disabled by default. +

+
+
phaser
+

Change the phase of the right channel. Disabled by default. +

+
+
mode
+

Set stereo mode. Available values are: +

+
+
‘lr>lr’
+

Left/Right to Left/Right, this is default. +

+
+
‘lr>ms’
+

Left/Right to Mid/Side. +

+
+
‘ms>lr’
+

Mid/Side to Left/Right. +

+
+
‘lr>ll’
+

Left/Right to Left/Left. +

+
+
‘lr>rr’
+

Left/Right to Right/Right. +

+
+
‘lr>l+r’
+

Left/Right to Left + Right. +

+
+
‘lr>rl’
+

Left/Right to Right/Left. +

+
+
‘ms>ll’
+

Mid/Side to Left/Left. +

+
+
‘ms>rr’
+

Mid/Side to Right/Right. +

+
+ +
+
slev
+

Set level of side signal. Default is 1. +Allowed range is from 0.015625 to 64. +

+
+
sbal
+

Set balance of side signal. Default is 0. +Allowed range is from -1 to 1. +

+
+
mlev
+

Set level of the middle signal. Default is 1. +Allowed range is from 0.015625 to 64. +

+
+
mpan
+

Set middle signal pan. Default is 0. Allowed range is from -1 to 1. +

+
+
base
+

Set stereo base between mono and inversed channels. Default is 0. +Allowed range is from -1 to 1. +

+
+
delay
+

Set delay in milliseconds how much to delay left from right channel and +vice versa. Default is 0. Allowed range is from -20 to 20. +

+
+
sclevel
+

Set S/C level. Default is 1. Allowed range is from 1 to 100. +

+
+
phase
+

Set the stereo phase in degrees. Default is 0. Allowed range is from 0 to 360. +

+
+
bmode_in, bmode_out
+

Set balance mode for balance_in/balance_out option. +

+

Can be one of the following: +

+
+
‘balance’
+

Classic balance mode. Attenuate one channel at time. +Gain is raised up to 1. +

+
+
‘amplitude’
+

Similar as classic mode above but gain is raised up to 2. +

+
+
‘power’
+

Equal power distribution, from -6dB to +6dB range. +

+
+
+
+ + +

27.88.1 Examples

+ +
    +
  • Apply karaoke like effect: +
    +
    stereotools=mlev=0.015625
+
    + +
  • Convert M/S signal to L/R: +
    +
    "stereotools=mode=ms>lr"
+
    +
+ + +

27.89 stereowiden

+ +

This filter enhance the stereo effect by suppressing signal common to both +channels and by delaying the signal of left into right and vice versa, +thereby widening the stereo effect. +

+

The filter accepts the following options: +

+
+
delay
+

Time in milliseconds of the delay of left signal into right and vice versa. +Default is 20 milliseconds. +

+
+
feedback
+

Amount of gain in delayed signal into right and vice versa. Gives a delay +effect of left signal in right output and vice versa which gives widening +effect. Default is 0.3. +

+
+
crossfeed
+

Cross feed of left into right with inverted phase. This helps in suppressing +the mono. If the value is 1 it will cancel all the signal common to both +channels. Default is 0.3. +

+
+
drymix
+

Set level of input signal of original channel. Default is 0.8. +

+
+ + +

27.89.1 Commands

+ +

This filter supports the all above options except delay as commands. +

+ +

27.90 superequalizer

+

Apply 18 band equalizer. +

+

The filter accepts the following options: +

+
1b
+

Set 65Hz band gain. +

+
2b
+

Set 92Hz band gain. +

+
3b
+

Set 131Hz band gain. +

+
4b
+

Set 185Hz band gain. +

+
5b
+

Set 262Hz band gain. +

+
6b
+

Set 370Hz band gain. +

+
7b
+

Set 523Hz band gain. +

+
8b
+

Set 740Hz band gain. +

+
9b
+

Set 1047Hz band gain. +

+
10b
+

Set 1480Hz band gain. +

+
11b
+

Set 2093Hz band gain. +

+
12b
+

Set 2960Hz band gain. +

+
13b
+

Set 4186Hz band gain. +

+
14b
+

Set 5920Hz band gain. +

+
15b
+

Set 8372Hz band gain. +

+
16b
+

Set 11840Hz band gain. +

+
17b
+

Set 16744Hz band gain. +

+
18b
+

Set 20000Hz band gain. +

+
+ + +

27.91 surround

+

Apply audio surround upmix filter. +

+

This filter allows to produce multichannel output from audio stream. +

+

The filter accepts the following options: +

+
+
chl_out
+

Set output channel layout. By default, this is 5.1. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+
chl_in
+

Set input channel layout. By default, this is stereo. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+
level_in
+

Set input volume level. By default, this is 1. +

+
+
level_out
+

Set output volume level. By default, this is 1. +

+
+
lfe
+

Enable LFE channel output if output channel layout has it. By default, this is enabled. +

+
+
lfe_low
+

Set LFE low cut off frequency. By default, this is 128 Hz. +

+
+
lfe_high
+

Set LFE high cut off frequency. By default, this is 256 Hz. +

+
+
lfe_mode
+

Set LFE mode, can be add or sub. Default is add. +In add mode, LFE channel is created from input audio and added to output. +In sub mode, LFE channel is created from input audio and added to output but +also all non-LFE output channels are subtracted with output LFE channel. +

+
+
angle
+

Set angle of stereo surround transform, Allowed range is from 0 to 360. +Default is 90. +

+
+
fc_in
+

Set front center input volume. By default, this is 1. +

+
+
fc_out
+

Set front center output volume. By default, this is 1. +

+
+
fl_in
+

Set front left input volume. By default, this is 1. +

+
+
fl_out
+

Set front left output volume. By default, this is 1. +

+
+
fr_in
+

Set front right input volume. By default, this is 1. +

+
+
fr_out
+

Set front right output volume. By default, this is 1. +

+
+
sl_in
+

Set side left input volume. By default, this is 1. +

+
+
sl_out
+

Set side left output volume. By default, this is 1. +

+
+
sr_in
+

Set side right input volume. By default, this is 1. +

+
+
sr_out
+

Set side right output volume. By default, this is 1. +

+
+
bl_in
+

Set back left input volume. By default, this is 1. +

+
+
bl_out
+

Set back left output volume. By default, this is 1. +

+
+
br_in
+

Set back right input volume. By default, this is 1. +

+
+
br_out
+

Set back right output volume. By default, this is 1. +

+
+
bc_in
+

Set back center input volume. By default, this is 1. +

+
+
bc_out
+

Set back center output volume. By default, this is 1. +

+
+
lfe_in
+

Set LFE input volume. By default, this is 1. +

+
+
lfe_out
+

Set LFE output volume. By default, this is 1. +

+
+
allx
+

Set spread usage of stereo image across X axis for all channels. +

+
+
ally
+

Set spread usage of stereo image across Y axis for all channels. +

+
+
fcx, flx, frx, blx, brx, slx, srx, bcx
+

Set spread usage of stereo image across X axis for each channel. +

+
+
fcy, fly, fry, bly, bry, sly, sry, bcy
+

Set spread usage of stereo image across Y axis for each channel. +

+
+
win_size
+

Set window size. Allowed range is from 1024 to 65536. Default size is 4096. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann, hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+

Default is hann. +

+
+
overlap
+

Set window overlap. If set to 1, the recommended overlap for selected +window function will be picked. Default is 0.5. +

+
+ + +

27.92 treble, highshelf

+ +

Boost or cut treble (upper) frequencies of the audio using a two-pole +shelving filter with a response similar to that of a standard +hi-fi’s tone-controls. This is also known as shelving equalisation (EQ). +

+

The filter accepts the following options: +

+
+
gain, g
+

Give the gain at whichever is the lower of ~22 kHz and the +Nyquist frequency. Its useful range is about -20 (for a large cut) +to +20 (for a large boost). Beware of clipping when using a positive gain. +

+
+
frequency, f
+

Set the filter’s central frequency and so can be used +to extend or reduce the frequency range to be boosted or cut. +The default value is 3000 Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Determine how steep is the filter’s shelf transition. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

27.92.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change treble frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change treble width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change treble width. +Syntax for the command is : "width" +

+
+
gain, g
+

Change treble gain. +Syntax for the command is : "gain" +

+
+
mix, m
+

Change treble mix. +Syntax for the command is : "mix" +

+
+ + +

27.93 tremolo

+ +

Sinusoidal amplitude modulation. +

+

The filter accepts the following options: +

+
+
f
+

Modulation frequency in Hertz. Modulation frequencies in the subharmonic range +(20 Hz or lower) will result in a tremolo effect. +This filter may also be used as a ring modulator by specifying +a modulation frequency higher than 20 Hz. +Range is 0.1 - 20000.0. Default value is 5.0 Hz. +

+
+
d
+

Depth of modulation as a percentage. Range is 0.0 - 1.0. +Default value is 0.5. +

+
+ + +

27.94 vibrato

+ +

Sinusoidal phase modulation. +

+

The filter accepts the following options: +

+
+
f
+

Modulation frequency in Hertz. +Range is 0.1 - 20000.0. Default value is 5.0 Hz. +

+
+
d
+

Depth of modulation as a percentage. Range is 0.0 - 1.0. +Default value is 0.5. +

+
+ + +

27.95 volume

+ +

Adjust the input audio volume. +

+

It accepts the following parameters: +

+
volume
+

Set audio volume expression. +

+

Output values are clipped to the maximum value. +

+

The output audio volume is given by the relation: +

+
output_volume = volume * input_volume
+
+ +

The default value for volume is "1.0". +

+
+
precision
+

This parameter represents the mathematical precision. +

+

It determines which input sample formats will be allowed, which affects the +precision of the volume scaling. +

+
+
fixed
+

8-bit fixed-point; this limits input sample format to U8, S16, and S32. +

+
float
+

32-bit floating-point; this limits input sample format to FLT. (default) +

+
double
+

64-bit floating-point; this limits input sample format to DBL. +

+
+ +
+
replaygain
+

Choose the behaviour on encountering ReplayGain side data in input frames. +

+
+
drop
+

Remove ReplayGain side data, ignoring its contents (the default). +

+
+
ignore
+

Ignore ReplayGain side data, but leave it in the frame. +

+
+
track
+

Prefer the track gain, if present. +

+
+
album
+

Prefer the album gain, if present. +

+
+ +
+
replaygain_preamp
+

Pre-amplification gain in dB to apply to the selected replaygain gain. +

+

Default value for replaygain_preamp is 0.0. +

+
+
replaygain_noclip
+

Prevent clipping by limiting the gain applied. +

+

Default value for replaygain_noclip is 1. +

+
+
eval
+

Set when the volume expression is evaluated. +

+

It accepts the following values: +

+
‘once’
+

only evaluate expression once during the filter initialization, or +when the ‘volume’ command is sent +

+
+
‘frame’
+

evaluate expression for each incoming frame +

+
+ +

Default value is ‘once’. +

+
+ +

The volume expression can contain the following parameters. +

+
+
n
+

frame number (starting at zero) +

+
nb_channels
+

number of channels +

+
nb_consumed_samples
+

number of samples consumed by the filter +

+
nb_samples
+

number of samples in the current frame +

+
pos
+

original frame position in the file +

+
pts
+

frame PTS +

+
sample_rate
+

sample rate +

+
startpts
+

PTS at start of stream +

+
startt
+

time at start of stream +

+
t
+

frame time +

+
tb
+

timestamp timebase +

+
volume
+

last set volume value +

+
+ +

Note that when eval is set to ‘once’ only the +sample_rate and tb variables are available, all other +variables will evaluate to NAN. +

+ +

27.95.1 Commands

+ +

This filter supports the following commands: +

+
volume
+

Modify the volume expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

27.95.2 Examples

+ +
    +
  • Halve the input audio volume: +
    +
    volume=volume=0.5
+volume=volume=1/2
+volume=volume=-6.0206dB
+
    + +

    In all the above example the named key for volume can be +omitted, for example like in: +

    +
    volume=0.5
+
    + +
  • Increase input audio power by 6 decibels using fixed-point precision: +
    +
    volume=volume=6dB:precision=fixed
+
    + +
  • Fade volume after time 10 with an annihilation period of 5 seconds: +
    +
    volume='if(lt(t,10),1,max(1-(t-10)/5,0))':eval=frame
+
    +
+ + +

27.96 volumedetect

+ +

Detect the volume of the input video. +

+

The filter has no parameters. The input is not modified. Statistics about +the volume will be printed in the log when the input stream end is reached. +

+

In particular it will show the mean volume (root mean square), maximum +volume (on a per-sample basis), and the beginning of a histogram of the +registered volume values (from the maximum value to a cumulated 1/1000 of +the samples). +

+

All volumes are in decibels relative to the maximum PCM value. +

+ +

27.96.1 Examples

+ +

Here is an excerpt of the output: +

+
[Parsed_volumedetect_0  0xa23120] mean_volume: -27 dB
+[Parsed_volumedetect_0  0xa23120] max_volume: -4 dB
+[Parsed_volumedetect_0  0xa23120] histogram_4db: 6
+[Parsed_volumedetect_0  0xa23120] histogram_5db: 62
+[Parsed_volumedetect_0  0xa23120] histogram_6db: 286
+[Parsed_volumedetect_0  0xa23120] histogram_7db: 1042
+[Parsed_volumedetect_0  0xa23120] histogram_8db: 2551
+[Parsed_volumedetect_0  0xa23120] histogram_9db: 4609
+[Parsed_volumedetect_0  0xa23120] histogram_10db: 8409
+
+ +

It means that: +

    +
  • The mean square energy is approximately -27 dB, or 10^-2.7. +
  • The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB. +
  • There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc. +
+ +

In other words, raising the volume by +4 dB does not cause any clipping, +raising it by +5 dB causes clipping for 6 samples, etc. +

+ + +

28 Audio Sources

+ +

Below is a description of the currently available audio sources. +

+ +

28.1 abuffer

+ +

Buffer audio frames, and make them available to the filter chain. +

+

This source is mainly intended for a programmatic use, in particular +through the interface defined in libavfilter/asrc_abuffer.h. +

+

It accepts the following parameters: +

+
time_base
+

The timebase which will be used for timestamps of submitted frames. It must be +either a floating-point number or in numerator/denominator form. +

+
+
sample_rate
+

The sample rate of the incoming audio buffers. +

+
+
sample_fmt
+

The sample format of the incoming audio buffers. +Either a sample format name or its corresponding integer representation from +the enum AVSampleFormat in libavutil/samplefmt.h +

+
+
channel_layout
+

The channel layout of the incoming audio buffers. +Either a channel layout name from channel_layout_map in +libavutil/channel_layout.c or its corresponding integer representation +from the AV_CH_LAYOUT_* macros in libavutil/channel_layout.h +

+
+
channels
+

The number of channels of the incoming audio buffers. +If both channels and channel_layout are specified, then they +must be consistent. +

+
+
+ + +

28.1.1 Examples

+ +
+
abuffer=sample_rate=44100:sample_fmt=s16p:channel_layout=stereo
+
+ +

will instruct the source to accept planar 16bit signed stereo at 44100Hz. +Since the sample format with name "s16p" corresponds to the number +6 and the "stereo" channel layout corresponds to the value 0x3, this is +equivalent to: +

+
abuffer=sample_rate=44100:sample_fmt=6:channel_layout=0x3
+
+ + +

28.2 aevalsrc

+ +

Generate an audio signal specified by an expression. +

+

This source accepts in input one or more expressions (one for each +channel), which are evaluated and used to generate a corresponding +audio signal. +

+

This source accepts the following options: +

+
+
exprs
+

Set the ’|’-separated expressions list for each separate channel. In case the +channel_layout option is not specified, the selected channel layout +depends on the number of provided expressions. Otherwise the last +specified expression is applied to the remaining output channels. +

+
+
channel_layout, c
+

Set the channel layout. The number of channels in the specified layout +must be equal to the number of specified expressions. +

+
+
duration, d
+

Set the minimum duration of the sourced audio. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +Note that the resulting duration may be greater than the specified +duration, as the generated audio is always cut at the end of a +complete frame. +

+

If not specified, or the expressed duration is negative, the audio is +supposed to be generated forever. +

+
+
nb_samples, n
+

Set the number of samples per channel per each output frame, +default to 1024. +

+
+
sample_rate, s
+

Specify the sample rate, default to 44100. +

+
+ +

Each expression in exprs can contain the following constants: +

+
+
n
+

number of the evaluated sample, starting from 0 +

+
+
t
+

time of the evaluated sample expressed in seconds, starting from 0 +

+
+
s
+

sample rate +

+
+
+ + +

28.2.1 Examples

+ +
    +
  • Generate silence: +
    +
    aevalsrc=0
+
    + +
  • Generate a sin signal with frequency of 440 Hz, set sample rate to +8000 Hz: +
    +
    aevalsrc="sin(440*2*PI*t):s=8000"
+
    + +
  • Generate a two channels signal, specify the channel layout (Front +Center + Back Center) explicitly: +
    +
    aevalsrc="sin(420*2*PI*t)|cos(430*2*PI*t):c=FC|BC"
+
    + +
  • Generate white noise: +
    +
    aevalsrc="-2+random(0)"
+
    + +
  • Generate an amplitude modulated signal: +
    +
    aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
+
    + +
  • Generate 2.5 Hz binaural beats on a 360 Hz carrier: +
    +
    aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) | 0.1*sin(2*PI*(360+2.5/2)*t)"
+
    + +
+ + +

28.3 afirsrc

+ +

Generate a FIR coefficients using frequency sampling method. +

+

The resulting stream can be used with afir filter for filtering the audio signal. +

+

The filter accepts the following options: +

+
+
taps, t
+

Set number of filter coefficents in output audio stream. +Default value is 1025. +

+
+
frequency, f
+

Set frequency points from where magnitude and phase are set. +This must be in non decreasing order, and first element must be 0, while last element +must be 1. Elements are separated by white spaces. +

+
+
magnitude, m
+

Set magnitude value for every frequency point set by frequency. +Number of values must be same as number of frequency points. +Values are separated by white spaces. +

+
+
phase, p
+

Set phase value for every frequency point set by frequency. +Number of values must be same as number of frequency points. +Values are separated by white spaces. +

+
+
sample_rate, r
+

Set sample rate, default is 44100. +

+
+
nb_samples, n
+

Set number of samples per each frame. Default is 1024. +

+
+
win_func, w
+

Set window function. Default is blackman. +

+
+ + +

28.4 anullsrc

+ +

The null audio source, return unprocessed audio frames. It is mainly useful +as a template and to be employed in analysis / debugging tools, or as +the source for filters which ignore the input data (for example the sox +synth filter). +

+

This source accepts the following options: +

+
+
channel_layout, cl
+
+

Specifies the channel layout, and can be either an integer or a string +representing a channel layout. The default value of channel_layout +is "stereo". +

+

Check the channel_layout_map definition in +libavutil/channel_layout.c for the mapping between strings and +channel layout values. +

+
+
sample_rate, r
+

Specifies the sample rate, and defaults to 44100. +

+
+
nb_samples, n
+

Set the number of samples per requested frames. +

+
+
+ + +

28.4.1 Examples

+ +
    +
  • Set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO. +
    +
    anullsrc=r=48000:cl=4
+
    + +
  • Do the same operation with a more obvious syntax: +
    +
    anullsrc=r=48000:cl=mono
+
    +
+ +

All the parameters need to be explicitly defined. +

+ +

28.5 flite

+ +

Synthesize a voice utterance using the libflite library. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libflite. +

+

Note that versions of the flite library prior to 2.0 are not thread-safe. +

+

The filter accepts the following options: +

+
+
list_voices
+

If set to 1, list the names of the available voices and exit +immediately. Default value is 0. +

+
+
nb_samples, n
+

Set the maximum number of samples per frame. Default value is 512. +

+
+
textfile
+

Set the filename containing the text to speak. +

+
+
text
+

Set the text to speak. +

+
+
voice, v
+

Set the voice to use for the speech synthesis. Default value is +kal. See also the list_voices option. +

+
+ + +

28.5.1 Examples

+ +
    +
  • Read from file speech.txt, and synthesize the text using the +standard flite voice: +
    +
    flite=textfile=speech.txt
+
    + +
  • Read the specified text selecting the slt voice: +
    +
    flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
+
    + +
  • Input text to ffmpeg: +
    +
    ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
+
    + +
  • Make ffplay speak the specified text, using flite and +the lavfi device: +
    +
    ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
+
    +
+ +

For more information about libflite, check: +http://www.festvox.org/flite/ +

+ +

28.6 anoisesrc

+ +

Generate a noise audio signal. +

+

The filter accepts the following options: +

+
+
sample_rate, r
+

Specify the sample rate. Default value is 48000 Hz. +

+
+
amplitude, a
+

Specify the amplitude (0.0 - 1.0) of the generated audio stream. Default value +is 1.0. +

+
+
duration, d
+

Specify the duration of the generated audio stream. Not specifying this option +results in noise with an infinite length. +

+
+
color, colour, c
+

Specify the color of noise. Available noise colors are white, pink, brown, +blue, violet and velvet. Default color is white. +

+
+
seed, s
+

Specify a value used to seed the PRNG. +

+
+
nb_samples, n
+

Set the number of samples per each output frame, default is 1024. +

+
+ + +

28.6.1 Examples

+ +
    +
  • Generate 60 seconds of pink noise, with a 44.1 kHz sampling rate and an amplitude of 0.5: +
    +
    anoisesrc=d=60:c=pink:r=44100:a=0.5
+
    +
+ + +

28.7 hilbert

+ +

Generate odd-tap Hilbert transform FIR coefficients. +

+

The resulting stream can be used with afir filter for phase-shifting +the signal by 90 degrees. +

+

This is used in many matrix coding schemes and for analytic signal generation. +The process is often written as a multiplication by i (or j), the imaginary unit. +

+

The filter accepts the following options: +

+
+
sample_rate, s
+

Set sample rate, default is 44100. +

+
+
taps, t
+

Set length of FIR filter, default is 22051. +

+
+
nb_samples, n
+

Set number of samples per each frame. +

+
+
win_func, w
+

Set window function to be used when generating FIR coefficients. +

+
+ + +

28.8 sinc

+ +

Generate a sinc kaiser-windowed low-pass, high-pass, band-pass, or band-reject FIR coefficients. +

+

The resulting stream can be used with afir filter for filtering the audio signal. +

+

The filter accepts the following options: +

+
+
sample_rate, r
+

Set sample rate, default is 44100. +

+
+
nb_samples, n
+

Set number of samples per each frame. Default is 1024. +

+
+
hp
+

Set high-pass frequency. Default is 0. +

+
+
lp
+

Set low-pass frequency. Default is 0. +If high-pass frequency is lower than low-pass frequency and low-pass frequency +is higher than 0 then filter will create band-pass filter coefficients, +otherwise band-reject filter coefficients. +

+
+
phase
+

Set filter phase response. Default is 50. Allowed range is from 0 to 100. +

+
+
beta
+

Set Kaiser window beta. +

+
+
att
+

Set stop-band attenuation. Default is 120dB, allowed range is from 40 to 180 dB. +

+
+
round
+

Enable rounding, by default is disabled. +

+
+
hptaps
+

Set number of taps for high-pass filter. +

+
+
lptaps
+

Set number of taps for low-pass filter. +

+
+ + +

28.9 sine

+ +

Generate an audio signal made of a sine wave with amplitude 1/8. +

+

The audio signal is bit-exact. +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the carrier frequency. Default is 440 Hz. +

+
+
beep_factor, b
+

Enable a periodic beep every second with frequency beep_factor times +the carrier frequency. Default is 0, meaning the beep is disabled. +

+
+
sample_rate, r
+

Specify the sample rate, default is 44100. +

+
+
duration, d
+

Specify the duration of the generated audio stream. +

+
+
samples_per_frame
+

Set the number of samples per output frame. +

+

The expression can contain the following constants: +

+
+
n
+

The (sequential) number of the output audio frame, starting from 0. +

+
+
pts
+

The PTS (Presentation TimeStamp) of the output audio frame, +expressed in TB units. +

+
+
t
+

The PTS of the output audio frame, expressed in seconds. +

+
+
TB
+

The timebase of the output audio frames. +

+
+ +

Default is 1024. +

+
+ + +

28.9.1 Examples

+ +
    +
  • Generate a simple 440 Hz sine wave: +
    +
    sine
+
    + +
  • Generate a 220 Hz sine wave with a 880 Hz beep each second, for 5 seconds: +
    +
    sine=220:4:d=5
+sine=f=220:b=4:d=5
+sine=frequency=220:beep_factor=4:duration=5
+
    + +
  • Generate a 1 kHz sine wave following 1602,1601,1602,1601,1602 NTSC +pattern: +
    +
    sine=1000:samples_per_frame='st(0,mod(n,5)); 1602-not(not(eq(ld(0),1)+eq(ld(0),3)))'
+
    +
+ + + +

29 Audio Sinks

+ +

Below is a description of the currently available audio sinks. +

+ +

29.1 abuffersink

+ +

Buffer audio frames, and make them available to the end of filter chain. +

+

This sink is mainly intended for programmatic use, in particular +through the interface defined in libavfilter/buffersink.h +or the options system. +

+

It accepts a pointer to an AVABufferSinkContext structure, which +defines the incoming buffers’ formats, to be passed as the opaque +parameter to avfilter_init_filter for initialization. +

+

29.2 anullsink

+ +

Null audio sink; do absolutely nothing with the input audio. It is +mainly useful as a template and for use in analysis / debugging +tools. +

+ + +

30 Video Filters

+ +

When you configure your FFmpeg build, you can disable any of the +existing filters using --disable-filters. +The configure output will show the video filters included in your +build. +

+

Below is a description of the currently available video filters. +

+ +

30.1 addroi

+ +

Mark a region of interest in a video frame. +

+

The frame data is passed through unchanged, but metadata is attached +to the frame indicating regions of interest which can affect the +behaviour of later encoding. Multiple regions can be marked by +applying the filter multiple times. +

+
+
x
+

Region distance in pixels from the left edge of the frame. +

+
y
+

Region distance in pixels from the top edge of the frame. +

+
w
+

Region width in pixels. +

+
h
+

Region height in pixels. +

+

The parameters x, y, w and h are expressions, +and may contain the following variables: +

+
iw
+

Width of the input frame. +

+
ih
+

Height of the input frame. +

+
+ +
+
qoffset
+

Quantisation offset to apply within the region. +

+

This must be a real value in the range -1 to +1. A value of zero +indicates no quality change. A negative value asks for better quality +(less quantisation), while a positive value asks for worse quality +(greater quantisation). +

+

The range is calibrated so that the extreme values indicate the +largest possible offset - if the rest of the frame is encoded with the +worst possible quality, an offset of -1 indicates that this region +should be encoded with the best possible quality anyway. Intermediate +values are then interpolated in some codec-dependent way. +

+

For example, in 10-bit H.264 the quantisation parameter varies between +-12 and 51. A typical qoffset value of -1/10 therefore indicates that +this region should be encoded with a QP around one-tenth of the full +range better than the rest of the frame. So, if most of the frame +were to be encoded with a QP of around 30, this region would get a QP +of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3). +An extreme value of -1 would indicate that this region should be +encoded with the best possible quality regardless of the treatment of +the rest of the frame - that is, should be encoded at a QP of -12. +

+
clear
+

If set to true, remove any existing regions of interest marked on the +frame before adding the new one. +

+
+ + +

30.1.1 Examples

+ +
    +
  • Mark the centre quarter of the frame as interesting. +
    +
    addroi=iw/4:ih/4:iw/2:ih/2:-1/10
+
    +
  • Mark the 100-pixel-wide region on the left edge of the frame as very +uninteresting (to be encoded at much lower quality than the rest of +the frame). +
    +
    addroi=0:0:100:ih:+1/5
+
    +
+ + +

30.2 alphaextract

+ +

Extract the alpha component from the input as a grayscale video. This +is especially useful with the alphamerge filter. +

+ +

30.3 alphamerge

+ +

Add or replace the alpha component of the primary input with the +grayscale value of a second input. This is intended for use with +alphaextract to allow the transmission or storage of frame +sequences that have alpha in a format that doesn’t support an alpha +channel. +

+

For example, to reconstruct full frames from a normal YUV-encoded video +and a separate video created with alphaextract, you might use: +

+
movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
+
+ +

Since this filter is designed for reconstruction, it operates on frame +sequences without considering timestamps, and terminates when either +input reaches end of stream. This will cause problems if your encoding +pipeline drops frames. If you’re trying to apply an image as an +overlay to a video stream, consider the overlay filter instead. +

+ +

30.4 amplify

+ +

Amplify differences between current pixel and pixels of adjacent frames in +same pixel location. +

+

This filter accepts the following options: +

+
+
radius
+

Set frame radius. Default is 2. Allowed range is from 1 to 63. +For example radius of 3 will instruct filter to calculate average of 7 frames. +

+
+
factor
+

Set factor to amplify difference. Default is 2. Allowed range is from 0 to 65535. +

+
+
threshold
+

Set threshold for difference amplification. Any difference greater or equal to +this value will not alter source pixel. Default is 10. +Allowed range is from 0 to 65535. +

+
+
tolerance
+

Set tolerance for difference amplification. Any difference lower to +this value will not alter source pixel. Default is 0. +Allowed range is from 0 to 65535. +

+
+
low
+

Set lower limit for changing source pixel. Default is 65535. Allowed range is from 0 to 65535. +This option controls maximum possible value that will decrease source pixel value. +

+
+
high
+

Set high limit for changing source pixel. Default is 65535. Allowed range is from 0 to 65535. +This option controls maximum possible value that will increase source pixel value. +

+
+
planes
+

Set which planes to filter. Default is all. Allowed range is from 0 to 15. +

+
+ + +

30.4.1 Commands

+ +

This filter supports the following commands that corresponds to option of same name: +

+
factor
+
threshold
+
tolerance
+
low
+
high
+
planes
+
+ + +

30.5 ass

+ +

Same as the subtitles filter, except that it doesn’t require libavcodec +and libavformat to work. On the other hand, it is limited to ASS (Advanced +Substation Alpha) subtitles files. +

+

This filter accepts the following option in addition to the common options from +the subtitles filter: +

+
+
shaping
+

Set the shaping engine +

+

Available values are: +

+
‘auto’
+

The default libass shaping engine, which is the best available. +

+
‘simple’
+

Fast, font-agnostic shaper that can do only substitutions +

+
‘complex’
+

Slower shaper using OpenType for substitutions and positioning +

+
+ +

The default is auto. +

+
+ + +

30.6 atadenoise

+

Apply an Adaptive Temporal Averaging Denoiser to the video input. +

+

The filter accepts the following options: +

+
+
0a
+

Set threshold A for 1st plane. Default is 0.02. +Valid range is 0 to 0.3. +

+
+
0b
+

Set threshold B for 1st plane. Default is 0.04. +Valid range is 0 to 5. +

+
+
1a
+

Set threshold A for 2nd plane. Default is 0.02. +Valid range is 0 to 0.3. +

+
+
1b
+

Set threshold B for 2nd plane. Default is 0.04. +Valid range is 0 to 5. +

+
+
2a
+

Set threshold A for 3rd plane. Default is 0.02. +Valid range is 0 to 0.3. +

+
+
2b
+

Set threshold B for 3rd plane. Default is 0.04. +Valid range is 0 to 5. +

+

Threshold A is designed to react on abrupt changes in the input signal and +threshold B is designed to react on continuous changes in the input signal. +

+
+
s
+

Set number of frames filter will use for averaging. Default is 9. Must be odd +number in range [5, 129]. +

+
+
p
+

Set what planes of frame filter will use for averaging. Default is all. +

+
+
a
+

Set what variant of algorithm filter will use for averaging. Default is p parallel. +Alternatively can be set to s serial. +

+

Parallel can be faster then serial, while other way around is never true. +Parallel will abort early on first change being greater then thresholds, while serial +will continue processing other side of frames if they are equal or bellow thresholds. +

+
+ + +

30.6.1 Commands

+

This filter supports same commands as options except option s. +The command accepts the same syntax of the corresponding option. +

+ +

30.7 avgblur

+ +

Apply average blur filter. +

+

The filter accepts the following options: +

+
+
sizeX
+

Set horizontal radius size. +

+
+
planes
+

Set which planes to filter. By default all planes are filtered. +

+
+
sizeY
+

Set vertical radius size, if zero it will be same as sizeX. +Default is 0. +

+
+ + +

30.7.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.8 bbox

+ +

Compute the bounding box for the non-black pixels in the input frame +luminance plane. +

+

This filter computes the bounding box containing all the pixels with a +luminance value greater than the minimum allowed value. +The parameters describing the bounding box are printed on the filter +log. +

+

The filter accepts the following option: +

+
+
min_val
+

Set the minimal luminance value. Default is 16. +

+
+ + +

30.9 bilateral

+

Apply bilateral filter, spatial smoothing while preserving edges. +

+

The filter accepts the following options: +

+
sigmaS
+

Set sigma of gaussian function to calculate spatial weight. +Allowed range is 0 to 10. Default is 0.1. +

+
+
sigmaR
+

Set sigma of gaussian function to calculate range weight. +Allowed range is 0 to 1. Default is 0.1. +

+
+
planes
+

Set planes to filter. Default is first only. +

+
+ + +

30.10 bitplanenoise

+ +

Show and measure bit plane noise. +

+

The filter accepts the following options: +

+
+
bitplane
+

Set which plane to analyze. Default is 1. +

+
+
filter
+

Filter out noisy pixels from bitplane set above. +Default is disabled. +

+
+ + +

30.11 blackdetect

+ +

Detect video intervals that are (almost) completely black. Can be +useful to detect chapter transitions, commercials, or invalid +recordings. +

+

The filter outputs its detection analysis to both the log as well as +frame metadata. If a black segment of at least the specified minimum +duration is found, a line with the start and end timestamps as well +as duration is printed to the log with level info. In addition, +a log line with level debug is printed per frame showing the +black amount detected for that frame. +

+

The filter also attaches metadata to the first frame of a black +segment with key lavfi.black_start and to the first frame +after the black segment ends with key lavfi.black_end. The +value is the frame’s timestamp. This metadata is added regardless +of the minimum duration specified. +

+

The filter accepts the following options: +

+
+
black_min_duration, d
+

Set the minimum detected black duration expressed in seconds. It must +be a non-negative floating point number. +

+

Default value is 2.0. +

+
+
picture_black_ratio_th, pic_th
+

Set the threshold for considering a picture "black". +Express the minimum value for the ratio: +

+
nb_black_pixels / nb_pixels
+
+ +

for which a picture is considered black. +Default value is 0.98. +

+
+
pixel_black_th, pix_th
+

Set the threshold for considering a pixel "black". +

+

The threshold expresses the maximum pixel luminance value for which a +pixel is considered "black". The provided value is scaled according to +the following equation: +

+
absolute_threshold = luminance_minimum_value + pixel_black_th * luminance_range_size
+
+ +

luminance_range_size and luminance_minimum_value depend on +the input video format, the range is [0-255] for YUV full-range +formats and [16-235] for YUV non full-range formats. +

+

Default value is 0.10. +

+
+ +

The following example sets the maximum pixel threshold to the minimum +value, and detects only black intervals of 2 or more seconds: +

+
blackdetect=d=2:pix_th=0.00
+
+ + +

30.12 blackframe

+ +

Detect frames that are (almost) completely black. Can be useful to +detect chapter transitions or commercials. Output lines consist of +the frame number of the detected frame, the percentage of blackness, +the position in the file if known or -1 and the timestamp in seconds. +

+

In order to display the output lines, you need to set the loglevel at +least to the AV_LOG_INFO value. +

+

This filter exports frame metadata lavfi.blackframe.pblack. +The value represents the percentage of pixels in the picture that +are below the threshold value. +

+

It accepts the following parameters: +

+
+
amount
+

The percentage of the pixels that have to be below the threshold; it defaults to +98. +

+
+
threshold, thresh
+

The threshold below which a pixel value is considered black; it defaults to +32. +

+
+
+ + +

30.13 blend

+ +

Blend two video frames into each other. +

+

The blend filter takes two input streams and outputs one +stream, the first input is the "top" layer and second input is +"bottom" layer. By default, the output terminates when the longest input terminates. +

+

The tblend (time blend) filter takes two consecutive frames +from one single stream, and outputs the result obtained by blending +the new frame on top of the old frame. +

+

A description of the accepted options follows. +

+
+
c0_mode
+
c1_mode
+
c2_mode
+
c3_mode
+
all_mode
+

Set blend mode for specific pixel component or all pixel components in case +of all_mode. Default value is normal. +

+

Available values for component modes are: +

+
‘addition’
+
‘grainmerge’
+
‘and’
+
‘average’
+
‘burn’
+
‘darken’
+
‘difference’
+
‘grainextract’
+
‘divide’
+
‘dodge’
+
‘freeze’
+
‘exclusion’
+
‘extremity’
+
‘glow’
+
‘hardlight’
+
‘hardmix’
+
‘heat’
+
‘lighten’
+
‘linearlight’
+
‘multiply’
+
‘multiply128’
+
‘negation’
+
‘normal’
+
‘or’
+
‘overlay’
+
‘phoenix’
+
‘pinlight’
+
‘reflect’
+
‘screen’
+
‘softlight’
+
‘subtract’
+
‘vividlight’
+
‘xor’
+
+ +
+
c0_opacity
+
c1_opacity
+
c2_opacity
+
c3_opacity
+
all_opacity
+

Set blend opacity for specific pixel component or all pixel components in case +of all_opacity. Only used in combination with pixel component blend modes. +

+
+
c0_expr
+
c1_expr
+
c2_expr
+
c3_expr
+
all_expr
+

Set blend expression for specific pixel component or all pixel components in case +of all_expr. Note that related mode options will be ignored if those are set. +

+

The expressions can use the following variables: +

+
+
N
+

The sequential number of the filtered frame, starting from 0. +

+
+
X
+
Y
+

the coordinates of the current sample +

+
+
W
+
H
+

the width and height of currently filtered plane +

+
+
SW
+
SH
+

Width and height scale for the plane being filtered. It is the +ratio between the dimensions of the current plane to the luma plane, +e.g. for a yuv420p frame, the values are 1,1 for +the luma plane and 0.5,0.5 for the chroma planes. +

+
+
T
+

Time of the current frame, expressed in seconds. +

+
+
TOP, A
+

Value of pixel component at current location for first video frame (top layer). +

+
+
BOTTOM, B
+

Value of pixel component at current location for second video frame (bottom layer). +

+
+
+
+ +

The blend filter also supports the framesync options. +

+ +

30.13.1 Examples

+ +
    +
  • Apply transition from bottom layer to top layer in first 10 seconds: +
    +
    blend=all_expr='A*(if(gte(T,10),1,T/10))+B*(1-(if(gte(T,10),1,T/10)))'
+
    + +
  • Apply linear horizontal transition from top layer to bottom layer: +
    +
    blend=all_expr='A*(X/W)+B*(1-X/W)'
+
    + +
  • Apply 1x1 checkerboard effect: +
    +
    blend=all_expr='if(eq(mod(X,2),mod(Y,2)),A,B)'
+
    + +
  • Apply uncover left effect: +
    +
    blend=all_expr='if(gte(N*SW+X,W),A,B)'
+
    + +
  • Apply uncover down effect: +
    +
    blend=all_expr='if(gte(Y-N*SH,0),A,B)'
+
    + +
  • Apply uncover up-left effect: +
    +
    blend=all_expr='if(gte(T*SH*40+Y,H)*gte((T*40*SW+X)*W/H,W),A,B)'
+
    + +
  • Split diagonally video and shows top and bottom layer on each side: +
    +
    blend=all_expr='if(gt(X,Y*(W/H)),A,B)'
+
    + +
  • Display differences between the current and the previous frame: +
    +
    tblend=all_mode=grainextract
+
    +
+ + +

30.14 bm3d

+ +

Denoise frames using Block-Matching 3D algorithm. +

+

The filter accepts the following options. +

+
+
sigma
+

Set denoising strength. Default value is 1. +Allowed range is from 0 to 999.9. +The denoising algorithm is very sensitive to sigma, so adjust it +according to the source. +

+
+
block
+

Set local patch size. This sets dimensions in 2D. +

+
+
bstep
+

Set sliding step for processing blocks. Default value is 4. +Allowed range is from 1 to 64. +Smaller values allows processing more reference blocks and is slower. +

+
+
group
+

Set maximal number of similar blocks for 3rd dimension. Default value is 1. +When set to 1, no block matching is done. Larger values allows more blocks +in single group. +Allowed range is from 1 to 256. +

+
+
range
+

Set radius for search block matching. Default is 9. +Allowed range is from 1 to INT32_MAX. +

+
+
mstep
+

Set step between two search locations for block matching. Default is 1. +Allowed range is from 1 to 64. Smaller is slower. +

+
+
thmse
+

Set threshold of mean square error for block matching. Valid range is 0 to +INT32_MAX. +

+
+
hdthr
+

Set thresholding parameter for hard thresholding in 3D transformed domain. +Larger values results in stronger hard-thresholding filtering in frequency +domain. +

+
+
estim
+

Set filtering estimation mode. Can be basic or final. +Default is basic. +

+
+
ref
+

If enabled, filter will use 2nd stream for block matching. +Default is disabled for basic value of estim option, +and always enabled if value of estim is final. +

+
+
planes
+

Set planes to filter. Default is all available except alpha. +

+
+ + +

30.14.1 Examples

+ +
    +
  • Basic filtering with bm3d: +
    +
    bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic
+
    + +
  • Same as above, but filtering only luma: +
    +
    bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic:planes=1
+
    + +
  • Same as above, but with both estimation modes: +
    +
    split[a][b],[a]bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic[a],[b][a]bm3d=sigma=3:block=4:bstep=2:group=16:estim=final:ref=1
+
    + +
  • Same as above, but prefilter with nlmeans filter instead: +
    +
    split[a][b],[a]nlmeans=s=3:r=7:p=3[a],[b][a]bm3d=sigma=3:block=4:bstep=2:group=16:estim=final:ref=1
+
    +
+ + +

30.15 boxblur

+ +

Apply a boxblur algorithm to the input video. +

+

It accepts the following parameters: +

+
+
luma_radius, lr
+
luma_power, lp
+
chroma_radius, cr
+
chroma_power, cp
+
alpha_radius, ar
+
alpha_power, ap
+
+ +

A description of the accepted options follows. +

+
+
luma_radius, lr
+
chroma_radius, cr
+
alpha_radius, ar
+

Set an expression for the box radius in pixels used for blurring the +corresponding input plane. +

+

The radius value must be a non-negative number, and must not be +greater than the value of the expression min(w,h)/2 for the +luma and alpha planes, and of min(cw,ch)/2 for the chroma +planes. +

+

Default value for luma_radius is "2". If not specified, +chroma_radius and alpha_radius default to the +corresponding value set for luma_radius. +

+

The expressions can contain the following constants: +

+
w
+
h
+

The input width and height in pixels. +

+
+
cw
+
ch
+

The input chroma image width and height in pixels. +

+
+
hsub
+
vsub
+

The horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p", hsub is 2 and vsub is 1. +

+
+ +
+
luma_power, lp
+
chroma_power, cp
+
alpha_power, ap
+

Specify how many times the boxblur filter is applied to the +corresponding plane. +

+

Default value for luma_power is 2. If not specified, +chroma_power and alpha_power default to the +corresponding value set for luma_power. +

+

A value of 0 will disable the effect. +

+
+ + +

30.15.1 Examples

+ +
    +
  • Apply a boxblur filter with the luma, chroma, and alpha radii +set to 2: +
    +
    boxblur=luma_radius=2:luma_power=1
+boxblur=2:1
+
    + +
  • Set the luma radius to 2, and alpha and chroma radius to 0: +
    +
    boxblur=2:1:cr=0:ar=0
+
    + +
  • Set the luma and chroma radii to a fraction of the video dimension: +
    +
    boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
+
    +
+ + +

30.16 bwdif

+ +

Deinterlace the input video ("bwdif" stands for "Bob Weaver +Deinterlacing Filter"). +

+

Motion adaptive deinterlacing based on yadif with the use of w3fdif and cubic +interpolation algorithms. +It accepts the following parameters: +

+
+
mode
+

The interlacing mode to adopt. It accepts one of the following values: +

+
+
0, send_frame
+

Output one frame for each frame. +

+
1, send_field
+

Output one frame for each field. +

+
+ +

The default value is send_field. +

+
+
parity
+

The picture field parity assumed for the input interlaced video. It accepts one +of the following values: +

+
+
0, tff
+

Assume the top field is first. +

+
1, bff
+

Assume the bottom field is first. +

+
-1, auto
+

Enable automatic detection of field parity. +

+
+ +

The default value is auto. +If the interlacing is unknown or the decoder does not export this information, +top field first will be assumed. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following +values: +

+
+
0, all
+

Deinterlace all frames. +

+
1, interlaced
+

Only deinterlace frames marked as interlaced. +

+
+ +

The default value is all. +

+
+ + +

30.17 cas

+ +

Apply Contrast Adaptive Sharpen filter to video stream. +

+

The filter accepts the following options: +

+
+
strength
+

Set the sharpening strength. Default value is 0. +

+
+
planes
+

Set planes to filter. Default value is to filter all +planes except alpha plane. +

+
+ + +

30.18 chromahold

+

Remove all color information for all colors except for certain one. +

+

The filter accepts the following options: +

+
+
color
+

The color which will not be replaced with neutral chroma. +

+
+
similarity
+

Similarity percentage with the above color. +0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +0.0 makes pixels either fully gray, or not gray at all. +Higher values result in more preserved color. +

+
+
yuv
+

Signals that the color passed is already in YUV instead of RGB. +

+

Literal colors like "green" or "red" don’t make sense with this enabled anymore. +This can be used to pass exact YUV values as hexadecimal numbers. +

+
+ + +

30.18.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.19 chromakey

+

YUV colorspace color/chroma keying. +

+

The filter accepts the following options: +

+
+
color
+

The color which will be replaced with transparency. +

+
+
similarity
+

Similarity percentage with the key color. +

+

0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +

+

0.0 makes pixels either fully transparent, or not transparent at all. +

+

Higher values result in semi-transparent pixels, with a higher transparency +the more similar the pixels color is to the key color. +

+
+
yuv
+

Signals that the color passed is already in YUV instead of RGB. +

+

Literal colors like "green" or "red" don’t make sense with this enabled anymore. +This can be used to pass exact YUV values as hexadecimal numbers. +

+
+ + +

30.19.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.19.2 Examples

+ +
    +
  • Make every green pixel in the input image transparent: +
    +
    ffmpeg -i input.png -vf chromakey=green out.png
+
    + +
  • Overlay a greenscreen-video on top of a static black background. +
    +
    ffmpeg -f lavfi -i color=c=black:s=1280x720 -i video.mp4 -shortest -filter_complex "[1:v]chromakey=0x70de77:0.1:0.2[ckout];[0:v][ckout]overlay[out]" -map "[out]" output.mkv
+
    +
+ + +

30.20 chromashift

+

Shift chroma pixels horizontally and/or vertically. +

+

The filter accepts the following options: +

+
cbh
+

Set amount to shift chroma-blue horizontally. +

+
cbv
+

Set amount to shift chroma-blue vertically. +

+
crh
+

Set amount to shift chroma-red horizontally. +

+
crv
+

Set amount to shift chroma-red vertically. +

+
edge
+

Set edge mode, can be smear, default, or warp. +

+
+ + +

30.20.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

30.21 ciescope

+ +

Display CIE color diagram with pixels overlaid onto it. +

+

The filter accepts the following options: +

+
+
system
+

Set color system. +

+
+
‘ntsc, 470m’
+
‘ebu, 470bg’
+
‘smpte’
+
‘240m’
+
‘apple’
+
‘widergb’
+
‘cie1931’
+
‘rec709, hdtv’
+
‘uhdtv, rec2020’
+
‘dcip3’
+
+ +
+
cie
+

Set CIE system. +

+
+
‘xyy’
+
‘ucs’
+
‘luv’
+
+ +
+
gamuts
+

Set what gamuts to draw. +

+

See system option for available values. +

+
+
size, s
+

Set ciescope size, by default set to 512. +

+
+
intensity, i
+

Set intensity used to map input pixel values to CIE diagram. +

+
+
contrast
+

Set contrast used to draw tongue colors that are out of active color system gamut. +

+
+
corrgamma
+

Correct gamma displayed on scope, by default enabled. +

+
+
showwhite
+

Show white point on CIE diagram, by default disabled. +

+
+
gamma
+

Set input gamma. Used only with XYZ input color space. +

+
+ + +

30.22 codecview

+ +

Visualize information exported by some codecs. +

+

Some codecs can export information through frames using side-data or other +means. For example, some MPEG based codecs export motion vectors through the +export_mvs flag in the codec flags2 option. +

+

The filter accepts the following option: +

+
+
mv
+

Set motion vectors to visualize. +

+

Available flags for mv are: +

+
+
‘pf’
+

forward predicted MVs of P-frames +

+
‘bf’
+

forward predicted MVs of B-frames +

+
‘bb’
+

backward predicted MVs of B-frames +

+
+ +
+
qp
+

Display quantization parameters using the chroma planes. +

+
+
mv_type, mvt
+

Set motion vectors type to visualize. Includes MVs from all frames unless specified by frame_type option. +

+

Available flags for mv_type are: +

+
+
‘fp’
+

forward predicted MVs +

+
‘bp’
+

backward predicted MVs +

+
+ +
+
frame_type, ft
+

Set frame type to visualize motion vectors of. +

+

Available flags for frame_type are: +

+
+
‘if’
+

intra-coded frames (I-frames) +

+
‘pf’
+

predicted frames (P-frames) +

+
‘bf’
+

bi-directionally predicted frames (B-frames) +

+
+
+
+ + +

30.22.1 Examples

+ +
    +
  • Visualize forward predicted MVs of all frames using ffplay: +
    +
    ffplay -flags2 +export_mvs input.mp4 -vf codecview=mv_type=fp
+
    + +
  • Visualize multi-directionals MVs of P and B-Frames using ffplay: +
    +
    ffplay -flags2 +export_mvs input.mp4 -vf codecview=mv=pf+bf+bb
+
    +
+ + +

30.23 colorbalance

+

Modify intensity of primary colors (red, green and blue) of input frames. +

+

The filter allows an input frame to be adjusted in the shadows, midtones or highlights +regions for the red-cyan, green-magenta or blue-yellow balance. +

+

A positive adjustment value shifts the balance towards the primary color, a negative +value towards the complementary color. +

+

The filter accepts the following options: +

+
+
rs
+
gs
+
bs
+

Adjust red, green and blue shadows (darkest pixels). +

+
+
rm
+
gm
+
bm
+

Adjust red, green and blue midtones (medium pixels). +

+
+
rh
+
gh
+
bh
+

Adjust red, green and blue highlights (brightest pixels). +

+

Allowed ranges for options are [-1.0, 1.0]. Defaults are 0. +

+
+
pl
+

Preserve lightness when changing color balance. Default is disabled. +

+
+ + +

30.23.1 Examples

+ +
    +
  • Add red color cast to shadows: +
    +
    colorbalance=rs=.3
+
    +
+ + +

30.23.2 Commands

+ +

This filter supports the all above options as commands. +

+ +

30.24 colorchannelmixer

+ +

Adjust video input frames by re-mixing color channels. +

+

This filter modifies a color channel by adding the values associated to +the other channels of the same pixels. For example if the value to +modify is red, the output value will be: +

+
red=red*rr + blue*rb + green*rg + alpha*ra
+
+ +

The filter accepts the following options: +

+
+
rr
+
rg
+
rb
+
ra
+

Adjust contribution of input red, green, blue and alpha channels for output red channel. +Default is 1 for rr, and 0 for rg, rb and ra. +

+
+
gr
+
gg
+
gb
+
ga
+

Adjust contribution of input red, green, blue and alpha channels for output green channel. +Default is 1 for gg, and 0 for gr, gb and ga. +

+
+
br
+
bg
+
bb
+
ba
+

Adjust contribution of input red, green, blue and alpha channels for output blue channel. +Default is 1 for bb, and 0 for br, bg and ba. +

+
+
ar
+
ag
+
ab
+
aa
+

Adjust contribution of input red, green, blue and alpha channels for output alpha channel. +Default is 1 for aa, and 0 for ar, ag and ab. +

+

Allowed ranges for options are [-2.0, 2.0]. +

+
+ + +

30.24.1 Examples

+ +
    +
  • Convert source to grayscale: +
    +
    colorchannelmixer=.3:.4:.3:0:.3:.4:.3:0:.3:.4:.3
+
    +
  • Simulate sepia tones: +
    +
    colorchannelmixer=.393:.769:.189:0:.349:.686:.168:0:.272:.534:.131
+
    +
+ + +

30.24.2 Commands

+ +

This filter supports the all above options as commands. +

+ +

30.25 colorkey

+

RGB colorspace color keying. +

+

The filter accepts the following options: +

+
+
color
+

The color which will be replaced with transparency. +

+
+
similarity
+

Similarity percentage with the key color. +

+

0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +

+

0.0 makes pixels either fully transparent, or not transparent at all. +

+

Higher values result in semi-transparent pixels, with a higher transparency +the more similar the pixels color is to the key color. +

+
+ + +

30.25.1 Examples

+ +
    +
  • Make every green pixel in the input image transparent: +
    +
    ffmpeg -i input.png -vf colorkey=green out.png
+
    + +
  • Overlay a greenscreen-video on top of a static background image. +
    +
    ffmpeg -i background.png -i video.mp4 -filter_complex "[1:v]colorkey=0x3BBD1E:0.3:0.2[ckout];[0:v][ckout]overlay[out]" -map "[out]" output.flv
+
    +
+ + +

30.25.2 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.26 colorhold

+

Remove all color information for all RGB colors except for certain one. +

+

The filter accepts the following options: +

+
+
color
+

The color which will not be replaced with neutral gray. +

+
+
similarity
+

Similarity percentage with the above color. +0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. 0.0 makes pixels fully gray. +Higher values result in more preserved color. +

+
+ + +

30.26.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.27 colorlevels

+ +

Adjust video input frames using levels. +

+

The filter accepts the following options: +

+
+
rimin
+
gimin
+
bimin
+
aimin
+

Adjust red, green, blue and alpha input black point. +Allowed ranges for options are [-1.0, 1.0]. Defaults are 0. +

+
+
rimax
+
gimax
+
bimax
+
aimax
+

Adjust red, green, blue and alpha input white point. +Allowed ranges for options are [-1.0, 1.0]. Defaults are 1. +

+

Input levels are used to lighten highlights (bright tones), darken shadows +(dark tones), change the balance of bright and dark tones. +

+
+
romin
+
gomin
+
bomin
+
aomin
+

Adjust red, green, blue and alpha output black point. +Allowed ranges for options are [0, 1.0]. Defaults are 0. +

+
+
romax
+
gomax
+
bomax
+
aomax
+

Adjust red, green, blue and alpha output white point. +Allowed ranges for options are [0, 1.0]. Defaults are 1. +

+

Output levels allows manual selection of a constrained output level range. +

+
+ + +

30.27.1 Examples

+ +
    +
  • Make video output darker: +
    +
    colorlevels=rimin=0.058:gimin=0.058:bimin=0.058
+
    + +
  • Increase contrast: +
    +
    colorlevels=rimin=0.039:gimin=0.039:bimin=0.039:rimax=0.96:gimax=0.96:bimax=0.96
+
    + +
  • Make video output lighter: +
    +
    colorlevels=rimax=0.902:gimax=0.902:bimax=0.902
+
    + +
  • Increase brightness: +
    +
    colorlevels=romin=0.5:gomin=0.5:bomin=0.5
+
    +
+ + +

30.27.2 Commands

+ +

This filter supports the all above options as commands. +

+ +

30.28 colormatrix

+ +

Convert color matrix. +

+

The filter accepts the following options: +

+
+
src
+
dst
+

Specify the source and destination color matrix. Both values must be +specified. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘fcc’
+

FCC +

+
+
‘bt601’
+

BT.601 +

+
+
‘bt470’
+

BT.470 +

+
+
‘bt470bg’
+

BT.470BG +

+
+
‘smpte170m’
+

SMPTE-170M +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘bt2020’
+

BT.2020 +

+
+
+
+ +

For example to convert from BT.601 to SMPTE-240M, use the command: +

+
colormatrix=bt601:smpte240m
+
+ + +

30.29 colorspace

+ +

Convert colorspace, transfer characteristics or color primaries. +Input video needs to have an even size. +

+

The filter accepts the following options: +

+
+
+
all
+

Specify all color properties at once. +

+

The accepted values are: +

+
‘bt470m’
+

BT.470M +

+
+
‘bt470bg’
+

BT.470BG +

+
+
‘bt601-6-525’
+

BT.601-6 525 +

+
+
‘bt601-6-625’
+

BT.601-6 625 +

+
+
‘bt709’
+

BT.709 +

+
+
‘smpte170m’
+

SMPTE-170M +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘bt2020’
+

BT.2020 +

+
+
+ +
+
space
+

Specify output colorspace. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘fcc’
+

FCC +

+
+
‘bt470bg’
+

BT.470BG or BT.601-6 625 +

+
+
‘smpte170m’
+

SMPTE-170M or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘ycgco’
+

YCgCo +

+
+
‘bt2020ncl’
+

BT.2020 with non-constant luminance +

+
+
+ +
+
trc
+

Specify output transfer characteristics. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘bt470m’
+

BT.470M +

+
+
‘bt470bg’
+

BT.470BG +

+
+
‘gamma22’
+

Constant gamma of 2.2 +

+
+
‘gamma28’
+

Constant gamma of 2.8 +

+
+
‘smpte170m’
+

SMPTE-170M, BT.601-6 625 or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘srgb’
+

SRGB +

+
+
‘iec61966-2-1’
+

iec61966-2-1 +

+
+
‘iec61966-2-4’
+

iec61966-2-4 +

+
+
‘xvycc’
+

xvycc +

+
+
‘bt2020-10’
+

BT.2020 for 10-bits content +

+
+
‘bt2020-12’
+

BT.2020 for 12-bits content +

+
+
+ +
+
primaries
+

Specify output color primaries. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘bt470m’
+

BT.470M +

+
+
‘bt470bg’
+

BT.470BG or BT.601-6 625 +

+
+
‘smpte170m’
+

SMPTE-170M or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘film’
+

film +

+
+
‘smpte431’
+

SMPTE-431 +

+
+
‘smpte432’
+

SMPTE-432 +

+
+
‘bt2020’
+

BT.2020 +

+
+
‘jedec-p22’
+

JEDEC P22 phosphors +

+
+
+ +
+
range
+

Specify output color range. +

+

The accepted values are: +

+
‘tv’
+

TV (restricted) range +

+
+
‘mpeg’
+

MPEG (restricted) range +

+
+
‘pc’
+

PC (full) range +

+
+
‘jpeg’
+

JPEG (full) range +

+
+
+ +
+
format
+

Specify output color format. +

+

The accepted values are: +

+
‘yuv420p’
+

YUV 4:2:0 planar 8-bits +

+
+
‘yuv420p10’
+

YUV 4:2:0 planar 10-bits +

+
+
‘yuv420p12’
+

YUV 4:2:0 planar 12-bits +

+
+
‘yuv422p’
+

YUV 4:2:2 planar 8-bits +

+
+
‘yuv422p10’
+

YUV 4:2:2 planar 10-bits +

+
+
‘yuv422p12’
+

YUV 4:2:2 planar 12-bits +

+
+
‘yuv444p’
+

YUV 4:4:4 planar 8-bits +

+
+
‘yuv444p10’
+

YUV 4:4:4 planar 10-bits +

+
+
‘yuv444p12’
+

YUV 4:4:4 planar 12-bits +

+
+
+ +
+
fast
+

Do a fast conversion, which skips gamma/primary correction. This will take +significantly less CPU, but will be mathematically incorrect. To get output +compatible with that produced by the colormatrix filter, use fast=1. +

+
+
dither
+

Specify dithering mode. +

+

The accepted values are: +

+
‘none’
+

No dithering +

+
+
‘fsb’
+

Floyd-Steinberg dithering +

+
+ +
+
wpadapt
+

Whitepoint adaptation mode. +

+

The accepted values are: +

+
‘bradford’
+

Bradford whitepoint adaptation +

+
+
‘vonkries’
+

von Kries whitepoint adaptation +

+
+
‘identity’
+

identity whitepoint adaptation (i.e. no whitepoint adaptation) +

+
+ +
+
iall
+

Override all input properties at once. Same accepted values as all. +

+
+
ispace
+

Override input colorspace. Same accepted values as space. +

+
+
iprimaries
+

Override input color primaries. Same accepted values as primaries. +

+
+
itrc
+

Override input transfer characteristics. Same accepted values as trc. +

+
+
irange
+

Override input color range. Same accepted values as range. +

+
+
+ +

The filter converts the transfer characteristics, color space and color +primaries to the specified user values. The output value, if not specified, +is set to a default value based on the "all" property. If that property is +also not specified, the filter will log an error. The output color range and +format default to the same value as the input color range and format. The +input transfer characteristics, color space, color primaries and color range +should be set on the input data. If any of these are missing, the filter will +log an error and no conversion will take place. +

+

For example to convert the input to SMPTE-240M, use the command: +

+
colorspace=smpte240m
+
+ + +

30.30 convolution

+ +

Apply convolution of 3x3, 5x5, 7x7 or horizontal/vertical up to 49 elements. +

+

The filter accepts the following options: +

+
+
0m
+
1m
+
2m
+
3m
+

Set matrix for each plane. +Matrix is sequence of 9, 25 or 49 signed integers in square mode, +and from 1 to 49 odd number of signed integers in row mode. +

+
+
0rdiv
+
1rdiv
+
2rdiv
+
3rdiv
+

Set multiplier for calculated value for each plane. +If unset or 0, it will be sum of all matrix elements. +

+
+
0bias
+
1bias
+
2bias
+
3bias
+

Set bias for each plane. This value is added to the result of the multiplication. +Useful for making the overall image brighter or darker. Default is 0.0. +

+
+
0mode
+
1mode
+
2mode
+
3mode
+

Set matrix mode for each plane. Can be square, row or column. +Default is square. +

+
+ + +

30.30.1 Examples

+ +
    +
  • Apply sharpen: +
    +
    convolution="0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0"
+
    + +
  • Apply blur: +
    +
    convolution="1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1/9:1/9:1/9:1/9"
+
    + +
  • Apply edge enhance: +
    +
    convolution="0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:5:1:1:1:0:128:128:128"
+
    + +
  • Apply edge detect: +
    +
    convolution="0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:5:5:5:1:0:128:128:128"
+
    + +
  • Apply laplacian edge detector which includes diagonals: +
    +
    convolution="1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:5:5:5:1:0:128:128:0"
+
    + +
  • Apply emboss: +
    +
    convolution="-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2"
+
    +
+ + +

30.31 convolve

+ +

Apply 2D convolution of video stream in frequency domain using second stream +as impulse. +

+

The filter accepts the following options: +

+
+
planes
+

Set which planes to process. +

+
+
impulse
+

Set which impulse video frames will be processed, can be first +or all. Default is all. +

+
+ +

The convolve filter also supports the framesync options. +

+ +

30.32 copy

+ +

Copy the input video source unchanged to the output. This is mainly useful for +testing purposes. +

+ +

30.33 coreimage

+

Video filtering on GPU using Apple’s CoreImage API on OSX. +

+

Hardware acceleration is based on an OpenGL context. Usually, this means it is +processed by video hardware. However, software-based OpenGL implementations +exist which means there is no guarantee for hardware processing. It depends on +the respective OSX. +

+

There are many filters and image generators provided by Apple that come with a +large variety of options. The filter has to be referenced by its name along +with its options. +

+

The coreimage filter accepts the following options: +

+
list_filters
+

List all available filters and generators along with all their respective +options as well as possible minimum and maximum values along with the default +values. +

+
list_filters=true
+
+ +
+
filter
+

Specify all filters by their respective name and options. +Use list_filters to determine all valid filter names and options. +Numerical options are specified by a float value and are automatically clamped +to their respective value range. Vector and color options have to be specified +by a list of space separated float values. Character escaping has to be done. +A special option name default is available to use default options for a +filter. +

+

It is required to specify either default or at least one of the filter options. +All omitted options are used with their default values. +The syntax of the filter string is as follows: +

+
filter=<NAME>@<OPTION>=<VALUE>[@<OPTION>=<VALUE>][@...][#<NAME>@<OPTION>=<VALUE>[@<OPTION>=<VALUE>][@...]][#...]
+
+ +
+
output_rect
+

Specify a rectangle where the output of the filter chain is copied into the +input image. It is given by a list of space separated float values: +

+
output_rect=x\ y\ width\ height
+
+

If not given, the output rectangle equals the dimensions of the input image. +The output rectangle is automatically cropped at the borders of the input +image. Negative values are valid for each component. +

+
output_rect=25\ 25\ 100\ 100
+
+
+
+ +

Several filters can be chained for successive processing without GPU-HOST +transfers allowing for fast processing of complex filter chains. +Currently, only filters with zero (generators) or exactly one (filters) input +image and one output image are supported. Also, transition filters are not yet +usable as intended. +

+

Some filters generate output images with additional padding depending on the +respective filter kernel. The padding is automatically removed to ensure the +filter output has the same size as the input image. +

+

For image generators, the size of the output image is determined by the +previous output image of the filter chain or the input image of the whole +filterchain, respectively. The generators do not use the pixel information of +this image to generate their output. However, the generated output is +blended onto this image, resulting in partial or complete coverage of the +output image. +

+

The coreimagesrc video source can be used for generating input images +which are directly fed into the filter chain. By using it, providing input +images by another video source or an input video is not required. +

+ +

30.33.1 Examples

+ +
    +
  • List all filters available: +
    +
    coreimage=list_filters=true
+
    + +
  • Use the CIBoxBlur filter with default options to blur an image: +
    +
    coreimage=filter=CIBoxBlur@default
+
    + +
  • Use a filter chain with CISepiaTone at default values and CIVignetteEffect with +its center at 100x100 and a radius of 50 pixels: +
    +
    coreimage=filter=CIBoxBlur@default#CIVignetteEffect@inputCenter=100\ 100@inputRadius=50
+
    + +
  • Use nullsrc and CIQRCodeGenerator to create a QR code for the FFmpeg homepage, +given as complete and escaped command-line for Apple’s standard bash shell: +
    +
    ffmpeg -f lavfi -i nullsrc=s=100x100,coreimage=filter=CIQRCodeGenerator@inputMessage=https\\\\\://FFmpeg.org/@inputCorrectionLevel=H -frames:v 1 QRCode.png
+
    +
+ + +

30.34 cover_rect

+ +

Cover a rectangular object +

+

It accepts the following options: +

+
+
cover
+

Filepath of the optional cover image, needs to be in yuv420. +

+
+
mode
+

Set covering mode. +

+

It accepts the following values: +

+
‘cover’
+

cover it by the supplied image +

+
‘blur’
+

cover it by interpolating the surrounding pixels +

+
+ +

Default value is blur. +

+
+ + +

30.34.1 Examples

+ +
    +
  • Cover a rectangular object by the supplied image of a given video using ffmpeg: +
    +
    ffmpeg -i file.ts -vf find_rect=newref.pgm,cover_rect=cover.jpg:mode=cover new.mkv
+
    +
+ + +

30.35 crop

+ +

Crop the input video to given dimensions. +

+

It accepts the following parameters: +

+
+
w, out_w
+

The width of the output video. It defaults to iw. +This expression is evaluated only once during the filter +configuration, or when the ‘w’ or ‘out_w’ command is sent. +

+
+
h, out_h
+

The height of the output video. It defaults to ih. +This expression is evaluated only once during the filter +configuration, or when the ‘h’ or ‘out_h’ command is sent. +

+
+
x
+

The horizontal position, in the input video, of the left edge of the output +video. It defaults to (in_w-out_w)/2. +This expression is evaluated per-frame. +

+
+
y
+

The vertical position, in the input video, of the top edge of the output video. +It defaults to (in_h-out_h)/2. +This expression is evaluated per-frame. +

+
+
keep_aspect
+

If set to 1 will force the output display aspect ratio +to be the same of the input, by changing the output sample aspect +ratio. It defaults to 0. +

+
+
exact
+

Enable exact cropping. If enabled, subsampled videos will be cropped at exact +width/height/x/y as specified and will not be rounded to nearest smaller value. +It defaults to 0. +

+
+ +

The out_w, out_h, x, y parameters are +expressions containing the following constants: +

+
+
x
+
y
+

The computed values for x and y. They are evaluated for +each new frame. +

+
+
in_w
+
in_h
+

The input width and height. +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output (cropped) width and height. +

+
+
ow
+
oh
+

These are the same as out_w and out_h. +

+
+
a
+

same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (iw / ih) * sar +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
n
+

The number of the input frame, starting from 0. +

+
+
pos
+

the position in the file of the input frame, NAN if unknown +

+
+
t
+

The timestamp expressed in seconds. It’s NAN if the input timestamp is unknown. +

+
+
+ +

The expression for out_w may depend on the value of out_h, +and the expression for out_h may depend on out_w, but they +cannot depend on x and y, as x and y are +evaluated after out_w and out_h. +

+

The x and y parameters specify the expressions for the +position of the top-left corner of the output (non-cropped) area. They +are evaluated for each frame. If the evaluated value is not valid, it +is approximated to the nearest valid value. +

+

The expression for x may depend on y, and the expression +for y may depend on x. +

+ +

30.35.1 Examples

+ +
    +
  • Crop area with size 100x100 at position (12,34). +
    +
    crop=100:100:12:34
+
    + +

    Using named options, the example above becomes: +

    +
    crop=w=100:h=100:x=12:y=34
+
    + +
  • Crop the central input area with size 100x100: +
    +
    crop=100:100
+
    + +
  • Crop the central input area with size 2/3 of the input video: +
    +
    crop=2/3*in_w:2/3*in_h
+
    + +
  • Crop the input video central square: +
    +
    crop=out_w=in_h
+crop=in_h
+
    + +
  • Delimit the rectangle with the top-left corner placed at position +100:100 and the right-bottom corner corresponding to the right-bottom +corner of the input image. +
    +
    crop=in_w-100:in_h-100:100:100
+
    + +
  • Crop 10 pixels from the left and right borders, and 20 pixels from +the top and bottom borders +
    +
    crop=in_w-2*10:in_h-2*20
+
    + +
  • Keep only the bottom right quarter of the input image: +
    +
    crop=in_w/2:in_h/2:in_w/2:in_h/2
+
    + +
  • Crop height for getting Greek harmony: +
    +
    crop=in_w:1/PHI*in_w
+
    + +
  • Apply trembling effect: +
    +
    crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(n/10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(n/7)
+
    + +
  • Apply erratic camera effect depending on timestamp: +
    +
    crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(t*10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(t*13)"
+
    + +
  • Set x depending on the value of y: +
    +
    crop=in_w/2:in_h/2:y:10+10*sin(n/10)
+
    +
+ + +

30.35.2 Commands

+ +

This filter supports the following commands: +

+
w, out_w
+
h, out_h
+
x
+
y
+

Set width/height of the output video and the horizontal/vertical position +in the input video. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

30.36 cropdetect

+ +

Auto-detect the crop size. +

+

It calculates the necessary cropping parameters and prints the +recommended parameters via the logging system. The detected dimensions +correspond to the non-black area of the input video. +

+

It accepts the following parameters: +

+
+
limit
+

Set higher black value threshold, which can be optionally specified +from nothing (0) to everything (255 for 8-bit based formats). An intensity +value greater to the set value is considered non-black. It defaults to 24. +You can also specify a value between 0.0 and 1.0 which will be scaled depending +on the bitdepth of the pixel format. +

+
+
round
+

The value which the width/height should be divisible by. It defaults to +16. The offset is automatically adjusted to center the video. Use 2 to +get only even dimensions (needed for 4:2:2 video). 16 is best when +encoding to most video codecs. +

+
+
reset_count, reset
+

Set the counter that determines after how many frames cropdetect will +reset the previously detected largest video area and start over to +detect the current optimal crop area. Default value is 0. +

+

This can be useful when channel logos distort the video area. 0 +indicates ’never reset’, and returns the largest area encountered during +playback. +

+
+ + +

30.37 cue

+ +

Delay video filtering until a given wallclock timestamp. The filter first +passes on preroll amount of frames, then it buffers at most +buffer amount of frames and waits for the cue. After reaching the cue +it forwards the buffered frames and also any subsequent frames coming in its +input. +

+

The filter can be used synchronize the output of multiple ffmpeg processes for +realtime output devices like decklink. By putting the delay in the filtering +chain and pre-buffering frames the process can pass on data to output almost +immediately after the target wallclock timestamp is reached. +

+

Perfect frame accuracy cannot be guaranteed, but the result is good enough for +some use cases. +

+
+
cue
+

The cue timestamp expressed in a UNIX timestamp in microseconds. Default is 0. +

+
+
preroll
+

The duration of content to pass on as preroll expressed in seconds. Default is 0. +

+
+
buffer
+

The maximum duration of content to buffer before waiting for the cue expressed +in seconds. Default is 0. +

+
+
+ + +

30.38 curves

+ +

Apply color adjustments using curves. +

+

This filter is similar to the Adobe Photoshop and GIMP curves tools. Each +component (red, green and blue) has its values defined by N key points +tied from each other using a smooth curve. The x-axis represents the pixel +values from the input frame, and the y-axis the new pixel values to be set for +the output frame. +

+

By default, a component curve is defined by the two points (0;0) and +(1;1). This creates a straight line where each original pixel value is +"adjusted" to its own value, which means no change to the image. +

+

The filter allows you to redefine these two points and add some more. A new +curve (using a natural cubic spline interpolation) will be define to pass +smoothly through all these new coordinates. The new defined points needs to be +strictly increasing over the x-axis, and their x and y values must +be in the [0;1] interval. If the computed curves happened to go outside +the vector spaces, the values will be clipped accordingly. +

+

The filter accepts the following options: +

+
+
preset
+

Select one of the available color presets. This option can be used in addition +to the r, g, b parameters; in this case, the later +options takes priority on the preset values. +Available presets are: +

+
‘none’
+
‘color_negative’
+
‘cross_process’
+
‘darker’
+
‘increase_contrast’
+
‘lighter’
+
‘linear_contrast’
+
‘medium_contrast’
+
‘negative’
+
‘strong_contrast’
+
‘vintage’
+
+

Default is none. +

+
master, m
+

Set the master key points. These points will define a second pass mapping. It +is sometimes called a "luminance" or "value" mapping. It can be used with +r, g, b or all since it acts like a +post-processing LUT. +

+
red, r
+

Set the key points for the red component. +

+
green, g
+

Set the key points for the green component. +

+
blue, b
+

Set the key points for the blue component. +

+
all
+

Set the key points for all components (not including master). +Can be used in addition to the other key points component +options. In this case, the unset component(s) will fallback on this +all setting. +

+
psfile
+

Specify a Photoshop curves file (.acv) to import the settings from. +

+
plot
+

Save Gnuplot script of the curves in specified file. +

+
+ +

To avoid some filtergraph syntax conflicts, each key points list need to be +defined using the following syntax: x0/y0 x1/y1 x2/y2 .... +

+ +

30.38.1 Examples

+ +
    +
  • Increase slightly the middle level of blue: +
    +
    curves=blue='0/0 0.5/0.58 1/1'
+
    + +
  • Vintage effect: +
    +
    curves=r='0/0.11 .42/.51 1/0.95':g='0/0 0.50/0.48 1/1':b='0/0.22 .49/.44 1/0.8'
+
    +

    Here we obtain the following coordinates for each components: +

    +
    red
    +

    (0;0.11) (0.42;0.51) (1;0.95) +

    +
    green
    +

    (0;0) (0.50;0.48) (1;1) +

    +
    blue
    +

    (0;0.22) (0.49;0.44) (1;0.80) +

    +
    + +
  • The previous example can also be achieved with the associated built-in preset: +
    +
    curves=preset=vintage
+
    + +
  • Or simply: +
    +
    curves=vintage
+
    + +
  • Use a Photoshop preset and redefine the points of the green component: +
    +
    curves=psfile='MyCurvesPresets/purple.acv':green='0/0 0.45/0.53 1/1'
+
    + +
  • Check out the curves of the cross_process profile using ffmpeg +and gnuplot: +
    +
    ffmpeg -f lavfi -i color -vf curves=cross_process:plot=/tmp/curves.plt -frames:v 1 -f null -
+gnuplot -p /tmp/curves.plt
+
    +
+ + +

30.39 datascope

+ +

Video data analysis filter. +

+

This filter shows hexadecimal pixel values of part of video. +

+

The filter accepts the following options: +

+
+
size, s
+

Set output video size. +

+
+
x
+

Set x offset from where to pick pixels. +

+
+
y
+

Set y offset from where to pick pixels. +

+
+
mode
+

Set scope mode, can be one of the following: +

+
‘mono’
+

Draw hexadecimal pixel values with white color on black background. +

+
+
‘color’
+

Draw hexadecimal pixel values with input video pixel color on black +background. +

+
+
‘color2’
+

Draw hexadecimal pixel values on color background picked from input video, +the text color is picked in such way so its always visible. +

+
+ +
+
axis
+

Draw rows and columns numbers on left and top of video. +

+
+
opacity
+

Set background opacity. +

+
+
format
+

Set display number format. Can be hex, or dec. Default is hex. +

+
+ + +

30.40 dblur

+

Apply Directional blur filter. +

+

The filter accepts the following options: +

+
+
angle
+

Set angle of directional blur. Default is 45. +

+
+
radius
+

Set radius of directional blur. Default is 5. +

+
+
planes
+

Set which planes to filter. By default all planes are filtered. +

+
+ + +

30.40.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.41 dctdnoiz

+ +

Denoise frames using 2D DCT (frequency domain filtering). +

+

This filter is not designed for real time. +

+

The filter accepts the following options: +

+
+
sigma, s
+

Set the noise sigma constant. +

+

This sigma defines a hard threshold of 3 * sigma; every DCT +coefficient (absolute value) below this threshold with be dropped. +

+

If you need a more advanced filtering, see expr. +

+

Default is 0. +

+
+
overlap
+

Set number overlapping pixels for each block. Since the filter can be slow, you +may want to reduce this value, at the cost of a less effective filter and the +risk of various artefacts. +

+

If the overlapping value doesn’t permit processing the whole input width or +height, a warning will be displayed and according borders won’t be denoised. +

+

Default value is blocksize-1, which is the best possible setting. +

+
+
expr, e
+

Set the coefficient factor expression. +

+

For each coefficient of a DCT block, this expression will be evaluated as a +multiplier value for the coefficient. +

+

If this is option is set, the sigma option will be ignored. +

+

The absolute value of the coefficient can be accessed through the c +variable. +

+
+
n
+

Set the blocksize using the number of bits. 1<<n defines the +blocksize, which is the width and height of the processed blocks. +

+

The default value is 3 (8x8) and can be raised to 4 for a +blocksize of 16x16. Note that changing this setting has huge consequences +on the speed processing. Also, a larger block size does not necessarily means a +better de-noising. +

+
+ + +

30.41.1 Examples

+ +

Apply a denoise with a sigma of 4.5: +

+
dctdnoiz=4.5
+
+ +

The same operation can be achieved using the expression system: +

+
dctdnoiz=e='gte(c, 4.5*3)'
+
+ +

Violent denoise using a block size of 16x16: +

+
dctdnoiz=15:n=4
+
+ + +

30.42 deband

+ +

Remove banding artifacts from input video. +It works by replacing banded pixels with average value of referenced pixels. +

+

The filter accepts the following options: +

+
+
1thr
+
2thr
+
3thr
+
4thr
+

Set banding detection threshold for each plane. Default is 0.02. +Valid range is 0.00003 to 0.5. +If difference between current pixel and reference pixel is less than threshold, +it will be considered as banded. +

+
+
range, r
+

Banding detection range in pixels. Default is 16. If positive, random number +in range 0 to set value will be used. If negative, exact absolute value +will be used. +The range defines square of four pixels around current pixel. +

+
+
direction, d
+

Set direction in radians from which four pixel will be compared. If positive, +random direction from 0 to set direction will be picked. If negative, exact of +absolute value will be picked. For example direction 0, -PI or -2*PI radians +will pick only pixels on same row and -PI/2 will pick only pixels on same +column. +

+
+
blur, b
+

If enabled, current pixel is compared with average value of all four +surrounding pixels. The default is enabled. If disabled current pixel is +compared with all four surrounding pixels. The pixel is considered banded +if only all four differences with surrounding pixels are less than threshold. +

+
+
coupling, c
+

If enabled, current pixel is changed if and only if all pixel components are banded, +e.g. banding detection threshold is triggered for all color components. +The default is disabled. +

+
+ + +

30.43 deblock

+ +

Remove blocking artifacts from input video. +

+

The filter accepts the following options: +

+
+
filter
+

Set filter type, can be weak or strong. Default is strong. +This controls what kind of deblocking is applied. +

+
+
block
+

Set size of block, allowed range is from 4 to 512. Default is 8. +

+
+
alpha
+
beta
+
gamma
+
delta
+

Set blocking detection thresholds. Allowed range is 0 to 1. +Defaults are: 0.098 for alpha and 0.05 for the rest. +Using higher threshold gives more deblocking strength. +Setting alpha controls threshold detection at exact edge of block. +Remaining options controls threshold detection near the edge. Each one for +below/above or left/right. Setting any of those to 0 disables +deblocking. +

+
+
planes
+

Set planes to filter. Default is to filter all available planes. +

+
+ + +

30.43.1 Examples

+ +
    +
  • Deblock using weak filter and block size of 4 pixels. +
    +
    deblock=filter=weak:block=4
+
    + +
  • Deblock using strong filter, block size of 4 pixels and custom thresholds for +deblocking more edges. +
    +
    deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05
+
    + +
  • Similar as above, but filter only first plane. +
    +
    deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05:planes=1
+
    + +
  • Similar as above, but filter only second and third plane. +
    +
    deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05:planes=6
+
    +
+ + +

30.44 decimate

+ +

Drop duplicated frames at regular intervals. +

+

The filter accepts the following options: +

+
+
cycle
+

Set the number of frames from which one will be dropped. Setting this to +N means one frame in every batch of N frames will be dropped. +Default is 5. +

+
+
dupthresh
+

Set the threshold for duplicate detection. If the difference metric for a frame +is less than or equal to this value, then it is declared as duplicate. Default +is 1.1 +

+
+
scthresh
+

Set scene change threshold. Default is 15. +

+
+
blockx
+
blocky
+

Set the size of the x and y-axis blocks used during metric calculations. +Larger blocks give better noise suppression, but also give worse detection of +small movements. Must be a power of two. Default is 32. +

+
+
ppsrc
+

Mark main input as a pre-processed input and activate clean source input +stream. This allows the input to be pre-processed with various filters to help +the metrics calculation while keeping the frame selection lossless. When set to +1, the first stream is for the pre-processed input, and the second +stream is the clean source from where the kept frames are chosen. Default is +0. +

+
+
chroma
+

Set whether or not chroma is considered in the metric calculations. Default is +1. +

+
+ + +

30.45 deconvolve

+ +

Apply 2D deconvolution of video stream in frequency domain using second stream +as impulse. +

+

The filter accepts the following options: +

+
+
planes
+

Set which planes to process. +

+
+
impulse
+

Set which impulse video frames will be processed, can be first +or all. Default is all. +

+
+
noise
+

Set noise when doing divisions. Default is 0.0000001. Useful when width +and height are not same and not power of 2 or if stream prior to convolving +had noise. +

+
+ +

The deconvolve filter also supports the framesync options. +

+ +

30.46 dedot

+ +

Reduce cross-luminance (dot-crawl) and cross-color (rainbows) from video. +

+

It accepts the following options: +

+
+
m
+

Set mode of operation. Can be combination of dotcrawl for cross-luminance reduction and/or +rainbows for cross-color reduction. +

+
+
lt
+

Set spatial luma threshold. Lower values increases reduction of cross-luminance. +

+
+
tl
+

Set tolerance for temporal luma. Higher values increases reduction of cross-luminance. +

+
+
tc
+

Set tolerance for chroma temporal variation. Higher values increases reduction of cross-color. +

+
+
ct
+

Set temporal chroma threshold. Lower values increases reduction of cross-color. +

+
+ + +

30.47 deflate

+ +

Apply deflate effect to the video. +

+

This filter replaces the pixel by the local(3x3) average by taking into account +only values lower than the pixel. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+ + +

30.47.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

30.48 deflicker

+ +

Remove temporal frame luminance variations. +

+

It accepts the following options: +

+
+
size, s
+

Set moving-average filter size in frames. Default is 5. Allowed range is 2 - 129. +

+
+
mode, m
+

Set averaging mode to smooth temporal luminance variations. +

+

Available values are: +

+
‘am’
+

Arithmetic mean +

+
+
‘gm’
+

Geometric mean +

+
+
‘hm’
+

Harmonic mean +

+
+
‘qm’
+

Quadratic mean +

+
+
‘cm’
+

Cubic mean +

+
+
‘pm’
+

Power mean +

+
+
‘median’
+

Median +

+
+ +
+
bypass
+

Do not actually modify frame. Useful when one only wants metadata. +

+
+ + +

30.49 dejudder

+ +

Remove judder produced by partially interlaced telecined content. +

+

Judder can be introduced, for instance, by pullup filter. If the original +source was partially telecined content then the output of pullup,dejudder +will have a variable frame rate. May change the recorded frame rate of the +container. Aside from that change, this filter will not affect constant frame +rate video. +

+

The option available in this filter is: +

+
cycle
+

Specify the length of the window over which the judder repeats. +

+

Accepts any integer greater than 1. Useful values are: +

+
‘4’
+

If the original was telecined from 24 to 30 fps (Film to NTSC). +

+
+
‘5’
+

If the original was telecined from 25 to 30 fps (PAL to NTSC). +

+
+
‘20’
+

If a mixture of the two. +

+
+ +

The default is ‘4’. +

+
+ + +

30.50 delogo

+ +

Suppress a TV station logo by a simple interpolation of the surrounding +pixels. Just set a rectangle covering the logo and watch it disappear +(and sometimes something even uglier appear - your mileage may vary). +

+

It accepts the following parameters: +

+
x
+
y
+

Specify the top left corner coordinates of the logo. They must be +specified. +

+
+
w
+
h
+

Specify the width and height of the logo to clear. They must be +specified. +

+
+
band, t
+

Specify the thickness of the fuzzy edge of the rectangle (added to +w and h). The default value is 1. This option is +deprecated, setting higher values should no longer be necessary and +is not recommended. +

+
+
show
+

When set to 1, a green rectangle is drawn on the screen to simplify +finding the right x, y, w, and h parameters. +The default value is 0. +

+

The rectangle is drawn on the outermost pixels which will be (partly) +replaced with interpolated values. The values of the next pixels +immediately outside this rectangle in each direction will be used to +compute the interpolated pixel values inside the rectangle. +

+
+
+ + +

30.50.1 Examples

+ +
    +
  • Set a rectangle covering the area with top left corner coordinates 0,0 +and size 100x77, and a band of size 10: +
    +
    delogo=x=0:y=0:w=100:h=77:band=10
+
    + +
+ + +

30.51 derain

+ +

Remove the rain in the input image/video by applying the derain methods based on +convolutional neural networks. Supported models: +

+ + +

Training as well as model generation scripts are provided in +the repository at https://github.com/XueweiMeng/derain_filter.git. +

+

Native model files (.model) can be generated from TensorFlow model +files (.pb) by using tools/python/convert.py +

+

The filter accepts the following options: +

+
+
filter_type
+

Specify which filter to use. This option accepts the following values: +

+
+
‘derain’
+

Derain filter. To conduct derain filter, you need to use a derain model. +

+
+
‘dehaze’
+

Dehaze filter. To conduct dehaze filter, you need to use a dehaze model. +

+
+

Default value is ‘derain’. +

+
+
dnn_backend
+

Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +

+
+
‘native’
+

Native implementation of DNN loading and execution. +

+
+
‘tensorflow’
+

TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +https://www.tensorflow.org/install/install_c) and configure FFmpeg with +--enable-libtensorflow +

+
+

Default value is ‘native’. +

+
+
model
+

Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow and native +backend can load files for only its format. +

+
+ +

It can also be finished with dnn_processing filter. +

+ +

30.52 deshake

+ +

Attempt to fix small changes in horizontal and/or vertical shift. This +filter helps remove camera shake from hand-holding a camera, bumping a +tripod, moving on a vehicle, etc. +

+

The filter accepts the following options: +

+
+
x
+
y
+
w
+
h
+

Specify a rectangular area where to limit the search for motion +vectors. +If desired the search for motion vectors can be limited to a +rectangular area of the frame defined by its top left corner, width +and height. These parameters have the same meaning as the drawbox +filter which can be used to visualise the position of the bounding +box. +

+

This is useful when simultaneous movement of subjects within the frame +might be confused for camera motion by the motion vector search. +

+

If any or all of x, y, w and h are set to -1 +then the full frame is used. This allows later options to be set +without specifying the bounding box for the motion vector search. +

+

Default - search the whole frame. +

+
+
rx
+
ry
+

Specify the maximum extent of movement in x and y directions in the +range 0-64 pixels. Default 16. +

+
+
edge
+

Specify how to generate pixels to fill blanks at the edge of the +frame. Available values are: +

+
‘blank, 0’
+

Fill zeroes at blank locations +

+
‘original, 1’
+

Original image at blank locations +

+
‘clamp, 2’
+

Extruded edge value at blank locations +

+
‘mirror, 3’
+

Mirrored edge at blank locations +

+
+

Default value is ‘mirror’. +

+
+
blocksize
+

Specify the blocksize to use for motion search. Range 4-128 pixels, +default 8. +

+
+
contrast
+

Specify the contrast threshold for blocks. Only blocks with more than +the specified contrast (difference between darkest and lightest +pixels) will be considered. Range 1-255, default 125. +

+
+
search
+

Specify the search strategy. Available values are: +

+
‘exhaustive, 0’
+

Set exhaustive search +

+
‘less, 1’
+

Set less exhaustive search. +

+
+

Default value is ‘exhaustive’. +

+
+
filename
+

If set then a detailed log of the motion search is written to the +specified file. +

+
+
+ + +

30.53 despill

+ +

Remove unwanted contamination of foreground colors, caused by reflected color of +greenscreen or bluescreen. +

+

This filter accepts the following options: +

+
+
type
+

Set what type of despill to use. +

+
+
mix
+

Set how spillmap will be generated. +

+
+
expand
+

Set how much to get rid of still remaining spill. +

+
+
red
+

Controls amount of red in spill area. +

+
+
green
+

Controls amount of green in spill area. +Should be -1 for greenscreen. +

+
+
blue
+

Controls amount of blue in spill area. +Should be -1 for bluescreen. +

+
+
brightness
+

Controls brightness of spill area, preserving colors. +

+
+
alpha
+

Modify alpha from generated spillmap. +

+
+ + +

30.54 detelecine

+ +

Apply an exact inverse of the telecine operation. It requires a predefined +pattern specified using the pattern option which must be the same as that passed +to the telecine filter. +

+

This filter accepts the following options: +

+
+
first_field
+
+
‘top, t’
+

top field first +

+
‘bottom, b’
+

bottom field first +The default value is top. +

+
+ +
+
pattern
+

A string of numbers representing the pulldown pattern you wish to apply. +The default value is 23. +

+
+
start_frame
+

A number representing position of the first frame with respect to the telecine +pattern. This is to be used if the stream is cut. The default value is 0. +

+
+ + +

30.55 dilation

+ +

Apply dilation effect to the video. +

+

This filter replaces the pixel by the local(3x3) maximum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. Default is 255 i.e. all eight +pixels are used. +

+

Flags to local 3x3 coordinates maps like this: +

+

1 2 3 + 4 5 + 6 7 8 +

+
+ + +

30.55.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

30.56 displace

+ +

Displace pixels as indicated by second and third input stream. +

+

It takes three input streams and outputs one stream, the first input is the +source, and second and third input are displacement maps. +

+

The second input specifies how much to displace pixels along the +x-axis, while the third input specifies how much to displace pixels +along the y-axis. +If one of displacement map streams terminates, last frame from that +displacement map will be used. +

+

Note that once generated, displacements maps can be reused over and over again. +

+

A description of the accepted options follows. +

+
+
edge
+

Set displace behavior for pixels that are out of range. +

+

Available values are: +

+
‘blank’
+

Missing pixels are replaced by black pixels. +

+
+
‘smear’
+

Adjacent pixels will spread out to replace missing pixels. +

+
+
‘wrap’
+

Out of range pixels are wrapped so they point to pixels of other side. +

+
+
‘mirror’
+

Out of range pixels will be replaced with mirrored pixels. +

+
+

Default is ‘smear’. +

+
+
+ + +

30.56.1 Examples

+ +
    +
  • Add ripple effect to rgb input of video size hd720: +
    +
    ffmpeg -i INPUT -f lavfi -i nullsrc=s=hd720,lutrgb=128:128:128 -f lavfi -i nullsrc=s=hd720,geq='r=128+30*sin(2*PI*X/400+T):g=128+30*sin(2*PI*X/400+T):b=128+30*sin(2*PI*X/400+T)' -lavfi '[0][1][2]displace' OUTPUT
+
    + +
  • Add wave effect to rgb input of video size hd720: +
    +
    ffmpeg -i INPUT -f lavfi -i nullsrc=hd720,geq='r=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T)):g=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T)):b=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T))' -lavfi '[1]split[x][y],[0][x][y]displace' OUTPUT
+
    +
+ + +

30.57 dnn_processing

+ +

Do image processing with deep neural networks. It works together with another filter +which converts the pixel format of the Frame to what the dnn network requires. +

+

The filter accepts the following options: +

+
+
dnn_backend
+

Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +

+
+
‘native’
+

Native implementation of DNN loading and execution. +

+
+
‘tensorflow’
+

TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +https://www.tensorflow.org/install/install_c) and configure FFmpeg with +--enable-libtensorflow +

+
+ +

Default value is ‘native’. +

+
+
model
+

Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow and native +backend can load files for only its format. +

+

Native model file (.model) can be generated from TensorFlow model file (.pb) by using tools/python/convert.py +

+
+
input
+

Set the input name of the dnn network. +

+
+
output
+

Set the output name of the dnn network. +

+
+
+ + +

30.57.1 Examples

+ +
    +
  • Remove rain in rgb24 frame with can.pb (see derain filter): +
    +
    ./ffmpeg -i rain.jpg -vf format=rgb24,dnn_processing=dnn_backend=tensorflow:model=can.pb:input=x:output=y derain.jpg
+
    + +
  • Halve the pixel value of the frame with format gray32f: +
    +
    ffmpeg -i input.jpg -vf format=grayf32,dnn_processing=model=halve_gray_float.model:input=dnn_in:output=dnn_out:dnn_backend=native -y out.native.png
+
    + +
  • Handle the Y channel with srcnn.pb (see sr filter) for frame with yuv420p (planar YUV formats supported): +
    +
    ./ffmpeg -i 480p.jpg -vf format=yuv420p,scale=w=iw*2:h=ih*2,dnn_processing=dnn_backend=tensorflow:model=srcnn.pb:input=x:output=y -y srcnn.jpg
+
    + +
  • Handle the Y channel with espcn.pb (see sr filter), which changes frame size, for format yuv420p (planar YUV formats supported): +
    +
    ./ffmpeg -i 480p.jpg -vf format=yuv420p,dnn_processing=dnn_backend=tensorflow:model=espcn.pb:input=x:output=y -y tmp.espcn.jpg
+
    + +
+ + +

30.58 drawbox

+ +

Draw a colored box on the input image. +

+

It accepts the following parameters: +

+
+
x
+
y
+

The expressions which specify the top left corner coordinates of the box. It defaults to 0. +

+
+
width, w
+
height, h
+

The expressions which specify the width and height of the box; if 0 they are interpreted as +the input width and height. It defaults to 0. +

+
+
color, c
+

Specify the color of the box to write. For the general syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. If the special +value invert is used, the box edge color is the same as the +video with inverted luma. +

+
+
thickness, t
+

The expression which sets the thickness of the box edge. +A value of fill will create a filled box. Default value is 3. +

+

See below for the list of accepted constants. +

+
+
replace
+

Applicable if the input has alpha. With value 1, the pixels of the painted box +will overwrite the video’s color and alpha pixels. +Default is 0, which composites the box onto the input, leaving the video’s alpha intact. +

+
+ +

The parameters for x, y, w and h and t are expressions containing the +following constants: +

+
+
dar
+

The input display aspect ratio, it is the same as (w / h) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
in_h, ih
+
in_w, iw
+

The input width and height. +

+
+
sar
+

The input sample aspect ratio. +

+
+
x
+
y
+

The x and y offset coordinates where the box is drawn. +

+
+
w
+
h
+

The width and height of the drawn box. +

+
+
t
+

The thickness of the drawn box. +

+

These constants allow the x, y, w, h and t expressions to refer to +each other, so you may for example specify y=x/dar or h=w/dar. +

+
+
+ + +

30.58.1 Examples

+ +
    +
  • Draw a black box around the edge of the input image: +
    +
    drawbox
+
    + +
  • Draw a box with color red and an opacity of 50%: +
    +
    drawbox=10:20:200:60:red@0.5
+
    + +

    The previous example can be specified as: +

    +
    drawbox=x=10:y=20:w=200:h=60:color=red@0.5
+
    + +
  • Fill the box with pink color: +
    +
    drawbox=x=10:y=10:w=100:h=100:color=pink@0.5:t=fill
+
    + +
  • Draw a 2-pixel red 2.40:1 mask: +
    +
    drawbox=x=-t:y=0.5*(ih-iw/2.4)-t:w=iw+t*2:h=iw/2.4+t*2:t=2:c=red
+
    +
+ + +

30.58.2 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.59 drawgraph

+

Draw a graph using input video metadata. +

+

It accepts the following parameters: +

+
+
m1
+

Set 1st frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg1
+

Set 1st foreground color expression. +

+
+
m2
+

Set 2nd frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg2
+

Set 2nd foreground color expression. +

+
+
m3
+

Set 3rd frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg3
+

Set 3rd foreground color expression. +

+
+
m4
+

Set 4th frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg4
+

Set 4th foreground color expression. +

+
+
min
+

Set minimal value of metadata value. +

+
+
max
+

Set maximal value of metadata value. +

+
+
bg
+

Set graph background color. Default is white. +

+
+
mode
+

Set graph mode. +

+

Available values for mode is: +

+
‘bar’
+
‘dot’
+
‘line’
+
+ +

Default is line. +

+
+
slide
+

Set slide mode. +

+

Available values for slide is: +

+
‘frame’
+

Draw new frame when right border is reached. +

+
+
‘replace’
+

Replace old columns with new ones. +

+
+
‘scroll’
+

Scroll from right to left. +

+
+
‘rscroll’
+

Scroll from left to right. +

+
+
‘picture’
+

Draw single picture. +

+
+ +

Default is frame. +

+
+
size
+

Set size of graph video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +The default value is 900x256. +

+
+
rate, r
+

Set the output frame rate. Default value is 25. +

+

The foreground color expressions can use the following variables: +

+
MIN
+

Minimal value of metadata value. +

+
+
MAX
+

Maximal value of metadata value. +

+
+
VAL
+

Current metadata key value. +

+
+ +

The color is defined as 0xAABBGGRR. +

+
+ +

Example using metadata from signalstats filter: +

+
signalstats,drawgraph=lavfi.signalstats.YAVG:min=0:max=255
+
+ +

Example using metadata from ebur128 filter: +

+
ebur128=metadata=1,adrawgraph=lavfi.r128.M:min=-120:max=5
+
+ + +

30.60 drawgrid

+ +

Draw a grid on the input image. +

+

It accepts the following parameters: +

+
+
x
+
y
+

The expressions which specify the coordinates of some point of grid intersection (meant to configure offset). Both default to 0. +

+
+
width, w
+
height, h
+

The expressions which specify the width and height of the grid cell, if 0 they are interpreted as the +input width and height, respectively, minus thickness, so image gets +framed. Default to 0. +

+
+
color, c
+

Specify the color of the grid. For the general syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. If the special +value invert is used, the grid color is the same as the +video with inverted luma. +

+
+
thickness, t
+

The expression which sets the thickness of the grid line. Default value is 1. +

+

See below for the list of accepted constants. +

+
+
replace
+

Applicable if the input has alpha. With 1 the pixels of the painted grid +will overwrite the video’s color and alpha pixels. +Default is 0, which composites the grid onto the input, leaving the video’s alpha intact. +

+
+ +

The parameters for x, y, w and h and t are expressions containing the +following constants: +

+
+
dar
+

The input display aspect ratio, it is the same as (w / h) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
in_h, ih
+
in_w, iw
+

The input grid cell width and height. +

+
+
sar
+

The input sample aspect ratio. +

+
+
x
+
y
+

The x and y coordinates of some point of grid intersection (meant to configure offset). +

+
+
w
+
h
+

The width and height of the drawn cell. +

+
+
t
+

The thickness of the drawn cell. +

+

These constants allow the x, y, w, h and t expressions to refer to +each other, so you may for example specify y=x/dar or h=w/dar. +

+
+
+ + +

30.60.1 Examples

+ +
    +
  • Draw a grid with cell 100x100 pixels, thickness 2 pixels, with color red and an opacity of 50%: +
    +
    drawgrid=width=100:height=100:thickness=2:color=red@0.5
+
    + +
  • Draw a white 3x3 grid with an opacity of 50%: +
    +
    drawgrid=w=iw/3:h=ih/3:t=2:c=white@0.5
+
    +
+ + +

30.60.2 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.61 drawtext

+ +

Draw a text string or text from a specified file on top of a video, using the +libfreetype library. +

+

To enable compilation of this filter, you need to configure FFmpeg with +--enable-libfreetype. +To enable default font fallback and the font option you need to +configure FFmpeg with --enable-libfontconfig. +To enable the text_shaping option, you need to configure FFmpeg with +--enable-libfribidi. +

+ +

30.61.1 Syntax

+ +

It accepts the following parameters: +

+
+
box
+

Used to draw a box around text using the background color. +The value must be either 1 (enable) or 0 (disable). +The default value of box is 0. +

+
+
boxborderw
+

Set the width of the border to be drawn around the box using boxcolor. +The default value of boxborderw is 0. +

+
+
boxcolor
+

The color to be used for drawing box around text. For the syntax of this +option, check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+

The default value of boxcolor is "white". +

+
+
line_spacing
+

Set the line spacing in pixels of the border to be drawn around the box using box. +The default value of line_spacing is 0. +

+
+
borderw
+

Set the width of the border to be drawn around the text using bordercolor. +The default value of borderw is 0. +

+
+
bordercolor
+

Set the color to be used for drawing border around text. For the syntax of this +option, check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+

The default value of bordercolor is "black". +

+
+
expansion
+

Select how the text is expanded. Can be either none, +strftime (deprecated) or +normal (default). See the Text expansion section +below for details. +

+
+
basetime
+

Set a start time for the count. Value is in microseconds. Only applied +in the deprecated strftime expansion mode. To emulate in normal expansion +mode use the pts function, supplying the start time (in seconds) +as the second argument. +

+
+
fix_bounds
+

If true, check and fix text coords to avoid clipping. +

+
+
fontcolor
+

The color to be used for drawing fonts. For the syntax of this option, check +the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+

The default value of fontcolor is "black". +

+
+
fontcolor_expr
+

String which is expanded the same way as text to obtain dynamic +fontcolor value. By default this option has empty value and is not +processed. When this option is set, it overrides fontcolor option. +

+
+
font
+

The font family to be used for drawing text. By default Sans. +

+
+
fontfile
+

The font file to be used for drawing text. The path must be included. +This parameter is mandatory if the fontconfig support is disabled. +

+
+
alpha
+

Draw the text applying alpha blending. The value can +be a number between 0.0 and 1.0. +The expression accepts the same variables x, y as well. +The default value is 1. +Please see fontcolor_expr. +

+
+
fontsize
+

The font size to be used for drawing text. +The default value of fontsize is 16. +

+
+
text_shaping
+

If set to 1, attempt to shape the text (for example, reverse the order of +right-to-left text and join Arabic characters) before drawing it. +Otherwise, just draw the text exactly as given. +By default 1 (if supported). +

+
+
ft_load_flags
+

The flags to be used for loading the fonts. +

+

The flags map the corresponding flags supported by libfreetype, and are +a combination of the following values: +

+
default
+
no_scale
+
no_hinting
+
render
+
no_bitmap
+
vertical_layout
+
force_autohint
+
crop_bitmap
+
pedantic
+
ignore_global_advance_width
+
no_recurse
+
ignore_transform
+
monochrome
+
linear_design
+
no_autohint
+
+ +

Default value is "default". +

+

For more information consult the documentation for the FT_LOAD_* +libfreetype flags. +

+
+
shadowcolor
+

The color to be used for drawing a shadow behind the drawn text. For the +syntax of this option, check the (ffmpeg-utils)"Color" section in the +ffmpeg-utils manual. +

+

The default value of shadowcolor is "black". +

+
+
shadowx
+
shadowy
+

The x and y offsets for the text shadow position with respect to the +position of the text. They can be either positive or negative +values. The default value for both is "0". +

+
+
start_number
+

The starting frame number for the n/frame_num variable. The default value +is "0". +

+
+
tabsize
+

The size in number of spaces to use for rendering the tab. +Default value is 4. +

+
+
timecode
+

Set the initial timecode representation in "hh:mm:ss[:;.]ff" +format. It can be used with or without text parameter. timecode_rate +option must be specified. +

+
+
timecode_rate, rate, r
+

Set the timecode frame rate (timecode only). Value will be rounded to nearest +integer. Minimum value is "1". +Drop-frame timecode is supported for frame rates 30 & 60. +

+
+
tc24hmax
+

If set to 1, the output of the timecode option will wrap around at 24 hours. +Default is 0 (disabled). +

+
+
text
+

The text string to be drawn. The text must be a sequence of UTF-8 +encoded characters. +This parameter is mandatory if no file is specified with the parameter +textfile. +

+
+
textfile
+

A text file containing text to be drawn. The text must be a sequence +of UTF-8 encoded characters. +

+

This parameter is mandatory if no text string is specified with the +parameter text. +

+

If both text and textfile are specified, an error is thrown. +

+
+
reload
+

If set to 1, the textfile will be reloaded before each frame. +Be sure to update it atomically, or it may be read partially, or even fail. +

+
+
x
+
y
+

The expressions which specify the offsets where text will be drawn +within the video frame. They are relative to the top/left border of the +output image. +

+

The default value of x and y is "0". +

+

See below for the list of accepted constants and functions. +

+
+ +

The parameters for x and y are expressions containing the +following constants and functions: +

+
+
dar
+

input display aspect ratio, it is the same as (w / h) * sar +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
line_h, lh
+

the height of each text line +

+
+
main_h, h, H
+

the input height +

+
+
main_w, w, W
+

the input width +

+
+
max_glyph_a, ascent
+

the maximum distance from the baseline to the highest/upper grid +coordinate used to place a glyph outline point, for all the rendered +glyphs. +It is a positive value, due to the grid’s orientation with the Y axis +upwards. +

+
+
max_glyph_d, descent
+

the maximum distance from the baseline to the lowest grid coordinate +used to place a glyph outline point, for all the rendered glyphs. +This is a negative value, due to the grid’s orientation, with the Y axis +upwards. +

+
+
max_glyph_h
+

maximum glyph height, that is the maximum height for all the glyphs +contained in the rendered text, it is equivalent to ascent - +descent. +

+
+
max_glyph_w
+

maximum glyph width, that is the maximum width for all the glyphs +contained in the rendered text +

+
+
n
+

the number of input frame, starting from 0 +

+
+
rand(min, max)
+

return a random number included between min and max +

+
+
sar
+

The input sample aspect ratio. +

+
+
t
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+
text_h, th
+

the height of the rendered text +

+
+
text_w, tw
+

the width of the rendered text +

+
+
x
+
y
+

the x and y offset coordinates where the text is drawn. +

+

These parameters allow the x and y expressions to refer +to each other, so you can for example specify y=x/dar. +

+
+
pict_type
+

A one character description of the current frame’s picture type. +

+
+
pkt_pos
+

The current packet’s position in the input file or stream +(in bytes, from the start of the input). A value of -1 indicates +this info is not available. +

+
+
pkt_duration
+

The current packet’s duration, in seconds. +

+
+
pkt_size
+

The current packet’s size (in bytes). +

+
+ + +

30.61.2 Text expansion

+ +

If expansion is set to strftime, +the filter recognizes strftime() sequences in the provided text and +expands them accordingly. Check the documentation of strftime(). This +feature is deprecated. +

+

If expansion is set to none, the text is printed verbatim. +

+

If expansion is set to normal (which is the default), +the following expansion mechanism is used. +

+

The backslash character ‘\’, followed by any character, always expands to +the second character. +

+

Sequences of the form %{...} are expanded. The text between the +braces is a function name, possibly followed by arguments separated by ’:’. +If the arguments contain special characters or delimiters (’:’ or ’}’), +they should be escaped. +

+

Note that they probably must also be escaped as the value for the +text option in the filter argument string and as the filter +argument in the filtergraph description, and possibly also for the shell, +that makes up to four levels of escaping; using a text file avoids these +problems. +

+

The following functions are available: +

+
+
expr, e
+

The expression evaluation result. +

+

It must take one argument specifying the expression to be evaluated, +which accepts the same constants and functions as the x and +y values. Note that not all constants should be used, for +example the text size is not known when evaluating the expression, so +the constants text_w and text_h will have an undefined +value. +

+
+
expr_int_format, eif
+

Evaluate the expression’s value and output as formatted integer. +

+

The first argument is the expression to be evaluated, just as for the expr function. +The second argument specifies the output format. Allowed values are ‘x’, +‘X’, ‘d’ and ‘u’. They are treated exactly as in the +printf function. +The third parameter is optional and sets the number of positions taken by the output. +It can be used to add padding with zeros from the left. +

+
+
gmtime
+

The time at which the filter is running, expressed in UTC. +It can accept an argument: a strftime() format string. +

+
+
localtime
+

The time at which the filter is running, expressed in the local time zone. +It can accept an argument: a strftime() format string. +

+
+
metadata
+

Frame metadata. Takes one or two arguments. +

+

The first argument is mandatory and specifies the metadata key. +

+

The second argument is optional and specifies a default value, used when the +metadata key is not found or empty. +

+

Available metadata can be identified by inspecting entries +starting with TAG included within each frame section +printed by running ffprobe -show_frames. +

+

String metadata generated in filters leading to +the drawtext filter are also available. +

+
+
n, frame_num
+

The frame number, starting from 0. +

+
+
pict_type
+

A one character description of the current picture type. +

+
+
pts
+

The timestamp of the current frame. +It can take up to three arguments. +

+

The first argument is the format of the timestamp; it defaults to flt +for seconds as a decimal number with microsecond accuracy; hms stands +for a formatted [-]HH:MM:SS.mmm timestamp with millisecond accuracy. +gmtime stands for the timestamp of the frame formatted as UTC time; +localtime stands for the timestamp of the frame formatted as +local time zone time. +

+

The second argument is an offset added to the timestamp. +

+

If the format is set to hms, a third argument 24HH may be +supplied to present the hour part of the formatted timestamp in 24h format +(00-23). +

+

If the format is set to localtime or gmtime, +a third argument may be supplied: a strftime() format string. +By default, YYYY-MM-DD HH:MM:SS format will be used. +

+
+ + +

30.61.3 Commands

+ +

This filter supports altering parameters via commands: +

+
reinit
+

Alter existing filter parameters. +

+

Syntax for the argument is the same as for filter invocation, e.g. +

+
+
fontsize=56:fontcolor=green:text='Hello World'
+
+ +

Full filter invocation with sendcmd would look like this: +

+
+
sendcmd=c='56.0 drawtext reinit fontsize=56\:fontcolor=green\:text=Hello\\ World'
+
+
+
+ +

If the entire argument can’t be parsed or applied as valid values then the filter will +continue with its existing parameters. +

+ +

30.61.4 Examples

+ +
    +
  • Draw "Test Text" with font FreeSerif, using the default values for the +optional parameters. + +
    +
    drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
+
    + +
  • Draw ’Test Text’ with font FreeSerif of size 24 at position x=100 +and y=50 (counting from the top-left corner of the screen), text is +yellow with a red box around it. Both the text and the box have an +opacity of 20%. + +
    +
    drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
+          x=100: y=50: fontsize=24: fontcolor=yellow@0.2: box=1: boxcolor=red@0.2"
+
    + +

    Note that the double quotes are not necessary if spaces are not used +within the parameter list. +

    +
  • Show the text at the center of the video frame: +
    +
    drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h)/2"
+
    + +
  • Show the text at a random position, switching to a new position every 30 seconds: +
    +
    drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=if(eq(mod(t\,30)\,0)\,rand(0\,(w-text_w))\,x):y=if(eq(mod(t\,30)\,0)\,rand(0\,(h-text_h))\,y)"
+
    + +
  • Show a text line sliding from right to left in the last row of the video +frame. The file LONG_LINE is assumed to contain a single line +with no newlines. +
    +
    drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
+
    + +
  • Show the content of file CREDITS off the bottom of the frame and scroll up. +
    +
    drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
+
    + +
  • Draw a single green letter "g", at the center of the input video. +The glyph baseline is placed at half screen height. +
    +
    drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
+
    + +
  • Show text for 1 second every 3 seconds: +
    +
    drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:enable=lt(mod(t\,3)\,1):text='blink'"
+
    + +
  • Use fontconfig to set the font. Note that the colons need to be escaped. +
    +
    drawtext='fontfile=Linux Libertine O-40\:style=Semibold:text=FFmpeg'
+
    + +
  • Print the date of a real-time encoding (see strftime(3)): +
    +
    drawtext='fontfile=FreeSans.ttf:text=%{localtime\:%a %b %d %Y}'
+
    + +
  • Show text fading in and out (appearing/disappearing): +
    +
    #!/bin/sh
+DS=1.0 # display start
+DE=10.0 # display end
+FID=1.5 # fade in duration
+FOD=5 # fade out duration
+ffplay -f lavfi "color,drawtext=text=TEST:fontsize=50:fontfile=FreeSerif.ttf:fontcolor_expr=ff0000%{eif\\\\: clip(255*(1*between(t\\, $DS + $FID\\, $DE - $FOD) + ((t - $DS)/$FID)*between(t\\, $DS\\, $DS + $FID) + (-(t - $DE)/$FOD)*between(t\\, $DE - $FOD\\, $DE) )\\, 0\\, 255) \\\\: x\\\\: 2 }"
+
    + +
  • Horizontally align multiple separate texts. Note that max_glyph_a +and the fontsize value are included in the y offset. +
    +
    drawtext=fontfile=FreeSans.ttf:text=DOG:fontsize=24:x=10:y=20+24-max_glyph_a,
+drawtext=fontfile=FreeSans.ttf:text=cow:fontsize=24:x=80:y=20+24-max_glyph_a
+
    + +
  • Plot special lavf.image2dec.source_basename metadata onto each frame if +such metadata exists. Otherwise, plot the string "NA". Note that image2 demuxer +must have option -export_path_metadata 1 for the special metadata fields +to be available for filters. +
    +
    drawtext="fontsize=20:fontcolor=white:fontfile=FreeSans.ttf:text='%{metadata\:lavf.image2dec.source_basename\:NA}':x=10:y=10"
+
    + +
+ +

For more information about libfreetype, check: +http://www.freetype.org/. +

+

For more information about fontconfig, check: +http://freedesktop.org/software/fontconfig/fontconfig-user.html. +

+

For more information about libfribidi, check: +http://fribidi.org/. +

+ +

30.62 edgedetect

+ +

Detect and draw edges. The filter uses the Canny Edge Detection algorithm. +

+

The filter accepts the following options: +

+
+
low
+
high
+

Set low and high threshold values used by the Canny thresholding +algorithm. +

+

The high threshold selects the "strong" edge pixels, which are then +connected through 8-connectivity with the "weak" edge pixels selected +by the low threshold. +

+

low and high threshold values must be chosen in the range +[0,1], and low should be lesser or equal to high. +

+

Default value for low is 20/255, and default value for high +is 50/255. +

+
+
mode
+

Define the drawing mode. +

+
+
‘wires’
+

Draw white/gray wires on black background. +

+
+
‘colormix’
+

Mix the colors to create a paint/cartoon effect. +

+
+
‘canny’
+

Apply Canny edge detector on all selected planes. +

+
+

Default value is wires. +

+
+
planes
+

Select planes for filtering. By default all available planes are filtered. +

+
+ + +

30.62.1 Examples

+ +
    +
  • Standard edge detection with custom values for the hysteresis thresholding: +
    +
    edgedetect=low=0.1:high=0.4
+
    + +
  • Painting effect without thresholding: +
    +
    edgedetect=mode=colormix:high=0
+
    +
+ + +

30.63 elbg

+ +

Apply a posterize effect using the ELBG (Enhanced LBG) algorithm. +

+

For each input image, the filter will compute the optimal mapping from +the input to the output given the codebook length, that is the number +of distinct output colors. +

+

This filter accepts the following options. +

+
+
codebook_length, l
+

Set codebook length. The value must be a positive integer, and +represents the number of distinct output colors. Default value is 256. +

+
+
nb_steps, n
+

Set the maximum number of iterations to apply for computing the optimal +mapping. The higher the value the better the result and the higher the +computation time. Default value is 1. +

+
+
seed, s
+

Set a random seed, must be an integer included between 0 and +UINT32_MAX. If not specified, or if explicitly set to -1, the filter +will try to use a good random seed on a best effort basis. +

+
+
pal8
+

Set pal8 output pixel format. This option does not work with codebook +length greater than 256. +

+
+ + +

30.64 entropy

+ +

Measure graylevel entropy in histogram of color channels of video frames. +

+

It accepts the following parameters: +

+
+
mode
+

Can be either normal or diff. Default is normal. +

+

diff mode measures entropy of histogram delta values, absolute differences +between neighbour histogram values. +

+
+ + +

30.65 eq

+

Set brightness, contrast, saturation and approximate gamma adjustment. +

+

The filter accepts the following options: +

+
+
contrast
+

Set the contrast expression. The value must be a float value in range +-1000.0 to 1000.0. The default value is "1". +

+
+
brightness
+

Set the brightness expression. The value must be a float value in +range -1.0 to 1.0. The default value is "0". +

+
+
saturation
+

Set the saturation expression. The value must be a float in +range 0.0 to 3.0. The default value is "1". +

+
+
gamma
+

Set the gamma expression. The value must be a float in range +0.1 to 10.0. The default value is "1". +

+
+
gamma_r
+

Set the gamma expression for red. The value must be a float in +range 0.1 to 10.0. The default value is "1". +

+
+
gamma_g
+

Set the gamma expression for green. The value must be a float in range +0.1 to 10.0. The default value is "1". +

+
+
gamma_b
+

Set the gamma expression for blue. The value must be a float in range +0.1 to 10.0. The default value is "1". +

+
+
gamma_weight
+

Set the gamma weight expression. It can be used to reduce the effect +of a high gamma value on bright image areas, e.g. keep them from +getting overamplified and just plain white. The value must be a float +in range 0.0 to 1.0. A value of 0.0 turns the +gamma correction all the way down while 1.0 leaves it at its +full strength. Default is "1". +

+
+
eval
+

Set when the expressions for brightness, contrast, saturation and +gamma expressions are evaluated. +

+

It accepts the following values: +

+
‘init’
+

only evaluate expressions once during the filter initialization or +when a command is processed +

+
+
‘frame’
+

evaluate expressions for each incoming frame +

+
+ +

Default value is ‘init’. +

+
+ +

The expressions accept the following parameters: +

+
n
+

frame count of the input frame starting from 0 +

+
+
pos
+

byte position of the corresponding packet in the input file, NAN if +unspecified +

+
+
r
+

frame rate of the input video, NAN if the input frame rate is unknown +

+
+
t
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+ + +

30.65.1 Commands

+

The filter supports the following commands: +

+
+
contrast
+

Set the contrast expression. +

+
+
brightness
+

Set the brightness expression. +

+
+
saturation
+

Set the saturation expression. +

+
+
gamma
+

Set the gamma expression. +

+
+
gamma_r
+

Set the gamma_r expression. +

+
+
gamma_g
+

Set gamma_g expression. +

+
+
gamma_b
+

Set gamma_b expression. +

+
+
gamma_weight
+

Set gamma_weight expression. +

+

The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+
+ + +

30.66 erosion

+ +

Apply erosion effect to the video. +

+

This filter replaces the pixel by the local(3x3) minimum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. Default is 255 i.e. all eight +pixels are used. +

+

Flags to local 3x3 coordinates maps like this: +

+

1 2 3 + 4 5 + 6 7 8 +

+
+ + +

30.66.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

30.67 extractplanes

+ +

Extract color channel components from input video stream into +separate grayscale video streams. +

+

The filter accepts the following option: +

+
+
planes
+

Set plane(s) to extract. +

+

Available values for planes are: +

+
‘y’
+
‘u’
+
‘v’
+
‘a’
+
‘r’
+
‘g’
+
‘b’
+
+ +

Choosing planes not available in the input will result in an error. +That means you cannot select r, g, b planes +with y, u, v planes at same time. +

+
+ + +

30.67.1 Examples

+ +
    +
  • Extract luma, u and v color channel component from input video frame +into 3 grayscale outputs: +
    +
    ffmpeg -i video.avi -filter_complex 'extractplanes=y+u+v[y][u][v]' -map '[y]' y.avi -map '[u]' u.avi -map '[v]' v.avi
+
    +
+ + +

30.68 fade

+ +

Apply a fade-in/out effect to the input video. +

+

It accepts the following parameters: +

+
+
type, t
+

The effect type can be either "in" for a fade-in, or "out" for a fade-out +effect. +Default is in. +

+
+
start_frame, s
+

Specify the number of the frame to start applying the fade +effect at. Default is 0. +

+
+
nb_frames, n
+

The number of frames that the fade effect lasts. At the end of the +fade-in effect, the output video will have the same intensity as the input video. +At the end of the fade-out transition, the output video will be filled with the +selected color. +Default is 25. +

+
+
alpha
+

If set to 1, fade only alpha channel, if one exists on the input. +Default value is 0. +

+
+
start_time, st
+

Specify the timestamp (in seconds) of the frame to start to apply the fade +effect. If both start_frame and start_time are specified, the fade will start at +whichever comes last. Default is 0. +

+
+
duration, d
+

The number of seconds for which the fade effect has to last. At the end of the +fade-in effect the output video will have the same intensity as the input video, +at the end of the fade-out transition the output video will be filled with the +selected color. +If both duration and nb_frames are specified, duration is used. Default is 0 +(nb_frames is used by default). +

+
+
color, c
+

Specify the color of the fade. Default is "black". +

+
+ + +

30.68.1 Examples

+ +
    +
  • Fade in the first 30 frames of video: +
    +
    fade=in:0:30
+
    + +

    The command above is equivalent to: +

    +
    fade=t=in:s=0:n=30
+
    + +
  • Fade out the last 45 frames of a 200-frame video: +
    +
    fade=out:155:45
+fade=type=out:start_frame=155:nb_frames=45
+
    + +
  • Fade in the first 25 frames and fade out the last 25 frames of a 1000-frame video: +
    +
    fade=in:0:25, fade=out:975:25
+
    + +
  • Make the first 5 frames yellow, then fade in from frame 5-24: +
    +
    fade=in:5:20:color=yellow
+
    + +
  • Fade in alpha over first 25 frames of video: +
    +
    fade=in:0:25:alpha=1
+
    + +
  • Make the first 5.5 seconds black, then fade in for 0.5 seconds: +
    +
    fade=t=in:st=5.5:d=0.5
+
    + +
+ + +

30.69 fftdnoiz

+

Denoise frames using 3D FFT (frequency domain filtering). +

+

The filter accepts the following options: +

+
+
sigma
+

Set the noise sigma constant. This sets denoising strength. +Default value is 1. Allowed range is from 0 to 30. +Using very high sigma with low overlap may give blocking artifacts. +

+
+
amount
+

Set amount of denoising. By default all detected noise is reduced. +Default value is 1. Allowed range is from 0 to 1. +

+
+
block
+

Set size of block, Default is 4, can be 3, 4, 5 or 6. +Actual size of block in pixels is 2 to power of block, so by default +block size in pixels is 2^4 which is 16. +

+
+
overlap
+

Set block overlap. Default is 0.5. Allowed range is from 0.2 to 0.8. +

+
+
prev
+

Set number of previous frames to use for denoising. By default is set to 0. +

+
+
next
+

Set number of next frames to to use for denoising. By default is set to 0. +

+
+
planes
+

Set planes which will be filtered, by default are all available filtered +except alpha. +

+
+ + +

30.70 fftfilt

+

Apply arbitrary expressions to samples in frequency domain +

+
+
dc_Y
+

Adjust the dc value (gain) of the luma plane of the image. The filter +accepts an integer value in range 0 to 1000. The default +value is set to 0. +

+
+
dc_U
+

Adjust the dc value (gain) of the 1st chroma plane of the image. The +filter accepts an integer value in range 0 to 1000. The +default value is set to 0. +

+
+
dc_V
+

Adjust the dc value (gain) of the 2nd chroma plane of the image. The +filter accepts an integer value in range 0 to 1000. The +default value is set to 0. +

+
+
weight_Y
+

Set the frequency domain weight expression for the luma plane. +

+
+
weight_U
+

Set the frequency domain weight expression for the 1st chroma plane. +

+
+
weight_V
+

Set the frequency domain weight expression for the 2nd chroma plane. +

+
+
eval
+

Set when the expressions are evaluated. +

+

It accepts the following values: +

+
‘init’
+

Only evaluate expressions once during the filter initialization. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. +

+
+ +

Default value is ‘init’. +

+

The filter accepts the following variables: +

+
X
+
Y
+

The coordinates of the current sample. +

+
+
W
+
H
+

The width and height of the image. +

+
+
N
+

The number of input frame, starting from 0. +

+
+ + +

30.70.1 Examples

+ +
    +
  • High-pass: +
    +
    fftfilt=dc_Y=128:weight_Y='squish(1-(Y+X)/100)'
+
    + +
  • Low-pass: +
    +
    fftfilt=dc_Y=0:weight_Y='squish((Y+X)/100-1)'
+
    + +
  • Sharpen: +
    +
    fftfilt=dc_Y=0:weight_Y='1+squish(1-(Y+X)/100)'
+
    + +
  • Blur: +
    +
    fftfilt=dc_Y=0:weight_Y='exp(-4 * ((Y+X)/(W+H)))'
+
    + +
+ + +

30.71 field

+ +

Extract a single field from an interlaced image using stride +arithmetic to avoid wasting CPU time. The output frames are marked as +non-interlaced. +

+

The filter accepts the following options: +

+
+
type
+

Specify whether to extract the top (if the value is 0 or +top) or the bottom field (if the value is 1 or +bottom). +

+
+ + +

30.72 fieldhint

+ +

Create new frames by copying the top and bottom fields from surrounding frames +supplied as numbers by the hint file. +

+
+
hint
+

Set file containing hints: absolute/relative frame numbers. +

+

There must be one line for each frame in a clip. Each line must contain two +numbers separated by the comma, optionally followed by - or +. +Numbers supplied on each line of file can not be out of [N-1,N+1] where N +is current frame number for absolute mode or out of [-1, 1] range +for relative mode. First number tells from which frame to pick up top +field and second number tells from which frame to pick up bottom field. +

+

If optionally followed by + output frame will be marked as interlaced, +else if followed by - output frame will be marked as progressive, else +it will be marked same as input frame. +If optionally followed by t output frame will use only top field, or in +case of b it will use only bottom field. +If line starts with # or ; that line is skipped. +

+
+
mode
+

Can be item absolute or relative. Default is absolute. +

+
+ +

Example of first several lines of hint file for relative mode: +

+
0,0 - # first frame
+1,0 - # second frame, use third's frame top field and second's frame bottom field
+1,0 - # third frame, use fourth's frame top field and third's frame bottom field
+1,0 -
+0,0 -
+0,0 -
+1,0 -
+1,0 -
+1,0 -
+0,0 -
+0,0 -
+1,0 -
+1,0 -
+1,0 -
+0,0 -
+
+ + +

30.73 fieldmatch

+ +

Field matching filter for inverse telecine. It is meant to reconstruct the +progressive frames from a telecined stream. The filter does not drop duplicated +frames, so to achieve a complete inverse telecine fieldmatch needs to be +followed by a decimation filter such as decimate in the filtergraph. +

+

The separation of the field matching and the decimation is notably motivated by +the possibility of inserting a de-interlacing filter fallback between the two. +If the source has mixed telecined and real interlaced content, +fieldmatch will not be able to match fields for the interlaced parts. +But these remaining combed frames will be marked as interlaced, and thus can be +de-interlaced by a later filter such as yadif before decimation. +

+

In addition to the various configuration options, fieldmatch can take an +optional second stream, activated through the ppsrc option. If +enabled, the frames reconstruction will be based on the fields and frames from +this second stream. This allows the first input to be pre-processed in order to +help the various algorithms of the filter, while keeping the output lossless +(assuming the fields are matched properly). Typically, a field-aware denoiser, +or brightness/contrast adjustments can help. +

+

Note that this filter uses the same algorithms as TIVTC/TFM (AviSynth project) +and VIVTC/VFM (VapourSynth project). The later is a light clone of TFM from +which fieldmatch is based on. While the semantic and usage are very +close, some behaviour and options names can differ. +

+

The decimate filter currently only works for constant frame rate input. +If your input has mixed telecined (30fps) and progressive content with a lower +framerate like 24fps use the following filterchain to produce the necessary cfr +stream: dejudder,fps=30000/1001,fieldmatch,decimate. +

+

The filter accepts the following options: +

+
+
order
+

Specify the assumed field order of the input stream. Available values are: +

+
+
‘auto’
+

Auto detect parity (use FFmpeg’s internal parity value). +

+
‘bff’
+

Assume bottom field first. +

+
‘tff’
+

Assume top field first. +

+
+ +

Note that it is sometimes recommended not to trust the parity announced by the +stream. +

+

Default value is auto. +

+
+
mode
+

Set the matching mode or strategy to use. pc mode is the safest in the +sense that it won’t risk creating jerkiness due to duplicate frames when +possible, but if there are bad edits or blended fields it will end up +outputting combed frames when a good match might actually exist. On the other +hand, pcn_ub mode is the most risky in terms of creating jerkiness, +but will almost always find a good frame if there is one. The other values are +all somewhere in between pc and pcn_ub in terms of risking +jerkiness and creating duplicate frames versus finding good matches in sections +with bad edits, orphaned fields, blended fields, etc. +

+

More details about p/c/n/u/b are available in p/c/n/u/b meaning section. +

+

Available values are: +

+
+
‘pc’
+

2-way matching (p/c) +

+
‘pc_n’
+

2-way matching, and trying 3rd match if still combed (p/c + n) +

+
‘pc_u’
+

2-way matching, and trying 3rd match (same order) if still combed (p/c + u) +

+
‘pc_n_ub’
+

2-way matching, trying 3rd match if still combed, and trying 4th/5th matches if +still combed (p/c + n + u/b) +

+
‘pcn’
+

3-way matching (p/c/n) +

+
‘pcn_ub’
+

3-way matching, and trying 4th/5th matches if all 3 of the original matches are +detected as combed (p/c/n + u/b) +

+
+ +

The parenthesis at the end indicate the matches that would be used for that +mode assuming order=tff (and field on auto or +top). +

+

In terms of speed pc mode is by far the fastest and pcn_ub is +the slowest. +

+

Default value is pc_n. +

+
+
ppsrc
+

Mark the main input stream as a pre-processed input, and enable the secondary +input stream as the clean source to pick the fields from. See the filter +introduction for more details. It is similar to the clip2 feature from +VFM/TFM. +

+

Default value is 0 (disabled). +

+
+
field
+

Set the field to match from. It is recommended to set this to the same value as +order unless you experience matching failures with that setting. In +certain circumstances changing the field that is used to match from can have a +large impact on matching performance. Available values are: +

+
+
‘auto’
+

Automatic (same value as order). +

+
‘bottom’
+

Match from the bottom field. +

+
‘top’
+

Match from the top field. +

+
+ +

Default value is auto. +

+
+
mchroma
+

Set whether or not chroma is included during the match comparisons. In most +cases it is recommended to leave this enabled. You should set this to 0 +only if your clip has bad chroma problems such as heavy rainbowing or other +artifacts. Setting this to 0 could also be used to speed things up at +the cost of some accuracy. +

+

Default value is 1. +

+
+
y0
+
y1
+

These define an exclusion band which excludes the lines between y0 and +y1 from being included in the field matching decision. An exclusion +band can be used to ignore subtitles, a logo, or other things that may +interfere with the matching. y0 sets the starting scan line and +y1 sets the ending line; all lines in between y0 and +y1 (including y0 and y1) will be ignored. Setting +y0 and y1 to the same value will disable the feature. +y0 and y1 defaults to 0. +

+
+
scthresh
+

Set the scene change detection threshold as a percentage of maximum change on +the luma plane. Good values are in the [8.0, 14.0] range. Scene change +detection is only relevant in case combmatch=sc. The range for +scthresh is [0.0, 100.0]. +

+

Default value is 12.0. +

+
+
combmatch
+

When combatch is not none, fieldmatch will take into +account the combed scores of matches when deciding what match to use as the +final match. Available values are: +

+
+
‘none’
+

No final matching based on combed scores. +

+
‘sc’
+

Combed scores are only used when a scene change is detected. +

+
‘full’
+

Use combed scores all the time. +

+
+ +

Default is sc. +

+
+
combdbg
+

Force fieldmatch to calculate the combed metrics for certain matches and +print them. This setting is known as micout in TFM/VFM vocabulary. +Available values are: +

+
+
‘none’
+

No forced calculation. +

+
‘pcn’
+

Force p/c/n calculations. +

+
‘pcnub’
+

Force p/c/n/u/b calculations. +

+
+ +

Default value is none. +

+
+
cthresh
+

This is the area combing threshold used for combed frame detection. This +essentially controls how "strong" or "visible" combing must be to be detected. +Larger values mean combing must be more visible and smaller values mean combing +can be less visible or strong and still be detected. Valid settings are from +-1 (every pixel will be detected as combed) to 255 (no pixel will +be detected as combed). This is basically a pixel difference value. A good +range is [8, 12]. +

+

Default value is 9. +

+
+
chroma
+

Sets whether or not chroma is considered in the combed frame decision. Only +disable this if your source has chroma problems (rainbowing, etc.) that are +causing problems for the combed frame detection with chroma enabled. Actually, +using chroma=0 is usually more reliable, except for the case +where there is chroma only combing in the source. +

+

Default value is 0. +

+
+
blockx
+
blocky
+

Respectively set the x-axis and y-axis size of the window used during combed +frame detection. This has to do with the size of the area in which +combpel pixels are required to be detected as combed for a frame to be +declared combed. See the combpel parameter description for more info. +Possible values are any number that is a power of 2 starting at 4 and going up +to 512. +

+

Default value is 16. +

+
+
combpel
+

The number of combed pixels inside any of the blocky by +blockx size blocks on the frame for the frame to be detected as +combed. While cthresh controls how "visible" the combing must be, this +setting controls "how much" combing there must be in any localized area (a +window defined by the blockx and blocky settings) on the +frame. Minimum value is 0 and maximum is blocky x blockx (at +which point no frames will ever be detected as combed). This setting is known +as MI in TFM/VFM vocabulary. +

+

Default value is 80. +

+
+ + +

30.73.1 p/c/n/u/b meaning

+ + +

30.73.1.1 p/c/n

+ +

We assume the following telecined stream: +

+
+
Top fields:     1 2 2 3 4
+Bottom fields:  1 2 3 4 4
+
+ +

The numbers correspond to the progressive frame the fields relate to. Here, the +first two frames are progressive, the 3rd and 4th are combed, and so on. +

+

When fieldmatch is configured to run a matching from bottom +(field=bottom) this is how this input stream get transformed: +

+
+
Input stream:
+                T     1 2 2 3 4
+                B     1 2 3 4 4   <-- matching reference
+
+Matches:              c c n n c
+
+Output stream:
+                T     1 2 3 4 4
+                B     1 2 3 4 4
+
+ +

As a result of the field matching, we can see that some frames get duplicated. +To perform a complete inverse telecine, you need to rely on a decimation filter +after this operation. See for instance the decimate filter. +

+

The same operation now matching from top fields (field=top) +looks like this: +

+
+
Input stream:
+                T     1 2 2 3 4   <-- matching reference
+                B     1 2 3 4 4
+
+Matches:              c c p p c
+
+Output stream:
+                T     1 2 2 3 4
+                B     1 2 2 3 4
+
+ +

In these examples, we can see what p, c and n mean; +basically, they refer to the frame and field of the opposite parity: +

+
    +
  • p matches the field of the opposite parity in the previous frame +
  • c matches the field of the opposite parity in the current frame +
  • n matches the field of the opposite parity in the next frame +
+ + +

30.73.1.2 u/b

+ +

The u and b matching are a bit special in the sense that they match +from the opposite parity flag. In the following examples, we assume that we are +currently matching the 2nd frame (Top:2, bottom:2). According to the match, a +’x’ is placed above and below each matched fields. +

+

With bottom matching (field=bottom): +

+
Match:           c         p           n          b          u
+
+                 x       x               x        x          x
+  Top          1 2 2     1 2 2       1 2 2      1 2 2      1 2 2
+  Bottom       1 2 3     1 2 3       1 2 3      1 2 3      1 2 3
+                 x         x           x        x              x
+
+Output frames:
+                 2          1          2          2          2
+                 2          2          2          1          3
+
+ +

With top matching (field=top): +

+
Match:           c         p           n          b          u
+
+                 x         x           x        x              x
+  Top          1 2 2     1 2 2       1 2 2      1 2 2      1 2 2
+  Bottom       1 2 3     1 2 3       1 2 3      1 2 3      1 2 3
+                 x       x               x        x          x
+
+Output frames:
+                 2          2          2          1          2
+                 2          1          3          2          2
+
+ + +

30.73.2 Examples

+ +

Simple IVTC of a top field first telecined stream: +

+
fieldmatch=order=tff:combmatch=none, decimate
+
+ +

Advanced IVTC, with fallback on yadif for still combed frames: +

+
fieldmatch=order=tff:combmatch=full, yadif=deint=interlaced, decimate
+
+ + +

30.74 fieldorder

+ +

Transform the field order of the input video. +

+

It accepts the following parameters: +

+
+
order
+

The output field order. Valid values are tff for top field first or bff +for bottom field first. +

+
+ +

The default value is ‘tff’. +

+

The transformation is done by shifting the picture content up or down +by one line, and filling the remaining line with appropriate picture content. +This method is consistent with most broadcast field order converters. +

+

If the input video is not flagged as being interlaced, or it is already +flagged as being of the required output field order, then this filter does +not alter the incoming video. +

+

It is very useful when converting to or from PAL DV material, +which is bottom field first. +

+

For example: +

+
ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
+
+ + +

30.75 fifo, afifo

+ +

Buffer input images and send them when they are requested. +

+

It is mainly useful when auto-inserted by the libavfilter +framework. +

+

It does not take parameters. +

+ +

30.76 fillborders

+ +

Fill borders of the input video, without changing video stream dimensions. +Sometimes video can have garbage at the four edges and you may not want to +crop video input to keep size multiple of some number. +

+

This filter accepts the following options: +

+
+
left
+

Number of pixels to fill from left border. +

+
+
right
+

Number of pixels to fill from right border. +

+
+
top
+

Number of pixels to fill from top border. +

+
+
bottom
+

Number of pixels to fill from bottom border. +

+
+
mode
+

Set fill mode. +

+

It accepts the following values: +

+
‘smear’
+

fill pixels using outermost pixels +

+
+
‘mirror’
+

fill pixels using mirroring +

+
+
‘fixed’
+

fill pixels with constant value +

+
+ +

Default is smear. +

+
+
color
+

Set color for pixels in fixed mode. Default is black. +

+
+ + +

30.76.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.77 find_rect

+ +

Find a rectangular object +

+

It accepts the following options: +

+
+
object
+

Filepath of the object image, needs to be in gray8. +

+
+
threshold
+

Detection threshold, default is 0.5. +

+
+
mipmaps
+

Number of mipmaps, default is 3. +

+
+
xmin, ymin, xmax, ymax
+

Specifies the rectangle in which to search. +

+
+ + +

30.77.1 Examples

+ +
    +
  • Cover a rectangular object by the supplied image of a given video using ffmpeg: +
    +
    ffmpeg -i file.ts -vf find_rect=newref.pgm,cover_rect=cover.jpg:mode=cover new.mkv
+
    +
+ + +

30.78 floodfill

+ +

Flood area with values of same pixel components with another values. +

+

It accepts the following options: +

+
x
+

Set pixel x coordinate. +

+
+
y
+

Set pixel y coordinate. +

+
+
s0
+

Set source #0 component value. +

+
+
s1
+

Set source #1 component value. +

+
+
s2
+

Set source #2 component value. +

+
+
s3
+

Set source #3 component value. +

+
+
d0
+

Set destination #0 component value. +

+
+
d1
+

Set destination #1 component value. +

+
+
d2
+

Set destination #2 component value. +

+
+
d3
+

Set destination #3 component value. +

+
+ + +

30.79 format

+ +

Convert the input video to one of the specified pixel formats. +Libavfilter will try to pick one that is suitable as input to +the next filter. +

+

It accepts the following parameters: +

+
pix_fmts
+

A ’|’-separated list of pixel format names, such as +"pix_fmts=yuv420p|monow|rgb24". +

+
+
+ + +

30.79.1 Examples

+ +
    +
  • Convert the input video to the yuv420p format +
    +
    format=pix_fmts=yuv420p
+
    + +

    Convert the input video to any of the formats in the list +

    +
    format=pix_fmts=yuv420p|yuv444p|yuv410p
+
    +
+ + +

30.80 fps

+ +

Convert the video to specified constant frame rate by duplicating or dropping +frames as necessary. +

+

It accepts the following parameters: +

+
fps
+

The desired output frame rate. The default is 25. +

+
+
start_time
+

Assume the first PTS should be the given value, in seconds. This allows for +padding/trimming at the start of stream. By default, no assumption is made +about the first frame’s expected PTS, so no padding or trimming is done. +For example, this could be set to 0 to pad the beginning with duplicates of +the first frame if a video stream starts after the audio stream or to trim any +frames with a negative PTS. +

+
+
round
+

Timestamp (PTS) rounding method. +

+

Possible values are: +

+
zero
+

round towards 0 +

+
inf
+

round away from 0 +

+
down
+

round towards -infinity +

+
up
+

round towards +infinity +

+
near
+

round to nearest +

+
+

The default is near. +

+
+
eof_action
+

Action performed when reading the last frame. +

+

Possible values are: +

+
round
+

Use same timestamp rounding method as used for other frames. +

+
pass
+

Pass through last frame if input duration has not been reached yet. +

+
+

The default is round. +

+
+
+ +

Alternatively, the options can be specified as a flat string: +fps[:start_time[:round]]. +

+

See also the setpts filter. +

+ +

30.80.1 Examples

+ +
    +
  • A typical usage in order to set the fps to 25: +
    +
    fps=fps=25
+
    + +
  • Sets the fps to 24, using abbreviation and rounding method to round to nearest: +
    +
    fps=fps=film:round=near
+
    +
+ + +

30.81 framepack

+ +

Pack two different video streams into a stereoscopic video, setting proper +metadata on supported codecs. The two views should have the same size and +framerate and processing will stop when the shorter video ends. Please note +that you may conveniently adjust view properties with the scale and +fps filters. +

+

It accepts the following parameters: +

+
format
+

The desired packing format. Supported values are: +

+
+
sbs
+

The views are next to each other (default). +

+
+
tab
+

The views are on top of each other. +

+
+
lines
+

The views are packed by line. +

+
+
columns
+

The views are packed by column. +

+
+
frameseq
+

The views are temporally interleaved. +

+
+
+ +
+
+ +

Some examples: +

+
+
# Convert left and right views into a frame-sequential video
+ffmpeg -i LEFT -i RIGHT -filter_complex framepack=frameseq OUTPUT
+
+# Convert views into a side-by-side video with the same output resolution as the input
+ffmpeg -i LEFT -i RIGHT -filter_complex [0:v]scale=w=iw/2[left],[1:v]scale=w=iw/2[right],[left][right]framepack=sbs OUTPUT
+
+ + +

30.82 framerate

+ +

Change the frame rate by interpolating new video output frames from the source +frames. +

+

This filter is not designed to function correctly with interlaced media. If +you wish to change the frame rate of interlaced media then you are required +to deinterlace before this filter and re-interlace after this filter. +

+

A description of the accepted options follows. +

+
+
fps
+

Specify the output frames per second. This option can also be specified +as a value alone. The default is 50. +

+
+
interp_start
+

Specify the start of a range where the output frame will be created as a +linear interpolation of two frames. The range is [0-255], +the default is 15. +

+
+
interp_end
+

Specify the end of a range where the output frame will be created as a +linear interpolation of two frames. The range is [0-255], +the default is 240. +

+
+
scene
+

Specify the level at which a scene change is detected as a value between +0 and 100 to indicate a new scene; a low value reflects a low +probability for the current frame to introduce a new scene, while a higher +value means the current frame is more likely to be one. +The default is 8.2. +

+
+
flags
+

Specify flags influencing the filter process. +

+

Available value for flags is: +

+
+
scene_change_detect, scd
+

Enable scene change detection using the value of the option scene. +This flag is enabled by default. +

+
+
+
+ + +

30.83 framestep

+ +

Select one frame every N-th frame. +

+

This filter accepts the following option: +

+
step
+

Select frame after every step frames. +Allowed values are positive integers higher than 0. Default value is 1. +

+
+ + +

30.84 freezedetect

+ +

Detect frozen video. +

+

This filter logs a message and sets frame metadata when it detects that the +input video has no significant change in content during a specified duration. +Video freeze detection calculates the mean average absolute difference of all +the components of video frames and compares it to a noise floor. +

+

The printed times and duration are expressed in seconds. The +lavfi.freezedetect.freeze_start metadata key is set on the first frame +whose timestamp equals or exceeds the detection duration and it contains the +timestamp of the first frame of the freeze. The +lavfi.freezedetect.freeze_duration and +lavfi.freezedetect.freeze_end metadata keys are set on the first frame +after the freeze. +

+

The filter accepts the following options: +

+
+
noise, n
+

Set noise tolerance. Can be specified in dB (in case "dB" is appended to the +specified value) or as a difference ratio between 0 and 1. Default is -60dB, or +0.001. +

+
+
duration, d
+

Set freeze duration until notification (default is 2 seconds). +

+
+ + +

30.85 freezeframes

+ +

Freeze video frames. +

+

This filter freezes video frames using frame from 2nd input. +

+

The filter accepts the following options: +

+
+
first
+

Set number of first frame from which to start freeze. +

+
+
last
+

Set number of last frame from which to end freeze. +

+
+
replace
+

Set number of frame from 2nd input which will be used instead of replaced frames. +

+
+ + +

30.86 frei0r

+ +

Apply a frei0r effect to the input video. +

+

To enable the compilation of this filter, you need to install the frei0r +header and configure FFmpeg with --enable-frei0r. +

+

It accepts the following parameters: +

+
+
filter_name
+

The name of the frei0r effect to load. If the environment variable +FREI0R_PATH is defined, the frei0r effect is searched for in each of the +directories specified by the colon-separated list in FREI0R_PATH. +Otherwise, the standard frei0r paths are searched, in this order: +HOME/.frei0r-1/lib/, /usr/local/lib/frei0r-1/, +/usr/lib/frei0r-1/. +

+
+
filter_params
+

A ’|’-separated list of parameters to pass to the frei0r effect. +

+
+
+ +

A frei0r effect parameter can be a boolean (its value is either +"y" or "n"), a double, a color (specified as +R/G/B, where R, G, and B are floating point +numbers between 0.0 and 1.0, inclusive) or a color description as specified in the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual, +a position (specified as X/Y, where +X and Y are floating point numbers) and/or a string. +

+

The number and types of parameters depend on the loaded effect. If an +effect parameter is not specified, the default value is set. +

+ +

30.86.1 Examples

+ +
    +
  • Apply the distort0r effect, setting the first two double parameters: +
    +
    frei0r=filter_name=distort0r:filter_params=0.5|0.01
+
    + +
  • Apply the colordistance effect, taking a color as the first parameter: +
    +
    frei0r=colordistance:0.2/0.3/0.4
+frei0r=colordistance:violet
+frei0r=colordistance:0x112233
+
    + +
  • Apply the perspective effect, specifying the top left and top right image +positions: +
    +
    frei0r=perspective:0.2/0.2|0.8/0.2
+
    +
+ +

For more information, see +http://frei0r.dyne.org +

+ +

30.87 fspp

+ +

Apply fast and simple postprocessing. It is a faster version of spp. +

+

It splits (I)DCT into horizontal/vertical passes. Unlike the simple post- +processing filter, one of them is performed once per block, not per pixel. +This allows for much higher speed. +

+

The filter accepts the following options: +

+
+
quality
+

Set quality. This option defines the number of levels for averaging. It accepts +an integer in the range 4-5. Default value is 4. +

+
+
qp
+

Force a constant quantization parameter. It accepts an integer in range 0-63. +If not set, the filter will use the QP from the video stream (if available). +

+
+
strength
+

Set filter strength. It accepts an integer in range -15 to 32. Lower values mean +more details but also more artifacts, while higher values make the image smoother +but also blurrier. Default value is 0 − PSNR optimal. +

+
+
use_bframe_qp
+

Enable the use of the QP from the B-Frames if set to 1. Using this +option may cause flicker since the B-Frames have often larger QP. Default is +0 (not enabled). +

+
+
+ + +

30.88 gblur

+ +

Apply Gaussian blur filter. +

+

The filter accepts the following options: +

+
+
sigma
+

Set horizontal sigma, standard deviation of Gaussian blur. Default is 0.5. +

+
+
steps
+

Set number of steps for Gaussian approximation. Default is 1. +

+
+
planes
+

Set which planes to filter. By default all planes are filtered. +

+
+
sigmaV
+

Set vertical sigma, if negative it will be same as sigma. +Default is -1. +

+
+ + +

30.88.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.89 geq

+ +

Apply generic equation to each pixel. +

+

The filter accepts the following options: +

+
+
lum_expr, lum
+

Set the luminance expression. +

+
cb_expr, cb
+

Set the chrominance blue expression. +

+
cr_expr, cr
+

Set the chrominance red expression. +

+
alpha_expr, a
+

Set the alpha expression. +

+
red_expr, r
+

Set the red expression. +

+
green_expr, g
+

Set the green expression. +

+
blue_expr, b
+

Set the blue expression. +

+
+ +

The colorspace is selected according to the specified options. If one +of the lum_expr, cb_expr, or cr_expr +options is specified, the filter will automatically select a YCbCr +colorspace. If one of the red_expr, green_expr, or +blue_expr options is specified, it will select an RGB +colorspace. +

+

If one of the chrominance expression is not defined, it falls back on the other +one. If no alpha expression is specified it will evaluate to opaque value. +If none of chrominance expressions are specified, they will evaluate +to the luminance expression. +

+

The expressions can use the following variables and functions: +

+
+
N
+

The sequential number of the filtered frame, starting from 0. +

+
+
X
+
Y
+

The coordinates of the current sample. +

+
+
W
+
H
+

The width and height of the image. +

+
+
SW
+
SH
+

Width and height scale depending on the currently filtered plane. It is the +ratio between the corresponding luma plane number of pixels and the current +plane ones. E.g. for YUV4:2:0 the values are 1,1 for the luma plane, and +0.5,0.5 for chroma planes. +

+
+
T
+

Time of the current frame, expressed in seconds. +

+
+
p(x, y)
+

Return the value of the pixel at location (x,y) of the current +plane. +

+
+
lum(x, y)
+

Return the value of the pixel at location (x,y) of the luminance +plane. +

+
+
cb(x, y)
+

Return the value of the pixel at location (x,y) of the +blue-difference chroma plane. Return 0 if there is no such plane. +

+
+
cr(x, y)
+

Return the value of the pixel at location (x,y) of the +red-difference chroma plane. Return 0 if there is no such plane. +

+
+
r(x, y)
+
g(x, y)
+
b(x, y)
+

Return the value of the pixel at location (x,y) of the +red/green/blue component. Return 0 if there is no such component. +

+
+
alpha(x, y)
+

Return the value of the pixel at location (x,y) of the alpha +plane. Return 0 if there is no such plane. +

+
+
psum(x,y), lumsum(x, y), cbsum(x,y), crsum(x,y), rsum(x,y), gsum(x,y), bsum(x,y), alphasum(x,y)
+

Sum of sample values in the rectangle from (0,0) to (x,y), this allows obtaining +sums of samples within a rectangle. See the functions without the sum postfix. +

+
+
interpolation
+

Set one of interpolation methods: +

+
nearest, n
+
bilinear, b
+
+

Default is bilinear. +

+
+ +

For functions, if x and y are outside the area, the value will be +automatically clipped to the closer edge. +

+

Please note that this filter can use multiple threads in which case each slice +will have its own expression state. If you want to use only a single expression +state because your expressions depend on previous state then you should limit +the number of filter threads to 1. +

+ +

30.89.1 Examples

+ +
    +
  • Flip the image horizontally: +
    +
    geq=p(W-X\,Y)
+
    + +
  • Generate a bidimensional sine wave, with angle PI/3 and a +wavelength of 100 pixels: +
    +
    geq=128 + 100*sin(2*(PI/100)*(cos(PI/3)*(X-50*T) + sin(PI/3)*Y)):128:128
+
    + +
  • Generate a fancy enigmatic moving light: +
    +
    nullsrc=s=256x256,geq=random(1)/hypot(X-cos(N*0.07)*W/2-W/2\,Y-sin(N*0.09)*H/2-H/2)^2*1000000*sin(N*0.02):128:128
+
    + +
  • Generate a quick emboss effect: +
    +
    format=gray,geq=lum_expr='(p(X,Y)+(256-p(X-4,Y-4)))/2'
+
    + +
  • Modify RGB components depending on pixel position: +
    +
    geq=r='X/W*r(X,Y)':g='(1-X/W)*g(X,Y)':b='(H-Y)/H*b(X,Y)'
+
    + +
  • Create a radial gradient that is the same size as the input (also see +the vignette filter): +
    +
    geq=lum=255*gauss((X/W-0.5)*3)*gauss((Y/H-0.5)*3)/gauss(0)/gauss(0),format=gray
+
    +
+ + +

30.90 gradfun

+ +

Fix the banding artifacts that are sometimes introduced into nearly flat +regions by truncation to 8-bit color depth. +Interpolate the gradients that should go where the bands are, and +dither them. +

+

It is designed for playback only. Do not use it prior to +lossy compression, because compression tends to lose the dither and +bring back the bands. +

+

It accepts the following parameters: +

+
+
strength
+

The maximum amount by which the filter will change any one pixel. This is also +the threshold for detecting nearly flat regions. Acceptable values range from +.51 to 64; the default value is 1.2. Out-of-range values will be clipped to the +valid range. +

+
+
radius
+

The neighborhood to fit the gradient to. A larger radius makes for smoother +gradients, but also prevents the filter from modifying the pixels near detailed +regions. Acceptable values are 8-32; the default value is 16. Out-of-range +values will be clipped to the valid range. +

+
+
+ +

Alternatively, the options can be specified as a flat string: +strength[:radius] +

+ +

30.90.1 Examples

+ +
    +
  • Apply the filter with a 3.5 strength and radius of 8: +
    +
    gradfun=3.5:8
+
    + +
  • Specify radius, omitting the strength (which will fall-back to the default +value): +
    +
    gradfun=radius=8
+
    + +
+ + +

30.91 graphmonitor

+

Show various filtergraph stats. +

+

With this filter one can debug complete filtergraph. +Especially issues with links filling with queued frames. +

+

The filter accepts the following options: +

+
+
size, s
+

Set video output size. Default is hd720. +

+
+
opacity, o
+

Set video opacity. Default is 0.9. Allowed range is from 0 to 1. +

+
+
mode, m
+

Set output mode, can be fulll or compact. +In compact mode only filters with some queued frames have displayed stats. +

+
+
flags, f
+

Set flags which enable which stats are shown in video. +

+

Available values for flags are: +

+
‘queue’
+

Display number of queued frames in each link. +

+
+
‘frame_count_in’
+

Display number of frames taken from filter. +

+
+
‘frame_count_out’
+

Display number of frames given out from filter. +

+
+
‘pts’
+

Display current filtered frame pts. +

+
+
‘time’
+

Display current filtered frame time. +

+
+
‘timebase’
+

Display time base for filter link. +

+
+
‘format’
+

Display used format for filter link. +

+
+
‘size’
+

Display video size or number of audio channels in case of audio used by filter link. +

+
+
‘rate’
+

Display video frame rate or sample rate in case of audio used by filter link. +

+
+ +
+
rate, r
+

Set upper limit for video rate of output stream, Default value is 25. +This guarantee that output video frame rate will not be higher than this value. +

+
+ + +

30.92 greyedge

+

A color constancy variation filter which estimates scene illumination via grey edge algorithm +and corrects the scene colors accordingly. +

+

See: https://staff.science.uva.nl/th.gevers/pub/GeversTIP07.pdf +

+

The filter accepts the following options: +

+
+
difford
+

The order of differentiation to be applied on the scene. Must be chosen in the range +[0,2] and default value is 1. +

+
+
minknorm
+

The Minkowski parameter to be used for calculating the Minkowski distance. Must +be chosen in the range [0,20] and default value is 1. Set to 0 for getting +max value instead of calculating Minkowski distance. +

+
+
sigma
+

The standard deviation of Gaussian blur to be applied on the scene. Must be +chosen in the range [0,1024.0] and default value = 1. floor( sigma * break_off_sigma(3) ) +can’t be equal to 0 if difford is greater than 0. +

+
+ + +

30.92.1 Examples

+
    +
  • Grey Edge: +
    +
    greyedge=difford=1:minknorm=5:sigma=2
+
    + +
  • Max Edge: +
    +
    greyedge=difford=1:minknorm=0:sigma=2
+
    + +
+ + +

30.93 haldclut

+ +

Apply a Hald CLUT to a video stream. +

+

First input is the video stream to process, and second one is the Hald CLUT. +The Hald CLUT input can be a simple picture or a complete video stream. +

+

The filter accepts the following options: +

+
+
shortest
+

Force termination when the shortest input terminates. Default is 0. +

+
repeatlast
+

Continue applying the last CLUT after the end of the stream. A value of +0 disable the filter after the last frame of the CLUT is reached. +Default is 1. +

+
+ +

haldclut also has the same interpolation options as lut3d (both +filters share the same internals). +

+

This filter also supports the framesync options. +

+

More information about the Hald CLUT can be found on Eskil Steenberg’s website +(Hald CLUT author) at http://www.quelsolaar.com/technology/clut.html. +

+ +

30.93.1 Workflow examples

+ + +

30.93.1.1 Hald CLUT video stream

+ +

Generate an identity Hald CLUT stream altered with various effects: +

+
ffmpeg -f lavfi -i haldclutsrc=8 -vf "hue=H=2*PI*t:s=sin(2*PI*t)+1, curves=cross_process" -t 10 -c:v ffv1 clut.nut
+
+ +

Note: make sure you use a lossless codec. +

+

Then use it with haldclut to apply it on some random stream: +

+
ffmpeg -f lavfi -i mandelbrot -i clut.nut -filter_complex '[0][1] haldclut' -t 20 mandelclut.mkv
+
+ +

The Hald CLUT will be applied to the 10 first seconds (duration of +clut.nut), then the latest picture of that CLUT stream will be applied +to the remaining frames of the mandelbrot stream. +

+ +

30.93.1.2 Hald CLUT with preview

+ +

A Hald CLUT is supposed to be a squared image of Level*Level*Level by +Level*Level*Level pixels. For a given Hald CLUT, FFmpeg will select the +biggest possible square starting at the top left of the picture. The remaining +padding pixels (bottom or right) will be ignored. This area can be used to add +a preview of the Hald CLUT. +

+

Typically, the following generated Hald CLUT will be supported by the +haldclut filter: +

+
+
ffmpeg -f lavfi -i haldclutsrc=8 -vf "
+   pad=iw+320 [padded_clut];
+   smptebars=s=320x256, split [a][b];
+   [padded_clut][a] overlay=W-320:h, curves=color_negative [main];
+   [main][b] overlay=W-320" -frames:v 1 clut.png
+
+ +

It contains the original and a preview of the effect of the CLUT: SMPTE color +bars are displayed on the right-top, and below the same color bars processed by +the color changes. +

+

Then, the effect of this Hald CLUT can be visualized with: +

+
ffplay input.mkv -vf "movie=clut.png, [in] haldclut"
+
+ + +

30.94 hflip

+ +

Flip the input video horizontally. +

+

For example, to horizontally flip the input video with ffmpeg: +

+
ffmpeg -i in.avi -vf "hflip" out.avi
+
+ + +

30.95 histeq

+

This filter applies a global color histogram equalization on a +per-frame basis. +

+

It can be used to correct video that has a compressed range of pixel +intensities. The filter redistributes the pixel intensities to +equalize their distribution across the intensity range. It may be +viewed as an "automatically adjusting contrast filter". This filter is +useful only for correcting degraded or poorly captured source +video. +

+

The filter accepts the following options: +

+
+
strength
+

Determine the amount of equalization to be applied. As the strength +is reduced, the distribution of pixel intensities more-and-more +approaches that of the input frame. The value must be a float number +in the range [0,1] and defaults to 0.200. +

+
+
intensity
+

Set the maximum intensity that can generated and scale the output +values appropriately. The strength should be set as desired and then +the intensity can be limited if needed to avoid washing-out. The value +must be a float number in the range [0,1] and defaults to 0.210. +

+
+
antibanding
+

Set the antibanding level. If enabled the filter will randomly vary +the luminance of output pixels by a small amount to avoid banding of +the histogram. Possible values are none, weak or +strong. It defaults to none. +

+
+ + +

30.96 histogram

+ +

Compute and draw a color distribution histogram for the input video. +

+

The computed histogram is a representation of the color component +distribution in an image. +

+

Standard histogram displays the color components distribution in an image. +Displays color graph for each color component. Shows distribution of +the Y, U, V, A or R, G, B components, depending on input format, in the +current frame. Below each graph a color component scale meter is shown. +

+

The filter accepts the following options: +

+
+
level_height
+

Set height of level. Default value is 200. +Allowed range is [50, 2048]. +

+
+
scale_height
+

Set height of color scale. Default value is 12. +Allowed range is [0, 40]. +

+
+
display_mode
+

Set display mode. +It accepts the following values: +

+
‘stack’
+

Per color component graphs are placed below each other. +

+
+
‘parade’
+

Per color component graphs are placed side by side. +

+
+
‘overlay’
+

Presents information identical to that in the parade, except +that the graphs representing color components are superimposed directly +over one another. +

+
+

Default is stack. +

+
+
levels_mode
+

Set mode. Can be either linear, or logarithmic. +Default is linear. +

+
+
components
+

Set what color components to display. +Default is 7. +

+
+
fgopacity
+

Set foreground opacity. Default is 0.7. +

+
+
bgopacity
+

Set background opacity. Default is 0.5. +

+
+ + +

30.96.1 Examples

+ +
    +
  • Calculate and draw histogram: +
    +
    ffplay -i input -vf histogram
+
    + +
+ + +

30.97 hqdn3d

+ +

This is a high precision/quality 3d denoise filter. It aims to reduce +image noise, producing smooth images and making still images really +still. It should enhance compressibility. +

+

It accepts the following optional parameters: +

+
+
luma_spatial
+

A non-negative floating point number which specifies spatial luma strength. +It defaults to 4.0. +

+
+
chroma_spatial
+

A non-negative floating point number which specifies spatial chroma strength. +It defaults to 3.0*luma_spatial/4.0. +

+
+
luma_tmp
+

A floating point number which specifies luma temporal strength. It defaults to +6.0*luma_spatial/4.0. +

+
+
chroma_tmp
+

A floating point number which specifies chroma temporal strength. It defaults to +luma_tmp*chroma_spatial/luma_spatial. +

+
+ + +

30.97.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.98 hwdownload

+ +

Download hardware frames to system memory. +

+

The input must be in hardware frames, and the output a non-hardware format. +Not all formats will be supported on the output - it may be necessary to insert +an additional format filter immediately following in the graph to get +the output in a supported format. +

+ +

30.99 hwmap

+ +

Map hardware frames to system memory or to another device. +

+

This filter has several different modes of operation; which one is used depends +on the input and output formats: +

    +
  • Hardware frame input, normal frame output + +

    Map the input frames to system memory and pass them to the output. If the +original hardware frame is later required (for example, after overlaying +something else on part of it), the hwmap filter can be used again +in the next mode to retrieve it. +

  • Normal frame input, hardware frame output + +

    If the input is actually a software-mapped hardware frame, then unmap it - +that is, return the original hardware frame. +

    +

    Otherwise, a device must be provided. Create new hardware surfaces on that +device for the output, then map them back to the software format at the input +and give those frames to the preceding filter. This will then act like the +hwupload filter, but may be able to avoid an additional copy when +the input is already in a compatible format. +

  • Hardware frame input and output + +

    A device must be supplied for the output, either directly or with the +derive_device option. The input and output devices must be of +different types and compatible - the exact meaning of this is +system-dependent, but typically it means that they must refer to the same +underlying hardware context (for example, refer to the same graphics card). +

    +

    If the input frames were originally created on the output device, then unmap +to retrieve the original frames. +

    +

    Otherwise, map the frames to the output device - create new hardware frames +on the output corresponding to the frames on the input. +

+ +

The following additional parameters are accepted: +

+
+
mode
+

Set the frame mapping mode. Some combination of: +

+
read
+

The mapped frame should be readable. +

+
write
+

The mapped frame should be writeable. +

+
overwrite
+

The mapping will always overwrite the entire frame. +

+

This may improve performance in some cases, as the original contents of the +frame need not be loaded. +

+
direct
+

The mapping must not involve any copying. +

+

Indirect mappings to copies of frames are created in some cases where either +direct mapping is not possible or it would have unexpected properties. +Setting this flag ensures that the mapping is direct and will fail if that is +not possible. +

+
+

Defaults to read+write if not specified. +

+
+
derive_device type
+

Rather than using the device supplied at initialisation, instead derive a new +device of type type from the device the input frames exist on. +

+
+
reverse
+

In a hardware to hardware mapping, map in reverse - create frames in the sink +and map them back to the source. This may be necessary in some cases where +a mapping in one direction is required but only the opposite direction is +supported by the devices being used. +

+

This option is dangerous - it may break the preceding filter in undefined +ways if there are any additional constraints on that filter’s output. +Do not use it without fully understanding the implications of its use. +

+
+ + +

30.100 hwupload

+ +

Upload system memory frames to hardware surfaces. +

+

The device to upload to must be supplied when the filter is initialised. If +using ffmpeg, select the appropriate device with the -filter_hw_device +option or with the derive_device option. The input and output devices +must be of different types and compatible - the exact meaning of this is +system-dependent, but typically it means that they must refer to the same +underlying hardware context (for example, refer to the same graphics card). +

+

The following additional parameters are accepted: +

+
+
derive_device type
+

Rather than using the device supplied at initialisation, instead derive a new +device of type type from the device the input frames exist on. +

+
+ + +

30.101 hwupload_cuda

+ +

Upload system memory frames to a CUDA device. +

+

It accepts the following optional parameters: +

+
+
device
+

The number of the CUDA device to use +

+
+ + +

30.102 hqx

+ +

Apply a high-quality magnification filter designed for pixel art. This filter +was originally created by Maxim Stepin. +

+

It accepts the following option: +

+
+
n
+

Set the scaling dimension: 2 for hq2x, 3 for +hq3x and 4 for hq4x. +Default is 3. +

+
+ + +

30.103 hstack

+

Stack input videos horizontally. +

+

All streams must be of same pixel format and of same height. +

+

Note that this filter is faster than using overlay and pad filter +to create same output. +

+

The filter accepts the following option: +

+
+
inputs
+

Set number of input streams. Default is 2. +

+
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+ + +

30.104 hue

+ +

Modify the hue and/or the saturation of the input. +

+

It accepts the following parameters: +

+
+
h
+

Specify the hue angle as a number of degrees. It accepts an expression, +and defaults to "0". +

+
+
s
+

Specify the saturation in the [-10,10] range. It accepts an expression and +defaults to "1". +

+
+
H
+

Specify the hue angle as a number of radians. It accepts an +expression, and defaults to "0". +

+
+
b
+

Specify the brightness in the [-10,10] range. It accepts an expression and +defaults to "0". +

+
+ +

h and H are mutually exclusive, and can’t be +specified at the same time. +

+

The b, h, H and s option values are +expressions containing the following constants: +

+
+
n
+

frame count of the input frame starting from 0 +

+
+
pts
+

presentation timestamp of the input frame expressed in time base units +

+
+
r
+

frame rate of the input video, NAN if the input frame rate is unknown +

+
+
t
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+
tb
+

time base of the input video +

+
+ + +

30.104.1 Examples

+ +
    +
  • Set the hue to 90 degrees and the saturation to 1.0: +
    +
    hue=h=90:s=1
+
    + +
  • Same command but expressing the hue in radians: +
    +
    hue=H=PI/2:s=1
+
    + +
  • Rotate hue and make the saturation swing between 0 +and 2 over a period of 1 second: +
    +
    hue="H=2*PI*t: s=sin(2*PI*t)+1"
+
    + +
  • Apply a 3 seconds saturation fade-in effect starting at 0: +
    +
    hue="s=min(t/3\,1)"
+
    + +

    The general fade-in expression can be written as: +

    +
    hue="s=min(0\, max((t-START)/DURATION\, 1))"
+
    + +
  • Apply a 3 seconds saturation fade-out effect starting at 5 seconds: +
    +
    hue="s=max(0\, min(1\, (8-t)/3))"
+
    + +

    The general fade-out expression can be written as: +

    +
    hue="s=max(0\, min(1\, (START+DURATION-t)/DURATION))"
+
    + +
+ + +

30.104.2 Commands

+ +

This filter supports the following commands: +

+
b
+
s
+
h
+
H
+

Modify the hue and/or the saturation and/or brightness of the input video. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

30.105 hysteresis

+ +

Grow first stream into second stream by connecting components. +This makes it possible to build more robust edge masks. +

+

This filter accepts the following options: +

+
+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+
threshold
+

Set threshold which is used in filtering. If pixel component value is higher than +this value filter algorithm for connecting components is activated. +By default value is 0. +

+
+ +

The hysteresis filter also supports the framesync options. +

+ +

30.106 idet

+ +

Detect video interlacing type. +

+

This filter tries to detect if the input frames are interlaced, progressive, +top or bottom field first. It will also try to detect fields that are +repeated between adjacent frames (a sign of telecine). +

+

Single frame detection considers only immediately adjacent frames when classifying each frame. +Multiple frame detection incorporates the classification history of previous frames. +

+

The filter will log these metadata values: +

+
+
single.current_frame
+

Detected type of current frame using single-frame detection. One of: +“tff” (top field first), “bff” (bottom field first), +“progressive”, or “undetermined” +

+
+
single.tff
+

Cumulative number of frames detected as top field first using single-frame detection. +

+
+
multiple.tff
+

Cumulative number of frames detected as top field first using multiple-frame detection. +

+
+
single.bff
+

Cumulative number of frames detected as bottom field first using single-frame detection. +

+
+
multiple.current_frame
+

Detected type of current frame using multiple-frame detection. One of: +“tff” (top field first), “bff” (bottom field first), +“progressive”, or “undetermined” +

+
+
multiple.bff
+

Cumulative number of frames detected as bottom field first using multiple-frame detection. +

+
+
single.progressive
+

Cumulative number of frames detected as progressive using single-frame detection. +

+
+
multiple.progressive
+

Cumulative number of frames detected as progressive using multiple-frame detection. +

+
+
single.undetermined
+

Cumulative number of frames that could not be classified using single-frame detection. +

+
+
multiple.undetermined
+

Cumulative number of frames that could not be classified using multiple-frame detection. +

+
+
repeated.current_frame
+

Which field in the current frame is repeated from the last. One of “neither”, “top”, or “bottom”. +

+
+
repeated.neither
+

Cumulative number of frames with no repeated field. +

+
+
repeated.top
+

Cumulative number of frames with the top field repeated from the previous frame’s top field. +

+
+
repeated.bottom
+

Cumulative number of frames with the bottom field repeated from the previous frame’s bottom field. +

+
+ +

The filter accepts the following options: +

+
+
intl_thres
+

Set interlacing threshold. +

+
prog_thres
+

Set progressive threshold. +

+
rep_thres
+

Threshold for repeated field detection. +

+
half_life
+

Number of frames after which a given frame’s contribution to the +statistics is halved (i.e., it contributes only 0.5 to its +classification). The default of 0 means that all frames seen are given +full weight of 1.0 forever. +

+
analyze_interlaced_flag
+

When this is not 0 then idet will use the specified number of frames to determine +if the interlaced flag is accurate, it will not count undetermined frames. +If the flag is found to be accurate it will be used without any further +computations, if it is found to be inaccurate it will be cleared without any +further computations. This allows inserting the idet filter as a low computational +method to clean up the interlaced flag +

+
+ + +

30.107 il

+ +

Deinterleave or interleave fields. +

+

This filter allows one to process interlaced images fields without +deinterlacing them. Deinterleaving splits the input frame into 2 +fields (so called half pictures). Odd lines are moved to the top +half of the output image, even lines to the bottom half. +You can process (filter) them independently and then re-interleave them. +

+

The filter accepts the following options: +

+
+
luma_mode, l
+
chroma_mode, c
+
alpha_mode, a
+

Available values for luma_mode, chroma_mode and +alpha_mode are: +

+
+
‘none’
+

Do nothing. +

+
+
‘deinterleave, d’
+

Deinterleave fields, placing one above the other. +

+
+
‘interleave, i’
+

Interleave fields. Reverse the effect of deinterleaving. +

+
+

Default value is none. +

+
+
luma_swap, ls
+
chroma_swap, cs
+
alpha_swap, as
+

Swap luma/chroma/alpha fields. Exchange even & odd lines. Default value is 0. +

+
+ + +

30.107.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

30.108 inflate

+ +

Apply inflate effect to the video. +

+

This filter replaces the pixel by the local(3x3) average by taking into account +only values higher than the pixel. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+ + +

30.108.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

30.109 interlace

+ +

Simple interlacing filter from progressive contents. This interleaves upper (or +lower) lines from odd frames with lower (or upper) lines from even frames, +halving the frame rate and preserving image height. +

+
+
   Original        Original             New Frame
+   Frame 'j'      Frame 'j+1'             (tff)
+  ==========      ===========       ==================
+    Line 0  -------------------->    Frame 'j' Line 0
+    Line 1          Line 1  ---->   Frame 'j+1' Line 1
+    Line 2 --------------------->    Frame 'j' Line 2
+    Line 3          Line 3  ---->   Frame 'j+1' Line 3
+     ...             ...                   ...
+New Frame + 1 will be generated by Frame 'j+2' and Frame 'j+3' and so on
+
+ +

It accepts the following optional parameters: +

+
+
scan
+

This determines whether the interlaced frame is taken from the even +(tff - default) or odd (bff) lines of the progressive frame. +

+
+
lowpass
+

Vertical lowpass filter to avoid twitter interlacing and +reduce moire patterns. +

+
+
‘0, off’
+

Disable vertical lowpass filter +

+
+
‘1, linear’
+

Enable linear filter (default) +

+
+
‘2, complex’
+

Enable complex filter. This will slightly less reduce twitter and moire +but better retain detail and subjective sharpness impression. +

+
+
+
+
+ + +

30.110 kerndeint

+ +

Deinterlace input video by applying Donald Graft’s adaptive kernel +deinterling. Work on interlaced parts of a video to produce +progressive frames. +

+

The description of the accepted parameters follows. +

+
+
thresh
+

Set the threshold which affects the filter’s tolerance when +determining if a pixel line must be processed. It must be an integer +in the range [0,255] and defaults to 10. A value of 0 will result in +applying the process on every pixels. +

+
+
map
+

Paint pixels exceeding the threshold value to white if set to 1. +Default is 0. +

+
+
order
+

Set the fields order. Swap fields if set to 1, leave fields alone if +0. Default is 0. +

+
+
sharp
+

Enable additional sharpening if set to 1. Default is 0. +

+
+
twoway
+

Enable twoway sharpening if set to 1. Default is 0. +

+
+ + +

30.110.1 Examples

+ +
    +
  • Apply default values: +
    +
    kerndeint=thresh=10:map=0:order=0:sharp=0:twoway=0
+
    + +
  • Enable additional sharpening: +
    +
    kerndeint=sharp=1
+
    + +
  • Paint processed pixels in white: +
    +
    kerndeint=map=1
+
    +
+ + +

30.111 lagfun

+ +

Slowly update darker pixels. +

+

This filter makes short flashes of light appear longer. +This filter accepts the following options: +

+
+
decay
+

Set factor for decaying. Default is .95. Allowed range is from 0 to 1. +

+
+
planes
+

Set which planes to filter. Default is all. Allowed range is from 0 to 15. +

+
+ + +

30.112 lenscorrection

+ +

Correct radial lens distortion +

+

This filter can be used to correct for radial distortion as can result from the use +of wide angle lenses, and thereby re-rectify the image. To find the right parameters +one can use tools available for example as part of opencv or simply trial-and-error. +To use opencv use the calibration sample (under samples/cpp) from the opencv sources +and extract the k1 and k2 coefficients from the resulting matrix. +

+

Note that effectively the same filter is available in the open-source tools Krita and +Digikam from the KDE project. +

+

In contrast to the vignette filter, which can also be used to compensate lens errors, +this filter corrects the distortion of the image, whereas vignette corrects the +brightness distribution, so you may want to use both filters together in certain +cases, though you will have to take care of ordering, i.e. whether vignetting should +be applied before or after lens correction. +

+ +

30.112.1 Options

+ +

The filter accepts the following options: +

+
+
cx
+

Relative x-coordinate of the focal point of the image, and thereby the center of the +distortion. This value has a range [0,1] and is expressed as fractions of the image +width. Default is 0.5. +

+
cy
+

Relative y-coordinate of the focal point of the image, and thereby the center of the +distortion. This value has a range [0,1] and is expressed as fractions of the image +height. Default is 0.5. +

+
k1
+

Coefficient of the quadratic correction term. This value has a range [-1,1]. 0 means +no correction. Default is 0. +

+
k2
+

Coefficient of the double quadratic correction term. This value has a range [-1,1]. +0 means no correction. Default is 0. +

+
+ +

The formula that generates the correction is: +

+

r_src = r_tgt * (1 + k1 * (r_tgt / r_0)^2 + k2 * (r_tgt / r_0)^4) +

+

where r_0 is halve of the image diagonal and r_src and r_tgt are the +distances from the focal point in the source and target images, respectively. +

+ +

30.113 lensfun

+ +

Apply lens correction via the lensfun library (http://lensfun.sourceforge.net/). +

+

The lensfun filter requires the camera make, camera model, and lens model +to apply the lens correction. The filter will load the lensfun database and +query it to find the corresponding camera and lens entries in the database. As +long as these entries can be found with the given options, the filter can +perform corrections on frames. Note that incomplete strings will result in the +filter choosing the best match with the given options, and the filter will +output the chosen camera and lens models (logged with level "info"). You must +provide the make, camera model, and lens model as they are required. +

+

The filter accepts the following options: +

+
+
make
+

The make of the camera (for example, "Canon"). This option is required. +

+
+
model
+

The model of the camera (for example, "Canon EOS 100D"). This option is +required. +

+
+
lens_model
+

The model of the lens (for example, "Canon EF-S 18-55mm f/3.5-5.6 IS STM"). This +option is required. +

+
+
mode
+

The type of correction to apply. The following values are valid options: +

+
+
‘vignetting’
+

Enables fixing lens vignetting. +

+
+
‘geometry’
+

Enables fixing lens geometry. This is the default. +

+
+
‘subpixel’
+

Enables fixing chromatic aberrations. +

+
+
‘vig_geo’
+

Enables fixing lens vignetting and lens geometry. +

+
+
‘vig_subpixel’
+

Enables fixing lens vignetting and chromatic aberrations. +

+
+
‘distortion’
+

Enables fixing both lens geometry and chromatic aberrations. +

+
+
‘all’
+

Enables all possible corrections. +

+
+
+
+
focal_length
+

The focal length of the image/video (zoom; expected constant for video). For +example, a 18–55mm lens has focal length range of [18–55], so a value in that +range should be chosen when using that lens. Default 18. +

+
+
aperture
+

The aperture of the image/video (expected constant for video). Note that +aperture is only used for vignetting correction. Default 3.5. +

+
+
focus_distance
+

The focus distance of the image/video (expected constant for video). Note that +focus distance is only used for vignetting and only slightly affects the +vignetting correction process. If unknown, leave it at the default value (which +is 1000). +

+
+
scale
+

The scale factor which is applied after transformation. After correction the +video is no longer necessarily rectangular. This parameter controls how much of +the resulting image is visible. The value 0 means that a value will be chosen +automatically such that there is little or no unmapped area in the output +image. 1.0 means that no additional scaling is done. Lower values may result +in more of the corrected image being visible, while higher values may avoid +unmapped areas in the output. +

+
+
target_geometry
+

The target geometry of the output image/video. The following values are valid +options: +

+
+
‘rectilinear (default)’
+
‘fisheye’
+
‘panoramic’
+
‘equirectangular’
+
‘fisheye_orthographic’
+
‘fisheye_stereographic’
+
‘fisheye_equisolid’
+
‘fisheye_thoby’
+
+
+
reverse
+

Apply the reverse of image correction (instead of correcting distortion, apply +it). +

+
+
interpolation
+

The type of interpolation used when correcting distortion. The following values +are valid options: +

+
+
‘nearest’
+
‘linear (default)’
+
‘lanczos’
+
+
+
+ + +

30.113.1 Examples

+ +
    +
  • Apply lens correction with make "Canon", camera model "Canon EOS 100D", and lens +model "Canon EF-S 18-55mm f/3.5-5.6 IS STM" with focal length of "18" and +aperture of "8.0". + +
    +
    ffmpeg -i input.mov -vf lensfun=make=Canon:model="Canon EOS 100D":lens_model="Canon EF-S 18-55mm f/3.5-5.6 IS STM":focal_length=18:aperture=8 -c:v h264 -b:v 8000k output.mov
+
    + +
  • Apply the same as before, but only for the first 5 seconds of video. + +
    +
    ffmpeg -i input.mov -vf lensfun=make=Canon:model="Canon EOS 100D":lens_model="Canon EF-S 18-55mm f/3.5-5.6 IS STM":focal_length=18:aperture=8:enable='lte(t\,5)' -c:v h264 -b:v 8000k output.mov
+
    + +
+ + +

30.114 libvmaf

+ +

Obtain the VMAF (Video Multi-Method Assessment Fusion) +score between two input videos. +

+

The obtained VMAF score is printed through the logging system. +

+

It requires Netflix’s vmaf library (libvmaf) as a pre-requisite. +After installing the library it can be enabled using: +./configure --enable-libvmaf --enable-version3. +If no model path is specified it uses the default model: vmaf_v0.6.1.pkl. +

+

The filter has following options: +

+
+
model_path
+

Set the model path which is to be used for SVM. +Default value: "/usr/local/share/model/vmaf_v0.6.1.pkl" +

+
+
log_path
+

Set the file path to be used to store logs. +

+
+
log_fmt
+

Set the format of the log file (xml or json). +

+
+
enable_transform
+

This option can enable/disable the score_transform applied to the final predicted VMAF score, +if you have specified score_transform option in the input parameter file passed to run_vmaf_training.py +Default value: false +

+
+
phone_model
+

Invokes the phone model which will generate VMAF scores higher than in the +regular model, which is more suitable for laptop, TV, etc. viewing conditions. +Default value: false +

+
+
psnr
+

Enables computing psnr along with vmaf. +Default value: false +

+
+
ssim
+

Enables computing ssim along with vmaf. +Default value: false +

+
+
ms_ssim
+

Enables computing ms_ssim along with vmaf. +Default value: false +

+
+
pool
+

Set the pool method to be used for computing vmaf. +Options are min, harmonic_mean or mean (default). +

+
+
n_threads
+

Set number of threads to be used when computing vmaf. +Default value: 0, which makes use of all available logical processors. +

+
+
n_subsample
+

Set interval for frame subsampling used when computing vmaf. +Default value: 1 +

+
+
enable_conf_interval
+

Enables confidence interval. +Default value: false +

+
+ +

This filter also supports the framesync options. +

+ +

30.114.1 Examples

+
    +
  • On the below examples the input file main.mpg being processed is +compared with the reference file ref.mpg. + +
    +
    ffmpeg -i main.mpg -i ref.mpg -lavfi libvmaf -f null -
+
    + +
  • Example with options: +
    +
    ffmpeg -i main.mpg -i ref.mpg -lavfi libvmaf="psnr=1:log_fmt=json" -f null -
+
    + +
  • Example with options and different containers: +
    +
    ffmpeg -i main.mpg -i ref.mkv -lavfi "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]libvmaf=psnr=1:log_fmt=json" -f null -
+
    +
+ + +

30.115 limiter

+ +

Limits the pixel components values to the specified range [min, max]. +

+

The filter accepts the following options: +

+
+
min
+

Lower bound. Defaults to the lowest allowed value for the input. +

+
+
max
+

Upper bound. Defaults to the highest allowed value for the input. +

+
+
planes
+

Specify which planes will be processed. Defaults to all available. +

+
+ + +

30.116 loop

+ +

Loop video frames. +

+

The filter accepts the following options: +

+
+
loop
+

Set the number of loops. Setting this value to -1 will result in infinite loops. +Default is 0. +

+
+
size
+

Set maximal size in number of frames. Default is 0. +

+
+
start
+

Set first frame of loop. Default is 0. +

+
+ + +

30.116.1 Examples

+ +
    +
  • Loop single first frame infinitely: +
    +
    loop=loop=-1:size=1:start=0
+
    + +
  • Loop single first frame 10 times: +
    +
    loop=loop=10:size=1:start=0
+
    + +
  • Loop 10 first frames 5 times: +
    +
    loop=loop=5:size=10:start=0
+
    +
+ + +

30.117 lut1d

+ +

Apply a 1D LUT to an input video. +

+

The filter accepts the following options: +

+
+
file
+

Set the 1D LUT file name. +

+

Currently supported formats: +

+
‘cube’
+

Iridas +

+
‘csp’
+

cineSpace +

+
+ +
+
interp
+

Select interpolation mode. +

+

Available values are: +

+
+
‘nearest’
+

Use values from the nearest defined point. +

+
‘linear’
+

Interpolate values using the linear interpolation. +

+
‘cosine’
+

Interpolate values using the cosine interpolation. +

+
‘cubic’
+

Interpolate values using the cubic interpolation. +

+
‘spline’
+

Interpolate values using the spline interpolation. +

+
+
+
+ + +

30.118 lut3d

+ +

Apply a 3D LUT to an input video. +

+

The filter accepts the following options: +

+
+
file
+

Set the 3D LUT file name. +

+

Currently supported formats: +

+
‘3dl’
+

AfterEffects +

+
‘cube’
+

Iridas +

+
‘dat’
+

DaVinci +

+
‘m3d’
+

Pandora +

+
‘csp’
+

cineSpace +

+
+
+
interp
+

Select interpolation mode. +

+

Available values are: +

+
+
‘nearest’
+

Use values from the nearest defined point. +

+
‘trilinear’
+

Interpolate values using the 8 points defining a cube. +

+
‘tetrahedral’
+

Interpolate values using a tetrahedron. +

+
+
+
+ + +

30.119 lumakey

+ +

Turn certain luma values into transparency. +

+

The filter accepts the following options: +

+
+
threshold
+

Set the luma which will be used as base for transparency. +Default value is 0. +

+
+
tolerance
+

Set the range of luma values to be keyed out. +Default value is 0.01. +

+
+
softness
+

Set the range of softness. Default value is 0. +Use this to control gradual transition from zero to full transparency. +

+
+ + +

30.119.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.120 lut, lutrgb, lutyuv

+ +

Compute a look-up table for binding each pixel component input value +to an output value, and apply it to the input video. +

+

lutyuv applies a lookup table to a YUV input video, lutrgb +to an RGB input video. +

+

These filters accept the following parameters: +

+
c0
+

set first pixel component expression +

+
c1
+

set second pixel component expression +

+
c2
+

set third pixel component expression +

+
c3
+

set fourth pixel component expression, corresponds to the alpha component +

+
+
r
+

set red component expression +

+
g
+

set green component expression +

+
b
+

set blue component expression +

+
a
+

alpha component expression +

+
+
y
+

set Y/luminance component expression +

+
u
+

set U/Cb component expression +

+
v
+

set V/Cr component expression +

+
+ +

Each of them specifies the expression to use for computing the lookup table for +the corresponding pixel component values. +

+

The exact component associated to each of the c* options depends on the +format in input. +

+

The lut filter requires either YUV or RGB pixel formats in input, +lutrgb requires RGB pixel formats in input, and lutyuv requires YUV. +

+

The expressions can contain the following constants and functions: +

+
+
w
+
h
+

The input width and height. +

+
+
val
+

The input value for the pixel component. +

+
+
clipval
+

The input value, clipped to the minval-maxval range. +

+
+
maxval
+

The maximum value for the pixel component. +

+
+
minval
+

The minimum value for the pixel component. +

+
+
negval
+

The negated value for the pixel component value, clipped to the +minval-maxval range; it corresponds to the expression +"maxval-clipval+minval". +

+
+
clip(val)
+

The computed value in val, clipped to the +minval-maxval range. +

+
+
gammaval(gamma)
+

The computed gamma correction value of the pixel component value, +clipped to the minval-maxval range. It corresponds to the +expression +"pow((clipval-minval)/(maxval-minval)\,gamma)*(maxval-minval)+minval" +

+
+
+ +

All expressions default to "val". +

+ +

30.120.1 Examples

+ +
    +
  • Negate input video: +
    +
    lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
+lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
+
    + +

    The above is the same as: +

    +
    lutrgb="r=negval:g=negval:b=negval"
+lutyuv="y=negval:u=negval:v=negval"
+
    + +
  • Negate luminance: +
    +
    lutyuv=y=negval
+
    + +
  • Remove chroma components, turning the video into a graytone image: +
    +
    lutyuv="u=128:v=128"
+
    + +
  • Apply a luma burning effect: +
    +
    lutyuv="y=2*val"
+
    + +
  • Remove green and blue components: +
    +
    lutrgb="g=0:b=0"
+
    + +
  • Set a constant alpha channel value on input: +
    +
    format=rgba,lutrgb=a="maxval-minval/2"
+
    + +
  • Correct luminance gamma by a factor of 0.5: +
    +
    lutyuv=y=gammaval(0.5)
+
    + +
  • Discard least significant bits of luma: +
    +
    lutyuv=y='bitand(val, 128+64+32)'
+
    + +
  • Technicolor like effect: +
    +
    lutyuv=u='(val-maxval/2)*2+maxval/2':v='(val-maxval/2)*2+maxval/2'
+
    +
+ + +

30.121 lut2, tlut2

+ +

The lut2 filter takes two input streams and outputs one +stream. +

+

The tlut2 (time lut2) filter takes two consecutive frames +from one single stream. +

+

This filter accepts the following parameters: +

+
c0
+

set first pixel component expression +

+
c1
+

set second pixel component expression +

+
c2
+

set third pixel component expression +

+
c3
+

set fourth pixel component expression, corresponds to the alpha component +

+
+
d
+

set output bit depth, only available for lut2 filter. By default is 0, +which means bit depth is automatically picked from first input format. +

+
+ +

The lut2 filter also supports the framesync options. +

+

Each of them specifies the expression to use for computing the lookup table for +the corresponding pixel component values. +

+

The exact component associated to each of the c* options depends on the +format in inputs. +

+

The expressions can contain the following constants: +

+
+
w
+
h
+

The input width and height. +

+
+
x
+

The first input value for the pixel component. +

+
+
y
+

The second input value for the pixel component. +

+
+
bdx
+

The first input video bit depth. +

+
+
bdy
+

The second input video bit depth. +

+
+ +

All expressions default to "x". +

+ +

30.121.1 Examples

+ +
    +
  • Highlight differences between two RGB video streams: +
    +
    lut2='ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,0,pow(2,bdx)-1)'
+
    + +
  • Highlight differences between two YUV video streams: +
    +
    lut2='ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,pow(2,bdx-1),pow(2,bdx)-1):ifnot(x-y,pow(2,bdx-1),pow(2,bdx)-1)'
+
    + +
  • Show max difference between two video streams: +
    +
    lut2='if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1))):if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1))):if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1)))'
+
    +
+ + +

30.122 maskedclamp

+ +

Clamp the first input stream with the second input and third input stream. +

+

Returns the value of first stream to be between second input +stream - undershoot and third input stream + overshoot. +

+

This filter accepts the following options: +

+
undershoot
+

Default value is 0. +

+
+
overshoot
+

Default value is 0. +

+
+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

30.123 maskedmax

+ +

Merge the second and third input stream into output stream using absolute differences +between second input stream and first input stream and absolute difference between +third input stream and first input stream. The picked value will be from second input +stream if second absolute difference is greater than first one or from third input stream +otherwise. +

+

This filter accepts the following options: +

+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

30.124 maskedmerge

+ +

Merge the first input stream with the second input stream using per pixel +weights in the third input stream. +

+

A value of 0 in the third stream pixel component means that pixel component +from first stream is returned unchanged, while maximum value (eg. 255 for +8-bit videos) means that pixel component from second stream is returned +unchanged. Intermediate values define the amount of merging between both +input stream’s pixel components. +

+

This filter accepts the following options: +

+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

30.125 maskedmin

+ +

Merge the second and third input stream into output stream using absolute differences +between second input stream and first input stream and absolute difference between +third input stream and first input stream. The picked value will be from second input +stream if second absolute difference is less than first one or from third input stream +otherwise. +

+

This filter accepts the following options: +

+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

30.126 maskedthreshold

+

Pick pixels comparing absolute difference of two video streams with fixed +threshold. +

+

If absolute difference between pixel component of first and second video +stream is equal or lower than user supplied threshold than pixel component +from first video stream is picked, otherwise pixel component from second +video stream is picked. +

+

This filter accepts the following options: +

+
threshold
+

Set threshold used when picking pixels from absolute difference from two input +video streams. +

+
+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from second stream. +By default value 0xf, all planes will be processed. +

+
+ + +

30.127 maskfun

+

Create mask from input video. +

+

For example it is useful to create motion masks after tblend filter. +

+

This filter accepts the following options: +

+
+
low
+

Set low threshold. Any pixel component lower or exact than this value will be set to 0. +

+
+
high
+

Set high threshold. Any pixel component higher than this value will be set to max value +allowed for current pixel format. +

+
+
planes
+

Set planes to filter, by default all available planes are filtered. +

+
+
fill
+

Fill all frame pixels with this value. +

+
+
sum
+

Set max average pixel value for frame. If sum of all pixel components is higher that this +average, output frame will be completely filled with value set by fill option. +Typically useful for scene changes when used in combination with tblend filter. +

+
+ + +

30.128 mcdeint

+ +

Apply motion-compensation deinterlacing. +

+

It needs one field per frame as input and must thus be used together +with yadif=1/3 or equivalent. +

+

This filter accepts the following options: +

+
mode
+

Set the deinterlacing mode. +

+

It accepts one of the following values: +

+
‘fast’
+
‘medium’
+
‘slow’
+

use iterative motion estimation +

+
‘extra_slow’
+

like ‘slow’, but use multiple reference frames. +

+
+

Default value is ‘fast’. +

+
+
parity
+

Set the picture field parity assumed for the input video. It must be +one of the following values: +

+
+
‘0, tff’
+

assume top field first +

+
‘1, bff’
+

assume bottom field first +

+
+ +

Default value is ‘bff’. +

+
+
qp
+

Set per-block quantization parameter (QP) used by the internal +encoder. +

+

Higher values should result in a smoother motion vector field but less +optimal individual vectors. Default value is 1. +

+
+ + +

30.129 median

+ +

Pick median pixel from certain rectangle defined by radius. +

+

This filter accepts the following options: +

+
+
radius
+

Set horizontal radius size. Default value is 1. +Allowed range is integer from 1 to 127. +

+
+
planes
+

Set which planes to process. Default is 15, which is all available planes. +

+
+
radiusV
+

Set vertical radius size. Default value is 0. +Allowed range is integer from 0 to 127. +If it is 0, value will be picked from horizontal radius option. +

+
+
percentile
+

Set median percentile. Default value is 0.5. +Default value of 0.5 will pick always median values, while 0 will pick +minimum values, and 1 maximum values. +

+
+ + +

30.129.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.130 mergeplanes

+ +

Merge color channel components from several video streams. +

+

The filter accepts up to 4 input streams, and merge selected input +planes to the output video. +

+

This filter accepts the following options: +

+
mapping
+

Set input to output plane mapping. Default is 0. +

+

The mappings is specified as a bitmap. It should be specified as a +hexadecimal number in the form 0xAa[Bb[Cc[Dd]]]. ’Aa’ describes the +mapping for the first plane of the output stream. ’A’ sets the number of +the input stream to use (from 0 to 3), and ’a’ the plane number of the +corresponding input to use (from 0 to 3). The rest of the mappings is +similar, ’Bb’ describes the mapping for the output stream second +plane, ’Cc’ describes the mapping for the output stream third plane and +’Dd’ describes the mapping for the output stream fourth plane. +

+
+
format
+

Set output pixel format. Default is yuva444p. +

+
+ + +

30.130.1 Examples

+ +
    +
  • Merge three gray video streams of same width and height into single video stream: +
    +
    [a0][a1][a2]mergeplanes=0x001020:yuv444p
+
    + +
  • Merge 1st yuv444p stream and 2nd gray video stream into yuva444p video stream: +
    +
    [a0][a1]mergeplanes=0x00010210:yuva444p
+
    + +
  • Swap Y and A plane in yuva444p stream: +
    +
    format=yuva444p,mergeplanes=0x03010200:yuva444p
+
    + +
  • Swap U and V plane in yuv420p stream: +
    +
    format=yuv420p,mergeplanes=0x000201:yuv420p
+
    + +
  • Cast a rgb24 clip to yuv444p: +
    +
    format=rgb24,mergeplanes=0x000102:yuv444p
+
    +
+ + +

30.131 mestimate

+ +

Estimate and export motion vectors using block matching algorithms. +Motion vectors are stored in frame side data to be used by other filters. +

+

This filter accepts the following options: +

+
method
+

Specify the motion estimation method. Accepts one of the following values: +

+
+
‘esa’
+

Exhaustive search algorithm. +

+
‘tss’
+

Three step search algorithm. +

+
‘tdls’
+

Two dimensional logarithmic search algorithm. +

+
‘ntss’
+

New three step search algorithm. +

+
‘fss’
+

Four step search algorithm. +

+
‘ds’
+

Diamond search algorithm. +

+
‘hexbs’
+

Hexagon-based search algorithm. +

+
‘epzs’
+

Enhanced predictive zonal search algorithm. +

+
‘umh’
+

Uneven multi-hexagon search algorithm. +

+
+

Default value is ‘esa’. +

+
+
mb_size
+

Macroblock size. Default 16. +

+
+
search_param
+

Search parameter. Default 7. +

+
+ + +

30.132 midequalizer

+ +

Apply Midway Image Equalization effect using two video streams. +

+

Midway Image Equalization adjusts a pair of images to have the same +histogram, while maintaining their dynamics as much as possible. It’s +useful for e.g. matching exposures from a pair of stereo cameras. +

+

This filter has two inputs and one output, which must be of same pixel format, but +may be of different sizes. The output of filter is first input adjusted with +midway histogram of both inputs. +

+

This filter accepts the following option: +

+
+
planes
+

Set which planes to process. Default is 15, which is all available planes. +

+
+ + +

30.133 minterpolate

+ +

Convert the video to specified frame rate using motion interpolation. +

+

This filter accepts the following options: +

+
fps
+

Specify the output frame rate. This can be rational e.g. 60000/1001. Frames are dropped if fps is lower than source fps. Default 60. +

+
+
mi_mode
+

Motion interpolation mode. Following values are accepted: +

+
‘dup’
+

Duplicate previous or next frame for interpolating new ones. +

+
‘blend’
+

Blend source frames. Interpolated frame is mean of previous and next frames. +

+
‘mci’
+

Motion compensated interpolation. Following options are effective when this mode is selected: +

+
+
‘mc_mode’
+

Motion compensation mode. Following values are accepted: +

+
‘obmc’
+

Overlapped block motion compensation. +

+
‘aobmc’
+

Adaptive overlapped block motion compensation. Window weighting coefficients are controlled adaptively according to the reliabilities of the neighboring motion vectors to reduce oversmoothing. +

+
+

Default mode is ‘obmc’. +

+
+
‘me_mode’
+

Motion estimation mode. Following values are accepted: +

+
‘bidir’
+

Bidirectional motion estimation. Motion vectors are estimated for each source frame in both forward and backward directions. +

+
‘bilat’
+

Bilateral motion estimation. Motion vectors are estimated directly for interpolated frame. +

+
+

Default mode is ‘bilat’. +

+
+
‘me’
+

The algorithm to be used for motion estimation. Following values are accepted: +

+
‘esa’
+

Exhaustive search algorithm. +

+
‘tss’
+

Three step search algorithm. +

+
‘tdls’
+

Two dimensional logarithmic search algorithm. +

+
‘ntss’
+

New three step search algorithm. +

+
‘fss’
+

Four step search algorithm. +

+
‘ds’
+

Diamond search algorithm. +

+
‘hexbs’
+

Hexagon-based search algorithm. +

+
‘epzs’
+

Enhanced predictive zonal search algorithm. +

+
‘umh’
+

Uneven multi-hexagon search algorithm. +

+
+

Default algorithm is ‘epzs’. +

+
+
‘mb_size’
+

Macroblock size. Default 16. +

+
+
‘search_param’
+

Motion estimation search parameter. Default 32. +

+
+
‘vsbmc’
+

Enable variable-size block motion compensation. Motion estimation is applied with smaller block sizes at object boundaries in order to make the them less blur. Default is 0 (disabled). +

+
+
+
+ +
+
scd
+

Scene change detection method. Scene change leads motion vectors to be in random direction. Scene change detection replace interpolated frames by duplicate ones. May not be needed for other modes. Following values are accepted: +

+
‘none’
+

Disable scene change detection. +

+
‘fdiff’
+

Frame difference. Corresponding pixel values are compared and if it satisfies scd_threshold scene change is detected. +

+
+

Default method is ‘fdiff’. +

+
+
scd_threshold
+

Scene change detection threshold. Default is 10.. +

+
+ + +

30.134 mix

+ +

Mix several video input streams into one video stream. +

+

A description of the accepted options follows. +

+
+
nb_inputs
+

The number of inputs. If unspecified, it defaults to 2. +

+
+
weights
+

Specify weight of each input video stream as sequence. +Each weight is separated by space. If number of weights +is smaller than number of frames last specified +weight will be used for all remaining unset weights. +

+
+
scale
+

Specify scale, if it is set it will be multiplied with sum +of each weight multiplied with pixel values to give final destination +pixel value. By default scale is auto scaled to sum of weights. +

+
+
duration
+

Specify how end of stream is determined. +

+
‘longest’
+

The duration of the longest input. (default) +

+
+
‘shortest’
+

The duration of the shortest input. +

+
+
‘first’
+

The duration of the first input. +

+
+
+
+ + +

30.135 mpdecimate

+ +

Drop frames that do not differ greatly from the previous frame in +order to reduce frame rate. +

+

The main use of this filter is for very-low-bitrate encoding +(e.g. streaming over dialup modem), but it could in theory be used for +fixing movies that were inverse-telecined incorrectly. +

+

A description of the accepted options follows. +

+
+
max
+

Set the maximum number of consecutive frames which can be dropped (if +positive), or the minimum interval between dropped frames (if +negative). If the value is 0, the frame is dropped disregarding the +number of previous sequentially dropped frames. +

+

Default value is 0. +

+
+
hi
+
lo
+
frac
+

Set the dropping threshold values. +

+

Values for hi and lo are for 8x8 pixel blocks and +represent actual pixel value differences, so a threshold of 64 +corresponds to 1 unit of difference for each pixel, or the same spread +out differently over the block. +

+

A frame is a candidate for dropping if no 8x8 blocks differ by more +than a threshold of hi, and if no more than frac blocks (1 +meaning the whole image) differ by more than a threshold of lo. +

+

Default value for hi is 64*12, default value for lo is +64*5, and default value for frac is 0.33. +

+
+ + + +

30.136 negate

+ +

Negate (invert) the input video. +

+

It accepts the following option: +

+
+
negate_alpha
+

With value 1, it negates the alpha component, if present. Default value is 0. +

+
+ + +

30.137 nlmeans

+ +

Denoise frames using Non-Local Means algorithm. +

+

Each pixel is adjusted by looking for other pixels with similar contexts. This +context similarity is defined by comparing their surrounding patches of size +pxp. Patches are searched in an area of rxr +around the pixel. +

+

Note that the research area defines centers for patches, which means some +patches will be made of pixels outside that research area. +

+

The filter accepts the following options. +

+
+
s
+

Set denoising strength. Default is 1.0. Must be in range [1.0, 30.0]. +

+
+
p
+

Set patch size. Default is 7. Must be odd number in range [0, 99]. +

+
+
pc
+

Same as p but for chroma planes. +

+

The default value is 0 and means automatic. +

+
+
r
+

Set research size. Default is 15. Must be odd number in range [0, 99]. +

+
+
rc
+

Same as r but for chroma planes. +

+

The default value is 0 and means automatic. +

+
+ + +

30.138 nnedi

+ +

Deinterlace video using neural network edge directed interpolation. +

+

This filter accepts the following options: +

+
+
weights
+

Mandatory option, without binary file filter can not work. +Currently file can be found here: +https://github.com/dubhater/vapoursynth-nnedi3/blob/master/src/nnedi3_weights.bin +

+
+
deint
+

Set which frames to deinterlace, by default it is all. +Can be all or interlaced. +

+
+
field
+

Set mode of operation. +

+

Can be one of the following: +

+
+
‘af’
+

Use frame flags, both fields. +

+
‘a’
+

Use frame flags, single field. +

+
‘t’
+

Use top field only. +

+
‘b’
+

Use bottom field only. +

+
‘tf’
+

Use both fields, top first. +

+
‘bf’
+

Use both fields, bottom first. +

+
+ +
+
planes
+

Set which planes to process, by default filter process all frames. +

+
+
nsize
+

Set size of local neighborhood around each pixel, used by the predictor neural +network. +

+

Can be one of the following: +

+
+
‘s8x6’
+
‘s16x6’
+
‘s32x6’
+
‘s48x6’
+
‘s8x4’
+
‘s16x4’
+
‘s32x4’
+
+ +
+
nns
+

Set the number of neurons in predictor neural network. +Can be one of the following: +

+
+
‘n16’
+
‘n32’
+
‘n64’
+
‘n128’
+
‘n256’
+
+ +
+
qual
+

Controls the number of different neural network predictions that are blended +together to compute the final output value. Can be fast, default or +slow. +

+
+
etype
+

Set which set of weights to use in the predictor. +Can be one of the following: +

+
+
‘a’
+

weights trained to minimize absolute error +

+
‘s’
+

weights trained to minimize squared error +

+
+ +
+
pscrn
+

Controls whether or not the prescreener neural network is used to decide +which pixels should be processed by the predictor neural network and which +can be handled by simple cubic interpolation. +The prescreener is trained to know whether cubic interpolation will be +sufficient for a pixel or whether it should be predicted by the predictor nn. +The computational complexity of the prescreener nn is much less than that of +the predictor nn. Since most pixels can be handled by cubic interpolation, +using the prescreener generally results in much faster processing. +The prescreener is pretty accurate, so the difference between using it and not +using it is almost always unnoticeable. +

+

Can be one of the following: +

+
+
‘none’
+
‘original’
+
‘new’
+
+ +

Default is new. +

+
+
fapprox
+

Set various debugging flags. +

+
+ + +

30.139 noformat

+ +

Force libavfilter not to use any of the specified pixel formats for the +input to the next filter. +

+

It accepts the following parameters: +

+
pix_fmts
+

A ’|’-separated list of pixel format names, such as +pix_fmts=yuv420p|monow|rgb24". +

+
+
+ + +

30.139.1 Examples

+ +
    +
  • Force libavfilter to use a format different from yuv420p for the +input to the vflip filter: +
    +
    noformat=pix_fmts=yuv420p,vflip
+
    + +
  • Convert the input video to any of the formats not contained in the list: +
    +
    noformat=yuv420p|yuv444p|yuv410p
+
    +
+ + +

30.140 noise

+ +

Add noise on video input frame. +

+

The filter accepts the following options: +

+
+
all_seed
+
c0_seed
+
c1_seed
+
c2_seed
+
c3_seed
+

Set noise seed for specific pixel component or all pixel components in case +of all_seed. Default value is 123457. +

+
+
all_strength, alls
+
c0_strength, c0s
+
c1_strength, c1s
+
c2_strength, c2s
+
c3_strength, c3s
+

Set noise strength for specific pixel component or all pixel components in case +all_strength. Default value is 0. Allowed range is [0, 100]. +

+
+
all_flags, allf
+
c0_flags, c0f
+
c1_flags, c1f
+
c2_flags, c2f
+
c3_flags, c3f
+

Set pixel component flags or set flags for all components if all_flags. +Available values for component flags are: +

+
‘a’
+

averaged temporal noise (smoother) +

+
‘p’
+

mix random noise with a (semi)regular pattern +

+
‘t’
+

temporal noise (noise pattern changes between frames) +

+
‘u’
+

uniform noise (gaussian otherwise) +

+
+
+
+ + +

30.140.1 Examples

+ +

Add temporal and uniform noise to input video: +

+
noise=alls=20:allf=t+u
+
+ + +

30.141 normalize

+ +

Normalize RGB video (aka histogram stretching, contrast stretching). +See: https://en.wikipedia.org/wiki/Normalization_(image_processing) +

+

For each channel of each frame, the filter computes the input range and maps +it linearly to the user-specified output range. The output range defaults +to the full dynamic range from pure black to pure white. +

+

Temporal smoothing can be used on the input range to reduce flickering (rapid +changes in brightness) caused when small dark or bright objects enter or leave +the scene. This is similar to the auto-exposure (automatic gain control) on a +video camera, and, like a video camera, it may cause a period of over- or +under-exposure of the video. +

+

The R,G,B channels can be normalized independently, which may cause some +color shifting, or linked together as a single channel, which prevents +color shifting. Linked normalization preserves hue. Independent normalization +does not, so it can be used to remove some color casts. Independent and linked +normalization can be combined in any ratio. +

+

The normalize filter accepts the following options: +

+
+
blackpt
+
whitept
+

Colors which define the output range. The minimum input value is mapped to +the blackpt. The maximum input value is mapped to the whitept. +The defaults are black and white respectively. Specifying white for +blackpt and black for whitept will give color-inverted, +normalized video. Shades of grey can be used to reduce the dynamic range +(contrast). Specifying saturated colors here can create some interesting +effects. +

+
+
smoothing
+

The number of previous frames to use for temporal smoothing. The input range +of each channel is smoothed using a rolling average over the current frame +and the smoothing previous frames. The default is 0 (no temporal +smoothing). +

+
+
independence
+

Controls the ratio of independent (color shifting) channel normalization to +linked (color preserving) normalization. 0.0 is fully linked, 1.0 is fully +independent. Defaults to 1.0 (fully independent). +

+
+
strength
+

Overall strength of the filter. 1.0 is full strength. 0.0 is a rather +expensive no-op. Defaults to 1.0 (full strength). +

+
+
+ + +

30.141.1 Commands

+

This filter supports same commands as options, excluding smoothing option. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.141.2 Examples

+ +

Stretch video contrast to use the full dynamic range, with no temporal +smoothing; may flicker depending on the source content: +

+
normalize=blackpt=black:whitept=white:smoothing=0
+
+ +

As above, but with 50 frames of temporal smoothing; flicker should be +reduced, depending on the source content: +

+
normalize=blackpt=black:whitept=white:smoothing=50
+
+ +

As above, but with hue-preserving linked channel normalization: +

+
normalize=blackpt=black:whitept=white:smoothing=50:independence=0
+
+ +

As above, but with half strength: +

+
normalize=blackpt=black:whitept=white:smoothing=50:independence=0:strength=0.5
+
+ +

Map the darkest input color to red, the brightest input color to cyan: +

+
normalize=blackpt=red:whitept=cyan
+
+ + +

30.142 null

+ +

Pass the video source unchanged to the output. +

+ +

30.143 ocr

+

Optical Character Recognition +

+

This filter uses Tesseract for optical character recognition. To enable +compilation of this filter, you need to configure FFmpeg with +--enable-libtesseract. +

+

It accepts the following options: +

+
+
datapath
+

Set datapath to tesseract data. Default is to use whatever was +set at installation. +

+
+
language
+

Set language, default is "eng". +

+
+
whitelist
+

Set character whitelist. +

+
+
blacklist
+

Set character blacklist. +

+
+ +

The filter exports recognized text as the frame metadata lavfi.ocr.text. +The filter exports confidence of recognized words as the frame metadata lavfi.ocr.confidence. +

+ +

30.144 ocv

+ +

Apply a video transform using libopencv. +

+

To enable this filter, install the libopencv library and headers and +configure FFmpeg with --enable-libopencv. +

+

It accepts the following parameters: +

+
+
filter_name
+

The name of the libopencv filter to apply. +

+
+
filter_params
+

The parameters to pass to the libopencv filter. If not specified, the default +values are assumed. +

+
+
+ +

Refer to the official libopencv documentation for more precise +information: +http://docs.opencv.org/master/modules/imgproc/doc/filtering.html +

+

Several libopencv filters are supported; see the following subsections. +

+ +

30.144.1 dilate

+ +

Dilate an image by using a specific structuring element. +It corresponds to the libopencv function cvDilate. +

+

It accepts the parameters: struct_el|nb_iterations. +

+

struct_el represents a structuring element, and has the syntax: +colsxrows+anchor_xxanchor_y/shape +

+

cols and rows represent the number of columns and rows of +the structuring element, anchor_x and anchor_y the anchor +point, and shape the shape for the structuring element. shape +must be "rect", "cross", "ellipse", or "custom". +

+

If the value for shape is "custom", it must be followed by a +string of the form "=filename". The file with name +filename is assumed to represent a binary image, with each +printable character corresponding to a bright pixel. When a custom +shape is used, cols and rows are ignored, the number +or columns and rows of the read file are assumed instead. +

+

The default value for struct_el is "3x3+0x0/rect". +

+

nb_iterations specifies the number of times the transform is +applied to the image, and defaults to 1. +

+

Some examples: +

+
# Use the default values
+ocv=dilate
+
+# Dilate using a structuring element with a 5x5 cross, iterating two times
+ocv=filter_name=dilate:filter_params=5x5+2x2/cross|2
+
+# Read the shape from the file diamond.shape, iterating two times.
+# The file diamond.shape may contain a pattern of characters like this
+#   *
+#  ***
+# *****
+#  ***
+#   *
+# The specified columns and rows are ignored
+# but the anchor point coordinates are not
+ocv=dilate:0x0+2x2/custom=diamond.shape|2
+
+ + +

30.144.2 erode

+ +

Erode an image by using a specific structuring element. +It corresponds to the libopencv function cvErode. +

+

It accepts the parameters: struct_el:nb_iterations, +with the same syntax and semantics as the dilate filter. +

+ +

30.144.3 smooth

+ +

Smooth the input video. +

+

The filter takes the following parameters: +type|param1|param2|param3|param4. +

+

type is the type of smooth filter to apply, and must be one of +the following values: "blur", "blur_no_scale", "median", "gaussian", +or "bilateral". The default value is "gaussian". +

+

The meaning of param1, param2, param3, and param4 +depends on the smooth type. param1 and +param2 accept integer positive values or 0. param3 and +param4 accept floating point values. +

+

The default value for param1 is 3. The default value for the +other parameters is 0. +

+

These parameters correspond to the parameters assigned to the +libopencv function cvSmooth. +

+ +

30.145 oscilloscope

+ +

2D Video Oscilloscope. +

+

Useful to measure spatial impulse, step responses, chroma delays, etc. +

+

It accepts the following parameters: +

+
+
x
+

Set scope center x position. +

+
+
y
+

Set scope center y position. +

+
+
s
+

Set scope size, relative to frame diagonal. +

+
+
t
+

Set scope tilt/rotation. +

+
+
o
+

Set trace opacity. +

+
+
tx
+

Set trace center x position. +

+
+
ty
+

Set trace center y position. +

+
+
tw
+

Set trace width, relative to width of frame. +

+
+
th
+

Set trace height, relative to height of frame. +

+
+
c
+

Set which components to trace. By default it traces first three components. +

+
+
g
+

Draw trace grid. By default is enabled. +

+
+
st
+

Draw some statistics. By default is enabled. +

+
+
sc
+

Draw scope. By default is enabled. +

+
+ + +

30.145.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

30.145.2 Examples

+ +
    +
  • Inspect full first row of video frame. +
    +
    oscilloscope=x=0.5:y=0:s=1
+
    + +
  • Inspect full last row of video frame. +
    +
    oscilloscope=x=0.5:y=1:s=1
+
    + +
  • Inspect full 5th line of video frame of height 1080. +
    +
    oscilloscope=x=0.5:y=5/1080:s=1
+
    + +
  • Inspect full last column of video frame. +
    +
    oscilloscope=x=1:y=0.5:s=1:t=1
+
    + +
+ + +

30.146 overlay

+ +

Overlay one video on top of another. +

+

It takes two inputs and has one output. The first input is the "main" +video on which the second input is overlaid. +

+

It accepts the following parameters: +

+

A description of the accepted options follows. +

+
+
x
+
y
+

Set the expression for the x and y coordinates of the overlaid video +on the main video. Default value is "0" for both expressions. In case +the expression is invalid, it is set to a huge value (meaning that the +overlay will not be displayed within the output visible area). +

+
+
eof_action
+

See framesync. +

+
+
eval
+

Set when the expressions for x, and y are evaluated. +

+

It accepts the following values: +

+
‘init’
+

only evaluate expressions once during the filter initialization or +when a command is processed +

+
+
‘frame’
+

evaluate expressions for each incoming frame +

+
+ +

Default value is ‘frame’. +

+
+
shortest
+

See framesync. +

+
+
format
+

Set the format for the output video. +

+

It accepts the following values: +

+
‘yuv420’
+

force YUV420 output +

+
+
‘yuv422’
+

force YUV422 output +

+
+
‘yuv444’
+

force YUV444 output +

+
+
‘rgb’
+

force packed RGB output +

+
+
‘gbrp’
+

force planar RGB output +

+
+
‘auto’
+

automatically pick format +

+
+ +

Default value is ‘yuv420’. +

+
+
repeatlast
+

See framesync. +

+
+
alpha
+

Set format of alpha of the overlaid video, it can be straight or +premultiplied. Default is straight. +

+
+ +

The x, and y expressions can contain the following +parameters. +

+
+
main_w, W
+
main_h, H
+

The main input width and height. +

+
+
overlay_w, w
+
overlay_h, h
+

The overlay input width and height. +

+
+
x
+
y
+

The computed values for x and y. They are evaluated for +each new frame. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values of the output +format. For example for the pixel format "yuv422p" hsub is 2 and +vsub is 1. +

+
+
n
+

the number of input frame, starting from 0 +

+
+
pos
+

the position in the file of the input frame, NAN if unknown +

+
+
t
+

The timestamp, expressed in seconds. It’s NAN if the input timestamp is unknown. +

+
+
+ +

This filter also supports the framesync options. +

+

Note that the n, pos, t variables are available only +when evaluation is done per frame, and will evaluate to NAN +when eval is set to ‘init’. +

+

Be aware that frames are taken from each input video in timestamp +order, hence, if their initial timestamps differ, it is a good idea +to pass the two inputs through a setpts=PTS-STARTPTS filter to +have them begin in the same zero timestamp, as the example for +the movie filter does. +

+

You can chain together more overlays but you should test the +efficiency of such approach. +

+ +

30.146.1 Commands

+ +

This filter supports the following commands: +

+
x
+
y
+

Modify the x and y of the overlay input. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

30.146.2 Examples

+ +
    +
  • Draw the overlay at 10 pixels from the bottom right corner of the main +video: +
    +
    overlay=main_w-overlay_w-10:main_h-overlay_h-10
+
    + +

    Using named options the example above becomes: +

    +
    overlay=x=main_w-overlay_w-10:y=main_h-overlay_h-10
+
    + +
  • Insert a transparent PNG logo in the bottom left corner of the input, +using the ffmpeg tool with the -filter_complex option: +
    +
    ffmpeg -i input -i logo -filter_complex 'overlay=10:main_h-overlay_h-10' output
+
    + +
  • Insert 2 different transparent PNG logos (second logo on bottom +right corner) using the ffmpeg tool: +
    +
    ffmpeg -i input -i logo1 -i logo2 -filter_complex 'overlay=x=10:y=H-h-10,overlay=x=W-w-10:y=H-h-10' output
+
    + +
  • Add a transparent color layer on top of the main video; WxH +must specify the size of the main input to the overlay filter: +
    +
    color=color=red@.3:size=WxH [over]; [in][over] overlay [out]
+
    + +
  • Play an original video and a filtered version (here with the deshake +filter) side by side using the ffplay tool: +
    +
    ffplay input.avi -vf 'split[a][b]; [a]pad=iw*2:ih[src]; [b]deshake[filt]; [src][filt]overlay=w'
+
    + +

    The above command is the same as: +

    +
    ffplay input.avi -vf 'split[b], pad=iw*2[src], [b]deshake, [src]overlay=w'
+
    + +
  • Make a sliding overlay appearing from the left to the right top part of the +screen starting since time 2: +
    +
    overlay=x='if(gte(t,2), -w+(t-2)*20, NAN)':y=0
+
    + +
  • Compose output by putting two input videos side to side: +
    +
    ffmpeg -i left.avi -i right.avi -filter_complex "
+nullsrc=size=200x100 [background];
+[0:v] setpts=PTS-STARTPTS, scale=100x100 [left];
+[1:v] setpts=PTS-STARTPTS, scale=100x100 [right];
+[background][left]       overlay=shortest=1       [background+left];
+[background+left][right] overlay=shortest=1:x=100 [left+right]
+"
+
    + +
  • Mask 10-20 seconds of a video by applying the delogo filter to a section +
    +
    ffmpeg -i test.avi -codec:v:0 wmv2 -ar 11025 -b:v 9000k
+-vf '[in]split[split_main][split_delogo];[split_delogo]trim=start=360:end=371,delogo=0:0:640:480[delogoed];[split_main][delogoed]overlay=eof_action=pass[out]'
+masked.avi
+
    + +
  • Chain several overlays in cascade: +
    +
    nullsrc=s=200x200 [bg];
+testsrc=s=100x100, split=4 [in0][in1][in2][in3];
+[in0] lutrgb=r=0, [bg]   overlay=0:0     [mid0];
+[in1] lutrgb=g=0, [mid0] overlay=100:0   [mid1];
+[in2] lutrgb=b=0, [mid1] overlay=0:100   [mid2];
+[in3] null,       [mid2] overlay=100:100 [out0]
+
    + +
+ + +

30.147 overlay_cuda

+ +

Overlay one video on top of another. +

+

This is the CUDA cariant of the overlay filter. +It only accepts CUDA frames. The underlying input pixel formats have to match. +

+

It takes two inputs and has one output. The first input is the "main" +video on which the second input is overlaid. +

+

It accepts the following parameters: +

+
+
x
+
y
+

Set the x and y coordinates of the overlaid video on the main video. +Default value is "0" for both expressions. +

+
+
eof_action
+

See framesync. +

+
+
shortest
+

See framesync. +

+
+
repeatlast
+

See framesync. +

+
+
+ +

This filter also supports the framesync options. +

+ +

30.148 owdenoise

+ +

Apply Overcomplete Wavelet denoiser. +

+

The filter accepts the following options: +

+
+
depth
+

Set depth. +

+

Larger depth values will denoise lower frequency components more, but +slow down filtering. +

+

Must be an int in the range 8-16, default is 8. +

+
+
luma_strength, ls
+

Set luma strength. +

+

Must be a double value in the range 0-1000, default is 1.0. +

+
+
chroma_strength, cs
+

Set chroma strength. +

+

Must be a double value in the range 0-1000, default is 1.0. +

+
+ + +

30.149 pad

+ +

Add paddings to the input image, and place the original input at the +provided x, y coordinates. +

+

It accepts the following parameters: +

+
+
width, w
+
height, h
+

Specify an expression for the size of the output image with the +paddings added. If the value for width or height is 0, the +corresponding input size is used for the output. +

+

The width expression can reference the value set by the +height expression, and vice versa. +

+

The default value of width and height is 0. +

+
+
x
+
y
+

Specify the offsets to place the input image at within the padded area, +with respect to the top/left border of the output image. +

+

The x expression can reference the value set by the y +expression, and vice versa. +

+

The default value of x and y is 0. +

+

If x or y evaluate to a negative number, they’ll be changed +so the input image is centered on the padded area. +

+
+
color
+

Specify the color of the padded area. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. +

+

The default value of color is "black". +

+
+
eval
+

Specify when to evaluate width, height, x and y expression. +

+

It accepts the following values: +

+
+
‘init’
+

Only evaluate expressions once during the filter initialization or when +a command is processed. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. +

+
+
+ +

Default value is ‘init’. +

+
+
aspect
+

Pad to aspect instead to a resolution. +

+
+
+ +

The value for the width, height, x, and y +options are expressions containing the following constants: +

+
+
in_w
+
in_h
+

The input video width and height. +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output width and height (the size of the padded area), as +specified by the width and height expressions. +

+
+
ow
+
oh
+

These are the same as out_w and out_h. +

+
+
x
+
y
+

The x and y offsets as specified by the x and y +expressions, or NAN if not yet specified. +

+
+
a
+

same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (iw / ih) * sar +

+
+
hsub
+
vsub
+

The horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+ + +

30.149.1 Examples

+ +
    +
  • Add paddings with the color "violet" to the input video. The output video +size is 640x480, and the top-left corner of the input video is placed at +column 0, row 40 +
    +
    pad=640:480:0:40:violet
+
    + +

    The example above is equivalent to the following command: +

    +
    pad=width=640:height=480:x=0:y=40:color=violet
+
    + +
  • Pad the input to get an output with dimensions increased by 3/2, +and put the input video at the center of the padded area: +
    +
    pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • Pad the input to get a squared output with size equal to the maximum +value between the input width and height, and put the input video at +the center of the padded area: +
    +
    pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • Pad the input to get a final w/h ratio of 16:9: +
    +
    pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • In case of anamorphic video, in order to set the output display aspect +correctly, it is necessary to use sar in the expression, +according to the relation: +
    +
    (ih * X / ih) * sar = output_dar
+X = output_dar / sar
+
    + +

    Thus the previous example needs to be modified to: +

    +
    pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • Double the output size and put the input video in the bottom-right +corner of the output padded area: +
    +
    pad="2*iw:2*ih:ow-iw:oh-ih"
+
    +
+ + +

30.150 palettegen

+ +

Generate one palette for a whole video stream. +

+

It accepts the following options: +

+
+
max_colors
+

Set the maximum number of colors to quantize in the palette. +Note: the palette will still contain 256 colors; the unused palette entries +will be black. +

+
+
reserve_transparent
+

Create a palette of 255 colors maximum and reserve the last one for +transparency. Reserving the transparency color is useful for GIF optimization. +If not set, the maximum of colors in the palette will be 256. You probably want +to disable this option for a standalone image. +Set by default. +

+
+
transparency_color
+

Set the color that will be used as background for transparency. +

+
+
stats_mode
+

Set statistics mode. +

+

It accepts the following values: +

+
‘full’
+

Compute full frame histograms. +

+
‘diff’
+

Compute histograms only for the part that differs from previous frame. This +might be relevant to give more importance to the moving part of your input if +the background is static. +

+
‘single’
+

Compute new histogram for each frame. +

+
+ +

Default value is full. +

+
+ +

The filter also exports the frame metadata lavfi.color_quant_ratio +(nb_color_in / nb_color_out) which you can use to evaluate the degree of +color quantization of the palette. This information is also visible at +info logging level. +

+ +

30.150.1 Examples

+ +
    +
  • Generate a representative palette of a given video using ffmpeg: +
    +
    ffmpeg -i input.mkv -vf palettegen palette.png
+
    +
+ + +

30.151 paletteuse

+ +

Use a palette to downsample an input video stream. +

+

The filter takes two inputs: one video stream and a palette. The palette must +be a 256 pixels image. +

+

It accepts the following options: +

+
+
dither
+

Select dithering mode. Available algorithms are: +

+
‘bayer’
+

Ordered 8x8 bayer dithering (deterministic) +

+
‘heckbert’
+

Dithering as defined by Paul Heckbert in 1982 (simple error diffusion). +Note: this dithering is sometimes considered "wrong" and is included as a +reference. +

+
‘floyd_steinberg’
+

Floyd and Steingberg dithering (error diffusion) +

+
‘sierra2’
+

Frankie Sierra dithering v2 (error diffusion) +

+
‘sierra2_4a’
+

Frankie Sierra dithering v2 "Lite" (error diffusion) +

+
+ +

Default is sierra2_4a. +

+
+
bayer_scale
+

When bayer dithering is selected, this option defines the scale of the +pattern (how much the crosshatch pattern is visible). A low value means more +visible pattern for less banding, and higher value means less visible pattern +at the cost of more banding. +

+

The option must be an integer value in the range [0,5]. Default is 2. +

+
+
diff_mode
+

If set, define the zone to process +

+
+
‘rectangle’
+

Only the changing rectangle will be reprocessed. This is similar to GIF +cropping/offsetting compression mechanism. This option can be useful for speed +if only a part of the image is changing, and has use cases such as limiting the +scope of the error diffusal dither to the rectangle that bounds the +moving scene (it leads to more deterministic output if the scene doesn’t change +much, and as a result less moving noise and better GIF compression). +

+
+ +

Default is none. +

+
+
new
+

Take new palette for each output frame. +

+
+
alpha_threshold
+

Sets the alpha threshold for transparency. Alpha values above this threshold +will be treated as completely opaque, and values below this threshold will be +treated as completely transparent. +

+

The option must be an integer value in the range [0,255]. Default is 128. +

+
+ + +

30.151.1 Examples

+ +
    +
  • Use a palette (generated for example with palettegen) to encode a GIF +using ffmpeg: +
    +
    ffmpeg -i input.mkv -i palette.png -lavfi paletteuse output.gif
+
    +
+ + +

30.152 perspective

+ +

Correct perspective of video not recorded perpendicular to the screen. +

+

A description of the accepted parameters follows. +

+
+
x0
+
y0
+
x1
+
y1
+
x2
+
y2
+
x3
+
y3
+

Set coordinates expression for top left, top right, bottom left and bottom right corners. +Default values are 0:0:W:0:0:H:W:H with which perspective will remain unchanged. +If the sense option is set to source, then the specified points will be sent +to the corners of the destination. If the sense option is set to destination, +then the corners of the source will be sent to the specified coordinates. +

+

The expressions can use the following variables: +

+
+
W
+
H
+

the width and height of video frame. +

+
in
+

Input frame count. +

+
on
+

Output frame count. +

+
+ +
+
interpolation
+

Set interpolation for perspective correction. +

+

It accepts the following values: +

+
‘linear’
+
‘cubic’
+
+ +

Default value is ‘linear’. +

+
+
sense
+

Set interpretation of coordinate options. +

+

It accepts the following values: +

+
‘0, source’
+
+

Send point in the source specified by the given coordinates to +the corners of the destination. +

+
+
‘1, destination’
+
+

Send the corners of the source to the point in the destination specified +by the given coordinates. +

+

Default value is ‘source’. +

+
+ +
+
eval
+

Set when the expressions for coordinates x0,y0,...x3,y3 are evaluated. +

+

It accepts the following values: +

+
‘init’
+

only evaluate expressions once during the filter initialization or +when a command is processed +

+
+
‘frame’
+

evaluate expressions for each incoming frame +

+
+ +

Default value is ‘init’. +

+
+ + +

30.153 phase

+ +

Delay interlaced video by one field time so that the field order changes. +

+

The intended use is to fix PAL movies that have been captured with the +opposite field order to the film-to-video transfer. +

+

A description of the accepted parameters follows. +

+
+
mode
+

Set phase mode. +

+

It accepts the following values: +

+
‘t’
+

Capture field order top-first, transfer bottom-first. +Filter will delay the bottom field. +

+
+
‘b’
+

Capture field order bottom-first, transfer top-first. +Filter will delay the top field. +

+
+
‘p’
+

Capture and transfer with the same field order. This mode only exists +for the documentation of the other options to refer to, but if you +actually select it, the filter will faithfully do nothing. +

+
+
‘a’
+

Capture field order determined automatically by field flags, transfer +opposite. +Filter selects among ‘t’ and ‘b’ modes on a frame by frame +basis using field flags. If no field information is available, +then this works just like ‘u’. +

+
+
‘u’
+

Capture unknown or varying, transfer opposite. +Filter selects among ‘t’ and ‘b’ on a frame by frame basis by +analyzing the images and selecting the alternative that produces best +match between the fields. +

+
+
‘T’
+

Capture top-first, transfer unknown or varying. +Filter selects among ‘t’ and ‘p’ using image analysis. +

+
+
‘B’
+

Capture bottom-first, transfer unknown or varying. +Filter selects among ‘b’ and ‘p’ using image analysis. +

+
+
‘A’
+

Capture determined by field flags, transfer unknown or varying. +Filter selects among ‘t’, ‘b’ and ‘p’ using field flags and +image analysis. If no field information is available, then this works just +like ‘U’. This is the default mode. +

+
+
‘U’
+

Both capture and transfer unknown or varying. +Filter selects among ‘t’, ‘b’ and ‘p’ using image analysis only. +

+
+
+
+ + +

30.154 photosensitivity

+

Reduce various flashes in video, so to help users with epilepsy. +

+

It accepts the following options: +

+
frames, f
+

Set how many frames to use when filtering. Default is 30. +

+
+
threshold, t
+

Set detection threshold factor. Default is 1. +Lower is stricter. +

+
+
skip
+

Set how many pixels to skip when sampling frames. Default is 1. +Allowed range is from 1 to 1024. +

+
+
bypass
+

Leave frames unchanged. Default is disabled. +

+
+ + +

30.155 pixdesctest

+ +

Pixel format descriptor test filter, mainly useful for internal +testing. The output video should be equal to the input video. +

+

For example: +

+
format=monow, pixdesctest
+
+ +

can be used to test the monowhite pixel format descriptor definition. +

+ +

30.156 pixscope

+ +

Display sample values of color channels. Mainly useful for checking color +and levels. Minimum supported resolution is 640x480. +

+

The filters accept the following options: +

+
+
x
+

Set scope X position, relative offset on X axis. +

+
+
y
+

Set scope Y position, relative offset on Y axis. +

+
+
w
+

Set scope width. +

+
+
h
+

Set scope height. +

+
+
o
+

Set window opacity. This window also holds statistics about pixel area. +

+
+
wx
+

Set window X position, relative offset on X axis. +

+
+
wy
+

Set window Y position, relative offset on Y axis. +

+
+ + +

30.157 pp

+ +

Enable the specified chain of postprocessing subfilters using libpostproc. This +library should be automatically selected with a GPL build (--enable-gpl). +Subfilters must be separated by ’/’ and can be disabled by prepending a ’-’. +Each subfilter and some options have a short and a long name that can be used +interchangeably, i.e. dr/dering are the same. +

+

The filters accept the following options: +

+
+
subfilters
+

Set postprocessing subfilters string. +

+
+ +

All subfilters share common options to determine their scope: +

+
+
a/autoq
+

Honor the quality commands for this subfilter. +

+
+
c/chrom
+

Do chrominance filtering, too (default). +

+
+
y/nochrom
+

Do luminance filtering only (no chrominance). +

+
+
n/noluma
+

Do chrominance filtering only (no luminance). +

+
+ +

These options can be appended after the subfilter name, separated by a ’|’. +

+

Available subfilters are: +

+
+
hb/hdeblock[|difference[|flatness]]
+

Horizontal deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+ +
+
vb/vdeblock[|difference[|flatness]]
+

Vertical deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+ +
+
ha/hadeblock[|difference[|flatness]]
+

Accurate horizontal deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+ +
+
va/vadeblock[|difference[|flatness]]
+

Accurate vertical deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+
+
+ +

The horizontal and vertical deblocking filters share the difference and +flatness values so you cannot set different horizontal and vertical +thresholds. +

+
+
h1/x1hdeblock
+

Experimental horizontal deblocking filter +

+
+
v1/x1vdeblock
+

Experimental vertical deblocking filter +

+
+
dr/dering
+

Deringing filter +

+
+
tn/tmpnoise[|threshold1[|threshold2[|threshold3]]], temporal noise reducer
+
+
threshold1
+

larger -> stronger filtering +

+
threshold2
+

larger -> stronger filtering +

+
threshold3
+

larger -> stronger filtering +

+
+ +
+
al/autolevels[:f/fullyrange], automatic brightness / contrast correction
+
+
f/fullyrange
+

Stretch luminance to 0-255. +

+
+ +
+
lb/linblenddeint
+

Linear blend deinterlacing filter that deinterlaces the given block by +filtering all lines with a (1 2 1) filter. +

+
+
li/linipoldeint
+

Linear interpolating deinterlacing filter that deinterlaces the given block by +linearly interpolating every second line. +

+
+
ci/cubicipoldeint
+

Cubic interpolating deinterlacing filter deinterlaces the given block by +cubically interpolating every second line. +

+
+
md/mediandeint
+

Median deinterlacing filter that deinterlaces the given block by applying a +median filter to every second line. +

+
+
fd/ffmpegdeint
+

FFmpeg deinterlacing filter that deinterlaces the given block by filtering every +second line with a (-1 4 2 4 -1) filter. +

+
+
l5/lowpass5
+

Vertically applied FIR lowpass deinterlacing filter that deinterlaces the given +block by filtering all lines with a (-1 2 6 2 -1) filter. +

+
+
fq/forceQuant[|quantizer]
+

Overrides the quantizer table from the input with the constant quantizer you +specify. +

+
quantizer
+

Quantizer to use +

+
+ +
+
de/default
+

Default pp filter combination (hb|a,vb|a,dr|a) +

+
+
fa/fast
+

Fast pp filter combination (h1|a,v1|a,dr|a) +

+
+
ac
+

High quality pp filter combination (ha|a|128|7,va|a,dr|a) +

+
+ + +

30.157.1 Examples

+ +
    +
  • Apply horizontal and vertical deblocking, deringing and automatic +brightness/contrast: +
    +
    pp=hb/vb/dr/al
+
    + +
  • Apply default filters without brightness/contrast correction: +
    +
    pp=de/-al
+
    + +
  • Apply default filters and temporal denoiser: +
    +
    pp=default/tmpnoise|1|2|3
+
    + +
  • Apply deblocking on luminance only, and switch vertical deblocking on or off +automatically depending on available CPU time: +
    +
    pp=hb|y/vb|a
+
    +
+ + +

30.158 pp7

+

Apply Postprocessing filter 7. It is variant of the spp filter, +similar to spp = 6 with 7 point DCT, where only the center sample is +used after IDCT. +

+

The filter accepts the following options: +

+
+
qp
+

Force a constant quantization parameter. It accepts an integer in range +0 to 63. If not set, the filter will use the QP from the video stream +(if available). +

+
+
mode
+

Set thresholding mode. Available modes are: +

+
+
‘hard’
+

Set hard thresholding. +

+
‘soft’
+

Set soft thresholding (better de-ringing effect, but likely blurrier). +

+
‘medium’
+

Set medium thresholding (good results, default). +

+
+
+
+ + +

30.159 premultiply

+

Apply alpha premultiply effect to input video stream using first plane +of second stream as alpha. +

+

Both streams must have same dimensions and same pixel format. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
inplace
+

Do not require 2nd input for processing, instead use alpha plane from input stream. +

+
+ + +

30.160 prewitt

+

Apply prewitt operator to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +

+
+
delta
+

Set value which will be added to filtered result. +

+
+ + +

30.161 pseudocolor

+ +

Alter frame colors in video with pseudocolors. +

+

This filter accepts the following options: +

+
+
c0
+

set pixel first component expression +

+
+
c1
+

set pixel second component expression +

+
+
c2
+

set pixel third component expression +

+
+
c3
+

set pixel fourth component expression, corresponds to the alpha component +

+
+
i
+

set component to use as base for altering colors +

+
+ +

Each of them specifies the expression to use for computing the lookup table for +the corresponding pixel component values. +

+

The expressions can contain the following constants and functions: +

+
+
w
+
h
+

The input width and height. +

+
+
val
+

The input value for the pixel component. +

+
+
ymin, umin, vmin, amin
+

The minimum allowed component value. +

+
+
ymax, umax, vmax, amax
+

The maximum allowed component value. +

+
+ +

All expressions default to "val". +

+ +

30.161.1 Examples

+ +
    +
  • Change too high luma values to gradient: +
    +
    pseudocolor="'if(between(val,ymax,amax),lerp(ymin,ymax,(val-ymax)/(amax-ymax)),-1):if(between(val,ymax,amax),lerp(umax,umin,(val-ymax)/(amax-ymax)),-1):if(between(val,ymax,amax),lerp(vmin,vmax,(val-ymax)/(amax-ymax)),-1):-1'"
+
    +
+ + +

30.162 psnr

+ +

Obtain the average, maximum and minimum PSNR (Peak Signal to Noise +Ratio) between two input videos. +

+

This filter takes in input two input videos, the first input is +considered the "main" source and is passed unchanged to the +output. The second input is used as a "reference" video for computing +the PSNR. +

+

Both video inputs must have the same resolution and pixel format for +this filter to work correctly. Also it assumes that both inputs +have the same number of frames, which are compared one by one. +

+

The obtained average PSNR is printed through the logging system. +

+

The filter stores the accumulated MSE (mean squared error) of each +frame, and at the end of the processing it is averaged across all frames +equally, and the following formula is applied to obtain the PSNR: +

+
+
PSNR = 10*log10(MAX^2/MSE)
+
+ +

Where MAX is the average of the maximum values of each component of the +image. +

+

The description of the accepted parameters follows. +

+
+
stats_file, f
+

If specified the filter will use the named file to save the PSNR of +each individual frame. When filename equals "-" the data is sent to +standard output. +

+
+
stats_version
+

Specifies which version of the stats file format to use. Details of +each format are written below. +Default value is 1. +

+
+
stats_add_max
+

Determines whether the max value is output to the stats log. +Default value is 0. +Requires stats_version >= 2. If this is set and stats_version < 2, +the filter will return an error. +

+
+ +

This filter also supports the framesync options. +

+

The file printed if stats_file is selected, contains a sequence of +key/value pairs of the form key:value for each compared +couple of frames. +

+

If a stats_version greater than 1 is specified, a header line precedes +the list of per-frame-pair stats, with key value pairs following the frame +format with the following parameters: +

+
+
psnr_log_version
+

The version of the log file format. Will match stats_version. +

+
+
fields
+

A comma separated list of the per-frame-pair parameters included in +the log. +

+
+ +

A description of each shown per-frame-pair parameter follows: +

+
+
n
+

sequential number of the input frame, starting from 1 +

+
+
mse_avg
+

Mean Square Error pixel-by-pixel average difference of the compared +frames, averaged over all the image components. +

+
+
mse_y, mse_u, mse_v, mse_r, mse_g, mse_b, mse_a
+

Mean Square Error pixel-by-pixel average difference of the compared +frames for the component specified by the suffix. +

+
+
psnr_y, psnr_u, psnr_v, psnr_r, psnr_g, psnr_b, psnr_a
+

Peak Signal to Noise ratio of the compared frames for the component +specified by the suffix. +

+
+
max_avg, max_y, max_u, max_v
+

Maximum allowed value for each channel, and average over all +channels. +

+
+ + +

30.162.1 Examples

+
    +
  • For example: +
    +
    movie=ref_movie.mpg, setpts=PTS-STARTPTS [main];
+[main][ref] psnr="stats_file=stats.log" [out]
+
    + +

    On this example the input file being processed is compared with the +reference file ref_movie.mpg. The PSNR of each individual frame +is stored in stats.log. +

    +
  • Another example with different containers: +
    +
    ffmpeg -i main.mpg -i ref.mkv -lavfi  "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]psnr" -f null -
+
    +
+ + +

30.163 pullup

+ +

Pulldown reversal (inverse telecine) filter, capable of handling mixed +hard-telecine, 24000/1001 fps progressive, and 30000/1001 fps progressive +content. +

+

The pullup filter is designed to take advantage of future context in making +its decisions. This filter is stateless in the sense that it does not lock +onto a pattern to follow, but it instead looks forward to the following +fields in order to identify matches and rebuild progressive frames. +

+

To produce content with an even framerate, insert the fps filter after +pullup, use fps=24000/1001 if the input frame rate is 29.97fps, +fps=24 for 30fps and the (rare) telecined 25fps input. +

+

The filter accepts the following options: +

+
+
jl
+
jr
+
jt
+
jb
+

These options set the amount of "junk" to ignore at the left, right, top, and +bottom of the image, respectively. Left and right are in units of 8 pixels, +while top and bottom are in units of 2 lines. +The default is 8 pixels on each side. +

+
+
sb
+

Set the strict breaks. Setting this option to 1 will reduce the chances of +filter generating an occasional mismatched frame, but it may also cause an +excessive number of frames to be dropped during high motion sequences. +Conversely, setting it to -1 will make filter match fields more easily. +This may help processing of video where there is slight blurring between +the fields, but may also cause there to be interlaced frames in the output. +Default value is 0. +

+
+
mp
+

Set the metric plane to use. It accepts the following values: +

+
‘l’
+

Use luma plane. +

+
+
‘u’
+

Use chroma blue plane. +

+
+
‘v’
+

Use chroma red plane. +

+
+ +

This option may be set to use chroma plane instead of the default luma plane +for doing filter’s computations. This may improve accuracy on very clean +source material, but more likely will decrease accuracy, especially if there +is chroma noise (rainbow effect) or any grayscale video. +The main purpose of setting mp to a chroma plane is to reduce CPU +load and make pullup usable in realtime on slow machines. +

+
+ +

For best results (without duplicated frames in the output file) it is +necessary to change the output frame rate. For example, to inverse +telecine NTSC input: +

+
ffmpeg -i input -vf pullup -r 24000/1001 ...
+
+ + +

30.164 qp

+ +

Change video quantization parameters (QP). +

+

The filter accepts the following option: +

+
+
qp
+

Set expression for quantization parameter. +

+
+ +

The expression is evaluated through the eval API and can contain, among others, +the following constants: +

+
+
known
+

1 if index is not 129, 0 otherwise. +

+
+
qp
+

Sequential index starting from -129 to 128. +

+
+ + +

30.164.1 Examples

+ +
    +
  • Some equation like: +
    +
    qp=2+2*sin(PI*qp)
+
    +
+ + +

30.165 random

+ +

Flush video frames from internal cache of frames into a random order. +No frame is discarded. +Inspired by frei0r nervous filter. +

+
+
frames
+

Set size in number of frames of internal cache, in range from 2 to +512. Default is 30. +

+
+
seed
+

Set seed for random number generator, must be an integer included between +0 and UINT32_MAX. If not specified, or if explicitly set to +less than 0, the filter will try to use a good random seed on a +best effort basis. +

+
+ + +

30.166 readeia608

+ +

Read closed captioning (EIA-608) information from the top lines of a video frame. +

+

This filter adds frame metadata for lavfi.readeia608.X.cc and +lavfi.readeia608.X.line, where X is the number of the identified line +with EIA-608 data (starting from 0). A description of each metadata value follows: +

+
+
lavfi.readeia608.X.cc
+

The two bytes stored as EIA-608 data (printed in hexadecimal). +

+
+
lavfi.readeia608.X.line
+

The number of the line on which the EIA-608 data was identified and read. +

+
+ +

This filter accepts the following options: +

+
+
scan_min
+

Set the line to start scanning for EIA-608 data. Default is 0. +

+
+
scan_max
+

Set the line to end scanning for EIA-608 data. Default is 29. +

+
+
spw
+

Set the ratio of width reserved for sync code detection. +Default is 0.27. Allowed range is [0.1 - 0.7]. +

+
+
chp
+

Enable checking the parity bit. In the event of a parity error, the filter will output +0x00 for that character. Default is false. +

+
+
lp
+

Lowpass lines prior to further processing. Default is enabled. +

+
+ + +

30.166.1 Examples

+ +
    +
  • Output a csv with presentation time and the first two lines of identified EIA-608 captioning data. +
    +
    ffprobe -f lavfi -i movie=captioned_video.mov,readeia608 -show_entries frame=pkt_pts_time:frame_tags=lavfi.readeia608.0.cc,lavfi.readeia608.1.cc -of csv
+
    +
+ + +

30.167 readvitc

+ +

Read vertical interval timecode (VITC) information from the top lines of a +video frame. +

+

The filter adds frame metadata key lavfi.readvitc.tc_str with the +timecode value, if a valid timecode has been detected. Further metadata key +lavfi.readvitc.found is set to 0/1 depending on whether +timecode data has been found or not. +

+

This filter accepts the following options: +

+
+
scan_max
+

Set the maximum number of lines to scan for VITC data. If the value is set to +-1 the full video frame is scanned. Default is 45. +

+
+
thr_b
+

Set the luma threshold for black. Accepts float numbers in the range [0.0,1.0], +default value is 0.2. The value must be equal or less than thr_w. +

+
+
thr_w
+

Set the luma threshold for white. Accepts float numbers in the range [0.0,1.0], +default value is 0.6. The value must be equal or greater than thr_b. +

+
+ + +

30.167.1 Examples

+ +
    +
  • Detect and draw VITC data onto the video frame; if no valid VITC is detected, +draw --:--:--:-- as a placeholder: +
    +
    ffmpeg -i input.avi -filter:v 'readvitc,drawtext=fontfile=FreeMono.ttf:text=%{metadata\\:lavfi.readvitc.tc_str\\:--\\\\\\:--\\\\\\:--\\\\\\:--}:x=(w-tw)/2:y=400-ascent'
+
    +
+ + +

30.168 remap

+ +

Remap pixels using 2nd: Xmap and 3rd: Ymap input video stream. +

+

Destination pixel at position (X, Y) will be picked from source (x, y) position +where x = Xmap(X, Y) and y = Ymap(X, Y). If mapping values are out of range, zero +value for pixel will be used for destination pixel. +

+

Xmap and Ymap input video streams must be of same dimensions. Output video stream +will have Xmap/Ymap video stream dimensions. +Xmap and Ymap input video streams are 16bit depth, single channel. +

+
+
format
+

Specify pixel format of output from this filter. Can be color or gray. +Default is color. +

+
+
fill
+

Specify the color of the unmapped pixels. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. Default color is black. +

+
+ + +

30.169 removegrain

+ +

The removegrain filter is a spatial denoiser for progressive video. +

+
+
m0
+

Set mode for the first plane. +

+
+
m1
+

Set mode for the second plane. +

+
+
m2
+

Set mode for the third plane. +

+
+
m3
+

Set mode for the fourth plane. +

+
+ +

Range of mode is from 0 to 24. Description of each mode follows: +

+
+
0
+

Leave input plane unchanged. Default. +

+
+
1
+

Clips the pixel with the minimum and maximum of the 8 neighbour pixels. +

+
+
2
+

Clips the pixel with the second minimum and maximum of the 8 neighbour pixels. +

+
+
3
+

Clips the pixel with the third minimum and maximum of the 8 neighbour pixels. +

+
+
4
+

Clips the pixel with the fourth minimum and maximum of the 8 neighbour pixels. +This is equivalent to a median filter. +

+
+
5
+

Line-sensitive clipping giving the minimal change. +

+
+
6
+

Line-sensitive clipping, intermediate. +

+
+
7
+

Line-sensitive clipping, intermediate. +

+
+
8
+

Line-sensitive clipping, intermediate. +

+
+
9
+

Line-sensitive clipping on a line where the neighbours pixels are the closest. +

+
+
10
+

Replaces the target pixel with the closest neighbour. +

+
+
11
+

[1 2 1] horizontal and vertical kernel blur. +

+
+
12
+

Same as mode 11. +

+
+
13
+

Bob mode, interpolates top field from the line where the neighbours +pixels are the closest. +

+
+
14
+

Bob mode, interpolates bottom field from the line where the neighbours +pixels are the closest. +

+
+
15
+

Bob mode, interpolates top field. Same as 13 but with a more complicated +interpolation formula. +

+
+
16
+

Bob mode, interpolates bottom field. Same as 14 but with a more complicated +interpolation formula. +

+
+
17
+

Clips the pixel with the minimum and maximum of respectively the maximum and +minimum of each pair of opposite neighbour pixels. +

+
+
18
+

Line-sensitive clipping using opposite neighbours whose greatest distance from +the current pixel is minimal. +

+
+
19
+

Replaces the pixel with the average of its 8 neighbours. +

+
+
20
+

Averages the 9 pixels ([1 1 1] horizontal and vertical blur). +

+
+
21
+

Clips pixels using the averages of opposite neighbour. +

+
+
22
+

Same as mode 21 but simpler and faster. +

+
+
23
+

Small edge and halo removal, but reputed useless. +

+
+
24
+

Similar as 23. +

+
+ + +

30.170 removelogo

+ +

Suppress a TV station logo, using an image file to determine which +pixels comprise the logo. It works by filling in the pixels that +comprise the logo with neighboring pixels. +

+

The filter accepts the following options: +

+
+
filename, f
+

Set the filter bitmap file, which can be any image format supported by +libavformat. The width and height of the image file must match those of the +video stream being processed. +

+
+ +

Pixels in the provided bitmap image with a value of zero are not +considered part of the logo, non-zero pixels are considered part of +the logo. If you use white (255) for the logo and black (0) for the +rest, you will be safe. For making the filter bitmap, it is +recommended to take a screen capture of a black frame with the logo +visible, and then using a threshold filter followed by the erode +filter once or twice. +

+

If needed, little splotches can be fixed manually. Remember that if +logo pixels are not covered, the filter quality will be much +reduced. Marking too many pixels as part of the logo does not hurt as +much, but it will increase the amount of blurring needed to cover over +the image and will destroy more information than necessary, and extra +pixels will slow things down on a large logo. +

+ +

30.171 repeatfields

+ +

This filter uses the repeat_field flag from the Video ES headers and hard repeats +fields based on its value. +

+ +

30.172 reverse

+ +

Reverse a video clip. +

+

Warning: This filter requires memory to buffer the entire clip, so trimming +is suggested. +

+ +

30.172.1 Examples

+ +
    +
  • Take the first 5 seconds of a clip, and reverse it. +
    +
    trim=end=5,reverse
+
    +
+ + +

30.173 rgbashift

+

Shift R/G/B/A pixels horizontally and/or vertically. +

+

The filter accepts the following options: +

+
rh
+

Set amount to shift red horizontally. +

+
rv
+

Set amount to shift red vertically. +

+
gh
+

Set amount to shift green horizontally. +

+
gv
+

Set amount to shift green vertically. +

+
bh
+

Set amount to shift blue horizontally. +

+
bv
+

Set amount to shift blue vertically. +

+
ah
+

Set amount to shift alpha horizontally. +

+
av
+

Set amount to shift alpha vertically. +

+
edge
+

Set edge mode, can be smear, default, or warp. +

+
+ + +

30.173.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

30.174 roberts

+

Apply roberts cross operator to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +

+
+
delta
+

Set value which will be added to filtered result. +

+
+ + +

30.175 rotate

+ +

Rotate video by an arbitrary angle expressed in radians. +

+

The filter accepts the following options: +

+

A description of the optional parameters follows. +

+
angle, a
+

Set an expression for the angle by which to rotate the input video +clockwise, expressed as a number of radians. A negative value will +result in a counter-clockwise rotation. By default it is set to "0". +

+

This expression is evaluated for each frame. +

+
+
out_w, ow
+

Set the output width expression, default value is "iw". +This expression is evaluated just once during configuration. +

+
+
out_h, oh
+

Set the output height expression, default value is "ih". +This expression is evaluated just once during configuration. +

+
+
bilinear
+

Enable bilinear interpolation if set to 1, a value of 0 disables +it. Default value is 1. +

+
+
fillcolor, c
+

Set the color used to fill the output area not covered by the rotated +image. For the general syntax of this option, check the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +If the special value "none" is selected then no +background is printed (useful for example if the background is never shown). +

+

Default value is "black". +

+
+ +

The expressions for the angle and the output size can contain the +following constants and functions: +

+
+
n
+

sequential number of the input frame, starting from 0. It is always NAN +before the first frame is filtered. +

+
+
t
+

time in seconds of the input frame, it is set to 0 when the filter is +configured. It is always NAN before the first frame is filtered. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
in_w, iw
+
in_h, ih
+

the input video width and height +

+
+
out_w, ow
+
out_h, oh
+

the output width and height, that is the size of the padded area as +specified by the width and height expressions +

+
+
rotw(a)
+
roth(a)
+

the minimal width/height required for completely containing the input +video rotated by a radians. +

+

These are only available when computing the out_w and +out_h expressions. +

+
+ + +

30.175.1 Examples

+ +
    +
  • Rotate the input by PI/6 radians clockwise: +
    +
    rotate=PI/6
+
    + +
  • Rotate the input by PI/6 radians counter-clockwise: +
    +
    rotate=-PI/6
+
    + +
  • Rotate the input by 45 degrees clockwise: +
    +
    rotate=45*PI/180
+
    + +
  • Apply a constant rotation with period T, starting from an angle of PI/3: +
    +
    rotate=PI/3+2*PI*t/T
+
    + +
  • Make the input video rotation oscillating with a period of T +seconds and an amplitude of A radians: +
    +
    rotate=A*sin(2*PI/T*t)
+
    + +
  • Rotate the video, output size is chosen so that the whole rotating +input video is always completely contained in the output: +
    +
    rotate='2*PI*t:ow=hypot(iw,ih):oh=ow'
+
    + +
  • Rotate the video, reduce the output size so that no background is ever +shown: +
    +
    rotate=2*PI*t:ow='min(iw,ih)/sqrt(2)':oh=ow:c=none
+
    +
+ + +

30.175.2 Commands

+ +

The filter supports the following commands: +

+
+
a, angle
+

Set the angle expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

30.176 sab

+ +

Apply Shape Adaptive Blur. +

+

The filter accepts the following options: +

+
+
luma_radius, lr
+

Set luma blur filter strength, must be a value in range 0.1-4.0, default +value is 1.0. A greater value will result in a more blurred image, and +in slower processing. +

+
+
luma_pre_filter_radius, lpfr
+

Set luma pre-filter radius, must be a value in the 0.1-2.0 range, default +value is 1.0. +

+
+
luma_strength, ls
+

Set luma maximum difference between pixels to still be considered, must +be a value in the 0.1-100.0 range, default value is 1.0. +

+
+
chroma_radius, cr
+

Set chroma blur filter strength, must be a value in range -0.9-4.0. A +greater value will result in a more blurred image, and in slower +processing. +

+
+
chroma_pre_filter_radius, cpfr
+

Set chroma pre-filter radius, must be a value in the -0.9-2.0 range. +

+
+
chroma_strength, cs
+

Set chroma maximum difference between pixels to still be considered, +must be a value in the -0.9-100.0 range. +

+
+ +

Each chroma option value, if not explicitly specified, is set to the +corresponding luma option value. +

+ +

30.177 scale

+ +

Scale (resize) the input video, using the libswscale library. +

+

The scale filter forces the output display aspect ratio to be the same +of the input, by changing the output sample aspect ratio. +

+

If the input image format is different from the format requested by +the next filter, the scale filter will convert the input to the +requested format. +

+ +

30.177.1 Options

+

The filter accepts the following options, or any of the options +supported by the libswscale scaler. +

+

See (ffmpeg-scaler)the ffmpeg-scaler manual for +the complete list of scaler options. +

+
+
width, w
+
height, h
+

Set the output video dimension expression. Default value is the input +dimension. +

+

If the width or w value is 0, the input width is used for +the output. If the height or h value is 0, the input height +is used for the output. +

+

If one and only one of the values is -n with n >= 1, the scale filter +will use a value that maintains the aspect ratio of the input image, +calculated from the other specified dimension. After that it will, +however, make sure that the calculated dimension is divisible by n and +adjust the value if necessary. +

+

If both values are -n with n >= 1, the behavior will be identical to +both values being set to 0 as previously detailed. +

+

See below for the list of accepted constants for use in the dimension +expression. +

+
+
eval
+

Specify when to evaluate width and height expression. It accepts the following values: +

+
+
‘init’
+

Only evaluate expressions once during the filter initialization or when a command is processed. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. +

+
+
+ +

Default value is ‘init’. +

+ +
+
interl
+

Set the interlacing mode. It accepts the following values: +

+
+
‘1’
+

Force interlaced aware scaling. +

+
+
‘0’
+

Do not apply interlaced scaling. +

+
+
‘-1’
+

Select interlaced aware scaling depending on whether the source frames +are flagged as interlaced or not. +

+
+ +

Default value is ‘0’. +

+
+
flags
+

Set libswscale scaling flags. See +(ffmpeg-scaler)the ffmpeg-scaler manual for the +complete list of values. If not explicitly specified the filter applies +the default flags. +

+ +
+
param0, param1
+

Set libswscale input parameters for scaling algorithms that need them. See +(ffmpeg-scaler)the ffmpeg-scaler manual for the +complete documentation. If not explicitly specified the filter applies +empty parameters. +

+ + +
+
size, s
+

Set the video size. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
in_color_matrix
+
out_color_matrix
+

Set in/output YCbCr color space type. +

+

This allows the autodetected value to be overridden as well as allows forcing +a specific value used for the output and encoder. +

+

If not specified, the color space type depends on the pixel format. +

+

Possible values: +

+
+
‘auto’
+

Choose automatically. +

+
+
‘bt709’
+

Format conforming to International Telecommunication Union (ITU) +Recommendation BT.709. +

+
+
‘fcc’
+

Set color space conforming to the United States Federal Communications +Commission (FCC) Code of Federal Regulations (CFR) Title 47 (2003) 73.682 (a). +

+
+
‘bt601’
+
‘bt470’
+
‘smpte170m’
+

Set color space conforming to: +

+
    +
  • ITU Radiocommunication Sector (ITU-R) Recommendation BT.601 + +
  • ITU-R Rec. BT.470-6 (1998) Systems B, B1, and G + +
  • Society of Motion Picture and Television Engineers (SMPTE) ST 170:2004 + +
+ +
+
‘smpte240m’
+

Set color space conforming to SMPTE ST 240:1999. +

+
+
‘bt2020’
+

Set color space conforming to ITU-R BT.2020 non-constant luminance system. +

+
+ +
+
in_range
+
out_range
+

Set in/output YCbCr sample range. +

+

This allows the autodetected value to be overridden as well as allows forcing +a specific value used for the output and encoder. If not specified, the +range depends on the pixel format. Possible values: +

+
+
‘auto/unknown’
+

Choose automatically. +

+
+
‘jpeg/full/pc’
+

Set full range (0-255 in case of 8-bit luma). +

+
+
‘mpeg/limited/tv’
+

Set "MPEG" range (16-235 in case of 8-bit luma). +

+
+ +
+
force_original_aspect_ratio
+

Enable decreasing or increasing output video width or height if necessary to +keep the original aspect ratio. Possible values: +

+
+
‘disable’
+

Scale the video as specified and disable this feature. +

+
+
‘decrease’
+

The output video dimensions will automatically be decreased if needed. +

+
+
‘increase’
+

The output video dimensions will automatically be increased if needed. +

+
+
+ +

One useful instance of this option is that when you know a specific device’s +maximum allowed resolution, you can use this to limit the output video to +that, while retaining the aspect ratio. For example, device A allows +1280x720 playback, and your video is 1920x800. Using this option (set it to +decrease) and specifying 1280x720 to the command line makes the output +1280x533. +

+

Please note that this is a different thing than specifying -1 for w +or h, you still need to specify the output resolution for this option +to work. +

+
+
force_divisible_by
+

Ensures that both the output dimensions, width and height, are divisible by the +given integer when used together with force_original_aspect_ratio. This +works similar to using -n in the w and h options. +

+

This option respects the value set for force_original_aspect_ratio, +increasing or decreasing the resolution accordingly. The video’s aspect ratio +may be slightly modified. +

+

This option can be handy if you need to have a video fit within or exceed +a defined resolution using force_original_aspect_ratio but also have +encoder restrictions on width or height divisibility. +

+
+
+ +

The values of the w and h options are expressions +containing the following constants: +

+
+
in_w
+
in_h
+

The input width and height +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output (scaled) width and height +

+
+
ow
+
oh
+

These are the same as out_w and out_h +

+
+
a
+

The same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

The input display aspect ratio. Calculated from (iw / ih) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical input chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
ohsub
+
ovsub
+

horizontal and vertical output chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
n
+

The (sequential) number of the input frame, starting from 0. +Only available with eval=frame. +

+
+
t
+

The presentation timestamp of the input frame, expressed as a number of +seconds. Only available with eval=frame. +

+
+
pos
+

The position (byte offset) of the frame in the input stream, or NaN if +this information is unavailable and/or meaningless (for example in case of synthetic video). +Only available with eval=frame. +

+
+ + +

30.177.2 Examples

+ +
    +
  • Scale the input video to a size of 200x100 +
    +
    scale=w=200:h=100
+
    + +

    This is equivalent to: +

    +
    scale=200:100
+
    + +

    or: +

    +
    scale=200x100
+
    + +
  • Specify a size abbreviation for the output size: +
    +
    scale=qcif
+
    + +

    which can also be written as: +

    +
    scale=size=qcif
+
    + +
  • Scale the input to 2x: +
    +
    scale=w=2*iw:h=2*ih
+
    + +
  • The above is the same as: +
    +
    scale=2*in_w:2*in_h
+
    + +
  • Scale the input to 2x with forced interlaced scaling: +
    +
    scale=2*iw:2*ih:interl=1
+
    + +
  • Scale the input to half size: +
    +
    scale=w=iw/2:h=ih/2
+
    + +
  • Increase the width, and set the height to the same size: +
    +
    scale=3/2*iw:ow
+
    + +
  • Seek Greek harmony: +
    +
    scale=iw:1/PHI*iw
+scale=ih*PHI:ih
+
    + +
  • Increase the height, and set the width to 3/2 of the height: +
    +
    scale=w=3/2*oh:h=3/5*ih
+
    + +
  • Increase the size, making the size a multiple of the chroma +subsample values: +
    +
    scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
+
    + +
  • Increase the width to a maximum of 500 pixels, +keeping the same aspect ratio as the input: +
    +
    scale=w='min(500\, iw*3/2):h=-1'
+
    + +
  • Make pixels square by combining scale and setsar: +
    +
    scale='trunc(ih*dar):ih',setsar=1/1
+
    + +
  • Make pixels square by combining scale and setsar, +making sure the resulting resolution is even (required by some codecs): +
    +
    scale='trunc(ih*dar/2)*2:trunc(ih/2)*2',setsar=1/1
+
    +
+ + +

30.177.3 Commands

+ +

This filter supports the following commands: +

+
width, w
+
height, h
+

Set the output video dimension expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

30.178 scale_npp

+ +

Use the NVIDIA Performance Primitives (libnpp) to perform scaling and/or pixel +format conversion on CUDA video frames. Setting the output width and height +works in the same way as for the scale filter. +

+

The following additional options are accepted: +

+
format
+

The pixel format of the output CUDA frames. If set to the string "same" (the +default), the input format will be kept. Note that automatic format negotiation +and conversion is not yet supported for hardware frames +

+
+
interp_algo
+

The interpolation algorithm used for resizing. One of the following: +

+
nn
+

Nearest neighbour. +

+
+
linear
+
cubic
+
cubic2p_bspline
+

2-parameter cubic (B=1, C=0) +

+
+
cubic2p_catmullrom
+

2-parameter cubic (B=0, C=1/2) +

+
+
cubic2p_b05c03
+

2-parameter cubic (B=1/2, C=3/10) +

+
+
super
+

Supersampling +

+
+
lanczos
+
+ +
+
force_original_aspect_ratio
+

Enable decreasing or increasing output video width or height if necessary to +keep the original aspect ratio. Possible values: +

+
+
‘disable’
+

Scale the video as specified and disable this feature. +

+
+
‘decrease’
+

The output video dimensions will automatically be decreased if needed. +

+
+
‘increase’
+

The output video dimensions will automatically be increased if needed. +

+
+
+ +

One useful instance of this option is that when you know a specific device’s +maximum allowed resolution, you can use this to limit the output video to +that, while retaining the aspect ratio. For example, device A allows +1280x720 playback, and your video is 1920x800. Using this option (set it to +decrease) and specifying 1280x720 to the command line makes the output +1280x533. +

+

Please note that this is a different thing than specifying -1 for w +or h, you still need to specify the output resolution for this option +to work. +

+
+
force_divisible_by
+

Ensures that both the output dimensions, width and height, are divisible by the +given integer when used together with force_original_aspect_ratio. This +works similar to using -n in the w and h options. +

+

This option respects the value set for force_original_aspect_ratio, +increasing or decreasing the resolution accordingly. The video’s aspect ratio +may be slightly modified. +

+

This option can be handy if you need to have a video fit within or exceed +a defined resolution using force_original_aspect_ratio but also have +encoder restrictions on width or height divisibility. +

+
+
+ + +

30.179 scale2ref

+ +

Scale (resize) the input video, based on a reference video. +

+

See the scale filter for available options, scale2ref supports the same but +uses the reference video instead of the main input as basis. scale2ref also +supports the following additional constants for the w and +h options: +

+
+
main_w
+
main_h
+

The main input video’s width and height +

+
+
main_a
+

The same as main_w / main_h +

+
+
main_sar
+

The main input video’s sample aspect ratio +

+
+
main_dar, mdar
+

The main input video’s display aspect ratio. Calculated from +(main_w / main_h) * main_sar. +

+
+
main_hsub
+
main_vsub
+

The main input video’s horizontal and vertical chroma subsample values. +For example for the pixel format "yuv422p" hsub is 2 and vsub +is 1. +

+
+
main_n
+

The (sequential) number of the main input frame, starting from 0. +Only available with eval=frame. +

+
+
main_t
+

The presentation timestamp of the main input frame, expressed as a number of +seconds. Only available with eval=frame. +

+
+
main_pos
+

The position (byte offset) of the frame in the main input stream, or NaN if +this information is unavailable and/or meaningless (for example in case of synthetic video). +Only available with eval=frame. +

+
+ + +

30.179.1 Examples

+ +
    +
  • Scale a subtitle stream (b) to match the main video (a) in size before overlaying +
    +
    'scale2ref[b][a];[a][b]overlay'
+
    + +
  • Scale a logo to 1/10th the height of a video, while preserving its display aspect ratio. +
    +
    [logo-in][video-in]scale2ref=w=oh*mdar:h=ih/10[logo-out][video-out]
+
    +
+ + +

30.179.2 Commands

+ +

This filter supports the following commands: +

+
width, w
+
height, h
+

Set the output video dimension expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

30.180 scroll

+

Scroll input video horizontally and/or vertically by constant speed. +

+

The filter accepts the following options: +

+
horizontal, h
+

Set the horizontal scrolling speed. Default is 0. Allowed range is from -1 to 1. +Negative values changes scrolling direction. +

+
+
vertical, v
+

Set the vertical scrolling speed. Default is 0. Allowed range is from -1 to 1. +Negative values changes scrolling direction. +

+
+
hpos
+

Set the initial horizontal scrolling position. Default is 0. Allowed range is from 0 to 1. +

+
+
vpos
+

Set the initial vertical scrolling position. Default is 0. Allowed range is from 0 to 1. +

+
+ + +

30.180.1 Commands

+ +

This filter supports the following commands: +

+
horizontal, h
+

Set the horizontal scrolling speed. +

+
vertical, v
+

Set the vertical scrolling speed. +

+
+ + +

30.181 scdet

+ +

Detect video scene change. +

+

This filter sets frame metadata with mafd between frame, the scene score, and +forward the frame to the next filter, so they can use these metadata to detect +scene change or others. +

+

In addition, this filter logs a message and sets frame metadata when it detects +a scene change by threshold. +

+

lavfi.scd.mafd metadata keys are set with mafd for every frame. +

+

lavfi.scd.score metadata keys are set with scene change score for every frame +to detect scene change. +

+

lavfi.scd.time metadata keys are set with current filtered frame time which +detect scene change with threshold. +

+

The filter accepts the following options: +

+
+
threshold, t
+

Set the scene change detection threshold as a percentage of maximum change. Good +values are in the [8.0, 14.0] range. The range for threshold is +[0., 100.]. +

+

Default value is 10.. +

+
+
sc_pass, s
+

Set the flag to pass scene change frames to the next filter. Default value is 0 +You can enable it if you want to get snapshot of scene change frames only. +

+
+ + +

30.182 selectivecolor

+ +

Adjust cyan, magenta, yellow and black (CMYK) to certain ranges of colors (such +as "reds", "yellows", "greens", "cyans", ...). The adjustment range is defined +by the "purity" of the color (that is, how saturated it already is). +

+

This filter is similar to the Adobe Photoshop Selective Color tool. +

+

The filter accepts the following options: +

+
+
correction_method
+

Select color correction method. +

+

Available values are: +

+
‘absolute’
+

Specified adjustments are applied "as-is" (added/subtracted to original pixel +component value). +

+
‘relative’
+

Specified adjustments are relative to the original component value. +

+
+

Default is absolute. +

+
reds
+

Adjustments for red pixels (pixels where the red component is the maximum) +

+
yellows
+

Adjustments for yellow pixels (pixels where the blue component is the minimum) +

+
greens
+

Adjustments for green pixels (pixels where the green component is the maximum) +

+
cyans
+

Adjustments for cyan pixels (pixels where the red component is the minimum) +

+
blues
+

Adjustments for blue pixels (pixels where the blue component is the maximum) +

+
magentas
+

Adjustments for magenta pixels (pixels where the green component is the minimum) +

+
whites
+

Adjustments for white pixels (pixels where all components are greater than 128) +

+
neutrals
+

Adjustments for all pixels except pure black and pure white +

+
blacks
+

Adjustments for black pixels (pixels where all components are lesser than 128) +

+
psfile
+

Specify a Photoshop selective color file (.asv) to import the settings from. +

+
+ +

All the adjustment settings (reds, yellows, ...) accept up to +4 space separated floating point adjustment values in the [-1,1] range, +respectively to adjust the amount of cyan, magenta, yellow and black for the +pixels of its range. +

+ +

30.182.1 Examples

+ +
    +
  • Increase cyan by 50% and reduce yellow by 33% in every green areas, and +increase magenta by 27% in blue areas: +
    +
    selectivecolor=greens=.5 0 -.33 0:blues=0 .27
+
    + +
  • Use a Photoshop selective color preset: +
    +
    selectivecolor=psfile=MySelectiveColorPresets/Misty.asv
+
    +
+ + +

30.183 separatefields

+ +

The separatefields takes a frame-based video input and splits +each frame into its components fields, producing a new half height clip +with twice the frame rate and twice the frame count. +

+

This filter use field-dominance information in frame to decide which +of each pair of fields to place first in the output. +If it gets it wrong use setfield filter before separatefields filter. +

+ +

30.184 setdar, setsar

+ +

The setdar filter sets the Display Aspect Ratio for the filter +output video. +

+

This is done by changing the specified Sample (aka Pixel) Aspect +Ratio, according to the following equation: +

+
DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR
+
+ +

Keep in mind that the setdar filter does not modify the pixel +dimensions of the video frame. Also, the display aspect ratio set by +this filter may be changed by later filters in the filterchain, +e.g. in case of scaling or if another "setdar" or a "setsar" filter is +applied. +

+

The setsar filter sets the Sample (aka Pixel) Aspect Ratio for +the filter output video. +

+

Note that as a consequence of the application of this filter, the +output display aspect ratio will change according to the equation +above. +

+

Keep in mind that the sample aspect ratio set by the setsar +filter may be changed by later filters in the filterchain, e.g. if +another "setsar" or a "setdar" filter is applied. +

+

It accepts the following parameters: +

+
+
r, ratio, dar (setdar only), sar (setsar only)
+

Set the aspect ratio used by the filter. +

+

The parameter can be a floating point number string, an expression, or +a string of the form num:den, where num and +den are the numerator and denominator of the aspect ratio. If +the parameter is not specified, it is assumed the value "0". +In case the form "num:den" is used, the : character +should be escaped. +

+
+
max
+

Set the maximum integer value to use for expressing numerator and +denominator when reducing the expressed aspect ratio to a rational. +Default value is 100. +

+
+
+ +

The parameter sar is an expression containing +the following constants: +

+
+
E, PI, PHI
+

These are approximated values for the mathematical constants e +(Euler’s number), pi (Greek pi), and phi (the golden ratio). +

+
+
w, h
+

The input width and height. +

+
+
a
+

These are the same as w / h. +

+
+
sar
+

The input sample aspect ratio. +

+
+
dar
+

The input display aspect ratio. It is the same as +(w / h) * sar. +

+
+
hsub, vsub
+

Horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+ + +

30.184.1 Examples

+ +
    +
  • To change the display aspect ratio to 16:9, specify one of the following: +
    +
    setdar=dar=1.77777
+setdar=dar=16/9
+
    + +
  • To change the sample aspect ratio to 10:11, specify: +
    +
    setsar=sar=10/11
+
    + +
  • To set a display aspect ratio of 16:9, and specify a maximum integer value of +1000 in the aspect ratio reduction, use the command: +
    +
    setdar=ratio=16/9:max=1000
+
    + +
+ + +

30.185 setfield

+ +

Force field for the output video frame. +

+

The setfield filter marks the interlace type field for the +output frames. It does not change the input frame, but only sets the +corresponding property, which affects how the frame is treated by +following filters (e.g. fieldorder or yadif). +

+

The filter accepts the following options: +

+
+
mode
+

Available values are: +

+
+
‘auto’
+

Keep the same field property. +

+
+
‘bff’
+

Mark the frame as bottom-field-first. +

+
+
‘tff’
+

Mark the frame as top-field-first. +

+
+
‘prog’
+

Mark the frame as progressive. +

+
+
+
+ + +

30.186 setparams

+ +

Force frame parameter for the output video frame. +

+

The setparams filter marks interlace and color range for the +output frames. It does not change the input frame, but only sets the +corresponding property, which affects how the frame is treated by +filters/encoders. +

+
+
field_mode
+

Available values are: +

+
+
‘auto’
+

Keep the same field property (default). +

+
+
‘bff’
+

Mark the frame as bottom-field-first. +

+
+
‘tff’
+

Mark the frame as top-field-first. +

+
+
‘prog’
+

Mark the frame as progressive. +

+
+ +
+
range
+

Available values are: +

+
+
‘auto’
+

Keep the same color range property (default). +

+
+
‘unspecified, unknown’
+

Mark the frame as unspecified color range. +

+
+
‘limited, tv, mpeg’
+

Mark the frame as limited range. +

+
+
‘full, pc, jpeg’
+

Mark the frame as full range. +

+
+ +
+
color_primaries
+

Set the color primaries. +Available values are: +

+
+
‘auto’
+

Keep the same color primaries property (default). +

+
+
‘bt709’
+
‘unknown’
+
‘bt470m’
+
‘bt470bg’
+
‘smpte170m’
+
‘smpte240m’
+
‘film’
+
‘bt2020’
+
‘smpte428’
+
‘smpte431’
+
‘smpte432’
+
‘jedec-p22’
+
+ +
+
color_trc
+

Set the color transfer. +Available values are: +

+
+
‘auto’
+

Keep the same color trc property (default). +

+
+
‘bt709’
+
‘unknown’
+
‘bt470m’
+
‘bt470bg’
+
‘smpte170m’
+
‘smpte240m’
+
‘linear’
+
‘log100’
+
‘log316’
+
‘iec61966-2-4’
+
‘bt1361e’
+
‘iec61966-2-1’
+
‘bt2020-10’
+
‘bt2020-12’
+
‘smpte2084’
+
‘smpte428’
+
‘arib-std-b67’
+
+ +
+
colorspace
+

Set the colorspace. +Available values are: +

+
+
‘auto’
+

Keep the same colorspace property (default). +

+
+
‘gbr’
+
‘bt709’
+
‘unknown’
+
‘fcc’
+
‘bt470bg’
+
‘smpte170m’
+
‘smpte240m’
+
‘ycgco’
+
‘bt2020nc’
+
‘bt2020c’
+
‘smpte2085’
+
‘chroma-derived-nc’
+
‘chroma-derived-c’
+
‘ictcp’
+
+
+
+ + +

30.187 showinfo

+ +

Show a line containing various information for each input video frame. +The input video is not modified. +

+

This filter supports the following options: +

+
+
checksum
+

Calculate checksums of each plane. By default enabled. +

+
+ +

The shown line contains a sequence of key/value pairs of the form +key:value. +

+

The following values are shown in the output: +

+
+
n
+

The (sequential) number of the input frame, starting from 0. +

+
+
pts
+

The Presentation TimeStamp of the input frame, expressed as a number of +time base units. The time base unit depends on the filter input pad. +

+
+
pts_time
+

The Presentation TimeStamp of the input frame, expressed as a number of +seconds. +

+
+
pos
+

The position of the frame in the input stream, or -1 if this information is +unavailable and/or meaningless (for example in case of synthetic video). +

+
+
fmt
+

The pixel format name. +

+
+
sar
+

The sample aspect ratio of the input frame, expressed in the form +num/den. +

+
+
s
+

The size of the input frame. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
i
+

The type of interlaced mode ("P" for "progressive", "T" for top field first, "B" +for bottom field first). +

+
+
iskey
+

This is 1 if the frame is a key frame, 0 otherwise. +

+
+
type
+

The picture type of the input frame ("I" for an I-frame, "P" for a +P-frame, "B" for a B-frame, or "?" for an unknown type). +Also refer to the documentation of the AVPictureType enum and of +the av_get_picture_type_char function defined in +libavutil/avutil.h. +

+
+
checksum
+

The Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame. +

+
+
plane_checksum
+

The Adler-32 checksum (printed in hexadecimal) of each plane of the input frame, +expressed in the form "[c0 c1 c2 c3]". +

+
+
mean
+

The mean value of pixels in each plane of the input frame, expressed in the form +"[mean0 mean1 mean2 mean3]". +

+
+
stdev
+

The standard deviation of pixel values in each plane of the input frame, expressed +in the form "[stdev0 stdev1 stdev2 stdev3]". +

+
+
+ + +

30.188 showpalette

+ +

Displays the 256 colors palette of each frame. This filter is only relevant for +pal8 pixel format frames. +

+

It accepts the following option: +

+
+
s
+

Set the size of the box used to represent one palette color entry. Default is +30 (for a 30x30 pixel box). +

+
+ + +

30.189 shuffleframes

+ +

Reorder and/or duplicate and/or drop video frames. +

+

It accepts the following parameters: +

+
+
mapping
+

Set the destination indexes of input frames. +This is space or ’|’ separated list of indexes that maps input frames to output +frames. Number of indexes also sets maximal value that each index may have. +’-1’ index have special meaning and that is to drop frame. +

+
+ +

The first frame has the index 0. The default is to keep the input unchanged. +

+ +

30.189.1 Examples

+ +
    +
  • Swap second and third frame of every three frames of the input: +
    +
    ffmpeg -i INPUT -vf "shuffleframes=0 2 1" OUTPUT
+
    + +
  • Swap 10th and 1st frame of every ten frames of the input: +
    +
    ffmpeg -i INPUT -vf "shuffleframes=9 1 2 3 4 5 6 7 8 0" OUTPUT
+
    +
+ + +

30.190 shuffleplanes

+ +

Reorder and/or duplicate video planes. +

+

It accepts the following parameters: +

+
+
map0
+

The index of the input plane to be used as the first output plane. +

+
+
map1
+

The index of the input plane to be used as the second output plane. +

+
+
map2
+

The index of the input plane to be used as the third output plane. +

+
+
map3
+

The index of the input plane to be used as the fourth output plane. +

+
+
+ +

The first plane has the index 0. The default is to keep the input unchanged. +

+ +

30.190.1 Examples

+ +
    +
  • Swap the second and third planes of the input: +
    +
    ffmpeg -i INPUT -vf shuffleplanes=0:2:1:3 OUTPUT
+
    +
+ + +

30.191 signalstats

+

Evaluate various visual metrics that assist in determining issues associated +with the digitization of analog video media. +

+

By default the filter will log these metadata values: +

+
+
YMIN
+

Display the minimal Y value contained within the input frame. Expressed in +range of [0-255]. +

+
+
YLOW
+

Display the Y value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
YAVG
+

Display the average Y value within the input frame. Expressed in range of +[0-255]. +

+
+
YHIGH
+

Display the Y value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
YMAX
+

Display the maximum Y value contained within the input frame. Expressed in +range of [0-255]. +

+
+
UMIN
+

Display the minimal U value contained within the input frame. Expressed in +range of [0-255]. +

+
+
ULOW
+

Display the U value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
UAVG
+

Display the average U value within the input frame. Expressed in range of +[0-255]. +

+
+
UHIGH
+

Display the U value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
UMAX
+

Display the maximum U value contained within the input frame. Expressed in +range of [0-255]. +

+
+
VMIN
+

Display the minimal V value contained within the input frame. Expressed in +range of [0-255]. +

+
+
VLOW
+

Display the V value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
VAVG
+

Display the average V value within the input frame. Expressed in range of +[0-255]. +

+
+
VHIGH
+

Display the V value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
VMAX
+

Display the maximum V value contained within the input frame. Expressed in +range of [0-255]. +

+
+
SATMIN
+

Display the minimal saturation value contained within the input frame. +Expressed in range of [0-~181.02]. +

+
+
SATLOW
+

Display the saturation value at the 10% percentile within the input frame. +Expressed in range of [0-~181.02]. +

+
+
SATAVG
+

Display the average saturation value within the input frame. Expressed in range +of [0-~181.02]. +

+
+
SATHIGH
+

Display the saturation value at the 90% percentile within the input frame. +Expressed in range of [0-~181.02]. +

+
+
SATMAX
+

Display the maximum saturation value contained within the input frame. +Expressed in range of [0-~181.02]. +

+
+
HUEMED
+

Display the median value for hue within the input frame. Expressed in range of +[0-360]. +

+
+
HUEAVG
+

Display the average value for hue within the input frame. Expressed in range of +[0-360]. +

+
+
YDIF
+

Display the average of sample value difference between all values of the Y +plane in the current frame and corresponding values of the previous input frame. +Expressed in range of [0-255]. +

+
+
UDIF
+

Display the average of sample value difference between all values of the U +plane in the current frame and corresponding values of the previous input frame. +Expressed in range of [0-255]. +

+
+
VDIF
+

Display the average of sample value difference between all values of the V +plane in the current frame and corresponding values of the previous input frame. +Expressed in range of [0-255]. +

+
+
YBITDEPTH
+

Display bit depth of Y plane in current frame. +Expressed in range of [0-16]. +

+
+
UBITDEPTH
+

Display bit depth of U plane in current frame. +Expressed in range of [0-16]. +

+
+
VBITDEPTH
+

Display bit depth of V plane in current frame. +Expressed in range of [0-16]. +

+
+ +

The filter accepts the following options: +

+
+
stat
+
out
+
+

stat specify an additional form of image analysis. +out output video with the specified type of pixel highlighted. +

+

Both options accept the following values: +

+
+
‘tout’
+

Identify temporal outliers pixels. A temporal outlier is a pixel +unlike the neighboring pixels of the same field. Examples of temporal outliers +include the results of video dropouts, head clogs, or tape tracking issues. +

+
+
‘vrep’
+

Identify vertical line repetition. Vertical line repetition includes +similar rows of pixels within a frame. In born-digital video vertical line +repetition is common, but this pattern is uncommon in video digitized from an +analog source. When it occurs in video that results from the digitization of an +analog source it can indicate concealment from a dropout compensator. +

+
+
‘brng’
+

Identify pixels that fall outside of legal broadcast range. +

+
+ +
+
color, c
+

Set the highlight color for the out option. The default color is +yellow. +

+
+ + +

30.191.1 Examples

+ +
    +
  • Output data of various video metrics: +
    +
    ffprobe -f lavfi movie=example.mov,signalstats="stat=tout+vrep+brng" -show_frames
+
    + +
  • Output specific data about the minimum and maximum values of the Y plane per frame: +
    +
    ffprobe -f lavfi movie=example.mov,signalstats -show_entries frame_tags=lavfi.signalstats.YMAX,lavfi.signalstats.YMIN
+
    + +
  • Playback video while highlighting pixels that are outside of broadcast range in red. +
    +
    ffplay example.mov -vf signalstats="out=brng:color=red"
+
    + +
  • Playback video with signalstats metadata drawn over the frame. +
    +
    ffplay example.mov -vf signalstats=stat=brng+vrep+tout,drawtext=fontfile=FreeSerif.ttf:textfile=signalstat_drawtext.txt
+
    + +

    The contents of signalstat_drawtext.txt used in the command are: +

    +
    time %{pts:hms}
+Y (%{metadata:lavfi.signalstats.YMIN}-%{metadata:lavfi.signalstats.YMAX})
+U (%{metadata:lavfi.signalstats.UMIN}-%{metadata:lavfi.signalstats.UMAX})
+V (%{metadata:lavfi.signalstats.VMIN}-%{metadata:lavfi.signalstats.VMAX})
+saturation maximum: %{metadata:lavfi.signalstats.SATMAX}
+
+
    +
+ + +

30.192 signature

+ +

Calculates the MPEG-7 Video Signature. The filter can handle more than one +input. In this case the matching between the inputs can be calculated additionally. +The filter always passes through the first input. The signature of each stream can +be written into a file. +

+

It accepts the following options: +

+
+
detectmode
+

Enable or disable the matching process. +

+

Available values are: +

+
+
‘off’
+

Disable the calculation of a matching (default). +

+
‘full’
+

Calculate the matching for the whole video and output whether the whole video +matches or only parts. +

+
‘fast’
+

Calculate only until a matching is found or the video ends. Should be faster in +some cases. +

+
+ +
+
nb_inputs
+

Set the number of inputs. The option value must be a non negative integer. +Default value is 1. +

+
+
filename
+

Set the path to which the output is written. If there is more than one input, +the path must be a prototype, i.e. must contain %d or %0nd (where n is a positive +integer), that will be replaced with the input number. If no filename is +specified, no output will be written. This is the default. +

+
+
format
+

Choose the output format. +

+

Available values are: +

+
+
‘binary’
+

Use the specified binary representation (default). +

+
‘xml’
+

Use the specified xml representation. +

+
+ +
+
th_d
+

Set threshold to detect one word as similar. The option value must be an integer +greater than zero. The default value is 9000. +

+
+
th_dc
+

Set threshold to detect all words as similar. The option value must be an integer +greater than zero. The default value is 60000. +

+
+
th_xh
+

Set threshold to detect frames as similar. The option value must be an integer +greater than zero. The default value is 116. +

+
+
th_di
+

Set the minimum length of a sequence in frames to recognize it as matching +sequence. The option value must be a non negative integer value. +The default value is 0. +

+
+
th_it
+

Set the minimum relation, that matching frames to all frames must have. +The option value must be a double value between 0 and 1. The default value is 0.5. +

+
+ + +

30.192.1 Examples

+ +
    +
  • To calculate the signature of an input video and store it in signature.bin: +
    +
    ffmpeg -i input.mkv -vf signature=filename=signature.bin -map 0:v -f null -
+
    + +
  • To detect whether two videos match and store the signatures in XML format in +signature0.xml and signature1.xml: +
    +
    ffmpeg -i input1.mkv -i input2.mkv -filter_complex "[0:v][1:v] signature=nb_inputs=2:detectmode=full:format=xml:filename=signature%d.xml" -map :v -f null -
+
    + +
+ + +

30.193 smartblur

+ +

Blur the input video without impacting the outlines. +

+

It accepts the following options: +

+
+
luma_radius, lr
+

Set the luma radius. The option value must be a float number in +the range [0.1,5.0] that specifies the variance of the gaussian filter +used to blur the image (slower if larger). Default value is 1.0. +

+
+
luma_strength, ls
+

Set the luma strength. The option value must be a float number +in the range [-1.0,1.0] that configures the blurring. A value included +in [0.0,1.0] will blur the image whereas a value included in +[-1.0,0.0] will sharpen the image. Default value is 1.0. +

+
+
luma_threshold, lt
+

Set the luma threshold used as a coefficient to determine +whether a pixel should be blurred or not. The option value must be an +integer in the range [-30,30]. A value of 0 will filter all the image, +a value included in [0,30] will filter flat areas and a value included +in [-30,0] will filter edges. Default value is 0. +

+
+
chroma_radius, cr
+

Set the chroma radius. The option value must be a float number in +the range [0.1,5.0] that specifies the variance of the gaussian filter +used to blur the image (slower if larger). Default value is luma_radius. +

+
+
chroma_strength, cs
+

Set the chroma strength. The option value must be a float number +in the range [-1.0,1.0] that configures the blurring. A value included +in [0.0,1.0] will blur the image whereas a value included in +[-1.0,0.0] will sharpen the image. Default value is luma_strength. +

+
+
chroma_threshold, ct
+

Set the chroma threshold used as a coefficient to determine +whether a pixel should be blurred or not. The option value must be an +integer in the range [-30,30]. A value of 0 will filter all the image, +a value included in [0,30] will filter flat areas and a value included +in [-30,0] will filter edges. Default value is luma_threshold. +

+
+ +

If a chroma option is not explicitly set, the corresponding luma value +is set. +

+ +

30.194 sobel

+

Apply sobel operator to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +

+
+
delta
+

Set value which will be added to filtered result. +

+
+ + +

30.195 spp

+ +

Apply a simple postprocessing filter that compresses and decompresses the image +at several (or - in the case of quality level 6 - all) shifts +and average the results. +

+

The filter accepts the following options: +

+
+
quality
+

Set quality. This option defines the number of levels for averaging. It accepts +an integer in the range 0-6. If set to 0, the filter will have no +effect. A value of 6 means the higher quality. For each increment of +that value the speed drops by a factor of approximately 2. Default value is +3. +

+
+
qp
+

Force a constant quantization parameter. If not set, the filter will use the QP +from the video stream (if available). +

+
+
mode
+

Set thresholding mode. Available modes are: +

+
+
‘hard’
+

Set hard thresholding (default). +

+
‘soft’
+

Set soft thresholding (better de-ringing effect, but likely blurrier). +

+
+ +
+
use_bframe_qp
+

Enable the use of the QP from the B-Frames if set to 1. Using this +option may cause flicker since the B-Frames have often larger QP. Default is +0 (not enabled). +

+
+ + +

30.195.1 Commands

+ +

This filter supports the following commands: +

+
quality, level
+

Set quality level. The value max can be used to set the maximum level, +currently 6. +

+
+ + +

30.196 sr

+ +

Scale the input by applying one of the super-resolution methods based on +convolutional neural networks. Supported models: +

+ + +

Training scripts as well as scripts for model file (.pb) saving can be found at +https://github.com/XueweiMeng/sr/tree/sr_dnn_native. Original repository +is at https://github.com/HighVoltageRocknRoll/sr.git. +

+

Native model files (.model) can be generated from TensorFlow model +files (.pb) by using tools/python/convert.py +

+

The filter accepts the following options: +

+
+
dnn_backend
+

Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +

+
+
‘native’
+

Native implementation of DNN loading and execution. +

+
+
‘tensorflow’
+

TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +https://www.tensorflow.org/install/install_c) and configure FFmpeg with +--enable-libtensorflow +

+
+ +

Default value is ‘native’. +

+
+
model
+

Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow backend +can load files for both formats, while native backend can load files for only +its format. +

+
+
scale_factor
+

Set scale factor for SRCNN model. Allowed values are 2, 3 and 4. +Default value is 2. Scale factor is necessary for SRCNN model, because it accepts +input upscaled using bicubic upscaling with proper scale factor. +

+
+ +

This feature can also be finished with dnn_processing filter. +

+ +

30.197 ssim

+ +

Obtain the SSIM (Structural SImilarity Metric) between two input videos. +

+

This filter takes in input two input videos, the first input is +considered the "main" source and is passed unchanged to the +output. The second input is used as a "reference" video for computing +the SSIM. +

+

Both video inputs must have the same resolution and pixel format for +this filter to work correctly. Also it assumes that both inputs +have the same number of frames, which are compared one by one. +

+

The filter stores the calculated SSIM of each frame. +

+

The description of the accepted parameters follows. +

+
+
stats_file, f
+

If specified the filter will use the named file to save the SSIM of +each individual frame. When filename equals "-" the data is sent to +standard output. +

+
+ +

The file printed if stats_file is selected, contains a sequence of +key/value pairs of the form key:value for each compared +couple of frames. +

+

A description of each shown parameter follows: +

+
+
n
+

sequential number of the input frame, starting from 1 +

+
+
Y, U, V, R, G, B
+

SSIM of the compared frames for the component specified by the suffix. +

+
+
All
+

SSIM of the compared frames for the whole frame. +

+
+
dB
+

Same as above but in dB representation. +

+
+ +

This filter also supports the framesync options. +

+ +

30.197.1 Examples

+
    +
  • For example: +
    +
    movie=ref_movie.mpg, setpts=PTS-STARTPTS [main];
+[main][ref] ssim="stats_file=stats.log" [out]
+
    + +

    On this example the input file being processed is compared with the +reference file ref_movie.mpg. The SSIM of each individual frame +is stored in stats.log. +

    +
  • Another example with both psnr and ssim at same time: +
    +
    ffmpeg -i main.mpg -i ref.mpg -lavfi  "ssim;[0:v][1:v]psnr" -f null -
+
    + +
  • Another example with different containers: +
    +
    ffmpeg -i main.mpg -i ref.mkv -lavfi  "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]ssim" -f null -
+
    +
+ + +

30.198 stereo3d

+ +

Convert between different stereoscopic image formats. +

+

The filters accept the following options: +

+
+
in
+

Set stereoscopic image format of input. +

+

Available values for input image formats are: +

+
‘sbsl’
+

side by side parallel (left eye left, right eye right) +

+
+
‘sbsr’
+

side by side crosseye (right eye left, left eye right) +

+
+
‘sbs2l’
+

side by side parallel with half width resolution +(left eye left, right eye right) +

+
+
‘sbs2r’
+

side by side crosseye with half width resolution +(right eye left, left eye right) +

+
+
‘abl’
+
‘tbl’
+

above-below (left eye above, right eye below) +

+
+
‘abr’
+
‘tbr’
+

above-below (right eye above, left eye below) +

+
+
‘ab2l’
+
‘tb2l’
+

above-below with half height resolution +(left eye above, right eye below) +

+
+
‘ab2r’
+
‘tb2r’
+

above-below with half height resolution +(right eye above, left eye below) +

+
+
‘al’
+

alternating frames (left eye first, right eye second) +

+
+
‘ar’
+

alternating frames (right eye first, left eye second) +

+
+
‘irl’
+

interleaved rows (left eye has top row, right eye starts on next row) +

+
+
‘irr’
+

interleaved rows (right eye has top row, left eye starts on next row) +

+
+
‘icl’
+

interleaved columns, left eye first +

+
+
‘icr’
+

interleaved columns, right eye first +

+

Default value is ‘sbsl’. +

+
+ +
+
out
+

Set stereoscopic image format of output. +

+
+
‘sbsl’
+

side by side parallel (left eye left, right eye right) +

+
+
‘sbsr’
+

side by side crosseye (right eye left, left eye right) +

+
+
‘sbs2l’
+

side by side parallel with half width resolution +(left eye left, right eye right) +

+
+
‘sbs2r’
+

side by side crosseye with half width resolution +(right eye left, left eye right) +

+
+
‘abl’
+
‘tbl’
+

above-below (left eye above, right eye below) +

+
+
‘abr’
+
‘tbr’
+

above-below (right eye above, left eye below) +

+
+
‘ab2l’
+
‘tb2l’
+

above-below with half height resolution +(left eye above, right eye below) +

+
+
‘ab2r’
+
‘tb2r’
+

above-below with half height resolution +(right eye above, left eye below) +

+
+
‘al’
+

alternating frames (left eye first, right eye second) +

+
+
‘ar’
+

alternating frames (right eye first, left eye second) +

+
+
‘irl’
+

interleaved rows (left eye has top row, right eye starts on next row) +

+
+
‘irr’
+

interleaved rows (right eye has top row, left eye starts on next row) +

+
+
‘arbg’
+

anaglyph red/blue gray +(red filter on left eye, blue filter on right eye) +

+
+
‘argg’
+

anaglyph red/green gray +(red filter on left eye, green filter on right eye) +

+
+
‘arcg’
+

anaglyph red/cyan gray +(red filter on left eye, cyan filter on right eye) +

+
+
‘arch’
+

anaglyph red/cyan half colored +(red filter on left eye, cyan filter on right eye) +

+
+
‘arcc’
+

anaglyph red/cyan color +(red filter on left eye, cyan filter on right eye) +

+
+
‘arcd’
+

anaglyph red/cyan color optimized with the least squares projection of dubois +(red filter on left eye, cyan filter on right eye) +

+
+
‘agmg’
+

anaglyph green/magenta gray +(green filter on left eye, magenta filter on right eye) +

+
+
‘agmh’
+

anaglyph green/magenta half colored +(green filter on left eye, magenta filter on right eye) +

+
+
‘agmc’
+

anaglyph green/magenta colored +(green filter on left eye, magenta filter on right eye) +

+
+
‘agmd’
+

anaglyph green/magenta color optimized with the least squares projection of dubois +(green filter on left eye, magenta filter on right eye) +

+
+
‘aybg’
+

anaglyph yellow/blue gray +(yellow filter on left eye, blue filter on right eye) +

+
+
‘aybh’
+

anaglyph yellow/blue half colored +(yellow filter on left eye, blue filter on right eye) +

+
+
‘aybc’
+

anaglyph yellow/blue colored +(yellow filter on left eye, blue filter on right eye) +

+
+
‘aybd’
+

anaglyph yellow/blue color optimized with the least squares projection of dubois +(yellow filter on left eye, blue filter on right eye) +

+
+
‘ml’
+

mono output (left eye only) +

+
+
‘mr’
+

mono output (right eye only) +

+
+
‘chl’
+

checkerboard, left eye first +

+
+
‘chr’
+

checkerboard, right eye first +

+
+
‘icl’
+

interleaved columns, left eye first +

+
+
‘icr’
+

interleaved columns, right eye first +

+
+
‘hdmi’
+

HDMI frame pack +

+
+ +

Default value is ‘arcd’. +

+
+ + +

30.198.1 Examples

+ +
    +
  • Convert input video from side by side parallel to anaglyph yellow/blue dubois: +
    +
    stereo3d=sbsl:aybd
+
    + +
  • Convert input video from above below (left eye above, right eye below) to side by side crosseye. +
    +
    stereo3d=abl:sbsr
+
    +
+ + +

30.199 streamselect, astreamselect

+

Select video or audio streams. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of inputs. Default is 2. +

+
+
map
+

Set input indexes to remap to outputs. +

+
+ + +

30.199.1 Commands

+ +

The streamselect and astreamselect filter supports the following +commands: +

+
+
map
+

Set input indexes to remap to outputs. +

+
+ + +

30.199.2 Examples

+ +
    +
  • Select first 5 seconds 1st stream and rest of time 2nd stream: +
    +
    sendcmd='5.0 streamselect map 1',streamselect=inputs=2:map=0
+
    + +
  • Same as above, but for audio: +
    +
    asendcmd='5.0 astreamselect map 1',astreamselect=inputs=2:map=0
+
    +
+ + +

30.200 subtitles

+ +

Draw subtitles on top of input video using the libass library. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libass. This filter also requires a build with libavcodec and +libavformat to convert the passed subtitles file to ASS (Advanced Substation +Alpha) subtitles format. +

+

The filter accepts the following options: +

+
+
filename, f
+

Set the filename of the subtitle file to read. It must be specified. +

+
+
original_size
+

Specify the size of the original video, the video for which the ASS file +was composed. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Due to a misdesign in ASS aspect ratio arithmetic, this is necessary to +correctly scale the fonts if the aspect ratio has been changed. +

+
+
fontsdir
+

Set a directory path containing fonts that can be used by the filter. +These fonts will be used in addition to whatever the font provider uses. +

+
+
alpha
+

Process alpha channel, by default alpha channel is untouched. +

+
+
charenc
+

Set subtitles input character encoding. subtitles filter only. Only +useful if not UTF-8. +

+
+
stream_index, si
+

Set subtitles stream index. subtitles filter only. +

+
+
force_style
+

Override default style or script info parameters of the subtitles. It accepts a +string containing ASS style format KEY=VALUE couples separated by ",". +

+
+ +

If the first key is not specified, it is assumed that the first value +specifies the filename. +

+

For example, to render the file sub.srt on top of the input +video, use the command: +

+
subtitles=sub.srt
+
+ +

which is equivalent to: +

+
subtitles=filename=sub.srt
+
+ +

To render the default subtitles stream from file video.mkv, use: +

+
subtitles=video.mkv
+
+ +

To render the second subtitles stream from that file, use: +

+
subtitles=video.mkv:si=1
+
+ +

To make the subtitles stream from sub.srt appear in 80% transparent blue +DejaVu Serif, use: +

+
subtitles=sub.srt:force_style='FontName=DejaVu Serif,PrimaryColour=&HCCFF0000'
+
+ + +

30.201 super2xsai

+ +

Scale the input by 2x and smooth using the Super2xSaI (Scale and +Interpolate) pixel art scaling algorithm. +

+

Useful for enlarging pixel art images without reducing sharpness. +

+ +

30.202 swaprect

+ +

Swap two rectangular objects in video. +

+

This filter accepts the following options: +

+
+
w
+

Set object width. +

+
+
h
+

Set object height. +

+
+
x1
+

Set 1st rect x coordinate. +

+
+
y1
+

Set 1st rect y coordinate. +

+
+
x2
+

Set 2nd rect x coordinate. +

+
+
y2
+

Set 2nd rect y coordinate. +

+

All expressions are evaluated once for each frame. +

+
+ +

The all options are expressions containing the following constants: +

+
+
w
+
h
+

The input width and height. +

+
+
a
+

same as w / h +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (w / h) * sar +

+
+
n
+

The number of the input frame, starting from 0. +

+
+
t
+

The timestamp expressed in seconds. It’s NAN if the input timestamp is unknown. +

+
+
pos
+

the position in the file of the input frame, NAN if unknown +

+
+ + +

30.203 swapuv

+

Swap U & V plane. +

+ +

30.204 tblend

+

Blend successive video frames. +

+

See blend +

+ +

30.205 telecine

+ +

Apply telecine process to the video. +

+

This filter accepts the following options: +

+
+
first_field
+
+
‘top, t’
+

top field first +

+
‘bottom, b’
+

bottom field first +The default value is top. +

+
+ +
+
pattern
+

A string of numbers representing the pulldown pattern you wish to apply. +The default value is 23. +

+
+ +
+
Some typical patterns:
+
+NTSC output (30i):
+27.5p: 32222
+24p: 23 (classic)
+24p: 2332 (preferred)
+20p: 33
+18p: 334
+16p: 3444
+
+PAL output (25i):
+27.5p: 12222
+24p: 222222222223 ("Euro pulldown")
+16.67p: 33
+16p: 33333334
+
+ + +

30.206 thistogram

+ +

Compute and draw a color distribution histogram for the input video across time. +

+

Unlike histogram video filter which only shows histogram of single input frame +at certain time, this filter shows also past histograms of number of frames defined +by width option. +

+

The computed histogram is a representation of the color component +distribution in an image. +

+

The filter accepts the following options: +

+
+
width, w
+

Set width of single color component output. Default value is 0. +Value of 0 means width will be picked from input video. +This also set number of passed histograms to keep. +Allowed range is [0, 8192]. +

+
+
display_mode, d
+

Set display mode. +It accepts the following values: +

+
‘stack’
+

Per color component graphs are placed below each other. +

+
+
‘parade’
+

Per color component graphs are placed side by side. +

+
+
‘overlay’
+

Presents information identical to that in the parade, except +that the graphs representing color components are superimposed directly +over one another. +

+
+

Default is stack. +

+
+
levels_mode, m
+

Set mode. Can be either linear, or logarithmic. +Default is linear. +

+
+
components, c
+

Set what color components to display. +Default is 7. +

+
+
bgopacity, b
+

Set background opacity. Default is 0.9. +

+
+
envelope, e
+

Show envelope. Default is disabled. +

+
+
ecolor, ec
+

Set envelope color. Default is gold. +

+
+ + +

30.207 threshold

+ +

Apply threshold effect to video stream. +

+

This filter needs four video streams to perform thresholding. +First stream is stream we are filtering. +Second stream is holding threshold values, third stream is holding min values, +and last, fourth stream is holding max values. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+ +

For example if first stream pixel’s component value is less then threshold value +of pixel component from 2nd threshold stream, third stream value will picked, +otherwise fourth stream pixel component value will be picked. +

+

Using color source filter one can perform various types of thresholding: +

+ +

30.207.1 Examples

+ +
    +
  • Binary threshold, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=black -f lavfi -i color=white -lavfi threshold output.avi
+
    + +
  • Inverted binary threshold, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=white -f lavfi -i color=black -lavfi threshold output.avi
+
    + +
  • Truncate binary threshold, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -i 320x240.avi -f lavfi -i color=gray -lavfi threshold output.avi
+
    + +
  • Threshold to zero, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=white -i 320x240.avi -lavfi threshold output.avi
+
    + +
  • Inverted threshold to zero, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -i 320x240.avi -f lavfi -i color=white -lavfi threshold output.avi
+
    +
+ + +

30.208 thumbnail

+

Select the most representative frame in a given sequence of consecutive frames. +

+

The filter accepts the following options: +

+
+
n
+

Set the frames batch size to analyze; in a set of n frames, the filter +will pick one of them, and then handle the next batch of n frames until +the end. Default is 100. +

+
+ +

Since the filter keeps track of the whole frames sequence, a bigger n +value will result in a higher memory usage, so a high value is not recommended. +

+ +

30.208.1 Examples

+ +
    +
  • Extract one picture each 50 frames: +
    +
    thumbnail=50
+
    + +
  • Complete example of a thumbnail creation with ffmpeg: +
    +
    ffmpeg -i in.avi -vf thumbnail,scale=300:200 -frames:v 1 out.png
+
    +
+ + +

30.209 tile

+ +

Tile several successive frames together. +

+

The untile filter can do the reverse. +

+

The filter accepts the following options: +

+
+
layout
+

Set the grid size (i.e. the number of lines and columns). For the syntax of +this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
nb_frames
+

Set the maximum number of frames to render in the given area. It must be less +than or equal to wxh. The default value is 0, meaning all +the area will be used. +

+
+
margin
+

Set the outer border margin in pixels. +

+
+
padding
+

Set the inner border thickness (i.e. the number of pixels between frames). For +more advanced padding options (such as having different values for the edges), +refer to the pad video filter. +

+
+
color
+

Specify the color of the unused area. For the syntax of this option, check the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +The default value of color is "black". +

+
+
overlap
+

Set the number of frames to overlap when tiling several successive frames together. +The value must be between 0 and nb_frames - 1. +

+
+
init_padding
+

Set the number of frames to initially be empty before displaying first output frame. +This controls how soon will one get first output frame. +The value must be between 0 and nb_frames - 1. +

+
+ + +

30.209.1 Examples

+ +
    +
  • Produce 8x8 PNG tiles of all keyframes (-skip_frame nokey) in a movie: +
    +
    ffmpeg -skip_frame nokey -i file.avi -vf 'scale=128:72,tile=8x8' -an -vsync 0 keyframes%03d.png
+
    +

    The -vsync 0 is necessary to prevent ffmpeg from +duplicating each output frame to accommodate the originally detected frame +rate. +

    +
  • Display 5 pictures in an area of 3x2 frames, +with 7 pixels between them, and 2 pixels of initial margin, using +mixed flat and named options: +
    +
    tile=3x2:nb_frames=5:padding=7:margin=2
+
    +
+ + +

30.210 tinterlace

+ +

Perform various types of temporal field interlacing. +

+

Frames are counted starting from 1, so the first input frame is +considered odd. +

+

The filter accepts the following options: +

+
+
mode
+

Specify the mode of the interlacing. This option can also be specified +as a value alone. See below for a list of values for this option. +

+

Available values are: +

+
+
‘merge, 0’
+

Move odd frames into the upper field, even into the lower field, +generating a double height frame at half frame rate. +

+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+
+ +
+
‘drop_even, 1’
+

Only output odd frames, even frames are dropped, generating a frame with +unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111                           33333
+11111                           33333
+11111                           33333
+11111                           33333
+
+ +
+
‘drop_odd, 2’
+

Only output even frames, odd frames are dropped, generating a frame with +unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+                22222                           44444
+                22222                           44444
+                22222                           44444
+                22222                           44444
+
+ +
+
‘pad, 3’
+

Expand each frame to full height, but pad alternate lines with black, +generating a frame with double height at the same input frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111           .....           33333           .....
+.....           22222           .....           44444
+11111           .....           33333           .....
+.....           22222           .....           44444
+11111           .....           33333           .....
+.....           22222           .....           44444
+11111           .....           33333           .....
+.....           22222           .....           44444
+
+ + +
+
‘interleave_top, 4’
+

Interleave the upper field from odd frames with the lower field from +even frames, generating a frame with unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111<-         22222           33333<-         44444
+11111           22222<-         33333           44444<-
+11111<-         22222           33333<-         44444
+11111           22222<-         33333           44444<-
+
+Output:
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+
+ + +
+
‘interleave_bottom, 5’
+

Interleave the lower field from odd frames with the upper field from +even frames, generating a frame with unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222<-         33333           44444<-
+11111<-         22222           33333<-         44444
+11111           22222<-         33333           44444<-
+11111<-         22222           33333<-         44444
+
+Output:
+22222                           44444
+11111                           33333
+22222                           44444
+11111                           33333
+
+ + +
+
‘interlacex2, 6’
+

Double frame rate with unchanged height. Frames are inserted each +containing the second temporal field from the previous input frame and +the first temporal field from the next input frame. This mode relies on +the top_field_first flag. Useful for interlaced video displays with no +field synchronisation. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+ 11111           22222           33333           44444
+11111           22222           33333           44444
+ 11111           22222           33333           44444
+
+Output:
+11111   22222   22222   33333   33333   44444   44444
+ 11111   11111   22222   22222   33333   33333   44444
+11111   22222   22222   33333   33333   44444   44444
+ 11111   11111   22222   22222   33333   33333   44444
+
+ + +
+
‘mergex2, 7’
+

Move odd frames into the upper field, even into the lower field, +generating a double height frame at same frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111           33333           33333           55555
+22222           22222           44444           44444
+11111           33333           33333           55555
+22222           22222           44444           44444
+11111           33333           33333           55555
+22222           22222           44444           44444
+11111           33333           33333           55555
+22222           22222           44444           44444
+
+ +
+
+ +

Numeric values are deprecated but are accepted for backward +compatibility reasons. +

+

Default mode is merge. +

+
+
flags
+

Specify flags influencing the filter process. +

+

Available value for flags is: +

+
+
low_pass_filter, vlpf
+

Enable linear vertical low-pass filtering in the filter. +Vertical low-pass filtering is required when creating an interlaced +destination from a progressive source which contains high-frequency +vertical detail. Filtering will reduce interlace ’twitter’ and Moire +patterning. +

+
+
complex_filter, cvlpf
+

Enable complex vertical low-pass filtering. +This will slightly less reduce interlace ’twitter’ and Moire +patterning but better retain detail and subjective sharpness impression. +

+
+
bypass_il
+

Bypass already interlaced frames, only adjust the frame rate. +

+
+ +

Vertical low-pass filtering and bypassing already interlaced frames can only be +enabled for mode interleave_top and interleave_bottom. +

+
+
+ + +

30.211 tmedian

+

Pick median pixels from several successive input video frames. +

+

The filter accepts the following options: +

+
+
radius
+

Set radius of median filter. +Default is 1. Allowed range is from 1 to 127. +

+
+
planes
+

Set which planes to filter. Default value is 15, by which all planes are processed. +

+
+
percentile
+

Set median percentile. Default value is 0.5. +Default value of 0.5 will pick always median values, while 0 will pick +minimum values, and 1 maximum values. +

+
+ + +

30.212 tmix

+ +

Mix successive video frames. +

+

A description of the accepted options follows. +

+
+
frames
+

The number of successive frames to mix. If unspecified, it defaults to 3. +

+
+
weights
+

Specify weight of each input video frame. +Each weight is separated by space. If number of weights is smaller than +number of frames last specified weight will be used for all remaining +unset weights. +

+
+
scale
+

Specify scale, if it is set it will be multiplied with sum +of each weight multiplied with pixel values to give final destination +pixel value. By default scale is auto scaled to sum of weights. +

+
+ + +

30.212.1 Examples

+ +
    +
  • Average 7 successive frames: +
    +
    tmix=frames=7:weights="1 1 1 1 1 1 1"
+
    + +
  • Apply simple temporal convolution: +
    +
    tmix=frames=3:weights="-1 3 -1"
+
    + +
  • Similar as above but only showing temporal differences: +
    +
    tmix=frames=3:weights="-1 2 -1":scale=1
+
    +
+ + +

30.213 tonemap

+

Tone map colors from different dynamic ranges. +

+

This filter expects data in single precision floating point, as it needs to +operate on (and can output) out-of-range values. Another filter, such as +zscale, is needed to convert the resulting frame to a usable format. +

+

The tonemapping algorithms implemented only work on linear light, so input +data should be linearized beforehand (and possibly correctly tagged). +

+
+
ffmpeg -i INPUT -vf zscale=transfer=linear,tonemap=clip,zscale=transfer=bt709,format=yuv420p OUTPUT
+
+ + +

30.213.1 Options

+

The filter accepts the following options. +

+
+
tonemap
+

Set the tone map algorithm to use. +

+

Possible values are: +

+
none
+

Do not apply any tone map, only desaturate overbright pixels. +

+
+
clip
+

Hard-clip any out-of-range values. Use it for perfect color accuracy for +in-range values, while distorting out-of-range values. +

+
+
linear
+

Stretch the entire reference gamut to a linear multiple of the display. +

+
+
gamma
+

Fit a logarithmic transfer between the tone curves. +

+
+
reinhard
+

Preserve overall image brightness with a simple curve, using nonlinear +contrast, which results in flattening details and degrading color accuracy. +

+
+
hable
+

Preserve both dark and bright details better than reinhard, at the cost +of slightly darkening everything. Use it when detail preservation is more +important than color and brightness accuracy. +

+
+
mobius
+

Smoothly map out-of-range values, while retaining contrast and colors for +in-range material as much as possible. Use it when color accuracy is more +important than detail preservation. +

+
+ +

Default is none. +

+
+
param
+

Tune the tone mapping algorithm. +

+

This affects the following algorithms: +

+
none
+

Ignored. +

+
+
linear
+

Specifies the scale factor to use while stretching. +Default to 1.0. +

+
+
gamma
+

Specifies the exponent of the function. +Default to 1.8. +

+
+
clip
+

Specify an extra linear coefficient to multiply into the signal before clipping. +Default to 1.0. +

+
+
reinhard
+

Specify the local contrast coefficient at the display peak. +Default to 0.5, which means that in-gamut values will be about half as bright +as when clipping. +

+
+
hable
+

Ignored. +

+
+
mobius
+

Specify the transition point from linear to mobius transform. Every value +below this point is guaranteed to be mapped 1:1. The higher the value, the +more accurate the result will be, at the cost of losing bright details. +Default to 0.3, which due to the steep initial slope still preserves in-range +colors fairly accurately. +

+
+ +
+
desat
+

Apply desaturation for highlights that exceed this level of brightness. The +higher the parameter, the more color information will be preserved. This +setting helps prevent unnaturally blown-out colors for super-highlights, by +(smoothly) turning into white instead. This makes images feel more natural, +at the cost of reducing information about out-of-range colors. +

+

The default of 2.0 is somewhat conservative and will mostly just apply to +skies or directly sunlit surfaces. A setting of 0.0 disables this option. +

+

This option works only if the input frame has a supported color tag. +

+
+
peak
+

Override signal/nominal/reference peak with this value. Useful when the +embedded peak information in display metadata is not reliable or when tone +mapping from a lower range to a higher range. +

+
+ + +

30.214 tpad

+ +

Temporarily pad video frames. +

+

The filter accepts the following options: +

+
+
start
+

Specify number of delay frames before input video stream. Default is 0. +

+
+
stop
+

Specify number of padding frames after input video stream. +Set to -1 to pad indefinitely. Default is 0. +

+
+
start_mode
+

Set kind of frames added to beginning of stream. +Can be either add or clone. +With add frames of solid-color are added. +With clone frames are clones of first frame. +Default is add. +

+
+
stop_mode
+

Set kind of frames added to end of stream. +Can be either add or clone. +With add frames of solid-color are added. +With clone frames are clones of last frame. +Default is add. +

+
+
start_duration, stop_duration
+

Specify the duration of the start/stop delay. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +These options override start and stop. Default is 0. +

+
+
color
+

Specify the color of the padded area. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. +

+

The default value of color is "black". +

+
+ + +

30.215 transpose

+ +

Transpose rows with columns in the input video and optionally flip it. +

+

It accepts the following parameters: +

+
+
dir
+

Specify the transposition direction. +

+

Can assume the following values: +

+
‘0, 4, cclock_flip’
+

Rotate by 90 degrees counterclockwise and vertically flip (default), that is: +

+
L.R     L.l
+. . ->  . .
+l.r     R.r
+
+ +
+
‘1, 5, clock’
+

Rotate by 90 degrees clockwise, that is: +

+
L.R     l.L
+. . ->  . .
+l.r     r.R
+
+ +
+
‘2, 6, cclock’
+

Rotate by 90 degrees counterclockwise, that is: +

+
L.R     R.r
+. . ->  . .
+l.r     L.l
+
+ +
+
‘3, 7, clock_flip’
+

Rotate by 90 degrees clockwise and vertically flip, that is: +

+
L.R     r.R
+. . ->  . .
+l.r     l.L
+
+
+
+ +

For values between 4-7, the transposition is only done if the input +video geometry is portrait and not landscape. These values are +deprecated, the passthrough option should be used instead. +

+

Numerical values are deprecated, and should be dropped in favor of +symbolic constants. +

+
+
passthrough
+

Do not apply the transposition if the input geometry matches the one +specified by the specified value. It accepts the following values: +

+
‘none’
+

Always apply transposition. +

+
‘portrait’
+

Preserve portrait geometry (when height >= width). +

+
‘landscape’
+

Preserve landscape geometry (when width >= height). +

+
+ +

Default value is none. +

+
+ +

For example to rotate by 90 degrees clockwise and preserve portrait +layout: +

+
transpose=dir=1:passthrough=portrait
+
+ +

The command above can also be specified as: +

+
transpose=1:portrait
+
+ + +

30.216 transpose_npp

+ +

Transpose rows with columns in the input video and optionally flip it. +For more in depth examples see the transpose video filter, which shares mostly the same options. +

+

It accepts the following parameters: +

+
+
dir
+

Specify the transposition direction. +

+

Can assume the following values: +

+
‘cclock_flip’
+

Rotate by 90 degrees counterclockwise and vertically flip. (default) +

+
+
‘clock’
+

Rotate by 90 degrees clockwise. +

+
+
‘cclock’
+

Rotate by 90 degrees counterclockwise. +

+
+
‘clock_flip’
+

Rotate by 90 degrees clockwise and vertically flip. +

+
+ +
+
passthrough
+

Do not apply the transposition if the input geometry matches the one +specified by the specified value. It accepts the following values: +

+
‘none’
+

Always apply transposition. (default) +

+
‘portrait’
+

Preserve portrait geometry (when height >= width). +

+
‘landscape’
+

Preserve landscape geometry (when width >= height). +

+
+ +
+
+ + +

30.217 trim

+

Trim the input so that the output contains one continuous subpart of the input. +

+

It accepts the following parameters: +

+
start
+

Specify the time of the start of the kept section, i.e. the frame with the +timestamp start will be the first frame in the output. +

+
+
end
+

Specify the time of the first frame that will be dropped, i.e. the frame +immediately preceding the one with the timestamp end will be the last +frame in the output. +

+
+
start_pts
+

This is the same as start, except this option sets the start timestamp +in timebase units instead of seconds. +

+
+
end_pts
+

This is the same as end, except this option sets the end timestamp +in timebase units instead of seconds. +

+
+
duration
+

The maximum duration of the output in seconds. +

+
+
start_frame
+

The number of the first frame that should be passed to the output. +

+
+
end_frame
+

The number of the first frame that should be dropped. +

+
+ +

start, end, and duration are expressed as time +duration specifications; see +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

Note that the first two sets of the start/end options and the duration +option look at the frame timestamp, while the _frame variants simply count the +frames that pass through the filter. Also note that this filter does not modify +the timestamps. If you wish for the output timestamps to start at zero, insert a +setpts filter after the trim filter. +

+

If multiple start or end options are set, this filter tries to be greedy and +keep all the frames that match at least one of the specified constraints. To keep +only the part that matches all the constraints at once, chain multiple trim +filters. +

+

The defaults are such that all the input is kept. So it is possible to set e.g. +just the end values to keep everything before the specified time. +

+

Examples: +

    +
  • Drop everything except the second minute of input: +
    +
    ffmpeg -i INPUT -vf trim=60:120
+
    + +
  • Keep only the first second: +
    +
    ffmpeg -i INPUT -vf trim=duration=1
+
    + +
+ + +

30.218 unpremultiply

+

Apply alpha unpremultiply effect to input video stream using first plane +of second stream as alpha. +

+

Both streams must have same dimensions and same pixel format. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+

If the format has 1 or 2 components, then luma is bit 0. +If the format has 3 or 4 components: +for RGB formats bit 0 is green, bit 1 is blue and bit 2 is red; +for YUV formats bit 0 is luma, bit 1 is chroma-U and bit 2 is chroma-V. +If present, the alpha channel is always the last bit. +

+
+
inplace
+

Do not require 2nd input for processing, instead use alpha plane from input stream. +

+
+ + +

30.219 unsharp

+ +

Sharpen or blur the input video. +

+

It accepts the following parameters: +

+
+
luma_msize_x, lx
+

Set the luma matrix horizontal size. It must be an odd integer between +3 and 23. The default value is 5. +

+
+
luma_msize_y, ly
+

Set the luma matrix vertical size. It must be an odd integer between 3 +and 23. The default value is 5. +

+
+
luma_amount, la
+

Set the luma effect strength. It must be a floating point number, reasonable +values lay between -1.5 and 1.5. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+

Default value is 1.0. +

+
+
chroma_msize_x, cx
+

Set the chroma matrix horizontal size. It must be an odd integer +between 3 and 23. The default value is 5. +

+
+
chroma_msize_y, cy
+

Set the chroma matrix vertical size. It must be an odd integer +between 3 and 23. The default value is 5. +

+
+
chroma_amount, ca
+

Set the chroma effect strength. It must be a floating point number, reasonable +values lay between -1.5 and 1.5. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+

Default value is 0.0. +

+
+
+ +

All parameters are optional and default to the equivalent of the +string ’5:5:1.0:5:5:0.0’. +

+ +

30.219.1 Examples

+ +
    +
  • Apply strong luma sharpen effect: +
    +
    unsharp=luma_msize_x=7:luma_msize_y=7:luma_amount=2.5
+
    + +
  • Apply a strong blur of both luma and chroma parameters: +
    +
    unsharp=7:7:-2:7:7:-2
+
    +
+ + +

30.220 untile

+ +

Decompose a video made of tiled images into the individual images. +

+

The frame rate of the output video is the frame rate of the input video +multiplied by the number of tiles. +

+

This filter does the reverse of tile. +

+

The filter accepts the following options: +

+
+
layout
+

Set the grid size (i.e. the number of lines and columns). For the syntax of +this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+ + +

30.220.1 Examples

+ +
    +
  • Produce a 1-second video from a still image file made of 25 frames stacked +vertically, like an analogic film reel: +
    +
    ffmpeg -r 1 -i image.jpg -vf untile=1x25 movie.mkv
+
    +
+ + +

30.221 uspp

+ +

Apply ultra slow/simple postprocessing filter that compresses and decompresses +the image at several (or - in the case of quality level 8 - all) +shifts and average the results. +

+

The way this differs from the behavior of spp is that uspp actually encodes & +decodes each case with libavcodec Snow, whereas spp uses a simplified intra only 8x8 +DCT similar to MJPEG. +

+

The filter accepts the following options: +

+
+
quality
+

Set quality. This option defines the number of levels for averaging. It accepts +an integer in the range 0-8. If set to 0, the filter will have no +effect. A value of 8 means the higher quality. For each increment of +that value the speed drops by a factor of approximately 2. Default value is +3. +

+
+
qp
+

Force a constant quantization parameter. If not set, the filter will use the QP +from the video stream (if available). +

+
+ + +

30.222 v360

+ +

Convert 360 videos between various formats. +

+

The filter accepts the following options: +

+
+
input
+
output
+

Set format of the input/output video. +

+

Available formats: +

+
+
‘e’
+
‘equirect’
+

Equirectangular projection. +

+
+
‘c3x2’
+
‘c6x1’
+
‘c1x6’
+

Cubemap with 3x2/6x1/1x6 layout. +

+

Format specific options: +

+
+
in_pad
+
out_pad
+

Set padding proportion for the input/output cubemap. Values in decimals. +

+

Example values: +

+
‘0’
+

No padding. +

+
‘0.01’
+

1% of face is padding. For example, with 1920x1280 resolution face size would be 640x640 and padding would be 3 pixels from each side. (640 * 0.01 = 6 pixels) +

+
+ +

Default value is ‘0’. +Maximum value is ‘0.1’. +

+
+
fin_pad
+
fout_pad
+

Set fixed padding for the input/output cubemap. Values in pixels. +

+

Default value is ‘0’. If greater than zero it overrides other padding options. +

+
+
in_forder
+
out_forder
+

Set order of faces for the input/output cubemap. Choose one direction for each position. +

+

Designation of directions: +

+
‘r’
+

right +

+
‘l’
+

left +

+
‘u’
+

up +

+
‘d’
+

down +

+
‘f’
+

forward +

+
‘b’
+

back +

+
+ +

Default value is ‘rludfb’. +

+
+
in_frot
+
out_frot
+

Set rotation of faces for the input/output cubemap. Choose one angle for each position. +

+

Designation of angles: +

+
‘0’
+

0 degrees clockwise +

+
‘1’
+

90 degrees clockwise +

+
‘2’
+

180 degrees clockwise +

+
‘3’
+

270 degrees clockwise +

+
+ +

Default value is ‘000000’. +

+
+ +
+
‘eac’
+

Equi-Angular Cubemap. +

+
+
‘flat’
+
‘gnomonic’
+
‘rectilinear’
+

Regular video. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘dfisheye’
+

Dual fisheye. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘barrel’
+
‘fb’
+
‘barrelsplit’
+

Facebook’s 360 formats. +

+
+
‘sg’
+

Stereographic format. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘mercator’
+

Mercator format. +

+
+
‘ball’
+

Ball format, gives significant distortion toward the back. +

+
+
‘hammer’
+

Hammer-Aitoff map projection format. +

+
+
‘sinusoidal’
+

Sinusoidal map projection format. +

+
+
‘fisheye’
+

Fisheye projection. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘pannini’
+

Pannini projection. +

+

Format specific options: +

+
h_fov
+

Set output pannini parameter. +

+
+
ih_fov
+

Set input pannini parameter. +

+
+ +
+
‘cylindrical’
+

Cylindrical projection. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘perspective’
+

Perspective projection. (output only) +

+

Format specific options: +

+
v_fov
+

Set perspective parameter. +

+
+ +
+
‘tetrahedron’
+

Tetrahedron projection. +

+
+
‘tsp’
+

Truncated square pyramid projection. +

+
+
‘he’
+
‘hequirect’
+

Half equirectangular projection. +

+
+ +
+
interp
+

Set interpolation method.
+Note: more complex interpolation methods require much more memory to run. +

+

Available methods: +

+
+
‘near’
+
‘nearest’
+

Nearest neighbour. +

+
‘line’
+
‘linear’
+

Bilinear interpolation. +

+
‘lagrange9’
+

Lagrange9 interpolation. +

+
‘cube’
+
‘cubic’
+

Bicubic interpolation. +

+
‘lanc’
+
‘lanczos’
+

Lanczos interpolation. +

+
‘sp16’
+
‘spline16’
+

Spline16 interpolation. +

+
‘gauss’
+
‘gaussian’
+

Gaussian interpolation. +

+
+ +

Default value is ‘line’. +

+
+
w
+
h
+

Set the output video resolution. +

+

Default resolution depends on formats. +

+
+
in_stereo
+
out_stereo
+

Set the input/output stereo format. +

+
+
‘2d’
+

2D mono +

+
‘sbs’
+

Side by side +

+
‘tb’
+

Top bottom +

+
+ +

Default value is ‘2d’ for input and output format. +

+
+
yaw
+
pitch
+
roll
+

Set rotation for the output video. Values in degrees. +

+
+
rorder
+

Set rotation order for the output video. Choose one item for each position. +

+
+
‘y, Y’
+

yaw +

+
‘p, P’
+

pitch +

+
‘r, R’
+

roll +

+
+ +

Default value is ‘ypr’. +

+
+
h_flip
+
v_flip
+
d_flip
+

Flip the output video horizontally(swaps left-right)/vertically(swaps up-down)/in-depth(swaps back-forward). Boolean values. +

+
+
ih_flip
+
iv_flip
+

Set if input video is flipped horizontally/vertically. Boolean values. +

+
+
in_trans
+

Set if input video is transposed. Boolean value, by default disabled. +

+
+
out_trans
+

Set if output video needs to be transposed. Boolean value, by default disabled. +

+
+
alpha_mask
+

Build mask in alpha plane for all unmapped pixels by marking them fully transparent. Boolean value, by default disabled. +

+
+ + +

30.222.1 Examples

+ +
    +
  • Convert equirectangular video to cubemap with 3x2 layout and 1% padding using bicubic interpolation: +
    +
    ffmpeg -i input.mkv -vf v360=e:c3x2:cubic:out_pad=0.01 output.mkv
+
    +
  • Extract back view of Equi-Angular Cubemap: +
    +
    ffmpeg -i input.mkv -vf v360=eac:flat:yaw=180 output.mkv
+
    +
  • Convert transposed and horizontally flipped Equi-Angular Cubemap in side-by-side stereo format to equirectangular top-bottom stereo format: +
    +
    v360=eac:equirect:in_stereo=sbs:in_trans=1:ih_flip=1:out_stereo=tb
+
    +
+ + +

30.222.2 Commands

+ +

This filter supports subset of above options as commands. +

+ +

30.223 vaguedenoiser

+ +

Apply a wavelet based denoiser. +

+

It transforms each frame from the video input into the wavelet domain, +using Cohen-Daubechies-Feauveau 9/7. Then it applies some filtering to +the obtained coefficients. It does an inverse wavelet transform after. +Due to wavelet properties, it should give a nice smoothed result, and +reduced noise, without blurring picture features. +

+

This filter accepts the following options: +

+
+
threshold
+

The filtering strength. The higher, the more filtered the video will be. +Hard thresholding can use a higher threshold than soft thresholding +before the video looks overfiltered. Default value is 2. +

+
+
method
+

The filtering method the filter will use. +

+

It accepts the following values: +

+
‘hard’
+

All values under the threshold will be zeroed. +

+
+
‘soft’
+

All values under the threshold will be zeroed. All values above will be +reduced by the threshold. +

+
+
‘garrote’
+

Scales or nullifies coefficients - intermediary between (more) soft and +(less) hard thresholding. +

+
+ +

Default is garrote. +

+
+
nsteps
+

Number of times, the wavelet will decompose the picture. Picture can’t +be decomposed beyond a particular point (typically, 8 for a 640x480 +frame - as 2^9 = 512 > 480). Valid values are integers between 1 and 32. Default value is 6. +

+
+
percent
+

Partial of full denoising (limited coefficients shrinking), from 0 to 100. Default value is 85. +

+
+
planes
+

A list of the planes to process. By default all planes are processed. +

+
+
type
+

The threshold type the filter will use. +

+

It accepts the following values: +

+
‘universal’
+

Threshold used is same for all decompositions. +

+
+
‘bayes’
+

Threshold used depends also on each decomposition coefficients. +

+
+ +

Default is universal. +

+
+ + +

30.224 vectorscope

+ +

Display 2 color component values in the two dimensional graph (which is called +a vectorscope). +

+

This filter accepts the following options: +

+
+
mode, m
+

Set vectorscope mode. +

+

It accepts the following values: +

+
‘gray’
+
‘tint’
+

Gray values are displayed on graph, higher brightness means more pixels have +same component color value on location in graph. This is the default mode. +

+
+
‘color’
+

Gray values are displayed on graph. Surrounding pixels values which are not +present in video frame are drawn in gradient of 2 color components which are +set by option x and y. The 3rd color component is static. +

+
+
‘color2’
+

Actual color components values present in video frame are displayed on graph. +

+
+
‘color3’
+

Similar as color2 but higher frequency of same values x and y +on graph increases value of another color component, which is luminance by +default values of x and y. +

+
+
‘color4’
+

Actual colors present in video frame are displayed on graph. If two different +colors map to same position on graph then color with higher value of component +not present in graph is picked. +

+
+
‘color5’
+

Gray values are displayed on graph. Similar to color but with 3rd color +component picked from radial gradient. +

+
+ +
+
x
+

Set which color component will be represented on X-axis. Default is 1. +

+
+
y
+

Set which color component will be represented on Y-axis. Default is 2. +

+
+
intensity, i
+

Set intensity, used by modes: gray, color, color3 and color5 for increasing brightness +of color component which represents frequency of (X, Y) location in graph. +

+
+
envelope, e
+
+
‘none’
+

No envelope, this is default. +

+
+
‘instant’
+

Instant envelope, even darkest single pixel will be clearly highlighted. +

+
+
‘peak’
+

Hold maximum and minimum values presented in graph over time. This way you +can still spot out of range values without constantly looking at vectorscope. +

+
+
‘peak+instant’
+

Peak and instant envelope combined together. +

+
+ +
+
graticule, g
+

Set what kind of graticule to draw. +

+
‘none’
+
‘green’
+
‘color’
+
‘invert’
+
+ +
+
opacity, o
+

Set graticule opacity. +

+
+
flags, f
+

Set graticule flags. +

+
+
‘white’
+

Draw graticule for white point. +

+
+
‘black’
+

Draw graticule for black point. +

+
+
‘name’
+

Draw color points short names. +

+
+ +
+
bgopacity, b
+

Set background opacity. +

+
+
lthreshold, l
+

Set low threshold for color component not represented on X or Y axis. +Values lower than this value will be ignored. Default is 0. +Note this value is multiplied with actual max possible value one pixel component +can have. So for 8-bit input and low threshold value of 0.1 actual threshold +is 0.1 * 255 = 25. +

+
+
hthreshold, h
+

Set high threshold for color component not represented on X or Y axis. +Values higher than this value will be ignored. Default is 1. +Note this value is multiplied with actual max possible value one pixel component +can have. So for 8-bit input and high threshold value of 0.9 actual threshold +is 0.9 * 255 = 230. +

+
+
colorspace, c
+

Set what kind of colorspace to use when drawing graticule. +

+
‘auto’
+
‘601’
+
‘709’
+
+

Default is auto. +

+
+
tint0, t0
+
tint1, t1
+

Set color tint for gray/tint vectorscope mode. By default both options are zero. +This means no tint, and output will remain gray. +

+
+ + +

30.225 vidstabdetect

+ +

Analyze video stabilization/deshaking. Perform pass 1 of 2, see +vidstabtransform for pass 2. +

+

This filter generates a file with relative translation and rotation +transform information about subsequent frames, which is then used by +the vidstabtransform filter. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libvidstab. +

+

This filter accepts the following options: +

+
+
result
+

Set the path to the file used to write the transforms information. +Default value is transforms.trf. +

+
+
shakiness
+

Set how shaky the video is and how quick the camera is. It accepts an +integer in the range 1-10, a value of 1 means little shakiness, a +value of 10 means strong shakiness. Default value is 5. +

+
+
accuracy
+

Set the accuracy of the detection process. It must be a value in the +range 1-15. A value of 1 means low accuracy, a value of 15 means high +accuracy. Default value is 15. +

+
+
stepsize
+

Set stepsize of the search process. The region around minimum is +scanned with 1 pixel resolution. Default value is 6. +

+
+
mincontrast
+

Set minimum contrast. Below this value a local measurement field is +discarded. Must be a floating point value in the range 0-1. Default +value is 0.3. +

+
+
tripod
+

Set reference frame number for tripod mode. +

+

If enabled, the motion of the frames is compared to a reference frame +in the filtered stream, identified by the specified number. The idea +is to compensate all movements in a more-or-less static scene and keep +the camera view absolutely still. +

+

If set to 0, it is disabled. The frames are counted starting from 1. +

+
+
show
+

Show fields and transforms in the resulting frames. It accepts an +integer in the range 0-2. Default value is 0, which disables any +visualization. +

+
+ + +

30.225.1 Examples

+ +
    +
  • Use default values: +
    +
    vidstabdetect
+
    + +
  • Analyze strongly shaky movie and put the results in file +mytransforms.trf: +
    +
    vidstabdetect=shakiness=10:accuracy=15:result="mytransforms.trf"
+
    + +
  • Visualize the result of internal transformations in the resulting +video: +
    +
    vidstabdetect=show=1
+
    + +
  • Analyze a video with medium shakiness using ffmpeg: +
    +
    ffmpeg -i input -vf vidstabdetect=shakiness=5:show=1 dummy.avi
+
    +
+ + +

30.226 vidstabtransform

+ +

Video stabilization/deshaking: pass 2 of 2, +see vidstabdetect for pass 1. +

+

Read a file with transform information for each frame and +apply/compensate them. Together with the vidstabdetect +filter this can be used to deshake videos. See also +http://public.hronopik.de/vid.stab. It is important to also use +the unsharp filter, see below. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libvidstab. +

+ +

30.226.1 Options

+ +
+
input
+

Set path to the file used to read the transforms. Default value is +transforms.trf. +

+
+
smoothing
+

Set the number of frames (value*2 + 1) used for lowpass filtering the +camera movements. Default value is 10. +

+

For example a number of 10 means that 21 frames are used (10 in the +past and 10 in the future) to smoothen the motion in the video. A +larger value leads to a smoother video, but limits the acceleration of +the camera (pan/tilt movements). 0 is a special case where a static +camera is simulated. +

+
+
optalgo
+

Set the camera path optimization algorithm. +

+

Accepted values are: +

+
‘gauss’
+

gaussian kernel low-pass filter on camera motion (default) +

+
‘avg’
+

averaging on transformations +

+
+ +
+
maxshift
+

Set maximal number of pixels to translate frames. Default value is -1, +meaning no limit. +

+
+
maxangle
+

Set maximal angle in radians (degree*PI/180) to rotate frames. Default +value is -1, meaning no limit. +

+
+
crop
+

Specify how to deal with borders that may be visible due to movement +compensation. +

+

Available values are: +

+
‘keep’
+

keep image information from previous frame (default) +

+
‘black’
+

fill the border black +

+
+ +
+
invert
+

Invert transforms if set to 1. Default value is 0. +

+
+
relative
+

Consider transforms as relative to previous frame if set to 1, +absolute if set to 0. Default value is 0. +

+
+
zoom
+

Set percentage to zoom. A positive value will result in a zoom-in +effect, a negative value in a zoom-out effect. Default value is 0 (no +zoom). +

+
+
optzoom
+

Set optimal zooming to avoid borders. +

+

Accepted values are: +

+
‘0’
+

disabled +

+
‘1’
+

optimal static zoom value is determined (only very strong movements +will lead to visible borders) (default) +

+
‘2’
+

optimal adaptive zoom value is determined (no borders will be +visible), see zoomspeed +

+
+ +

Note that the value given at zoom is added to the one calculated here. +

+
+
zoomspeed
+

Set percent to zoom maximally each frame (enabled when +optzoom is set to 2). Range is from 0 to 5, default value is +0.25. +

+
+
interpol
+

Specify type of interpolation. +

+

Available values are: +

+
‘no’
+

no interpolation +

+
‘linear’
+

linear only horizontal +

+
‘bilinear’
+

linear in both directions (default) +

+
‘bicubic’
+

cubic in both directions (slow) +

+
+ +
+
tripod
+

Enable virtual tripod mode if set to 1, which is equivalent to +relative=0:smoothing=0. Default value is 0. +

+

Use also tripod option of vidstabdetect. +

+
+
debug
+

Increase log verbosity if set to 1. Also the detected global motions +are written to the temporary file global_motions.trf. Default +value is 0. +

+
+ + +

30.226.2 Examples

+ +
    +
  • Use ffmpeg for a typical stabilization with default values: +
    +
    ffmpeg -i inp.mpeg -vf vidstabtransform,unsharp=5:5:0.8:3:3:0.4 inp_stabilized.mpeg
+
    + +

    Note the use of the unsharp filter which is always recommended. +

    +
  • Zoom in a bit more and load transform data from a given file: +
    +
    vidstabtransform=zoom=5:input="mytransforms.trf"
+
    + +
  • Smoothen the video even more: +
    +
    vidstabtransform=smoothing=30
+
    +
+ + +

30.227 vflip

+ +

Flip the input video vertically. +

+

For example, to vertically flip a video with ffmpeg: +

+
ffmpeg -i in.avi -vf "vflip" out.avi
+
+ + +

30.228 vfrdet

+ +

Detect variable frame rate video. +

+

This filter tries to detect if the input is variable or constant frame rate. +

+

At end it will output number of frames detected as having variable delta pts, +and ones with constant delta pts. +If there was frames with variable delta, than it will also show min, max and +average delta encountered. +

+ +

30.229 vibrance

+ +

Boost or alter saturation. +

+

The filter accepts the following options: +

+
intensity
+

Set strength of boost if positive value or strength of alter if negative value. +Default is 0. Allowed range is from -2 to 2. +

+
+
rbal
+

Set the red balance. Default is 1. Allowed range is from -10 to 10. +

+
+
gbal
+

Set the green balance. Default is 1. Allowed range is from -10 to 10. +

+
+
bbal
+

Set the blue balance. Default is 1. Allowed range is from -10 to 10. +

+
+
rlum
+

Set the red luma coefficient. +

+
+
glum
+

Set the green luma coefficient. +

+
+
blum
+

Set the blue luma coefficient. +

+
+
alternate
+

If intensity is negative and this is set to 1, colors will change, +otherwise colors will be less saturated, more towards gray. +

+
+ + +

30.229.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

30.230 vignette

+ +

Make or reverse a natural vignetting effect. +

+

The filter accepts the following options: +

+
+
angle, a
+

Set lens angle expression as a number of radians. +

+

The value is clipped in the [0,PI/2] range. +

+

Default value: "PI/5" +

+
+
x0
+
y0
+

Set center coordinates expressions. Respectively "w/2" and "h/2" +by default. +

+
+
mode
+

Set forward/backward mode. +

+

Available modes are: +

+
‘forward’
+

The larger the distance from the central point, the darker the image becomes. +

+
+
‘backward’
+

The larger the distance from the central point, the brighter the image becomes. +This can be used to reverse a vignette effect, though there is no automatic +detection to extract the lens angle and other settings (yet). It can +also be used to create a burning effect. +

+
+ +

Default value is ‘forward’. +

+
+
eval
+

Set evaluation mode for the expressions (angle, x0, y0). +

+

It accepts the following values: +

+
‘init’
+

Evaluate expressions only once during the filter initialization. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. This is way slower than the +‘init’ mode since it requires all the scalers to be re-computed, but it +allows advanced dynamic expressions. +

+
+ +

Default value is ‘init’. +

+
+
dither
+

Set dithering to reduce the circular banding effects. Default is 1 +(enabled). +

+
+
aspect
+

Set vignette aspect. This setting allows one to adjust the shape of the vignette. +Setting this value to the SAR of the input will make a rectangular vignetting +following the dimensions of the video. +

+

Default is 1/1. +

+
+ + +

30.230.1 Expressions

+ +

The alpha, x0 and y0 expressions can contain the +following parameters. +

+
+
w
+
h
+

input width and height +

+
+
n
+

the number of input frame, starting from 0 +

+
+
pts
+

the PTS (Presentation TimeStamp) time of the filtered video frame, expressed in +TB units, NAN if undefined +

+
+
r
+

frame rate of the input video, NAN if the input frame rate is unknown +

+
+
t
+

the PTS (Presentation TimeStamp) of the filtered video frame, +expressed in seconds, NAN if undefined +

+
+
tb
+

time base of the input video +

+
+ + + +

30.230.2 Examples

+ +
    +
  • Apply simple strong vignetting effect: +
    +
    vignette=PI/4
+
    + +
  • Make a flickering vignetting: +
    +
    vignette='PI/4+random(1)*PI/50':eval=frame
+
    + +
+ + +

30.231 vmafmotion

+ +

Obtain the average VMAF motion score of a video. +It is one of the component metrics of VMAF. +

+

The obtained average motion score is printed through the logging system. +

+

The filter accepts the following options: +

+
+
stats_file
+

If specified, the filter will use the named file to save the motion score of +each frame with respect to the previous frame. +When filename equals "-" the data is sent to standard output. +

+
+ +

Example: +

+
ffmpeg -i ref.mpg -vf vmafmotion -f null -
+
+ + +

30.232 vstack

+

Stack input videos vertically. +

+

All streams must be of same pixel format and of same width. +

+

Note that this filter is faster than using overlay and pad filter +to create same output. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of input streams. Default is 2. +

+
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+ + +

30.233 w3fdif

+ +

Deinterlace the input video ("w3fdif" stands for "Weston 3 Field +Deinterlacing Filter"). +

+

Based on the process described by Martin Weston for BBC R&D, and +implemented based on the de-interlace algorithm written by Jim +Easterbrook for BBC R&D, the Weston 3 field deinterlacing filter +uses filter coefficients calculated by BBC R&D. +

+

This filter uses field-dominance information in frame to decide which +of each pair of fields to place first in the output. +If it gets it wrong use setfield filter before w3fdif filter. +

+

There are two sets of filter coefficients, so called "simple" +and "complex". Which set of filter coefficients is used can +be set by passing an optional parameter: +

+
+
filter
+

Set the interlacing filter coefficients. Accepts one of the following values: +

+
+
‘simple’
+

Simple filter coefficient set. +

+
‘complex’
+

More-complex filter coefficient set. +

+
+

Default value is ‘complex’. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following values: +

+
+
‘all’
+

Deinterlace all frames, +

+
‘interlaced’
+

Only deinterlace frames marked as interlaced. +

+
+ +

Default value is ‘all’. +

+
+ + +

30.234 waveform

+

Video waveform monitor. +

+

The waveform monitor plots color component intensity. By default luminance +only. Each column of the waveform corresponds to a column of pixels in the +source video. +

+

It accepts the following options: +

+
+
mode, m
+

Can be either row, or column. Default is column. +In row mode, the graph on the left side represents color component value 0 and +the right side represents value = 255. In column mode, the top side represents +color component value = 0 and bottom side represents value = 255. +

+
+
intensity, i
+

Set intensity. Smaller values are useful to find out how many values of the same +luminance are distributed across input rows/columns. +Default value is 0.04. Allowed range is [0, 1]. +

+
+
mirror, r
+

Set mirroring mode. 0 means unmirrored, 1 means mirrored. +In mirrored mode, higher values will be represented on the left +side for row mode and at the top for column mode. Default is +1 (mirrored). +

+
+
display, d
+

Set display mode. +It accepts the following values: +

+
‘overlay’
+

Presents information identical to that in the parade, except +that the graphs representing color components are superimposed directly +over one another. +

+

This display mode makes it easier to spot relative differences or similarities +in overlapping areas of the color components that are supposed to be identical, +such as neutral whites, grays, or blacks. +

+
+
‘stack’
+

Display separate graph for the color components side by side in +row mode or one below the other in column mode. +

+
+
‘parade’
+

Display separate graph for the color components side by side in +column mode or one below the other in row mode. +

+

Using this display mode makes it easy to spot color casts in the highlights +and shadows of an image, by comparing the contours of the top and the bottom +graphs of each waveform. Since whites, grays, and blacks are characterized +by exactly equal amounts of red, green, and blue, neutral areas of the picture +should display three waveforms of roughly equal width/height. If not, the +correction is easy to perform by making level adjustments the three waveforms. +

+
+

Default is stack. +

+
+
components, c
+

Set which color components to display. Default is 1, which means only luminance +or red color component if input is in RGB colorspace. If is set for example to +7 it will display all 3 (if) available color components. +

+
+
envelope, e
+
+
‘none’
+

No envelope, this is default. +

+
+
‘instant’
+

Instant envelope, minimum and maximum values presented in graph will be easily +visible even with small step value. +

+
+
‘peak’
+

Hold minimum and maximum values presented in graph across time. This way you +can still spot out of range values without constantly looking at waveforms. +

+
+
‘peak+instant’
+

Peak and instant envelope combined together. +

+
+ +
+
filter, f
+
+
‘lowpass’
+

No filtering, this is default. +

+
+
‘flat’
+

Luma and chroma combined together. +

+
+
‘aflat’
+

Similar as above, but shows difference between blue and red chroma. +

+
+
‘xflat’
+

Similar as above, but use different colors. +

+
+
‘yflat’
+

Similar as above, but again with different colors. +

+
+
‘chroma’
+

Displays only chroma. +

+
+
‘color’
+

Displays actual color value on waveform. +

+
+
‘acolor’
+

Similar as above, but with luma showing frequency of chroma values. +

+
+ +
+
graticule, g
+

Set which graticule to display. +

+
+
‘none’
+

Do not display graticule. +

+
+
‘green’
+

Display green graticule showing legal broadcast ranges. +

+
+
‘orange’
+

Display orange graticule showing legal broadcast ranges. +

+
+
‘invert’
+

Display invert graticule showing legal broadcast ranges. +

+
+ +
+
opacity, o
+

Set graticule opacity. +

+
+
flags, fl
+

Set graticule flags. +

+
+
‘numbers’
+

Draw numbers above lines. By default enabled. +

+
+
‘dots’
+

Draw dots instead of lines. +

+
+ +
+
scale, s
+

Set scale used for displaying graticule. +

+
+
‘digital’
+
‘millivolts’
+
‘ire’
+
+

Default is digital. +

+
+
bgopacity, b
+

Set background opacity. +

+
+
tint0, t0
+
tint1, t1
+

Set tint for output. +Only used with lowpass filter and when display is not overlay and input +pixel formats are not RGB. +

+
+ + +

30.235 weave, doubleweave

+ +

The weave takes a field-based video input and join +each two sequential fields into single frame, producing a new double +height clip with half the frame rate and half the frame count. +

+

The doubleweave works same as weave but without +halving frame rate and frame count. +

+

It accepts the following option: +

+
+
first_field
+

Set first field. Available values are: +

+
+
‘top, t’
+

Set the frame as top-field-first. +

+
+
‘bottom, b’
+

Set the frame as bottom-field-first. +

+
+
+
+ + +

30.235.1 Examples

+ +
    +
  • Interlace video using select and separatefields filter: +
    +
    separatefields,select=eq(mod(n,4),0)+eq(mod(n,4),3),weave
+
    +
+ + +

30.236 xbr

+

Apply the xBR high-quality magnification filter which is designed for pixel +art. It follows a set of edge-detection rules, see +https://forums.libretro.com/t/xbr-algorithm-tutorial/123. +

+

It accepts the following option: +

+
+
n
+

Set the scaling dimension: 2 for 2xBR, 3 for +3xBR and 4 for 4xBR. +Default is 3. +

+
+ + +

30.237 xfade

+ +

Apply cross fade from one input video stream to another input video stream. +The cross fade is applied for specified duration. +

+

The filter accepts the following options: +

+
+
transition
+

Set one of available transition effects: +

+
+
‘custom’
+
‘fade’
+
‘wipeleft’
+
‘wiperight’
+
‘wipeup’
+
‘wipedown’
+
‘slideleft’
+
‘slideright’
+
‘slideup’
+
‘slidedown’
+
‘circlecrop’
+
‘rectcrop’
+
‘distance’
+
‘fadeblack’
+
‘fadewhite’
+
‘radial’
+
‘smoothleft’
+
‘smoothright’
+
‘smoothup’
+
‘smoothdown’
+
‘circleopen’
+
‘circleclose’
+
‘vertopen’
+
‘vertclose’
+
‘horzopen’
+
‘horzclose’
+
‘dissolve’
+
‘pixelize’
+
‘diagtl’
+
‘diagtr’
+
‘diagbl’
+
‘diagbr’
+
‘hlslice’
+
‘hrslice’
+
‘vuslice’
+
‘vdslice’
+
+

Default transition effect is fade. +

+
+
duration
+

Set cross fade duration in seconds. +Default duration is 1 second. +

+
+
offset
+

Set cross fade start relative to first input stream in seconds. +Default offset is 0. +

+
+
expr
+

Set expression for custom transition effect. +

+

The expressions can use the following variables and functions: +

+
+
X
+
Y
+

The coordinates of the current sample. +

+
+
W
+
H
+

The width and height of the image. +

+
+
P
+

Progress of transition effect. +

+
+
PLANE
+

Currently processed plane. +

+
+
A
+

Return value of first input at current location and plane. +

+
+
B
+

Return value of second input at current location and plane. +

+
+
a0(x, y)
+
a1(x, y)
+
a2(x, y)
+
a3(x, y)
+

Return the value of the pixel at location (x,y) of the +first/second/third/fourth component of first input. +

+
+
b0(x, y)
+
b1(x, y)
+
b2(x, y)
+
b3(x, y)
+

Return the value of the pixel at location (x,y) of the +first/second/third/fourth component of second input. +

+
+
+
+ + +

30.237.1 Examples

+ +
    +
  • Cross fade from one input video to another input video, with fade transition and duration of transition +of 2 seconds starting at offset of 5 seconds: +
    +
    ffmpeg -i first.mp4 -i second.mp4 -filter_complex xfade=transition=fade:duration=2:offset=5 output.mp4
+
    +
+ + +

30.238 xmedian

+

Pick median pixels from several input videos. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of inputs. +Default is 3. Allowed range is from 3 to 255. +If number of inputs is even number, than result will be mean value between two median values. +

+
+
planes
+

Set which planes to filter. Default value is 15, by which all planes are processed. +

+
+
percentile
+

Set median percentile. Default value is 0.5. +Default value of 0.5 will pick always median values, while 0 will pick +minimum values, and 1 maximum values. +

+
+ + +

30.239 xstack

+

Stack video inputs into custom layout. +

+

All streams must be of same pixel format. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of input streams. Default is 2. +

+
+
layout
+

Specify layout of inputs. +This option requires the desired layout configuration to be explicitly set by the user. +This sets position of each video input in output. Each input +is separated by ’|’. +The first number represents the column, and the second number represents the row. +Numbers start at 0 and are separated by ’_’. Optionally one can use wX and hX, +where X is video input from which to take width or height. +Multiple values can be used when separated by ’+’. In such +case values are summed together. +

+

Note that if inputs are of different sizes gaps may appear, as not all of +the output video frame will be filled. Similarly, videos can overlap each +other if their position doesn’t leave enough space for the full frame of +adjoining videos. +

+

For 2 inputs, a default layout of 0_0|w0_0 is set. In all other cases, +a layout must be set by the user. +

+
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+
fill
+

If set to valid color, all unused pixels will be filled with that color. +By default fill is set to none, so it is disabled. +

+
+ + +

30.239.1 Examples

+ +
    +
  • Display 4 inputs into 2x2 grid. + +

    Layout: +

    +
    input1(0, 0)  | input3(w0, 0)
+input2(0, h0) | input4(w0, h0)
+
    + +
    +
    xstack=inputs=4:layout=0_0|0_h0|w0_0|w0_h0
+
    + +

    Note that if inputs are of different sizes, gaps or overlaps may occur. +

    +
  • Display 4 inputs into 1x4 grid. + +

    Layout: +

    +
    input1(0, 0)
+input2(0, h0)
+input3(0, h0+h1)
+input4(0, h0+h1+h2)
+
    + +
    +
    xstack=inputs=4:layout=0_0|0_h0|0_h0+h1|0_h0+h1+h2
+
    + +

    Note that if inputs are of different widths, unused space will appear. +

    +
  • Display 9 inputs into 3x3 grid. + +

    Layout: +

    +
    input1(0, 0)       | input4(w0, 0)      | input7(w0+w3, 0)
+input2(0, h0)      | input5(w0, h0)     | input8(w0+w3, h0)
+input3(0, h0+h1)   | input6(w0, h0+h1)  | input9(w0+w3, h0+h1)
+
    + +
    +
    xstack=inputs=9:layout=0_0|0_h0|0_h0+h1|w0_0|w0_h0|w0_h0+h1|w0+w3_0|w0+w3_h0|w0+w3_h0+h1
+
    + +

    Note that if inputs are of different sizes, gaps or overlaps may occur. +

    +
  • Display 16 inputs into 4x4 grid. + +

    Layout: +

    +
    input1(0, 0)       | input5(w0, 0)       | input9 (w0+w4, 0)       | input13(w0+w4+w8, 0)
+input2(0, h0)      | input6(w0, h0)      | input10(w0+w4, h0)      | input14(w0+w4+w8, h0)
+input3(0, h0+h1)   | input7(w0, h0+h1)   | input11(w0+w4, h0+h1)   | input15(w0+w4+w8, h0+h1)
+input4(0, h0+h1+h2)| input8(w0, h0+h1+h2)| input12(w0+w4, h0+h1+h2)| input16(w0+w4+w8, h0+h1+h2)
+
    + +
    +
    xstack=inputs=16:layout=0_0|0_h0|0_h0+h1|0_h0+h1+h2|w0_0|w0_h0|w0_h0+h1|w0_h0+h1+h2|w0+w4_0|
+w0+w4_h0|w0+w4_h0+h1|w0+w4_h0+h1+h2|w0+w4+w8_0|w0+w4+w8_h0|w0+w4+w8_h0+h1|w0+w4+w8_h0+h1+h2
+
    + +

    Note that if inputs are of different sizes, gaps or overlaps may occur. +

    +
+ + +

30.240 yadif

+ +

Deinterlace the input video ("yadif" means "yet another deinterlacing +filter"). +

+

It accepts the following parameters: +

+ +
+
mode
+

The interlacing mode to adopt. It accepts one of the following values: +

+
+
0, send_frame
+

Output one frame for each frame. +

+
1, send_field
+

Output one frame for each field. +

+
2, send_frame_nospatial
+

Like send_frame, but it skips the spatial interlacing check. +

+
3, send_field_nospatial
+

Like send_field, but it skips the spatial interlacing check. +

+
+ +

The default value is send_frame. +

+
+
parity
+

The picture field parity assumed for the input interlaced video. It accepts one +of the following values: +

+
+
0, tff
+

Assume the top field is first. +

+
1, bff
+

Assume the bottom field is first. +

+
-1, auto
+

Enable automatic detection of field parity. +

+
+ +

The default value is auto. +If the interlacing is unknown or the decoder does not export this information, +top field first will be assumed. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following +values: +

+
+
0, all
+

Deinterlace all frames. +

+
1, interlaced
+

Only deinterlace frames marked as interlaced. +

+
+ +

The default value is all. +

+
+ + +

30.241 yadif_cuda

+ +

Deinterlace the input video using the yadif algorithm, but implemented +in CUDA so that it can work as part of a GPU accelerated pipeline with nvdec +and/or nvenc. +

+

It accepts the following parameters: +

+ +
+
mode
+

The interlacing mode to adopt. It accepts one of the following values: +

+
+
0, send_frame
+

Output one frame for each frame. +

+
1, send_field
+

Output one frame for each field. +

+
2, send_frame_nospatial
+

Like send_frame, but it skips the spatial interlacing check. +

+
3, send_field_nospatial
+

Like send_field, but it skips the spatial interlacing check. +

+
+ +

The default value is send_frame. +

+
+
parity
+

The picture field parity assumed for the input interlaced video. It accepts one +of the following values: +

+
+
0, tff
+

Assume the top field is first. +

+
1, bff
+

Assume the bottom field is first. +

+
-1, auto
+

Enable automatic detection of field parity. +

+
+ +

The default value is auto. +If the interlacing is unknown or the decoder does not export this information, +top field first will be assumed. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following +values: +

+
+
0, all
+

Deinterlace all frames. +

+
1, interlaced
+

Only deinterlace frames marked as interlaced. +

+
+ +

The default value is all. +

+
+ + +

30.242 yaepblur

+ +

Apply blur filter while preserving edges ("yaepblur" means "yet another edge preserving blur filter"). +The algorithm is described in +"J. S. Lee, Digital image enhancement and noise filtering by use of local statistics, IEEE Trans. Pattern Anal. Mach. Intell. PAMI-2, 1980." +

+

It accepts the following parameters: +

+
+
radius, r
+

Set the window radius. Default value is 3. +

+
+
planes, p
+

Set which planes to filter. Default is only the first plane. +

+
+
sigma, s
+

Set blur strength. Default value is 128. +

+
+ + +

30.242.1 Commands

+

This filter supports same commands as options. +

+ +

30.243 zoompan

+ +

Apply Zoom & Pan effect. +

+

This filter accepts the following options: +

+
+
zoom, z
+

Set the zoom expression. Range is 1-10. Default is 1. +

+
+
x
+
y
+

Set the x and y expression. Default is 0. +

+
+
d
+

Set the duration expression in number of frames. +This sets for how many number of frames effect will last for +single input image. +

+
+
s
+

Set the output image size, default is ’hd720’. +

+
+
fps
+

Set the output frame rate, default is ’25’. +

+
+ +

Each expression can contain the following constants: +

+
+
in_w, iw
+

Input width. +

+
+
in_h, ih
+

Input height. +

+
+
out_w, ow
+

Output width. +

+
+
out_h, oh
+

Output height. +

+
+
in
+

Input frame count. +

+
+
on
+

Output frame count. +

+
+
x
+
y
+

Last calculated ’x’ and ’y’ position from ’x’ and ’y’ expression +for current input frame. +

+
+
px
+
py
+

’x’ and ’y’ of last output frame of previous input frame or 0 when there was +not yet such frame (first input frame). +

+
+
zoom
+

Last calculated zoom from ’z’ expression for current input frame. +

+
+
pzoom
+

Last calculated zoom of last output frame of previous input frame. +

+
+
duration
+

Number of output frames for current input frame. Calculated from ’d’ expression +for each input frame. +

+
+
pduration
+

number of output frames created for previous input frame +

+
+
a
+

Rational number: input width / input height +

+
+
sar
+

sample aspect ratio +

+
+
dar
+

display aspect ratio +

+
+
+ + +

30.243.1 Examples

+ +
    +
  • Zoom-in up to 1.5 and pan at same time to some spot near center of picture: +
    +
    zoompan=z='min(zoom+0.0015,1.5)':d=700:x='if(gte(zoom,1.5),x,x+1/a)':y='if(gte(zoom,1.5),y,y+1)':s=640x360
+
    + +
  • Zoom-in up to 1.5 and pan always at center of picture: +
    +
    zoompan=z='min(zoom+0.0015,1.5)':d=700:x='iw/2-(iw/zoom/2)':y='ih/2-(ih/zoom/2)'
+
    + +
  • Same as above but without pausing: +
    +
    zoompan=z='min(max(zoom,pzoom)+0.0015,1.5)':d=1:x='iw/2-(iw/zoom/2)':y='ih/2-(ih/zoom/2)'
+
    +
+ + +

30.244 zscale

+

Scale (resize) the input video, using the z.lib library: +https://github.com/sekrit-twc/zimg. To enable compilation of this +filter, you need to configure FFmpeg with --enable-libzimg. +

+

The zscale filter forces the output display aspect ratio to be the same +as the input, by changing the output sample aspect ratio. +

+

If the input image format is different from the format requested by +the next filter, the zscale filter will convert the input to the +requested format. +

+ +

30.244.1 Options

+

The filter accepts the following options. +

+
+
width, w
+
height, h
+

Set the output video dimension expression. Default value is the input +dimension. +

+

If the width or w value is 0, the input width is used for +the output. If the height or h value is 0, the input height +is used for the output. +

+

If one and only one of the values is -n with n >= 1, the zscale filter +will use a value that maintains the aspect ratio of the input image, +calculated from the other specified dimension. After that it will, +however, make sure that the calculated dimension is divisible by n and +adjust the value if necessary. +

+

If both values are -n with n >= 1, the behavior will be identical to +both values being set to 0 as previously detailed. +

+

See below for the list of accepted constants for use in the dimension +expression. +

+
+
size, s
+

Set the video size. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
dither, d
+

Set the dither type. +

+

Possible values are: +

+
none
+
ordered
+
random
+
error_diffusion
+
+ +

Default is none. +

+
+
filter, f
+

Set the resize filter type. +

+

Possible values are: +

+
point
+
bilinear
+
bicubic
+
spline16
+
spline36
+
lanczos
+
+ +

Default is bilinear. +

+
+
range, r
+

Set the color range. +

+

Possible values are: +

+
input
+
limited
+
full
+
+ +

Default is same as input. +

+
+
primaries, p
+

Set the color primaries. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
170m
+
240m
+
2020
+
+ +

Default is same as input. +

+
+
transfer, t
+

Set the transfer characteristics. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
601
+
linear
+
2020_10
+
2020_12
+
smpte2084
+
iec61966-2-1
+
arib-std-b67
+
+ +

Default is same as input. +

+
+
matrix, m
+

Set the colorspace matrix. +

+

Possible value are: +

+
input
+
709
+
unspecified
+
470bg
+
170m
+
2020_ncl
+
2020_cl
+
+ +

Default is same as input. +

+
+
rangein, rin
+

Set the input color range. +

+

Possible values are: +

+
input
+
limited
+
full
+
+ +

Default is same as input. +

+
+
primariesin, pin
+

Set the input color primaries. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
170m
+
240m
+
2020
+
+ +

Default is same as input. +

+
+
transferin, tin
+

Set the input transfer characteristics. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
601
+
linear
+
2020_10
+
2020_12
+
+ +

Default is same as input. +

+
+
matrixin, min
+

Set the input colorspace matrix. +

+

Possible value are: +

+
input
+
709
+
unspecified
+
470bg
+
170m
+
2020_ncl
+
2020_cl
+
+ +
+
chromal, c
+

Set the output chroma location. +

+

Possible values are: +

+
input
+
left
+
center
+
topleft
+
top
+
bottomleft
+
bottom
+
+ +
+
chromalin, cin
+

Set the input chroma location. +

+

Possible values are: +

+
input
+
left
+
center
+
topleft
+
top
+
bottomleft
+
bottom
+
+ +
+
npl
+

Set the nominal peak luminance. +

+
+ +

The values of the w and h options are expressions +containing the following constants: +

+
+
in_w
+
in_h
+

The input width and height +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output (scaled) width and height +

+
+
ow
+
oh
+

These are the same as out_w and out_h +

+
+
a
+

The same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

The input display aspect ratio. Calculated from (iw / ih) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical input chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
ohsub
+
ovsub
+

horizontal and vertical output chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+ + +

30.244.2 Commands

+ +

This filter supports the following commands: +

+
width, w
+
height, h
+

Set the output video dimension expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + + +

31 OpenCL Video Filters

+ +

Below is a description of the currently available OpenCL video filters. +

+

To enable compilation of these filters you need to configure FFmpeg with +--enable-opencl. +

+

Running OpenCL filters requires you to initialize a hardware device and to pass that device to all filters in any filter graph. +

+
-init_hw_device opencl[=name][:device[,key=value...]]
+

Initialise a new hardware device of type opencl called name, using the +given device parameters. +

+
+
-filter_hw_device name
+

Pass the hardware device called name to all filters in any filter graph. +

+
+
+ +

For more detailed information see https://www.ffmpeg.org/ffmpeg.html#Advanced-Video-options +

+
    +
  • Example of choosing the first device on the second platform and running avgblur_opencl filter with default parameters on it. +
    +
    -init_hw_device opencl=gpu:1.0 -filter_hw_device gpu -i INPUT -vf "hwupload, avgblur_opencl, hwdownload" OUTPUT
+
    +
+ +

Since OpenCL filters are not able to access frame data in normal memory, all frame data needs to be uploaded(hwupload) to hardware surfaces connected to the appropriate device before being used and then downloaded(hwdownload) back to normal memory. Note that hwupload will upload to a surface with the same layout as the software frame, so it may be necessary to add a format filter immediately before to get the input into the right format and hwdownload does not support all formats on the output - it may be necessary to insert an additional format filter immediately following in the graph to get the output in a supported format. +

+ +

31.1 avgblur_opencl

+ +

Apply average blur filter. +

+

The filter accepts the following options: +

+
+
sizeX
+

Set horizontal radius size. +Range is [1, 1024] and default value is 1. +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
sizeY
+

Set vertical radius size. Range is [1, 1024] and default value is 0. If zero, sizeX value will be used. +

+
+ + +

31.1.1 Example

+ +
    +
  • Apply average blur filter with horizontal and vertical size of 3, setting each pixel of the output to the average value of the 7x7 region centered on it in the input. For pixels on the edges of the image, the region does not extend beyond the image boundaries, and so out-of-range coordinates are not used in the calculations. +
    +
    -i INPUT -vf "hwupload, avgblur_opencl=3, hwdownload" OUTPUT
+
    +
+ + +

31.2 boxblur_opencl

+ +

Apply a boxblur algorithm to the input video. +

+

It accepts the following parameters: +

+
+
luma_radius, lr
+
luma_power, lp
+
chroma_radius, cr
+
chroma_power, cp
+
alpha_radius, ar
+
alpha_power, ap
+
+ +

A description of the accepted options follows. +

+
+
luma_radius, lr
+
chroma_radius, cr
+
alpha_radius, ar
+

Set an expression for the box radius in pixels used for blurring the +corresponding input plane. +

+

The radius value must be a non-negative number, and must not be +greater than the value of the expression min(w,h)/2 for the +luma and alpha planes, and of min(cw,ch)/2 for the chroma +planes. +

+

Default value for luma_radius is "2". If not specified, +chroma_radius and alpha_radius default to the +corresponding value set for luma_radius. +

+

The expressions can contain the following constants: +

+
w
+
h
+

The input width and height in pixels. +

+
+
cw
+
ch
+

The input chroma image width and height in pixels. +

+
+
hsub
+
vsub
+

The horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p", hsub is 2 and vsub is 1. +

+
+ +
+
luma_power, lp
+
chroma_power, cp
+
alpha_power, ap
+

Specify how many times the boxblur filter is applied to the +corresponding plane. +

+

Default value for luma_power is 2. If not specified, +chroma_power and alpha_power default to the +corresponding value set for luma_power. +

+

A value of 0 will disable the effect. +

+
+ + +

31.2.1 Examples

+ +

Apply boxblur filter, setting each pixel of the output to the average value of box-radiuses luma_radius, chroma_radius, alpha_radius for each plane respectively. The filter will apply luma_power, chroma_power, alpha_power times onto the corresponding plane. For pixels on the edges of the image, the radius does not extend beyond the image boundaries, and so out-of-range coordinates are not used in the calculations. +

+
    +
  • Apply a boxblur filter with the luma, chroma, and alpha radius +set to 2 and luma, chroma, and alpha power set to 3. The filter will run 3 times with box-radius set to 2 for every plane of the image. +
    +
    -i INPUT -vf "hwupload, boxblur_opencl=luma_radius=2:luma_power=3, hwdownload" OUTPUT
+-i INPUT -vf "hwupload, boxblur_opencl=2:3, hwdownload" OUTPUT
+
    + +
  • Apply a boxblur filter with luma radius set to 2, luma_power to 1, chroma_radius to 4, chroma_power to 5, alpha_radius to 3 and alpha_power to 7. + +

    For the luma plane, a 2x2 box radius will be run once. +

    +

    For the chroma plane, a 4x4 box radius will be run 5 times. +

    +

    For the alpha plane, a 3x3 box radius will be run 7 times. +

    +
    -i INPUT -vf "hwupload, boxblur_opencl=2:1:4:5:3:7, hwdownload" OUTPUT
+
    +
+ + +

31.3 colorkey_opencl

+

RGB colorspace color keying. +

+

The filter accepts the following options: +

+
+
color
+

The color which will be replaced with transparency. +

+
+
similarity
+

Similarity percentage with the key color. +

+

0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +

+

0.0 makes pixels either fully transparent, or not transparent at all. +

+

Higher values result in semi-transparent pixels, with a higher transparency +the more similar the pixels color is to the key color. +

+
+ + +

31.3.1 Examples

+ +
    +
  • Make every semi-green pixel in the input transparent with some slight blending: +
    +
    -i INPUT -vf "hwupload, colorkey_opencl=green:0.3:0.1, hwdownload" OUTPUT
+
    +
+ + +

31.4 convolution_opencl

+ +

Apply convolution of 3x3, 5x5, 7x7 matrix. +

+

The filter accepts the following options: +

+
+
0m
+
1m
+
2m
+
3m
+

Set matrix for each plane. +Matrix is sequence of 9, 25 or 49 signed numbers. +Default value for each plane is 0 0 0 0 1 0 0 0 0. +

+
+
0rdiv
+
1rdiv
+
2rdiv
+
3rdiv
+

Set multiplier for calculated value for each plane. +If unset or 0, it will be sum of all matrix elements. +The option value must be a float number greater or equal to 0.0. Default value is 1.0. +

+
+
0bias
+
1bias
+
2bias
+
3bias
+

Set bias for each plane. This value is added to the result of the multiplication. +Useful for making the overall image brighter or darker. +The option value must be a float number greater or equal to 0.0. Default value is 0.0. +

+
+
+ + +

31.4.1 Examples

+ +
    +
  • Apply sharpen: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0, hwdownload" OUTPUT
+
    + +
  • Apply blur: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1/9:1/9:1/9:1/9, hwdownload" OUTPUT
+
    + +
  • Apply edge enhance: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:5:1:1:1:0:128:128:128, hwdownload" OUTPUT
+
    + +
  • Apply edge detect: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:5:5:5:1:0:128:128:128, hwdownload" OUTPUT
+
    + +
  • Apply laplacian edge detector which includes diagonals: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:5:5:5:1:0:128:128:0, hwdownload" OUTPUT
+
    + +
  • Apply emboss: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2, hwdownload" OUTPUT
+
    +
+ + +

31.5 erosion_opencl

+ +

Apply erosion effect to the video. +

+

This filter replaces the pixel by the local(3x3) minimum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane. Range is [0, 65535] and default value is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. +Range is [0, 255] and default value is 255, i.e. all eight pixels are used. +

+

Flags to local 3x3 coordinates region centered on x: +

+

1 2 3 +

+

4 x 5 +

+

6 7 8 +

+
+ + +

31.5.1 Example

+ +
    +
  • Apply erosion filter with threshold0 set to 30, threshold1 set 40, threshold2 set to 50 and coordinates set to 231, setting each pixel of the output to the local minimum between pixels: 1, 2, 3, 6, 7, 8 of the 3x3 region centered on it in the input. If the difference between input pixel and local minimum is more then threshold of the corresponding plane, output pixel will be set to input pixel - threshold of corresponding plane. +
    +
    -i INPUT -vf "hwupload, erosion_opencl=30:40:50:coordinates=231, hwdownload" OUTPUT
+
    +
+ + +

31.6 deshake_opencl

+

Feature-point based video stabilization filter. +

+

The filter accepts the following options: +

+
+
tripod
+

Simulates a tripod by preventing any camera movement whatsoever from the original frame. Defaults to 0. +

+
+
debug
+

Whether or not additional debug info should be displayed, both in the processed output and in the console. +

+

Note that in order to see console debug output you will also need to pass -v verbose to ffmpeg. +

+

Viewing point matches in the output video is only supported for RGB input. +

+

Defaults to 0. +

+
+
adaptive_crop
+

Whether or not to do a tiny bit of cropping at the borders to cut down on the amount of mirrored pixels. +

+

Defaults to 1. +

+
+
refine_features
+

Whether or not feature points should be refined at a sub-pixel level. +

+

This can be turned off for a slight performance gain at the cost of precision. +

+

Defaults to 1. +

+
+
smooth_strength
+

The strength of the smoothing applied to the camera path from 0.0 to 1.0. +

+

1.0 is the maximum smoothing strength while values less than that result in less smoothing. +

+

0.0 causes the filter to adaptively choose a smoothing strength on a per-frame basis. +

+

Defaults to 0.0. +

+
+
smooth_window_multiplier
+

Controls the size of the smoothing window (the number of frames buffered to determine motion information from). +

+

The size of the smoothing window is determined by multiplying the framerate of the video by this number. +

+

Acceptable values range from 0.1 to 10.0. +

+

Larger values increase the amount of motion data available for determining how to smooth the camera path, +potentially improving smoothness, but also increase latency and memory usage. +

+

Defaults to 2.0. +

+
+
+ + +

31.6.1 Examples

+ +
    +
  • Stabilize a video with a fixed, medium smoothing strength: +
    +
    -i INPUT -vf "hwupload, deshake_opencl=smooth_strength=0.5, hwdownload" OUTPUT
+
    + +
  • Stabilize a video with debugging (both in console and in rendered video): +
    +
    -i INPUT -filter_complex "[0:v]format=rgba, hwupload, deshake_opencl=debug=1, hwdownload, format=rgba, format=yuv420p" -v verbose OUTPUT
+
    +
+ + +

31.7 dilation_opencl

+ +

Apply dilation effect to the video. +

+

This filter replaces the pixel by the local(3x3) maximum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane. Range is [0, 65535] and default value is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. +Range is [0, 255] and default value is 255, i.e. all eight pixels are used. +

+

Flags to local 3x3 coordinates region centered on x: +

+

1 2 3 +

+

4 x 5 +

+

6 7 8 +

+
+ + +

31.7.1 Example

+ +
    +
  • Apply dilation filter with threshold0 set to 30, threshold1 set 40, threshold2 set to 50 and coordinates set to 231, setting each pixel of the output to the local maximum between pixels: 1, 2, 3, 6, 7, 8 of the 3x3 region centered on it in the input. If the difference between input pixel and local maximum is more then threshold of the corresponding plane, output pixel will be set to input pixel + threshold of corresponding plane. +
    +
    -i INPUT -vf "hwupload, dilation_opencl=30:40:50:coordinates=231, hwdownload" OUTPUT
+
    +
+ + +

31.8 nlmeans_opencl

+ +

Non-local Means denoise filter through OpenCL, this filter accepts same options as nlmeans. +

+ +

31.9 overlay_opencl

+ +

Overlay one video on top of another. +

+

It takes two inputs and has one output. The first input is the "main" video on which the second input is overlaid. +This filter requires same memory layout for all the inputs. So, format conversion may be needed. +

+

The filter accepts the following options: +

+
+
x
+

Set the x coordinate of the overlaid video on the main video. +Default value is 0. +

+
+
y
+

Set the y coordinate of the overlaid video on the main video. +Default value is 0. +

+
+
+ + +

31.9.1 Examples

+ +
    +
  • Overlay an image LOGO at the top-left corner of the INPUT video. Both inputs are yuv420p format. +
    +
    -i INPUT -i LOGO -filter_complex "[0:v]hwupload[a], [1:v]format=yuv420p, hwupload[b], [a][b]overlay_opencl, hwdownload" OUTPUT
+
    +
  • The inputs have same memory layout for color channels , the overlay has additional alpha plane, like INPUT is yuv420p, and the LOGO is yuva420p. +
    +
    -i INPUT -i LOGO -filter_complex "[0:v]hwupload[a], [1:v]format=yuva420p, hwupload[b], [a][b]overlay_opencl, hwdownload" OUTPUT
+
    + +
+ + +

31.10 pad_opencl

+ +

Add paddings to the input image, and place the original input at the +provided x, y coordinates. +

+

It accepts the following options: +

+
+
width, w
+
height, h
+

Specify an expression for the size of the output image with the +paddings added. If the value for width or height is 0, the +corresponding input size is used for the output. +

+

The width expression can reference the value set by the +height expression, and vice versa. +

+

The default value of width and height is 0. +

+
+
x
+
y
+

Specify the offsets to place the input image at within the padded area, +with respect to the top/left border of the output image. +

+

The x expression can reference the value set by the y +expression, and vice versa. +

+

The default value of x and y is 0. +

+

If x or y evaluate to a negative number, they’ll be changed +so the input image is centered on the padded area. +

+
+
color
+

Specify the color of the padded area. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. +

+
+
aspect
+

Pad to an aspect instead to a resolution. +

+
+ +

The value for the width, height, x, and y +options are expressions containing the following constants: +

+
+
in_w
+
in_h
+

The input video width and height. +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output width and height (the size of the padded area), as +specified by the width and height expressions. +

+
+
ow
+
oh
+

These are the same as out_w and out_h. +

+
+
x
+
y
+

The x and y offsets as specified by the x and y +expressions, or NAN if not yet specified. +

+
+
a
+

same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (iw / ih) * sar +

+
+ + +

31.11 prewitt_opencl

+ +

Apply the Prewitt operator (https://en.wikipedia.org/wiki/Prewitt_operator) to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +Range is [0.0, 65535] and default value is 1.0. +

+
+
delta
+

Set value which will be added to filtered result. +Range is [-65535, 65535] and default value is 0.0. +

+
+ + +

31.11.1 Example

+ +
    +
  • Apply the Prewitt operator with scale set to 2 and delta set to 10. +
    +
    -i INPUT -vf "hwupload, prewitt_opencl=scale=2:delta=10, hwdownload" OUTPUT
+
    +
+ + +

31.12 program_opencl

+ +

Filter video using an OpenCL program. +

+
+
source
+

OpenCL program source file. +

+
+
kernel
+

Kernel name in program. +

+
+
inputs
+

Number of inputs to the filter. Defaults to 1. +

+
+
size, s
+

Size of output frames. Defaults to the same as the first input. +

+
+
+ +

The program_opencl filter also supports the framesync options. +

+

The program source file must contain a kernel function with the given name, +which will be run once for each plane of the output. Each run on a plane +gets enqueued as a separate 2D global NDRange with one work-item for each +pixel to be generated. The global ID offset for each work-item is therefore +the coordinates of a pixel in the destination image. +

+

The kernel function needs to take the following arguments: +

    +
  • Destination image, __write_only image2d_t. + +

    This image will become the output; the kernel should write all of it. +

  • Frame index, unsigned int. + +

    This is a counter starting from zero and increasing by one for each frame. +

  • Source images, __read_only image2d_t. + +

    These are the most recent images on each input. The kernel may read from +them to generate the output, but they can’t be written to. +

+ +

Example programs: +

+
    +
  • Copy the input to the output (output must be the same size as the input). +
    __kernel void copy(__write_only image2d_t destination,
+                   unsigned int index,
+                   __read_only  image2d_t source)
+{
+    const sampler_t sampler = CLK_NORMALIZED_COORDS_FALSE;
+
+    int2 location = (int2)(get_global_id(0), get_global_id(1));
+
+    float4 value = read_imagef(source, sampler, location);
+
+    write_imagef(destination, location, value);
+}
+
    +
  • Apply a simple transformation, rotating the input by an amount increasing +with the index counter. Pixel values are linearly interpolated by the +sampler, and the output need not have the same dimensions as the input. +
    __kernel void rotate_image(__write_only image2d_t dst,
+                           unsigned int index,
+                           __read_only  image2d_t src)
+{
+    const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE |
+                               CLK_FILTER_LINEAR);
+
+    float angle = (float)index / 100.0f;
+
+    float2 dst_dim = convert_float2(get_image_dim(dst));
+    float2 src_dim = convert_float2(get_image_dim(src));
+
+    float2 dst_cen = dst_dim / 2.0f;
+    float2 src_cen = src_dim / 2.0f;
+
+    int2   dst_loc = (int2)(get_global_id(0), get_global_id(1));
+
+    float2 dst_pos = convert_float2(dst_loc) - dst_cen;
+    float2 src_pos = {
+        cos(angle) * dst_pos.x - sin(angle) * dst_pos.y,
+        sin(angle) * dst_pos.x + cos(angle) * dst_pos.y
+    };
+    src_pos = src_pos * src_dim / dst_dim;
+
+    float2 src_loc = src_pos + src_cen;
+
+    if (src_loc.x < 0.0f      || src_loc.y < 0.0f ||
+        src_loc.x > src_dim.x || src_loc.y > src_dim.y)
+        write_imagef(dst, dst_loc, 0.5f);
+    else
+        write_imagef(dst, dst_loc, read_imagef(src, sampler, src_loc));
+}
+
    +
  • Blend two inputs together, with the amount of each input used varying +with the index counter. +
    __kernel void blend_images(__write_only image2d_t dst,
+                           unsigned int index,
+                           __read_only  image2d_t src1,
+                           __read_only  image2d_t src2)
+{
+    const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE |
+                               CLK_FILTER_LINEAR);
+
+    float blend = (cos((float)index / 50.0f) + 1.0f) / 2.0f;
+
+    int2  dst_loc = (int2)(get_global_id(0), get_global_id(1));
+    int2 src1_loc = dst_loc * get_image_dim(src1) / get_image_dim(dst);
+    int2 src2_loc = dst_loc * get_image_dim(src2) / get_image_dim(dst);
+
+    float4 val1 = read_imagef(src1, sampler, src1_loc);
+    float4 val2 = read_imagef(src2, sampler, src2_loc);
+
+    write_imagef(dst, dst_loc, val1 * blend + val2 * (1.0f - blend));
+}
+
    +
+ + +

31.13 roberts_opencl

+

Apply the Roberts cross operator (https://en.wikipedia.org/wiki/Roberts_cross) to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +Range is [0.0, 65535] and default value is 1.0. +

+
+
delta
+

Set value which will be added to filtered result. +Range is [-65535, 65535] and default value is 0.0. +

+
+ + +

31.13.1 Example

+ +
    +
  • Apply the Roberts cross operator with scale set to 2 and delta set to 10 +
    +
    -i INPUT -vf "hwupload, roberts_opencl=scale=2:delta=10, hwdownload" OUTPUT
+
    +
+ + +

31.14 sobel_opencl

+ +

Apply the Sobel operator (https://en.wikipedia.org/wiki/Sobel_operator) to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +Range is [0.0, 65535] and default value is 1.0. +

+
+
delta
+

Set value which will be added to filtered result. +Range is [-65535, 65535] and default value is 0.0. +

+
+ + +

31.14.1 Example

+ +
    +
  • Apply sobel operator with scale set to 2 and delta set to 10 +
    +
    -i INPUT -vf "hwupload, sobel_opencl=scale=2:delta=10, hwdownload" OUTPUT
+
    +
+ + +

31.15 tonemap_opencl

+ +

Perform HDR(PQ/HLG) to SDR conversion with tone-mapping. +

+

It accepts the following parameters: +

+
+
tonemap
+

Specify the tone-mapping operator to be used. Same as tonemap option in tonemap. +

+
+
param
+

Tune the tone mapping algorithm. same as param option in tonemap. +

+
+
desat
+

Apply desaturation for highlights that exceed this level of brightness. The +higher the parameter, the more color information will be preserved. This +setting helps prevent unnaturally blown-out colors for super-highlights, by +(smoothly) turning into white instead. This makes images feel more natural, +at the cost of reducing information about out-of-range colors. +

+

The default value is 0.5, and the algorithm here is a little different from +the cpu version tonemap currently. A setting of 0.0 disables this option. +

+
+
threshold
+

The tonemapping algorithm parameters is fine-tuned per each scene. And a threshold +is used to detect whether the scene has changed or not. If the distance between +the current frame average brightness and the current running average exceeds +a threshold value, we would re-calculate scene average and peak brightness. +The default value is 0.2. +

+
+
format
+

Specify the output pixel format. +

+

Currently supported formats are: +

+
p010
+
nv12
+
+ +
+
range, r
+

Set the output color range. +

+

Possible values are: +

+
tv/mpeg
+
pc/jpeg
+
+ +

Default is same as input. +

+
+
primaries, p
+

Set the output color primaries. +

+

Possible values are: +

+
bt709
+
bt2020
+
+ +

Default is same as input. +

+
+
transfer, t
+

Set the output transfer characteristics. +

+

Possible values are: +

+
bt709
+
bt2020
+
+ +

Default is bt709. +

+
+
matrix, m
+

Set the output colorspace matrix. +

+

Possible value are: +

+
bt709
+
bt2020
+
+ +

Default is same as input. +

+
+
+ + +

31.15.1 Example

+ +
    +
  • Convert HDR(PQ/HLG) video to bt2020-transfer-characteristic p010 format using linear operator. +
    +
    -i INPUT -vf "format=p010,hwupload,tonemap_opencl=t=bt2020:tonemap=linear:format=p010,hwdownload,format=p010" OUTPUT
+
    +
+ + +

31.16 unsharp_opencl

+ +

Sharpen or blur the input video. +

+

It accepts the following parameters: +

+
+
luma_msize_x, lx
+

Set the luma matrix horizontal size. +Range is [1, 23] and default value is 5. +

+
+
luma_msize_y, ly
+

Set the luma matrix vertical size. +Range is [1, 23] and default value is 5. +

+
+
luma_amount, la
+

Set the luma effect strength. +Range is [-10, 10] and default value is 1.0. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+
+
chroma_msize_x, cx
+

Set the chroma matrix horizontal size. +Range is [1, 23] and default value is 5. +

+
+
chroma_msize_y, cy
+

Set the chroma matrix vertical size. +Range is [1, 23] and default value is 5. +

+
+
chroma_amount, ca
+

Set the chroma effect strength. +Range is [-10, 10] and default value is 0.0. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+
+
+ +

All parameters are optional and default to the equivalent of the +string ’5:5:1.0:5:5:0.0’. +

+ +

31.16.1 Examples

+ +
    +
  • Apply strong luma sharpen effect: +
    +
    -i INPUT -vf "hwupload, unsharp_opencl=luma_msize_x=7:luma_msize_y=7:luma_amount=2.5, hwdownload" OUTPUT
+
    + +
  • Apply a strong blur of both luma and chroma parameters: +
    +
    -i INPUT -vf "hwupload, unsharp_opencl=7:7:-2:7:7:-2, hwdownload" OUTPUT
+
    +
+ + +

31.17 xfade_opencl

+ +

Cross fade two videos with custom transition effect by using OpenCL. +

+

It accepts the following options: +

+
+
transition
+

Set one of possible transition effects. +

+
+
custom
+

Select custom transition effect, the actual transition description +will be picked from source and kernel options. +

+
+
fade
+
wipeleft
+
wiperight
+
wipeup
+
wipedown
+
slideleft
+
slideright
+
slideup
+
slidedown
+
+

Default transition is fade. +

+
+ +
+
source
+

OpenCL program source file for custom transition. +

+
+
kernel
+

Set name of kernel to use for custom transition from program source file. +

+
+
duration
+

Set duration of video transition. +

+
+
offset
+

Set time of start of transition relative to first video. +

+
+ +

The program source file must contain a kernel function with the given name, +which will be run once for each plane of the output. Each run on a plane +gets enqueued as a separate 2D global NDRange with one work-item for each +pixel to be generated. The global ID offset for each work-item is therefore +the coordinates of a pixel in the destination image. +

+

The kernel function needs to take the following arguments: +

    +
  • Destination image, __write_only image2d_t. + +

    This image will become the output; the kernel should write all of it. +

    +
  • First Source image, __read_only image2d_t. +Second Source image, __read_only image2d_t. + +

    These are the most recent images on each input. The kernel may read from +them to generate the output, but they can’t be written to. +

    +
  • Transition progress, float. This value is always between 0 and 1 inclusive. +
+ +

Example programs: +

+
    +
  • Apply dots curtain transition effect: +
    __kernel void blend_images(__write_only image2d_t dst,
+                           __read_only  image2d_t src1,
+                           __read_only  image2d_t src2,
+                           float progress)
+{
+    const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE |
+                               CLK_FILTER_LINEAR);
+    int2  p = (int2)(get_global_id(0), get_global_id(1));
+    float2 rp = (float2)(get_global_id(0), get_global_id(1));
+    float2 dim = (float2)(get_image_dim(src1).x, get_image_dim(src1).y);
+    rp = rp / dim;
+
+    float2 dots = (float2)(20.0, 20.0);
+    float2 center = (float2)(0,0);
+    float2 unused;
+
+    float4 val1 = read_imagef(src1, sampler, p);
+    float4 val2 = read_imagef(src2, sampler, p);
+    bool next = distance(fract(rp * dots, &unused), (float2)(0.5, 0.5)) < (progress / distance(rp, center));
+
+    write_imagef(dst, p, next ? val1 : val2);
+}
+
    +
+ + + +

32 VAAPI Video Filters

+ +

VAAPI Video filters are usually used with VAAPI decoder and VAAPI encoder. Below is a description of VAAPI video filters. +

+

To enable compilation of these filters you need to configure FFmpeg with +--enable-vaapi. +

+

To use vaapi filters, you need to setup the vaapi device correctly. For more information, please read https://trac.ffmpeg.org/wiki/Hardware/VAAPI +

+ +

32.1 tonemap_vaapi

+ +

Perform HDR(High Dynamic Range) to SDR(Standard Dynamic Range) conversion with tone-mapping. +It maps the dynamic range of HDR10 content to the SDR content. +It currently only accepts HDR10 as input. +

+

It accepts the following parameters: +

+
+
format
+

Specify the output pixel format. +

+

Currently supported formats are: +

+
p010
+
nv12
+
+ +

Default is nv12. +

+
+
primaries, p
+

Set the output color primaries. +

+

Default is same as input. +

+
+
transfer, t
+

Set the output transfer characteristics. +

+

Default is bt709. +

+
+
matrix, m
+

Set the output colorspace matrix. +

+

Default is same as input. +

+
+
+ + +

32.1.1 Example

+ +
    +
  • Convert HDR(HDR10) video to bt2020-transfer-characteristic p010 format +
    +
    tonemap_vaapi=format=p010:t=bt2020-10
+
    +
+ + + +

33 Video Sources

+ +

Below is a description of the currently available video sources. +

+ +

33.1 buffer

+ +

Buffer video frames, and make them available to the filter chain. +

+

This source is mainly intended for a programmatic use, in particular +through the interface defined in libavfilter/vsrc_buffer.h. +

+

It accepts the following parameters: +

+
+
video_size
+

Specify the size (width and height) of the buffered video frames. For the +syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
width
+

The input video width. +

+
+
height
+

The input video height. +

+
+
pix_fmt
+

A string representing the pixel format of the buffered video frames. +It may be a number corresponding to a pixel format, or a pixel format +name. +

+
+
time_base
+

Specify the timebase assumed by the timestamps of the buffered frames. +

+
+
frame_rate
+

Specify the frame rate expected for the video stream. +

+
+
pixel_aspect, sar
+

The sample (pixel) aspect ratio of the input video. +

+
+
sws_param
+

This option is deprecated and ignored. Prepend sws_flags=flags; +to the filtergraph description to specify swscale flags for automatically +inserted scalers. See Filtergraph syntax. +

+
+
hw_frames_ctx
+

When using a hardware pixel format, this should be a reference to an +AVHWFramesContext describing input frames. +

+
+ +

For example: +

+
buffer=width=320:height=240:pix_fmt=yuv410p:time_base=1/24:sar=1
+
+ +

will instruct the source to accept video frames with size 320x240 and +with format "yuv410p", assuming 1/24 as the timestamps timebase and +square pixels (1:1 sample aspect ratio). +Since the pixel format with name "yuv410p" corresponds to the number 6 +(check the enum AVPixelFormat definition in libavutil/pixfmt.h), +this example corresponds to: +

+
buffer=size=320x240:pixfmt=6:time_base=1/24:pixel_aspect=1/1
+
+ +

Alternatively, the options can be specified as a flat string, but this +syntax is deprecated: +

+

width:height:pix_fmt:time_base.num:time_base.den:pixel_aspect.num:pixel_aspect.den +

+ +

33.2 cellauto

+ +

Create a pattern generated by an elementary cellular automaton. +

+

The initial state of the cellular automaton can be defined through the +filename and pattern options. If such options are +not specified an initial state is created randomly. +

+

At each new frame a new row in the video is filled with the result of +the cellular automaton next generation. The behavior when the whole +frame is filled is defined by the scroll option. +

+

This source accepts the following options: +

+
+
filename, f
+

Read the initial cellular automaton state, i.e. the starting row, from +the specified file. +In the file, each non-whitespace character is considered an alive +cell, a newline will terminate the row, and further characters in the +file will be ignored. +

+
+
pattern, p
+

Read the initial cellular automaton state, i.e. the starting row, from +the specified string. +

+

Each non-whitespace character in the string is considered an alive +cell, a newline will terminate the row, and further characters in the +string will be ignored. +

+
+
rate, r
+

Set the video rate, that is the number of frames generated per second. +Default is 25. +

+
+
random_fill_ratio, ratio
+

Set the random fill ratio for the initial cellular automaton row. It +is a floating point number value ranging from 0 to 1, defaults to +1/PHI. +

+

This option is ignored when a file or a pattern is specified. +

+
+
random_seed, seed
+

Set the seed for filling randomly the initial row, must be an integer +included between 0 and UINT32_MAX. If not specified, or if explicitly +set to -1, the filter will try to use a good random seed on a best +effort basis. +

+
+
rule
+

Set the cellular automaton rule, it is a number ranging from 0 to 255. +Default value is 110. +

+
+
size, s
+

Set the size of the output video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+

If filename or pattern is specified, the size is set +by default to the width of the specified initial state row, and the +height is set to width * PHI. +

+

If size is set, it must contain the width of the specified +pattern string, and the specified pattern will be centered in the +larger row. +

+

If a filename or a pattern string is not specified, the size value +defaults to "320x518" (used for a randomly generated initial state). +

+
+
scroll
+

If set to 1, scroll the output upward when all the rows in the output +have been already filled. If set to 0, the new generated row will be +written over the top row just after the bottom row is filled. +Defaults to 1. +

+
+
start_full, full
+

If set to 1, completely fill the output with generated rows before +outputting the first frame. +This is the default behavior, for disabling set the value to 0. +

+
+
stitch
+

If set to 1, stitch the left and right row edges together. +This is the default behavior, for disabling set the value to 0. +

+
+ + +

33.2.1 Examples

+ +
    +
  • Read the initial state from pattern, and specify an output of +size 200x400. +
    +
    cellauto=f=pattern:s=200x400
+
    + +
  • Generate a random initial row with a width of 200 cells, with a fill +ratio of 2/3: +
    +
    cellauto=ratio=2/3:s=200x200
+
    + +
  • Create a pattern generated by rule 18 starting by a single alive cell +centered on an initial row with width 100: +
    +
    cellauto=p=@:s=100x400:full=0:rule=18
+
    + +
  • Specify a more elaborated initial pattern: +
    +
    cellauto=p='@@ @ @@':s=100x400:full=0:rule=18
+
    + +
+ + +

33.3 coreimagesrc

+

Video source generated on GPU using Apple’s CoreImage API on OSX. +

+

This video source is a specialized version of the coreimage video filter. +Use a core image generator at the beginning of the applied filterchain to +generate the content. +

+

The coreimagesrc video source accepts the following options: +

+
list_generators
+

List all available generators along with all their respective options as well as +possible minimum and maximum values along with the default values. +

+
list_generators=true
+
+ +
+
size, s
+

Specify the size of the sourced video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +The default value is 320x240. +

+
+
rate, r
+

Specify the frame rate of the sourced video, as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a floating point +number or a valid video frame rate abbreviation. The default value is +"25". +

+
+
sar
+

Set the sample aspect ratio of the sourced video. +

+
+
duration, d
+

Set the duration of the sourced video. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

If not specified, or the expressed duration is negative, the video is +supposed to be generated forever. +

+
+ +

Additionally, all options of the coreimage video filter are accepted. +A complete filterchain can be used for further processing of the +generated input without CPU-HOST transfer. See coreimage documentation +and examples for details. +

+ +

33.3.1 Examples

+ +
    +
  • Use CIQRCodeGenerator to create a QR code for the FFmpeg homepage, +given as complete and escaped command-line for Apple’s standard bash shell: +
    +
    ffmpeg -f lavfi -i coreimagesrc=s=100x100:filter=CIQRCodeGenerator@inputMessage=https\\\\\://FFmpeg.org/@inputCorrectionLevel=H -frames:v 1 QRCode.png
+
    +

    This example is equivalent to the QRCode example of coreimage without the +need for a nullsrc video source. +

+ + + +

33.4 gradients

+

Generate several gradients. +

+
+
size, s
+

Set frame size. For the syntax of this option, check the (ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual. Default value is "640x480". +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
c0, c1, c2, c3, c4, c5, c6, c7
+

Set 8 colors. Default values for colors is to pick random one. +

+
+
x0, y0, y0, y1
+

Set gradient line source and destination points. If negative or out of range, random ones +are picked. +

+
+
nb_colors, n
+

Set number of colors to use at once. Allowed range is from 2 to 8. Default value is 2. +

+
+
seed
+

Set seed for picking gradient line points. +

+
+ + + +

33.5 mandelbrot

+ +

Generate a Mandelbrot set fractal, and progressively zoom towards the +point specified with start_x and start_y. +

+

This source accepts the following options: +

+
+
end_pts
+

Set the terminal pts value. Default value is 400. +

+
+
end_scale
+

Set the terminal scale value. +Must be a floating point value. Default value is 0.3. +

+
+
inner
+

Set the inner coloring mode, that is the algorithm used to draw the +Mandelbrot fractal internal region. +

+

It shall assume one of the following values: +

+
black
+

Set black mode. +

+
convergence
+

Show time until convergence. +

+
mincol
+

Set color based on point closest to the origin of the iterations. +

+
period
+

Set period mode. +

+
+ +

Default value is mincol. +

+
+
bailout
+

Set the bailout value. Default value is 10.0. +

+
+
maxiter
+

Set the maximum of iterations performed by the rendering +algorithm. Default value is 7189. +

+
+
outer
+

Set outer coloring mode. +It shall assume one of following values: +

+
iteration_count
+

Set iteration count mode. +

+
normalized_iteration_count
+

set normalized iteration count mode. +

+
+

Default value is normalized_iteration_count. +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
size, s
+

Set frame size. For the syntax of this option, check the (ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual. Default value is "640x480". +

+
+
start_scale
+

Set the initial scale value. Default value is 3.0. +

+
+
start_x
+

Set the initial x position. Must be a floating point value between +-100 and 100. Default value is -0.743643887037158704752191506114774. +

+
+
start_y
+

Set the initial y position. Must be a floating point value between +-100 and 100. Default value is -0.131825904205311970493132056385139. +

+
+ + +

33.6 mptestsrc

+ +

Generate various test patterns, as generated by the MPlayer test filter. +

+

The size of the generated video is fixed, and is 256x256. +This source is useful in particular for testing encoding features. +

+

This source accepts the following options: +

+
+
rate, r
+

Specify the frame rate of the sourced video, as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a floating point +number or a valid video frame rate abbreviation. The default value is +"25". +

+
+
duration, d
+

Set the duration of the sourced video. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

If not specified, or the expressed duration is negative, the video is +supposed to be generated forever. +

+
+
test, t
+
+

Set the number or the name of the test to perform. Supported tests are: +

+
dc_luma
+
dc_chroma
+
freq_luma
+
freq_chroma
+
amp_luma
+
amp_chroma
+
cbp
+
mv
+
ring1
+
ring2
+
all
+
max_frames, m
+

Set the maximum number of frames generated for each test, default value is 30. +

+
+
+ +

Default value is "all", which will cycle through the list of all tests. +

+
+ +

Some examples: +

+
mptestsrc=t=dc_luma
+
+ +

will generate a "dc_luma" test pattern. +

+ +

33.7 frei0r_src

+ +

Provide a frei0r source. +

+

To enable compilation of this filter you need to install the frei0r +header and configure FFmpeg with --enable-frei0r. +

+

This source accepts the following parameters: +

+
+
size
+

The size of the video to generate. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
framerate
+

The framerate of the generated video. It may be a string of the form +num/den or a frame rate abbreviation. +

+
+
filter_name
+

The name to the frei0r source to load. For more information regarding frei0r and +how to set the parameters, read the frei0r section in the video filters +documentation. +

+
+
filter_params
+

A ’|’-separated list of parameters to pass to the frei0r source. +

+
+
+ +

For example, to generate a frei0r partik0l source with size 200x200 +and frame rate 10 which is overlaid on the overlay filter main input: +

+
frei0r_src=size=200x200:framerate=10:filter_name=partik0l:filter_params=1234 [overlay]; [in][overlay] overlay
+
+ + +

33.8 life

+ +

Generate a life pattern. +

+

This source is based on a generalization of John Conway’s life game. +

+

The sourced input represents a life grid, each pixel represents a cell +which can be in one of two possible states, alive or dead. Every cell +interacts with its eight neighbours, which are the cells that are +horizontally, vertically, or diagonally adjacent. +

+

At each interaction the grid evolves according to the adopted rule, +which specifies the number of neighbor alive cells which will make a +cell stay alive or born. The rule option allows one to specify +the rule to adopt. +

+

This source accepts the following options: +

+
+
filename, f
+

Set the file from which to read the initial grid state. In the file, +each non-whitespace character is considered an alive cell, and newline +is used to delimit the end of each row. +

+

If this option is not specified, the initial grid is generated +randomly. +

+
+
rate, r
+

Set the video rate, that is the number of frames generated per second. +Default is 25. +

+
+
random_fill_ratio, ratio
+

Set the random fill ratio for the initial random grid. It is a +floating point number value ranging from 0 to 1, defaults to 1/PHI. +It is ignored when a file is specified. +

+
+
random_seed, seed
+

Set the seed for filling the initial random grid, must be an integer +included between 0 and UINT32_MAX. If not specified, or if explicitly +set to -1, the filter will try to use a good random seed on a best +effort basis. +

+
+
rule
+

Set the life rule. +

+

A rule can be specified with a code of the kind "SNS/BNB", +where NS and NB are sequences of numbers in the range 0-8, +NS specifies the number of alive neighbor cells which make a +live cell stay alive, and NB the number of alive neighbor cells +which make a dead cell to become alive (i.e. to "born"). +"s" and "b" can be used in place of "S" and "B", respectively. +

+

Alternatively a rule can be specified by an 18-bits integer. The 9 +high order bits are used to encode the next cell state if it is alive +for each number of neighbor alive cells, the low order bits specify +the rule for "borning" new cells. Higher order bits encode for an +higher number of neighbor cells. +For example the number 6153 = (12<<9)+9 specifies a stay alive +rule of 12 and a born rule of 9, which corresponds to "S23/B03". +

+

Default value is "S23/B3", which is the original Conway’s game of life +rule, and will keep a cell alive if it has 2 or 3 neighbor alive +cells, and will born a new cell if there are three alive cells around +a dead cell. +

+
+
size, s
+

Set the size of the output video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+

If filename is specified, the size is set by default to the +same size of the input file. If size is set, it must contain +the size specified in the input file, and the initial grid defined in +that file is centered in the larger resulting area. +

+

If a filename is not specified, the size value defaults to "320x240" +(used for a randomly generated initial grid). +

+
+
stitch
+

If set to 1, stitch the left and right grid edges together, and the +top and bottom edges also. Defaults to 1. +

+
+
mold
+

Set cell mold speed. If set, a dead cell will go from death_color to +mold_color with a step of mold. mold can have a +value from 0 to 255. +

+
+
life_color
+

Set the color of living (or new born) cells. +

+
+
death_color
+

Set the color of dead cells. If mold is set, this is the first color +used to represent a dead cell. +

+
+
mold_color
+

Set mold color, for definitely dead and moldy cells. +

+

For the syntax of these 3 color options, check the (ffmpeg-utils)"Color" section in the +ffmpeg-utils manual. +

+
+ + +

33.8.1 Examples

+ +
    +
  • Read a grid from pattern, and center it on a grid of size +300x300 pixels: +
    +
    life=f=pattern:s=300x300
+
    + +
  • Generate a random grid of size 200x200, with a fill ratio of 2/3: +
    +
    life=ratio=2/3:s=200x200
+
    + +
  • Specify a custom rule for evolving a randomly generated grid: +
    +
    life=rule=S14/B34
+
    + +
  • Full example with slow death effect (mold) using ffplay: +
    +
    ffplay -f lavfi life=s=300x200:mold=10:r=60:ratio=0.1:death_color=#C83232:life_color=#00ff00,scale=1200:800:flags=16
+
    +
+ + +

33.9 allrgb, allyuv, color, haldclutsrc, nullsrc, pal75bars, pal100bars, rgbtestsrc, smptebars, smptehdbars, testsrc, testsrc2, yuvtestsrc

+ +

The allrgb source returns frames of size 4096x4096 of all rgb colors. +

+

The allyuv source returns frames of size 4096x4096 of all yuv colors. +

+

The color source provides an uniformly colored input. +

+

The haldclutsrc source provides an identity Hald CLUT. See also +haldclut filter. +

+

The nullsrc source returns unprocessed video frames. It is +mainly useful to be employed in analysis / debugging tools, or as the +source for filters which ignore the input data. +

+

The pal75bars source generates a color bars pattern, based on +EBU PAL recommendations with 75% color levels. +

+

The pal100bars source generates a color bars pattern, based on +EBU PAL recommendations with 100% color levels. +

+

The rgbtestsrc source generates an RGB test pattern useful for +detecting RGB vs BGR issues. You should see a red, green and blue +stripe from top to bottom. +

+

The smptebars source generates a color bars pattern, based on +the SMPTE Engineering Guideline EG 1-1990. +

+

The smptehdbars source generates a color bars pattern, based on +the SMPTE RP 219-2002. +

+

The testsrc source generates a test video pattern, showing a +color pattern, a scrolling gradient and a timestamp. This is mainly +intended for testing purposes. +

+

The testsrc2 source is similar to testsrc, but supports more +pixel formats instead of just rgb24. This allows using it as an +input for other tests without requiring a format conversion. +

+

The yuvtestsrc source generates an YUV test pattern. You should +see a y, cb and cr stripe from top to bottom. +

+

The sources accept the following parameters: +

+
+
level
+

Specify the level of the Hald CLUT, only available in the haldclutsrc +source. A level of N generates a picture of N*N*N by N*N*N +pixels to be used as identity matrix for 3D lookup tables. Each component is +coded on a 1/(N*N) scale. +

+
+
color, c
+

Specify the color of the source, only available in the color +source. For the syntax of this option, check the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+
+
size, s
+

Specify the size of the sourced video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +The default value is 320x240. +

+

This option is not available with the allrgb, allyuv, and +haldclutsrc filters. +

+
+
rate, r
+

Specify the frame rate of the sourced video, as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a floating point +number or a valid video frame rate abbreviation. The default value is +"25". +

+
+
duration, d
+

Set the duration of the sourced video. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

If not specified, or the expressed duration is negative, the video is +supposed to be generated forever. +

+
+
sar
+

Set the sample aspect ratio of the sourced video. +

+
+
alpha
+

Specify the alpha (opacity) of the background, only available in the +testsrc2 source. The value must be between 0 (fully transparent) and +255 (fully opaque, the default). +

+
+
decimals, n
+

Set the number of decimals to show in the timestamp, only available in the +testsrc source. +

+

The displayed timestamp value will correspond to the original +timestamp value multiplied by the power of 10 of the specified +value. Default value is 0. +

+
+ + +

33.9.1 Examples

+ +
    +
  • Generate a video with a duration of 5.3 seconds, with size +176x144 and a frame rate of 10 frames per second: +
    +
    testsrc=duration=5.3:size=qcif:rate=10
+
    + +
  • The following graph description will generate a red source +with an opacity of 0.2, with size "qcif" and a frame rate of 10 +frames per second: +
    +
    color=c=red@0.2:s=qcif:r=10
+
    + +
  • If the input content is to be ignored, nullsrc can be used. The +following command generates noise in the luminance plane by employing +the geq filter: +
    +
    nullsrc=s=256x256, geq=random(1)*255:128:128
+
    +
+ + +

33.9.2 Commands

+ +

The color source supports the following commands: +

+
+
c, color
+

Set the color of the created image. Accepts the same syntax of the +corresponding color option. +

+
+ + +

33.10 openclsrc

+ +

Generate video using an OpenCL program. +

+
+
source
+

OpenCL program source file. +

+
+
kernel
+

Kernel name in program. +

+
+
size, s
+

Size of frames to generate. This must be set. +

+
+
format
+

Pixel format to use for the generated frames. This must be set. +

+
+
rate, r
+

Number of frames generated every second. Default value is ’25’. +

+
+
+ +

For details of how the program loading works, see the program_opencl +filter. +

+

Example programs: +

+
    +
  • Generate a colour ramp by setting pixel values from the position of the pixel +in the output image. (Note that this will work with all pixel formats, but +the generated output will not be the same.) +
    __kernel void ramp(__write_only image2d_t dst,
+                   unsigned int index)
+{
+    int2 loc = (int2)(get_global_id(0), get_global_id(1));
+
+    float4 val;
+    val.xy = val.zw = convert_float2(loc) / convert_float2(get_image_dim(dst));
+
+    write_imagef(dst, loc, val);
+}
+
    +
  • Generate a Sierpinski carpet pattern, panning by a single pixel each frame. +
    __kernel void sierpinski_carpet(__write_only image2d_t dst,
+                                unsigned int index)
+{
+    int2 loc = (int2)(get_global_id(0), get_global_id(1));
+
+    float4 value = 0.0f;
+    int x = loc.x + index;
+    int y = loc.y + index;
+    while (x > 0 || y > 0) {
+        if (x % 3 == 1 && y % 3 == 1) {
+            value = 1.0f;
+            break;
+        }
+        x /= 3;
+        y /= 3;
+    }
+
+    write_imagef(dst, loc, value);
+}
+
    +
+ + +

33.11 sierpinski

+ +

Generate a Sierpinski carpet/triangle fractal, and randomly pan around. +

+

This source accepts the following options: +

+
+
size, s
+

Set frame size. For the syntax of this option, check the (ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual. Default value is "640x480". +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
seed
+

Set seed which is used for random panning. +

+
+
jump
+

Set max jump for single pan destination. Allowed range is from 1 to 10000. +

+
+
type
+

Set fractal type, can be default carpet or triangle. +

+
+ + + +

34 Video Sinks

+ +

Below is a description of the currently available video sinks. +

+ +

34.1 buffersink

+ +

Buffer video frames, and make them available to the end of the filter +graph. +

+

This sink is mainly intended for programmatic use, in particular +through the interface defined in libavfilter/buffersink.h +or the options system. +

+

It accepts a pointer to an AVBufferSinkContext structure, which +defines the incoming buffers’ formats, to be passed as the opaque +parameter to avfilter_init_filter for initialization. +

+ +

34.2 nullsink

+ +

Null video sink: do absolutely nothing with the input video. It is +mainly useful as a template and for use in analysis / debugging +tools. +

+ + +

35 Multimedia Filters

+ +

Below is a description of the currently available multimedia filters. +

+ +

35.1 abitscope

+ +

Convert input audio to a video output, displaying the audio bit scope. +

+

The filter accepts the following options: +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 1024x256. +

+
+
colors
+

Specify list of colors separated by space or by ’|’ which will be used to +draw channels. Unrecognized or missing colors will be replaced +by white color. +

+
+ + +

35.2 adrawgraph

+

Draw a graph using input audio metadata. +

+

See drawgraph +

+ +

35.3 agraphmonitor

+ +

See graphmonitor. +

+ +

35.4 ahistogram

+ +

Convert input audio to a video output, displaying the volume histogram. +

+

The filter accepts the following options: +

+
+
dmode
+

Specify how histogram is calculated. +

+

It accepts the following values: +

+
‘single’
+

Use single histogram for all channels. +

+
‘separate’
+

Use separate histogram for each channel. +

+
+

Default is single. +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is hd720. +

+
+
scale
+

Set display scale. +

+

It accepts the following values: +

+
‘log’
+

logarithmic +

+
‘sqrt’
+

square root +

+
‘cbrt’
+

cubic root +

+
‘lin’
+

linear +

+
‘rlog’
+

reverse logarithmic +

+
+

Default is log. +

+
+
ascale
+

Set amplitude scale. +

+

It accepts the following values: +

+
‘log’
+

logarithmic +

+
‘lin’
+

linear +

+
+

Default is log. +

+
+
acount
+

Set how much frames to accumulate in histogram. +Default is 1. Setting this to -1 accumulates all frames. +

+
+
rheight
+

Set histogram ratio of window height. +

+
+
slide
+

Set sonogram sliding. +

+

It accepts the following values: +

+
‘replace’
+

replace old rows with new ones. +

+
‘scroll’
+

scroll from top to bottom. +

+
+

Default is replace. +

+
+ + +

35.5 aphasemeter

+ +

Measures phase of input audio, which is exported as metadata lavfi.aphasemeter.phase, +representing mean phase of current audio frame. A video output can also be produced and is +enabled by default. The audio is passed through as first output. +

+

Audio will be rematrixed to stereo if it has a different channel layout. Phase value is in +range [-1, 1] where -1 means left and right channels are completely out of phase +and 1 means channels are in phase. +

+

The filter accepts the following options, all related to its video output: +

+
+
rate, r
+

Set the output frame rate. Default value is 25. +

+
+
size, s
+

Set the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 800x400. +

+
+
rc
+
gc
+
bc
+

Specify the red, green, blue contrast. Default values are 2, +7 and 1. +Allowed range is [0, 255]. +

+
+
mpc
+

Set color which will be used for drawing median phase. If color is +none which is default, no median phase value will be drawn. +

+
+
video
+

Enable video output. Default is enabled. +

+
+ + +

35.6 avectorscope

+ +

Convert input audio to a video output, representing the audio vector +scope. +

+

The filter is used to measure the difference between channels of stereo +audio stream. A monaural signal, consisting of identical left and right +signal, results in straight vertical line. Any stereo separation is visible +as a deviation from this line, creating a Lissajous figure. +If the straight (or deviation from it) but horizontal line appears this +indicates that the left and right channels are out of phase. +

+

The filter accepts the following options: +

+
+
mode, m
+

Set the vectorscope mode. +

+

Available values are: +

+
‘lissajous’
+

Lissajous rotated by 45 degrees. +

+
+
‘lissajous_xy’
+

Same as above but not rotated. +

+
+
‘polar’
+

Shape resembling half of circle. +

+
+ +

Default value is ‘lissajous’. +

+
+
size, s
+

Set the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 400x400. +

+
+
rate, r
+

Set the output frame rate. Default value is 25. +

+
+
rc
+
gc
+
bc
+
ac
+

Specify the red, green, blue and alpha contrast. Default values are 40, +160, 80 and 255. +Allowed range is [0, 255]. +

+
+
rf
+
gf
+
bf
+
af
+

Specify the red, green, blue and alpha fade. Default values are 15, +10, 5 and 5. +Allowed range is [0, 255]. +

+
+
zoom
+

Set the zoom factor. Default value is 1. Allowed range is [0, 10]. +Values lower than 1 will auto adjust zoom factor to maximal possible value. +

+
+
draw
+

Set the vectorscope drawing mode. +

+

Available values are: +

+
‘dot’
+

Draw dot for each sample. +

+
+
‘line’
+

Draw line between previous and current sample. +

+
+ +

Default value is ‘dot’. +

+
+
scale
+

Specify amplitude scale of audio samples. +

+

Available values are: +

+
‘lin’
+

Linear. +

+
+
‘sqrt’
+

Square root. +

+
+
‘cbrt’
+

Cubic root. +

+
+
‘log’
+

Logarithmic. +

+
+ +
+
swap
+

Swap left channel axis with right channel axis. +

+
+
mirror
+

Mirror axis. +

+
+
‘none’
+

No mirror. +

+
+
‘x’
+

Mirror only x axis. +

+
+
‘y’
+

Mirror only y axis. +

+
+
‘xy’
+

Mirror both axis. +

+
+ +
+
+ + +

35.6.1 Examples

+ +
    +
  • Complete example using ffplay: +
    +
    ffplay -f lavfi 'amovie=input.mp3, asplit [a][out1];
+             [a] avectorscope=zoom=1.3:rc=2:gc=200:bc=10:rf=1:gf=8:bf=7 [out0]'
+
    +
+ + +

35.7 bench, abench

+ +

Benchmark part of a filtergraph. +

+

The filter accepts the following options: +

+
+
action
+

Start or stop a timer. +

+

Available values are: +

+
‘start’
+

Get the current time, set it as frame metadata (using the key +lavfi.bench.start_time), and forward the frame to the next filter. +

+
+
‘stop’
+

Get the current time and fetch the lavfi.bench.start_time metadata from +the input frame metadata to get the time difference. Time difference, average, +maximum and minimum time (respectively t, avg, max and +min) are then printed. The timestamps are expressed in seconds. +

+
+
+
+ + +

35.7.1 Examples

+ +
    +
  • Benchmark selectivecolor filter: +
    +
    bench=start,selectivecolor=reds=-.2 .12 -.49,bench=stop
+
    +
+ + +

35.8 concat

+ +

Concatenate audio and video streams, joining them together one after the +other. +

+

The filter works on segments of synchronized video and audio streams. All +segments must have the same number of streams of each type, and that will +also be the number of streams at output. +

+

The filter accepts the following options: +

+
+
n
+

Set the number of segments. Default is 2. +

+
+
v
+

Set the number of output video streams, that is also the number of video +streams in each segment. Default is 1. +

+
+
a
+

Set the number of output audio streams, that is also the number of audio +streams in each segment. Default is 0. +

+
+
unsafe
+

Activate unsafe mode: do not fail if segments have a different format. +

+
+
+ +

The filter has v+a outputs: first v video outputs, then +a audio outputs. +

+

There are nx(v+a) inputs: first the inputs for the first +segment, in the same order as the outputs, then the inputs for the second +segment, etc. +

+

Related streams do not always have exactly the same duration, for various +reasons including codec frame size or sloppy authoring. For that reason, +related synchronized streams (e.g. a video and its audio track) should be +concatenated at once. The concat filter will use the duration of the longest +stream in each segment (except the last one), and if necessary pad shorter +audio streams with silence. +

+

For this filter to work correctly, all segments must start at timestamp 0. +

+

All corresponding streams must have the same parameters in all segments; the +filtering system will automatically select a common pixel format for video +streams, and a common sample format, sample rate and channel layout for +audio streams, but other settings, such as resolution, must be converted +explicitly by the user. +

+

Different frame rates are acceptable but will result in variable frame rate +at output; be sure to configure the output file to handle it. +

+ +

35.8.1 Examples

+ +
    +
  • Concatenate an opening, an episode and an ending, all in bilingual version +(video in stream 0, audio in streams 1 and 2): +
    +
    ffmpeg -i opening.mkv -i episode.mkv -i ending.mkv -filter_complex \
+  '[0:0] [0:1] [0:2] [1:0] [1:1] [1:2] [2:0] [2:1] [2:2]
+   concat=n=3:v=1:a=2 [v] [a1] [a2]' \
+  -map '[v]' -map '[a1]' -map '[a2]' output.mkv
+
    + +
  • Concatenate two parts, handling audio and video separately, using the +(a)movie sources, and adjusting the resolution: +
    +
    movie=part1.mp4, scale=512:288 [v1] ; amovie=part1.mp4 [a1] ;
+movie=part2.mp4, scale=512:288 [v2] ; amovie=part2.mp4 [a2] ;
+[v1] [v2] concat [outv] ; [a1] [a2] concat=v=0:a=1 [outa]
+
    +

    Note that a desync will happen at the stitch if the audio and video streams +do not have exactly the same duration in the first file. +

    +
+ + +

35.8.2 Commands

+ +

This filter supports the following commands: +

+
next
+

Close the current segment and step to the next one +

+
+ + +

35.9 ebur128

+ +

EBU R128 scanner filter. This filter takes an audio stream and analyzes its loudness +level. By default, it logs a message at a frequency of 10Hz with the +Momentary loudness (identified by M), Short-term loudness (S), +Integrated loudness (I) and Loudness Range (LRA). +

+

The filter can only analyze streams which have a sampling rate of 48000 Hz and whose +sample format is double-precision floating point. The input stream will be converted to +this specification, if needed. Users may need to insert aformat and/or aresample filters +after this filter to obtain the original parameters. +

+

The filter also has a video output (see the video option) with a real +time graph to observe the loudness evolution. The graphic contains the logged +message mentioned above, so it is not printed anymore when this option is set, +unless the verbose logging is set. The main graphing area contains the +short-term loudness (3 seconds of analysis), and the gauge on the right is for +the momentary loudness (400 milliseconds), but can optionally be configured +to instead display short-term loudness (see gauge). +

+

The green area marks a +/- 1LU target range around the target loudness +(-23LUFS by default, unless modified through target). +

+

More information about the Loudness Recommendation EBU R128 on +http://tech.ebu.ch/loudness. +

+

The filter accepts the following options: +

+
+
video
+

Activate the video output. The audio stream is passed unchanged whether this +option is set or no. The video stream will be the first output stream if +activated. Default is 0. +

+
+
size
+

Set the video size. This option is for video only. For the syntax of this +option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default and minimum resolution is 640x480. +

+
+
meter
+

Set the EBU scale meter. Default is 9. Common values are 9 and +18, respectively for EBU scale meter +9 and EBU scale meter +18. Any +other integer value between this range is allowed. +

+
+
metadata
+

Set metadata injection. If set to 1, the audio input will be segmented +into 100ms output frames, each of them containing various loudness information +in metadata. All the metadata keys are prefixed with lavfi.r128.. +

+

Default is 0. +

+
+
framelog
+

Force the frame logging level. +

+

Available values are: +

+
‘info’
+

information logging level +

+
‘verbose’
+

verbose logging level +

+
+ +

By default, the logging level is set to info. If the video or +the metadata options are set, it switches to verbose. +

+
+
peak
+

Set peak mode(s). +

+

Available modes can be cumulated (the option is a flag type). Possible +values are: +

+
‘none’
+

Disable any peak mode (default). +

+
‘sample’
+

Enable sample-peak mode. +

+

Simple peak mode looking for the higher sample value. It logs a message +for sample-peak (identified by SPK). +

+
‘true’
+

Enable true-peak mode. +

+

If enabled, the peak lookup is done on an over-sampled version of the input +stream for better peak accuracy. It logs a message for true-peak. +(identified by TPK) and true-peak per frame (identified by FTPK). +This mode requires a build with libswresample. +

+
+ +
+
dualmono
+

Treat mono input files as "dual mono". If a mono file is intended for playback +on a stereo system, its EBU R128 measurement will be perceptually incorrect. +If set to true, this option will compensate for this effect. +Multi-channel input files are not affected by this option. +

+
+
panlaw
+

Set a specific pan law to be used for the measurement of dual mono files. +This parameter is optional, and has a default value of -3.01dB. +

+
+
target
+

Set a specific target level (in LUFS) used as relative zero in the visualization. +This parameter is optional and has a default value of -23LUFS as specified +by EBU R128. However, material published online may prefer a level of -16LUFS +(e.g. for use with podcasts or video platforms). +

+
+
gauge
+

Set the value displayed by the gauge. Valid values are momentary and s +shortterm. By default the momentary value will be used, but in certain +scenarios it may be more useful to observe the short term value instead (e.g. +live mixing). +

+
+
scale
+

Sets the display scale for the loudness. Valid parameters are absolute +(in LUFS) or relative (LU) relative to the target. This only affects the +video output, not the summary or continuous log output. +

+
+ + +

35.9.1 Examples

+ +
    +
  • Real-time graph using ffplay, with a EBU scale meter +18: +
    +
    ffplay -f lavfi -i "amovie=input.mp3,ebur128=video=1:meter=18 [out0][out1]"
+
    + +
  • Run an analysis with ffmpeg: +
    +
    ffmpeg -nostats -i input.mp3 -filter_complex ebur128 -f null -
+
    +
+ + +

35.10 interleave, ainterleave

+ +

Temporally interleave frames from several inputs. +

+

interleave works with video inputs, ainterleave with audio. +

+

These filters read frames from several inputs and send the oldest +queued frame to the output. +

+

Input streams must have well defined, monotonically increasing frame +timestamp values. +

+

In order to submit one frame to output, these filters need to enqueue +at least one frame for each input, so they cannot work in case one +input is not yet terminated and will not receive incoming frames. +

+

For example consider the case when one input is a select filter +which always drops input frames. The interleave filter will keep +reading from that input, but it will never be able to send new frames +to output until the input sends an end-of-stream signal. +

+

Also, depending on inputs synchronization, the filters will drop +frames in case one input receives more frames than the other ones, and +the queue is already filled. +

+

These filters accept the following options: +

+
+
nb_inputs, n
+

Set the number of different inputs, it is 2 by default. +

+
+
duration
+

How to determine the end-of-stream. +

+
+
longest
+

The duration of the longest input. (default) +

+
+
shortest
+

The duration of the shortest input. +

+
+
first
+

The duration of the first input. +

+
+ +
+
+ + +

35.10.1 Examples

+ +
    +
  • Interleave frames belonging to different streams using ffmpeg: +
    +
    ffmpeg -i bambi.avi -i pr0n.mkv -filter_complex "[0:v][1:v] interleave" out.avi
+
    + +
  • Add flickering blur effect: +
    +
    select='if(gt(random(0), 0.2), 1, 2)':n=2 [tmp], boxblur=2:2, [tmp] interleave
+
    +
+ + +

35.11 metadata, ametadata

+ +

Manipulate frame metadata. +

+

This filter accepts the following options: +

+
+
mode
+

Set mode of operation of the filter. +

+

Can be one of the following: +

+
+
‘select’
+

If both value and key is set, select frames +which have such metadata. If only key is set, select +every frame that has such key in metadata. +

+
+
‘add’
+

Add new metadata key and value. If key is already available +do nothing. +

+
+
‘modify’
+

Modify value of already present key. +

+
+
‘delete’
+

If value is set, delete only keys that have such value. +Otherwise, delete key. If key is not set, delete all metadata values in +the frame. +

+
+
‘print’
+

Print key and its value if metadata was found. If key is not set print all +metadata values available in frame. +

+
+ +
+
key
+

Set key used with all modes. Must be set for all modes except print and delete. +

+
+
value
+

Set metadata value which will be used. This option is mandatory for +modify and add mode. +

+
+
function
+

Which function to use when comparing metadata value and value. +

+

Can be one of following: +

+
+
‘same_str’
+

Values are interpreted as strings, returns true if metadata value is same as value. +

+
+
‘starts_with’
+

Values are interpreted as strings, returns true if metadata value starts with +the value option string. +

+
+
‘less’
+

Values are interpreted as floats, returns true if metadata value is less than value. +

+
+
‘equal’
+

Values are interpreted as floats, returns true if value is equal with metadata value. +

+
+
‘greater’
+

Values are interpreted as floats, returns true if metadata value is greater than value. +

+
+
‘expr’
+

Values are interpreted as floats, returns true if expression from option expr +evaluates to true. +

+
+
‘ends_with’
+

Values are interpreted as strings, returns true if metadata value ends with +the value option string. +

+
+ +
+
expr
+

Set expression which is used when function is set to expr. +The expression is evaluated through the eval API and can contain the following +constants: +

+
+
VALUE1
+

Float representation of value from metadata key. +

+
+
VALUE2
+

Float representation of value as supplied by user in value option. +

+
+ +
+
file
+

If specified in print mode, output is written to the named file. Instead of +plain filename any writable url can be specified. Filename “-” is a shorthand +for standard output. If file option is not set, output is written to the log +with AV_LOG_INFO loglevel. +

+
+
direct
+

Reduces buffering in print mode when output is written to a URL set using file. +

+
+
+ + +

35.11.1 Examples

+ +
    +
  • Print all metadata values for frames with key lavfi.signalstats.YDIF with values +between 0 and 1. +
    +
    signalstats,metadata=print:key=lavfi.signalstats.YDIF:value=0:function=expr:expr='between(VALUE1,0,1)'
+
    +
  • Print silencedetect output to file metadata.txt. +
    +
    silencedetect,ametadata=mode=print:file=metadata.txt
+
    +
  • Direct all metadata to a pipe with file descriptor 4. +
    +
    metadata=mode=print:file='pipe\:4'
+
    +
+ + +

35.12 perms, aperms

+ +

Set read/write permissions for the output frames. +

+

These filters are mainly aimed at developers to test direct path in the +following filter in the filtergraph. +

+

The filters accept the following options: +

+
+
mode
+

Select the permissions mode. +

+

It accepts the following values: +

+
‘none’
+

Do nothing. This is the default. +

+
‘ro’
+

Set all the output frames read-only. +

+
‘rw’
+

Set all the output frames directly writable. +

+
‘toggle’
+

Make the frame read-only if writable, and writable if read-only. +

+
‘random’
+

Set each output frame read-only or writable randomly. +

+
+ +
+
seed
+

Set the seed for the random mode, must be an integer included between +0 and UINT32_MAX. If not specified, or if explicitly set to +-1, the filter will try to use a good random seed on a best effort +basis. +

+
+ +

Note: in case of auto-inserted filter between the permission filter and the +following one, the permission might not be received as expected in that +following filter. Inserting a format or aformat filter before the +perms/aperms filter can avoid this problem. +

+ +

35.13 realtime, arealtime

+ +

Slow down filtering to match real time approximately. +

+

These filters will pause the filtering for a variable amount of time to +match the output rate with the input timestamps. +They are similar to the re option to ffmpeg. +

+

They accept the following options: +

+
+
limit
+

Time limit for the pauses. Any pause longer than that will be considered +a timestamp discontinuity and reset the timer. Default is 2 seconds. +

+
speed
+

Speed factor for processing. The value must be a float larger than zero. +Values larger than 1.0 will result in faster than realtime processing, +smaller will slow processing down. The limit is automatically adapted +accordingly. Default is 1.0. +

+

A processing speed faster than what is possible without these filters cannot +be achieved. +

+
+ + +

35.14 select, aselect

+ +

Select frames to pass in output. +

+

This filter accepts the following options: +

+
+
expr, e
+

Set expression, which is evaluated for each input frame. +

+

If the expression is evaluated to zero, the frame is discarded. +

+

If the evaluation result is negative or NaN, the frame is sent to the +first output; otherwise it is sent to the output with index +ceil(val)-1, assuming that the input index starts from 0. +

+

For example a value of 1.2 corresponds to the output with index +ceil(1.2)-1 = 2-1 = 1, that is the second output. +

+
+
outputs, n
+

Set the number of outputs. The output to which to send the selected +frame is based on the result of the evaluation. Default value is 1. +

+
+ +

The expression can contain the following constants: +

+
+
n
+

The (sequential) number of the filtered frame, starting from 0. +

+
+
selected_n
+

The (sequential) number of the selected frame, starting from 0. +

+
+
prev_selected_n
+

The sequential number of the last selected frame. It’s NAN if undefined. +

+
+
TB
+

The timebase of the input timestamps. +

+
+
pts
+

The PTS (Presentation TimeStamp) of the filtered video frame, +expressed in TB units. It’s NAN if undefined. +

+
+
t
+

The PTS of the filtered video frame, +expressed in seconds. It’s NAN if undefined. +

+
+
prev_pts
+

The PTS of the previously filtered video frame. It’s NAN if undefined. +

+
+
prev_selected_pts
+

The PTS of the last previously filtered video frame. It’s NAN if undefined. +

+
+
prev_selected_t
+

The PTS of the last previously selected video frame, expressed in seconds. It’s NAN if undefined. +

+
+
start_pts
+

The PTS of the first video frame in the video. It’s NAN if undefined. +

+
+
start_t
+

The time of the first video frame in the video. It’s NAN if undefined. +

+
+
pict_type (video only)
+

The type of the filtered frame. It can assume one of the following +values: +

+
I
+
P
+
B
+
S
+
SI
+
SP
+
BI
+
+ +
+
interlace_type (video only)
+

The frame interlace type. It can assume one of the following values: +

+
PROGRESSIVE
+

The frame is progressive (not interlaced). +

+
TOPFIRST
+

The frame is top-field-first. +

+
BOTTOMFIRST
+

The frame is bottom-field-first. +

+
+ +
+
consumed_sample_n (audio only)
+

the number of selected samples before the current frame +

+
+
samples_n (audio only)
+

the number of samples in the current frame +

+
+
sample_rate (audio only)
+

the input sample rate +

+
+
key
+

This is 1 if the filtered frame is a key-frame, 0 otherwise. +

+
+
pos
+

the position in the file of the filtered frame, -1 if the information +is not available (e.g. for synthetic video) +

+
+
scene (video only)
+

value between 0 and 1 to indicate a new scene; a low value reflects a low +probability for the current frame to introduce a new scene, while a higher +value means the current frame is more likely to be one (see the example below) +

+
+
concatdec_select
+

The concat demuxer can select only part of a concat input file by setting an +inpoint and an outpoint, but the output packets may not be entirely contained +in the selected interval. By using this variable, it is possible to skip frames +generated by the concat demuxer which are not exactly contained in the selected +interval. +

+

This works by comparing the frame pts against the lavf.concat.start_time +and the lavf.concat.duration packet metadata values which are also +present in the decoded frames. +

+

The concatdec_select variable is -1 if the frame pts is at least +start_time and either the duration metadata is missing or the frame pts is less +than start_time + duration, 0 otherwise, and NaN if the start_time metadata is +missing. +

+

That basically means that an input frame is selected if its pts is within the +interval set by the concat demuxer. +

+
+
+ +

The default value of the select expression is "1". +

+ +

35.14.1 Examples

+ +
    +
  • Select all frames in input: +
    +
    select
+
    + +

    The example above is the same as: +

    +
    select=1
+
    + +
  • Skip all frames: +
    +
    select=0
+
    + +
  • Select only I-frames: +
    +
    select='eq(pict_type\,I)'
+
    + +
  • Select one frame every 100: +
    +
    select='not(mod(n\,100))'
+
    + +
  • Select only frames contained in the 10-20 time interval: +
    +
    select=between(t\,10\,20)
+
    + +
  • Select only I-frames contained in the 10-20 time interval: +
    +
    select=between(t\,10\,20)*eq(pict_type\,I)
+
    + +
  • Select frames with a minimum distance of 10 seconds: +
    +
    select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
+
    + +
  • Use aselect to select only audio frames with samples number > 100: +
    +
    aselect='gt(samples_n\,100)'
+
    + +
  • Create a mosaic of the first scenes: +
    +
    ffmpeg -i video.avi -vf select='gt(scene\,0.4)',scale=160:120,tile -frames:v 1 preview.png
+
    + +

    Comparing scene against a value between 0.3 and 0.5 is generally a sane +choice. +

    +
  • Send even and odd frames to separate outputs, and compose them: +
    +
    select=n=2:e='mod(n, 2)+1' [odd][even]; [odd] pad=h=2*ih [tmp]; [tmp][even] overlay=y=h
+
    + +
  • Select useful frames from an ffconcat file which is using inpoints and +outpoints but where the source files are not intra frame only. +
    +
    ffmpeg -copyts -vsync 0 -segment_time_metadata 1 -i input.ffconcat -vf select=concatdec_select -af aselect=concatdec_select output.avi
+
    +
+ + +

35.15 sendcmd, asendcmd

+ +

Send commands to filters in the filtergraph. +

+

These filters read commands to be sent to other filters in the +filtergraph. +

+

sendcmd must be inserted between two video filters, +asendcmd must be inserted between two audio filters, but apart +from that they act the same way. +

+

The specification of commands can be provided in the filter arguments +with the commands option, or in a file specified by the +filename option. +

+

These filters accept the following options: +

+
commands, c
+

Set the commands to be read and sent to the other filters. +

+
filename, f
+

Set the filename of the commands to be read and sent to the other +filters. +

+
+ + +

35.15.1 Commands syntax

+ +

A commands description consists of a sequence of interval +specifications, comprising a list of commands to be executed when a +particular event related to that interval occurs. The occurring event +is typically the current frame time entering or leaving a given time +interval. +

+

An interval is specified by the following syntax: +

+
START[-END] COMMANDS;
+
+ +

The time interval is specified by the START and END times. +END is optional and defaults to the maximum time. +

+

The current frame time is considered within the specified interval if +it is included in the interval [START, END), that is when +the time is greater or equal to START and is lesser than +END. +

+

COMMANDS consists of a sequence of one or more command +specifications, separated by ",", relating to that interval. The +syntax of a command specification is given by: +

+
[FLAGS] TARGET COMMAND ARG
+
+ +

FLAGS is optional and specifies the type of events relating to +the time interval which enable sending the specified command, and must +be a non-null sequence of identifier flags separated by "+" or "|" and +enclosed between "[" and "]". +

+

The following flags are recognized: +

+
enter
+

The command is sent when the current frame timestamp enters the +specified interval. In other words, the command is sent when the +previous frame timestamp was not in the given interval, and the +current is. +

+
+
leave
+

The command is sent when the current frame timestamp leaves the +specified interval. In other words, the command is sent when the +previous frame timestamp was in the given interval, and the +current is not. +

+
+
expr
+

The command ARG is interpreted as expression and result of +expression is passed as ARG. +

+

The expression is evaluated through the eval API and can contain the following +constants: +

+
+
POS
+

Original position in the file of the frame, or undefined if undefined +for the current frame. +

+
+
PTS
+

The presentation timestamp in input. +

+
+
N
+

The count of the input frame for video or audio, starting from 0. +

+
+
T
+

The time in seconds of the current frame. +

+
+
TS
+

The start time in seconds of the current command interval. +

+
+
TE
+

The end time in seconds of the current command interval. +

+
+
TI
+

The interpolated time of the current command interval, TI = (T - TS) / (TE - TS). +

+
+ +
+
+ +

If FLAGS is not specified, a default value of [enter] is +assumed. +

+

TARGET specifies the target of the command, usually the name of +the filter class or a specific filter instance name. +

+

COMMAND specifies the name of the command for the target filter. +

+

ARG is optional and specifies the optional list of argument for +the given COMMAND. +

+

Between one interval specification and another, whitespaces, or +sequences of characters starting with # until the end of line, +are ignored and can be used to annotate comments. +

+

A simplified BNF description of the commands specification syntax +follows: +

+
COMMAND_FLAG  ::= "enter" | "leave"
+COMMAND_FLAGS ::= COMMAND_FLAG [(+|"|")COMMAND_FLAG]
+COMMAND       ::= ["[" COMMAND_FLAGS "]"] TARGET COMMAND [ARG]
+COMMANDS      ::= COMMAND [,COMMANDS]
+INTERVAL      ::= START[-END] COMMANDS
+INTERVALS     ::= INTERVAL[;INTERVALS]
+
+ + +

35.15.2 Examples

+ +
    +
  • Specify audio tempo change at second 4: +
    +
    asendcmd=c='4.0 atempo tempo 1.5',atempo
+
    + +
  • Target a specific filter instance: +
    +
    asendcmd=c='4.0 atempo@my tempo 1.5',atempo@my
+
    + +
  • Specify a list of drawtext and hue commands in a file. +
    +
    # show text in the interval 5-10
+5.0-10.0 [enter] drawtext reinit 'fontfile=FreeSerif.ttf:text=hello world',
+         [leave] drawtext reinit 'fontfile=FreeSerif.ttf:text=';
+
+# desaturate the image in the interval 15-20
+15.0-20.0 [enter] hue s 0,
+          [enter] drawtext reinit 'fontfile=FreeSerif.ttf:text=nocolor',
+          [leave] hue s 1,
+          [leave] drawtext reinit 'fontfile=FreeSerif.ttf:text=color';
+
+# apply an exponential saturation fade-out effect, starting from time 25
+25 [enter] hue s exp(25-t)
+
    + +

    A filtergraph allowing to read and process the above command list +stored in a file test.cmd, can be specified with: +

    +
    sendcmd=f=test.cmd,drawtext=fontfile=FreeSerif.ttf:text='',hue
+
    +
+ + +

35.16 setpts, asetpts

+ +

Change the PTS (presentation timestamp) of the input frames. +

+

setpts works on video frames, asetpts on audio frames. +

+

This filter accepts the following options: +

+
+
expr
+

The expression which is evaluated for each frame to construct its timestamp. +

+
+
+ +

The expression is evaluated through the eval API and can contain the following +constants: +

+
+
FRAME_RATE, FR
+

frame rate, only defined for constant frame-rate video +

+
+
PTS
+

The presentation timestamp in input +

+
+
N
+

The count of the input frame for video or the number of consumed samples, +not including the current frame for audio, starting from 0. +

+
+
NB_CONSUMED_SAMPLES
+

The number of consumed samples, not including the current frame (only +audio) +

+
+
NB_SAMPLES, S
+

The number of samples in the current frame (only audio) +

+
+
SAMPLE_RATE, SR
+

The audio sample rate. +

+
+
STARTPTS
+

The PTS of the first frame. +

+
+
STARTT
+

the time in seconds of the first frame +

+
+
INTERLACED
+

State whether the current frame is interlaced. +

+
+
T
+

the time in seconds of the current frame +

+
+
POS
+

original position in the file of the frame, or undefined if undefined +for the current frame +

+
+
PREV_INPTS
+

The previous input PTS. +

+
+
PREV_INT
+

previous input time in seconds +

+
+
PREV_OUTPTS
+

The previous output PTS. +

+
+
PREV_OUTT
+

previous output time in seconds +

+
+
RTCTIME
+

The wallclock (RTC) time in microseconds. This is deprecated, use time(0) +instead. +

+
+
RTCSTART
+

The wallclock (RTC) time at the start of the movie in microseconds. +

+
+
TB
+

The timebase of the input timestamps. +

+
+
+ + +

35.16.1 Examples

+ +
    +
  • Start counting PTS from zero +
    +
    setpts=PTS-STARTPTS
+
    + +
  • Apply fast motion effect: +
    +
    setpts=0.5*PTS
+
    + +
  • Apply slow motion effect: +
    +
    setpts=2.0*PTS
+
    + +
  • Set fixed rate of 25 frames per second: +
    +
    setpts=N/(25*TB)
+
    + +
  • Set fixed rate 25 fps with some jitter: +
    +
    setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
+
    + +
  • Apply an offset of 10 seconds to the input PTS: +
    +
    setpts=PTS+10/TB
+
    + +
  • Generate timestamps from a "live source" and rebase onto the current timebase: +
    +
    setpts='(RTCTIME - RTCSTART) / (TB * 1000000)'
+
    + +
  • Generate timestamps by counting samples: +
    +
    asetpts=N/SR/TB
+
    + +
+ + +

35.17 setrange

+ +

Force color range for the output video frame. +

+

The setrange filter marks the color range property for the +output frames. It does not change the input frame, but only sets the +corresponding property, which affects how the frame is treated by +following filters. +

+

The filter accepts the following options: +

+
+
range
+

Available values are: +

+
+
‘auto’
+

Keep the same color range property. +

+
+
‘unspecified, unknown’
+

Set the color range as unspecified. +

+
+
‘limited, tv, mpeg’
+

Set the color range as limited. +

+
+
‘full, pc, jpeg’
+

Set the color range as full. +

+
+
+
+ + +

35.18 settb, asettb

+ +

Set the timebase to use for the output frames timestamps. +It is mainly useful for testing timebase configuration. +

+

It accepts the following parameters: +

+
+
expr, tb
+

The expression which is evaluated into the output timebase. +

+
+
+ +

The value for tb is an arithmetic expression representing a +rational. The expression can contain the constants "AVTB" (the default +timebase), "intb" (the input timebase) and "sr" (the sample rate, +audio only). Default value is "intb". +

+ +

35.18.1 Examples

+ +
    +
  • Set the timebase to 1/25: +
    +
    settb=expr=1/25
+
    + +
  • Set the timebase to 1/10: +
    +
    settb=expr=0.1
+
    + +
  • Set the timebase to 1001/1000: +
    +
    settb=1+0.001
+
    + +
  • Set the timebase to 2*intb: +
    +
    settb=2*intb
+
    + +
  • Set the default timebase value: +
    +
    settb=AVTB
+
    +
+ + +

35.19 showcqt

+

Convert input audio to a video output representing frequency spectrum +logarithmically using Brown-Puckette constant Q transform algorithm with +direct frequency domain coefficient calculation (but the transform itself +is not really constant Q, instead the Q factor is actually variable/clamped), +with musical tone scale, from E0 to D#10. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. It must be even. For the syntax of this option, +check the (ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 1920x1080. +

+
+
fps, rate, r
+

Set the output frame rate. Default value is 25. +

+
+
bar_h
+

Set the bargraph height. It must be even. Default value is -1 which +computes the bargraph height automatically. +

+
+
axis_h
+

Set the axis height. It must be even. Default value is -1 which computes +the axis height automatically. +

+
+
sono_h
+

Set the sonogram height. It must be even. Default value is -1 which +computes the sonogram height automatically. +

+
+
fullhd
+

Set the fullhd resolution. This option is deprecated, use size, s +instead. Default value is 1. +

+
+
sono_v, volume
+

Specify the sonogram volume expression. It can contain variables: +

+
bar_v
+

the bar_v evaluated expression +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option +

+
+

and functions: +

+
a_weighting(f)
+

A-weighting of equal loudness +

+
b_weighting(f)
+

B-weighting of equal loudness +

+
c_weighting(f)
+

C-weighting of equal loudness. +

+
+

Default value is 16. +

+
+
bar_v, volume2
+

Specify the bargraph volume expression. It can contain variables: +

+
sono_v
+

the sono_v evaluated expression +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option +

+
+

and functions: +

+
a_weighting(f)
+

A-weighting of equal loudness +

+
b_weighting(f)
+

B-weighting of equal loudness +

+
c_weighting(f)
+

C-weighting of equal loudness. +

+
+

Default value is sono_v. +

+
+
sono_g, gamma
+

Specify the sonogram gamma. Lower gamma makes the spectrum more contrast, +higher gamma makes the spectrum having more range. Default value is 3. +Acceptable range is [1, 7]. +

+
+
bar_g, gamma2
+

Specify the bargraph gamma. Default value is 1. Acceptable range is +[1, 7]. +

+
+
bar_t
+

Specify the bargraph transparency level. Lower value makes the bargraph sharper. +Default value is 1. Acceptable range is [0, 1]. +

+
+
timeclamp, tc
+

Specify the transform timeclamp. At low frequency, there is trade-off between +accuracy in time domain and frequency domain. If timeclamp is lower, +event in time domain is represented more accurately (such as fast bass drum), +otherwise event in frequency domain is represented more accurately +(such as bass guitar). Acceptable range is [0.002, 1]. Default value is 0.17. +

+
+
attack
+

Set attack time in seconds. The default is 0 (disabled). Otherwise, it +limits future samples by applying asymmetric windowing in time domain, useful +when low latency is required. Accepted range is [0, 1]. +

+
+
basefreq
+

Specify the transform base frequency. Default value is 20.01523126408007475, +which is frequency 50 cents below E0. Acceptable range is [10, 100000]. +

+
+
endfreq
+

Specify the transform end frequency. Default value is 20495.59681441799654, +which is frequency 50 cents above D#10. Acceptable range is [10, 100000]. +

+
+
coeffclamp
+

This option is deprecated and ignored. +

+
+
tlength
+

Specify the transform length in time domain. Use this option to control accuracy +trade-off between time domain and frequency domain at every frequency sample. +It can contain variables: +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option. +

+
+

Default value is 384*tc/(384+tc*f). +

+
+
count
+

Specify the transform count for every video frame. Default value is 6. +Acceptable range is [1, 30]. +

+
+
fcount
+

Specify the transform count for every single pixel. Default value is 0, +which makes it computed automatically. Acceptable range is [0, 10]. +

+
+
fontfile
+

Specify font file for use with freetype to draw the axis. If not specified, +use embedded font. Note that drawing with font file or embedded font is not +implemented with custom basefreq and endfreq, use axisfile +option instead. +

+
+
font
+

Specify fontconfig pattern. This has lower priority than fontfile. The +: in the pattern may be replaced by | to avoid unnecessary +escaping. +

+
+
fontcolor
+

Specify font color expression. This is arithmetic expression that should return +integer value 0xRRGGBB. It can contain variables: +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option +

+
+

and functions: +

+
midi(f)
+

midi number of frequency f, some midi numbers: E0(16), C1(24), C2(36), A4(69) +

+
r(x), g(x), b(x)
+

red, green, and blue value of intensity x. +

+
+

Default value is st(0, (midi(f)-59.5)/12); +st(1, if(between(ld(0),0,1), 0.5-0.5*cos(2*PI*ld(0)), 0)); +r(1-ld(1)) + b(ld(1)). +

+
+
axisfile
+

Specify image file to draw the axis. This option override fontfile and +fontcolor option. +

+
+
axis, text
+

Enable/disable drawing text to the axis. If it is set to 0, drawing to +the axis is disabled, ignoring fontfile and axisfile option. +Default value is 1. +

+
+
csp
+

Set colorspace. The accepted values are: +

+
‘unspecified’
+

Unspecified (default) +

+
+
‘bt709’
+

BT.709 +

+
+
‘fcc’
+

FCC +

+
+
‘bt470bg’
+

BT.470BG or BT.601-6 625 +

+
+
‘smpte170m’
+

SMPTE-170M or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘bt2020ncl’
+

BT.2020 with non-constant luminance +

+
+
+ +
+
cscheme
+

Set spectrogram color scheme. This is list of floating point values with format +left_r|left_g|left_b|right_r|right_g|right_b. +The default is 1|0.5|0|0|0.5|1. +

+
+
+ + +

35.19.1 Examples

+ +
    +
  • Playing audio while showing the spectrum: +
    +
    ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt [out0]'
+
    + +
  • Same as above, but with frame rate 30 fps: +
    +
    ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt=fps=30:count=5 [out0]'
+
    + +
  • Playing at 1280x720: +
    +
    ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt=s=1280x720:count=4 [out0]'
+
    + +
  • Disable sonogram display: +
    +
    sono_h=0
+
    + +
  • A1 and its harmonics: A1, A2, (near)E3, A3: +
    +
    ffplay -f lavfi 'aevalsrc=0.1*sin(2*PI*55*t)+0.1*sin(4*PI*55*t)+0.1*sin(6*PI*55*t)+0.1*sin(8*PI*55*t),
+                 asplit[a][out1]; [a] showcqt [out0]'
+
    + +
  • Same as above, but with more accuracy in frequency domain: +
    +
    ffplay -f lavfi 'aevalsrc=0.1*sin(2*PI*55*t)+0.1*sin(4*PI*55*t)+0.1*sin(6*PI*55*t)+0.1*sin(8*PI*55*t),
+                 asplit[a][out1]; [a] showcqt=timeclamp=0.5 [out0]'
+
    + +
  • Custom volume: +
    +
    bar_v=10:sono_v=bar_v*a_weighting(f)
+
    + +
  • Custom gamma, now spectrum is linear to the amplitude. +
    +
    bar_g=2:sono_g=2
+
    + +
  • Custom tlength equation: +
    +
    tc=0.33:tlength='st(0,0.17); 384*tc / (384 / ld(0) + tc*f /(1-ld(0))) + 384*tc / (tc*f / ld(0) + 384 /(1-ld(0)))'
+
    + +
  • Custom fontcolor and fontfile, C-note is colored green, others are colored blue: +
    +
    fontcolor='if(mod(floor(midi(f)+0.5),12), 0x0000FF, g(1))':fontfile=myfont.ttf
+
    + +
  • Custom font using fontconfig: +
    +
    font='Courier New,Monospace,mono|bold'
+
    + +
  • Custom frequency range with custom axis using image file: +
    +
    axisfile=myaxis.png:basefreq=40:endfreq=10000
+
    +
+ + +

35.20 showfreqs

+ +

Convert input audio to video output representing the audio power spectrum. +Audio amplitude is on Y-axis while frequency is on X-axis. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify size of video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default is 1024x512. +

+
+
mode
+

Set display mode. +This set how each frequency bin will be represented. +

+

It accepts the following values: +

+
‘line’
+
‘bar’
+
‘dot’
+
+

Default is bar. +

+
+
ascale
+

Set amplitude scale. +

+

It accepts the following values: +

+
‘lin’
+

Linear scale. +

+
+
‘sqrt’
+

Square root scale. +

+
+
‘cbrt’
+

Cubic root scale. +

+
+
‘log’
+

Logarithmic scale. +

+
+

Default is log. +

+
+
fscale
+

Set frequency scale. +

+

It accepts the following values: +

+
‘lin’
+

Linear scale. +

+
+
‘log’
+

Logarithmic scale. +

+
+
‘rlog’
+

Reverse logarithmic scale. +

+
+

Default is lin. +

+
+
win_size
+

Set window size. Allowed range is from 16 to 65536. +

+

Default is 2048 +

+
+
win_func
+

Set windowing function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+

Default is hanning. +

+
+
overlap
+

Set window overlap. In range [0, 1]. Default is 1, +which means optimal overlap for selected window function will be picked. +

+
+
averaging
+

Set time averaging. Setting this to 0 will display current maximal peaks. +Default is 1, which means time averaging is disabled. +

+
+
colors
+

Specify list of colors separated by space or by ’|’ which will be used to +draw channel frequencies. Unrecognized or missing colors will be replaced +by white color. +

+
+
cmode
+

Set channel display mode. +

+

It accepts the following values: +

+
‘combined’
+
‘separate’
+
+

Default is combined. +

+
+
minamp
+

Set minimum amplitude used in log amplitude scaler. +

+
+
+ + +

35.21 showspatial

+ +

Convert stereo input audio to a video output, representing the spatial relationship +between two channels. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 512x512. +

+
+
win_size
+

Set window size. Allowed range is from 1024 to 65536. Default size is 4096. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+ +

Default value is hann. +

+
+
overlap
+

Set ratio of overlap window. Default value is 0.5. +When value is 1 overlap is set to recommended size for specific +window function currently used. +

+
+ + +

35.22 showspectrum

+ +

Convert input audio to a video output, representing the audio frequency +spectrum. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 640x512. +

+
+
slide
+

Specify how the spectrum should slide along the window. +

+

It accepts the following values: +

+
‘replace’
+

the samples start again on the left when they reach the right +

+
‘scroll’
+

the samples scroll from right to left +

+
‘fullframe’
+

frames are only produced when the samples reach the right +

+
‘rscroll’
+

the samples scroll from left to right +

+
+ +

Default value is replace. +

+
+
mode
+

Specify display mode. +

+

It accepts the following values: +

+
‘combined’
+

all channels are displayed in the same row +

+
‘separate’
+

all channels are displayed in separate rows +

+
+ +

Default value is ‘combined’. +

+
+
color
+

Specify display color mode. +

+

It accepts the following values: +

+
‘channel’
+

each channel is displayed in a separate color +

+
‘intensity’
+

each channel is displayed using the same color scheme +

+
‘rainbow’
+

each channel is displayed using the rainbow color scheme +

+
‘moreland’
+

each channel is displayed using the moreland color scheme +

+
‘nebulae’
+

each channel is displayed using the nebulae color scheme +

+
‘fire’
+

each channel is displayed using the fire color scheme +

+
‘fiery’
+

each channel is displayed using the fiery color scheme +

+
‘fruit’
+

each channel is displayed using the fruit color scheme +

+
‘cool’
+

each channel is displayed using the cool color scheme +

+
‘magma’
+

each channel is displayed using the magma color scheme +

+
‘green’
+

each channel is displayed using the green color scheme +

+
‘viridis’
+

each channel is displayed using the viridis color scheme +

+
‘plasma’
+

each channel is displayed using the plasma color scheme +

+
‘cividis’
+

each channel is displayed using the cividis color scheme +

+
‘terrain’
+

each channel is displayed using the terrain color scheme +

+
+ +

Default value is ‘channel’. +

+
+
scale
+

Specify scale used for calculating intensity color values. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘sqrt’
+

square root, default +

+
‘cbrt’
+

cubic root +

+
‘log’
+

logarithmic +

+
‘4thrt’
+

4th root +

+
‘5thrt’
+

5th root +

+
+ +

Default value is ‘sqrt’. +

+
+
fscale
+

Specify frequency scale. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘log’
+

logarithmic +

+
+ +

Default value is ‘lin’. +

+
+
saturation
+

Set saturation modifier for displayed colors. Negative values provide +alternative color scheme. 0 is no saturation at all. +Saturation must be in [-10.0, 10.0] range. +Default value is 1. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+ +

Default value is hann. +

+
+
orientation
+

Set orientation of time vs frequency axis. Can be vertical or +horizontal. Default is vertical. +

+
+
overlap
+

Set ratio of overlap window. Default value is 0. +When value is 1 overlap is set to recommended size for specific +window function currently used. +

+
+
gain
+

Set scale gain for calculating intensity color values. +Default value is 1. +

+
+
data
+

Set which data to display. Can be magnitude, default or phase. +

+
+
rotation
+

Set color rotation, must be in [-1.0, 1.0] range. +Default value is 0. +

+
+
start
+

Set start frequency from which to display spectrogram. Default is 0. +

+
+
stop
+

Set stop frequency to which to display spectrogram. Default is 0. +

+
+
fps
+

Set upper frame rate limit. Default is auto, unlimited. +

+
+
legend
+

Draw time and frequency axes and legends. Default is disabled. +

+
+ +

The usage is very similar to the showwaves filter; see the examples in that +section. +

+ +

35.22.1 Examples

+ +
    +
  • Large window with logarithmic color scaling: +
    +
    showspectrum=s=1280x480:scale=log
+
    + +
  • Complete example for a colored and sliding spectrum per channel using ffplay: +
    +
    ffplay -f lavfi 'amovie=input.mp3, asplit [a][out1];
+             [a] showspectrum=mode=separate:color=intensity:slide=1:scale=cbrt [out0]'
+
    +
+ + +

35.23 showspectrumpic

+ +

Convert input audio to a single video frame, representing the audio frequency +spectrum. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 4096x2048. +

+
+
mode
+

Specify display mode. +

+

It accepts the following values: +

+
‘combined’
+

all channels are displayed in the same row +

+
‘separate’
+

all channels are displayed in separate rows +

+
+

Default value is ‘combined’. +

+
+
color
+

Specify display color mode. +

+

It accepts the following values: +

+
‘channel’
+

each channel is displayed in a separate color +

+
‘intensity’
+

each channel is displayed using the same color scheme +

+
‘rainbow’
+

each channel is displayed using the rainbow color scheme +

+
‘moreland’
+

each channel is displayed using the moreland color scheme +

+
‘nebulae’
+

each channel is displayed using the nebulae color scheme +

+
‘fire’
+

each channel is displayed using the fire color scheme +

+
‘fiery’
+

each channel is displayed using the fiery color scheme +

+
‘fruit’
+

each channel is displayed using the fruit color scheme +

+
‘cool’
+

each channel is displayed using the cool color scheme +

+
‘magma’
+

each channel is displayed using the magma color scheme +

+
‘green’
+

each channel is displayed using the green color scheme +

+
‘viridis’
+

each channel is displayed using the viridis color scheme +

+
‘plasma’
+

each channel is displayed using the plasma color scheme +

+
‘cividis’
+

each channel is displayed using the cividis color scheme +

+
‘terrain’
+

each channel is displayed using the terrain color scheme +

+
+

Default value is ‘intensity’. +

+
+
scale
+

Specify scale used for calculating intensity color values. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘sqrt’
+

square root, default +

+
‘cbrt’
+

cubic root +

+
‘log’
+

logarithmic +

+
‘4thrt’
+

4th root +

+
‘5thrt’
+

5th root +

+
+

Default value is ‘log’. +

+
+
fscale
+

Specify frequency scale. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘log’
+

logarithmic +

+
+ +

Default value is ‘lin’. +

+
+
saturation
+

Set saturation modifier for displayed colors. Negative values provide +alternative color scheme. 0 is no saturation at all. +Saturation must be in [-10.0, 10.0] range. +Default value is 1. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+

Default value is hann. +

+
+
orientation
+

Set orientation of time vs frequency axis. Can be vertical or +horizontal. Default is vertical. +

+
+
gain
+

Set scale gain for calculating intensity color values. +Default value is 1. +

+
+
legend
+

Draw time and frequency axes and legends. Default is enabled. +

+
+
rotation
+

Set color rotation, must be in [-1.0, 1.0] range. +Default value is 0. +

+
+
start
+

Set start frequency from which to display spectrogram. Default is 0. +

+
+
stop
+

Set stop frequency to which to display spectrogram. Default is 0. +

+
+ + +

35.23.1 Examples

+ +
    +
  • Extract an audio spectrogram of a whole audio track +in a 1024x1024 picture using ffmpeg: +
    +
    ffmpeg -i audio.flac -lavfi showspectrumpic=s=1024x1024 spectrogram.png
+
    +
+ + +

35.24 showvolume

+ +

Convert input audio volume to a video output. +

+

The filter accepts the following options: +

+
+
rate, r
+

Set video rate. +

+
+
b
+

Set border width, allowed range is [0, 5]. Default is 1. +

+
+
w
+

Set channel width, allowed range is [80, 8192]. Default is 400. +

+
+
h
+

Set channel height, allowed range is [1, 900]. Default is 20. +

+
+
f
+

Set fade, allowed range is [0, 1]. Default is 0.95. +

+
+
c
+

Set volume color expression. +

+

The expression can use the following variables: +

+
+
VOLUME
+

Current max volume of channel in dB. +

+
+
PEAK
+

Current peak. +

+
+
CHANNEL
+

Current channel number, starting from 0. +

+
+ +
+
t
+

If set, displays channel names. Default is enabled. +

+
+
v
+

If set, displays volume values. Default is enabled. +

+
+
o
+

Set orientation, can be horizontal: h or vertical: v, +default is h. +

+
+
s
+

Set step size, allowed range is [0, 5]. Default is 0, which means +step is disabled. +

+
+
p
+

Set background opacity, allowed range is [0, 1]. Default is 0. +

+
+
m
+

Set metering mode, can be peak: p or rms: r, +default is p. +

+
+
ds
+

Set display scale, can be linear: lin or log: log, +default is lin. +

+
+
dm
+

In second. +If set to > 0., display a line for the max level +in the previous seconds. +default is disabled: 0. +

+
+
dmc
+

The color of the max line. Use when dm option is set to > 0. +default is: orange +

+
+ + +

35.25 showwaves

+ +

Convert input audio to a video output, representing the samples waves. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 600x240. +

+
+
mode
+

Set display mode. +

+

Available values are: +

+
‘point’
+

Draw a point for each sample. +

+
+
‘line’
+

Draw a vertical line for each sample. +

+
+
‘p2p’
+

Draw a point for each sample and a line between them. +

+
+
‘cline’
+

Draw a centered vertical line for each sample. +

+
+ +

Default value is point. +

+
+
n
+

Set the number of samples which are printed on the same column. A +larger value will decrease the frame rate. Must be a positive +integer. This option can be set only if the value for rate +is not explicitly specified. +

+
+
rate, r
+

Set the (approximate) output frame rate. This is done by setting the +option n. Default value is "25". +

+
+
split_channels
+

Set if channels should be drawn separately or overlap. Default value is 0. +

+
+
colors
+

Set colors separated by ’|’ which are going to be used for drawing of each channel. +

+
+
scale
+

Set amplitude scale. +

+

Available values are: +

+
‘lin’
+

Linear. +

+
+
‘log’
+

Logarithmic. +

+
+
‘sqrt’
+

Square root. +

+
+
‘cbrt’
+

Cubic root. +

+
+ +

Default is linear. +

+
+
draw
+

Set the draw mode. This is mostly useful to set for high n. +

+

Available values are: +

+
‘scale’
+

Scale pixel values for each drawn sample. +

+
+
‘full’
+

Draw every sample directly. +

+
+ +

Default value is scale. +

+
+ + +

35.25.1 Examples

+ +
    +
  • Output the input file audio and the corresponding video representation +at the same time: +
    +
    amovie=a.mp3,asplit[out0],showwaves[out1]
+
    + +
  • Create a synthetic signal and show it with showwaves, forcing a +frame rate of 30 frames per second: +
    +
    aevalsrc=sin(1*2*PI*t)*sin(880*2*PI*t):cos(2*PI*200*t),asplit[out0],showwaves=r=30[out1]
+
    +
+ + +

35.26 showwavespic

+ +

Convert input audio to a single video frame, representing the samples waves. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 600x240. +

+
+
split_channels
+

Set if channels should be drawn separately or overlap. Default value is 0. +

+
+
colors
+

Set colors separated by ’|’ which are going to be used for drawing of each channel. +

+
+
scale
+

Set amplitude scale. +

+

Available values are: +

+
‘lin’
+

Linear. +

+
+
‘log’
+

Logarithmic. +

+
+
‘sqrt’
+

Square root. +

+
+
‘cbrt’
+

Cubic root. +

+
+ +

Default is linear. +

+
+
draw
+

Set the draw mode. +

+

Available values are: +

+
‘scale’
+

Scale pixel values for each drawn sample. +

+
+
‘full’
+

Draw every sample directly. +

+
+ +

Default value is scale. +

+
+ + +

35.26.1 Examples

+ +
    +
  • Extract a channel split representation of the wave form of a whole audio track +in a 1024x800 picture using ffmpeg: +
    +
    ffmpeg -i audio.flac -lavfi showwavespic=split_channels=1:s=1024x800 waveform.png
+
    +
+ + +

35.27 sidedata, asidedata

+ +

Delete frame side data, or select frames based on it. +

+

This filter accepts the following options: +

+
+
mode
+

Set mode of operation of the filter. +

+

Can be one of the following: +

+
+
‘select’
+

Select every frame with side data of type. +

+
+
‘delete’
+

Delete side data of type. If type is not set, delete all side +data in the frame. +

+
+
+ +
+
type
+

Set side data type used with all modes. Must be set for select mode. For +the list of frame side data types, refer to the AVFrameSideDataType enum +in libavutil/frame.h. For example, to choose +AV_FRAME_DATA_PANSCAN side data, you must specify PANSCAN. +

+
+
+ + +

35.28 spectrumsynth

+ +

Synthesize audio from 2 input video spectrums, first input stream represents +magnitude across time and second represents phase across time. +The filter will transform from frequency domain as displayed in videos back +to time domain as presented in audio output. +

+

This filter is primarily created for reversing processed showspectrum +filter outputs, but can synthesize sound from other spectrograms too. +But in such case results are going to be poor if the phase data is not +available, because in such cases phase data need to be recreated, usually +it’s just recreated from random noise. +For best results use gray only output (channel color mode in +showspectrum filter) and log scale for magnitude video and +lin scale for phase video. To produce phase, for 2nd video, use +data option. Inputs videos should generally use fullframe +slide mode as that saves resources needed for decoding video. +

+

The filter accepts the following options: +

+
+
sample_rate
+

Specify sample rate of output audio, the sample rate of audio from which +spectrum was generated may differ. +

+
+
channels
+

Set number of channels represented in input video spectrums. +

+
+
scale
+

Set scale which was used when generating magnitude input spectrum. +Can be lin or log. Default is log. +

+
+
slide
+

Set slide which was used when generating inputs spectrums. +Can be replace, scroll, fullframe or rscroll. +Default is fullframe. +

+
+
win_func
+

Set window function used for resynthesis. +

+
+
overlap
+

Set window overlap. In range [0, 1]. Default is 1, +which means optimal overlap for selected window function will be picked. +

+
+
orientation
+

Set orientation of input videos. Can be vertical or horizontal. +Default is vertical. +

+
+ + +

35.28.1 Examples

+ +
    +
  • First create magnitude and phase videos from audio, assuming audio is stereo with 44100 sample rate, +then resynthesize videos back to audio with spectrumsynth: +
    +
    ffmpeg -i input.flac -lavfi showspectrum=mode=separate:scale=log:overlap=0.875:color=channel:slide=fullframe:data=magnitude -an -c:v rawvideo magnitude.nut
+ffmpeg -i input.flac -lavfi showspectrum=mode=separate:scale=lin:overlap=0.875:color=channel:slide=fullframe:data=phase -an -c:v rawvideo phase.nut
+ffmpeg -i magnitude.nut -i phase.nut -lavfi spectrumsynth=channels=2:sample_rate=44100:win_func=hann:overlap=0.875:slide=fullframe output.flac
+
    +
+ + +

35.29 split, asplit

+ +

Split input into several identical outputs. +

+

asplit works with audio input, split with video. +

+

The filter accepts a single parameter which specifies the number of outputs. If +unspecified, it defaults to 2. +

+ +

35.29.1 Examples

+ +
    +
  • Create two separate outputs from the same input: +
    +
    [in] split [out0][out1]
+
    + +
  • To create 3 or more outputs, you need to specify the number of +outputs, like in: +
    +
    [in] asplit=3 [out0][out1][out2]
+
    + +
  • Create two separate outputs from the same input, one cropped and +one padded: +
    +
    [in] split [splitout1][splitout2];
+[splitout1] crop=100:100:0:0    [cropout];
+[splitout2] pad=200:200:100:100 [padout];
+
    + +
  • Create 5 copies of the input audio with ffmpeg: +
    +
    ffmpeg -i INPUT -filter_complex asplit=5 OUTPUT
+
    +
+ + +

35.30 zmq, azmq

+ +

Receive commands sent through a libzmq client, and forward them to +filters in the filtergraph. +

+

zmq and azmq work as a pass-through filters. zmq +must be inserted between two video filters, azmq between two +audio filters. Both are capable to send messages to any filter type. +

+

To enable these filters you need to install the libzmq library and +headers and configure FFmpeg with --enable-libzmq. +

+

For more information about libzmq see: +http://www.zeromq.org/ +

+

The zmq and azmq filters work as a libzmq server, which +receives messages sent through a network interface defined by the +bind_address (or the abbreviation "b") option. +Default value of this option is tcp://localhost:5555. You may +want to alter this value to your needs, but do not forget to escape any +’:’ signs (see filtergraph escaping). +

+

The received message must be in the form: +

+
TARGET COMMAND [ARG]
+
+ +

TARGET specifies the target of the command, usually the name of +the filter class or a specific filter instance name. The default +filter instance name uses the pattern ‘Parsed_<filter_name>_<index>’, +but you can override this by using the ‘filter_name@id’ syntax +(see Filtergraph syntax). +

+

COMMAND specifies the name of the command for the target filter. +

+

ARG is optional and specifies the optional argument list for the +given COMMAND. +

+

Upon reception, the message is processed and the corresponding command +is injected into the filtergraph. Depending on the result, the filter +will send a reply to the client, adopting the format: +

+
ERROR_CODE ERROR_REASON
+MESSAGE
+
+ +

MESSAGE is optional. +

+ +

35.30.1 Examples

+ +

Look at tools/zmqsend for an example of a zmq client which can +be used to send commands processed by these filters. +

+

Consider the following filtergraph generated by ffplay. +In this example the last overlay filter has an instance name. All other +filters will have default instance names. +

+
+
ffplay -dumpgraph 1 -f lavfi "
+color=s=100x100:c=red  [l];
+color=s=100x100:c=blue [r];
+nullsrc=s=200x100, zmq [bg];
+[bg][l]   overlay     [bg+l];
+[bg+l][r] overlay@my=x=100 "
+
+ +

To change the color of the left side of the video, the following +command can be used: +

+
echo Parsed_color_0 c yellow | tools/zmqsend
+
+ +

To change the right side: +

+
echo Parsed_color_1 c pink | tools/zmqsend
+
+ +

To change the position of the right side: +

+
echo overlay@my x 150 | tools/zmqsend
+
+ + + + +

36 Multimedia Sources

+ +

Below is a description of the currently available multimedia sources. +

+ +

36.1 amovie

+ +

This is the same as movie source, except it selects an audio +stream by default. +

+ +

36.2 movie

+ +

Read audio and/or video stream(s) from a movie container. +

+

It accepts the following parameters: +

+
+
filename
+

The name of the resource to read (not necessarily a file; it can also be a +device or a stream accessed through some protocol). +

+
+
format_name, f
+

Specifies the format assumed for the movie to read, and can be either +the name of a container or an input device. If not specified, the +format is guessed from movie_name or by probing. +

+
+
seek_point, sp
+

Specifies the seek point in seconds. The frames will be output +starting from this seek point. The parameter is evaluated with +av_strtod, so the numerical value may be suffixed by an IS +postfix. The default value is "0". +

+
+
streams, s
+

Specifies the streams to read. Several streams can be specified, +separated by "+". The source will then have as many outputs, in the +same order. The syntax is explained in the (ffmpeg)"Stream specifiers" +section in the ffmpeg manual. Two special names, "dv" and "da" specify +respectively the default (best suited) video and audio stream. Default +is "dv", or "da" if the filter is called as "amovie". +

+
+
stream_index, si
+

Specifies the index of the video stream to read. If the value is -1, +the most suitable video stream will be automatically selected. The default +value is "-1". Deprecated. If the filter is called "amovie", it will select +audio instead of video. +

+
+
loop
+

Specifies how many times to read the stream in sequence. +If the value is 0, the stream will be looped infinitely. +Default value is "1". +

+

Note that when the movie is looped the source timestamps are not +changed, so it will generate non monotonically increasing timestamps. +

+
+
discontinuity
+

Specifies the time difference between frames above which the point is +considered a timestamp discontinuity which is removed by adjusting the later +timestamps. +

+
+ +

It allows overlaying a second video on top of the main input of +a filtergraph, as shown in this graph: +

+
input -----------> deltapts0 --> overlay --> output
+                                    ^
+                                    |
+movie --> scale--> deltapts1 -------+
+
+ +

36.2.1 Examples

+ +
    +
  • Skip 3.2 seconds from the start of the AVI file in.avi, and overlay it +on top of the input labelled "in": +
    +
    movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [over];
+[in] setpts=PTS-STARTPTS [main];
+[main][over] overlay=16:16 [out]
+
    + +
  • Read from a video4linux2 device, and overlay it on top of the input +labelled "in": +
    +
    movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [over];
+[in] setpts=PTS-STARTPTS [main];
+[main][over] overlay=16:16 [out]
+
    + +
  • Read the first video stream and the audio stream with id 0x81 from +dvd.vob; the video is connected to the pad named "video" and the audio is +connected to the pad named "audio": +
    +
    movie=dvd.vob:s=v:0+#0x81 [video] [audio]
+
    +
+ + +

36.2.2 Commands

+ +

Both movie and amovie support the following commands: +

+
seek
+

Perform seek using "av_seek_frame". +The syntax is: seek stream_index|timestamp|flags +

    +
  • stream_index: If stream_index is -1, a default +stream is selected, and timestamp is automatically converted +from AV_TIME_BASE units to the stream specific time_base. +
  • timestamp: Timestamp in AVStream.time_base units +or, if no stream is specified, in AV_TIME_BASE units. +
  • flags: Flags which select direction and seeking mode. +
+ +
+
get_duration
+

Get movie duration in AV_TIME_BASE units. +

+
+
+ + + +

37 See Also

+ +

ffplay, +ffmpeg, ffprobe, +ffmpeg-utils, +ffmpeg-scaler, +ffmpeg-resampler, +ffmpeg-codecs, +ffmpeg-bitstream-filters, +ffmpeg-formats, +ffmpeg-devices, +ffmpeg-protocols, +ffmpeg-filters +

+ + +

38 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffplay.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffplay.html new file mode 100644 index 0000000..4b36759 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffplay.html @@ -0,0 +1,852 @@ + + + + + + + ffplay Documentation + + + + + + +
+

+ ffplay Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Synopsis

+ +

ffplay [options] [input_url] +

+ +

2 Description

+ +

FFplay is a very simple and portable media player using the FFmpeg +libraries and the SDL library. It is mostly used as a testbed for the +various FFmpeg APIs. +

+ +

3 Options

+ +

All the numerical options, if not specified otherwise, accept a string +representing a number as input, which may be followed by one of the SI +unit prefixes, for example: ’K’, ’M’, or ’G’. +

+

If ’i’ is appended to the SI unit prefix, the complete prefix will be +interpreted as a unit prefix for binary multiples, which are based on +powers of 1024 instead of powers of 1000. Appending ’B’ to the SI unit +prefix multiplies the value by 8. This allows using, for example: +’KB’, ’MiB’, ’G’ and ’B’ as number suffixes. +

+

Options which do not take arguments are boolean options, and set the +corresponding value to true. They can be set to false by prefixing +the option name with "no". For example using "-nofoo" +will set the boolean option with name "foo" to false. +

+ +

3.1 Stream specifiers

+

Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers +are used to precisely specify which stream(s) a given option belongs to. +

+

A stream specifier is a string generally appended to the option name and +separated from it by a colon. E.g. -codec:a:1 ac3 contains the +a:1 stream specifier, which matches the second audio stream. Therefore, it +would select the ac3 codec for the second audio stream. +

+

A stream specifier can match several streams, so that the option is applied to all +of them. E.g. the stream specifier in -b:a 128k matches all audio +streams. +

+

An empty stream specifier matches all streams. For example, -codec copy +or -codec: copy would copy all the streams without reencoding. +

+

Possible forms of stream specifiers are: +

+
stream_index
+

Matches the stream with this index. E.g. -threads:1 4 would set the +thread count for the second stream to 4. If stream_index is used as an +additional stream specifier (see below), then it selects stream number +stream_index from the matching streams. Stream numbering is based on the +order of the streams as detected by libavformat except when a program ID is +also specified. In this case it is based on the ordering of the streams in the +program. +

+
stream_type[:additional_stream_specifier]
+

stream_type is one of following: ’v’ or ’V’ for video, ’a’ for audio, ’s’ +for subtitle, ’d’ for data, and ’t’ for attachments. ’v’ matches all video +streams, ’V’ only matches video streams which are not attached pictures, video +thumbnails or cover arts. If additional_stream_specifier is used, then +it matches streams which both have this type and match the +additional_stream_specifier. Otherwise, it matches all streams of the +specified type. +

+
p:program_id[:additional_stream_specifier]
+

Matches streams which are in the program with the id program_id. If +additional_stream_specifier is used, then it matches streams which both +are part of the program and match the additional_stream_specifier. +

+
+
#stream_id or i:stream_id
+

Match the stream by stream id (e.g. PID in MPEG-TS container). +

+
m:key[:value]
+

Matches streams with the metadata tag key having the specified value. If +value is not given, matches streams that contain the given tag with any +value. +

+
u
+

Matches streams with usable configuration, the codec must be defined and the +essential information such as video dimension or audio sample rate must be present. +

+

Note that in ffmpeg, matching by metadata will only work properly for +input files. +

+
+ + +

3.2 Generic options

+ +

These options are shared amongst the ff* tools. +

+
+
-L
+

Show license. +

+
+
-h, -?, -help, --help [arg]
+

Show help. An optional parameter may be specified to print help about a specific +item. If no argument is specified, only basic (non advanced) tool +options are shown. +

+

Possible values of arg are: +

+
long
+

Print advanced tool options in addition to the basic tool options. +

+
+
full
+

Print complete list of options, including shared and private options +for encoders, decoders, demuxers, muxers, filters, etc. +

+
+
decoder=decoder_name
+

Print detailed information about the decoder named decoder_name. Use the +-decoders option to get a list of all decoders. +

+
+
encoder=encoder_name
+

Print detailed information about the encoder named encoder_name. Use the +-encoders option to get a list of all encoders. +

+
+
demuxer=demuxer_name
+

Print detailed information about the demuxer named demuxer_name. Use the +-formats option to get a list of all demuxers and muxers. +

+
+
muxer=muxer_name
+

Print detailed information about the muxer named muxer_name. Use the +-formats option to get a list of all muxers and demuxers. +

+
+
filter=filter_name
+

Print detailed information about the filter name filter_name. Use the +-filters option to get a list of all filters. +

+
+
bsf=bitstream_filter_name
+

Print detailed information about the bitstream filter name bitstream_filter_name. +Use the -bsfs option to get a list of all bitstream filters. +

+
+ +
+
-version
+

Show version. +

+
+
-formats
+

Show available formats (including devices). +

+
+
-demuxers
+

Show available demuxers. +

+
+
-muxers
+

Show available muxers. +

+
+
-devices
+

Show available devices. +

+
+
-codecs
+

Show all codecs known to libavcodec. +

+

Note that the term ’codec’ is used throughout this documentation as a shortcut +for what is more correctly called a media bitstream format. +

+
+
-decoders
+

Show available decoders. +

+
+
-encoders
+

Show all available encoders. +

+
+
-bsfs
+

Show available bitstream filters. +

+
+
-protocols
+

Show available protocols. +

+
+
-filters
+

Show available libavfilter filters. +

+
+
-pix_fmts
+

Show available pixel formats. +

+
+
-sample_fmts
+

Show available sample formats. +

+
+
-layouts
+

Show channel names and standard channel layouts. +

+
+
-colors
+

Show recognized color names. +

+
+
-sources device[,opt1=val1[,opt2=val2]...]
+

Show autodetected sources of the input device. +Some devices may provide system-dependent source names that cannot be autodetected. +The returned list cannot be assumed to be always complete. +

+
ffmpeg -sources pulse,server=192.168.0.4
+
+ +
+
-sinks device[,opt1=val1[,opt2=val2]...]
+

Show autodetected sinks of the output device. +Some devices may provide system-dependent sink names that cannot be autodetected. +The returned list cannot be assumed to be always complete. +

+
ffmpeg -sinks pulse,server=192.168.0.4
+
+ +
+
-loglevel [flags+]loglevel | -v [flags+]loglevel
+

Set logging level and flags used by the library. +

+

The optional flags prefix can consist of the following values: +

+
‘repeat’
+

Indicates that repeated log output should not be compressed to the first line +and the "Last message repeated n times" line will be omitted. +

+
‘level’
+

Indicates that log output should add a [level] prefix to each message +line. This can be used as an alternative to log coloring, e.g. when dumping the +log to file. +

+
+

Flags can also be used alone by adding a ’+’/’-’ prefix to set/reset a single +flag without affecting other flags or changing loglevel. When +setting both flags and loglevel, a ’+’ separator is expected +between the last flags value and before loglevel. +

+

loglevel is a string or a number containing one of the following values: +

+
‘quiet, -8’
+

Show nothing at all; be silent. +

+
‘panic, 0’
+

Only show fatal errors which could lead the process to crash, such as +an assertion failure. This is not currently used for anything. +

+
‘fatal, 8’
+

Only show fatal errors. These are errors after which the process absolutely +cannot continue. +

+
‘error, 16’
+

Show all errors, including ones which can be recovered from. +

+
‘warning, 24’
+

Show all warnings and errors. Any message related to possibly +incorrect or unexpected events will be shown. +

+
‘info, 32’
+

Show informative messages during processing. This is in addition to +warnings and errors. This is the default value. +

+
‘verbose, 40’
+

Same as info, except more verbose. +

+
‘debug, 48’
+

Show everything, including debugging information. +

+
‘trace, 56’
+
+ +

For example to enable repeated log output, add the level prefix, and set +loglevel to verbose: +

+
ffmpeg -loglevel repeat+level+verbose -i input output
+
+

Another example that enables repeated log output without affecting current +state of level prefix flag or loglevel: +

+
ffmpeg [...] -loglevel +repeat
+
+ +

By default the program logs to stderr. If coloring is supported by the +terminal, colors are used to mark errors and warnings. Log coloring +can be disabled setting the environment variable +AV_LOG_FORCE_NOCOLOR, or can be forced setting +the environment variable AV_LOG_FORCE_COLOR. +

+
+
-report
+

Dump full command line and log output to a file named +program-YYYYMMDD-HHMMSS.log in the current +directory. +This file can be useful for bug reports. +It also implies -loglevel debug. +

+

Setting the environment variable FFREPORT to any value has the +same effect. If the value is a ’:’-separated key=value sequence, these +options will affect the report; option values must be escaped if they +contain special characters or the options delimiter ’:’ (see the +“Quoting and escaping” section in the ffmpeg-utils manual). +

+

The following options are recognized: +

+
file
+

set the file name to use for the report; %p is expanded to the name +of the program, %t is expanded to a timestamp, %% is expanded +to a plain % +

+
level
+

set the log verbosity level using a numerical value (see -loglevel). +

+
+ +

For example, to output a report to a file named ffreport.log +using a log level of 32 (alias for log level info): +

+
+
FFREPORT=file=ffreport.log:level=32 ffmpeg -i input output
+
+ +

Errors in parsing the environment variable are not fatal, and will not +appear in the report. +

+
+
-hide_banner
+

Suppress printing banner. +

+

All FFmpeg tools will normally show a copyright notice, build options +and library versions. This option can be used to suppress printing +this information. +

+
+
-cpuflags flags (global)
+

Allows setting and clearing cpu flags. This option is intended +for testing. Do not use it unless you know what you’re doing. +

+
ffmpeg -cpuflags -sse+mmx ...
+ffmpeg -cpuflags mmx ...
+ffmpeg -cpuflags 0 ...
+
+

Possible flags for this option are: +

+
‘x86’
+
+
‘mmx’
+
‘mmxext’
+
‘sse’
+
‘sse2’
+
‘sse2slow’
+
‘sse3’
+
‘sse3slow’
+
‘ssse3’
+
‘atom’
+
‘sse4.1’
+
‘sse4.2’
+
‘avx’
+
‘avx2’
+
‘xop’
+
‘fma3’
+
‘fma4’
+
‘3dnow’
+
‘3dnowext’
+
‘bmi1’
+
‘bmi2’
+
‘cmov’
+
+
+
‘ARM’
+
+
‘armv5te’
+
‘armv6’
+
‘armv6t2’
+
‘vfp’
+
‘vfpv3’
+
‘neon’
+
‘setend’
+
+
+
‘AArch64’
+
+
‘armv8’
+
‘vfp’
+
‘neon’
+
+
+
‘PowerPC’
+
+
‘altivec’
+
+
+
‘Specific Processors’
+
+
‘pentium2’
+
‘pentium3’
+
‘pentium4’
+
‘k6’
+
‘k62’
+
‘athlon’
+
‘athlonxp’
+
‘k8’
+
+
+
+
+
+ + +

3.3 AVOptions

+ +

These options are provided directly by the libavformat, libavdevice and +libavcodec libraries. To see the list of available AVOptions, use the +-help option. They are separated into two categories: +

+
generic
+

These options can be set for any container, codec or device. Generic options +are listed under AVFormatContext options for containers/devices and under +AVCodecContext options for codecs. +

+
private
+

These options are specific to the given container, device or codec. Private +options are listed under their corresponding containers/devices/codecs. +

+
+ +

For example to write an ID3v2.3 header instead of a default ID3v2.4 to +an MP3 file, use the id3v2_version private option of the MP3 +muxer: +

+
ffmpeg -i input.flac -id3v2_version 3 out.mp3
+
+ +

All codec AVOptions are per-stream, and thus a stream specifier +should be attached to them: +

+
ffmpeg -i multichannel.mxf -map 0:v:0 -map 0:a:0 -map 0:a:0 -c:a:0 ac3 -b:a:0 640k -ac:a:1 2 -c:a:1 aac -b:2 128k out.mp4
+
+ +

In the above example, a multichannel audio stream is mapped twice for output. +The first instance is encoded with codec ac3 and bitrate 640k. +The second instance is downmixed to 2 channels and encoded with codec aac. A bitrate of 128k is specified for it using +absolute index of the output stream. +

+

Note: the -nooption syntax cannot be used for boolean +AVOptions, use -option 0/-option 1. +

+

Note: the old undocumented way of specifying per-stream AVOptions by +prepending v/a/s to the options name is now obsolete and will be +removed soon. +

+ +

3.4 Main options

+ +
+
-x width
+

Force displayed width. +

+
-y height
+

Force displayed height. +

+
-s size
+

Set frame size (WxH or abbreviation), needed for videos which do +not contain a header with the frame size like raw YUV. This option +has been deprecated in favor of private options, try -video_size. +

+
-fs
+

Start in fullscreen mode. +

+
-an
+

Disable audio. +

+
-vn
+

Disable video. +

+
-sn
+

Disable subtitles. +

+
-ss pos
+

Seek to pos. Note that in most formats it is not possible to seek +exactly, so ffplay will seek to the nearest seek point to +pos. +

+

pos must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+
-t duration
+

Play duration seconds of audio/video. +

+

duration must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+
-bytes
+

Seek by bytes. +

+
-seek_interval
+

Set custom interval, in seconds, for seeking using left/right keys. Default is 10 seconds. +

+
-nodisp
+

Disable graphical display. +

+
-noborder
+

Borderless window. +

+
-alwaysontop
+

Window always on top. Available on: X11 with SDL >= 2.0.5, Windows SDL >= 2.0.6. +

+
-volume
+

Set the startup volume. 0 means silence, 100 means no volume reduction or +amplification. Negative values are treated as 0, values above 100 are treated +as 100. +

+
-f fmt
+

Force format. +

+
-window_title title
+

Set window title (default is the input filename). +

+
-left title
+

Set the x position for the left of the window (default is a centered window). +

+
-top title
+

Set the y position for the top of the window (default is a centered window). +

+
-loop number
+

Loops movie playback <number> times. 0 means forever. +

+
-showmode mode
+

Set the show mode to use. +Available values for mode are: +

+
‘0, video’
+

show video +

+
‘1, waves’
+

show audio waves +

+
‘2, rdft’
+

show audio frequency band using RDFT ((Inverse) Real Discrete Fourier Transform) +

+
+ +

Default value is "video", if video is not present or cannot be played +"rdft" is automatically selected. +

+

You can interactively cycle through the available show modes by +pressing the key w. +

+
+
-vf filtergraph
+

Create the filtergraph specified by filtergraph and use it to +filter the video stream. +

+

filtergraph is a description of the filtergraph to apply to +the stream, and must have a single video input and a single video +output. In the filtergraph, the input is associated to the label +in, and the output to the label out. See the +ffmpeg-filters manual for more information about the filtergraph +syntax. +

+

You can specify this parameter multiple times and cycle through the specified +filtergraphs along with the show modes by pressing the key w. +

+
+
-af filtergraph
+

filtergraph is a description of the filtergraph to apply to +the input audio. +Use the option "-filters" to show all the available filters (including +sources and sinks). +

+
+
-i input_url
+

Read input_url. +

+
+ + +

3.5 Advanced options

+
+
-pix_fmt format
+

Set pixel format. +This option has been deprecated in favor of private options, try -pixel_format. +

+
+
-stats
+

Print several playback statistics, in particular show the stream +duration, the codec parameters, the current position in the stream and +the audio/video synchronisation drift. It is shown by default, unless the +log level is lower than info. Its display can be forced by manually +specifying this option. To disable it, you need to specify -nostats. +

+
+
-fast
+

Non-spec-compliant optimizations. +

+
-genpts
+

Generate pts. +

+
-sync type
+

Set the master clock to audio (type=audio), video +(type=video) or external (type=ext). Default is audio. The +master clock is used to control audio-video synchronization. Most media +players use audio as master clock, but in some cases (streaming or high +quality broadcast) it is necessary to change that. This option is mainly +used for debugging purposes. +

+
-ast audio_stream_specifier
+

Select the desired audio stream using the given stream specifier. The stream +specifiers are described in the Stream specifiers chapter. If this option +is not specified, the "best" audio stream is selected in the program of the +already selected video stream. +

+
-vst video_stream_specifier
+

Select the desired video stream using the given stream specifier. The stream +specifiers are described in the Stream specifiers chapter. If this option +is not specified, the "best" video stream is selected. +

+
-sst subtitle_stream_specifier
+

Select the desired subtitle stream using the given stream specifier. The stream +specifiers are described in the Stream specifiers chapter. If this option +is not specified, the "best" subtitle stream is selected in the program of the +already selected video or audio stream. +

+
-autoexit
+

Exit when video is done playing. +

+
-exitonkeydown
+

Exit if any key is pressed. +

+
-exitonmousedown
+

Exit if any mouse button is pressed. +

+
+
-codec:media_specifier codec_name
+

Force a specific decoder implementation for the stream identified by +media_specifier, which can assume the values a (audio), +v (video), and s subtitle. +

+
+
-acodec codec_name
+

Force a specific audio decoder. +

+
+
-vcodec codec_name
+

Force a specific video decoder. +

+
+
-scodec codec_name
+

Force a specific subtitle decoder. +

+
+
-autorotate
+

Automatically rotate the video according to file metadata. Enabled by +default, use -noautorotate to disable it. +

+
+
-framedrop
+

Drop video frames if video is out of sync. Enabled by default if the master +clock is not set to video. Use this option to enable frame dropping for all +master clock sources, use -noframedrop to disable it. +

+
+
-infbuf
+

Do not limit the input buffer size, read as much data as possible from the +input as soon as possible. Enabled by default for realtime streams, where data +may be dropped if not read in time. Use this option to enable infinite buffers +for all inputs, use -noinfbuf to disable it. +

+
+
-filter_threads nb_threads
+

Defines how many threads are used to process a filter pipeline. Each pipeline +will produce a thread pool with this many threads available for parallel +processing. The default is 0 which means that the thread count will be +determined by the number of available CPUs. +

+
+
+ + +

3.6 While playing

+ +
+
q, ESC
+

Quit. +

+
+
f
+

Toggle full screen. +

+
+
p, SPC
+

Pause. +

+
+
m
+

Toggle mute. +

+
+
9, 0
+

Decrease and increase volume respectively. +

+
+
/, *
+

Decrease and increase volume respectively. +

+
+
a
+

Cycle audio channel in the current program. +

+
+
v
+

Cycle video channel. +

+
+
t
+

Cycle subtitle channel in the current program. +

+
+
c
+

Cycle program. +

+
+
w
+

Cycle video filters or show modes. +

+
+
s
+

Step to the next frame. +

+

Pause if the stream is not already paused, step to the next video +frame, and pause. +

+
+
left/right
+

Seek backward/forward 10 seconds. +

+
+
down/up
+

Seek backward/forward 1 minute. +

+
+
page down/page up
+

Seek to the previous/next chapter. +or if there are no chapters +Seek backward/forward 10 minutes. +

+
+
right mouse click
+

Seek to percentage in file corresponding to fraction of width. +

+
+
left mouse double-click
+

Toggle full screen. +

+
+
+ + + + +

4 See Also

+ +

ffmpeg-all, +ffmpeg, ffprobe, +ffmpeg-utils, +ffmpeg-scaler, +ffmpeg-resampler, +ffmpeg-codecs, +ffmpeg-bitstream-filters, +ffmpeg-formats, +ffmpeg-devices, +ffmpeg-protocols, +ffmpeg-filters +

+ + +

5 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffprobe-all.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffprobe-all.html new file mode 100644 index 0000000..8d8636b --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffprobe-all.html @@ -0,0 +1,41420 @@ + + + + + + + ffprobe Documentation + + + + + + +
+

+ ffprobe Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Synopsis

+ +

ffprobe [options] [input_url] +

+ +

2 Description

+ +

ffprobe gathers information from multimedia streams and prints it in +human- and machine-readable fashion. +

+

For example it can be used to check the format of the container used +by a multimedia stream and the format and type of each media stream +contained in it. +

+

If a url is specified in input, ffprobe will try to open and +probe the url content. If the url cannot be opened or recognized as +a multimedia file, a positive exit code is returned. +

+

ffprobe may be employed both as a standalone application or in +combination with a textual filter, which may perform more +sophisticated processing, e.g. statistical processing or plotting. +

+

Options are used to list some of the formats supported by ffprobe or +for specifying which information to display, and for setting how +ffprobe will show it. +

+

ffprobe output is designed to be easily parsable by a textual filter, +and consists of one or more sections of a form defined by the selected +writer, which is specified by the print_format option. +

+

Sections may contain other nested sections, and are identified by a +name (which may be shared by other sections), and an unique +name. See the output of sections. +

+

Metadata tags stored in the container or in the streams are recognized +and printed in the corresponding "FORMAT", "STREAM" or "PROGRAM_STREAM" +section. +

+ + +

3 Options

+ +

All the numerical options, if not specified otherwise, accept a string +representing a number as input, which may be followed by one of the SI +unit prefixes, for example: ’K’, ’M’, or ’G’. +

+

If ’i’ is appended to the SI unit prefix, the complete prefix will be +interpreted as a unit prefix for binary multiples, which are based on +powers of 1024 instead of powers of 1000. Appending ’B’ to the SI unit +prefix multiplies the value by 8. This allows using, for example: +’KB’, ’MiB’, ’G’ and ’B’ as number suffixes. +

+

Options which do not take arguments are boolean options, and set the +corresponding value to true. They can be set to false by prefixing +the option name with "no". For example using "-nofoo" +will set the boolean option with name "foo" to false. +

+ +

3.1 Stream specifiers

+

Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers +are used to precisely specify which stream(s) a given option belongs to. +

+

A stream specifier is a string generally appended to the option name and +separated from it by a colon. E.g. -codec:a:1 ac3 contains the +a:1 stream specifier, which matches the second audio stream. Therefore, it +would select the ac3 codec for the second audio stream. +

+

A stream specifier can match several streams, so that the option is applied to all +of them. E.g. the stream specifier in -b:a 128k matches all audio +streams. +

+

An empty stream specifier matches all streams. For example, -codec copy +or -codec: copy would copy all the streams without reencoding. +

+

Possible forms of stream specifiers are: +

+
stream_index
+

Matches the stream with this index. E.g. -threads:1 4 would set the +thread count for the second stream to 4. If stream_index is used as an +additional stream specifier (see below), then it selects stream number +stream_index from the matching streams. Stream numbering is based on the +order of the streams as detected by libavformat except when a program ID is +also specified. In this case it is based on the ordering of the streams in the +program. +

+
stream_type[:additional_stream_specifier]
+

stream_type is one of following: ’v’ or ’V’ for video, ’a’ for audio, ’s’ +for subtitle, ’d’ for data, and ’t’ for attachments. ’v’ matches all video +streams, ’V’ only matches video streams which are not attached pictures, video +thumbnails or cover arts. If additional_stream_specifier is used, then +it matches streams which both have this type and match the +additional_stream_specifier. Otherwise, it matches all streams of the +specified type. +

+
p:program_id[:additional_stream_specifier]
+

Matches streams which are in the program with the id program_id. If +additional_stream_specifier is used, then it matches streams which both +are part of the program and match the additional_stream_specifier. +

+
+
#stream_id or i:stream_id
+

Match the stream by stream id (e.g. PID in MPEG-TS container). +

+
m:key[:value]
+

Matches streams with the metadata tag key having the specified value. If +value is not given, matches streams that contain the given tag with any +value. +

+
u
+

Matches streams with usable configuration, the codec must be defined and the +essential information such as video dimension or audio sample rate must be present. +

+

Note that in ffmpeg, matching by metadata will only work properly for +input files. +

+
+ + +

3.2 Generic options

+ +

These options are shared amongst the ff* tools. +

+
+
-L
+

Show license. +

+
+
-h, -?, -help, --help [arg]
+

Show help. An optional parameter may be specified to print help about a specific +item. If no argument is specified, only basic (non advanced) tool +options are shown. +

+

Possible values of arg are: +

+
long
+

Print advanced tool options in addition to the basic tool options. +

+
+
full
+

Print complete list of options, including shared and private options +for encoders, decoders, demuxers, muxers, filters, etc. +

+
+
decoder=decoder_name
+

Print detailed information about the decoder named decoder_name. Use the +-decoders option to get a list of all decoders. +

+
+
encoder=encoder_name
+

Print detailed information about the encoder named encoder_name. Use the +-encoders option to get a list of all encoders. +

+
+
demuxer=demuxer_name
+

Print detailed information about the demuxer named demuxer_name. Use the +-formats option to get a list of all demuxers and muxers. +

+
+
muxer=muxer_name
+

Print detailed information about the muxer named muxer_name. Use the +-formats option to get a list of all muxers and demuxers. +

+
+
filter=filter_name
+

Print detailed information about the filter name filter_name. Use the +-filters option to get a list of all filters. +

+
+
bsf=bitstream_filter_name
+

Print detailed information about the bitstream filter name bitstream_filter_name. +Use the -bsfs option to get a list of all bitstream filters. +

+
+ +
+
-version
+

Show version. +

+
+
-formats
+

Show available formats (including devices). +

+
+
-demuxers
+

Show available demuxers. +

+
+
-muxers
+

Show available muxers. +

+
+
-devices
+

Show available devices. +

+
+
-codecs
+

Show all codecs known to libavcodec. +

+

Note that the term ’codec’ is used throughout this documentation as a shortcut +for what is more correctly called a media bitstream format. +

+
+
-decoders
+

Show available decoders. +

+
+
-encoders
+

Show all available encoders. +

+
+
-bsfs
+

Show available bitstream filters. +

+
+
-protocols
+

Show available protocols. +

+
+
-filters
+

Show available libavfilter filters. +

+
+
-pix_fmts
+

Show available pixel formats. +

+
+
-sample_fmts
+

Show available sample formats. +

+
+
-layouts
+

Show channel names and standard channel layouts. +

+
+
-colors
+

Show recognized color names. +

+
+
-sources device[,opt1=val1[,opt2=val2]...]
+

Show autodetected sources of the input device. +Some devices may provide system-dependent source names that cannot be autodetected. +The returned list cannot be assumed to be always complete. +

+
ffmpeg -sources pulse,server=192.168.0.4
+
+ +
+
-sinks device[,opt1=val1[,opt2=val2]...]
+

Show autodetected sinks of the output device. +Some devices may provide system-dependent sink names that cannot be autodetected. +The returned list cannot be assumed to be always complete. +

+
ffmpeg -sinks pulse,server=192.168.0.4
+
+ +
+
-loglevel [flags+]loglevel | -v [flags+]loglevel
+

Set logging level and flags used by the library. +

+

The optional flags prefix can consist of the following values: +

+
‘repeat’
+

Indicates that repeated log output should not be compressed to the first line +and the "Last message repeated n times" line will be omitted. +

+
‘level’
+

Indicates that log output should add a [level] prefix to each message +line. This can be used as an alternative to log coloring, e.g. when dumping the +log to file. +

+
+

Flags can also be used alone by adding a ’+’/’-’ prefix to set/reset a single +flag without affecting other flags or changing loglevel. When +setting both flags and loglevel, a ’+’ separator is expected +between the last flags value and before loglevel. +

+

loglevel is a string or a number containing one of the following values: +

+
‘quiet, -8’
+

Show nothing at all; be silent. +

+
‘panic, 0’
+

Only show fatal errors which could lead the process to crash, such as +an assertion failure. This is not currently used for anything. +

+
‘fatal, 8’
+

Only show fatal errors. These are errors after which the process absolutely +cannot continue. +

+
‘error, 16’
+

Show all errors, including ones which can be recovered from. +

+
‘warning, 24’
+

Show all warnings and errors. Any message related to possibly +incorrect or unexpected events will be shown. +

+
‘info, 32’
+

Show informative messages during processing. This is in addition to +warnings and errors. This is the default value. +

+
‘verbose, 40’
+

Same as info, except more verbose. +

+
‘debug, 48’
+

Show everything, including debugging information. +

+
‘trace, 56’
+
+ +

For example to enable repeated log output, add the level prefix, and set +loglevel to verbose: +

+
ffmpeg -loglevel repeat+level+verbose -i input output
+
+

Another example that enables repeated log output without affecting current +state of level prefix flag or loglevel: +

+
ffmpeg [...] -loglevel +repeat
+
+ +

By default the program logs to stderr. If coloring is supported by the +terminal, colors are used to mark errors and warnings. Log coloring +can be disabled setting the environment variable +AV_LOG_FORCE_NOCOLOR, or can be forced setting +the environment variable AV_LOG_FORCE_COLOR. +

+
+
-report
+

Dump full command line and log output to a file named +program-YYYYMMDD-HHMMSS.log in the current +directory. +This file can be useful for bug reports. +It also implies -loglevel debug. +

+

Setting the environment variable FFREPORT to any value has the +same effect. If the value is a ’:’-separated key=value sequence, these +options will affect the report; option values must be escaped if they +contain special characters or the options delimiter ’:’ (see the +“Quoting and escaping” section in the ffmpeg-utils manual). +

+

The following options are recognized: +

+
file
+

set the file name to use for the report; %p is expanded to the name +of the program, %t is expanded to a timestamp, %% is expanded +to a plain % +

+
level
+

set the log verbosity level using a numerical value (see -loglevel). +

+
+ +

For example, to output a report to a file named ffreport.log +using a log level of 32 (alias for log level info): +

+
+
FFREPORT=file=ffreport.log:level=32 ffmpeg -i input output
+
+ +

Errors in parsing the environment variable are not fatal, and will not +appear in the report. +

+
+
-hide_banner
+

Suppress printing banner. +

+

All FFmpeg tools will normally show a copyright notice, build options +and library versions. This option can be used to suppress printing +this information. +

+
+
-cpuflags flags (global)
+

Allows setting and clearing cpu flags. This option is intended +for testing. Do not use it unless you know what you’re doing. +

+
ffmpeg -cpuflags -sse+mmx ...
+ffmpeg -cpuflags mmx ...
+ffmpeg -cpuflags 0 ...
+
+

Possible flags for this option are: +

+
‘x86’
+
+
‘mmx’
+
‘mmxext’
+
‘sse’
+
‘sse2’
+
‘sse2slow’
+
‘sse3’
+
‘sse3slow’
+
‘ssse3’
+
‘atom’
+
‘sse4.1’
+
‘sse4.2’
+
‘avx’
+
‘avx2’
+
‘xop’
+
‘fma3’
+
‘fma4’
+
‘3dnow’
+
‘3dnowext’
+
‘bmi1’
+
‘bmi2’
+
‘cmov’
+
+
+
‘ARM’
+
+
‘armv5te’
+
‘armv6’
+
‘armv6t2’
+
‘vfp’
+
‘vfpv3’
+
‘neon’
+
‘setend’
+
+
+
‘AArch64’
+
+
‘armv8’
+
‘vfp’
+
‘neon’
+
+
+
‘PowerPC’
+
+
‘altivec’
+
+
+
‘Specific Processors’
+
+
‘pentium2’
+
‘pentium3’
+
‘pentium4’
+
‘k6’
+
‘k62’
+
‘athlon’
+
‘athlonxp’
+
‘k8’
+
+
+
+
+
+ + +

3.3 AVOptions

+ +

These options are provided directly by the libavformat, libavdevice and +libavcodec libraries. To see the list of available AVOptions, use the +-help option. They are separated into two categories: +

+
generic
+

These options can be set for any container, codec or device. Generic options +are listed under AVFormatContext options for containers/devices and under +AVCodecContext options for codecs. +

+
private
+

These options are specific to the given container, device or codec. Private +options are listed under their corresponding containers/devices/codecs. +

+
+ +

For example to write an ID3v2.3 header instead of a default ID3v2.4 to +an MP3 file, use the id3v2_version private option of the MP3 +muxer: +

+
ffmpeg -i input.flac -id3v2_version 3 out.mp3
+
+ +

All codec AVOptions are per-stream, and thus a stream specifier +should be attached to them: +

+
ffmpeg -i multichannel.mxf -map 0:v:0 -map 0:a:0 -map 0:a:0 -c:a:0 ac3 -b:a:0 640k -ac:a:1 2 -c:a:1 aac -b:2 128k out.mp4
+
+ +

In the above example, a multichannel audio stream is mapped twice for output. +The first instance is encoded with codec ac3 and bitrate 640k. +The second instance is downmixed to 2 channels and encoded with codec aac. A bitrate of 128k is specified for it using +absolute index of the output stream. +

+

Note: the -nooption syntax cannot be used for boolean +AVOptions, use -option 0/-option 1. +

+

Note: the old undocumented way of specifying per-stream AVOptions by +prepending v/a/s to the options name is now obsolete and will be +removed soon. +

+ +

3.4 Main options

+ +
+
-f format
+

Force format to use. +

+
+
-unit
+

Show the unit of the displayed values. +

+
+
-prefix
+

Use SI prefixes for the displayed values. +Unless the "-byte_binary_prefix" option is used all the prefixes +are decimal. +

+
+
-byte_binary_prefix
+

Force the use of binary prefixes for byte values. +

+
+
-sexagesimal
+

Use sexagesimal format HH:MM:SS.MICROSECONDS for time values. +

+
+
-pretty
+

Prettify the format of the displayed values, it corresponds to the +options "-unit -prefix -byte_binary_prefix -sexagesimal". +

+
+
-of, -print_format writer_name[=writer_options]
+

Set the output printing format. +

+

writer_name specifies the name of the writer, and +writer_options specifies the options to be passed to the writer. +

+

For example for printing the output in JSON format, specify: +

+
-print_format json
+
+ +

For more details on the available output printing formats, see the +Writers section below. +

+
+
-sections
+

Print sections structure and section information, and exit. The output +is not meant to be parsed by a machine. +

+
+
-select_streams stream_specifier
+

Select only the streams specified by stream_specifier. This +option affects only the options related to streams +(e.g. show_streams, show_packets, etc.). +

+

For example to show only audio streams, you can use the command: +

+
ffprobe -show_streams -select_streams a INPUT
+
+ +

To show only video packets belonging to the video stream with index 1: +

+
ffprobe -show_packets -select_streams v:1 INPUT
+
+ +
+
-show_data
+

Show payload data, as a hexadecimal and ASCII dump. Coupled with +-show_packets, it will dump the packets’ data. Coupled with +-show_streams, it will dump the codec extradata. +

+

The dump is printed as the "data" field. It may contain newlines. +

+
+
-show_data_hash algorithm
+

Show a hash of payload data, for packets with -show_packets and for +codec extradata with -show_streams. +

+
+
-show_error
+

Show information about the error found when trying to probe the input. +

+

The error information is printed within a section with name "ERROR". +

+
+
-show_format
+

Show information about the container format of the input multimedia +stream. +

+

All the container format information is printed within a section with +name "FORMAT". +

+
+
-show_format_entry name
+

Like -show_format, but only prints the specified entry of the +container format information, rather than all. This option may be given more +than once, then all specified entries will be shown. +

+

This option is deprecated, use show_entries instead. +

+
+
-show_entries section_entries
+

Set list of entries to show. +

+

Entries are specified according to the following +syntax. section_entries contains a list of section entries +separated by :. Each section entry is composed by a section +name (or unique name), optionally followed by a list of entries local +to that section, separated by ,. +

+

If section name is specified but is followed by no =, all +entries are printed to output, together with all the contained +sections. Otherwise only the entries specified in the local section +entries list are printed. In particular, if = is specified but +the list of local entries is empty, then no entries will be shown for +that section. +

+

Note that the order of specification of the local section entries is +not honored in the output, and the usual display order will be +retained. +

+

The formal syntax is given by: +

+
LOCAL_SECTION_ENTRIES ::= SECTION_ENTRY_NAME[,LOCAL_SECTION_ENTRIES]
+SECTION_ENTRY         ::= SECTION_NAME[=[LOCAL_SECTION_ENTRIES]]
+SECTION_ENTRIES       ::= SECTION_ENTRY[:SECTION_ENTRIES]
+
+ +

For example, to show only the index and type of each stream, and the PTS +time, duration time, and stream index of the packets, you can specify +the argument: +

+
packet=pts_time,duration_time,stream_index : stream=index,codec_type
+
+ +

To show all the entries in the section "format", but only the codec +type in the section "stream", specify the argument: +

+
format : stream=codec_type
+
+ +

To show all the tags in the stream and format sections: +

+
stream_tags : format_tags
+
+ +

To show only the title tag (if available) in the stream +sections: +

+
stream_tags=title
+
+ +
+
-show_packets
+

Show information about each packet contained in the input multimedia +stream. +

+

The information for each single packet is printed within a dedicated +section with name "PACKET". +

+
+
-show_frames
+

Show information about each frame and subtitle contained in the input +multimedia stream. +

+

The information for each single frame is printed within a dedicated +section with name "FRAME" or "SUBTITLE". +

+
+
-show_log loglevel
+

Show logging information from the decoder about each frame according to +the value set in loglevel, (see -loglevel). This option requires -show_frames. +

+

The information for each log message is printed within a dedicated +section with name "LOG". +

+
+
-show_streams
+

Show information about each media stream contained in the input +multimedia stream. +

+

Each media stream information is printed within a dedicated section +with name "STREAM". +

+
+
-show_programs
+

Show information about programs and their streams contained in the input +multimedia stream. +

+

Each media stream information is printed within a dedicated section +with name "PROGRAM_STREAM". +

+
+
-show_chapters
+

Show information about chapters stored in the format. +

+

Each chapter is printed within a dedicated section with name "CHAPTER". +

+
+
-count_frames
+

Count the number of frames per stream and report it in the +corresponding stream section. +

+
+
-count_packets
+

Count the number of packets per stream and report it in the +corresponding stream section. +

+
+
-read_intervals read_intervals
+
+

Read only the specified intervals. read_intervals must be a +sequence of interval specifications separated by ",". +ffprobe will seek to the interval starting point, and will +continue reading from that. +

+

Each interval is specified by two optional parts, separated by "%". +

+

The first part specifies the interval start position. It is +interpreted as an absolute position, or as a relative offset from the +current position if it is preceded by the "+" character. If this first +part is not specified, no seeking will be performed when reading this +interval. +

+

The second part specifies the interval end position. It is interpreted +as an absolute position, or as a relative offset from the current +position if it is preceded by the "+" character. If the offset +specification starts with "#", it is interpreted as the number of +packets to read (not including the flushing packets) from the interval +start. If no second part is specified, the program will read until the +end of the input. +

+

Note that seeking is not accurate, thus the actual interval start +point may be different from the specified position. Also, when an +interval duration is specified, the absolute end time will be computed +by adding the duration to the interval start point found by seeking +the file, rather than to the specified start value. +

+

The formal syntax is given by: +

+
INTERVAL  ::= [START|+START_OFFSET][%[END|+END_OFFSET]]
+INTERVALS ::= INTERVAL[,INTERVALS]
+
+ +

A few examples follow. +

    +
  • Seek to time 10, read packets until 20 seconds after the found seek +point, then seek to position 01:30 (1 minute and thirty +seconds) and read packets until position 01:45. +
    +
    10%+20,01:30%01:45
+
    + +
  • Read only 42 packets after seeking to position 01:23: +
    +
    01:23%+#42
+
    + +
  • Read only the first 20 seconds from the start: +
    +
    %+20
+
    + +
  • Read from the start until position 02:30: +
    +
    %02:30
+
    +
+ +
+
-show_private_data, -private
+

Show private data, that is data depending on the format of the +particular shown element. +This option is enabled by default, but you may need to disable it +for specific uses, for example when creating XSD-compliant XML output. +

+
+
-show_program_version
+

Show information related to program version. +

+

Version information is printed within a section with name +"PROGRAM_VERSION". +

+
+
-show_library_versions
+

Show information related to library versions. +

+

Version information for each library is printed within a section with +name "LIBRARY_VERSION". +

+
+
-show_versions
+

Show information related to program and library versions. This is the +equivalent of setting both -show_program_version and +-show_library_versions options. +

+
+
-show_pixel_formats
+

Show information about all pixel formats supported by FFmpeg. +

+

Pixel format information for each format is printed within a section +with name "PIXEL_FORMAT". +

+
+
-bitexact
+

Force bitexact output, useful to produce output which is not dependent +on the specific build. +

+
+
-i input_url
+

Read input_url. +

+
+
+ + +

4 Writers

+ +

A writer defines the output format adopted by ffprobe, and will be +used for printing all the parts of the output. +

+

A writer may accept one or more arguments, which specify the options +to adopt. The options are specified as a list of key=value +pairs, separated by ":". +

+

All writers support the following options: +

+
+
string_validation, sv
+

Set string validation mode. +

+

The following values are accepted. +

+
‘fail’
+

The writer will fail immediately in case an invalid string (UTF-8) +sequence or code point is found in the input. This is especially +useful to validate input metadata. +

+
+
‘ignore’
+

Any validation error will be ignored. This will result in possibly +broken output, especially with the json or xml writer. +

+
+
‘replace’
+

The writer will substitute invalid UTF-8 sequences or code points with +the string specified with the string_validation_replacement. +

+
+ +

Default value is ‘replace’. +

+
+
string_validation_replacement, svr
+

Set replacement string to use in case string_validation is +set to ‘replace’. +

+

In case the option is not specified, the writer will assume the empty +string, that is it will remove the invalid sequences from the input +strings. +

+
+ +

A description of the currently available writers follows. +

+ +

4.1 default

+

Default format. +

+

Print each section in the form: +

+
[SECTION]
+key1=val1
+...
+keyN=valN
+[/SECTION]
+
+ +

Metadata tags are printed as a line in the corresponding FORMAT, STREAM or +PROGRAM_STREAM section, and are prefixed by the string "TAG:". +

+

A description of the accepted options follows. +

+
+
nokey, nk
+

If set to 1 specify not to print the key of each field. Default value +is 0. +

+
+
noprint_wrappers, nw
+

If set to 1 specify not to print the section header and footer. +Default value is 0. +

+
+ + +

4.2 compact, csv

+

Compact and CSV format. +

+

The csv writer is equivalent to compact, but supports +different defaults. +

+

Each section is printed on a single line. +If no option is specified, the output has the form: +

+
section|key1=val1| ... |keyN=valN
+
+ +

Metadata tags are printed in the corresponding "format" or "stream" +section. A metadata tag key, if printed, is prefixed by the string +"tag:". +

+

The description of the accepted options follows. +

+
+
item_sep, s
+

Specify the character to use for separating fields in the output line. +It must be a single printable character, it is "|" by default ("," for +the csv writer). +

+
+
nokey, nk
+

If set to 1 specify not to print the key of each field. Its default +value is 0 (1 for the csv writer). +

+
+
escape, e
+

Set the escape mode to use, default to "c" ("csv" for the csv +writer). +

+

It can assume one of the following values: +

+
c
+

Perform C-like escaping. Strings containing a newline (‘\n’), carriage +return (‘\r’), a tab (‘\t’), a form feed (‘\f’), the escaping +character (‘\’) or the item separator character SEP are escaped +using C-like fashioned escaping, so that a newline is converted to the +sequence ‘\n’, a carriage return to ‘\r’, ‘\’ to ‘\\’ and +the separator SEP is converted to ‘\SEP’. +

+
+
csv
+

Perform CSV-like escaping, as described in RFC4180. Strings +containing a newline (‘\n’), a carriage return (‘\r’), a double quote +(‘"’), or SEP are enclosed in double-quotes. +

+
+
none
+

Perform no escaping. +

+
+ +
+
print_section, p
+

Print the section name at the beginning of each line if the value is +1, disable it with value set to 0. Default value is +1. +

+
+
+ + +

4.3 flat

+

Flat format. +

+

A free-form output where each line contains an explicit key=value, such as +"streams.stream.3.tags.foo=bar". The output is shell escaped, so it can be +directly embedded in sh scripts as long as the separator character is an +alphanumeric character or an underscore (see sep_char option). +

+

The description of the accepted options follows. +

+
+
sep_char, s
+

Separator character used to separate the chapter, the section name, IDs and +potential tags in the printed field key. +

+

Default value is ‘.’. +

+
+
hierarchical, h
+

Specify if the section name specification should be hierarchical. If +set to 1, and if there is more than one section in the current +chapter, the section name will be prefixed by the name of the +chapter. A value of 0 will disable this behavior. +

+

Default value is 1. +

+
+ + +

4.4 ini

+

INI format output. +

+

Print output in an INI based format. +

+

The following conventions are adopted: +

+
    +
  • all key and values are UTF-8 +
  • ‘.’ is the subgroup separator +
  • newline, ‘\t’, ‘\f’, ‘\b’ and the following characters are +escaped +
  • ‘\’ is the escape character +
  • ‘#’ is the comment indicator +
  • ‘=’ is the key/value separator +
  • ‘:’ is not used but usually parsed as key/value separator +
+ +

This writer accepts options as a list of key=value pairs, +separated by ‘:’. +

+

The description of the accepted options follows. +

+
+
hierarchical, h
+

Specify if the section name specification should be hierarchical. If +set to 1, and if there is more than one section in the current +chapter, the section name will be prefixed by the name of the +chapter. A value of 0 will disable this behavior. +

+

Default value is 1. +

+
+ + +

4.5 json

+

JSON based format. +

+

Each section is printed using JSON notation. +

+

The description of the accepted options follows. +

+
+
compact, c
+

If set to 1 enable compact output, that is each section will be +printed on a single line. Default value is 0. +

+
+ +

For more information about JSON, see http://www.json.org/. +

+ +

4.6 xml

+

XML based format. +

+

The XML output is described in the XML schema description file +ffprobe.xsd installed in the FFmpeg datadir. +

+

An updated version of the schema can be retrieved at the url +http://www.ffmpeg.org/schema/ffprobe.xsd, which redirects to the +latest schema committed into the FFmpeg development source code tree. +

+

Note that the output issued will be compliant to the +ffprobe.xsd schema only when no special global output options +(unit, prefix, byte_binary_prefix, +sexagesimal etc.) are specified. +

+

The description of the accepted options follows. +

+
+
fully_qualified, q
+

If set to 1 specify if the output should be fully qualified. Default +value is 0. +This is required for generating an XML file which can be validated +through an XSD file. +

+
+
xsd_strict, x
+

If set to 1 perform more checks for ensuring that the output is XSD +compliant. Default value is 0. +This option automatically sets fully_qualified to 1. +

+
+ +

For more information about the XML format, see +https://www.w3.org/XML/. +

+ +

5 Timecode

+ +

ffprobe supports Timecode extraction: +

+
    +
  • MPEG1/2 timecode is extracted from the GOP, and is available in the video +stream details (-show_streams, see timecode). + +
  • MOV timecode is extracted from tmcd track, so is available in the tmcd +stream metadata (-show_streams, see TAG:timecode). + +
  • DV, GXF and AVI timecodes are available in format metadata +(-show_format, see TAG:timecode). + +
+ + +

6 Syntax

+ +

This section documents the syntax and formats employed by the FFmpeg +libraries and tools. +

+ +

6.1 Quoting and escaping

+ +

FFmpeg adopts the following quoting and escaping mechanism, unless +explicitly specified. The following rules are applied: +

+
    +
  • ‘'’ and ‘\’ are special characters (respectively used for +quoting and escaping). In addition to them, there might be other +special characters depending on the specific syntax where the escaping +and quoting are employed. + +
  • A special character is escaped by prefixing it with a ‘\’. + +
  • All characters enclosed between ‘''’ are included literally in the +parsed string. The quote character ‘'’ itself cannot be quoted, +so you may need to close the quote and escape it. + +
  • Leading and trailing whitespaces, unless escaped or quoted, are +removed from the parsed string. +
+ +

Note that you may need to add a second level of escaping when using +the command line or a script, which depends on the syntax of the +adopted shell language. +

+

The function av_get_token defined in +libavutil/avstring.h can be used to parse a token quoted or +escaped according to the rules defined above. +

+

The tool tools/ffescape in the FFmpeg source tree can be used +to automatically quote or escape a string in a script. +

+ +

6.1.1 Examples

+ +
    +
  • Escape the string Crime d'Amour containing the ' special +character: +
    +
    Crime d\'Amour
+
    + +
  • The string above contains a quote, so the ' needs to be escaped +when quoting it: +
    +
    'Crime d'\''Amour'
+
    + +
  • Include leading or trailing whitespaces using quoting: +
    +
    '  this string starts and ends with whitespaces  '
+
    + +
  • Escaping and quoting can be mixed together: +
    +
    ' The string '\'string\'' is a string '
+
    + +
  • To include a literal ‘\’ you can use either escaping or quoting: +
    +
    'c:\foo' can be written as c:\\foo
+
    +
+ + +

6.2 Date

+ +

The accepted syntax is: +

+
[(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH:MM:SS[.m...]]])|(HHMMSS[.m...]]]))[Z]
+now
+
+ +

If the value is "now" it takes the current time. +

+

Time is local time unless Z is appended, in which case it is +interpreted as UTC. +If the year-month-day part is not specified it takes the current +year-month-day. +

+ +

6.3 Time duration

+ +

There are two accepted syntaxes for expressing time duration. +

+
+
[-][HH:]MM:SS[.m...]
+
+ +

HH expresses the number of hours, MM the number of minutes +for a maximum of 2 digits, and SS the number of seconds for a +maximum of 2 digits. The m at the end expresses decimal value for +SS. +

+

or +

+
+
[-]S+[.m...]
+
+ +

S expresses the number of seconds, with the optional decimal part +m. +

+

In both expressions, the optional ‘-’ indicates negative duration. +

+ +

6.3.1 Examples

+ +

The following examples are all valid time duration: +

+
+
‘55’
+

55 seconds +

+
+
‘0.2’
+

0.2 seconds +

+
+
‘200ms’
+

200 milliseconds, that’s 0.2s +

+
+
‘200000us’
+

200000 microseconds, that’s 0.2s +

+
+
‘12:03:45’
+

12 hours, 03 minutes and 45 seconds +

+
+
‘23.189’
+

23.189 seconds +

+
+ + +

6.4 Video size

+

Specify the size of the sourced video, it may be a string of the form +widthxheight, or the name of a size abbreviation. +

+

The following abbreviations are recognized: +

+
‘ntsc’
+

720x480 +

+
‘pal’
+

720x576 +

+
‘qntsc’
+

352x240 +

+
‘qpal’
+

352x288 +

+
‘sntsc’
+

640x480 +

+
‘spal’
+

768x576 +

+
‘film’
+

352x240 +

+
‘ntsc-film’
+

352x240 +

+
‘sqcif’
+

128x96 +

+
‘qcif’
+

176x144 +

+
‘cif’
+

352x288 +

+
‘4cif’
+

704x576 +

+
‘16cif’
+

1408x1152 +

+
‘qqvga’
+

160x120 +

+
‘qvga’
+

320x240 +

+
‘vga’
+

640x480 +

+
‘svga’
+

800x600 +

+
‘xga’
+

1024x768 +

+
‘uxga’
+

1600x1200 +

+
‘qxga’
+

2048x1536 +

+
‘sxga’
+

1280x1024 +

+
‘qsxga’
+

2560x2048 +

+
‘hsxga’
+

5120x4096 +

+
‘wvga’
+

852x480 +

+
‘wxga’
+

1366x768 +

+
‘wsxga’
+

1600x1024 +

+
‘wuxga’
+

1920x1200 +

+
‘woxga’
+

2560x1600 +

+
‘wqsxga’
+

3200x2048 +

+
‘wquxga’
+

3840x2400 +

+
‘whsxga’
+

6400x4096 +

+
‘whuxga’
+

7680x4800 +

+
‘cga’
+

320x200 +

+
‘ega’
+

640x350 +

+
‘hd480’
+

852x480 +

+
‘hd720’
+

1280x720 +

+
‘hd1080’
+

1920x1080 +

+
‘2k’
+

2048x1080 +

+
‘2kflat’
+

1998x1080 +

+
‘2kscope’
+

2048x858 +

+
‘4k’
+

4096x2160 +

+
‘4kflat’
+

3996x2160 +

+
‘4kscope’
+

4096x1716 +

+
‘nhd’
+

640x360 +

+
‘hqvga’
+

240x160 +

+
‘wqvga’
+

400x240 +

+
‘fwqvga’
+

432x240 +

+
‘hvga’
+

480x320 +

+
‘qhd’
+

960x540 +

+
‘2kdci’
+

2048x1080 +

+
‘4kdci’
+

4096x2160 +

+
‘uhd2160’
+

3840x2160 +

+
‘uhd4320’
+

7680x4320 +

+
+ + +

6.5 Video rate

+ +

Specify the frame rate of a video, expressed as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a float +number or a valid video frame rate abbreviation. +

+

The following abbreviations are recognized: +

+
‘ntsc’
+

30000/1001 +

+
‘pal’
+

25/1 +

+
‘qntsc’
+

30000/1001 +

+
‘qpal’
+

25/1 +

+
‘sntsc’
+

30000/1001 +

+
‘spal’
+

25/1 +

+
‘film’
+

24/1 +

+
‘ntsc-film’
+

24000/1001 +

+
+ + +

6.6 Ratio

+ +

A ratio can be expressed as an expression, or in the form +numerator:denominator. +

+

Note that a ratio with infinite (1/0) or negative value is +considered valid, so you should check on the returned value if you +want to exclude those values. +

+

The undefined value can be expressed using the "0:0" string. +

+ +

6.7 Color

+ +

It can be the name of a color as defined below (case insensitive match) or a +[0x|#]RRGGBB[AA] sequence, possibly followed by @ and a string +representing the alpha component. +

+

The alpha component may be a string composed by "0x" followed by an +hexadecimal number or a decimal number between 0.0 and 1.0, which +represents the opacity value (‘0x00’ or ‘0.0’ means completely +transparent, ‘0xff’ or ‘1.0’ completely opaque). If the alpha +component is not specified then ‘0xff’ is assumed. +

+

The string ‘random’ will result in a random color. +

+

The following names of colors are recognized: +

+
‘AliceBlue’
+

0xF0F8FF +

+
‘AntiqueWhite’
+

0xFAEBD7 +

+
‘Aqua’
+

0x00FFFF +

+
‘Aquamarine’
+

0x7FFFD4 +

+
‘Azure’
+

0xF0FFFF +

+
‘Beige’
+

0xF5F5DC +

+
‘Bisque’
+

0xFFE4C4 +

+
‘Black’
+

0x000000 +

+
‘BlanchedAlmond’
+

0xFFEBCD +

+
‘Blue’
+

0x0000FF +

+
‘BlueViolet’
+

0x8A2BE2 +

+
‘Brown’
+

0xA52A2A +

+
‘BurlyWood’
+

0xDEB887 +

+
‘CadetBlue’
+

0x5F9EA0 +

+
‘Chartreuse’
+

0x7FFF00 +

+
‘Chocolate’
+

0xD2691E +

+
‘Coral’
+

0xFF7F50 +

+
‘CornflowerBlue’
+

0x6495ED +

+
‘Cornsilk’
+

0xFFF8DC +

+
‘Crimson’
+

0xDC143C +

+
‘Cyan’
+

0x00FFFF +

+
‘DarkBlue’
+

0x00008B +

+
‘DarkCyan’
+

0x008B8B +

+
‘DarkGoldenRod’
+

0xB8860B +

+
‘DarkGray’
+

0xA9A9A9 +

+
‘DarkGreen’
+

0x006400 +

+
‘DarkKhaki’
+

0xBDB76B +

+
‘DarkMagenta’
+

0x8B008B +

+
‘DarkOliveGreen’
+

0x556B2F +

+
‘Darkorange’
+

0xFF8C00 +

+
‘DarkOrchid’
+

0x9932CC +

+
‘DarkRed’
+

0x8B0000 +

+
‘DarkSalmon’
+

0xE9967A +

+
‘DarkSeaGreen’
+

0x8FBC8F +

+
‘DarkSlateBlue’
+

0x483D8B +

+
‘DarkSlateGray’
+

0x2F4F4F +

+
‘DarkTurquoise’
+

0x00CED1 +

+
‘DarkViolet’
+

0x9400D3 +

+
‘DeepPink’
+

0xFF1493 +

+
‘DeepSkyBlue’
+

0x00BFFF +

+
‘DimGray’
+

0x696969 +

+
‘DodgerBlue’
+

0x1E90FF +

+
‘FireBrick’
+

0xB22222 +

+
‘FloralWhite’
+

0xFFFAF0 +

+
‘ForestGreen’
+

0x228B22 +

+
‘Fuchsia’
+

0xFF00FF +

+
‘Gainsboro’
+

0xDCDCDC +

+
‘GhostWhite’
+

0xF8F8FF +

+
‘Gold’
+

0xFFD700 +

+
‘GoldenRod’
+

0xDAA520 +

+
‘Gray’
+

0x808080 +

+
‘Green’
+

0x008000 +

+
‘GreenYellow’
+

0xADFF2F +

+
‘HoneyDew’
+

0xF0FFF0 +

+
‘HotPink’
+

0xFF69B4 +

+
‘IndianRed’
+

0xCD5C5C +

+
‘Indigo’
+

0x4B0082 +

+
‘Ivory’
+

0xFFFFF0 +

+
‘Khaki’
+

0xF0E68C +

+
‘Lavender’
+

0xE6E6FA +

+
‘LavenderBlush’
+

0xFFF0F5 +

+
‘LawnGreen’
+

0x7CFC00 +

+
‘LemonChiffon’
+

0xFFFACD +

+
‘LightBlue’
+

0xADD8E6 +

+
‘LightCoral’
+

0xF08080 +

+
‘LightCyan’
+

0xE0FFFF +

+
‘LightGoldenRodYellow’
+

0xFAFAD2 +

+
‘LightGreen’
+

0x90EE90 +

+
‘LightGrey’
+

0xD3D3D3 +

+
‘LightPink’
+

0xFFB6C1 +

+
‘LightSalmon’
+

0xFFA07A +

+
‘LightSeaGreen’
+

0x20B2AA +

+
‘LightSkyBlue’
+

0x87CEFA +

+
‘LightSlateGray’
+

0x778899 +

+
‘LightSteelBlue’
+

0xB0C4DE +

+
‘LightYellow’
+

0xFFFFE0 +

+
‘Lime’
+

0x00FF00 +

+
‘LimeGreen’
+

0x32CD32 +

+
‘Linen’
+

0xFAF0E6 +

+
‘Magenta’
+

0xFF00FF +

+
‘Maroon’
+

0x800000 +

+
‘MediumAquaMarine’
+

0x66CDAA +

+
‘MediumBlue’
+

0x0000CD +

+
‘MediumOrchid’
+

0xBA55D3 +

+
‘MediumPurple’
+

0x9370D8 +

+
‘MediumSeaGreen’
+

0x3CB371 +

+
‘MediumSlateBlue’
+

0x7B68EE +

+
‘MediumSpringGreen’
+

0x00FA9A +

+
‘MediumTurquoise’
+

0x48D1CC +

+
‘MediumVioletRed’
+

0xC71585 +

+
‘MidnightBlue’
+

0x191970 +

+
‘MintCream’
+

0xF5FFFA +

+
‘MistyRose’
+

0xFFE4E1 +

+
‘Moccasin’
+

0xFFE4B5 +

+
‘NavajoWhite’
+

0xFFDEAD +

+
‘Navy’
+

0x000080 +

+
‘OldLace’
+

0xFDF5E6 +

+
‘Olive’
+

0x808000 +

+
‘OliveDrab’
+

0x6B8E23 +

+
‘Orange’
+

0xFFA500 +

+
‘OrangeRed’
+

0xFF4500 +

+
‘Orchid’
+

0xDA70D6 +

+
‘PaleGoldenRod’
+

0xEEE8AA +

+
‘PaleGreen’
+

0x98FB98 +

+
‘PaleTurquoise’
+

0xAFEEEE +

+
‘PaleVioletRed’
+

0xD87093 +

+
‘PapayaWhip’
+

0xFFEFD5 +

+
‘PeachPuff’
+

0xFFDAB9 +

+
‘Peru’
+

0xCD853F +

+
‘Pink’
+

0xFFC0CB +

+
‘Plum’
+

0xDDA0DD +

+
‘PowderBlue’
+

0xB0E0E6 +

+
‘Purple’
+

0x800080 +

+
‘Red’
+

0xFF0000 +

+
‘RosyBrown’
+

0xBC8F8F +

+
‘RoyalBlue’
+

0x4169E1 +

+
‘SaddleBrown’
+

0x8B4513 +

+
‘Salmon’
+

0xFA8072 +

+
‘SandyBrown’
+

0xF4A460 +

+
‘SeaGreen’
+

0x2E8B57 +

+
‘SeaShell’
+

0xFFF5EE +

+
‘Sienna’
+

0xA0522D +

+
‘Silver’
+

0xC0C0C0 +

+
‘SkyBlue’
+

0x87CEEB +

+
‘SlateBlue’
+

0x6A5ACD +

+
‘SlateGray’
+

0x708090 +

+
‘Snow’
+

0xFFFAFA +

+
‘SpringGreen’
+

0x00FF7F +

+
‘SteelBlue’
+

0x4682B4 +

+
‘Tan’
+

0xD2B48C +

+
‘Teal’
+

0x008080 +

+
‘Thistle’
+

0xD8BFD8 +

+
‘Tomato’
+

0xFF6347 +

+
‘Turquoise’
+

0x40E0D0 +

+
‘Violet’
+

0xEE82EE +

+
‘Wheat’
+

0xF5DEB3 +

+
‘White’
+

0xFFFFFF +

+
‘WhiteSmoke’
+

0xF5F5F5 +

+
‘Yellow’
+

0xFFFF00 +

+
‘YellowGreen’
+

0x9ACD32 +

+
+ + +

6.8 Channel Layout

+ +

A channel layout specifies the spatial disposition of the channels in +a multi-channel audio stream. To specify a channel layout, FFmpeg +makes use of a special syntax. +

+

Individual channels are identified by an id, as given by the table +below: +

+
‘FL’
+

front left +

+
‘FR’
+

front right +

+
‘FC’
+

front center +

+
‘LFE’
+

low frequency +

+
‘BL’
+

back left +

+
‘BR’
+

back right +

+
‘FLC’
+

front left-of-center +

+
‘FRC’
+

front right-of-center +

+
‘BC’
+

back center +

+
‘SL’
+

side left +

+
‘SR’
+

side right +

+
‘TC’
+

top center +

+
‘TFL’
+

top front left +

+
‘TFC’
+

top front center +

+
‘TFR’
+

top front right +

+
‘TBL’
+

top back left +

+
‘TBC’
+

top back center +

+
‘TBR’
+

top back right +

+
‘DL’
+

downmix left +

+
‘DR’
+

downmix right +

+
‘WL’
+

wide left +

+
‘WR’
+

wide right +

+
‘SDL’
+

surround direct left +

+
‘SDR’
+

surround direct right +

+
‘LFE2’
+

low frequency 2 +

+
+ +

Standard channel layout compositions can be specified by using the +following identifiers: +

+
‘mono’
+

FC +

+
‘stereo’
+

FL+FR +

+
‘2.1’
+

FL+FR+LFE +

+
‘3.0’
+

FL+FR+FC +

+
‘3.0(back)’
+

FL+FR+BC +

+
‘4.0’
+

FL+FR+FC+BC +

+
‘quad’
+

FL+FR+BL+BR +

+
‘quad(side)’
+

FL+FR+SL+SR +

+
‘3.1’
+

FL+FR+FC+LFE +

+
‘5.0’
+

FL+FR+FC+BL+BR +

+
‘5.0(side)’
+

FL+FR+FC+SL+SR +

+
‘4.1’
+

FL+FR+FC+LFE+BC +

+
‘5.1’
+

FL+FR+FC+LFE+BL+BR +

+
‘5.1(side)’
+

FL+FR+FC+LFE+SL+SR +

+
‘6.0’
+

FL+FR+FC+BC+SL+SR +

+
‘6.0(front)’
+

FL+FR+FLC+FRC+SL+SR +

+
‘hexagonal’
+

FL+FR+FC+BL+BR+BC +

+
‘6.1’
+

FL+FR+FC+LFE+BC+SL+SR +

+
‘6.1’
+

FL+FR+FC+LFE+BL+BR+BC +

+
‘6.1(front)’
+

FL+FR+LFE+FLC+FRC+SL+SR +

+
‘7.0’
+

FL+FR+FC+BL+BR+SL+SR +

+
‘7.0(front)’
+

FL+FR+FC+FLC+FRC+SL+SR +

+
‘7.1’
+

FL+FR+FC+LFE+BL+BR+SL+SR +

+
‘7.1(wide)’
+

FL+FR+FC+LFE+BL+BR+FLC+FRC +

+
‘7.1(wide-side)’
+

FL+FR+FC+LFE+FLC+FRC+SL+SR +

+
‘octagonal’
+

FL+FR+FC+BL+BR+BC+SL+SR +

+
‘hexadecagonal’
+

FL+FR+FC+BL+BR+BC+SL+SR+WL+WR+TBL+TBR+TBC+TFC+TFL+TFR +

+
‘downmix’
+

DL+DR +

+
+ +

A custom channel layout can be specified as a sequence of terms, separated by +’+’ or ’|’. Each term can be: +

    +
  • the name of a standard channel layout (e.g. ‘mono’, +‘stereo’, ‘4.0’, ‘quad’, ‘5.0’, etc.) + +
  • the name of a single channel (e.g. ‘FL’, ‘FR’, ‘FC’, ‘LFE’, etc.) + +
  • a number of channels, in decimal, followed by ’c’, yielding the default channel +layout for that number of channels (see the function +av_get_default_channel_layout). Note that not all channel counts have a +default layout. + +
  • a number of channels, in decimal, followed by ’C’, yielding an unknown channel +layout with the specified number of channels. Note that not all channel layout +specification strings support unknown channel layouts. + +
  • a channel layout mask, in hexadecimal starting with "0x" (see the +AV_CH_* macros in libavutil/channel_layout.h. +
+ +

Before libavutil version 53 the trailing character "c" to specify a number of +channels was optional, but now it is required, while a channel layout mask can +also be specified as a decimal number (if and only if not followed by "c" or "C"). +

+

See also the function av_get_channel_layout defined in +libavutil/channel_layout.h. +

+ +

7 Expression Evaluation

+ +

When evaluating an arithmetic expression, FFmpeg uses an internal +formula evaluator, implemented through the libavutil/eval.h +interface. +

+

An expression may contain unary, binary operators, constants, and +functions. +

+

Two expressions expr1 and expr2 can be combined to form +another expression "expr1;expr2". +expr1 and expr2 are evaluated in turn, and the new +expression evaluates to the value of expr2. +

+

The following binary operators are available: +, -, +*, /, ^. +

+

The following unary operators are available: +, -. +

+

The following functions are available: +

+
abs(x)
+

Compute absolute value of x. +

+
+
acos(x)
+

Compute arccosine of x. +

+
+
asin(x)
+

Compute arcsine of x. +

+
+
atan(x)
+

Compute arctangent of x. +

+
+
atan2(x, y)
+

Compute principal value of the arc tangent of y/x. +

+
+
between(x, min, max)
+

Return 1 if x is greater than or equal to min and lesser than or +equal to max, 0 otherwise. +

+
+
bitand(x, y)
+
bitor(x, y)
+

Compute bitwise and/or operation on x and y. +

+

The results of the evaluation of x and y are converted to +integers before executing the bitwise operation. +

+

Note that both the conversion to integer and the conversion back to +floating point can lose precision. Beware of unexpected results for +large numbers (usually 2^53 and larger). +

+
+
ceil(expr)
+

Round the value of expression expr upwards to the nearest +integer. For example, "ceil(1.5)" is "2.0". +

+
+
clip(x, min, max)
+

Return the value of x clipped between min and max. +

+
+
cos(x)
+

Compute cosine of x. +

+
+
cosh(x)
+

Compute hyperbolic cosine of x. +

+
+
eq(x, y)
+

Return 1 if x and y are equivalent, 0 otherwise. +

+
+
exp(x)
+

Compute exponential of x (with base e, the Euler’s number). +

+
+
floor(expr)
+

Round the value of expression expr downwards to the nearest +integer. For example, "floor(-1.5)" is "-2.0". +

+
+
gauss(x)
+

Compute Gauss function of x, corresponding to +exp(-x*x/2) / sqrt(2*PI). +

+
+
gcd(x, y)
+

Return the greatest common divisor of x and y. If both x and +y are 0 or either or both are less than zero then behavior is undefined. +

+
+
gt(x, y)
+

Return 1 if x is greater than y, 0 otherwise. +

+
+
gte(x, y)
+

Return 1 if x is greater than or equal to y, 0 otherwise. +

+
+
hypot(x, y)
+

This function is similar to the C function with the same name; it returns +"sqrt(x*x + y*y)", the length of the hypotenuse of a +right triangle with sides of length x and y, or the distance of the +point (x, y) from the origin. +

+
+
if(x, y)
+

Evaluate x, and if the result is non-zero return the result of +the evaluation of y, return 0 otherwise. +

+
+
if(x, y, z)
+

Evaluate x, and if the result is non-zero return the evaluation +result of y, otherwise the evaluation result of z. +

+
+
ifnot(x, y)
+

Evaluate x, and if the result is zero return the result of the +evaluation of y, return 0 otherwise. +

+
+
ifnot(x, y, z)
+

Evaluate x, and if the result is zero return the evaluation +result of y, otherwise the evaluation result of z. +

+
+
isinf(x)
+

Return 1.0 if x is +/-INFINITY, 0.0 otherwise. +

+
+
isnan(x)
+

Return 1.0 if x is NAN, 0.0 otherwise. +

+
+
ld(var)
+

Load the value of the internal variable with number +var, which was previously stored with st(var, expr). +The function returns the loaded value. +

+
+
lerp(x, y, z)
+

Return linear interpolation between x and y by amount of z. +

+
+
log(x)
+

Compute natural logarithm of x. +

+
+
lt(x, y)
+

Return 1 if x is lesser than y, 0 otherwise. +

+
+
lte(x, y)
+

Return 1 if x is lesser than or equal to y, 0 otherwise. +

+
+
max(x, y)
+

Return the maximum between x and y. +

+
+
min(x, y)
+

Return the minimum between x and y. +

+
+
mod(x, y)
+

Compute the remainder of division of x by y. +

+
+
not(expr)
+

Return 1.0 if expr is zero, 0.0 otherwise. +

+
+
pow(x, y)
+

Compute the power of x elevated y, it is equivalent to +"(x)^(y)". +

+
+
print(t)
+
print(t, l)
+

Print the value of expression t with loglevel l. If +l is not specified then a default log level is used. +Returns the value of the expression printed. +

+

Prints t with loglevel l +

+
+
random(x)
+

Return a pseudo random value between 0.0 and 1.0. x is the index of the +internal variable which will be used to save the seed/state. +

+
+
root(expr, max)
+

Find an input value for which the function represented by expr +with argument ld(0) is 0 in the interval 0..max. +

+

The expression in expr must denote a continuous function or the +result is undefined. +

+

ld(0) is used to represent the function input value, which means +that the given expression will be evaluated multiple times with +various input values that the expression can access through +ld(0). When the expression evaluates to 0 then the +corresponding input value will be returned. +

+
+
round(expr)
+

Round the value of expression expr to the nearest integer. For example, "round(1.5)" is "2.0". +

+
+
sgn(x)
+

Compute sign of x. +

+
+
sin(x)
+

Compute sine of x. +

+
+
sinh(x)
+

Compute hyperbolic sine of x. +

+
+
sqrt(expr)
+

Compute the square root of expr. This is equivalent to +"(expr)^.5". +

+
+
squish(x)
+

Compute expression 1/(1 + exp(4*x)). +

+
+
st(var, expr)
+

Store the value of the expression expr in an internal +variable. var specifies the number of the variable where to +store the value, and it is a value ranging from 0 to 9. The function +returns the value stored in the internal variable. +Note, Variables are currently not shared between expressions. +

+
+
tan(x)
+

Compute tangent of x. +

+
+
tanh(x)
+

Compute hyperbolic tangent of x. +

+
+
taylor(expr, x)
+
taylor(expr, x, id)
+

Evaluate a Taylor series at x, given an expression representing +the ld(id)-th derivative of a function at 0. +

+

When the series does not converge the result is undefined. +

+

ld(id) is used to represent the derivative order in expr, +which means that the given expression will be evaluated multiple times +with various input values that the expression can access through +ld(id). If id is not specified then 0 is assumed. +

+

Note, when you have the derivatives at y instead of 0, +taylor(expr, x-y) can be used. +

+
+
time(0)
+

Return the current (wallclock) time in seconds. +

+
+
trunc(expr)
+

Round the value of expression expr towards zero to the nearest +integer. For example, "trunc(-1.5)" is "-1.0". +

+
+
while(cond, expr)
+

Evaluate expression expr while the expression cond is +non-zero, and returns the value of the last expr evaluation, or +NAN if cond was always false. +

+
+ +

The following constants are available: +

+
PI
+

area of the unit disc, approximately 3.14 +

+
E
+

exp(1) (Euler’s number), approximately 2.718 +

+
PHI
+

golden ratio (1+sqrt(5))/2, approximately 1.618 +

+
+ +

Assuming that an expression is considered "true" if it has a non-zero +value, note that: +

+

* works like AND +

+

+ works like OR +

+

For example the construct: +

+
if (A AND B) then C
+
+

is equivalent to: +

+
if(A*B, C)
+
+ +

In your C code, you can extend the list of unary and binary functions, +and define recognized constants, so that they are available for your +expressions. +

+

The evaluator also recognizes the International System unit prefixes. +If ’i’ is appended after the prefix, binary prefixes are used, which +are based on powers of 1024 instead of powers of 1000. +The ’B’ postfix multiplies the value by 8, and can be appended after a +unit prefix or used alone. This allows using for example ’KB’, ’MiB’, +’G’ and ’B’ as number postfix. +

+

The list of available International System prefixes follows, with +indication of the corresponding powers of 10 and of 2. +

+
y
+

10^-24 / 2^-80 +

+
z
+

10^-21 / 2^-70 +

+
a
+

10^-18 / 2^-60 +

+
f
+

10^-15 / 2^-50 +

+
p
+

10^-12 / 2^-40 +

+
n
+

10^-9 / 2^-30 +

+
u
+

10^-6 / 2^-20 +

+
m
+

10^-3 / 2^-10 +

+
c
+

10^-2 +

+
d
+

10^-1 +

+
h
+

10^2 +

+
k
+

10^3 / 2^10 +

+
K
+

10^3 / 2^10 +

+
M
+

10^6 / 2^20 +

+
G
+

10^9 / 2^30 +

+
T
+

10^12 / 2^40 +

+
P
+

10^15 / 2^40 +

+
E
+

10^18 / 2^50 +

+
Z
+

10^21 / 2^60 +

+
Y
+

10^24 / 2^70 +

+
+ + +

8 Codec Options

+ +

libavcodec provides some generic global options, which can be set on +all the encoders and decoders. In addition each codec may support +so-called private options, which are specific for a given codec. +

+

Sometimes, a global option may only affect a specific kind of codec, +and may be nonsensical or ignored by another, so you need to be aware +of the meaning of the specified options. Also some options are +meant only for decoding or encoding. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the +AVCodecContext options or using the libavutil/opt.h API +for programmatic use. +

+

The list of supported options follow: +

+
+
b integer (encoding,audio,video)
+

Set bitrate in bits/s. Default value is 200K. +

+
+
ab integer (encoding,audio)
+

Set audio bitrate (in bits/s). Default value is 128K. +

+
+
bt integer (encoding,video)
+

Set video bitrate tolerance (in bits/s). In 1-pass mode, bitrate +tolerance specifies how far ratecontrol is willing to deviate from the +target average bitrate value. This is not related to min/max +bitrate. Lowering tolerance too much has an adverse effect on quality. +

+
+
flags flags (decoding/encoding,audio,video,subtitles)
+

Set generic flags. +

+

Possible values: +

+
‘mv4’
+

Use four motion vector by macroblock (mpeg4). +

+
‘qpel’
+

Use 1/4 pel motion compensation. +

+
‘loop’
+

Use loop filter. +

+
‘qscale’
+

Use fixed qscale. +

+
‘pass1’
+

Use internal 2pass ratecontrol in first pass mode. +

+
‘pass2’
+

Use internal 2pass ratecontrol in second pass mode. +

+
‘gray’
+

Only decode/encode grayscale. +

+
‘emu_edge’
+

Do not draw edges. +

+
‘psnr’
+

Set error[?] variables during encoding. +

+
‘truncated’
+

Input bitstream might be randomly truncated. +

+
‘drop_changed’
+

Don’t output frames whose parameters differ from first decoded frame in stream. +Error AVERROR_INPUT_CHANGED is returned when a frame is dropped. +

+
+
‘ildct’
+

Use interlaced DCT. +

+
‘low_delay’
+

Force low delay. +

+
‘global_header’
+

Place global headers in extradata instead of every keyframe. +

+
‘bitexact’
+

Only write platform-, build- and time-independent data. (except (I)DCT). +This ensures that file and data checksums are reproducible and match between +platforms. Its primary use is for regression testing. +

+
‘aic’
+

Apply H263 advanced intra coding / mpeg4 ac prediction. +

+
‘cbp’
+

Deprecated, use mpegvideo private options instead. +

+
‘qprd’
+

Deprecated, use mpegvideo private options instead. +

+
‘ilme’
+

Apply interlaced motion estimation. +

+
‘cgop’
+

Use closed gop. +

+
‘output_corrupt’
+

Output even potentially corrupted frames. +

+
+ +
+
me_method integer (encoding,video)
+

Set motion estimation method. +

+

Possible values: +

+
‘zero’
+

zero motion estimation (fastest) +

+
‘full’
+

full motion estimation (slowest) +

+
‘epzs’
+

EPZS motion estimation (default) +

+
‘esa’
+

esa motion estimation (alias for full) +

+
‘tesa’
+

tesa motion estimation +

+
‘dia’
+

dia motion estimation (alias for epzs) +

+
‘log’
+

log motion estimation +

+
‘phods’
+

phods motion estimation +

+
‘x1’
+

X1 motion estimation +

+
‘hex’
+

hex motion estimation +

+
‘umh’
+

umh motion estimation +

+
‘iter’
+

iter motion estimation +

+
+ +
+
extradata_size integer
+

Set extradata size. +

+
+
time_base rational number
+

Set codec time base. +

+

It is the fundamental unit of time (in seconds) in terms of which +frame timestamps are represented. For fixed-fps content, timebase +should be 1 / frame_rate and timestamp increments should be +identically 1. +

+
+
g integer (encoding,video)
+

Set the group of picture (GOP) size. Default value is 12. +

+
+
ar integer (decoding/encoding,audio)
+

Set audio sampling rate (in Hz). +

+
+
ac integer (decoding/encoding,audio)
+

Set number of audio channels. +

+
+
cutoff integer (encoding,audio)
+

Set cutoff bandwidth. (Supported only by selected encoders, see +their respective documentation sections.) +

+
+
frame_size integer (encoding,audio)
+

Set audio frame size. +

+

Each submitted frame except the last must contain exactly frame_size +samples per channel. May be 0 when the codec has +CODEC_CAP_VARIABLE_FRAME_SIZE set, in that case the frame size is not +restricted. It is set by some decoders to indicate constant frame +size. +

+
+
frame_number integer
+

Set the frame number. +

+
+
delay integer
+
qcomp float (encoding,video)
+

Set video quantizer scale compression (VBR). It is used as a constant +in the ratecontrol equation. Recommended range for default rc_eq: +0.0-1.0. +

+
+
qblur float (encoding,video)
+

Set video quantizer scale blur (VBR). +

+
+
qmin integer (encoding,video)
+

Set min video quantizer scale (VBR). Must be included between -1 and +69, default value is 2. +

+
+
qmax integer (encoding,video)
+

Set max video quantizer scale (VBR). Must be included between -1 and +1024, default value is 31. +

+
+
qdiff integer (encoding,video)
+

Set max difference between the quantizer scale (VBR). +

+
+
bf integer (encoding,video)
+

Set max number of B frames between non-B-frames. +

+

Must be an integer between -1 and 16. 0 means that B-frames are +disabled. If a value of -1 is used, it will choose an automatic value +depending on the encoder. +

+

Default value is 0. +

+
+
b_qfactor float (encoding,video)
+

Set qp factor between P and B frames. +

+
+
rc_strategy integer (encoding,video)
+

Set ratecontrol method. +

+
+
b_strategy integer (encoding,video)
+

Set strategy to choose between I/P/B-frames. +

+
+
ps integer (encoding,video)
+

Set RTP payload size in bytes. +

+
+
mv_bits integer
+
header_bits integer
+
i_tex_bits integer
+
p_tex_bits integer
+
i_count integer
+
p_count integer
+
skip_count integer
+
misc_bits integer
+
frame_bits integer
+
codec_tag integer
+
bug flags (decoding,video)
+

Workaround not auto detected encoder bugs. +

+

Possible values: +

+
‘autodetect’
+
‘old_msmpeg4’
+

some old lavc generated msmpeg4v3 files (no autodetection) +

+
‘xvid_ilace’
+

Xvid interlacing bug (autodetected if fourcc==XVIX) +

+
‘ump4’
+

(autodetected if fourcc==UMP4) +

+
‘no_padding’
+

padding bug (autodetected) +

+
‘amv’
+
‘ac_vlc’
+

illegal vlc bug (autodetected per fourcc) +

+
‘qpel_chroma’
+
‘std_qpel’
+

old standard qpel (autodetected per fourcc/version) +

+
‘qpel_chroma2’
+
‘direct_blocksize’
+

direct-qpel-blocksize bug (autodetected per fourcc/version) +

+
‘edge’
+

edge padding bug (autodetected per fourcc/version) +

+
‘hpel_chroma’
+
‘dc_clip’
+
‘ms’
+

Workaround various bugs in microsoft broken decoders. +

+
‘trunc’
+

trancated frames +

+
+ +
+
lelim integer (encoding,video)
+

Set single coefficient elimination threshold for luminance (negative +values also consider DC coefficient). +

+
+
celim integer (encoding,video)
+

Set single coefficient elimination threshold for chrominance (negative +values also consider dc coefficient) +

+
+
strict integer (decoding/encoding,audio,video)
+

Specify how strictly to follow the standards. +

+

Possible values: +

+
‘very’
+

strictly conform to an older more strict version of the spec or reference software +

+
‘strict’
+

strictly conform to all the things in the spec no matter what consequences +

+
‘normal’
+
‘unofficial’
+

allow unofficial extensions +

+
‘experimental’
+

allow non standardized experimental things, experimental +(unfinished/work in progress/not well tested) decoders and encoders. +Note: experimental decoders can pose a security risk, do not use this for +decoding untrusted input. +

+
+ +
+
b_qoffset float (encoding,video)
+

Set QP offset between P and B frames. +

+
+
err_detect flags (decoding,audio,video)
+

Set error detection flags. +

+

Possible values: +

+
‘crccheck’
+

verify embedded CRCs +

+
‘bitstream’
+

detect bitstream specification deviations +

+
‘buffer’
+

detect improper bitstream length +

+
‘explode’
+

abort decoding on minor error detection +

+
‘ignore_err’
+

ignore decoding errors, and continue decoding. +This is useful if you want to analyze the content of a video and thus want +everything to be decoded no matter what. This option will not result in a video +that is pleasing to watch in case of errors. +

+
‘careful’
+

consider things that violate the spec and have not been seen in the wild as errors +

+
‘compliant’
+

consider all spec non compliancies as errors +

+
‘aggressive’
+

consider things that a sane encoder should not do as an error +

+
+ +
+
has_b_frames integer
+
block_align integer
+
mpeg_quant integer (encoding,video)
+

Use MPEG quantizers instead of H.263. +

+
+
qsquish float (encoding,video)
+

How to keep quantizer between qmin and qmax (0 = clip, 1 = use +differentiable function). +

+
+
rc_qmod_amp float (encoding,video)
+

Set experimental quantizer modulation. +

+
+
rc_qmod_freq integer (encoding,video)
+

Set experimental quantizer modulation. +

+
+
rc_override_count integer
+
rc_eq string (encoding,video)
+

Set rate control equation. When computing the expression, besides the +standard functions defined in the section ’Expression Evaluation’, the +following functions are available: bits2qp(bits), qp2bits(qp). Also +the following constants are available: iTex pTex tex mv fCode iCount +mcVar var isI isP isB avgQP qComp avgIITex avgPITex avgPPTex avgBPTex +avgTex. +

+
+
maxrate integer (encoding,audio,video)
+

Set max bitrate tolerance (in bits/s). Requires bufsize to be set. +

+
+
minrate integer (encoding,audio,video)
+

Set min bitrate tolerance (in bits/s). Most useful in setting up a CBR +encode. It is of little use elsewise. +

+
+
bufsize integer (encoding,audio,video)
+

Set ratecontrol buffer size (in bits). +

+
+
rc_buf_aggressivity float (encoding,video)
+

Currently useless. +

+
+
i_qfactor float (encoding,video)
+

Set QP factor between P and I frames. +

+
+
i_qoffset float (encoding,video)
+

Set QP offset between P and I frames. +

+
+
rc_init_cplx float (encoding,video)
+

Set initial complexity for 1-pass encoding. +

+
+
dct integer (encoding,video)
+

Set DCT algorithm. +

+

Possible values: +

+
‘auto’
+

autoselect a good one (default) +

+
‘fastint’
+

fast integer +

+
‘int’
+

accurate integer +

+
‘mmx’
+
‘altivec’
+
‘faan’
+

floating point AAN DCT +

+
+ +
+
lumi_mask float (encoding,video)
+

Compress bright areas stronger than medium ones. +

+
+
tcplx_mask float (encoding,video)
+

Set temporal complexity masking. +

+
+
scplx_mask float (encoding,video)
+

Set spatial complexity masking. +

+
+
p_mask float (encoding,video)
+

Set inter masking. +

+
+
dark_mask float (encoding,video)
+

Compress dark areas stronger than medium ones. +

+
+
idct integer (decoding/encoding,video)
+

Select IDCT implementation. +

+

Possible values: +

+
‘auto’
+
‘int’
+
‘simple’
+
‘simplemmx’
+
‘simpleauto’
+

Automatically pick a IDCT compatible with the simple one +

+
+
‘arm’
+
‘altivec’
+
‘sh4’
+
‘simplearm’
+
‘simplearmv5te’
+
‘simplearmv6’
+
‘simpleneon’
+
‘simplealpha’
+
‘ipp’
+
‘xvidmmx’
+
‘faani’
+

floating point AAN IDCT +

+
+ +
+
slice_count integer
+
ec flags (decoding,video)
+

Set error concealment strategy. +

+

Possible values: +

+
‘guess_mvs’
+

iterative motion vector (MV) search (slow) +

+
‘deblock’
+

use strong deblock filter for damaged MBs +

+
‘favor_inter’
+

favor predicting from the previous frame instead of the current +

+
+ +
+
bits_per_coded_sample integer
+
pred integer (encoding,video)
+

Set prediction method. +

+

Possible values: +

+
‘left’
+
‘plane’
+
‘median’
+
+ +
+
aspect rational number (encoding,video)
+

Set sample aspect ratio. +

+
+
sar rational number (encoding,video)
+

Set sample aspect ratio. Alias to aspect. +

+
+
debug flags (decoding/encoding,audio,video,subtitles)
+

Print specific debug info. +

+

Possible values: +

+
‘pict’
+

picture info +

+
‘rc’
+

rate control +

+
‘bitstream’
+
‘mb_type’
+

macroblock (MB) type +

+
‘qp’
+

per-block quantization parameter (QP) +

+
‘dct_coeff’
+
‘green_metadata’
+

display complexity metadata for the upcoming frame, GoP or for a given duration. +

+
+
‘skip’
+
‘startcode’
+
‘er’
+

error recognition +

+
‘mmco’
+

memory management control operations (H.264) +

+
‘bugs’
+
‘buffers’
+

picture buffer allocations +

+
‘thread_ops’
+

threading operations +

+
‘nomc’
+

skip motion compensation +

+
+ +
+
cmp integer (encoding,video)
+

Set full pel me compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
subcmp integer (encoding,video)
+

Set sub pel me compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
mbcmp integer (encoding,video)
+

Set macroblock compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
ildctcmp integer (encoding,video)
+

Set interlaced dct compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
dia_size integer (encoding,video)
+

Set diamond type & size for motion estimation. +

+
‘(1024, INT_MAX)’
+

full motion estimation(slowest) +

+
‘(768, 1024]’
+

umh motion estimation +

+
‘(512, 768]’
+

hex motion estimation +

+
‘(256, 512]’
+

l2s diamond motion estimation +

+
‘[2,256]’
+

var diamond motion estimation +

+
‘(-1, 2)’
+

small diamond motion estimation +

+
‘-1’
+

funny diamond motion estimation +

+
‘(INT_MIN, -1)’
+

sab diamond motion estimation +

+
+ +
+
last_pred integer (encoding,video)
+

Set amount of motion predictors from the previous frame. +

+
+
preme integer (encoding,video)
+

Set pre motion estimation. +

+
+
precmp integer (encoding,video)
+

Set pre motion estimation compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
pre_dia_size integer (encoding,video)
+

Set diamond type & size for motion estimation pre-pass. +

+
+
subq integer (encoding,video)
+

Set sub pel motion estimation quality. +

+
+
dtg_active_format integer
+
me_range integer (encoding,video)
+

Set limit motion vectors range (1023 for DivX player). +

+
+
ibias integer (encoding,video)
+

Set intra quant bias. +

+
+
pbias integer (encoding,video)
+

Set inter quant bias. +

+
+
color_table_id integer
+
global_quality integer (encoding,audio,video)
+
coder integer (encoding,video)
+
+

Possible values: +

+
‘vlc’
+

variable length coder / huffman coder +

+
‘ac’
+

arithmetic coder +

+
‘raw’
+

raw (no encoding) +

+
‘rle’
+

run-length coder +

+
‘deflate’
+

deflate-based coder +

+
+ +
+
context integer (encoding,video)
+

Set context model. +

+
+
slice_flags integer
+
mbd integer (encoding,video)
+

Set macroblock decision algorithm (high quality mode). +

+

Possible values: +

+
‘simple’
+

use mbcmp (default) +

+
‘bits’
+

use fewest bits +

+
‘rd’
+

use best rate distortion +

+
+ +
+
stream_codec_tag integer
+
sc_threshold integer (encoding,video)
+

Set scene change threshold. +

+
+
lmin integer (encoding,video)
+

Set min lagrange factor (VBR). +

+
+
lmax integer (encoding,video)
+

Set max lagrange factor (VBR). +

+
+
nr integer (encoding,video)
+

Set noise reduction. +

+
+
rc_init_occupancy integer (encoding,video)
+

Set number of bits which should be loaded into the rc buffer before +decoding starts. +

+
+
flags2 flags (decoding/encoding,audio,video,subtitles)
+
+

Possible values: +

+
‘fast’
+

Allow non spec compliant speedup tricks. +

+
‘noout’
+

Skip bitstream encoding. +

+
‘ignorecrop’
+

Ignore cropping information from sps. +

+
‘local_header’
+

Place global headers at every keyframe instead of in extradata. +

+
‘chunks’
+

Frame data might be split into multiple chunks. +

+
‘showall’
+

Show all frames before the first keyframe. +

+
‘export_mvs’
+

Export motion vectors into frame side-data (see AV_FRAME_DATA_MOTION_VECTORS) +for codecs that support it. See also doc/examples/export_mvs.c. +

+
‘skip_manual’
+

Do not skip samples and export skip information as frame side data. +

+
‘ass_ro_flush_noop’
+

Do not reset ASS ReadOrder field on flush. +

+
+ +
+
export_side_data flags (decoding/encoding,audio,video,subtitles)
+
+

Possible values: +

+
‘mvs’
+

Export motion vectors into frame side-data (see AV_FRAME_DATA_MOTION_VECTORS) +for codecs that support it. See also doc/examples/export_mvs.c. +

+
‘prft’
+

Export encoder Producer Reference Time into packet side-data (see AV_PKT_DATA_PRFT) +for codecs that support it. +

+
+ +
+
error integer (encoding,video)
+
qns integer (encoding,video)
+

Deprecated, use mpegvideo private options instead. +

+
+
threads integer (decoding/encoding,video)
+

Set the number of threads to be used, in case the selected codec +implementation supports multi-threading. +

+

Possible values: +

+
‘auto, 0’
+

automatically select the number of threads to set +

+
+ +

Default value is ‘auto’. +

+
+
me_threshold integer (encoding,video)
+

Set motion estimation threshold. +

+
+
mb_threshold integer (encoding,video)
+

Set macroblock threshold. +

+
+
dc integer (encoding,video)
+

Set intra_dc_precision. +

+
+
nssew integer (encoding,video)
+

Set nsse weight. +

+
+
skip_top integer (decoding,video)
+

Set number of macroblock rows at the top which are skipped. +

+
+
skip_bottom integer (decoding,video)
+

Set number of macroblock rows at the bottom which are skipped. +

+
+
profile integer (encoding,audio,video)
+
+

Set encoder codec profile. Default value is ‘unknown’. Encoder specific +profiles are documented in the relevant encoder documentation. +

+
+
level integer (encoding,audio,video)
+
+

Possible values: +

+
‘unknown’
+
+ +
+
lowres integer (decoding,audio,video)
+

Decode at 1= 1/2, 2=1/4, 3=1/8 resolutions. +

+
+
skip_threshold integer (encoding,video)
+

Set frame skip threshold. +

+
+
skip_factor integer (encoding,video)
+

Set frame skip factor. +

+
+
skip_exp integer (encoding,video)
+

Set frame skip exponent. +Negative values behave identical to the corresponding positive ones, except +that the score is normalized. +Positive values exist primarily for compatibility reasons and are not so useful. +

+
+
skipcmp integer (encoding,video)
+

Set frame skip compare function. +

+

Possible values: +

+
‘sad’
+

sum of absolute differences, fast (default) +

+
‘sse’
+

sum of squared errors +

+
‘satd’
+

sum of absolute Hadamard transformed differences +

+
‘dct’
+

sum of absolute DCT transformed differences +

+
‘psnr’
+

sum of squared quantization errors (avoid, low quality) +

+
‘bit’
+

number of bits needed for the block +

+
‘rd’
+

rate distortion optimal, slow +

+
‘zero’
+

0 +

+
‘vsad’
+

sum of absolute vertical differences +

+
‘vsse’
+

sum of squared vertical differences +

+
‘nsse’
+

noise preserving sum of squared differences +

+
‘w53’
+

5/3 wavelet, only used in snow +

+
‘w97’
+

9/7 wavelet, only used in snow +

+
‘dctmax’
+
‘chroma’
+
+ +
+
border_mask float (encoding,video)
+

Increase the quantizer for macroblocks close to borders. +

+
+
mblmin integer (encoding,video)
+

Set min macroblock lagrange factor (VBR). +

+
+
mblmax integer (encoding,video)
+

Set max macroblock lagrange factor (VBR). +

+
+
mepc integer (encoding,video)
+

Set motion estimation bitrate penalty compensation (1.0 = 256). +

+
+
skip_loop_filter integer (decoding,video)
+
skip_idct integer (decoding,video)
+
skip_frame integer (decoding,video)
+
+

Make decoder discard processing depending on the frame type selected +by the option value. +

+

skip_loop_filter skips frame loop filtering, skip_idct +skips frame IDCT/dequantization, skip_frame skips decoding. +

+

Possible values: +

+
‘none’
+

Discard no frame. +

+
+
‘default’
+

Discard useless frames like 0-sized frames. +

+
+
‘noref’
+

Discard all non-reference frames. +

+
+
‘bidir’
+

Discard all bidirectional frames. +

+
+
‘nokey’
+

Discard all frames excepts keyframes. +

+
+
‘nointra’
+

Discard all frames except I frames. +

+
+
‘all’
+

Discard all frames. +

+
+ +

Default value is ‘default’. +

+
+
bidir_refine integer (encoding,video)
+

Refine the two motion vectors used in bidirectional macroblocks. +

+
+
brd_scale integer (encoding,video)
+

Downscale frames for dynamic B-frame decision. +

+
+
keyint_min integer (encoding,video)
+

Set minimum interval between IDR-frames. +

+
+
refs integer (encoding,video)
+

Set reference frames to consider for motion compensation. +

+
+
chromaoffset integer (encoding,video)
+

Set chroma qp offset from luma. +

+
+
trellis integer (encoding,audio,video)
+

Set rate-distortion optimal quantization. +

+
+
mv0_threshold integer (encoding,video)
+
b_sensitivity integer (encoding,video)
+

Adjust sensitivity of b_frame_strategy 1. +

+
+
compression_level integer (encoding,audio,video)
+
min_prediction_order integer (encoding,audio)
+
max_prediction_order integer (encoding,audio)
+
timecode_frame_start integer (encoding,video)
+

Set GOP timecode frame start number, in non drop frame format. +

+
+
request_channels integer (decoding,audio)
+

Set desired number of audio channels. +

+
+
bits_per_raw_sample integer
+
channel_layout integer (decoding/encoding,audio)
+
+

Possible values: +

+
request_channel_layout integer (decoding,audio)
+
+

Possible values: +

+
rc_max_vbv_use float (encoding,video)
+
rc_min_vbv_use float (encoding,video)
+
ticks_per_frame integer (decoding/encoding,audio,video)
+
color_primaries integer (decoding/encoding,video)
+

Possible values: +

+
‘bt709’
+

BT.709 +

+
‘bt470m’
+

BT.470 M +

+
‘bt470bg’
+

BT.470 BG +

+
‘smpte170m’
+

SMPTE 170 M +

+
‘smpte240m’
+

SMPTE 240 M +

+
‘film’
+

Film +

+
‘bt2020’
+

BT.2020 +

+
‘smpte428’
+
‘smpte428_1’
+

SMPTE ST 428-1 +

+
‘smpte431’
+

SMPTE 431-2 +

+
‘smpte432’
+

SMPTE 432-1 +

+
‘jedec-p22’
+

JEDEC P22 +

+
+ +
+
color_trc integer (decoding/encoding,video)
+

Possible values: +

+
‘bt709’
+

BT.709 +

+
‘gamma22’
+

BT.470 M +

+
‘gamma28’
+

BT.470 BG +

+
‘smpte170m’
+

SMPTE 170 M +

+
‘smpte240m’
+

SMPTE 240 M +

+
‘linear’
+

Linear +

+
‘log’
+
‘log100’
+

Log +

+
‘log_sqrt’
+
‘log316’
+

Log square root +

+
‘iec61966_2_4’
+
‘iec61966-2-4’
+

IEC 61966-2-4 +

+
‘bt1361’
+
‘bt1361e’
+

BT.1361 +

+
‘iec61966_2_1’
+
‘iec61966-2-1’
+

IEC 61966-2-1 +

+
‘bt2020_10’
+
‘bt2020_10bit’
+

BT.2020 - 10 bit +

+
‘bt2020_12’
+
‘bt2020_12bit’
+

BT.2020 - 12 bit +

+
‘smpte2084’
+

SMPTE ST 2084 +

+
‘smpte428’
+
‘smpte428_1’
+

SMPTE ST 428-1 +

+
‘arib-std-b67’
+

ARIB STD-B67 +

+
+ +
+
colorspace integer (decoding/encoding,video)
+

Possible values: +

+
‘rgb’
+

RGB +

+
‘bt709’
+

BT.709 +

+
‘fcc’
+

FCC +

+
‘bt470bg’
+

BT.470 BG +

+
‘smpte170m’
+

SMPTE 170 M +

+
‘smpte240m’
+

SMPTE 240 M +

+
‘ycocg’
+

YCOCG +

+
‘bt2020nc’
+
‘bt2020_ncl’
+

BT.2020 NCL +

+
‘bt2020c’
+
‘bt2020_cl’
+

BT.2020 CL +

+
‘smpte2085’
+

SMPTE 2085 +

+
+ +
+
color_range integer (decoding/encoding,video)
+

If used as input parameter, it serves as a hint to the decoder, which +color_range the input has. +Possible values: +

+
‘tv’
+
‘mpeg’
+

MPEG (219*2^(n-8)) +

+
‘pc’
+
‘jpeg’
+

JPEG (2^n-1) +

+
+ +
+
chroma_sample_location integer (decoding/encoding,video)
+

Possible values: +

+
‘left’
+
‘center’
+
‘topleft’
+
‘top’
+
‘bottomleft’
+
‘bottom’
+
+ +
+
log_level_offset integer
+

Set the log level offset. +

+
+
slices integer (encoding,video)
+

Number of slices, used in parallelized encoding. +

+
+
thread_type flags (decoding/encoding,video)
+

Select which multithreading methods to use. +

+

Use of ‘frame’ will increase decoding delay by one frame per +thread, so clients which cannot provide future frames should not use +it. +

+

Possible values: +

+
‘slice’
+

Decode more than one part of a single frame at once. +

+

Multithreading using slices works only when the video was encoded with +slices. +

+
+
‘frame’
+

Decode more than one frame at once. +

+
+ +

Default value is ‘slice+frame’. +

+
+
audio_service_type integer (encoding,audio)
+

Set audio service type. +

+

Possible values: +

+
‘ma’
+

Main Audio Service +

+
‘ef’
+

Effects +

+
‘vi’
+

Visually Impaired +

+
‘hi’
+

Hearing Impaired +

+
‘di’
+

Dialogue +

+
‘co’
+

Commentary +

+
‘em’
+

Emergency +

+
‘vo’
+

Voice Over +

+
‘ka’
+

Karaoke +

+
+ +
+
request_sample_fmt sample_fmt (decoding,audio)
+

Set sample format audio decoders should prefer. Default value is +none. +

+
+
pkt_timebase rational number
+
sub_charenc encoding (decoding,subtitles)
+

Set the input subtitles character encoding. +

+
+
field_order field_order (video)
+

Set/override the field order of the video. +Possible values: +

+
‘progressive’
+

Progressive video +

+
‘tt’
+

Interlaced video, top field coded and displayed first +

+
‘bb’
+

Interlaced video, bottom field coded and displayed first +

+
‘tb’
+

Interlaced video, top coded first, bottom displayed first +

+
‘bt’
+

Interlaced video, bottom coded first, top displayed first +

+
+ +
+
skip_alpha bool (decoding,video)
+

Set to 1 to disable processing alpha (transparency). This works like the +‘gray’ flag in the flags option which skips chroma information +instead of alpha. Default is 0. +

+
+
codec_whitelist list (input)
+

"," separated list of allowed decoders. By default all are allowed. +

+
+
dump_separator string (input)
+

Separator used to separate the fields printed on the command line about the +Stream parameters. +For example, to separate the fields with newlines and indentation: +

+
ffprobe -dump_separator "
+                          "  -i ~/videos/matrixbench_mpeg2.mpg
+
+ +
+
max_pixels integer (decoding/encoding,video)
+

Maximum number of pixels per image. This value can be used to avoid out of +memory failures due to large images. +

+
+
apply_cropping bool (decoding,video)
+

Enable cropping if cropping parameters are multiples of the required +alignment for the left and top parameters. If the alignment is not met the +cropping will be partially applied to maintain alignment. +Default is 1 (enabled). +Note: The required alignment depends on if AV_CODEC_FLAG_UNALIGNED is set and the +CPU. AV_CODEC_FLAG_UNALIGNED cannot be changed from the command line. Also hardware +decoders will not apply left/top Cropping. +

+ +
+
+ + + +

9 Decoders

+ +

Decoders are configured elements in FFmpeg which allow the decoding of +multimedia streams. +

+

When you configure your FFmpeg build, all the supported native decoders +are enabled by default. Decoders requiring an external library must be enabled +manually via the corresponding --enable-lib option. You can list all +available decoders using the configure option --list-decoders. +

+

You can disable all the decoders with the configure option +--disable-decoders and selectively enable / disable single decoders +with the options --enable-decoder=DECODER / +--disable-decoder=DECODER. +

+

The option -decoders of the ff* tools will display the list of +enabled decoders. +

+ + +

10 Video Decoders

+ +

A description of some of the currently available video decoders +follows. +

+ +

10.1 rawvideo

+ +

Raw video decoder. +

+

This decoder decodes rawvideo streams. +

+ +

10.1.1 Options

+ +
+
top top_field_first
+

Specify the assumed field type of the input video. +

+
-1
+

the video is assumed to be progressive (default) +

+
0
+

bottom-field-first is assumed +

+
1
+

top-field-first is assumed +

+
+ +
+
+ + +

10.2 libdav1d

+ +

dav1d AV1 decoder. +

+

libdav1d allows libavcodec to decode the AOMedia Video 1 (AV1) codec. +Requires the presence of the libdav1d headers and library during configuration. +You need to explicitly configure the build with --enable-libdav1d. +

+ +

10.2.1 Options

+ +

The following options are supported by the libdav1d wrapper. +

+
+
framethreads
+

Set amount of frame threads to use during decoding. The default value is 0 (autodetect). +

+
+
tilethreads
+

Set amount of tile threads to use during decoding. The default value is 0 (autodetect). +

+
+
filmgrain
+

Apply film grain to the decoded video if present in the bitstream. Defaults to the +internal default of the library. +

+
+
oppoint
+

Select an operating point of a scalable AV1 bitstream (0 - 31). Defaults to the +internal default of the library. +

+
+
alllayers
+

Output all spatial layers of a scalable AV1 bitstream. The default value is false. +

+
+
+ + +

10.3 libdavs2

+ +

AVS2-P2/IEEE1857.4 video decoder wrapper. +

+

This decoder allows libavcodec to decode AVS2 streams with davs2 library. +

+ + +

11 Audio Decoders

+ +

A description of some of the currently available audio decoders +follows. +

+ +

11.1 ac3

+ +

AC-3 audio decoder. +

+

This decoder implements part of ATSC A/52:2010 and ETSI TS 102 366, as well as +the undocumented RealAudio 3 (a.k.a. dnet). +

+ +

11.1.1 AC-3 Decoder Options

+ +
+
-drc_scale value
+

Dynamic Range Scale Factor. The factor to apply to dynamic range values +from the AC-3 stream. This factor is applied exponentially. +There are 3 notable scale factor ranges: +

+
drc_scale == 0
+

DRC disabled. Produces full range audio. +

+
0 < drc_scale <= 1
+

DRC enabled. Applies a fraction of the stream DRC value. +Audio reproduction is between full range and full compression. +

+
drc_scale > 1
+

DRC enabled. Applies drc_scale asymmetrically. +Loud sounds are fully compressed. Soft sounds are enhanced. +

+
+ +
+
+ + +

11.2 flac

+ +

FLAC audio decoder. +

+

This decoder aims to implement the complete FLAC specification from Xiph. +

+ +

11.2.1 FLAC Decoder options

+ +
+
-use_buggy_lpc
+

The lavc FLAC encoder used to produce buggy streams with high lpc values +(like the default value). This option makes it possible to decode such streams +correctly by using lavc’s old buggy lpc logic for decoding. +

+
+
+ + +

11.3 ffwavesynth

+ +

Internal wave synthesizer. +

+

This decoder generates wave patterns according to predefined sequences. Its +use is purely internal and the format of the data it accepts is not publicly +documented. +

+ +

11.4 libcelt

+ +

libcelt decoder wrapper. +

+

libcelt allows libavcodec to decode the Xiph CELT ultra-low delay audio codec. +Requires the presence of the libcelt headers and library during configuration. +You need to explicitly configure the build with --enable-libcelt. +

+ +

11.5 libgsm

+ +

libgsm decoder wrapper. +

+

libgsm allows libavcodec to decode the GSM full rate audio codec. Requires +the presence of the libgsm headers and library during configuration. You need +to explicitly configure the build with --enable-libgsm. +

+

This decoder supports both the ordinary GSM and the Microsoft variant. +

+ +

11.6 libilbc

+ +

libilbc decoder wrapper. +

+

libilbc allows libavcodec to decode the Internet Low Bitrate Codec (iLBC) +audio codec. Requires the presence of the libilbc headers and library during +configuration. You need to explicitly configure the build with +--enable-libilbc. +

+ +

11.6.1 Options

+ +

The following option is supported by the libilbc wrapper. +

+
+
enhance
+
+

Enable the enhancement of the decoded audio when set to 1. The default +value is 0 (disabled). +

+
+
+ + +

11.7 libopencore-amrnb

+ +

libopencore-amrnb decoder wrapper. +

+

libopencore-amrnb allows libavcodec to decode the Adaptive Multi-Rate +Narrowband audio codec. Using it requires the presence of the +libopencore-amrnb headers and library during configuration. You need to +explicitly configure the build with --enable-libopencore-amrnb. +

+

An FFmpeg native decoder for AMR-NB exists, so users can decode AMR-NB +without this library. +

+ +

11.8 libopencore-amrwb

+ +

libopencore-amrwb decoder wrapper. +

+

libopencore-amrwb allows libavcodec to decode the Adaptive Multi-Rate +Wideband audio codec. Using it requires the presence of the +libopencore-amrwb headers and library during configuration. You need to +explicitly configure the build with --enable-libopencore-amrwb. +

+

An FFmpeg native decoder for AMR-WB exists, so users can decode AMR-WB +without this library. +

+ +

11.9 libopus

+ +

libopus decoder wrapper. +

+

libopus allows libavcodec to decode the Opus Interactive Audio Codec. +Requires the presence of the libopus headers and library during +configuration. You need to explicitly configure the build with +--enable-libopus. +

+

An FFmpeg native decoder for Opus exists, so users can decode Opus +without this library. +

+ + +

12 Subtitles Decoders

+ + +

12.1 libaribb24

+ +

ARIB STD-B24 caption decoder. +

+

Implements profiles A and C of the ARIB STD-B24 standard. +

+ +

12.1.1 libaribb24 Decoder Options

+ +
+
-aribb24-base-path path
+

Sets the base path for the libaribb24 library. This is utilized for reading of +configuration files (for custom unicode conversions), and for dumping of +non-text symbols as images under that location. +

+

Unset by default. +

+
+
-aribb24-skip-ruby-text boolean
+

Tells the decoder wrapper to skip text blocks that contain half-height ruby +text. +

+

Enabled by default. +

+
+
+ + +

12.2 dvbsub

+ + +

12.2.1 Options

+ +
+
compute_clut
+
+
-1
+

Compute clut if no matching CLUT is in the stream. +

+
0
+

Never compute CLUT +

+
1
+

Always compute CLUT and override the one provided in the stream. +

+
+
+
dvb_substream
+

Selects the dvb substream, or all substreams if -1 which is default. +

+
+
+ + +

12.3 dvdsub

+ +

This codec decodes the bitmap subtitles used in DVDs; the same subtitles can +also be found in VobSub file pairs and in some Matroska files. +

+ +

12.3.1 Options

+ +
+
palette
+

Specify the global palette used by the bitmaps. When stored in VobSub, the +palette is normally specified in the index file; in Matroska, the palette is +stored in the codec extra-data in the same format as in VobSub. In DVDs, the +palette is stored in the IFO file, and therefore not available when reading +from dumped VOB files. +

+

The format for this option is a string containing 16 24-bits hexadecimal +numbers (without 0x prefix) separated by commas, for example 0d00ee, +ee450d, 101010, eaeaea, 0ce60b, ec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1, +7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b. +

+
+
ifo_palette
+

Specify the IFO file from which the global palette is obtained. +(experimental) +

+
+
forced_subs_only
+

Only decode subtitle entries marked as forced. Some titles have forced +and non-forced subtitles in the same track. Setting this flag to 1 +will only keep the forced subtitles. Default value is 0. +

+
+ + +

12.4 libzvbi-teletext

+ +

Libzvbi allows libavcodec to decode DVB teletext pages and DVB teletext +subtitles. Requires the presence of the libzvbi headers and library during +configuration. You need to explicitly configure the build with +--enable-libzvbi. +

+ +

12.4.1 Options

+ +
+
txt_page
+

List of teletext page numbers to decode. Pages that do not match the specified +list are dropped. You may use the special * string to match all pages, +or subtitle to match all subtitle pages. +Default value is *. +

+
txt_default_region
+

Set default character set used for decoding, a value between 0 and 87 (see +ETS 300 706, Section 15, Table 32). Default value is -1, which does not +override the libzvbi default. This option is needed for some legacy level 1.0 +transmissions which cannot signal the proper charset. +

+
txt_chop_top
+

Discards the top teletext line. Default value is 1. +

+
txt_format
+

Specifies the format of the decoded subtitles. +

+
bitmap
+

The default format, you should use this for teletext pages, because certain +graphics and colors cannot be expressed in simple text or even ASS. +

+
text
+

Simple text based output without formatting. +

+
ass
+

Formatted ASS output, subtitle pages and teletext pages are returned in +different styles, subtitle pages are stripped down to text, but an effort is +made to keep the text alignment and the formatting. +

+
+
+
txt_left
+

X offset of generated bitmaps, default is 0. +

+
txt_top
+

Y offset of generated bitmaps, default is 0. +

+
txt_chop_spaces
+

Chops leading and trailing spaces and removes empty lines from the generated +text. This option is useful for teletext based subtitles where empty spaces may +be present at the start or at the end of the lines or empty lines may be +present between the subtitle lines because of double-sized teletext characters. +Default value is 1. +

+
txt_duration
+

Sets the display duration of the decoded teletext pages or subtitles in +milliseconds. Default value is -1 which means infinity or until the next +subtitle event comes. +

+
txt_transparent
+

Force transparent background of the generated teletext bitmaps. Default value +is 0 which means an opaque background. +

+
txt_opacity
+

Sets the opacity (0-255) of the teletext background. If +txt_transparent is not set, it only affects characters between a start +box and an end box, typically subtitles. Default value is 0 if +txt_transparent is set, 255 otherwise. +

+
+
+ + +

13 Bitstream Filters

+ +

When you configure your FFmpeg build, all the supported bitstream +filters are enabled by default. You can list all available ones using +the configure option --list-bsfs. +

+

You can disable all the bitstream filters using the configure option +--disable-bsfs, and selectively enable any bitstream filter using +the option --enable-bsf=BSF, or you can disable a particular +bitstream filter using the option --disable-bsf=BSF. +

+

The option -bsfs of the ff* tools will display the list of +all the supported bitstream filters included in your build. +

+

The ff* tools have a -bsf option applied per stream, taking a +comma-separated list of filters, whose parameters follow the filter +name after a ’=’. +

+
+
ffmpeg -i INPUT -c:v copy -bsf:v filter1[=opt1=str1:opt2=str2][,filter2] OUTPUT
+
+ +

Below is a description of the currently available bitstream filters, +with their parameters, if any. +

+ +

13.1 aac_adtstoasc

+ +

Convert MPEG-2/4 AAC ADTS to an MPEG-4 Audio Specific Configuration +bitstream. +

+

This filter creates an MPEG-4 AudioSpecificConfig from an MPEG-2/4 +ADTS header and removes the ADTS header. +

+

This filter is required for example when copying an AAC stream from a +raw ADTS AAC or an MPEG-TS container to MP4A-LATM, to an FLV file, or +to MOV/MP4 files and related formats such as 3GP or M4A. Please note +that it is auto-inserted for MP4A-LATM and MOV/MP4 and related formats. +

+ +

13.2 av1_metadata

+ +

Modify metadata embedded in an AV1 stream. +

+
+
td
+

Insert or remove temporal delimiter OBUs in all temporal units of the +stream. +

+
+
‘insert’
+

Insert a TD at the beginning of every TU which does not already have one. +

+
‘remove’
+

Remove the TD from the beginning of every TU which has one. +

+
+ +
+
color_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the color description fields in the stream (see AV1 section 6.4.2). +

+
+
color_range
+

Set the color range in the stream (see AV1 section 6.4.2; note that +this cannot be set for streams using BT.709 primaries, sRGB transfer +characteristic and identity (RGB) matrix coefficients). +

+
‘tv’
+

Limited range. +

+
‘pc’
+

Full range. +

+
+ +
+
chroma_sample_position
+

Set the chroma sample location in the stream (see AV1 section 6.4.2). +This can only be set for 4:2:0 streams. +

+
+
‘vertical’
+

Left position (matching the default in MPEG-2 and H.264). +

+
‘colocated’
+

Top-left position. +

+
+ +
+
tick_rate
+

Set the tick rate (num_units_in_display_tick / time_scale) in +the timing info in the sequence header. +

+
num_ticks_per_picture
+

Set the number of ticks in each picture, to indicate that the stream +has a fixed framerate. Ignored if tick_rate is not also set. +

+
+
delete_padding
+

Deletes Padding OBUs. +

+
+
+ + +

13.3 chomp

+ +

Remove zero padding at the end of a packet. +

+ +

13.4 dca_core

+ +

Extract the core from a DCA/DTS stream, dropping extensions such as +DTS-HD. +

+ +

13.5 dump_extra

+ +

Add extradata to the beginning of the filtered packets except when +said packets already exactly begin with the extradata that is intended +to be added. +

+
+
freq
+

The additional argument specifies which packets should be filtered. +It accepts the values: +

+
‘k’
+
‘keyframe’
+

add extradata to all key packets +

+
+
‘e’
+
‘all’
+

add extradata to all packets +

+
+
+
+ +

If not specified it is assumed ‘k’. +

+

For example the following ffmpeg command forces a global +header (thus disabling individual packet headers) in the H.264 packets +generated by the libx264 encoder, but corrects them by adding +the header stored in extradata to the key packets: +

+
ffmpeg -i INPUT -map 0 -flags:v +global_header -c:v libx264 -bsf:v dump_extra out.ts
+
+ + +

13.6 eac3_core

+ +

Extract the core from a E-AC-3 stream, dropping extra channels. +

+ +

13.7 extract_extradata

+ +

Extract the in-band extradata. +

+

Certain codecs allow the long-term headers (e.g. MPEG-2 sequence headers, +or H.264/HEVC (VPS/)SPS/PPS) to be transmitted either "in-band" (i.e. as a part +of the bitstream containing the coded frames) or "out of band" (e.g. on the +container level). This latter form is called "extradata" in FFmpeg terminology. +

+

This bitstream filter detects the in-band headers and makes them available as +extradata. +

+
+
remove
+

When this option is enabled, the long-term headers are removed from the +bitstream after extraction. +

+
+ + +

13.8 filter_units

+ +

Remove units with types in or not in a given set from the stream. +

+
+
pass_types
+

List of unit types or ranges of unit types to pass through while removing +all others. This is specified as a ’|’-separated list of unit type values +or ranges of values with ’-’. +

+
+
remove_types
+

Identical to pass_types, except the units in the given set +removed and all others passed through. +

+
+ +

Extradata is unchanged by this transformation, but note that if the stream +contains inline parameter sets then the output may be unusable if they are +removed. +

+

For example, to remove all non-VCL NAL units from an H.264 stream: +

+
ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=pass_types=1-5' OUTPUT
+
+ +

To remove all AUDs, SEI and filler from an H.265 stream: +

+
ffmpeg -i INPUT -c:v copy -bsf:v 'filter_units=remove_types=35|38-40' OUTPUT
+
+ + +

13.9 hapqa_extract

+ +

Extract Rgb or Alpha part of an HAPQA file, without recompression, in order to create an HAPQ or an HAPAlphaOnly file. +

+
+
texture
+

Specifies the texture to keep. +

+
+
color
+
alpha
+
+ +
+
+ +

Convert HAPQA to HAPQ +

+
ffmpeg -i hapqa_inputfile.mov -c copy -bsf:v hapqa_extract=texture=color -tag:v HapY -metadata:s:v:0 encoder="HAPQ" hapq_file.mov
+
+ +

Convert HAPQA to HAPAlphaOnly +

+
ffmpeg -i hapqa_inputfile.mov -c copy -bsf:v hapqa_extract=texture=alpha -tag:v HapA -metadata:s:v:0 encoder="HAPAlpha Only" hapalphaonly_file.mov
+
+ + +

13.10 h264_metadata

+ +

Modify metadata embedded in an H.264 stream. +

+
+
aud
+

Insert or remove AUD NAL units in all access units of the stream. +

+
+
‘insert’
+
‘remove’
+
+ +
+
sample_aspect_ratio
+

Set the sample aspect ratio of the stream in the VUI parameters. +

+
+
overscan_appropriate_flag
+

Set whether the stream is suitable for display using overscan +or not (see H.264 section E.2.1). +

+
+
video_format
+
video_full_range_flag
+

Set the video format in the stream (see H.264 section E.2.1 and +table E-2). +

+
+
colour_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the colour description in the stream (see H.264 section E.2.1 +and tables E-3, E-4 and E-5). +

+
+
chroma_sample_loc_type
+

Set the chroma sample location in the stream (see H.264 section +E.2.1 and figure E-1). +

+
+
tick_rate
+

Set the tick rate (num_units_in_tick / time_scale) in the VUI +parameters. This is the smallest time unit representable in the +stream, and in many cases represents the field rate of the stream +(double the frame rate). +

+
fixed_frame_rate_flag
+

Set whether the stream has fixed framerate - typically this indicates +that the framerate is exactly half the tick rate, but the exact +meaning is dependent on interlacing and the picture structure (see +H.264 section E.2.1 and table E-6). +

+
+
crop_left
+
crop_right
+
crop_top
+
crop_bottom
+

Set the frame cropping offsets in the SPS. These values will replace +the current ones if the stream is already cropped. +

+

These fields are set in pixels. Note that some sizes may not be +representable if the chroma is subsampled or the stream is interlaced +(see H.264 section 7.4.2.1.1). +

+
+
sei_user_data
+

Insert a string as SEI unregistered user data. The argument must +be of the form UUID+string, where the UUID is as hex digits +possibly separated by hyphens, and the string can be anything. +

+

For example, ‘086f3693-b7b3-4f2c-9653-21492feee5b8+hello’ will +insert the string “hello” associated with the given UUID. +

+
+
delete_filler
+

Deletes both filler NAL units and filler SEI messages. +

+
+
level
+

Set the level in the SPS. Refer to H.264 section A.3 and tables A-1 +to A-5. +

+

The argument must be the name of a level (for example, ‘4.2’), a +level_idc value (for example, ‘42’), or the special name ‘auto’ +indicating that the filter should attempt to guess the level from the +input stream properties. +

+
+
+ + +

13.11 h264_mp4toannexb

+ +

Convert an H.264 bitstream from length prefixed mode to start code +prefixed mode (as defined in the Annex B of the ITU-T H.264 +specification). +

+

This is required by some streaming formats, typically the MPEG-2 +transport stream format (muxer mpegts). +

+

For example to remux an MP4 file containing an H.264 stream to mpegts +format with ffmpeg, you can use the command: +

+
+
ffmpeg -i INPUT.mp4 -codec copy -bsf:v h264_mp4toannexb OUTPUT.ts
+
+ +

Please note that this filter is auto-inserted for MPEG-TS (muxer +mpegts) and raw H.264 (muxer h264) output formats. +

+ +

13.12 h264_redundant_pps

+ +

This applies a specific fixup to some Blu-ray streams which contain +redundant PPSs modifying irrelevant parameters of the stream which +confuse other transformations which require correct extradata. +

+

A new single global PPS is created, and all of the redundant PPSs +within the stream are removed. +

+ +

13.13 hevc_metadata

+ +

Modify metadata embedded in an HEVC stream. +

+
+
aud
+

Insert or remove AUD NAL units in all access units of the stream. +

+
+
‘insert’
+
‘remove’
+
+ +
+
sample_aspect_ratio
+

Set the sample aspect ratio in the stream in the VUI parameters. +

+
+
video_format
+
video_full_range_flag
+

Set the video format in the stream (see H.265 section E.3.1 and +table E.2). +

+
+
colour_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the colour description in the stream (see H.265 section E.3.1 +and tables E.3, E.4 and E.5). +

+
+
chroma_sample_loc_type
+

Set the chroma sample location in the stream (see H.265 section +E.3.1 and figure E.1). +

+
+
tick_rate
+

Set the tick rate in the VPS and VUI parameters (num_units_in_tick / +time_scale). Combined with num_ticks_poc_diff_one, this can +set a constant framerate in the stream. Note that it is likely to be +overridden by container parameters when the stream is in a container. +

+
+
num_ticks_poc_diff_one
+

Set poc_proportional_to_timing_flag in VPS and VUI and use this value +to set num_ticks_poc_diff_one_minus1 (see H.265 sections 7.4.3.1 and +E.3.1). Ignored if tick_rate is not also set. +

+
+
crop_left
+
crop_right
+
crop_top
+
crop_bottom
+

Set the conformance window cropping offsets in the SPS. These values +will replace the current ones if the stream is already cropped. +

+

These fields are set in pixels. Note that some sizes may not be +representable if the chroma is subsampled (H.265 section 7.4.3.2.1). +

+
+
level
+

Set the level in the VPS and SPS. See H.265 section A.4 and tables +A.6 and A.7. +

+

The argument must be the name of a level (for example, ‘5.1’), a +general_level_idc value (for example, ‘153’ for level 5.1), +or the special name ‘auto’ indicating that the filter should +attempt to guess the level from the input stream properties. +

+
+
+ + +

13.14 hevc_mp4toannexb

+ +

Convert an HEVC/H.265 bitstream from length prefixed mode to start code +prefixed mode (as defined in the Annex B of the ITU-T H.265 +specification). +

+

This is required by some streaming formats, typically the MPEG-2 +transport stream format (muxer mpegts). +

+

For example to remux an MP4 file containing an HEVC stream to mpegts +format with ffmpeg, you can use the command: +

+
+
ffmpeg -i INPUT.mp4 -codec copy -bsf:v hevc_mp4toannexb OUTPUT.ts
+
+ +

Please note that this filter is auto-inserted for MPEG-TS (muxer +mpegts) and raw HEVC/H.265 (muxer h265 or +hevc) output formats. +

+ +

13.15 imxdump

+ +

Modifies the bitstream to fit in MOV and to be usable by the Final Cut +Pro decoder. This filter only applies to the mpeg2video codec, and is +likely not needed for Final Cut Pro 7 and newer with the appropriate +-tag:v. +

+

For example, to remux 30 MB/sec NTSC IMX to MOV: +

+
+
ffmpeg -i input.mxf -c copy -bsf:v imxdump -tag:v mx3n output.mov
+
+ + +

13.16 mjpeg2jpeg

+ +

Convert MJPEG/AVI1 packets to full JPEG/JFIF packets. +

+

MJPEG is a video codec wherein each video frame is essentially a +JPEG image. The individual frames can be extracted without loss, +e.g. by +

+
+
ffmpeg -i ../some_mjpeg.avi -c:v copy frames_%d.jpg
+
+ +

Unfortunately, these chunks are incomplete JPEG images, because +they lack the DHT segment required for decoding. Quoting from +http://www.digitalpreservation.gov/formats/fdd/fdd000063.shtml: +

+

Avery Lee, writing in the rec.video.desktop newsgroup in 2001, +commented that "MJPEG, or at least the MJPEG in AVIs having the +MJPG fourcc, is restricted JPEG with a fixed – and *omitted* – +Huffman table. The JPEG must be YCbCr colorspace, it must be 4:2:2, +and it must use basic Huffman encoding, not arithmetic or +progressive. . . . You can indeed extract the MJPEG frames and +decode them with a regular JPEG decoder, but you have to prepend +the DHT segment to them, or else the decoder won’t have any idea +how to decompress the data. The exact table necessary is given in +the OpenDML spec." +

+

This bitstream filter patches the header of frames extracted from an MJPEG +stream (carrying the AVI1 header ID and lacking a DHT segment) to +produce fully qualified JPEG images. +

+
+
ffmpeg -i mjpeg-movie.avi -c:v copy -bsf:v mjpeg2jpeg frame_%d.jpg
+exiftran -i -9 frame*.jpg
+ffmpeg -i frame_%d.jpg -c:v copy rotated.avi
+
+ + +

13.17 mjpegadump

+ +

Add an MJPEG A header to the bitstream, to enable decoding by +Quicktime. +

+ +

13.18 mov2textsub

+ +

Extract a representable text file from MOV subtitles, stripping the +metadata header from each subtitle packet. +

+

See also the text2movsub filter. +

+ +

13.19 mp3decomp

+ +

Decompress non-standard compressed MP3 audio headers. +

+ +

13.20 mpeg2_metadata

+ +

Modify metadata embedded in an MPEG-2 stream. +

+
+
display_aspect_ratio
+

Set the display aspect ratio in the stream. +

+

The following fixed values are supported: +

+
4/3
+
16/9
+
221/100
+
+

Any other value will result in square pixels being signalled instead +(see H.262 section 6.3.3 and table 6-3). +

+
+
frame_rate
+

Set the frame rate in the stream. This is constructed from a table +of known values combined with a small multiplier and divisor - if +the supplied value is not exactly representable, the nearest +representable value will be used instead (see H.262 section 6.3.3 +and table 6-4). +

+
+
video_format
+

Set the video format in the stream (see H.262 section 6.3.6 and +table 6-6). +

+
+
colour_primaries
+
transfer_characteristics
+
matrix_coefficients
+

Set the colour description in the stream (see H.262 section 6.3.6 +and tables 6-7, 6-8 and 6-9). +

+
+
+ + +

13.21 mpeg4_unpack_bframes

+ +

Unpack DivX-style packed B-frames. +

+

DivX-style packed B-frames are not valid MPEG-4 and were only a +workaround for the broken Video for Windows subsystem. +They use more space, can cause minor AV sync issues, require more +CPU power to decode (unless the player has some decoded picture queue +to compensate the 2,0,2,0 frame per packet style) and cause +trouble if copied into a standard container like mp4 or mpeg-ps/ts, +because MPEG-4 decoders may not be able to decode them, since they are +not valid MPEG-4. +

+

For example to fix an AVI file containing an MPEG-4 stream with +DivX-style packed B-frames using ffmpeg, you can use the command: +

+
+
ffmpeg -i INPUT.avi -codec copy -bsf:v mpeg4_unpack_bframes OUTPUT.avi
+
+ + +

13.22 noise

+ +

Damages the contents of packets or simply drops them without damaging the +container. Can be used for fuzzing or testing error resilience/concealment. +

+

Parameters: +

+
amount
+

A numeral string, whose value is related to how often output bytes will +be modified. Therefore, values below or equal to 0 are forbidden, and +the lower the more frequent bytes will be modified, with 1 meaning +every byte is modified. +

+
dropamount
+

A numeral string, whose value is related to how often packets will be dropped. +Therefore, values below or equal to 0 are forbidden, and the lower the more +frequent packets will be dropped, with 1 meaning every packet is dropped. +

+
+ +

The following example applies the modification to every byte but does not drop +any packets. +

+
ffmpeg -i INPUT -c copy -bsf noise[=1] output.mkv
+
+ + +

13.23 null

+

This bitstream filter passes the packets through unchanged. +

+ +

13.24 pcm_rechunk

+ +

Repacketize PCM audio to a fixed number of samples per packet or a fixed packet +rate per second. This is similar to the (ffmpeg-filters)asetnsamples audio +filter but works on audio packets instead of audio frames. +

+
+
nb_out_samples, n
+

Set the number of samples per each output audio packet. The number is intended +as the number of samples per each channel. Default value is 1024. +

+
+
pad, p
+

If set to 1, the filter will pad the last audio packet with silence, so that it +will contain the same number of samples (or roughly the same number of samples, +see frame_rate) as the previous ones. Default value is 1. +

+
+
frame_rate, r
+

This option makes the filter output a fixed number of packets per second instead +of a fixed number of samples per packet. If the audio sample rate is not +divisible by the frame rate then the number of samples will not be constant but +will vary slightly so that each packet will start as close to the frame +boundary as possible. Using this option has precedence over nb_out_samples. +

+
+ +

You can generate the well known 1602-1601-1602-1601-1602 pattern of 48kHz audio +for NTSC frame rate using the frame_rate option. +

+
ffmpeg -f lavfi -i sine=r=48000:d=1 -c pcm_s16le -bsf pcm_rechunk=r=30000/1001 -f framecrc -
+
+ + +

13.25 prores_metadata

+ +

Modify color property metadata embedded in prores stream. +

+
+
color_primaries
+

Set the color primaries. +Available values are: +

+
+
‘auto’
+

Keep the same color primaries property (default). +

+
+
‘unknown’
+
‘bt709’
+
‘bt470bg’
+

BT601 625 +

+
+
‘smpte170m’
+

BT601 525 +

+
+
‘bt2020’
+
‘smpte431’
+

DCI P3 +

+
+
‘smpte432’
+

P3 D65 +

+
+
+ +
+
transfer_characteristics
+

Set the color transfer. +Available values are: +

+
+
‘auto’
+

Keep the same transfer characteristics property (default). +

+
+
‘unknown’
+
‘bt709’
+

BT 601, BT 709, BT 2020 +

+
‘smpte2084’
+

SMPTE ST 2084 +

+
‘arib-std-b67’
+

ARIB STD-B67 +

+
+ + +
+
matrix_coefficients
+

Set the matrix coefficient. +Available values are: +

+
+
‘auto’
+

Keep the same colorspace property (default). +

+
+
‘unknown’
+
‘bt709’
+
‘smpte170m’
+

BT 601 +

+
+
‘bt2020nc’
+
+
+
+ +

Set Rec709 colorspace for each frame of the file +

+
ffmpeg -i INPUT -c copy -bsf:v prores_metadata=color_primaries=bt709:color_trc=bt709:colorspace=bt709 output.mov
+
+ +

Set Hybrid Log-Gamma parameters for each frame of the file +

+
ffmpeg -i INPUT -c copy -bsf:v prores_metadata=color_primaries=bt2020:color_trc=arib-std-b67:colorspace=bt2020nc output.mov
+
+ + +

13.26 remove_extra

+ +

Remove extradata from packets. +

+

It accepts the following parameter: +

+
freq
+

Set which frame types to remove extradata from. +

+
+
‘k’
+

Remove extradata from non-keyframes only. +

+
+
‘keyframe’
+

Remove extradata from keyframes only. +

+
+
‘e, all’
+

Remove extradata from all frames. +

+
+
+
+
+ + +

13.27 text2movsub

+ +

Convert text subtitles to MOV subtitles (as used by the mov_text +codec) with metadata headers. +

+

See also the mov2textsub filter. +

+ +

13.28 trace_headers

+ +

Log trace output containing all syntax elements in the coded stream +headers (everything above the level of individual coded blocks). +This can be useful for debugging low-level stream issues. +

+

Supports AV1, H.264, H.265, (M)JPEG, MPEG-2 and VP9, but depending +on the build only a subset of these may be available. +

+ +

13.29 truehd_core

+ +

Extract the core from a TrueHD stream, dropping ATMOS data. +

+ +

13.30 vp9_metadata

+ +

Modify metadata embedded in a VP9 stream. +

+
+
color_space
+

Set the color space value in the frame header. Note that any frame +set to RGB will be implicitly set to PC range and that RGB is +incompatible with profiles 0 and 2. +

+
‘unknown’
+
‘bt601’
+
‘bt709’
+
‘smpte170’
+
‘smpte240’
+
‘bt2020’
+
‘rgb’
+
+ +
+
color_range
+

Set the color range value in the frame header. Note that any value +imposed by the color space will take precedence over this value. +

+
‘tv’
+
‘pc’
+
+
+
+ + +

13.31 vp9_superframe

+ +

Merge VP9 invisible (alt-ref) frames back into VP9 superframes. This +fixes merging of split/segmented VP9 streams where the alt-ref frame +was split from its visible counterpart. +

+ +

13.32 vp9_superframe_split

+ +

Split VP9 superframes into single frames. +

+ +

13.33 vp9_raw_reorder

+ +

Given a VP9 stream with correct timestamps but possibly out of order, +insert additional show-existing-frame packets to correct the ordering. +

+ +

14 Format Options

+ +

The libavformat library provides some generic global options, which +can be set on all the muxers and demuxers. In addition each muxer or +demuxer may support so-called private options, which are specific for +that component. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the +AVFormatContext options or using the libavutil/opt.h API +for programmatic use. +

+

The list of supported options follows: +

+
+
avioflags flags (input/output)
+

Possible values: +

+
‘direct’
+

Reduce buffering. +

+
+ +
+
probesize integer (input)
+

Set probing size in bytes, i.e. the size of the data to analyze to get +stream information. A higher value will enable detecting more +information in case it is dispersed into the stream, but will increase +latency. Must be an integer not lesser than 32. It is 5000000 by default. +

+
+
max_probe_packets integer (input)
+

Set the maximum number of buffered packets when probing a codec. +Default is 2500 packets. +

+
+
packetsize integer (output)
+

Set packet size. +

+
+
fflags flags
+

Set format flags. Some are implemented for a limited number of formats. +

+

Possible values for input files: +

+
‘discardcorrupt’
+

Discard corrupted packets. +

+
‘fastseek’
+

Enable fast, but inaccurate seeks for some formats. +

+
‘genpts’
+

Generate missing PTS if DTS is present. +

+
‘igndts’
+

Ignore DTS if PTS is set. Inert when nofillin is set. +

+
‘ignidx’
+

Ignore index. +

+
‘keepside (deprecated,inert)’
+
‘nobuffer’
+

Reduce the latency introduced by buffering during initial input streams analysis. +

+
‘nofillin’
+

Do not fill in missing values in packet fields that can be exactly calculated. +

+
‘noparse’
+

Disable AVParsers, this needs +nofillin too. +

+
‘sortdts’
+

Try to interleave output packets by DTS. At present, available only for AVIs with an index. +

+
+ +

Possible values for output files: +

+
‘autobsf’
+

Automatically apply bitstream filters as required by the output format. Enabled by default. +

+
‘bitexact’
+

Only write platform-, build- and time-independent data. +This ensures that file and data checksums are reproducible and match between +platforms. Its primary use is for regression testing. +

+
‘flush_packets’
+

Write out packets immediately. +

+
‘latm (deprecated,inert)’
+
‘shortest’
+

Stop muxing at the end of the shortest stream. +It may be needed to increase max_interleave_delta to avoid flushing the longer +streams before EOF. +

+
+ +
+
seek2any integer (input)
+

Allow seeking to non-keyframes on demuxer level when supported if set to 1. +Default is 0. +

+
+
analyzeduration integer (input)
+

Specify how many microseconds are analyzed to probe the input. A +higher value will enable detecting more accurate information, but will +increase latency. It defaults to 5,000,000 microseconds = 5 seconds. +

+
+
cryptokey hexadecimal string (input)
+

Set decryption key. +

+
+
indexmem integer (input)
+

Set max memory used for timestamp index (per stream). +

+
+
rtbufsize integer (input)
+

Set max memory used for buffering real-time frames. +

+
+
fdebug flags (input/output)
+

Print specific debug info. +

+

Possible values: +

+
‘ts’
+
+ +
+
max_delay integer (input/output)
+

Set maximum muxing or demuxing delay in microseconds. +

+
+
fpsprobesize integer (input)
+

Set number of frames used to probe fps. +

+
+
audio_preload integer (output)
+

Set microseconds by which audio packets should be interleaved earlier. +

+
+
chunk_duration integer (output)
+

Set microseconds for each chunk. +

+
+
chunk_size integer (output)
+

Set size in bytes for each chunk. +

+
+
err_detect, f_err_detect flags (input)
+

Set error detection flags. f_err_detect is deprecated and +should be used only via the ffmpeg tool. +

+

Possible values: +

+
‘crccheck’
+

Verify embedded CRCs. +

+
‘bitstream’
+

Detect bitstream specification deviations. +

+
‘buffer’
+

Detect improper bitstream length. +

+
‘explode’
+

Abort decoding on minor error detection. +

+
‘careful’
+

Consider things that violate the spec and have not been seen in the +wild as errors. +

+
‘compliant’
+

Consider all spec non compliancies as errors. +

+
‘aggressive’
+

Consider things that a sane encoder should not do as an error. +

+
+ +
+
max_interleave_delta integer (output)
+

Set maximum buffering duration for interleaving. The duration is +expressed in microseconds, and defaults to 10000000 (10 seconds). +

+

To ensure all the streams are interleaved correctly, libavformat will +wait until it has at least one packet for each stream before actually +writing any packets to the output file. When some streams are +"sparse" (i.e. there are large gaps between successive packets), this +can result in excessive buffering. +

+

This field specifies the maximum difference between the timestamps of the +first and the last packet in the muxing queue, above which libavformat +will output a packet regardless of whether it has queued a packet for all +the streams. +

+

If set to 0, libavformat will continue buffering packets until it has +a packet for each stream, regardless of the maximum timestamp +difference between the buffered packets. +

+
+
use_wallclock_as_timestamps integer (input)
+

Use wallclock as timestamps if set to 1. Default is 0. +

+
+
avoid_negative_ts integer (output)
+
+

Possible values: +

+
‘make_non_negative’
+

Shift timestamps to make them non-negative. +Also note that this affects only leading negative timestamps, and not +non-monotonic negative timestamps. +

+
‘make_zero’
+

Shift timestamps so that the first timestamp is 0. +

+
‘auto (default)’
+

Enables shifting when required by the target format. +

+
‘disabled’
+

Disables shifting of timestamp. +

+
+ +

When shifting is enabled, all output timestamps are shifted by the +same amount. Audio, video, and subtitles desynching and relative +timestamp differences are preserved compared to how they would have +been without shifting. +

+
+
skip_initial_bytes integer (input)
+

Set number of bytes to skip before reading header and frames if set to 1. +Default is 0. +

+
+
correct_ts_overflow integer (input)
+

Correct single timestamp overflows if set to 1. Default is 1. +

+
+
flush_packets integer (output)
+

Flush the underlying I/O stream after each packet. Default is -1 (auto), which +means that the underlying protocol will decide, 1 enables it, and has the +effect of reducing the latency, 0 disables it and may increase IO throughput in +some cases. +

+
+
output_ts_offset offset (output)
+

Set the output time offset. +

+

offset must be a time duration specification, +see (ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+

The offset is added by the muxer to the output timestamps. +

+

Specifying a positive offset means that the corresponding streams are +delayed bt the time duration specified in offset. Default value +is 0 (meaning that no offset is applied). +

+
+
format_whitelist list (input)
+

"," separated list of allowed demuxers. By default all are allowed. +

+
+
dump_separator string (input)
+

Separator used to separate the fields printed on the command line about the +Stream parameters. +For example, to separate the fields with newlines and indentation: +

+
ffprobe -dump_separator "
+                          "  -i ~/videos/matrixbench_mpeg2.mpg
+
+ +
+
max_streams integer (input)
+

Specifies the maximum number of streams. This can be used to reject files that +would require too many resources due to a large number of streams. +

+
+
skip_estimate_duration_from_pts bool (input)
+

Skip estimation of input duration when calculated using PTS. +At present, applicable for MPEG-PS and MPEG-TS. +

+
+
strict, f_strict integer (input/output)
+

Specify how strictly to follow the standards. f_strict is deprecated and +should be used only via the ffmpeg tool. +

+

Possible values: +

+
‘very’
+

strictly conform to an older more strict version of the spec or reference software +

+
‘strict’
+

strictly conform to all the things in the spec no matter what consequences +

+
‘normal’
+
‘unofficial’
+

allow unofficial extensions +

+
‘experimental’
+

allow non standardized experimental things, experimental +(unfinished/work in progress/not well tested) decoders and encoders. +Note: experimental decoders can pose a security risk, do not use this for +decoding untrusted input. +

+
+ +
+
+ + + +

14.1 Format stream specifiers

+ +

Format stream specifiers allow selection of one or more streams that +match specific properties. +

+

The exact semantics of stream specifiers is defined by the +avformat_match_stream_specifier() function declared in the +libavformat/avformat.h header and documented in the +(ffmpeg)Stream specifiers section in the ffmpeg(1) manual. +

+ +

15 Demuxers

+ +

Demuxers are configured elements in FFmpeg that can read the +multimedia streams from a particular type of file. +

+

When you configure your FFmpeg build, all the supported demuxers +are enabled by default. You can list all available ones using the +configure option --list-demuxers. +

+

You can disable all the demuxers using the configure option +--disable-demuxers, and selectively enable a single demuxer with +the option --enable-demuxer=DEMUXER, or disable it +with the option --disable-demuxer=DEMUXER. +

+

The option -demuxers of the ff* tools will display the list of +enabled demuxers. Use -formats to view a combined list of +enabled demuxers and muxers. +

+

The description of some of the currently available demuxers follows. +

+ +

15.1 aa

+ +

Audible Format 2, 3, and 4 demuxer. +

+

This demuxer is used to demux Audible Format 2, 3, and 4 (.aa) files. +

+ +

15.2 apng

+ +

Animated Portable Network Graphics demuxer. +

+

This demuxer is used to demux APNG files. +All headers, but the PNG signature, up to (but not including) the first +fcTL chunk are transmitted as extradata. +Frames are then split as being all the chunks between two fcTL ones, or +between the last fcTL and IEND chunks. +

+
+
-ignore_loop bool
+

Ignore the loop variable in the file if set. +

+
-max_fps int
+

Maximum framerate in frames per second (0 for no limit). +

+
-default_fps int
+

Default framerate in frames per second when none is specified in the file +(0 meaning as fast as possible). +

+
+ + +

15.3 asf

+ +

Advanced Systems Format demuxer. +

+

This demuxer is used to demux ASF files and MMS network streams. +

+
+
-no_resync_search bool
+

Do not try to resynchronize by looking for a certain optional start code. +

+
+ + +

15.4 concat

+ +

Virtual concatenation script demuxer. +

+

This demuxer reads a list of files and other directives from a text file and +demuxes them one after the other, as if all their packets had been muxed +together. +

+

The timestamps in the files are adjusted so that the first file starts at 0 +and each next file starts where the previous one finishes. Note that it is +done globally and may cause gaps if all streams do not have exactly the same +length. +

+

All files must have the same streams (same codecs, same time base, etc.). +

+

The duration of each file is used to adjust the timestamps of the next file: +if the duration is incorrect (because it was computed using the bit-rate or +because the file is truncated, for example), it can cause artifacts. The +duration directive can be used to override the duration stored in +each file. +

+ +

15.4.1 Syntax

+ +

The script is a text file in extended-ASCII, with one directive per line. +Empty lines, leading spaces and lines starting with ’#’ are ignored. The +following directive is recognized: +

+
+
file path
+

Path to a file to read; special characters and spaces must be escaped with +backslash or single quotes. +

+

All subsequent file-related directives apply to that file. +

+
+
ffconcat version 1.0
+

Identify the script type and version. It also sets the safe option +to 1 if it was -1. +

+

To make FFmpeg recognize the format automatically, this directive must +appear exactly as is (no extra space or byte-order-mark) on the very first +line of the script. +

+
+
duration dur
+

Duration of the file. This information can be specified from the file; +specifying it here may be more efficient or help if the information from the +file is not available or accurate. +

+

If the duration is set for all files, then it is possible to seek in the +whole concatenated video. +

+
+
inpoint timestamp
+

In point of the file. When the demuxer opens the file it instantly seeks to the +specified timestamp. Seeking is done so that all streams can be presented +successfully at In point. +

+

This directive works best with intra frame codecs, because for non-intra frame +ones you will usually get extra packets before the actual In point and the +decoded content will most likely contain frames before In point too. +

+

For each file, packets before the file In point will have timestamps less than +the calculated start timestamp of the file (negative in case of the first +file), and the duration of the files (if not specified by the duration +directive) will be reduced based on their specified In point. +

+

Because of potential packets before the specified In point, packet timestamps +may overlap between two concatenated files. +

+
+
outpoint timestamp
+

Out point of the file. When the demuxer reaches the specified decoding +timestamp in any of the streams, it handles it as an end of file condition and +skips the current and all the remaining packets from all streams. +

+

Out point is exclusive, which means that the demuxer will not output packets +with a decoding timestamp greater or equal to Out point. +

+

This directive works best with intra frame codecs and formats where all streams +are tightly interleaved. For non-intra frame codecs you will usually get +additional packets with presentation timestamp after Out point therefore the +decoded content will most likely contain frames after Out point too. If your +streams are not tightly interleaved you may not get all the packets from all +streams before Out point and you may only will be able to decode the earliest +stream until Out point. +

+

The duration of the files (if not specified by the duration +directive) will be reduced based on their specified Out point. +

+
+
file_packet_metadata key=value
+

Metadata of the packets of the file. The specified metadata will be set for +each file packet. You can specify this directive multiple times to add multiple +metadata entries. +

+
+
stream
+

Introduce a stream in the virtual file. +All subsequent stream-related directives apply to the last introduced +stream. +Some streams properties must be set in order to allow identifying the +matching streams in the subfiles. +If no streams are defined in the script, the streams from the first file are +copied. +

+
+
exact_stream_id id
+

Set the id of the stream. +If this directive is given, the string with the corresponding id in the +subfiles will be used. +This is especially useful for MPEG-PS (VOB) files, where the order of the +streams is not reliable. +

+
+
+ + +

15.4.2 Options

+ +

This demuxer accepts the following option: +

+
+
safe
+

If set to 1, reject unsafe file paths. A file path is considered safe if it +does not contain a protocol specification and is relative and all components +only contain characters from the portable character set (letters, digits, +period, underscore and hyphen) and have no period at the beginning of a +component. +

+

If set to 0, any file name is accepted. +

+

The default is 1. +

+

-1 is equivalent to 1 if the format was automatically +probed and 0 otherwise. +

+
+
auto_convert
+

If set to 1, try to perform automatic conversions on packet data to make the +streams concatenable. +The default is 1. +

+

Currently, the only conversion is adding the h264_mp4toannexb bitstream +filter to H.264 streams in MP4 format. This is necessary in particular if +there are resolution changes. +

+
+
segment_time_metadata
+

If set to 1, every packet will contain the lavf.concat.start_time and the +lavf.concat.duration packet metadata values which are the start_time and +the duration of the respective file segments in the concatenated output +expressed in microseconds. The duration metadata is only set if it is known +based on the concat file. +The default is 0. +

+
+
+ + +

15.4.3 Examples

+ +
    +
  • Use absolute filenames and include some comments: +
    +
    # my first filename
+file /mnt/share/file-1.wav
+# my second filename including whitespace
+file '/mnt/share/file 2.wav'
+# my third filename including whitespace plus single quote
+file '/mnt/share/file 3'\''.wav'
+
    + +
  • Allow for input format auto-probing, use safe filenames and set the duration of +the first file: +
    +
    ffconcat version 1.0
+
+file file-1.wav
+duration 20.0
+
+file subdir/file-2.wav
+
    +
+ + +

15.5 dash

+ +

Dynamic Adaptive Streaming over HTTP demuxer. +

+

This demuxer presents all AVStreams found in the manifest. +By setting the discard flags on AVStreams the caller can decide +which streams to actually receive. +Each stream mirrors the id and bandwidth properties from the +<Representation> as metadata keys named "id" and "variant_bitrate" respectively. +

+ +

15.6 flv, live_flv

+ +

Adobe Flash Video Format demuxer. +

+

This demuxer is used to demux FLV files and RTMP network streams. In case of live network streams, if you force format, you may use live_flv option instead of flv to survive timestamp discontinuities. +

+
+
ffmpeg -f flv -i myfile.flv ...
+ffmpeg -f live_flv -i rtmp://<any.server>/anything/key ....
+
+ + +
+
-flv_metadata bool
+

Allocate the streams according to the onMetaData array content. +

+
+
-flv_ignore_prevtag bool
+

Ignore the size of previous tag value. +

+
+
-flv_full_metadata bool
+

Output all context of the onMetadata. +

+
+ + +

15.7 gif

+ +

Animated GIF demuxer. +

+

It accepts the following options: +

+
+
min_delay
+

Set the minimum valid delay between frames in hundredths of seconds. +Range is 0 to 6000. Default value is 2. +

+
+
max_gif_delay
+

Set the maximum valid delay between frames in hundredth of seconds. +Range is 0 to 65535. Default value is 65535 (nearly eleven minutes), +the maximum value allowed by the specification. +

+
+
default_delay
+

Set the default delay between frames in hundredths of seconds. +Range is 0 to 6000. Default value is 10. +

+
+
ignore_loop
+

GIF files can contain information to loop a certain number of times (or +infinitely). If ignore_loop is set to 1, then the loop setting +from the input will be ignored and looping will not occur. If set to 0, +then looping will occur and will cycle the number of times according to +the GIF. Default value is 1. +

+
+ +

For example, with the overlay filter, place an infinitely looping GIF +over another video: +

+
ffmpeg -i input.mp4 -ignore_loop 0 -i input.gif -filter_complex overlay=shortest=1 out.mkv
+
+ +

Note that in the above example the shortest option for overlay filter is +used to end the output video at the length of the shortest input file, +which in this case is input.mp4 as the GIF in this example loops +infinitely. +

+ +

15.8 hls

+ +

HLS demuxer +

+

Apple HTTP Live Streaming demuxer. +

+

This demuxer presents all AVStreams from all variant streams. +The id field is set to the bitrate variant index number. By setting +the discard flags on AVStreams (by pressing ’a’ or ’v’ in ffplay), +the caller can decide which variant streams to actually receive. +The total bitrate of the variant that the stream belongs to is +available in a metadata key named "variant_bitrate". +

+

It accepts the following options: +

+
+
live_start_index
+

segment index to start live streams at (negative values are from the end). +

+
+
allowed_extensions
+

’,’ separated list of file extensions that hls is allowed to access. +

+
+
max_reload
+

Maximum number of times a insufficient list is attempted to be reloaded. +Default value is 1000. +

+
+
m3u8_hold_counters
+

The maximum number of times to load m3u8 when it refreshes without new segments. +Default value is 1000. +

+
+
http_persistent
+

Use persistent HTTP connections. Applicable only for HTTP streams. +Enabled by default. +

+
+
http_multiple
+

Use multiple HTTP connections for downloading HTTP segments. +Enabled by default for HTTP/1.1 servers. +

+
+
http_seekable
+

Use HTTP partial requests for downloading HTTP segments. +0 = disable, 1 = enable, -1 = auto, Default is auto. +

+
+ + +

15.9 image2

+ +

Image file demuxer. +

+

This demuxer reads from a list of image files specified by a pattern. +The syntax and meaning of the pattern is specified by the +option pattern_type. +

+

The pattern may contain a suffix which is used to automatically +determine the format of the images contained in the files. +

+

The size, the pixel format, and the format of each image must be the +same for all the files in the sequence. +

+

This demuxer accepts the following options: +

+
framerate
+

Set the frame rate for the video stream. It defaults to 25. +

+
loop
+

If set to 1, loop over the input. Default value is 0. +

+
pattern_type
+

Select the pattern type used to interpret the provided filename. +

+

pattern_type accepts one of the following values. +

+
none
+

Disable pattern matching, therefore the video will only contain the specified +image. You should use this option if you do not want to create sequences from +multiple images and your filenames may contain special pattern characters. +

+
sequence
+

Select a sequence pattern type, used to specify a sequence of files +indexed by sequential numbers. +

+

A sequence pattern may contain the string "%d" or "%0Nd", which +specifies the position of the characters representing a sequential +number in each filename matched by the pattern. If the form +"%d0Nd" is used, the string representing the number in each +filename is 0-padded and N is the total number of 0-padded +digits representing the number. The literal character ’%’ can be +specified in the pattern with the string "%%". +

+

If the sequence pattern contains "%d" or "%0Nd", the first filename of +the file list specified by the pattern must contain a number +inclusively contained between start_number and +start_number+start_number_range-1, and all the following +numbers must be sequential. +

+

For example the pattern "img-%03d.bmp" will match a sequence of +filenames of the form img-001.bmp, img-002.bmp, ..., +img-010.bmp, etc.; the pattern "i%%m%%g-%d.jpg" will match a +sequence of filenames of the form i%m%g-1.jpg, +i%m%g-2.jpg, ..., i%m%g-10.jpg, etc. +

+

Note that the pattern must not necessarily contain "%d" or +"%0Nd", for example to convert a single image file +img.jpeg you can employ the command: +

+
ffmpeg -i img.jpeg img.png
+
+ +
+
glob
+

Select a glob wildcard pattern type. +

+

The pattern is interpreted like a glob() pattern. This is only +selectable if libavformat was compiled with globbing support. +

+
+
glob_sequence (deprecated, will be removed)
+

Select a mixed glob wildcard/sequence pattern. +

+

If your version of libavformat was compiled with globbing support, and +the provided pattern contains at least one glob meta character among +%*?[]{} that is preceded by an unescaped "%", the pattern is +interpreted like a glob() pattern, otherwise it is interpreted +like a sequence pattern. +

+

All glob special characters %*?[]{} must be prefixed +with "%". To escape a literal "%" you shall use "%%". +

+

For example the pattern foo-%*.jpeg will match all the +filenames prefixed by "foo-" and terminating with ".jpeg", and +foo-%?%?%?.jpeg will match all the filenames prefixed with +"foo-", followed by a sequence of three characters, and terminating +with ".jpeg". +

+

This pattern type is deprecated in favor of glob and +sequence. +

+
+ +

Default value is glob_sequence. +

+
pixel_format
+

Set the pixel format of the images to read. If not specified the pixel +format is guessed from the first image file in the sequence. +

+
start_number
+

Set the index of the file matched by the image file pattern to start +to read from. Default value is 0. +

+
start_number_range
+

Set the index interval range to check when looking for the first image +file in the sequence, starting from start_number. Default value +is 5. +

+
ts_from_file
+

If set to 1, will set frame timestamp to modification time of image file. Note +that monotonity of timestamps is not provided: images go in the same order as +without this option. Default value is 0. +If set to 2, will set frame timestamp to the modification time of the image file in +nanosecond precision. +

+
video_size
+

Set the video size of the images to read. If not specified the video +size is guessed from the first image file in the sequence. +

+
export_path_metadata
+

If set to 1, will add two extra fields to the metadata found in input, making them +also available for other filters (see drawtext filter for examples). Default +value is 0. The extra fields are described below: +

+
lavf.image2dec.source_path
+

Corresponds to the full path to the input file being read. +

+
lavf.image2dec.source_basename
+

Corresponds to the name of the file being read. +

+
+ +
+
+ + +

15.9.1 Examples

+ +
    +
  • Use ffmpeg for creating a video from the images in the file +sequence img-001.jpeg, img-002.jpeg, ..., assuming an +input frame rate of 10 frames per second: +
    +
    ffmpeg -framerate 10 -i 'img-%03d.jpeg' out.mkv
+
    + +
  • As above, but start by reading from a file with index 100 in the sequence: +
    +
    ffmpeg -framerate 10 -start_number 100 -i 'img-%03d.jpeg' out.mkv
+
    + +
  • Read images matching the "*.png" glob pattern , that is all the files +terminating with the ".png" suffix: +
    +
    ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
+
    +
+ + +

15.10 libgme

+ +

The Game Music Emu library is a collection of video game music file emulators. +

+

See https://bitbucket.org/mpyne/game-music-emu/overview for more information. +

+

It accepts the following options: +

+
+
track_index
+

Set the index of which track to demux. The demuxer can only export one track. +Track indexes start at 0. Default is to pick the first track. Number of tracks +is exported as tracks metadata entry. +

+
+
sample_rate
+

Set the sampling rate of the exported track. Range is 1000 to 999999. Default is 44100. +

+
+
max_size (bytes)
+

The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size, +which in turn, acts as a ceiling for the size of files that can be read. +Default is 50 MiB. +

+
+
+ + +

15.11 libmodplug

+ +

ModPlug based module demuxer +

+

See https://github.com/Konstanty/libmodplug +

+

It will export one 2-channel 16-bit 44.1 kHz audio stream. +Optionally, a pal8 16-color video stream can be exported with or without printed metadata. +

+

It accepts the following options: +

+
+
noise_reduction
+

Apply a simple low-pass filter. Can be 1 (on) or 0 (off). Default is 0. +

+
+
reverb_depth
+

Set amount of reverb. Range 0-100. Default is 0. +

+
+
reverb_delay
+

Set delay in ms, clamped to 40-250 ms. Default is 0. +

+
+
bass_amount
+

Apply bass expansion a.k.a. XBass or megabass. Range is 0 (quiet) to 100 (loud). Default is 0. +

+
+
bass_range
+

Set cutoff i.e. upper-bound for bass frequencies. Range is 10-100 Hz. Default is 0. +

+
+
surround_depth
+

Apply a Dolby Pro-Logic surround effect. Range is 0 (quiet) to 100 (heavy). Default is 0. +

+
+
surround_delay
+

Set surround delay in ms, clamped to 5-40 ms. Default is 0. +

+
+
max_size
+

The demuxer buffers the entire file into memory. Adjust this value to set the maximum buffer size, +which in turn, acts as a ceiling for the size of files that can be read. Range is 0 to 100 MiB. +0 removes buffer size limit (not recommended). Default is 5 MiB. +

+
+
video_stream_expr
+

String which is evaluated using the eval API to assign colors to the generated video stream. +Variables which can be used are x, y, w, h, t, speed, +tempo, order, pattern and row. +

+
+
video_stream
+

Generate video stream. Can be 1 (on) or 0 (off). Default is 0. +

+
+
video_stream_w
+

Set video frame width in ’chars’ where one char indicates 8 pixels. Range is 20-512. Default is 30. +

+
+
video_stream_h
+

Set video frame height in ’chars’ where one char indicates 8 pixels. Range is 20-512. Default is 30. +

+
+
video_stream_ptxt
+

Print metadata on video stream. Includes speed, tempo, order, pattern, +row and ts (time in ms). Can be 1 (on) or 0 (off). Default is 1. +

+
+
+ + +

15.12 libopenmpt

+ +

libopenmpt based module demuxer +

+

See https://lib.openmpt.org/libopenmpt/ for more information. +

+

Some files have multiple subsongs (tracks) this can be set with the subsong +option. +

+

It accepts the following options: +

+
+
subsong
+

Set the subsong index. This can be either ’all’, ’auto’, or the index of the +subsong. Subsong indexes start at 0. The default is ’auto’. +

+

The default value is to let libopenmpt choose. +

+
+
layout
+

Set the channel layout. Valid values are 1, 2, and 4 channel layouts. +The default value is STEREO. +

+
+
sample_rate
+

Set the sample rate for libopenmpt to output. +Range is from 1000 to INT_MAX. The value default is 48000. +

+
+ + +

15.13 mov/mp4/3gp

+ +

Demuxer for Quicktime File Format & ISO/IEC Base Media File Format (ISO/IEC 14496-12 or MPEG-4 Part 12, ISO/IEC 15444-12 or JPEG 2000 Part 12). +

+

Registered extensions: mov, mp4, m4a, 3gp, 3g2, mj2, psp, m4b, ism, ismv, isma, f4v +

+ +

15.13.1 Options

+ +

This demuxer accepts the following options: +

+
enable_drefs
+

Enable loading of external tracks, disabled by default. +Enabling this can theoretically leak information in some use cases. +

+
+
use_absolute_path
+

Allows loading of external tracks via absolute paths, disabled by default. +Enabling this poses a security risk. It should only be enabled if the source +is known to be non-malicious. +

+
+
seek_streams_individually
+

When seeking, identify the closest point in each stream individually and demux packets in +that stream from identified point. This can lead to a different sequence of packets compared +to demuxing linearly from the beginning. Default is true. +

+
+
ignore_editlist
+

Ignore any edit list atoms. The demuxer, by default, modifies the stream index to reflect the +timeline described by the edit list. Default is false. +

+
+
advanced_editlist
+

Modify the stream index to reflect the timeline described by the edit list. ignore_editlist +must be set to false for this option to be effective. +If both ignore_editlist and this option are set to false, then only the +start of the stream index is modified to reflect initial dwell time or starting timestamp +described by the edit list. Default is true. +

+
+
ignore_chapters
+

Don’t parse chapters. This includes GoPro ’HiLight’ tags/moments. Note that chapters are +only parsed when input is seekable. Default is false. +

+
+
use_mfra_for
+

For seekable fragmented input, set fragment’s starting timestamp from media fragment random access box, if present. +

+

Following options are available: +

+
‘auto’
+

Auto-detect whether to set mfra timestamps as PTS or DTS (default) +

+
+
‘dts’
+

Set mfra timestamps as DTS +

+
+
‘pts’
+

Set mfra timestamps as PTS +

+
+
‘0’
+

Don’t use mfra box to set timestamps +

+
+ +
+
export_all
+

Export unrecognized boxes within the udta box as metadata entries. The first four +characters of the box type are set as the key. Default is false. +

+
+
export_xmp
+

Export entire contents of XMP_ box and uuid box as a string with key xmp. Note that +if export_all is set and this option isn’t, the contents of XMP_ box are still exported +but with key XMP_. Default is false. +

+
+
activation_bytes
+

4-byte key required to decrypt Audible AAX and AAX+ files. See Audible AAX subsection below. +

+
+
audible_fixed_key
+

Fixed key used for handling Audible AAX/AAX+ files. It has been pre-set so should not be necessary to +specify. +

+
+
decryption_key
+

16-byte key, in hex, to decrypt files encrypted using ISO Common Encryption (CENC/AES-128 CTR; ISO/IEC 23001-7). +

+
+ + +

15.13.2 Audible AAX

+ +

Audible AAX files are encrypted M4B files, and they can be decrypted by specifying a 4 byte activation secret. +

+
ffmpeg -activation_bytes 1CEB00DA -i test.aax -vn -c:a copy output.mp4
+
+ + +

15.14 mpegts

+ +

MPEG-2 transport stream demuxer. +

+

This demuxer accepts the following options: +

+
resync_size
+

Set size limit for looking up a new synchronization. Default value is +65536. +

+
+
skip_unknown_pmt
+

Skip PMTs for programs not defined in the PAT. Default value is 0. +

+
+
fix_teletext_pts
+

Override teletext packet PTS and DTS values with the timestamps calculated +from the PCR of the first program which the teletext stream is part of and is +not discarded. Default value is 1, set this option to 0 if you want your +teletext packet PTS and DTS values untouched. +

+
+
ts_packetsize
+

Output option carrying the raw packet size in bytes. +Show the detected raw packet size, cannot be set by the user. +

+
+
scan_all_pmts
+

Scan and combine all PMTs. The value is an integer with value from -1 +to 1 (-1 means automatic setting, 1 means enabled, 0 means +disabled). Default value is -1. +

+
+
merge_pmt_versions
+

Re-use existing streams when a PMT’s version is updated and elementary +streams move to different PIDs. Default value is 0. +

+
+ + +

15.15 mpjpeg

+ +

MJPEG encapsulated in multi-part MIME demuxer. +

+

This demuxer allows reading of MJPEG, where each frame is represented as a part of +multipart/x-mixed-replace stream. +

+
strict_mime_boundary
+

Default implementation applies a relaxed standard to multi-part MIME boundary detection, +to prevent regression with numerous existing endpoints not generating a proper MIME +MJPEG stream. Turning this option on by setting it to 1 will result in a stricter check +of the boundary value. +

+
+ + +

15.16 rawvideo

+ +

Raw video demuxer. +

+

This demuxer allows one to read raw video data. Since there is no header +specifying the assumed video parameters, the user must specify them +in order to be able to decode the data correctly. +

+

This demuxer accepts the following options: +

+
framerate
+

Set input video frame rate. Default value is 25. +

+
+
pixel_format
+

Set the input video pixel format. Default value is yuv420p. +

+
+
video_size
+

Set the input video size. This value must be specified explicitly. +

+
+ +

For example to read a rawvideo file input.raw with +ffplay, assuming a pixel format of rgb24, a video +size of 320x240, and a frame rate of 10 images per second, use +the command: +

+
ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.raw
+
+ + +

15.17 sbg

+ +

SBaGen script demuxer. +

+

This demuxer reads the script language used by SBaGen +http://uazu.net/sbagen/ to generate binaural beats sessions. A SBG +script looks like that: +

+
-SE
+a: 300-2.5/3 440+4.5/0
+b: 300-2.5/0 440+4.5/3
+off: -
+NOW      == a
++0:07:00 == b
++0:14:00 == a
++0:21:00 == b
++0:30:00    off
+
+ +

A SBG script can mix absolute and relative timestamps. If the script uses +either only absolute timestamps (including the script start time) or only +relative ones, then its layout is fixed, and the conversion is +straightforward. On the other hand, if the script mixes both kind of +timestamps, then the NOW reference for relative timestamps will be +taken from the current time of day at the time the script is read, and the +script layout will be frozen according to that reference. That means that if +the script is directly played, the actual times will match the absolute +timestamps up to the sound controller’s clock accuracy, but if the user +somehow pauses the playback or seeks, all times will be shifted accordingly. +

+ +

15.18 tedcaptions

+ +

JSON captions used for TED Talks. +

+

TED does not provide links to the captions, but they can be guessed from the +page. The file tools/bookmarklets.html from the FFmpeg source tree +contains a bookmarklet to expose them. +

+

This demuxer accepts the following option: +

+
start_time
+

Set the start time of the TED talk, in milliseconds. The default is 15000 +(15s). It is used to sync the captions with the downloadable videos, because +they include a 15s intro. +

+
+ +

Example: convert the captions to a format most players understand: +

+
ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
+
+ + +

15.19 vapoursynth

+ +

Vapoursynth wrapper. +

+

Due to security concerns, Vapoursynth scripts will not +be autodetected so the input format has to be forced. For ff* CLI tools, +add -f vapoursynth before the input -i yourscript.vpy. +

+

This demuxer accepts the following option: +

+
max_script_size
+

The demuxer buffers the entire script into memory. Adjust this value to set the maximum buffer size, +which in turn, acts as a ceiling for the size of scripts that can be read. +Default is 1 MiB. +

+
+ + +

16 Metadata

+ +

FFmpeg is able to dump metadata from media files into a simple UTF-8-encoded +INI-like text file and then load it back using the metadata muxer/demuxer. +

+

The file format is as follows: +

    +
  1. A file consists of a header and a number of metadata tags divided into sections, +each on its own line. + +
  2. The header is a ‘;FFMETADATA’ string, followed by a version number (now 1). + +
  3. Metadata tags are of the form ‘key=value’ + +
  4. Immediately after header follows global metadata + +
  5. After global metadata there may be sections with per-stream/per-chapter +metadata. + +
  6. A section starts with the section name in uppercase (i.e. STREAM or CHAPTER) in +brackets (‘[’, ‘]’) and ends with next section or end of file. + +
  7. At the beginning of a chapter section there may be an optional timebase to be +used for start/end values. It must be in form +‘TIMEBASE=num/den’, where num and den are +integers. If the timebase is missing then start/end times are assumed to +be in nanoseconds. + +

    Next a chapter section must contain chapter start and end times in form +‘START=num’, ‘END=num’, where num is a positive +integer. +

    +
  8. Empty lines and lines starting with ‘;’ or ‘#’ are ignored. + +
  9. Metadata keys or values containing special characters (‘=’, ‘;’, +‘#’, ‘\’ and a newline) must be escaped with a backslash ‘\’. + +
  10. Note that whitespace in metadata (e.g. ‘foo = bar’) is considered to be +a part of the tag (in the example above key is ‘foo ’, value is +‘ bar’). +
+ +

A ffmetadata file might look like this: +

+
;FFMETADATA1
+title=bike\\shed
+;this is a comment
+artist=FFmpeg troll team
+
+[CHAPTER]
+TIMEBASE=1/1000
+START=0
+#chapter ends at 0:01:00
+END=60000
+title=chapter \#1
+[STREAM]
+title=multi\
+line
+
+ +

By using the ffmetadata muxer and demuxer it is possible to extract +metadata from an input file to an ffmetadata file, and then transcode +the file into an output file with the edited ffmetadata file. +

+

Extracting an ffmetadata file with ffmpeg goes as follows: +

+
ffmpeg -i INPUT -f ffmetadata FFMETADATAFILE
+
+ +

Reinserting edited metadata information from the FFMETADATAFILE file can +be done as: +

+
ffmpeg -i INPUT -i FFMETADATAFILE -map_metadata 1 -codec copy OUTPUT
+
+ + +

17 Protocol Options

+ +

The libavformat library provides some generic global options, which +can be set on all the protocols. In addition each protocol may support +so-called private options, which are specific for that component. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the +AVFormatContext options or using the libavutil/opt.h API +for programmatic use. +

+

The list of supported options follows: +

+
+
protocol_whitelist list (input)
+

Set a ","-separated list of allowed protocols. "ALL" matches all protocols. Protocols +prefixed by "-" are disabled. +All protocols are allowed by default but protocols used by an another +protocol (nested protocols) are restricted to a per protocol subset. +

+
+ + + +

18 Protocols

+ +

Protocols are configured elements in FFmpeg that enable access to +resources that require specific protocols. +

+

When you configure your FFmpeg build, all the supported protocols are +enabled by default. You can list all available ones using the +configure option "–list-protocols". +

+

You can disable all the protocols using the configure option +"–disable-protocols", and selectively enable a protocol using the +option "–enable-protocol=PROTOCOL", or you can disable a +particular protocol using the option +"–disable-protocol=PROTOCOL". +

+

The option "-protocols" of the ff* tools will display the list of +supported protocols. +

+

All protocols accept the following options: +

+
+
rw_timeout
+

Maximum time to wait for (network) read/write operations to complete, +in microseconds. +

+
+ +

A description of the currently available protocols follows. +

+ +

18.1 amqp

+ +

Advanced Message Queueing Protocol (AMQP) version 0-9-1 is a broker based +publish-subscribe communication protocol. +

+

FFmpeg must be compiled with –enable-librabbitmq to support AMQP. A separate +AMQP broker must also be run. An example open-source AMQP broker is RabbitMQ. +

+

After starting the broker, an FFmpeg client may stream data to the broker using +the command: +

+
+
ffmpeg -re -i input -f mpegts amqp://[[user]:[password]@]hostname[:port]
+
+ +

Where hostname and port (default is 5672) is the address of the broker. The +client may also set a user/password for authentication. The default for both +fields is "guest". +

+

Muliple subscribers may stream from the broker using the command: +

+
ffplay amqp://[[user]:[password]@]hostname[:port]
+
+ +

In RabbitMQ all data published to the broker flows through a specific exchange, +and each subscribing client has an assigned queue/buffer. When a packet arrives +at an exchange, it may be copied to a client’s queue depending on the exchange +and routing_key fields. +

+

The following options are supported: +

+
+
exchange
+

Sets the exchange to use on the broker. RabbitMQ has several predefined +exchanges: "amq.direct" is the default exchange, where the publisher and +subscriber must have a matching routing_key; "amq.fanout" is the same as a +broadcast operation (i.e. the data is forwarded to all queues on the fanout +exchange independent of the routing_key); and "amq.topic" is similar to +"amq.direct", but allows for more complex pattern matching (refer to the RabbitMQ +documentation). +

+
+
routing_key
+

Sets the routing key. The default value is "amqp". The routing key is used on +the "amq.direct" and "amq.topic" exchanges to decide whether packets are written +to the queue of a subscriber. +

+
+
pkt_size
+

Maximum size of each packet sent/received to the broker. Default is 131072. +Minimum is 4096 and max is any large value (representable by an int). When +receiving packets, this sets an internal buffer size in FFmpeg. It should be +equal to or greater than the size of the published packets to the broker. Otherwise +the received message may be truncated causing decoding errors. +

+
+
connection_timeout
+

The timeout in seconds during the initial connection to the broker. The +default value is rw_timeout, or 5 seconds if rw_timeout is not set. +

+
+
+ + +

18.2 async

+ +

Asynchronous data filling wrapper for input stream. +

+

Fill data in a background thread, to decouple I/O operation from demux thread. +

+
+
async:URL
+async:http://host/resource
+async:cache:http://host/resource
+
+ + +

18.3 bluray

+ +

Read BluRay playlist. +

+

The accepted options are: +

+
angle
+

BluRay angle +

+
+
chapter
+

Start chapter (1...N) +

+
+
playlist
+

Playlist to read (BDMV/PLAYLIST/?????.mpls) +

+
+
+ +

Examples: +

+

Read longest playlist from BluRay mounted to /mnt/bluray: +

+
bluray:/mnt/bluray
+
+ +

Read angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapter 2: +

+
-playlist 4 -angle 2 -chapter 2 bluray:/mnt/bluray
+
+ + +

18.4 cache

+ +

Caching wrapper for input stream. +

+

Cache the input stream to temporary file. It brings seeking capability to live streams. +

+
+
cache:URL
+
+ + +

18.5 concat

+ +

Physical concatenation protocol. +

+

Read and seek from many resources in sequence as if they were +a unique resource. +

+

A URL accepted by this protocol has the syntax: +

+
concat:URL1|URL2|...|URLN
+
+ +

where URL1, URL2, ..., URLN are the urls of the +resource to be concatenated, each one possibly specifying a distinct +protocol. +

+

For example to read a sequence of files split1.mpeg, +split2.mpeg, split3.mpeg with ffplay use the +command: +

+
ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
+
+ +

Note that you may need to escape the character "|" which is special for +many shells. +

+ +

18.6 crypto

+ +

AES-encrypted stream reading protocol. +

+

The accepted options are: +

+
key
+

Set the AES decryption key binary block from given hexadecimal representation. +

+
+
iv
+

Set the AES decryption initialization vector binary block from given hexadecimal representation. +

+
+ +

Accepted URL formats: +

+
crypto:URL
+crypto+URL
+
+ + +

18.7 data

+ +

Data in-line in the URI. See http://en.wikipedia.org/wiki/Data_URI_scheme. +

+

For example, to convert a GIF file given inline with ffmpeg: +

+
ffmpeg -i "data:image/gif;base64,R0lGODdhCAAIAMIEAAAAAAAA//8AAP//AP///////////////ywAAAAACAAIAAADF0gEDLojDgdGiJdJqUX02iB4E8Q9jUMkADs=" smiley.png
+
+ + +

18.8 file

+ +

File access protocol. +

+

Read from or write to a file. +

+

A file URL can have the form: +

+
file:filename
+
+ +

where filename is the path of the file to read. +

+

An URL that does not have a protocol prefix will be assumed to be a +file URL. Depending on the build, an URL that looks like a Windows +path with the drive letter at the beginning will also be assumed to be +a file URL (usually not the case in builds for unix-like systems). +

+

For example to read from a file input.mpeg with ffmpeg +use the command: +

+
ffmpeg -i file:input.mpeg output.mpeg
+
+ +

This protocol accepts the following options: +

+
+
truncate
+

Truncate existing files on write, if set to 1. A value of 0 prevents +truncating. Default value is 1. +

+
+
blocksize
+

Set I/O operation maximum block size, in bytes. Default value is +INT_MAX, which results in not limiting the requested block size. +Setting this value reasonably low improves user termination request reaction +time, which is valuable for files on slow medium. +

+
+
follow
+

If set to 1, the protocol will retry reading at the end of the file, allowing +reading files that still are being written. In order for this to terminate, +you either need to use the rw_timeout option, or use the interrupt callback +(for API users). +

+
+
seekable
+

Controls if seekability is advertised on the file. 0 means non-seekable, -1 +means auto (seekable for normal files, non-seekable for named pipes). +

+

Many demuxers handle seekable and non-seekable resources differently, +overriding this might speed up opening certain files at the cost of losing some +features (e.g. accurate seeking). +

+
+ + +

18.9 ftp

+ +

FTP (File Transfer Protocol). +

+

Read from or write to remote resources using FTP protocol. +

+

Following syntax is required. +

+
ftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg
+
+ +

This protocol accepts the following options. +

+
+
timeout
+

Set timeout in microseconds of socket I/O operations used by the underlying low level +operation. By default it is set to -1, which means that the timeout is +not specified. +

+
+
ftp-user
+

Set a user to be used for authenticating to the FTP server. This is overridden by the +user in the FTP URL. +

+
+
ftp-password
+

Set a password to be used for authenticating to the FTP server. This is overridden by +the password in the FTP URL, or by ftp-anonymous-password if no user is set. +

+
+
ftp-anonymous-password
+

Password used when login as anonymous user. Typically an e-mail address +should be used. +

+
+
ftp-write-seekable
+

Control seekability of connection during encoding. If set to 1 the +resource is supposed to be seekable, if set to 0 it is assumed not +to be seekable. Default value is 0. +

+
+ +

NOTE: Protocol can be used as output, but it is recommended to not do +it, unless special care is taken (tests, customized server configuration +etc.). Different FTP servers behave in different way during seek +operation. ff* tools may produce incomplete content due to server limitations. +

+ +

18.10 gopher

+ +

Gopher protocol. +

+ +

18.11 hls

+ +

Read Apple HTTP Live Streaming compliant segmented stream as +a uniform one. The M3U8 playlists describing the segments can be +remote HTTP resources or local files, accessed using the standard +file protocol. +The nested protocol is declared by specifying +"+proto" after the hls URI scheme name, where proto +is either "file" or "http". +

+
+
hls+http://host/path/to/remote/resource.m3u8
+hls+file://path/to/local/resource.m3u8
+
+ +

Using this protocol is discouraged - the hls demuxer should work +just as well (if not, please report the issues) and is more complete. +To use the hls demuxer instead, simply use the direct URLs to the +m3u8 files. +

+ +

18.12 http

+ +

HTTP (Hyper Text Transfer Protocol). +

+

This protocol accepts the following options: +

+
+
seekable
+

Control seekability of connection. If set to 1 the resource is +supposed to be seekable, if set to 0 it is assumed not to be seekable, +if set to -1 it will try to autodetect if it is seekable. Default +value is -1. +

+
+
chunked_post
+

If set to 1 use chunked Transfer-Encoding for posts, default is 1. +

+
+
content_type
+

Set a specific content type for the POST messages or for listen mode. +

+
+
http_proxy
+

set HTTP proxy to tunnel through e.g. http://example.com:1234 +

+
+
headers
+

Set custom HTTP headers, can override built in default headers. The +value must be a string encoding the headers. +

+
+
multiple_requests
+

Use persistent connections if set to 1, default is 0. +

+
+
post_data
+

Set custom HTTP post data. +

+
+
referer
+

Set the Referer header. Include ’Referer: URL’ header in HTTP request. +

+
+
user_agent
+

Override the User-Agent header. If not specified the protocol will use a +string describing the libavformat build. ("Lavf/<version>") +

+
+
user-agent
+

This is a deprecated option, you can use user_agent instead it. +

+
+
timeout
+

Set timeout in microseconds of socket I/O operations used by the underlying low level +operation. By default it is set to -1, which means that the timeout is +not specified. +

+
+
reconnect_at_eof
+

If set then eof is treated like an error and causes reconnection, this is useful +for live / endless streams. +

+
+
reconnect_streamed
+

If set then even streamed/non seekable streams will be reconnected on errors. +

+
+
reconnect_delay_max
+

Sets the maximum delay in seconds after which to give up reconnecting +

+
+
mime_type
+

Export the MIME type. +

+
+
http_version
+

Exports the HTTP response version number. Usually "1.0" or "1.1". +

+
+
icy
+

If set to 1 request ICY (SHOUTcast) metadata from the server. If the server +supports this, the metadata has to be retrieved by the application by reading +the icy_metadata_headers and icy_metadata_packet options. +The default is 1. +

+
+
icy_metadata_headers
+

If the server supports ICY metadata, this contains the ICY-specific HTTP reply +headers, separated by newline characters. +

+
+
icy_metadata_packet
+

If the server supports ICY metadata, and icy was set to 1, this +contains the last non-empty metadata packet sent by the server. It should be +polled in regular intervals by applications interested in mid-stream metadata +updates. +

+
+
cookies
+

Set the cookies to be sent in future requests. The format of each cookie is the +same as the value of a Set-Cookie HTTP response field. Multiple cookies can be +delimited by a newline character. +

+
+
offset
+

Set initial byte offset. +

+
+
end_offset
+

Try to limit the request to bytes preceding this offset. +

+
+
method
+

When used as a client option it sets the HTTP method for the request. +

+

When used as a server option it sets the HTTP method that is going to be +expected from the client(s). +If the expected and the received HTTP method do not match the client will +be given a Bad Request response. +When unset the HTTP method is not checked for now. This will be replaced by +autodetection in the future. +

+
+
listen
+

If set to 1 enables experimental HTTP server. This can be used to send data when +used as an output option, or read data from a client with HTTP POST when used as +an input option. +If set to 2 enables experimental multi-client HTTP server. This is not yet implemented +in ffmpeg.c and thus must not be used as a command line option. +

+
# Server side (sending):
+ffmpeg -i somefile.ogg -c copy -listen 1 -f ogg http://server:port
+
+# Client side (receiving):
+ffmpeg -i http://server:port -c copy somefile.ogg
+
+# Client can also be done with wget:
+wget http://server:port -O somefile.ogg
+
+# Server side (receiving):
+ffmpeg -listen 1 -i http://server:port -c copy somefile.ogg
+
+# Client side (sending):
+ffmpeg -i somefile.ogg -chunked_post 0 -c copy -f ogg http://server:port
+
+# Client can also be done with wget:
+wget --post-file=somefile.ogg http://server:port
+
+ +
+
send_expect_100
+

Send an Expect: 100-continue header for POST. If set to 1 it will send, if set +to 0 it won’t, if set to -1 it will try to send if it is applicable. Default +value is -1. +

+
+
+ + +

18.12.1 HTTP Cookies

+ +

Some HTTP requests will be denied unless cookie values are passed in with the +request. The cookies option allows these cookies to be specified. At +the very least, each cookie must specify a value along with a path and domain. +HTTP requests that match both the domain and path will automatically include the +cookie value in the HTTP Cookie header field. Multiple cookies can be delimited +by a newline. +

+

The required syntax to play a stream specifying a cookie is: +

+
ffplay -cookies "nlqptid=nltid=tsn; path=/; domain=somedomain.com;" http://somedomain.com/somestream.m3u8
+
+ + +

18.13 Icecast

+ +

Icecast protocol (stream to Icecast servers) +

+

This protocol accepts the following options: +

+
+
ice_genre
+

Set the stream genre. +

+
+
ice_name
+

Set the stream name. +

+
+
ice_description
+

Set the stream description. +

+
+
ice_url
+

Set the stream website URL. +

+
+
ice_public
+

Set if the stream should be public. +The default is 0 (not public). +

+
+
user_agent
+

Override the User-Agent header. If not specified a string of the form +"Lavf/<version>" will be used. +

+
+
password
+

Set the Icecast mountpoint password. +

+
+
content_type
+

Set the stream content type. This must be set if it is different from +audio/mpeg. +

+
+
legacy_icecast
+

This enables support for Icecast versions < 2.4.0, that do not support the +HTTP PUT method but the SOURCE method. +

+
+
+ +
+
icecast://[username[:password]@]server:port/mountpoint
+
+ + +

18.14 mmst

+ +

MMS (Microsoft Media Server) protocol over TCP. +

+ +

18.15 mmsh

+ +

MMS (Microsoft Media Server) protocol over HTTP. +

+

The required syntax is: +

+
mmsh://server[:port][/app][/playpath]
+
+ + +

18.16 md5

+ +

MD5 output protocol. +

+

Computes the MD5 hash of the data to be written, and on close writes +this to the designated output or stdout if none is specified. It can +be used to test muxers without writing an actual file. +

+

Some examples follow. +

+
# Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
+ffmpeg -i input.flv -f avi -y md5:output.avi.md5
+
+# Write the MD5 hash of the encoded AVI file to stdout.
+ffmpeg -i input.flv -f avi -y md5:
+
+ +

Note that some formats (typically MOV) require the output protocol to +be seekable, so they will fail with the MD5 output protocol. +

+ +

18.17 pipe

+ +

UNIX pipe access protocol. +

+

Read and write from UNIX pipes. +

+

The accepted syntax is: +

+
pipe:[number]
+
+ +

number is the number corresponding to the file descriptor of the +pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr). If number +is not specified, by default the stdout file descriptor will be used +for writing, stdin for reading. +

+

For example to read from stdin with ffmpeg: +

+
cat test.wav | ffmpeg -i pipe:0
+# ...this is the same as...
+cat test.wav | ffmpeg -i pipe:
+
+ +

For writing to stdout with ffmpeg: +

+
ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
+# ...this is the same as...
+ffmpeg -i test.wav -f avi pipe: | cat > test.avi
+
+ +

This protocol accepts the following options: +

+
+
blocksize
+

Set I/O operation maximum block size, in bytes. Default value is +INT_MAX, which results in not limiting the requested block size. +Setting this value reasonably low improves user termination request reaction +time, which is valuable if data transmission is slow. +

+
+ +

Note that some formats (typically MOV), require the output protocol to +be seekable, so they will fail with the pipe output protocol. +

+ +

18.18 prompeg

+ +

Pro-MPEG Code of Practice #3 Release 2 FEC protocol. +

+

The Pro-MPEG CoP#3 FEC is a 2D parity-check forward error correction mechanism +for MPEG-2 Transport Streams sent over RTP. +

+

This protocol must be used in conjunction with the rtp_mpegts muxer and +the rtp protocol. +

+

The required syntax is: +

+
-f rtp_mpegts -fec prompeg=option=val... rtp://hostname:port
+
+ +

The destination UDP ports are port + 2 for the column FEC stream +and port + 4 for the row FEC stream. +

+

This protocol accepts the following options: +

+
l=n
+

The number of columns (4-20, LxD <= 100) +

+
+
d=n
+

The number of rows (4-20, LxD <= 100) +

+
+
+ +

Example usage: +

+
+
-f rtp_mpegts -fec prompeg=l=8:d=4 rtp://hostname:port
+
+ + +

18.19 rtmp

+ +

Real-Time Messaging Protocol. +

+

The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia +content across a TCP/IP network. +

+

The required syntax is: +

+
rtmp://[username:password@]server[:port][/app][/instance][/playpath]
+
+ +

The accepted parameters are: +

+
username
+

An optional username (mostly for publishing). +

+
+
password
+

An optional password (mostly for publishing). +

+
+
server
+

The address of the RTMP server. +

+
+
port
+

The number of the TCP port to use (by default is 1935). +

+
+
app
+

It is the name of the application to access. It usually corresponds to +the path where the application is installed on the RTMP server +(e.g. /ondemand/, /flash/live/, etc.). You can override +the value parsed from the URI through the rtmp_app option, too. +

+
+
playpath
+

It is the path or name of the resource to play with reference to the +application specified in app, may be prefixed by "mp4:". You +can override the value parsed from the URI through the rtmp_playpath +option, too. +

+
+
listen
+

Act as a server, listening for an incoming connection. +

+
+
timeout
+

Maximum time to wait for the incoming connection. Implies listen. +

+
+ +

Additionally, the following parameters can be set via command line options +(or in code via AVOptions): +

+
rtmp_app
+

Name of application to connect on the RTMP server. This option +overrides the parameter specified in the URI. +

+
+
rtmp_buffer
+

Set the client buffer time in milliseconds. The default is 3000. +

+
+
rtmp_conn
+

Extra arbitrary AMF connection parameters, parsed from a string, +e.g. like B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0. +Each value is prefixed by a single character denoting the type, +B for Boolean, N for number, S for string, O for object, or Z for null, +followed by a colon. For Booleans the data must be either 0 or 1 for +FALSE or TRUE, respectively. Likewise for Objects the data must be 0 or +1 to end or begin an object, respectively. Data items in subobjects may +be named, by prefixing the type with ’N’ and specifying the name before +the value (i.e. NB:myFlag:1). This option may be used multiple +times to construct arbitrary AMF sequences. +

+
+
rtmp_flashver
+

Version of the Flash plugin used to run the SWF player. The default +is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible; +<libavformat version>).) +

+
+
rtmp_flush_interval
+

Number of packets flushed in the same request (RTMPT only). The default +is 10. +

+
+
rtmp_live
+

Specify that the media is a live stream. No resuming or seeking in +live streams is possible. The default value is any, which means the +subscriber first tries to play the live stream specified in the +playpath. If a live stream of that name is not found, it plays the +recorded stream. The other possible values are live and +recorded. +

+
+
rtmp_pageurl
+

URL of the web page in which the media was embedded. By default no +value will be sent. +

+
+
rtmp_playpath
+

Stream identifier to play or to publish. This option overrides the +parameter specified in the URI. +

+
+
rtmp_subscribe
+

Name of live stream to subscribe to. By default no value will be sent. +It is only sent if the option is specified or if rtmp_live +is set to live. +

+
+
rtmp_swfhash
+

SHA256 hash of the decompressed SWF file (32 bytes). +

+
+
rtmp_swfsize
+

Size of the decompressed SWF file, required for SWFVerification. +

+
+
rtmp_swfurl
+

URL of the SWF player for the media. By default no value will be sent. +

+
+
rtmp_swfverify
+

URL to player swf file, compute hash/size automatically. +

+
+
rtmp_tcurl
+

URL of the target stream. Defaults to proto://host[:port]/app. +

+
+
+ +

For example to read with ffplay a multimedia resource named +"sample" from the application "vod" from an RTMP server "myserver": +

+
ffplay rtmp://myserver/vod/sample
+
+ +

To publish to a password protected server, passing the playpath and +app names separately: +

+
ffmpeg -re -i <input> -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@myserver/
+
+ + +

18.20 rtmpe

+ +

Encrypted Real-Time Messaging Protocol. +

+

The Encrypted Real-Time Messaging Protocol (RTMPE) is used for +streaming multimedia content within standard cryptographic primitives, +consisting of Diffie-Hellman key exchange and HMACSHA256, generating +a pair of RC4 keys. +

+ +

18.21 rtmps

+ +

Real-Time Messaging Protocol over a secure SSL connection. +

+

The Real-Time Messaging Protocol (RTMPS) is used for streaming +multimedia content across an encrypted connection. +

+ +

18.22 rtmpt

+ +

Real-Time Messaging Protocol tunneled through HTTP. +

+

The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used +for streaming multimedia content within HTTP requests to traverse +firewalls. +

+ +

18.23 rtmpte

+ +

Encrypted Real-Time Messaging Protocol tunneled through HTTP. +

+

The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE) +is used for streaming multimedia content within HTTP requests to traverse +firewalls. +

+ +

18.24 rtmpts

+ +

Real-Time Messaging Protocol tunneled through HTTPS. +

+

The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used +for streaming multimedia content within HTTPS requests to traverse +firewalls. +

+ +

18.25 libsmbclient

+ +

libsmbclient permits one to manipulate CIFS/SMB network resources. +

+

Following syntax is required. +

+
+
smb://[[domain:]user[:password@]]server[/share[/path[/file]]]
+
+ +

This protocol accepts the following options. +

+
+
timeout
+

Set timeout in milliseconds of socket I/O operations used by the underlying +low level operation. By default it is set to -1, which means that the timeout +is not specified. +

+
+
truncate
+

Truncate existing files on write, if set to 1. A value of 0 prevents +truncating. Default value is 1. +

+
+
workgroup
+

Set the workgroup used for making connections. By default workgroup is not specified. +

+
+
+ +

For more information see: http://www.samba.org/. +

+ +

18.26 libssh

+ +

Secure File Transfer Protocol via libssh +

+

Read from or write to remote resources using SFTP protocol. +

+

Following syntax is required. +

+
+
sftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg
+
+ +

This protocol accepts the following options. +

+
+
timeout
+

Set timeout of socket I/O operations used by the underlying low level +operation. By default it is set to -1, which means that the timeout +is not specified. +

+
+
truncate
+

Truncate existing files on write, if set to 1. A value of 0 prevents +truncating. Default value is 1. +

+
+
private_key
+

Specify the path of the file containing private key to use during authorization. +By default libssh searches for keys in the ~/.ssh/ directory. +

+
+
+ +

Example: Play a file stored on remote server. +

+
+
ffplay sftp://user:password@server_address:22/home/user/resource.mpeg
+
+ + +

18.27 librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte

+ +

Real-Time Messaging Protocol and its variants supported through +librtmp. +

+

Requires the presence of the librtmp headers and library during +configuration. You need to explicitly configure the build with +"–enable-librtmp". If enabled this will replace the native RTMP +protocol. +

+

This protocol provides most client functions and a few server +functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT), +encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled +variants of these encrypted types (RTMPTE, RTMPTS). +

+

The required syntax is: +

+
rtmp_proto://server[:port][/app][/playpath] options
+
+ +

where rtmp_proto is one of the strings "rtmp", "rtmpt", "rtmpe", +"rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and +server, port, app and playpath have the same +meaning as specified for the RTMP native protocol. +options contains a list of space-separated options of the form +key=val. +

+

See the librtmp manual page (man 3 librtmp) for more information. +

+

For example, to stream a file in real-time to an RTMP server using +ffmpeg: +

+
ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
+
+ +

To play the same stream using ffplay: +

+
ffplay "rtmp://myserver/live/mystream live=1"
+
+ + +

18.28 rtp

+ +

Real-time Transport Protocol. +

+

The required syntax for an RTP URL is: +rtp://hostname[:port][?option=val...] +

+

port specifies the RTP port to use. +

+

The following URL options are supported: +

+
+
ttl=n
+

Set the TTL (Time-To-Live) value (for multicast only). +

+
+
rtcpport=n
+

Set the remote RTCP port to n. +

+
+
localrtpport=n
+

Set the local RTP port to n. +

+
+
localrtcpport=n'
+

Set the local RTCP port to n. +

+
+
pkt_size=n
+

Set max packet size (in bytes) to n. +

+
+
connect=0|1
+

Do a connect() on the UDP socket (if set to 1) or not (if set +to 0). +

+
+
sources=ip[,ip]
+

List allowed source IP addresses. +

+
+
block=ip[,ip]
+

List disallowed (blocked) source IP addresses. +

+
+
write_to_source=0|1
+

Send packets to the source address of the latest received packet (if +set to 1) or to a default remote address (if set to 0). +

+
+
localport=n
+

Set the local RTP port to n. +

+

This is a deprecated option. Instead, localrtpport should be +used. +

+
+
+ +

Important notes: +

+
    +
  1. If rtcpport is not set the RTCP port will be set to the RTP +port value plus 1. + +
  2. If localrtpport (the local RTP port) is not set any available +port will be used for the local RTP and RTCP ports. + +
  3. If localrtcpport (the local RTCP port) is not set it will be +set to the local RTP port value plus 1. +
+ + +

18.29 rtsp

+ +

Real-Time Streaming Protocol. +

+

RTSP is not technically a protocol handler in libavformat, it is a demuxer +and muxer. The demuxer supports both normal RTSP (with data transferred +over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with +data transferred over RDT). +

+

The muxer can be used to send a stream using RTSP ANNOUNCE to a server +supporting it (currently Darwin Streaming Server and Mischa Spiegelmock’s +RTSP server). +

+

The required syntax for a RTSP url is: +

+
rtsp://hostname[:port]/path
+
+ +

Options can be set on the ffmpeg/ffplay command +line, or set in code via AVOptions or in +avformat_open_input. +

+

The following options are supported. +

+
+
initial_pause
+

Do not start playing the stream immediately if set to 1. Default value +is 0. +

+
+
rtsp_transport
+

Set RTSP transport protocols. +

+

It accepts the following values: +

+
‘udp’
+

Use UDP as lower transport protocol. +

+
+
‘tcp’
+

Use TCP (interleaving within the RTSP control channel) as lower +transport protocol. +

+
+
‘udp_multicast’
+

Use UDP multicast as lower transport protocol. +

+
+
‘http’
+

Use HTTP tunneling as lower transport protocol, which is useful for +passing proxies. +

+
+ +

Multiple lower transport protocols may be specified, in that case they are +tried one at a time (if the setup of one fails, the next one is tried). +For the muxer, only the ‘tcp’ and ‘udp’ options are supported. +

+
+
rtsp_flags
+

Set RTSP flags. +

+

The following values are accepted: +

+
‘filter_src’
+

Accept packets only from negotiated peer address and port. +

+
‘listen’
+

Act as a server, listening for an incoming connection. +

+
‘prefer_tcp’
+

Try TCP for RTP transport first, if TCP is available as RTSP RTP transport. +

+
+ +

Default value is ‘none’. +

+
+
allowed_media_types
+

Set media types to accept from the server. +

+

The following flags are accepted: +

+
‘video’
+
‘audio’
+
‘data’
+
+ +

By default it accepts all media types. +

+
+
min_port
+

Set minimum local UDP port. Default value is 5000. +

+
+
max_port
+

Set maximum local UDP port. Default value is 65000. +

+
+
timeout
+

Set maximum timeout (in seconds) to wait for incoming connections. +

+

A value of -1 means infinite (default). This option implies the +rtsp_flags set to ‘listen’. +

+
+
reorder_queue_size
+

Set number of packets to buffer for handling of reordered packets. +

+
+
stimeout
+

Set socket TCP I/O timeout in microseconds. +

+
+
user-agent
+

Override User-Agent header. If not specified, it defaults to the +libavformat identifier string. +

+
+ +

When receiving data over UDP, the demuxer tries to reorder received packets +(since they may arrive out of order, or packets may get lost totally). This +can be disabled by setting the maximum demuxing delay to zero (via +the max_delay field of AVFormatContext). +

+

When watching multi-bitrate Real-RTSP streams with ffplay, the +streams to display can be chosen with -vst n and +-ast n for video and audio respectively, and can be switched +on the fly by pressing v and a. +

+ +

18.29.1 Examples

+ +

The following examples all make use of the ffplay and +ffmpeg tools. +

+
    +
  • Watch a stream over UDP, with a max reordering delay of 0.5 seconds: +
    +
    ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
+
    + +
  • Watch a stream tunneled over HTTP: +
    +
    ffplay -rtsp_transport http rtsp://server/video.mp4
+
    + +
  • Send a stream in realtime to a RTSP server, for others to watch: +
    +
    ffmpeg -re -i input -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
+
    + +
  • Receive a stream in realtime: +
    +
    ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp output
+
    +
+ + +

18.30 sap

+ +

Session Announcement Protocol (RFC 2974). This is not technically a +protocol handler in libavformat, it is a muxer and demuxer. +It is used for signalling of RTP streams, by announcing the SDP for the +streams regularly on a separate port. +

+ +

18.30.1 Muxer

+ +

The syntax for a SAP url given to the muxer is: +

+
sap://destination[:port][?options]
+
+ +

The RTP packets are sent to destination on port port, +or to port 5004 if no port is specified. +options is a &-separated list. The following options +are supported: +

+
+
announce_addr=address
+

Specify the destination IP address for sending the announcements to. +If omitted, the announcements are sent to the commonly used SAP +announcement multicast address 224.2.127.254 (sap.mcast.net), or +ff0e::2:7ffe if destination is an IPv6 address. +

+
+
announce_port=port
+

Specify the port to send the announcements on, defaults to +9875 if not specified. +

+
+
ttl=ttl
+

Specify the time to live value for the announcements and RTP packets, +defaults to 255. +

+
+
same_port=0|1
+

If set to 1, send all RTP streams on the same port pair. If zero (the +default), all streams are sent on unique ports, with each stream on a +port 2 numbers higher than the previous. +VLC/Live555 requires this to be set to 1, to be able to receive the stream. +The RTP stack in libavformat for receiving requires all streams to be sent +on unique ports. +

+
+ +

Example command lines follow. +

+

To broadcast a stream on the local subnet, for watching in VLC: +

+
+
ffmpeg -re -i input -f sap sap://224.0.0.255?same_port=1
+
+ +

Similarly, for watching in ffplay: +

+
+
ffmpeg -re -i input -f sap sap://224.0.0.255
+
+ +

And for watching in ffplay, over IPv6: +

+
+
ffmpeg -re -i input -f sap sap://[ff0e::1:2:3:4]
+
+ + +

18.30.2 Demuxer

+ +

The syntax for a SAP url given to the demuxer is: +

+
sap://[address][:port]
+
+ +

address is the multicast address to listen for announcements on, +if omitted, the default 224.2.127.254 (sap.mcast.net) is used. port +is the port that is listened on, 9875 if omitted. +

+

The demuxers listens for announcements on the given address and port. +Once an announcement is received, it tries to receive that particular stream. +

+

Example command lines follow. +

+

To play back the first stream announced on the normal SAP multicast address: +

+
+
ffplay sap://
+
+ +

To play back the first stream announced on one the default IPv6 SAP multicast address: +

+
+
ffplay sap://[ff0e::2:7ffe]
+
+ + +

18.31 sctp

+ +

Stream Control Transmission Protocol. +

+

The accepted URL syntax is: +

+
sctp://host:port[?options]
+
+ +

The protocol accepts the following options: +

+
listen
+

If set to any value, listen for an incoming connection. Outgoing connection is done by default. +

+
+
max_streams
+

Set the maximum number of streams. By default no limit is set. +

+
+ + +

18.32 srt

+ +

Haivision Secure Reliable Transport Protocol via libsrt. +

+

The supported syntax for a SRT URL is: +

+
srt://hostname:port[?options]
+
+ +

options contains a list of &-separated options of the form +key=val. +

+

or +

+
+
options srt://hostname:port
+
+ +

options contains a list of ’-key val’ +options. +

+

This protocol accepts the following options. +

+
+
connect_timeout=milliseconds
+

Connection timeout; SRT cannot connect for RTT > 1500 msec +(2 handshake exchanges) with the default connect timeout of +3 seconds. This option applies to the caller and rendezvous +connection modes. The connect timeout is 10 times the value +set for the rendezvous mode (which can be used as a +workaround for this connection problem with earlier versions). +

+
+
ffs=bytes
+

Flight Flag Size (Window Size), in bytes. FFS is actually an +internal parameter and you should set it to not less than +recv_buffer_size and mss. The default value +is relatively large, therefore unless you set a very large receiver buffer, +you do not need to change this option. Default value is 25600. +

+
+
inputbw=bytes/seconds
+

Sender nominal input rate, in bytes per seconds. Used along with +oheadbw, when maxbw is set to relative (0), to +calculate maximum sending rate when recovery packets are sent +along with the main media stream: +inputbw * (100 + oheadbw) / 100 +if inputbw is not set while maxbw is set to +relative (0), the actual input rate is evaluated inside +the library. Default value is 0. +

+
+
iptos=tos
+

IP Type of Service. Applies to sender only. Default value is 0xB8. +

+
+
ipttl=ttl
+

IP Time To Live. Applies to sender only. Default value is 64. +

+
+
latency=microseconds
+

Timestamp-based Packet Delivery Delay. +Used to absorb bursts of missed packet retransmissions. +This flag sets both rcvlatency and peerlatency +to the same value. Note that prior to version 1.3.0 +this is the only flag to set the latency, however +this is effectively equivalent to setting peerlatency, +when side is sender and rcvlatency +when side is receiver, and the bidirectional stream +sending is not supported. +

+
+
listen_timeout=microseconds
+

Set socket listen timeout. +

+
+
maxbw=bytes/seconds
+

Maximum sending bandwidth, in bytes per seconds. +-1 infinite (CSRTCC limit is 30mbps) +0 relative to input rate (see inputbw) +>0 absolute limit value +Default value is 0 (relative) +

+
+
mode=caller|listener|rendezvous
+

Connection mode. +caller opens client connection. +listener starts server to listen for incoming connections. +rendezvous use Rendez-Vous connection mode. +Default value is caller. +

+
+
mss=bytes
+

Maximum Segment Size, in bytes. Used for buffer allocation +and rate calculation using a packet counter assuming fully +filled packets. The smallest MSS between the peers is +used. This is 1500 by default in the overall internet. +This is the maximum size of the UDP packet and can be +only decreased, unless you have some unusual dedicated +network settings. Default value is 1500. +

+
+
nakreport=1|0
+

If set to 1, Receiver will send ‘UMSG_LOSSREPORT‘ messages +periodically until a lost packet is retransmitted or +intentionally dropped. Default value is 1. +

+
+
oheadbw=percents
+

Recovery bandwidth overhead above input rate, in percents. +See inputbw. Default value is 25%. +

+
+
passphrase=string
+

HaiCrypt Encryption/Decryption Passphrase string, length +from 10 to 79 characters. The passphrase is the shared +secret between the sender and the receiver. It is used +to generate the Key Encrypting Key using PBKDF2 +(Password-Based Key Derivation Function). It is used +only if pbkeylen is non-zero. It is used on +the receiver only if the received data is encrypted. +The configured passphrase cannot be recovered (write-only). +

+
+
enforced_encryption=1|0
+

If true, both connection parties must have the same password +set (including empty, that is, with no encryption). If the +password doesn’t match or only one side is unencrypted, +the connection is rejected. Default is true. +

+
+
kmrefreshrate=packets
+

The number of packets to be transmitted after which the +encryption key is switched to a new key. Default is -1. +-1 means auto (0x1000000 in srt library). The range for +this option is integers in the 0 - INT_MAX. +

+
+
kmpreannounce=packets
+

The interval between when a new encryption key is sent and +when switchover occurs. This value also applies to the +subsequent interval between when switchover occurs and +when the old encryption key is decommissioned. Default is -1. +-1 means auto (0x1000 in srt library). The range for +this option is integers in the 0 - INT_MAX. +

+
+
payload_size=bytes
+

Sets the maximum declared size of a packet transferred +during the single call to the sending function in Live +mode. Use 0 if this value isn’t used (which is default in +file mode). +Default is -1 (automatic), which typically means MPEG-TS; +if you are going to use SRT +to send any different kind of payload, such as, for example, +wrapping a live stream in very small frames, then you can +use a bigger maximum frame size, though not greater than +1456 bytes. +

+
+
pkt_size=bytes
+

Alias for ‘payload_size’. +

+
+
peerlatency=microseconds
+

The latency value (as described in rcvlatency) that is +set by the sender side as a minimum value for the receiver. +

+
+
pbkeylen=bytes
+

Sender encryption key length, in bytes. +Only can be set to 0, 16, 24 and 32. +Enable sender encryption if not 0. +Not required on receiver (set to 0), +key size obtained from sender in HaiCrypt handshake. +Default value is 0. +

+
+
rcvlatency=microseconds
+

The time that should elapse since the moment when the +packet was sent and the moment when it’s delivered to +the receiver application in the receiving function. +This time should be a buffer time large enough to cover +the time spent for sending, unexpectedly extended RTT +time, and the time needed to retransmit the lost UDP +packet. The effective latency value will be the maximum +of this options’ value and the value of peerlatency +set by the peer side. Before version 1.3.0 this option +is only available as latency. +

+
+
recv_buffer_size=bytes
+

Set UDP receive buffer size, expressed in bytes. +

+
+
send_buffer_size=bytes
+

Set UDP send buffer size, expressed in bytes. +

+
+
timeout=microseconds
+

Set raise error timeouts for read, write and connect operations. Note that the +SRT library has internal timeouts which can be controlled separately, the +value set here is only a cap on those. +

+
+
tlpktdrop=1|0
+

Too-late Packet Drop. When enabled on receiver, it skips +missing packets that have not been delivered in time and +delivers the following packets to the application when +their time-to-play has come. It also sends a fake ACK to +the sender. When enabled on sender and enabled on the +receiving peer, the sender drops the older packets that +have no chance of being delivered in time. It was +automatically enabled in the sender if the receiver +supports it. +

+
+
sndbuf=bytes
+

Set send buffer size, expressed in bytes. +

+
+
rcvbuf=bytes
+

Set receive buffer size, expressed in bytes. +

+

Receive buffer must not be greater than ffs. +

+
+
lossmaxttl=packets
+

The value up to which the Reorder Tolerance may grow. When +Reorder Tolerance is > 0, then packet loss report is delayed +until that number of packets come in. Reorder Tolerance +increases every time a "belated" packet has come, but it +wasn’t due to retransmission (that is, when UDP packets tend +to come out of order), with the difference between the latest +sequence and this packet’s sequence, and not more than the +value of this option. By default it’s 0, which means that this +mechanism is turned off, and the loss report is always sent +immediately upon experiencing a "gap" in sequences. +

+
+
minversion
+

The minimum SRT version that is required from the peer. A connection +to a peer that does not satisfy the minimum version requirement +will be rejected. +

+

The version format in hex is 0xXXYYZZ for x.y.z in human readable +form. +

+
+
streamid=string
+

A string limited to 512 characters that can be set on the socket prior +to connecting. This stream ID will be able to be retrieved by the +listener side from the socket that is returned from srt_accept and +was connected by a socket with that set stream ID. SRT does not enforce +any special interpretation of the contents of this string. +This option doesn’t make sense in Rendezvous connection; the result +might be that simply one side will override the value from the other +side and it’s the matter of luck which one would win +

+
+
smoother=live|file
+

The type of Smoother used for the transmission for that socket, which +is responsible for the transmission and congestion control. The Smoother +type must be exactly the same on both connecting parties, otherwise +the connection is rejected. +

+
+
messageapi=1|0
+

When set, this socket uses the Message API, otherwise it uses Buffer +API. Note that in live mode (see transtype) there’s only +message API available. In File mode you can chose to use one of two modes: +

+

Stream API (default, when this option is false). In this mode you may +send as many data as you wish with one sending instruction, or even use +dedicated functions that read directly from a file. The internal facility +will take care of any speed and congestion control. When receiving, you +can also receive as many data as desired, the data not extracted will be +waiting for the next call. There is no boundary between data portions in +the Stream mode. +

+

Message API. In this mode your single sending instruction passes exactly +one piece of data that has boundaries (a message). Contrary to Live mode, +this message may span across multiple UDP packets and the only size +limitation is that it shall fit as a whole in the sending buffer. The +receiver shall use as large buffer as necessary to receive the message, +otherwise the message will not be given up. When the message is not +complete (not all packets received or there was a packet loss) it will +not be given up. +

+
+
transtype=live|file
+

Sets the transmission type for the socket, in particular, setting this +option sets multiple other parameters to their default values as required +for a particular transmission type. +

+

live: Set options as for live transmission. In this mode, you should +send by one sending instruction only so many data that fit in one UDP packet, +and limited to the value defined first in payload_size (1316 is +default in this mode). There is no speed control in this mode, only the +bandwidth control, if configured, in order to not exceed the bandwidth with +the overhead transmission (retransmitted and control packets). +

+

file: Set options as for non-live transmission. See messageapi +for further explanations +

+
+
linger=seconds
+

The number of seconds that the socket waits for unsent data when closing. +Default is -1. -1 means auto (off with 0 seconds in live mode, on with 180 +seconds in file mode). The range for this option is integers in the +0 - INT_MAX. +

+
+
+ +

For more information see: https://github.com/Haivision/srt. +

+ +

18.33 srtp

+ +

Secure Real-time Transport Protocol. +

+

The accepted options are: +

+
srtp_in_suite
+
srtp_out_suite
+

Select input and output encoding suites. +

+

Supported values: +

+
‘AES_CM_128_HMAC_SHA1_80’
+
‘SRTP_AES128_CM_HMAC_SHA1_80’
+
‘AES_CM_128_HMAC_SHA1_32’
+
‘SRTP_AES128_CM_HMAC_SHA1_32’
+
+ +
+
srtp_in_params
+
srtp_out_params
+

Set input and output encoding parameters, which are expressed by a +base64-encoded representation of a binary block. The first 16 bytes of +this binary block are used as master key, the following 14 bytes are +used as master salt. +

+
+ + +

18.34 subfile

+ +

Virtually extract a segment of a file or another stream. +The underlying stream must be seekable. +

+

Accepted options: +

+
start
+

Start offset of the extracted segment, in bytes. +

+
end
+

End offset of the extracted segment, in bytes. +If set to 0, extract till end of file. +

+
+ +

Examples: +

+

Extract a chapter from a DVD VOB file (start and end sectors obtained +externally and multiplied by 2048): +

+
subfile,,start,153391104,end,268142592,,:/media/dvd/VIDEO_TS/VTS_08_1.VOB
+
+ +

Play an AVI file directly from a TAR archive: +

+
subfile,,start,183241728,end,366490624,,:archive.tar
+
+ +

Play a MPEG-TS file from start offset till end: +

+
subfile,,start,32815239,end,0,,:video.ts
+
+ + +

18.35 tee

+ +

Writes the output to multiple protocols. The individual outputs are separated +by | +

+
+
tee:file://path/to/local/this.avi|file://path/to/local/that.avi
+
+ + +

18.36 tcp

+ +

Transmission Control Protocol. +

+

The required syntax for a TCP url is: +

+
tcp://hostname:port[?options]
+
+ +

options contains a list of &-separated options of the form +key=val. +

+

The list of supported options follows. +

+
+
listen=1|0
+

Listen for an incoming connection. Default value is 0. +

+
+
timeout=microseconds
+

Set raise error timeout, expressed in microseconds. +

+

This option is only relevant in read mode: if no data arrived in more +than this time interval, raise error. +

+
+
listen_timeout=milliseconds
+

Set listen timeout, expressed in milliseconds. +

+
+
recv_buffer_size=bytes
+

Set receive buffer size, expressed bytes. +

+
+
send_buffer_size=bytes
+

Set send buffer size, expressed bytes. +

+
+
tcp_nodelay=1|0
+

Set TCP_NODELAY to disable Nagle’s algorithm. Default value is 0. +

+
+
tcp_mss=bytes
+

Set maximum segment size for outgoing TCP packets, expressed in bytes. +

+
+ +

The following example shows how to setup a listening TCP connection +with ffmpeg, which is then accessed with ffplay: +

+
ffmpeg -i input -f format tcp://hostname:port?listen
+ffplay tcp://hostname:port
+
+ + +

18.37 tls

+ +

Transport Layer Security (TLS) / Secure Sockets Layer (SSL) +

+

The required syntax for a TLS/SSL url is: +

+
tls://hostname:port[?options]
+
+ +

The following parameters can be set via command line options +(or in code via AVOptions): +

+
+
ca_file, cafile=filename
+

A file containing certificate authority (CA) root certificates to treat +as trusted. If the linked TLS library contains a default this might not +need to be specified for verification to work, but not all libraries and +setups have defaults built in. +The file must be in OpenSSL PEM format. +

+
+
tls_verify=1|0
+

If enabled, try to verify the peer that we are communicating with. +Note, if using OpenSSL, this currently only makes sure that the +peer certificate is signed by one of the root certificates in the CA +database, but it does not validate that the certificate actually +matches the host name we are trying to connect to. (With other backends, +the host name is validated as well.) +

+

This is disabled by default since it requires a CA database to be +provided by the caller in many cases. +

+
+
cert_file, cert=filename
+

A file containing a certificate to use in the handshake with the peer. +(When operating as server, in listen mode, this is more often required +by the peer, while client certificates only are mandated in certain +setups.) +

+
+
key_file, key=filename
+

A file containing the private key for the certificate. +

+
+
listen=1|0
+

If enabled, listen for connections on the provided port, and assume +the server role in the handshake instead of the client role. +

+
+
+ +

Example command lines: +

+

To create a TLS/SSL server that serves an input stream. +

+
+
ffmpeg -i input -f format tls://hostname:port?listen&cert=server.crt&key=server.key
+
+ +

To play back a stream from the TLS/SSL server using ffplay: +

+
+
ffplay tls://hostname:port
+
+ + +

18.38 udp

+ +

User Datagram Protocol. +

+

The required syntax for an UDP URL is: +

+
udp://hostname:port[?options]
+
+ +

options contains a list of &-separated options of the form key=val. +

+

In case threading is enabled on the system, a circular buffer is used +to store the incoming data, which allows one to reduce loss of data due to +UDP socket buffer overruns. The fifo_size and +overrun_nonfatal options are related to this buffer. +

+

The list of supported options follows. +

+
+
buffer_size=size
+

Set the UDP maximum socket buffer size in bytes. This is used to set either +the receive or send buffer size, depending on what the socket is used for. +Default is 32 KB for output, 384 KB for input. See also fifo_size. +

+
+
bitrate=bitrate
+

If set to nonzero, the output will have the specified constant bitrate if the +input has enough packets to sustain it. +

+
+
burst_bits=bits
+

When using bitrate this specifies the maximum number of bits in +packet bursts. +

+
+
localport=port
+

Override the local UDP port to bind with. +

+
+
localaddr=addr
+

Local IP address of a network interface used for sending packets or joining +multicast groups. +

+
+
pkt_size=size
+

Set the size in bytes of UDP packets. +

+
+
reuse=1|0
+

Explicitly allow or disallow reusing UDP sockets. +

+
+
ttl=ttl
+

Set the time to live value (for multicast only). +

+
+
connect=1|0
+

Initialize the UDP socket with connect(). In this case, the +destination address can’t be changed with ff_udp_set_remote_url later. +If the destination address isn’t known at the start, this option can +be specified in ff_udp_set_remote_url, too. +This allows finding out the source address for the packets with getsockname, +and makes writes return with AVERROR(ECONNREFUSED) if "destination +unreachable" is received. +For receiving, this gives the benefit of only receiving packets from +the specified peer address/port. +

+
+
sources=address[,address]
+

Only receive packets sent from the specified addresses. In case of multicast, +also subscribe to multicast traffic coming from these addresses only. +

+
+
block=address[,address]
+

Ignore packets sent from the specified addresses. In case of multicast, also +exclude the source addresses in the multicast subscription. +

+
+
fifo_size=units
+

Set the UDP receiving circular buffer size, expressed as a number of +packets with size of 188 bytes. If not specified defaults to 7*4096. +

+
+
overrun_nonfatal=1|0
+

Survive in case of UDP receiving circular buffer overrun. Default +value is 0. +

+
+
timeout=microseconds
+

Set raise error timeout, expressed in microseconds. +

+

This option is only relevant in read mode: if no data arrived in more +than this time interval, raise error. +

+
+
broadcast=1|0
+

Explicitly allow or disallow UDP broadcasting. +

+

Note that broadcasting may not work properly on networks having +a broadcast storm protection. +

+
+ + +

18.38.1 Examples

+ +
    +
  • Use ffmpeg to stream over UDP to a remote endpoint: +
    +
    ffmpeg -i input -f format udp://hostname:port
+
    + +
  • Use ffmpeg to stream in mpegts format over UDP using 188 +sized UDP packets, using a large input buffer: +
    +
    ffmpeg -i input -f mpegts udp://hostname:port?pkt_size=188&buffer_size=65535
+
    + +
  • Use ffmpeg to receive over UDP from a remote endpoint: +
    +
    ffmpeg -i udp://[multicast-address]:port ...
+
    +
+ + +

18.39 unix

+ +

Unix local socket +

+

The required syntax for a Unix socket URL is: +

+
+
unix://filepath
+
+ +

The following parameters can be set via command line options +(or in code via AVOptions): +

+
+
timeout
+

Timeout in ms. +

+
listen
+

Create the Unix socket in listening mode. +

+
+ + +

18.40 zmq

+ +

ZeroMQ asynchronous messaging using the libzmq library. +

+

This library supports unicast streaming to multiple clients without relying on +an external server. +

+

The required syntax for streaming or connecting to a stream is: +

+
zmq:tcp://ip-address:port
+
+ +

Example: +Create a localhost stream on port 5555: +

+
ffmpeg -re -i input -f mpegts zmq:tcp://127.0.0.1:5555
+
+ +

Multiple clients may connect to the stream using: +

+
ffplay zmq:tcp://127.0.0.1:5555
+
+ +

Streaming to multiple clients is implemented using a ZeroMQ Pub-Sub pattern. +The server side binds to a port and publishes data. Clients connect to the +server (via IP address/port) and subscribe to the stream. The order in which +the server and client start generally does not matter. +

+

ffmpeg must be compiled with the –enable-libzmq option to support +this protocol. +

+

Options can be set on the ffmpeg/ffplay command +line. The following options are supported: +

+
+
pkt_size
+

Forces the maximum packet size for sending/receiving data. The default value is +131,072 bytes. On the server side, this sets the maximum size of sent packets +via ZeroMQ. On the clients, it sets an internal buffer size for receiving +packets. Note that pkt_size on the clients should be equal to or greater than +pkt_size on the server. Otherwise the received message may be truncated causing +decoding errors. +

+
+
+ + + +

19 Device Options

+ +

The libavdevice library provides the same interface as +libavformat. Namely, an input device is considered like a demuxer, and +an output device like a muxer, and the interface and generic device +options are the same provided by libavformat (see the ffmpeg-formats +manual). +

+

In addition each input or output device may support so-called private +options, which are specific for that component. +

+

Options may be set by specifying -option value in the +FFmpeg tools, or by setting the value explicitly in the device +AVFormatContext options or using the libavutil/opt.h API +for programmatic use. +

+ + +

20 Input Devices

+ +

Input devices are configured elements in FFmpeg which enable accessing +the data coming from a multimedia device attached to your system. +

+

When you configure your FFmpeg build, all the supported input devices +are enabled by default. You can list all available ones using the +configure option "–list-indevs". +

+

You can disable all the input devices using the configure option +"–disable-indevs", and selectively enable an input device using the +option "–enable-indev=INDEV", or you can disable a particular +input device using the option "–disable-indev=INDEV". +

+

The option "-devices" of the ff* tools will display the list of +supported input devices. +

+

A description of the currently available input devices follows. +

+ +

20.1 alsa

+ +

ALSA (Advanced Linux Sound Architecture) input device. +

+

To enable this input device during configuration you need libasound +installed on your system. +

+

This device allows capturing from an ALSA device. The name of the +device to capture has to be an ALSA card identifier. +

+

An ALSA identifier has the syntax: +

+
hw:CARD[,DEV[,SUBDEV]]
+
+ +

where the DEV and SUBDEV components are optional. +

+

The three arguments (in order: CARD,DEV,SUBDEV) +specify card number or identifier, device number and subdevice number +(-1 means any). +

+

To see the list of cards currently recognized by your system check the +files /proc/asound/cards and /proc/asound/devices. +

+

For example to capture with ffmpeg from an ALSA device with +card id 0, you may run the command: +

+
ffmpeg -f alsa -i hw:0 alsaout.wav
+
+ +

For more information see: +http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html +

+ +

20.1.1 Options

+ +
+
sample_rate
+

Set the sample rate in Hz. Default is 48000. +

+
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

20.2 android_camera

+ +

Android camera input device. +

+

This input devices uses the Android Camera2 NDK API which is +available on devices with API level 24+. The availability of +android_camera is autodetected during configuration. +

+

This device allows capturing from all cameras on an Android device, +which are integrated into the Camera2 NDK API. +

+

The available cameras are enumerated internally and can be selected +with the camera_index parameter. The input file string is +discarded. +

+

Generally the back facing camera has index 0 while the front facing +camera has index 1. +

+ +

20.2.1 Options

+ +
+
video_size
+

Set the video size given as a string such as 640x480 or hd720. +Falls back to the first available configuration reported by +Android if requested video size is not available or by default. +

+
+
framerate
+

Set the video framerate. +Falls back to the first available configuration reported by +Android if requested framerate is not available or by default (-1). +

+
+
camera_index
+

Set the index of the camera to use. Default is 0. +

+
+
input_queue_size
+

Set the maximum number of frames to buffer. Default is 5. +

+
+
+ + +

20.3 avfoundation

+ +

AVFoundation input device. +

+

AVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX >= 10.7 as well as on iOS. +

+

The input filename has to be given in the following syntax: +

+
-i "[[VIDEO]:[AUDIO]]"
+
+

The first entry selects the video input while the latter selects the audio input. +The stream has to be specified by the device name or the device index as shown by the device list. +Alternatively, the video and/or audio input device can be chosen by index using the + + -video_device_index <INDEX> + +and/or + + -audio_device_index <INDEX> + +, overriding any +device name or index given in the input filename. +

+

All available devices can be enumerated by using -list_devices true, listing +all device names and corresponding indices. +

+

There are two device name aliases: +

+
default
+

Select the AVFoundation default device of the corresponding type. +

+
+
none
+

Do not record the corresponding media type. +This is equivalent to specifying an empty device name or index. +

+
+
+ + +

20.3.1 Options

+ +

AVFoundation supports the following options: +

+
+
-list_devices <TRUE|FALSE>
+

If set to true, a list of all available input devices is given showing all +device names and indices. +

+
+
-video_device_index <INDEX>
+

Specify the video device by its index. Overrides anything given in the input filename. +

+
+
-audio_device_index <INDEX>
+

Specify the audio device by its index. Overrides anything given in the input filename. +

+
+
-pixel_format <FORMAT>
+

Request the video device to use a specific pixel format. +If the specified format is not supported, a list of available formats is given +and the first one in this list is used instead. Available pixel formats are: +monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0, + bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10, + yuv420p, nv12, yuyv422, gray +

+
+
-framerate
+

Set the grabbing frame rate. Default is ntsc, corresponding to a +frame rate of 30000/1001. +

+
+
-video_size
+

Set the video frame size. +

+
+
-capture_cursor
+

Capture the mouse pointer. Default is 0. +

+
+
-capture_mouse_clicks
+

Capture the screen mouse clicks. Default is 0. +

+
+
-capture_raw_data
+

Capture the raw device data. Default is 0. +Using this option may result in receiving the underlying data delivered to the AVFoundation framework. E.g. for muxed devices that sends raw DV data to the framework (like tape-based camcorders), setting this option to false results in extracted video frames captured in the designated pixel format only. Setting this option to true results in receiving the raw DV stream untouched. +

+
+ + +

20.3.2 Examples

+ +
    +
  • Print the list of AVFoundation supported devices and exit: +
    +
    $ ffmpeg -f avfoundation -list_devices true -i ""
+
    + +
  • Record video from video device 0 and audio from audio device 0 into out.avi: +
    +
    $ ffmpeg -f avfoundation -i "0:0" out.avi
+
    + +
  • Record video from video device 2 and audio from audio device 1 into out.avi: +
    +
    $ ffmpeg -f avfoundation -video_device_index 2 -i ":1" out.avi
+
    + +
  • Record video from the system default video device using the pixel format bgr0 and do not record any audio into out.avi: +
    +
    $ ffmpeg -f avfoundation -pixel_format bgr0 -i "default:none" out.avi
+
    + +
  • Record raw DV data from a suitable input device and write the output into out.dv: +
    +
    $ ffmpeg -f avfoundation -capture_raw_data true -i "zr100:none" out.dv
+
    + + +
+ + +

20.4 bktr

+ +

BSD video input device. +

+ +

20.4.1 Options

+ +
+
framerate
+

Set the frame rate. +

+
+
video_size
+

Set the video frame size. Default is vga. +

+
+
standard
+
+

Available values are: +

+
‘pal’
+
‘ntsc’
+
‘secam’
+
‘paln’
+
‘palm’
+
‘ntscj’
+
+ +
+
+ + +

20.5 decklink

+ +

The decklink input device provides capture capabilities for Blackmagic +DeckLink devices. +

+

To enable this input device, you need the Blackmagic DeckLink SDK and you +need to configure with the appropriate --extra-cflags +and --extra-ldflags. +On Windows, you need to run the IDL files through widl. +

+

DeckLink is very picky about the formats it supports. Pixel format of the +input can be set with raw_format. +Framerate and video size must be determined for your device with +-list_formats 1. Audio sample rate is always 48 kHz and the number +of channels can be 2, 8 or 16. Note that all audio channels are bundled in one single +audio track. +

+ +

20.5.1 Options

+ +
+
list_devices
+

If set to true, print a list of devices and exit. +Defaults to false. This option is deprecated, please use the +-sources option of ffmpeg to list the available input devices. +

+
+
list_formats
+

If set to true, print a list of supported formats and exit. +Defaults to false. +

+
+
format_code <FourCC>
+

This sets the input video format to the format given by the FourCC. To see +the supported values of your device(s) use list_formats. +Note that there is a FourCC 'pal ' that can also be used +as pal (3 letters). +Default behavior is autodetection of the input video format, if the hardware +supports it. +

+
+
raw_format
+

Set the pixel format of the captured video. +Available values are: +

+
‘uyvy422’
+
‘yuv422p10’
+
‘argb’
+
‘bgra’
+
‘rgb10’
+
+ +
+
teletext_lines
+

If set to nonzero, an additional teletext stream will be captured from the +vertical ancillary data. Both SD PAL (576i) and HD (1080i or 1080p) +sources are supported. In case of HD sources, OP47 packets are decoded. +

+

This option is a bitmask of the SD PAL VBI lines captured, specifically lines 6 +to 22, and lines 318 to 335. Line 6 is the LSB in the mask. Selected lines +which do not contain teletext information will be ignored. You can use the +special all constant to select all possible lines, or +standard to skip lines 6, 318 and 319, which are not compatible with +all receivers. +

+

For SD sources, ffmpeg needs to be compiled with --enable-libzvbi. For +HD sources, on older (pre-4K) DeckLink card models you have to capture in 10 +bit mode. +

+
+
channels
+

Defines number of audio channels to capture. Must be ‘2’, ‘8’ or ‘16’. +Defaults to ‘2’. +

+
+
duplex_mode
+

Sets the decklink device duplex mode. Must be ‘unset’, ‘half’ or ‘full’. +Defaults to ‘unset’. +

+
+
timecode_format
+

Timecode type to include in the frame and video stream metadata. Must be +‘none’, ‘rp188vitc’, ‘rp188vitc2’, ‘rp188ltc’, +‘rp188any’, ‘vitc’, ‘vitc2’, or ‘serial’. Defaults to +‘none’ (not included). +

+
+
video_input
+

Sets the video input source. Must be ‘unset’, ‘sdi’, ‘hdmi’, +‘optical_sdi’, ‘component’, ‘composite’ or ‘s_video’. +Defaults to ‘unset’. +

+
+
audio_input
+

Sets the audio input source. Must be ‘unset’, ‘embedded’, +‘aes_ebu’, ‘analog’, ‘analog_xlr’, ‘analog_rca’ or +‘microphone’. Defaults to ‘unset’. +

+
+
video_pts
+

Sets the video packet timestamp source. Must be ‘video’, ‘audio’, +‘reference’, ‘wallclock’ or ‘abs_wallclock’. +Defaults to ‘video’. +

+
+
audio_pts
+

Sets the audio packet timestamp source. Must be ‘video’, ‘audio’, +‘reference’, ‘wallclock’ or ‘abs_wallclock’. +Defaults to ‘audio’. +

+
+
draw_bars
+

If set to ‘true’, color bars are drawn in the event of a signal loss. +Defaults to ‘true’. +

+
+
queue_size
+

Sets maximum input buffer size in bytes. If the buffering reaches this value, +incoming frames will be dropped. +Defaults to ‘1073741824’. +

+
+
audio_depth
+

Sets the audio sample bit depth. Must be ‘16’ or ‘32’. +Defaults to ‘16’. +

+
+
decklink_copyts
+

If set to true, timestamps are forwarded as they are without removing +the initial offset. +Defaults to false. +

+
+
timestamp_align
+

Capture start time alignment in seconds. If set to nonzero, input frames are +dropped till the system timestamp aligns with configured value. +Alignment difference of up to one frame duration is tolerated. +This is useful for maintaining input synchronization across N different +hardware devices deployed for ’N-way’ redundancy. The system time of different +hardware devices should be synchronized with protocols such as NTP or PTP, +before using this option. +Note that this method is not foolproof. In some border cases input +synchronization may not happen due to thread scheduling jitters in the OS. +Either sync could go wrong by 1 frame or in a rarer case +timestamp_align seconds. +Defaults to ‘0’. +

+
+
wait_for_tc (bool)
+

Drop frames till a frame with timecode is received. Sometimes serial timecode +isn’t received with the first input frame. If that happens, the stored stream +timecode will be inaccurate. If this option is set to true, input frames +are dropped till a frame with timecode is received. +Option timecode_format must be specified. +Defaults to false. +

+
+
+ + +

20.5.2 Examples

+ +
    +
  • List input devices: +
    +
    ffmpeg -sources decklink
+
    + +
  • List supported formats: +
    +
    ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
+
    + +
  • Capture video clip at 1080i50: +
    +
    ffmpeg -format_code Hi50 -f decklink -i 'Intensity Pro' -c:a copy -c:v copy output.avi
+
    + +
  • Capture video clip at 1080i50 10 bit: +
    +
    ffmpeg -raw_format yuv422p10 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi
+
    + +
  • Capture video clip at 1080i50 with 16 audio channels: +
    +
    ffmpeg -channels 16 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi
+
    + +
+ + +

20.6 dshow

+ +

Windows DirectShow input device. +

+

DirectShow support is enabled when FFmpeg is built with the mingw-w64 project. +Currently only audio and video devices are supported. +

+

Multiple devices may be opened as separate inputs, but they may also be +opened on the same input, which should improve synchronism between them. +

+

The input name should be in the format: +

+
+
TYPE=NAME[:TYPE=NAME]
+
+ +

where TYPE can be either audio or video, +and NAME is the device’s name or alternative name.. +

+ +

20.6.1 Options

+ +

If no options are specified, the device’s defaults are used. +If the device does not support the requested options, it will +fail to open. +

+
+
video_size
+

Set the video size in the captured video. +

+
+
framerate
+

Set the frame rate in the captured video. +

+
+
sample_rate
+

Set the sample rate (in Hz) of the captured audio. +

+
+
sample_size
+

Set the sample size (in bits) of the captured audio. +

+
+
channels
+

Set the number of channels in the captured audio. +

+
+
list_devices
+

If set to true, print a list of devices and exit. +

+
+
list_options
+

If set to true, print a list of selected device’s options +and exit. +

+
+
video_device_number
+

Set video device number for devices with the same name (starts at 0, +defaults to 0). +

+
+
audio_device_number
+

Set audio device number for devices with the same name (starts at 0, +defaults to 0). +

+
+
pixel_format
+

Select pixel format to be used by DirectShow. This may only be set when +the video codec is not set or set to rawvideo. +

+
+
audio_buffer_size
+

Set audio device buffer size in milliseconds (which can directly +impact latency, depending on the device). +Defaults to using the audio device’s +default buffer size (typically some multiple of 500ms). +Setting this value too low can degrade performance. +See also +http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx +

+
+
video_pin_name
+

Select video capture pin to use by name or alternative name. +

+
+
audio_pin_name
+

Select audio capture pin to use by name or alternative name. +

+
+
crossbar_video_input_pin_number
+

Select video input pin number for crossbar device. This will be +routed to the crossbar device’s Video Decoder output pin. +Note that changing this value can affect future invocations +(sets a new default) until system reboot occurs. +

+
+
crossbar_audio_input_pin_number
+

Select audio input pin number for crossbar device. This will be +routed to the crossbar device’s Audio Decoder output pin. +Note that changing this value can affect future invocations +(sets a new default) until system reboot occurs. +

+
+
show_video_device_dialog
+

If set to true, before capture starts, popup a display dialog +to the end user, allowing them to change video filter properties +and configurations manually. +Note that for crossbar devices, adjusting values in this dialog +may be needed at times to toggle between PAL (25 fps) and NTSC (29.97) +input frame rates, sizes, interlacing, etc. Changing these values can +enable different scan rates/frame rates and avoiding green bars at +the bottom, flickering scan lines, etc. +Note that with some devices, changing these properties can also affect future +invocations (sets new defaults) until system reboot occurs. +

+
+
show_audio_device_dialog
+

If set to true, before capture starts, popup a display dialog +to the end user, allowing them to change audio filter properties +and configurations manually. +

+
+
show_video_crossbar_connection_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify crossbar pin routings, when it opens a video device. +

+
+
show_audio_crossbar_connection_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify crossbar pin routings, when it opens an audio device. +

+
+
show_analog_tv_tuner_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify TV channels and frequencies. +

+
+
show_analog_tv_tuner_audio_dialog
+

If set to true, before capture starts, popup a display +dialog to the end user, allowing them to manually +modify TV audio (like mono vs. stereo, Language A,B or C). +

+
+
audio_device_load
+

Load an audio capture filter device from file instead of searching +it by name. It may load additional parameters too, if the filter +supports the serialization of its properties to. +To use this an audio capture source has to be specified, but it can +be anything even fake one. +

+
+
audio_device_save
+

Save the currently used audio capture filter device and its +parameters (if the filter supports it) to a file. +If a file with the same name exists it will be overwritten. +

+
+
video_device_load
+

Load a video capture filter device from file instead of searching +it by name. It may load additional parameters too, if the filter +supports the serialization of its properties to. +To use this a video capture source has to be specified, but it can +be anything even fake one. +

+
+
video_device_save
+

Save the currently used video capture filter device and its +parameters (if the filter supports it) to a file. +If a file with the same name exists it will be overwritten. +

+
+
+ + +

20.6.2 Examples

+ +
    +
  • Print the list of DirectShow supported devices and exit: +
    +
    $ ffmpeg -list_devices true -f dshow -i dummy
+
    + +
  • Open video device Camera: +
    +
    $ ffmpeg -f dshow -i video="Camera"
+
    + +
  • Open second video device with name Camera: +
    +
    $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
+
    + +
  • Open video device Camera and audio device Microphone: +
    +
    $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
+
    + +
  • Print the list of supported options in selected device and exit: +
    +
    $ ffmpeg -list_options true -f dshow -i video="Camera"
+
    + +
  • Specify pin names to capture by name or alternative name, specify alternative device name: +
    +
    $ ffmpeg -f dshow -audio_pin_name "Audio Out" -video_pin_name 2 -i video=video="@device_pnp_\\?\pci#ven_1a0a&dev_6200&subsys_62021461&rev_01#4&e2c7dd6&0&00e1#{65e8773d-8f56-11d0-a3b9-00a0c9223196}\{ca465100-deb0-4d59-818f-8c477184adf6}":audio="Microphone"
+
    + +
  • Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup: +
    +
    $ ffmpeg -f dshow -show_video_device_dialog true -crossbar_video_input_pin_number 0
+     -crossbar_audio_input_pin_number 3 -i video="AVerMedia BDA Analog Capture":audio="AVerMedia BDA Analog Capture"
+
    + +
+ + +

20.7 fbdev

+ +

Linux framebuffer input device. +

+

The Linux framebuffer is a graphic hardware-independent abstraction +layer to show graphics on a computer monitor, typically on the +console. It is accessed through a file device node, usually +/dev/fb0. +

+

For more detailed information read the file +Documentation/fb/framebuffer.txt included in the Linux source tree. +

+

See also http://linux-fbdev.sourceforge.net/, and fbset(1). +

+

To record from the framebuffer device /dev/fb0 with +ffmpeg: +

+
ffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi
+
+ +

You can take a single screenshot image with the command: +

+
ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
+
+ + +

20.7.1 Options

+ +
+
framerate
+

Set the frame rate. Default is 25. +

+
+
+ + +

20.8 gdigrab

+ +

Win32 GDI-based screen capture device. +

+

This device allows you to capture a region of the display on Windows. +

+

There are two options for the input filename: +

+
desktop
+
+

or +

+
title=window_title
+
+ +

The first option will capture the entire desktop, or a fixed region of the +desktop. The second option will instead capture the contents of a single +window, regardless of its position on the screen. +

+

For example, to grab the entire desktop using ffmpeg: +

+
ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
+
+ +

Grab a 640x480 region at position 10,20: +

+
ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
+
+ +

Grab the contents of the window named "Calculator" +

+
ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
+
+ + +

20.8.1 Options

+ +
+
draw_mouse
+

Specify whether to draw the mouse pointer. Use the value 0 to +not draw the pointer. Default value is 1. +

+
+
framerate
+

Set the grabbing frame rate. Default value is ntsc, +corresponding to a frame rate of 30000/1001. +

+
+
show_region
+

Show grabbed region on screen. +

+

If show_region is specified with 1, then the grabbing +region will be indicated on screen. With this option, it is easy to +know what is being grabbed if only a portion of the screen is grabbed. +

+

Note that show_region is incompatible with grabbing the contents +of a single window. +

+

For example: +

+
ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
+
+ +
+
video_size
+

Set the video frame size. The default is to capture the full screen if desktop is selected, or the full window size if title=window_title is selected. +

+
+
offset_x
+

When capturing a region with video_size, set the distance from the left edge of the screen or desktop. +

+

Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned to the left of your primary monitor, you will need to use a negative offset_x value to move the region to that monitor. +

+
+
offset_y
+

When capturing a region with video_size, set the distance from the top edge of the screen or desktop. +

+

Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned above your primary monitor, you will need to use a negative offset_y value to move the region to that monitor. +

+
+
+ + +

20.9 iec61883

+ +

FireWire DV/HDV input device using libiec61883. +

+

To enable this input device, you need libiec61883, libraw1394 and +libavc1394 installed on your system. Use the configure option +--enable-libiec61883 to compile with the device enabled. +

+

The iec61883 capture device supports capturing from a video device +connected via IEEE1394 (FireWire), using libiec61883 and the new Linux +FireWire stack (juju). This is the default DV/HDV input method in Linux +Kernel 2.6.37 and later, since the old FireWire stack was removed. +

+

Specify the FireWire port to be used as input file, or "auto" +to choose the first port connected. +

+ +

20.9.1 Options

+ +
+
dvtype
+

Override autodetection of DV/HDV. This should only be used if auto +detection does not work, or if usage of a different device type +should be prohibited. Treating a DV device as HDV (or vice versa) will +not work and result in undefined behavior. +The values auto, dv and hdv are supported. +

+
+
dvbuffer
+

Set maximum size of buffer for incoming data, in frames. For DV, this +is an exact value. For HDV, it is not frame exact, since HDV does +not have a fixed frame size. +

+
+
dvguid
+

Select the capture device by specifying its GUID. Capturing will only +be performed from the specified device and fails if no device with the +given GUID is found. This is useful to select the input if multiple +devices are connected at the same time. +Look at /sys/bus/firewire/devices to find out the GUIDs. +

+
+
+ + +

20.9.2 Examples

+ +
    +
  • Grab and show the input of a FireWire DV/HDV device. +
    +
    ffplay -f iec61883 -i auto
+
    + +
  • Grab and record the input of a FireWire DV/HDV device, +using a packet buffer of 100000 packets if the source is HDV. +
    +
    ffmpeg -f iec61883 -i auto -dvbuffer 100000 out.mpg
+
    + +
+ + +

20.10 jack

+ +

JACK input device. +

+

To enable this input device during configuration you need libjack +installed on your system. +

+

A JACK input device creates one or more JACK writable clients, one for +each audio channel, with name client_name:input_N, where +client_name is the name provided by the application, and N +is a number which identifies the channel. +Each writable client will send the acquired data to the FFmpeg input +device. +

+

Once you have created one or more JACK readable clients, you need to +connect them to one or more JACK writable clients. +

+

To connect or disconnect JACK clients you can use the jack_connect +and jack_disconnect programs, or do it through a graphical interface, +for example with qjackctl. +

+

To list the JACK clients and their properties you can invoke the command +jack_lsp. +

+

Follows an example which shows how to capture a JACK readable client +with ffmpeg. +

+
# Create a JACK writable client with name "ffmpeg".
+$ ffmpeg -f jack -i ffmpeg -y out.wav
+
+# Start the sample jack_metro readable client.
+$ jack_metro -b 120 -d 0.2 -f 4000
+
+# List the current JACK clients.
+$ jack_lsp -c
+system:capture_1
+system:capture_2
+system:playback_1
+system:playback_2
+ffmpeg:input_1
+metro:120_bpm
+
+# Connect metro to the ffmpeg writable client.
+$ jack_connect metro:120_bpm ffmpeg:input_1
+
+ +

For more information read: +http://jackaudio.org/ +

+ +

20.10.1 Options

+ +
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

20.11 kmsgrab

+ +

KMS video input device. +

+

Captures the KMS scanout framebuffer associated with a specified CRTC or plane as a +DRM object that can be passed to other hardware functions. +

+

Requires either DRM master or CAP_SYS_ADMIN to run. +

+

If you don’t understand what all of that means, you probably don’t want this. Look at +x11grab instead. +

+ +

20.11.1 Options

+ +
+
device
+

DRM device to capture on. Defaults to /dev/dri/card0. +

+
+
format
+

Pixel format of the framebuffer. Defaults to bgr0. +

+
+
format_modifier
+

Format modifier to signal on output frames. This is necessary to import correctly into +some APIs, but can’t be autodetected. See the libdrm documentation for possible values. +

+
+
crtc_id
+

KMS CRTC ID to define the capture source. The first active plane on the given CRTC +will be used. +

+
+
plane_id
+

KMS plane ID to define the capture source. Defaults to the first active plane found if +neither crtc_id nor plane_id are specified. +

+
+
framerate
+

Framerate to capture at. This is not synchronised to any page flipping or framebuffer +changes - it just defines the interval at which the framebuffer is sampled. Sampling +faster than the framebuffer update rate will generate independent frames with the same +content. Defaults to 30. +

+
+
+ + +

20.11.2 Examples

+ +
    +
  • Capture from the first active plane, download the result to normal frames and encode. +This will only work if the framebuffer is both linear and mappable - if not, the result +may be scrambled or fail to download. +
    +
    ffmpeg -f kmsgrab -i - -vf 'hwdownload,format=bgr0' output.mp4
+
    + +
  • Capture from CRTC ID 42 at 60fps, map the result to VAAPI, convert to NV12 and encode as H.264. +
    +
    ffmpeg -crtc_id 42 -framerate 60 -f kmsgrab -i - -vf 'hwmap=derive_device=vaapi,scale_vaapi=w=1920:h=1080:format=nv12' -c:v h264_vaapi output.mp4
+
    + +
  • To capture only part of a plane the output can be cropped - this can be used to capture +a single window, as long as it has a known absolute position and size. For example, to +capture and encode the middle quarter of a 1920x1080 plane: +
    +
    ffmpeg -f kmsgrab -i - -vf 'hwmap=derive_device=vaapi,crop=960:540:480:270,scale_vaapi=960:540:nv12' -c:v h264_vaapi output.mp4
+
    + +
+ + +

20.12 lavfi

+ +

Libavfilter input virtual device. +

+

This input device reads data from the open output pads of a libavfilter +filtergraph. +

+

For each filtergraph open output, the input device will create a +corresponding stream which is mapped to the generated output. Currently +only video data is supported. The filtergraph is specified through the +option graph. +

+ +

20.12.1 Options

+ +
+
graph
+

Specify the filtergraph to use as input. Each video open output must be +labelled by a unique string of the form "outN", where N is a +number starting from 0 corresponding to the mapped input stream +generated by the device. +The first unlabelled output is automatically assigned to the "out0" +label, but all the others need to be specified explicitly. +

+

The suffix "+subcc" can be appended to the output label to create an extra +stream with the closed captions packets attached to that output +(experimental; only for EIA-608 / CEA-708 for now). +The subcc streams are created after all the normal streams, in the order of +the corresponding stream. +For example, if there is "out19+subcc", "out7+subcc" and up to "out42", the +stream #43 is subcc for stream #7 and stream #44 is subcc for stream #19. +

+

If not specified defaults to the filename specified for the input +device. +

+
+
graph_file
+

Set the filename of the filtergraph to be read and sent to the other +filters. Syntax of the filtergraph is the same as the one specified by +the option graph. +

+
+
dumpgraph
+

Dump graph to stderr. +

+
+
+ + +

20.12.2 Examples

+ +
    +
  • Create a color video stream and play it back with ffplay: +
    +
    ffplay -f lavfi -graph "color=c=pink [out0]" dummy
+
    + +
  • As the previous example, but use filename for specifying the graph +description, and omit the "out0" label: +
    +
    ffplay -f lavfi color=c=pink
+
    + +
  • Create three different video test filtered sources and play them: +
    +
    ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
+
    + +
  • Read an audio stream from a file using the amovie source and play it +back with ffplay: +
    +
    ffplay -f lavfi "amovie=test.wav"
+
    + +
  • Read an audio stream and a video stream and play it back with +ffplay: +
    +
    ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
+
    + +
  • Dump decoded frames to images and closed captions to a file (experimental): +
    +
    ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
+
    + +
+ + +

20.13 libcdio

+ +

Audio-CD input device based on libcdio. +

+

To enable this input device during configuration you need libcdio +installed on your system. It requires the configure option +--enable-libcdio. +

+

This device allows playing and grabbing from an Audio-CD. +

+

For example to copy with ffmpeg the entire Audio-CD in /dev/sr0, +you may run the command: +

+
ffmpeg -f libcdio -i /dev/sr0 cd.wav
+
+ + +

20.13.1 Options

+
+
speed
+

Set drive reading speed. Default value is 0. +

+

The speed is specified CD-ROM speed units. The speed is set through +the libcdio cdio_cddap_speed_set function. On many CD-ROM +drives, specifying a value too large will result in using the fastest +speed. +

+
+
paranoia_mode
+

Set paranoia recovery mode flags. It accepts one of the following values: +

+
+
‘disable’
+
‘verify’
+
‘overlap’
+
‘neverskip’
+
‘full’
+
+ +

Default value is ‘disable’. +

+

For more information about the available recovery modes, consult the +paranoia project documentation. +

+
+ + +

20.14 libdc1394

+ +

IIDC1394 input device, based on libdc1394 and libraw1394. +

+

Requires the configure option --enable-libdc1394. +

+ +

20.14.1 Options

+
+
framerate
+

Set the frame rate. Default is ntsc, corresponding to a frame +rate of 30000/1001. +

+
+
pixel_format
+

Select the pixel format. Default is uyvy422. +

+
+
video_size
+

Set the video size given as a string such as 640x480 or hd720. +Default is qvga. +

+
+ + +

20.15 openal

+ +

The OpenAL input device provides audio capture on all systems with a +working OpenAL 1.1 implementation. +

+

To enable this input device during configuration, you need OpenAL +headers and libraries installed on your system, and need to configure +FFmpeg with --enable-openal. +

+

OpenAL headers and libraries should be provided as part of your OpenAL +implementation, or as an additional download (an SDK). Depending on your +installation you may need to specify additional flags via the +--extra-cflags and --extra-ldflags for allowing the build +system to locate the OpenAL headers and libraries. +

+

An incomplete list of OpenAL implementations follows: +

+
+
Creative
+

The official Windows implementation, providing hardware acceleration +with supported devices and software fallback. +See http://openal.org/. +

+
OpenAL Soft
+

Portable, open source (LGPL) software implementation. Includes +backends for the most common sound APIs on the Windows, Linux, +Solaris, and BSD operating systems. +See http://kcat.strangesoft.net/openal.html. +

+
Apple
+

OpenAL is part of Core Audio, the official Mac OS X Audio interface. +See http://developer.apple.com/technologies/mac/audio-and-video.html +

+
+ +

This device allows one to capture from an audio input device handled +through OpenAL. +

+

You need to specify the name of the device to capture in the provided +filename. If the empty string is provided, the device will +automatically select the default device. You can get the list of the +supported devices by using the option list_devices. +

+ +

20.15.1 Options

+ +
+
channels
+

Set the number of channels in the captured audio. Only the values +1 (monaural) and 2 (stereo) are currently supported. +Defaults to 2. +

+
+
sample_size
+

Set the sample size (in bits) of the captured audio. Only the values +8 and 16 are currently supported. Defaults to +16. +

+
+
sample_rate
+

Set the sample rate (in Hz) of the captured audio. +Defaults to 44.1k. +

+
+
list_devices
+

If set to true, print a list of devices and exit. +Defaults to false. +

+
+
+ + +

20.15.2 Examples

+ +

Print the list of OpenAL supported devices and exit: +

+
$ ffmpeg -list_devices true -f openal -i dummy out.ogg
+
+ +

Capture from the OpenAL device DR-BT101 via PulseAudio: +

+
$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
+
+ +

Capture from the default device (note the empty string ” as filename): +

+
$ ffmpeg -f openal -i '' out.ogg
+
+ +

Capture from two devices simultaneously, writing to two different files, +within the same ffmpeg command: +

+
$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
+
+

Note: not all OpenAL implementations support multiple simultaneous capture - +try the latest OpenAL Soft if the above does not work. +

+ +

20.16 oss

+ +

Open Sound System input device. +

+

The filename to provide to the input device is the device node +representing the OSS input device, and is usually set to +/dev/dsp. +

+

For example to grab from /dev/dsp using ffmpeg use the +command: +

+
ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
+
+ +

For more information about OSS see: +http://manuals.opensound.com/usersguide/dsp.html +

+ +

20.16.1 Options

+ +
+
sample_rate
+

Set the sample rate in Hz. Default is 48000. +

+
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

20.17 pulse

+ +

PulseAudio input device. +

+

To enable this output device you need to configure FFmpeg with --enable-libpulse. +

+

The filename to provide to the input device is a source device or the +string "default" +

+

To list the PulseAudio source devices and their properties you can invoke +the command pactl list sources. +

+

More information about PulseAudio can be found on http://www.pulseaudio.org. +

+ +

20.17.1 Options

+
+
server
+

Connect to a specific PulseAudio server, specified by an IP address. +Default server is used when not provided. +

+
+
name
+

Specify the application name PulseAudio will use when showing active clients, +by default it is the LIBAVFORMAT_IDENT string. +

+
+
stream_name
+

Specify the stream name PulseAudio will use when showing active streams, +by default it is "record". +

+
+
sample_rate
+

Specify the samplerate in Hz, by default 48kHz is used. +

+
+
channels
+

Specify the channels in use, by default 2 (stereo) is set. +

+
+
frame_size
+

Specify the number of bytes per frame, by default it is set to 1024. +

+
+
fragment_size
+

Specify the minimal buffering fragment in PulseAudio, it will affect the +audio latency. By default it is unset. +

+
+
wallclock
+

Set the initial PTS using the current time. Default is 1. +

+
+
+ + +

20.17.2 Examples

+

Record a stream from default device: +

+
ffmpeg -f pulse -i default /tmp/pulse.wav
+
+ + +

20.18 sndio

+ +

sndio input device. +

+

To enable this input device during configuration you need libsndio +installed on your system. +

+

The filename to provide to the input device is the device node +representing the sndio input device, and is usually set to +/dev/audio0. +

+

For example to grab from /dev/audio0 using ffmpeg use the +command: +

+
ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
+
+ + +

20.18.1 Options

+ +
+
sample_rate
+

Set the sample rate in Hz. Default is 48000. +

+
+
channels
+

Set the number of channels. Default is 2. +

+
+
+ + +

20.19 video4linux2, v4l2

+ +

Video4Linux2 input video device. +

+

"v4l2" can be used as alias for "video4linux2". +

+

If FFmpeg is built with v4l-utils support (by using the +--enable-libv4l2 configure option), it is possible to use it with the +-use_libv4l2 input device option. +

+

The name of the device to grab is a file device node, usually Linux +systems tend to automatically create such nodes when the device +(e.g. an USB webcam) is plugged into the system, and has a name of the +kind /dev/videoN, where N is a number associated to +the device. +

+

Video4Linux2 devices usually support a limited set of +widthxheight sizes and frame rates. You can check which are +supported using -list_formats all for Video4Linux2 devices. +Some devices, like TV cards, support one or more standards. It is possible +to list all the supported standards using -list_standards all. +

+

The time base for the timestamps is 1 microsecond. Depending on the kernel +version and configuration, the timestamps may be derived from the real time +clock (origin at the Unix Epoch) or the monotonic clock (origin usually at +boot time, unaffected by NTP or manual changes to the clock). The +-timestamps abs or -ts abs option can be used to force +conversion into the real time clock. +

+

Some usage examples of the video4linux2 device with ffmpeg +and ffplay: +

    +
  • List supported formats for a video4linux2 device: +
    +
    ffplay -f video4linux2 -list_formats all /dev/video0
+
    + +
  • Grab and show the input of a video4linux2 device: +
    +
    ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
+
    + +
  • Grab and record the input of a video4linux2 device, leave the +frame rate and size as previously set: +
    +
    ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
+
    +
+ +

For more information about Video4Linux, check http://linuxtv.org/. +

+ +

20.19.1 Options

+ +
+
standard
+

Set the standard. Must be the name of a supported standard. To get a +list of the supported standards, use the list_standards +option. +

+
+
channel
+

Set the input channel number. Default to -1, which means using the +previously selected channel. +

+
+
video_size
+

Set the video frame size. The argument must be a string in the form +WIDTHxHEIGHT or a valid size abbreviation. +

+
+
pixel_format
+

Select the pixel format (only valid for raw video input). +

+
+
input_format
+

Set the preferred pixel format (for raw video) or a codec name. +This option allows one to select the input format, when several are +available. +

+
+
framerate
+

Set the preferred video frame rate. +

+
+
list_formats
+

List available formats (supported pixel formats, codecs, and frame +sizes) and exit. +

+

Available values are: +

+
‘all’
+

Show all available (compressed and non-compressed) formats. +

+
+
‘raw’
+

Show only raw video (non-compressed) formats. +

+
+
‘compressed’
+

Show only compressed formats. +

+
+ +
+
list_standards
+

List supported standards and exit. +

+

Available values are: +

+
‘all’
+

Show all supported standards. +

+
+ +
+
timestamps, ts
+

Set type of timestamps for grabbed frames. +

+

Available values are: +

+
‘default’
+

Use timestamps from the kernel. +

+
+
‘abs’
+

Use absolute timestamps (wall clock). +

+
+
‘mono2abs’
+

Force conversion from monotonic to absolute timestamps. +

+
+ +

Default value is default. +

+
+
use_libv4l2
+

Use libv4l2 (v4l-utils) conversion functions. Default is 0. +

+
+
+ + +

20.20 vfwcap

+ +

VfW (Video for Windows) capture input device. +

+

The filename passed as input is the capture driver number, ranging from +0 to 9. You may use "list" as filename to print a list of drivers. Any +other filename will be interpreted as device number 0. +

+ +

20.20.1 Options

+ +
+
video_size
+

Set the video frame size. +

+
+
framerate
+

Set the grabbing frame rate. Default value is ntsc, +corresponding to a frame rate of 30000/1001. +

+
+
+ + +

20.21 x11grab

+ +

X11 video input device. +

+

To enable this input device during configuration you need libxcb +installed on your system. It will be automatically detected during +configuration. +

+

This device allows one to capture a region of an X11 display. +

+

The filename passed as input has the syntax: +

+
[hostname]:display_number.screen_number[+x_offset,y_offset]
+
+ +

hostname:display_number.screen_number specifies the +X11 display name of the screen to grab from. hostname can be +omitted, and defaults to "localhost". The environment variable +DISPLAY contains the default display name. +

+

x_offset and y_offset specify the offsets of the grabbed +area with respect to the top-left border of the X11 screen. They +default to 0. +

+

Check the X11 documentation (e.g. man X) for more detailed +information. +

+

Use the xdpyinfo program for getting basic information about +the properties of your X11 display (e.g. grep for "name" or +"dimensions"). +

+

For example to grab from :0.0 using ffmpeg: +

+
ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +

Grab at position 10,20: +

+
ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
+
+ + +

20.21.1 Options

+ +
+
draw_mouse
+

Specify whether to draw the mouse pointer. A value of 0 specifies +not to draw the pointer. Default value is 1. +

+
+
follow_mouse
+

Make the grabbed area follow the mouse. The argument can be +centered or a number of pixels PIXELS. +

+

When it is specified with "centered", the grabbing region follows the mouse +pointer and keeps the pointer at the center of region; otherwise, the region +follows only when the mouse pointer reaches within PIXELS (greater than +zero) to the edge of region. +

+

For example: +

+
ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +

To follow only when the mouse pointer reaches within 100 pixels to edge: +

+
ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +
+
framerate
+

Set the grabbing frame rate. Default value is ntsc, +corresponding to a frame rate of 30000/1001. +

+
+
show_region
+

Show grabbed region on screen. +

+

If show_region is specified with 1, then the grabbing +region will be indicated on screen. With this option, it is easy to +know what is being grabbed if only a portion of the screen is grabbed. +

+
+
region_border
+

Set the region border thickness if -show_region 1 is used. +Range is 1 to 128 and default is 3 (XCB-based x11grab only). +

+

For example: +

+
ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
+
+ +

With follow_mouse: +

+
ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
+
+ +
+
video_size
+

Set the video frame size. Default is the full desktop. +

+
+
grab_x
+
grab_y
+

Set the grabbing region coordinates. They are expressed as offset from +the top left corner of the X11 window and correspond to the +x_offset and y_offset parameters in the device name. The +default value for both options is 0. +

+
+ + +

21 Resampler Options

+ +

The audio resampler supports the following named options. +

+

Options may be set by specifying -option value in the +FFmpeg tools, option=value for the aresample filter, +by setting the value explicitly in the +SwrContext options or using the libavutil/opt.h API for +programmatic use. +

+
+
ich, in_channel_count
+

Set the number of input channels. Default value is 0. Setting this +value is not mandatory if the corresponding channel layout +in_channel_layout is set. +

+
+
och, out_channel_count
+

Set the number of output channels. Default value is 0. Setting this +value is not mandatory if the corresponding channel layout +out_channel_layout is set. +

+
+
uch, used_channel_count
+

Set the number of used input channels. Default value is 0. This option is +only used for special remapping. +

+
+
isr, in_sample_rate
+

Set the input sample rate. Default value is 0. +

+
+
osr, out_sample_rate
+

Set the output sample rate. Default value is 0. +

+
+
isf, in_sample_fmt
+

Specify the input sample format. It is set by default to none. +

+
+
osf, out_sample_fmt
+

Specify the output sample format. It is set by default to none. +

+
+
tsf, internal_sample_fmt
+

Set the internal sample format. Default value is none. +This will automatically be chosen when it is not explicitly set. +

+
+
icl, in_channel_layout
+
ocl, out_channel_layout
+

Set the input/output channel layout. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+
clev, center_mix_level
+

Set the center mix level. It is a value expressed in deciBel, and must be +in the interval [-32,32]. +

+
+
slev, surround_mix_level
+

Set the surround mix level. It is a value expressed in deciBel, and must +be in the interval [-32,32]. +

+
+
lfe_mix_level
+

Set LFE mix into non LFE level. It is used when there is a LFE input but no +LFE output. It is a value expressed in deciBel, and must +be in the interval [-32,32]. +

+
+
rmvol, rematrix_volume
+

Set rematrix volume. Default value is 1.0. +

+
+
rematrix_maxval
+

Set maximum output value for rematrixing. +This can be used to prevent clipping vs. preventing volume reduction. +A value of 1.0 prevents clipping. +

+
+
flags, swr_flags
+

Set flags used by the converter. Default value is 0. +

+

It supports the following individual flags: +

+
res
+

force resampling, this flag forces resampling to be used even when the +input and output sample rates match. +

+
+ +
+
dither_scale
+

Set the dither scale. Default value is 1. +

+
+
dither_method
+

Set dither method. Default value is 0. +

+

Supported values: +

+
‘rectangular’
+

select rectangular dither +

+
‘triangular’
+

select triangular dither +

+
‘triangular_hp’
+

select triangular dither with high pass +

+
‘lipshitz’
+

select Lipshitz noise shaping dither. +

+
‘shibata’
+

select Shibata noise shaping dither. +

+
‘low_shibata’
+

select low Shibata noise shaping dither. +

+
‘high_shibata’
+

select high Shibata noise shaping dither. +

+
‘f_weighted’
+

select f-weighted noise shaping dither +

+
‘modified_e_weighted’
+

select modified-e-weighted noise shaping dither +

+
‘improved_e_weighted’
+

select improved-e-weighted noise shaping dither +

+
+
+ +
+
resampler
+

Set resampling engine. Default value is swr. +

+

Supported values: +

+
‘swr’
+

select the native SW Resampler; filter options precision and cheby are not +applicable in this case. +

+
‘soxr’
+

select the SoX Resampler (where available); compensation, and filter options +filter_size, phase_shift, exact_rational, filter_type & kaiser_beta, are not +applicable in this case. +

+
+ +
+
filter_size
+

For swr only, set resampling filter size, default value is 32. +

+
+
phase_shift
+

For swr only, set resampling phase shift, default value is 10, and must be in +the interval [0,30]. +

+
+
linear_interp
+

Use linear interpolation when enabled (the default). Disable it if you want +to preserve speed instead of quality when exact_rational fails. +

+
+
exact_rational
+

For swr only, when enabled, try to use exact phase_count based on input and +output sample rate. However, if it is larger than 1 << phase_shift, +the phase_count will be 1 << phase_shift as fallback. Default is enabled. +

+
+
cutoff
+

Set cutoff frequency (swr: 6dB point; soxr: 0dB point) ratio; must be a float +value between 0 and 1. Default value is 0.97 with swr, and 0.91 with soxr +(which, with a sample-rate of 44100, preserves the entire audio band to 20kHz). +

+
+
precision
+

For soxr only, the precision in bits to which the resampled signal will be +calculated. The default value of 20 (which, with suitable dithering, is +appropriate for a destination bit-depth of 16) gives SoX’s ’High Quality’; a +value of 28 gives SoX’s ’Very High Quality’. +

+
+
cheby
+

For soxr only, selects passband rolloff none (Chebyshev) & higher-precision +approximation for ’irrational’ ratios. Default value is 0. +

+
+
async
+

For swr only, simple 1 parameter audio sync to timestamps using stretching, +squeezing, filling and trimming. Setting this to 1 will enable filling and +trimming, larger values represent the maximum amount in samples that the data +may be stretched or squeezed for each second. +Default value is 0, thus no compensation is applied to make the samples match +the audio timestamps. +

+
+
first_pts
+

For swr only, assume the first pts should be this value. The time unit is 1 / sample rate. +This allows for padding/trimming at the start of stream. By default, no +assumption is made about the first frame’s expected pts, so no padding or +trimming is done. For example, this could be set to 0 to pad the beginning with +silence if an audio stream starts after the video stream or to trim any samples +with a negative pts due to encoder delay. +

+
+
min_comp
+

For swr only, set the minimum difference between timestamps and audio data (in +seconds) to trigger stretching/squeezing/filling or trimming of the +data to make it match the timestamps. The default is that +stretching/squeezing/filling and trimming is disabled +(min_comp = FLT_MAX). +

+
+
min_hard_comp
+

For swr only, set the minimum difference between timestamps and audio data (in +seconds) to trigger adding/dropping samples to make it match the +timestamps. This option effectively is a threshold to select between +hard (trim/fill) and soft (squeeze/stretch) compensation. Note that +all compensation is by default disabled through min_comp. +The default is 0.1. +

+
+
comp_duration
+

For swr only, set duration (in seconds) over which data is stretched/squeezed +to make it match the timestamps. Must be a non-negative double float value, +default value is 1.0. +

+
+
max_soft_comp
+

For swr only, set maximum factor by which data is stretched/squeezed to make it +match the timestamps. Must be a non-negative double float value, default value +is 0. +

+
+
matrix_encoding
+

Select matrixed stereo encoding. +

+

It accepts the following values: +

+
‘none’
+

select none +

+
‘dolby’
+

select Dolby +

+
‘dplii’
+

select Dolby Pro Logic II +

+
+ +

Default value is none. +

+
+
filter_type
+

For swr only, select resampling filter type. This only affects resampling +operations. +

+

It accepts the following values: +

+
‘cubic’
+

select cubic +

+
‘blackman_nuttall’
+

select Blackman Nuttall windowed sinc +

+
‘kaiser’
+

select Kaiser windowed sinc +

+
+ +
+
kaiser_beta
+

For swr only, set Kaiser window beta value. Must be a double float value in the +interval [2,16], default value is 9. +

+
+
output_sample_bits
+

For swr only, set number of used output sample bits for dithering. Must be an integer in the +interval [0,64], default value is 0, which means it’s not used. +

+
+
+ + +

22 Scaler Options

+ +

The video scaler supports the following named options. +

+

Options may be set by specifying -option value in the +FFmpeg tools, with a few API-only exceptions noted below. +For programmatic use, they can be set explicitly in the +SwsContext options or through the libavutil/opt.h API. +

+
+
+
+
sws_flags
+

Set the scaler flags. This is also used to set the scaling +algorithm. Only a single algorithm should be selected. Default +value is ‘bicubic’. +

+

It accepts the following values: +

+
‘fast_bilinear’
+

Select fast bilinear scaling algorithm. +

+
+
‘bilinear’
+

Select bilinear scaling algorithm. +

+
+
‘bicubic’
+

Select bicubic scaling algorithm. +

+
+
‘experimental’
+

Select experimental scaling algorithm. +

+
+
‘neighbor’
+

Select nearest neighbor rescaling algorithm. +

+
+
‘area’
+

Select averaging area rescaling algorithm. +

+
+
‘bicublin’
+

Select bicubic scaling algorithm for the luma component, bilinear for +chroma components. +

+
+
‘gauss’
+

Select Gaussian rescaling algorithm. +

+
+
‘sinc’
+

Select sinc rescaling algorithm. +

+
+
‘lanczos’
+

Select Lanczos rescaling algorithm. The default width (alpha) is 3 and can be +changed by setting param0. +

+
+
‘spline’
+

Select natural bicubic spline rescaling algorithm. +

+
+
‘print_info’
+

Enable printing/debug logging. +

+
+
‘accurate_rnd’
+

Enable accurate rounding. +

+
+
‘full_chroma_int’
+

Enable full chroma interpolation. +

+
+
‘full_chroma_inp’
+

Select full chroma input. +

+
+
‘bitexact’
+

Enable bitexact output. +

+
+ +
+
srcw (API only)
+

Set source width. +

+
+
srch (API only)
+

Set source height. +

+
+
dstw (API only)
+

Set destination width. +

+
+
dsth (API only)
+

Set destination height. +

+
+
src_format (API only)
+

Set source pixel format (must be expressed as an integer). +

+
+
dst_format (API only)
+

Set destination pixel format (must be expressed as an integer). +

+
+
src_range (boolean)
+

If value is set to 1, indicates source is full range. Default value is +0, which indicates source is limited range. +

+
+
dst_range (boolean)
+

If value is set to 1, enable full range for destination. Default value +is 0, which enables limited range. +

+
+
param0, param1
+

Set scaling algorithm parameters. The specified values are specific of +some scaling algorithms and ignored by others. The specified values +are floating point number values. +

+
+
sws_dither
+

Set the dithering algorithm. Accepts one of the following +values. Default value is ‘auto’. +

+
+
‘auto’
+

automatic choice +

+
+
‘none’
+

no dithering +

+
+
‘bayer’
+

bayer dither +

+
+
‘ed’
+

error diffusion dither +

+
+
‘a_dither’
+

arithmetic dither, based using addition +

+
+
‘x_dither’
+

arithmetic dither, based using xor (more random/less apparent patterning that +a_dither). +

+
+
+ +
+
alphablend
+

Set the alpha blending to use when the input has alpha but the output does not. +Default value is ‘none’. +

+
+
‘uniform_color’
+

Blend onto a uniform background color +

+
+
‘checkerboard’
+

Blend onto a checkerboard +

+
+
‘none’
+

No blending +

+
+
+ +
+
+ + +

23 Filtering Introduction

+ +

Filtering in FFmpeg is enabled through the libavfilter library. +

+

In libavfilter, a filter can have multiple inputs and multiple +outputs. +To illustrate the sorts of things that are possible, we consider the +following filtergraph. +

+
                [main]
+input --> split ---------------------> overlay --> output
+            |                             ^
+            |[tmp]                  [flip]|
+            +-----> crop --> vflip -------+
+
+

This filtergraph splits the input stream in two streams, then sends one +stream through the crop filter and the vflip filter, before merging it +back with the other stream by overlaying it on top. You can use the +following command to achieve this: +

+
+
ffmpeg -i INPUT -vf "split [main][tmp]; [tmp] crop=iw:ih/2:0:0, vflip [flip]; [main][flip] overlay=0:H/2" OUTPUT
+
+ +

The result will be that the top half of the video is mirrored +onto the bottom half of the output video. +

+

Filters in the same linear chain are separated by commas, and distinct +linear chains of filters are separated by semicolons. In our example, +crop,vflip are in one linear chain, split and +overlay are separately in another. The points where the linear +chains join are labelled by names enclosed in square brackets. In the +example, the split filter generates two outputs that are associated to +the labels [main] and [tmp]. +

+

The stream sent to the second output of split, labelled as +[tmp], is processed through the crop filter, which crops +away the lower half part of the video, and then vertically flipped. The +overlay filter takes in input the first unchanged output of the +split filter (which was labelled as [main]), and overlay on its +lower half the output generated by the crop,vflip filterchain. +

+

Some filters take in input a list of parameters: they are specified +after the filter name and an equal sign, and are separated from each other +by a colon. +

+

There exist so-called source filters that do not have an +audio/video input, and sink filters that will not have audio/video +output. +

+ + +

24 graph2dot

+ +

The graph2dot program included in the FFmpeg tools +directory can be used to parse a filtergraph description and issue a +corresponding textual representation in the dot language. +

+

Invoke the command: +

+
graph2dot -h
+
+ +

to see how to use graph2dot. +

+

You can then pass the dot description to the dot program (from +the graphviz suite of programs) and obtain a graphical representation +of the filtergraph. +

+

For example the sequence of commands: +

+
echo GRAPH_DESCRIPTION | \
+tools/graph2dot -o graph.tmp && \
+dot -Tpng graph.tmp -o graph.png && \
+display graph.png
+
+ +

can be used to create and display an image representing the graph +described by the GRAPH_DESCRIPTION string. Note that this string must be +a complete self-contained graph, with its inputs and outputs explicitly defined. +For example if your command line is of the form: +

+
ffmpeg -i infile -vf scale=640:360 outfile
+
+

your GRAPH_DESCRIPTION string will need to be of the form: +

+
nullsrc,scale=640:360,nullsink
+
+

you may also need to set the nullsrc parameters and add a format +filter in order to simulate a specific input file. +

+ + +

25 Filtergraph description

+ +

A filtergraph is a directed graph of connected filters. It can contain +cycles, and there can be multiple links between a pair of +filters. Each link has one input pad on one side connecting it to one +filter from which it takes its input, and one output pad on the other +side connecting it to one filter accepting its output. +

+

Each filter in a filtergraph is an instance of a filter class +registered in the application, which defines the features and the +number of input and output pads of the filter. +

+

A filter with no input pads is called a "source", and a filter with no +output pads is called a "sink". +

+ +

25.1 Filtergraph syntax

+ +

A filtergraph has a textual representation, which is recognized by the +-filter/-vf/-af and +-filter_complex options in ffmpeg and +-vf/-af in ffplay, and by the +avfilter_graph_parse_ptr() function defined in +libavfilter/avfilter.h. +

+

A filterchain consists of a sequence of connected filters, each one +connected to the previous one in the sequence. A filterchain is +represented by a list of ","-separated filter descriptions. +

+

A filtergraph consists of a sequence of filterchains. A sequence of +filterchains is represented by a list of ";"-separated filterchain +descriptions. +

+

A filter is represented by a string of the form: +[in_link_1]...[in_link_N]filter_name@id=arguments[out_link_1]...[out_link_M] +

+

filter_name is the name of the filter class of which the +described filter is an instance of, and has to be the name of one of +the filter classes registered in the program optionally followed by "@id". +The name of the filter class is optionally followed by a string +"=arguments". +

+

arguments is a string which contains the parameters used to +initialize the filter instance. It may have one of two forms: +

    +
  • A ’:’-separated list of key=value pairs. + +
  • A ’:’-separated list of value. In this case, the keys are assumed to be +the option names in the order they are declared. E.g. the fade filter +declares three options in this order – type, start_frame and +nb_frames. Then the parameter list in:0:30 means that the value +in is assigned to the option type, 0 to +start_frame and 30 to nb_frames. + +
  • A ’:’-separated list of mixed direct value and long key=value +pairs. The direct value must precede the key=value pairs, and +follow the same constraints order of the previous point. The following +key=value pairs can be set in any preferred order. + +
+ +

If the option value itself is a list of items (e.g. the format filter +takes a list of pixel formats), the items in the list are usually separated by +‘|’. +

+

The list of arguments can be quoted using the character ‘'’ as initial +and ending mark, and the character ‘\’ for escaping the characters +within the quoted text; otherwise the argument string is considered +terminated when the next special character (belonging to the set +‘[]=;,’) is encountered. +

+

The name and arguments of the filter are optionally preceded and +followed by a list of link labels. +A link label allows one to name a link and associate it to a filter output +or input pad. The preceding labels in_link_1 +... in_link_N, are associated to the filter input pads, +the following labels out_link_1 ... out_link_M, are +associated to the output pads. +

+

When two link labels with the same name are found in the +filtergraph, a link between the corresponding input and output pad is +created. +

+

If an output pad is not labelled, it is linked by default to the first +unlabelled input pad of the next filter in the filterchain. +For example in the filterchain +

+
nullsrc, split[L1], [L2]overlay, nullsink
+
+

the split filter instance has two output pads, and the overlay filter +instance two input pads. The first output pad of split is labelled +"L1", the first input pad of overlay is labelled "L2", and the second +output pad of split is linked to the second input pad of overlay, +which are both unlabelled. +

+

In a filter description, if the input label of the first filter is not +specified, "in" is assumed; if the output label of the last filter is not +specified, "out" is assumed. +

+

In a complete filterchain all the unlabelled filter input and output +pads must be connected. A filtergraph is considered valid if all the +filter input and output pads of all the filterchains are connected. +

+

Libavfilter will automatically insert scale filters where format +conversion is required. It is possible to specify swscale flags +for those automatically inserted scalers by prepending +sws_flags=flags; +to the filtergraph description. +

+

Here is a BNF description of the filtergraph syntax: +

+
NAME             ::= sequence of alphanumeric characters and '_'
+FILTER_NAME      ::= NAME["@"NAME]
+LINKLABEL        ::= "[" NAME "]"
+LINKLABELS       ::= LINKLABEL [LINKLABELS]
+FILTER_ARGUMENTS ::= sequence of chars (possibly quoted)
+FILTER           ::= [LINKLABELS] FILTER_NAME ["=" FILTER_ARGUMENTS] [LINKLABELS]
+FILTERCHAIN      ::= FILTER [,FILTERCHAIN]
+FILTERGRAPH      ::= [sws_flags=flags;] FILTERCHAIN [;FILTERGRAPH]
+
+ + +

25.2 Notes on filtergraph escaping

+ +

Filtergraph description composition entails several levels of +escaping. See (ffmpeg-utils)the "Quoting and escaping" +section in the ffmpeg-utils(1) manual for more +information about the employed escaping procedure. +

+

A first level escaping affects the content of each filter option +value, which may contain the special character : used to +separate values, or one of the escaping characters \'. +

+

A second level escaping affects the whole filter description, which +may contain the escaping characters \' or the special +characters [],; used by the filtergraph description. +

+

Finally, when you specify a filtergraph on a shell commandline, you +need to perform a third level escaping for the shell special +characters contained within it. +

+

For example, consider the following string to be embedded in +the drawtext filter description text value: +

+
this is a 'string': may contain one, or more, special characters
+
+ +

This string contains the ' special escaping character, and the +: special character, so it needs to be escaped in this way: +

+
text=this is a \'string\'\: may contain one, or more, special characters
+
+ +

A second level of escaping is required when embedding the filter +description in a filtergraph description, in order to escape all the +filtergraph special characters. Thus the example above becomes: +

+
drawtext=text=this is a \\\'string\\\'\\: may contain one\, or more\, special characters
+
+

(note that in addition to the \' escaping special characters, +also , needs to be escaped). +

+

Finally an additional level of escaping is needed when writing the +filtergraph description in a shell command, which depends on the +escaping rules of the adopted shell. For example, assuming that +\ is special and needs to be escaped with another \, the +previous string will finally result in: +

+
-vf "drawtext=text=this is a \\\\\\'string\\\\\\'\\\\: may contain one\\, or more\\, special characters"
+
+ + +

26 Timeline editing

+ +

Some filters support a generic enable option. For the filters +supporting timeline editing, this option can be set to an expression which is +evaluated before sending a frame to the filter. If the evaluation is non-zero, +the filter will be enabled, otherwise the frame will be sent unchanged to the +next filter in the filtergraph. +

+

The expression accepts the following values: +

+
‘t’
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+
‘n’
+

sequential number of the input frame, starting from 0 +

+
+
‘pos’
+

the position in the file of the input frame, NAN if unknown +

+
+
‘w’
+
‘h’
+

width and height of the input frame if video +

+
+ +

Additionally, these filters support an enable command that can be used +to re-define the expression. +

+

Like any other filtering option, the enable option follows the same +rules. +

+

For example, to enable a blur filter (smartblur) from 10 seconds to 3 +minutes, and a curves filter starting at 3 seconds: +

+
smartblur = enable='between(t,10,3*60)',
+curves    = enable='gte(t,3)' : preset=cross_process
+
+ +

See ffmpeg -filters to view which filters have timeline support. +

+ + +

27 Changing options at runtime with a command

+ +

Some options can be changed during the operation of the filter using +a command. These options are marked ’T’ on the output of +ffmpeg -h filter=<name of filter>. +The name of the command is the name of the option and the argument is +the new value. +

+ +

28 Options for filters with several inputs (framesync)

+ +

Some filters with several inputs support a common set of options. +These options can only be set by name, not with the short notation. +

+
+
eof_action
+

The action to take when EOF is encountered on the secondary input; it accepts +one of the following values: +

+
+
repeat
+

Repeat the last frame (the default). +

+
endall
+

End both streams. +

+
pass
+

Pass the main input through. +

+
+ +
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+
repeatlast
+

If set to 1, force the filter to extend the last frame of secondary streams +until the end of the primary stream. A value of 0 disables this behavior. +Default value is 1. +

+
+ + + +

29 Audio Filters

+ +

When you configure your FFmpeg build, you can disable any of the +existing filters using --disable-filters. +The configure output will show the audio filters included in your +build. +

+

Below is a description of the currently available audio filters. +

+ +

29.1 acompressor

+ +

A compressor is mainly used to reduce the dynamic range of a signal. +Especially modern music is mostly compressed at a high ratio to +improve the overall loudness. It’s done to get the highest attention +of a listener, "fatten" the sound and bring more "power" to the track. +If a signal is compressed too much it may sound dull or "dead" +afterwards or it may start to "pump" (which could be a powerful effect +but can also destroy a track completely). +The right compression is the key to reach a professional sound and is +the high art of mixing and mastering. Because of its complex settings +it may take a long time to get the right feeling for this kind of effect. +

+

Compression is done by detecting the volume above a chosen level +threshold and dividing it by the factor set with ratio. +So if you set the threshold to -12dB and your signal reaches -6dB a ratio +of 2:1 will result in a signal at -9dB. Because an exact manipulation of +the signal would cause distortion of the waveform the reduction can be +levelled over the time. This is done by setting "Attack" and "Release". +attack determines how long the signal has to rise above the threshold +before any reduction will occur and release sets the time the signal +has to fall below the threshold to reduce the reduction again. Shorter signals +than the chosen attack time will be left untouched. +The overall reduction of the signal can be made up afterwards with the +makeup setting. So compressing the peaks of a signal about 6dB and +raising the makeup to this level results in a signal twice as loud than the +source. To gain a softer entry in the compression the knee flattens the +hard edge at the threshold in the range of the chosen decibels. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. Default is 1. Range is between 0.015625 and 64. +

+
+
mode
+

Set mode of compressor operation. Can be upward or downward. +Default is downward. +

+
+
threshold
+

If a signal of stream rises above this level it will affect the gain +reduction. +By default it is 0.125. Range is between 0.00097563 and 1. +

+
+
ratio
+

Set a ratio by which the signal is reduced. 1:2 means that if the level +rose 4dB above the threshold, it will be only 2dB above after the reduction. +Default is 2. Range is between 1 and 20. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction starts. Default is 20. Range is between 0.01 and 2000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before +reduction is decreased again. Default is 250. Range is between 0.01 and 9000. +

+
+
makeup
+

Set the amount by how much signal will be amplified after processing. +Default is 1. Range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.82843. Range is between 1 and 8. +

+
+
link
+

Choose if the average level between all channels of input stream +or the louder(maximum) channel of input stream affects the +reduction. Default is average. +

+
+
detection
+

Should the exact signal be taken in case of peak or an RMS one in case +of rms. Default is rms which is mostly smoother. +

+
+
mix
+

How much to use compressed signal in output. Default is 1. +Range is between 0 and 1. +

+
+ + +

29.1.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

29.2 acontrast

+

Simple audio dynamic range compression/expansion filter. +

+

The filter accepts the following options: +

+
+
contrast
+

Set contrast. Default is 33. Allowed range is between 0 and 100. +

+
+ + +

29.3 acopy

+ +

Copy the input audio source unchanged to the output. This is mainly useful for +testing purposes. +

+ +

29.4 acrossfade

+ +

Apply cross fade from one input audio stream to another input audio stream. +The cross fade is applied for specified duration near the end of first stream. +

+

The filter accepts the following options: +

+
+
nb_samples, ns
+

Specify the number of samples for which the cross fade effect has to last. +At the end of the cross fade effect the first input audio will be completely +silent. Default is 44100. +

+
+
duration, d
+

Specify the duration of the cross fade effect. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +By default the duration is determined by nb_samples. +If set this option is used instead of nb_samples. +

+
+
overlap, o
+

Should first stream end overlap with second stream start. Default is enabled. +

+
+
curve1
+

Set curve for cross fade transition for first stream. +

+
+
curve2
+

Set curve for cross fade transition for second stream. +

+

For description of available curve types see afade filter description. +

+
+ + +

29.4.1 Examples

+ +
    +
  • Cross fade from one input to another: +
    +
    ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:c1=exp:c2=exp output.flac
+
    + +
  • Cross fade from one input to another but without overlapping: +
    +
    ffmpeg -i first.flac -i second.flac -filter_complex acrossfade=d=10:o=0:c1=exp:c2=exp output.flac
+
    +
+ + +

29.5 acrossover

+

Split audio stream into several bands. +

+

This filter splits audio stream into two or more frequency ranges. +Summing all streams back will give flat output. +

+

The filter accepts the following options: +

+
+
split
+

Set split frequencies. Those must be positive and increasing. +

+
+
order
+

Set filter order, can be 2nd, 4th or 8th. +Default is 4th. +

+
+ + +

29.6 acrusher

+ +

Reduce audio bit resolution. +

+

This filter is bit crusher with enhanced functionality. A bit crusher +is used to audibly reduce number of bits an audio signal is sampled +with. This doesn’t change the bit depth at all, it just produces the +effect. Material reduced in bit depth sounds more harsh and "digital". +This filter is able to even round to continuous values instead of discrete +bit depths. +Additionally it has a D/C offset which results in different crushing of +the lower and the upper half of the signal. +An Anti-Aliasing setting is able to produce "softer" crushing sounds. +

+

Another feature of this filter is the logarithmic mode. +This setting switches from linear distances between bits to logarithmic ones. +The result is a much more "natural" sounding crusher which doesn’t gate low +signals for example. The human ear has a logarithmic perception, +so this kind of crushing is much more pleasant. +Logarithmic crushing is also able to get anti-aliased. +

+

The filter accepts the following options: +

+
+
level_in
+

Set level in. +

+
+
level_out
+

Set level out. +

+
+
bits
+

Set bit reduction. +

+
+
mix
+

Set mixing amount. +

+
+
mode
+

Can be linear: lin or logarithmic: log. +

+
+
dc
+

Set DC. +

+
+
aa
+

Set anti-aliasing. +

+
+
samples
+

Set sample reduction. +

+
+
lfo
+

Enable LFO. By default disabled. +

+
+
lforange
+

Set LFO range. +

+
+
lforate
+

Set LFO rate. +

+
+ + +

29.7 acue

+ +

Delay audio filtering until a given wallclock timestamp. See the cue +filter. +

+ +

29.8 adeclick

+

Remove impulsive noise from input audio. +

+

Samples detected as impulsive noise are replaced by interpolated samples using +autoregressive modelling. +

+
+
w
+

Set window size, in milliseconds. Allowed range is from 10 to +100. Default value is 55 milliseconds. +This sets size of window which will be processed at once. +

+
+
o
+

Set window overlap, in percentage of window size. Allowed range is from +50 to 95. Default value is 75 percent. +Setting this to a very high value increases impulsive noise removal but makes +whole process much slower. +

+
+
a
+

Set autoregression order, in percentage of window size. Allowed range is from +0 to 25. Default value is 2 percent. This option also +controls quality of interpolated samples using neighbour good samples. +

+
+
t
+

Set threshold value. Allowed range is from 1 to 100. +Default value is 2. +This controls the strength of impulsive noise which is going to be removed. +The lower value, the more samples will be detected as impulsive noise. +

+
+
b
+

Set burst fusion, in percentage of window size. Allowed range is 0 to +10. Default value is 2. +If any two samples detected as noise are spaced less than this value then any +sample between those two samples will be also detected as noise. +

+
+
m
+

Set overlap method. +

+

It accepts the following values: +

+
a
+

Select overlap-add method. Even not interpolated samples are slightly +changed with this method. +

+
+
s
+

Select overlap-save method. Not interpolated samples remain unchanged. +

+
+ +

Default value is a. +

+
+ + +

29.9 adeclip

+

Remove clipped samples from input audio. +

+

Samples detected as clipped are replaced by interpolated samples using +autoregressive modelling. +

+
+
w
+

Set window size, in milliseconds. Allowed range is from 10 to 100. +Default value is 55 milliseconds. +This sets size of window which will be processed at once. +

+
+
o
+

Set window overlap, in percentage of window size. Allowed range is from 50 +to 95. Default value is 75 percent. +

+
+
a
+

Set autoregression order, in percentage of window size. Allowed range is from +0 to 25. Default value is 8 percent. This option also controls +quality of interpolated samples using neighbour good samples. +

+
+
t
+

Set threshold value. Allowed range is from 1 to 100. +Default value is 10. Higher values make clip detection less aggressive. +

+
+
n
+

Set size of histogram used to detect clips. Allowed range is from 100 to 9999. +Default value is 1000. Higher values make clip detection less aggressive. +

+
+
m
+

Set overlap method. +

+

It accepts the following values: +

+
a
+

Select overlap-add method. Even not interpolated samples are slightly changed +with this method. +

+
+
s
+

Select overlap-save method. Not interpolated samples remain unchanged. +

+
+ +

Default value is a. +

+
+ + +

29.10 adelay

+ +

Delay one or more audio channels. +

+

Samples in delayed channel are filled with silence. +

+

The filter accepts the following option: +

+
+
delays
+

Set list of delays in milliseconds for each channel separated by ’|’. +Unused delays will be silently ignored. If number of given delays is +smaller than number of channels all remaining channels will not be delayed. +If you want to delay exact number of samples, append ’S’ to number. +If you want instead to delay in seconds, append ’s’ to number. +

+
+
all
+

Use last set delay for all remaining channels. By default is disabled. +This option if enabled changes how option delays is interpreted. +

+
+ + +

29.10.1 Examples

+ +
    +
  • Delay first channel by 1.5 seconds, the third channel by 0.5 seconds and leave +the second channel (and any other channels that may be present) unchanged. +
    +
    adelay=1500|0|500
+
    + +
  • Delay second channel by 500 samples, the third channel by 700 samples and leave +the first channel (and any other channels that may be present) unchanged. +
    +
    adelay=0|500S|700S
+
    + +
  • Delay all channels by same number of samples: +
    +
    adelay=delays=64S:all=1
+
    +
+ + +

29.11 aderivative, aintegral

+ +

Compute derivative/integral of audio stream. +

+

Applying both filters one after another produces original audio. +

+ +

29.12 aecho

+ +

Apply echoing to the input audio. +

+

Echoes are reflected sound and can occur naturally amongst mountains +(and sometimes large buildings) when talking or shouting; digital echo +effects emulate this behaviour and are often used to help fill out the +sound of a single instrument or vocal. The time difference between the +original signal and the reflection is the delay, and the +loudness of the reflected signal is the decay. +Multiple echoes can have different delays and decays. +

+

A description of the accepted parameters follows. +

+
+
in_gain
+

Set input gain of reflected signal. Default is 0.6. +

+
+
out_gain
+

Set output gain of reflected signal. Default is 0.3. +

+
+
delays
+

Set list of time intervals in milliseconds between original signal and reflections +separated by ’|’. Allowed range for each delay is (0 - 90000.0]. +Default is 1000. +

+
+
decays
+

Set list of loudness of reflected signals separated by ’|’. +Allowed range for each decay is (0 - 1.0]. +Default is 0.5. +

+
+ + +

29.12.1 Examples

+ +
    +
  • Make it sound as if there are twice as many instruments as are actually playing: +
    +
    aecho=0.8:0.88:60:0.4
+
    + +
  • If delay is very short, then it sounds like a (metallic) robot playing music: +
    +
    aecho=0.8:0.88:6:0.4
+
    + +
  • A longer delay will sound like an open air concert in the mountains: +
    +
    aecho=0.8:0.9:1000:0.3
+
    + +
  • Same as above but with one more mountain: +
    +
    aecho=0.8:0.9:1000|1800:0.3|0.25
+
    +
+ + +

29.13 aemphasis

+

Audio emphasis filter creates or restores material directly taken from LPs or +emphased CDs with different filter curves. E.g. to store music on vinyl the +signal has to be altered by a filter first to even out the disadvantages of +this recording medium. +Once the material is played back the inverse filter has to be applied to +restore the distortion of the frequency response. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. +

+
+
level_out
+

Set output gain. +

+
+
mode
+

Set filter mode. For restoring material use reproduction mode, otherwise +use production mode. Default is reproduction mode. +

+
+
type
+

Set filter type. Selects medium. Can be one of the following: +

+
+
col
+

select Columbia. +

+
emi
+

select EMI. +

+
bsi
+

select BSI (78RPM). +

+
riaa
+

select RIAA. +

+
cd
+

select Compact Disc (CD). +

+
50fm
+

select 50µs (FM). +

+
75fm
+

select 75µs (FM). +

+
50kf
+

select 50µs (FM-KF). +

+
75kf
+

select 75µs (FM-KF). +

+
+
+
+ + +

29.14 aeval

+ +

Modify an audio signal according to the specified expressions. +

+

This filter accepts one or more expressions (one for each channel), +which are evaluated and used to modify a corresponding audio signal. +

+

It accepts the following parameters: +

+
+
exprs
+

Set the ’|’-separated expressions list for each separate channel. If +the number of input channels is greater than the number of +expressions, the last specified expression is used for the remaining +output channels. +

+
+
channel_layout, c
+

Set output channel layout. If not specified, the channel layout is +specified by the number of expressions. If set to ‘same’, it will +use by default the same input channel layout. +

+
+ +

Each expression in exprs can contain the following constants and functions: +

+
+
ch
+

channel number of the current expression +

+
+
n
+

number of the evaluated sample, starting from 0 +

+
+
s
+

sample rate +

+
+
t
+

time of the evaluated sample expressed in seconds +

+
+
nb_in_channels
+
nb_out_channels
+

input and output number of channels +

+
+
val(CH)
+

the value of input channel with number CH +

+
+ +

Note: this filter is slow. For faster processing you should use a +dedicated filter. +

+ +

29.14.1 Examples

+ +
    +
  • Half volume: +
    +
    aeval=val(ch)/2:c=same
+
    + +
  • Invert phase of the second channel: +
    +
    aeval=val(0)|-val(1)
+
    +
+ + +

29.15 afade

+ +

Apply fade-in/out effect to input audio. +

+

A description of the accepted parameters follows. +

+
+
type, t
+

Specify the effect type, can be either in for fade-in, or +out for a fade-out effect. Default is in. +

+
+
start_sample, ss
+

Specify the number of the start sample for starting to apply the fade +effect. Default is 0. +

+
+
nb_samples, ns
+

Specify the number of samples for which the fade effect has to last. At +the end of the fade-in effect the output audio will have the same +volume as the input audio, at the end of the fade-out transition +the output audio will be silence. Default is 44100. +

+
+
start_time, st
+

Specify the start time of the fade effect. Default is 0. +The value must be specified as a time duration; see +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +If set this option is used instead of start_sample. +

+
+
duration, d
+

Specify the duration of the fade effect. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +At the end of the fade-in effect the output audio will have the same +volume as the input audio, at the end of the fade-out transition +the output audio will be silence. +By default the duration is determined by nb_samples. +If set this option is used instead of nb_samples. +

+
+
curve
+

Set curve for fade transition. +

+

It accepts the following values: +

+
tri
+

select triangular, linear slope (default) +

+
qsin
+

select quarter of sine wave +

+
hsin
+

select half of sine wave +

+
esin
+

select exponential sine wave +

+
log
+

select logarithmic +

+
ipar
+

select inverted parabola +

+
qua
+

select quadratic +

+
cub
+

select cubic +

+
squ
+

select square root +

+
cbr
+

select cubic root +

+
par
+

select parabola +

+
exp
+

select exponential +

+
iqsin
+

select inverted quarter of sine wave +

+
ihsin
+

select inverted half of sine wave +

+
dese
+

select double-exponential seat +

+
desi
+

select double-exponential sigmoid +

+
losi
+

select logistic sigmoid +

+
nofade
+

no fade applied +

+
+
+
+ + +

29.15.1 Examples

+ +
    +
  • Fade in first 15 seconds of audio: +
    +
    afade=t=in:ss=0:d=15
+
    + +
  • Fade out last 25 seconds of a 900 seconds audio: +
    +
    afade=t=out:st=875:d=25
+
    +
+ + +

29.16 afftdn

+

Denoise audio samples with FFT. +

+

A description of the accepted parameters follows. +

+
+
nr
+

Set the noise reduction in dB, allowed range is 0.01 to 97. +Default value is 12 dB. +

+
+
nf
+

Set the noise floor in dB, allowed range is -80 to -20. +Default value is -50 dB. +

+
+
nt
+

Set the noise type. +

+

It accepts the following values: +

+
w
+

Select white noise. +

+
+
v
+

Select vinyl noise. +

+
+
s
+

Select shellac noise. +

+
+
c
+

Select custom noise, defined in bn option. +

+

Default value is white noise. +

+
+ +
+
bn
+

Set custom band noise for every one of 15 bands. +Bands are separated by ’ ’ or ’|’. +

+
+
rf
+

Set the residual floor in dB, allowed range is -80 to -20. +Default value is -38 dB. +

+
+
tn
+

Enable noise tracking. By default is disabled. +With this enabled, noise floor is automatically adjusted. +

+
+
tr
+

Enable residual tracking. By default is disabled. +

+
+
om
+

Set the output mode. +

+

It accepts the following values: +

+
i
+

Pass input unchanged. +

+
+
o
+

Pass noise filtered out. +

+
+
n
+

Pass only noise. +

+

Default value is o. +

+
+
+
+ + +

29.16.1 Commands

+ +

This filter supports the following commands: +

+
sample_noise, sn
+

Start or stop measuring noise profile. +Syntax for the command is : "start" or "stop" string. +After measuring noise profile is stopped it will be +automatically applied in filtering. +

+
+
noise_reduction, nr
+

Change noise reduction. Argument is single float number. +Syntax for the command is : "noise_reduction" +

+
+
noise_floor, nf
+

Change noise floor. Argument is single float number. +Syntax for the command is : "noise_floor" +

+
+
output_mode, om
+

Change output mode operation. +Syntax for the command is : "i", "o" or "n" string. +

+
+ + +

29.17 afftfilt

+

Apply arbitrary expressions to samples in frequency domain. +

+
+
real
+

Set frequency domain real expression for each separate channel separated +by ’|’. Default is "re". +If the number of input channels is greater than the number of +expressions, the last specified expression is used for the remaining +output channels. +

+
+
imag
+

Set frequency domain imaginary expression for each separate channel +separated by ’|’. Default is "im". +

+

Each expression in real and imag can contain the following +constants and functions: +

+
+
sr
+

sample rate +

+
+
b
+

current frequency bin number +

+
+
nb
+

number of available bins +

+
+
ch
+

channel number of the current expression +

+
+
chs
+

number of channels +

+
+
pts
+

current frame pts +

+
+
re
+

current real part of frequency bin of current channel +

+
+
im
+

current imaginary part of frequency bin of current channel +

+
+
real(b, ch)
+

Return the value of real part of frequency bin at location (bin,channel) +

+
+
imag(b, ch)
+

Return the value of imaginary part of frequency bin at location (bin,channel) +

+
+ +
+
win_size
+

Set window size. Allowed range is from 16 to 131072. +Default is 4096 +

+
+
win_func
+

Set window function. Default is hann. +

+
+
overlap
+

Set window overlap. If set to 1, the recommended overlap for selected +window function will be picked. Default is 0.75. +

+
+ + +

29.17.1 Examples

+ +
    +
  • Leave almost only low frequencies in audio: +
    +
    afftfilt="'real=re * (1-clip((b/nb)*b,0,1))':imag='im * (1-clip((b/nb)*b,0,1))'"
+
    + +
  • Apply robotize effect: +
    +
    afftfilt="real='hypot(re,im)*sin(0)':imag='hypot(re,im)*cos(0)':win_size=512:overlap=0.75"
+
    + +
  • Apply whisper effect: +
    +
    afftfilt="real='hypot(re,im)*cos((random(0)*2-1)*2*3.14)':imag='hypot(re,im)*sin((random(1)*2-1)*2*3.14)':win_size=128:overlap=0.8"
+
    +
+ + +

29.18 afir

+ +

Apply an arbitrary Finite Impulse Response filter. +

+

This filter is designed for applying long FIR filters, +up to 60 seconds long. +

+

It can be used as component for digital crossover filters, +room equalization, cross talk cancellation, wavefield synthesis, +auralization, ambiophonics, ambisonics and spatialization. +

+

This filter uses the streams higher than first one as FIR coefficients. +If the non-first stream holds a single channel, it will be used +for all input channels in the first stream, otherwise +the number of channels in the non-first stream must be same as +the number of channels in the first stream. +

+

It accepts the following parameters: +

+
+
dry
+

Set dry gain. This sets input gain. +

+
+
wet
+

Set wet gain. This sets final output gain. +

+
+
length
+

Set Impulse Response filter length. Default is 1, which means whole IR is processed. +

+
+
gtype
+

Enable applying gain measured from power of IR. +

+

Set which approach to use for auto gain measurement. +

+
+
none
+

Do not apply any gain. +

+
+
peak
+

select peak gain, very conservative approach. This is default value. +

+
+
dc
+

select DC gain, limited application. +

+
+
gn
+

select gain to noise approach, this is most popular one. +

+
+ +
+
irgain
+

Set gain to be applied to IR coefficients before filtering. +Allowed range is 0 to 1. This gain is applied after any gain applied with gtype option. +

+
+
irfmt
+

Set format of IR stream. Can be mono or input. +Default is input. +

+
+
maxir
+

Set max allowed Impulse Response filter duration in seconds. Default is 30 seconds. +Allowed range is 0.1 to 60 seconds. +

+
+
response
+

Show IR frequency response, magnitude(magenta), phase(green) and group delay(yellow) in additional video stream. +By default it is disabled. +

+
+
channel
+

Set for which IR channel to display frequency response. By default is first channel +displayed. This option is used only when response is enabled. +

+
+
size
+

Set video stream size. This option is used only when response is enabled. +

+
+
rate
+

Set video stream frame rate. This option is used only when response is enabled. +

+
+
minp
+

Set minimal partition size used for convolution. Default is 8192. +Allowed range is from 1 to 32768. +Lower values decreases latency at cost of higher CPU usage. +

+
+
maxp
+

Set maximal partition size used for convolution. Default is 8192. +Allowed range is from 8 to 32768. +Lower values may increase CPU usage. +

+
+
nbirs
+

Set number of input impulse responses streams which will be switchable at runtime. +Allowed range is from 1 to 32. Default is 1. +

+
+
ir
+

Set IR stream which will be used for convolution, starting from 0, should always be +lower than supplied value by nbirs option. Default is 0. +This option can be changed at runtime via commands. +

+
+ + +

29.18.1 Examples

+ +
    +
  • Apply reverb to stream using mono IR file as second input, complete command using ffmpeg: +
    +
    ffmpeg -i input.wav -i middle_tunnel_1way_mono.wav -lavfi afir output.wav
+
    +
+ + +

29.19 aformat

+ +

Set output format constraints for the input audio. The framework will +negotiate the most appropriate format to minimize conversions. +

+

It accepts the following parameters: +

+
sample_fmts, f
+

A ’|’-separated list of requested sample formats. +

+
+
sample_rates, r
+

A ’|’-separated list of requested sample rates. +

+
+
channel_layouts, cl
+

A ’|’-separated list of requested channel layouts. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+ +

If a parameter is omitted, all values are allowed. +

+

Force the output to either unsigned 8-bit or signed 16-bit stereo +

+
aformat=sample_fmts=u8|s16:channel_layouts=stereo
+
+ + +

29.20 agate

+ +

A gate is mainly used to reduce lower parts of a signal. This kind of signal +processing reduces disturbing noise between useful signals. +

+

Gating is done by detecting the volume below a chosen level threshold +and dividing it by the factor set with ratio. The bottom of the noise +floor is set via range. Because an exact manipulation of the signal +would cause distortion of the waveform the reduction can be levelled over +time. This is done by setting attack and release. +

+

attack determines how long the signal has to fall below the threshold +before any reduction will occur and release sets the time the signal +has to rise above the threshold to reduce the reduction again. +Shorter signals than the chosen attack time will be left untouched. +

+
+
level_in
+

Set input level before filtering. +Default is 1. Allowed range is from 0.015625 to 64. +

+
+
mode
+

Set the mode of operation. Can be upward or downward. +Default is downward. If set to upward mode, higher parts of signal +will be amplified, expanding dynamic range in upward direction. +Otherwise, in case of downward lower parts of signal will be reduced. +

+
+
range
+

Set the level of gain reduction when the signal is below the threshold. +Default is 0.06125. Allowed range is from 0 to 1. +Setting this to 0 disables reduction and then filter behaves like expander. +

+
+
threshold
+

If a signal rises above this level the gain reduction is released. +Default is 0.125. Allowed range is from 0 to 1. +

+
+
ratio
+

Set a ratio by which the signal is reduced. +Default is 2. Allowed range is from 1 to 9000. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction stops. +Default is 20 milliseconds. Allowed range is from 0.01 to 9000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before the +reduction is increased again. Default is 250 milliseconds. +Allowed range is from 0.01 to 9000. +

+
+
makeup
+

Set amount of amplification of signal after processing. +Default is 1. Allowed range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.828427125. Allowed range is from 1 to 8. +

+
+
detection
+

Choose if exact signal should be taken for detection or an RMS like one. +Default is rms. Can be peak or rms. +

+
+
link
+

Choose if the average level between all channels or the louder channel affects +the reduction. +Default is average. Can be average or maximum. +

+
+ + +

29.21 aiir

+ +

Apply an arbitrary Infinite Impulse Response filter. +

+

It accepts the following parameters: +

+
+
zeros, z
+

Set numerator/zeros coefficients. +

+
+
poles, p
+

Set denominator/poles coefficients. +

+
+
gains, k
+

Set channels gains. +

+
+
dry_gain
+

Set input gain. +

+
+
wet_gain
+

Set output gain. +

+
+
format, f
+

Set coefficients format. +

+
+
‘tf’
+

digital transfer function +

+
‘zp’
+

Z-plane zeros/poles, cartesian (default) +

+
‘pr’
+

Z-plane zeros/poles, polar radians +

+
‘pd’
+

Z-plane zeros/poles, polar degrees +

+
‘sp’
+

S-plane zeros/poles +

+
+ +
+
process, r
+

Set kind of processing. +Can be d - direct or s - serial cascading. Default is s. +

+
+
precision, e
+

Set filtering precision. +

+
+
‘dbl’
+

double-precision floating-point (default) +

+
‘flt’
+

single-precision floating-point +

+
‘i32’
+

32-bit integers +

+
‘i16’
+

16-bit integers +

+
+ +
+
normalize, n
+

Normalize filter coefficients, by default is enabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+
mix
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
response
+

Show IR frequency response, magnitude(magenta), phase(green) and group delay(yellow) in additional video stream. +By default it is disabled. +

+
+
channel
+

Set for which IR channel to display frequency response. By default is first channel +displayed. This option is used only when response is enabled. +

+
+
size
+

Set video stream size. This option is used only when response is enabled. +

+
+ +

Coefficients in tf format are separated by spaces and are in ascending +order. +

+

Coefficients in zp format are separated by spaces and order of coefficients +doesn’t matter. Coefficients in zp format are complex numbers with i +imaginary unit. +

+

Different coefficients and gains can be provided for every channel, in such case +use ’|’ to separate coefficients or gains. Last provided coefficients will be +used for all remaining channels. +

+ +

29.21.1 Examples

+ +
    +
  • Apply 2 pole elliptic notch at around 5000Hz for 48000 Hz sample rate: +
    +
    aiir=k=1:z=7.957584807809675810E-1 -2.575128568908332300 3.674839853930788710 -2.57512875289799137 7.957586296317130880E-1:p=1 -2.86950072432325953 3.63022088054647218 -2.28075678147272232 6.361362326477423500E-1:f=tf:r=d
+
    + +
  • Same as above but in zp format: +
    +
    aiir=k=0.79575848078096756:z=0.80918701+0.58773007i 0.80918701-0.58773007i 0.80884700+0.58784055i 0.80884700-0.58784055i:p=0.63892345+0.59951235i 0.63892345-0.59951235i 0.79582691+0.44198673i 0.79582691-0.44198673i:f=zp:r=s
+
    +
+ + +

29.22 alimiter

+ +

The limiter prevents an input signal from rising over a desired threshold. +This limiter uses lookahead technology to prevent your signal from distorting. +It means that there is a small delay after the signal is processed. Keep in mind +that the delay it produces is the attack time you set. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. Default is 1. +

+
+
level_out
+

Set output gain. Default is 1. +

+
+
limit
+

Don’t let signals above this level pass the limiter. Default is 1. +

+
+
attack
+

The limiter will reach its attenuation level in this amount of time in +milliseconds. Default is 5 milliseconds. +

+
+
release
+

Come back from limiting to attenuation 1.0 in this amount of milliseconds. +Default is 50 milliseconds. +

+
+
asc
+

When gain reduction is always needed ASC takes care of releasing to an +average reduction level rather than reaching a reduction of 0 in the release +time. +

+
+
asc_level
+

Select how much the release time is affected by ASC, 0 means nearly no changes +in release time while 1 produces higher release times. +

+
+
level
+

Auto level output signal. Default is enabled. +This normalizes audio back to 0dB if enabled. +

+
+ +

Depending on picked setting it is recommended to upsample input 2x or 4x times +with aresample before applying this filter. +

+ +

29.23 allpass

+ +

Apply a two-pole all-pass filter with central frequency (in Hz) +frequency, and filter-width width. +An all-pass filter changes the audio’s frequency to phase relationship +without changing its frequency to amplitude relationship. +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set frequency in Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+
order, o
+

Set the filter order, can be 1 or 2. Default is 2. +

+
+ + +

29.23.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change allpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change allpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change allpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change allpass mix. +Syntax for the command is : "mix" +

+
+ + +

29.24 aloop

+ +

Loop audio samples. +

+

The filter accepts the following options: +

+
+
loop
+

Set the number of loops. Setting this value to -1 will result in infinite loops. +Default is 0. +

+
+
size
+

Set maximal number of samples. Default is 0. +

+
+
start
+

Set first sample of loop. Default is 0. +

+
+ + +

29.25 amerge

+ +

Merge two or more audio streams into a single multi-channel stream. +

+

The filter accepts the following options: +

+
+
inputs
+

Set the number of inputs. Default is 2. +

+
+
+ +

If the channel layouts of the inputs are disjoint, and therefore compatible, +the channel layout of the output will be set accordingly and the channels +will be reordered as necessary. If the channel layouts of the inputs are not +disjoint, the output will have all the channels of the first input then all +the channels of the second input, in that order, and the channel layout of +the output will be the default value corresponding to the total number of +channels. +

+

For example, if the first input is in 2.1 (FL+FR+LF) and the second input +is FC+BL+BR, then the output will be in 5.1, with the channels in the +following order: a1, a2, b1, a3, b2, b3 (a1 is the first channel of the +first input, b1 is the first channel of the second input). +

+

On the other hand, if both input are in stereo, the output channels will be +in the default order: a1, a2, b1, b2, and the channel layout will be +arbitrarily set to 4.0, which may or may not be the expected value. +

+

All inputs must have the same sample rate, and format. +

+

If inputs do not have the same duration, the output will stop with the +shortest. +

+ +

29.25.1 Examples

+ +
    +
  • Merge two mono files into a stereo stream: +
    +
    amovie=left.wav [l] ; amovie=right.mp3 [r] ; [l] [r] amerge
+
    + +
  • Multiple merges assuming 1 video stream and 6 audio streams in input.mkv: +
    +
    ffmpeg -i input.mkv -filter_complex "[0:1][0:2][0:3][0:4][0:5][0:6] amerge=inputs=6" -c:a pcm_s16le output.mkv
+
    +
+ + +

29.26 amix

+ +

Mixes multiple audio inputs into a single output. +

+

Note that this filter only supports float samples (the amerge +and pan audio filters support many formats). If the amix +input has integer samples then aresample will be automatically +inserted to perform the conversion to float samples. +

+

For example +

+
ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex amix=inputs=3:duration=first:dropout_transition=3 OUTPUT
+
+

will mix 3 input audio streams to a single output with the same duration as the +first input and a dropout transition time of 3 seconds. +

+

It accepts the following parameters: +

+
inputs
+

The number of inputs. If unspecified, it defaults to 2. +

+
+
duration
+

How to determine the end-of-stream. +

+
longest
+

The duration of the longest input. (default) +

+
+
shortest
+

The duration of the shortest input. +

+
+
first
+

The duration of the first input. +

+
+
+ +
+
dropout_transition
+

The transition time, in seconds, for volume renormalization when an input +stream ends. The default value is 2 seconds. +

+
+
weights
+

Specify weight of each input audio stream as sequence. +Each weight is separated by space. By default all inputs have same weight. +

+
+ + +

29.26.1 Commands

+ +

This filter supports the following commands: +

+
weights
+

Syntax is same as option with same name. +

+
+ + +

29.27 amultiply

+ +

Multiply first audio stream with second audio stream and store result +in output audio stream. Multiplication is done by multiplying each +sample from first stream with sample at same position from second stream. +

+

With this element-wise multiplication one can create amplitude fades and +amplitude modulations. +

+ +

29.28 anequalizer

+ +

High-order parametric multiband equalizer for each channel. +

+

It accepts the following parameters: +

+
params
+
+

This option string is in format: +"cchn f=cf w=w g=g t=f | ..." +Each equalizer band is separated by ’|’. +

+
+
chn
+

Set channel number to which equalization will be applied. +If input doesn’t have that channel the entry is ignored. +

+
+
f
+

Set central frequency for band. +If input doesn’t have that frequency the entry is ignored. +

+
+
w
+

Set band width in hertz. +

+
+
g
+

Set band gain in dB. +

+
+
t
+

Set filter type for band, optional, can be: +

+
+
‘0’
+

Butterworth, this is default. +

+
+
‘1’
+

Chebyshev type 1. +

+
+
‘2’
+

Chebyshev type 2. +

+
+
+
+ +
+
curves
+

With this option activated frequency response of anequalizer is displayed +in video stream. +

+
+
size
+

Set video stream size. Only useful if curves option is activated. +

+
+
mgain
+

Set max gain that will be displayed. Only useful if curves option is activated. +Setting this to a reasonable value makes it possible to display gain which is derived from +neighbour bands which are too close to each other and thus produce higher gain +when both are activated. +

+
+
fscale
+

Set frequency scale used to draw frequency response in video output. +Can be linear or logarithmic. Default is logarithmic. +

+
+
colors
+

Set color for each channel curve which is going to be displayed in video stream. +This is list of color names separated by space or by ’|’. +Unrecognised or missing colors will be replaced by white color. +

+
+ + +

29.28.1 Examples

+ +
    +
  • Lower gain by 10 of central frequency 200Hz and width 100 Hz +for first 2 channels using Chebyshev type 1 filter: +
    +
    anequalizer=c0 f=200 w=100 g=-10 t=1|c1 f=200 w=100 g=-10 t=1
+
    +
+ + +

29.28.2 Commands

+ +

This filter supports the following commands: +

+
change
+

Alter existing filter parameters. +Syntax for the commands is : "fN|f=freq|w=width|g=gain" +

+

fN is existing filter number, starting from 0, if no such filter is available +error is returned. +freq set new frequency parameter. +width set new width parameter in herz. +gain set new gain parameter in dB. +

+

Full filter invocation with asendcmd may look like this: +asendcmd=c=’4.0 anequalizer change 0|f=200|w=50|g=1’,anequalizer=... +

+
+ + +

29.29 anlmdn

+ +

Reduce broadband noise in audio samples using Non-Local Means algorithm. +

+

Each sample is adjusted by looking for other samples with similar contexts. This +context similarity is defined by comparing their surrounding patches of size +p. Patches are searched in an area of r around the sample. +

+

The filter accepts the following options: +

+
+
s
+

Set denoising strength. Allowed range is from 0.00001 to 10. Default value is 0.00001. +

+
+
p
+

Set patch radius duration. Allowed range is from 1 to 100 milliseconds. +Default value is 2 milliseconds. +

+
+
r
+

Set research radius duration. Allowed range is from 2 to 300 milliseconds. +Default value is 6 milliseconds. +

+
+
o
+

Set the output mode. +

+

It accepts the following values: +

+
i
+

Pass input unchanged. +

+
+
o
+

Pass noise filtered out. +

+
+
n
+

Pass only noise. +

+

Default value is o. +

+
+ +
+
m
+

Set smooth factor. Default value is 11. Allowed range is from 1 to 15. +

+
+ + +

29.29.1 Commands

+ +

This filter supports the following commands: +

+
s
+

Change denoise strength. Argument is single float number. +Syntax for the command is : "s" +

+
+
o
+

Change output mode. +Syntax for the command is : "i", "o" or "n" string. +

+
+ + +

29.30 anlms

+

Apply Normalized Least-Mean-Squares algorithm to the first audio stream using the second audio stream. +

+

This adaptive filter is used to mimic a desired filter by finding the filter coefficients that +relate to producing the least mean square of the error signal (difference between the desired, +2nd input audio stream and the actual signal, the 1st input audio stream). +

+

A description of the accepted options follows. +

+
+
order
+

Set filter order. +

+
+
mu
+

Set filter mu. +

+
+
eps
+

Set the filter eps. +

+
+
leakage
+

Set the filter leakage. +

+
+
out_mode
+

It accepts the following values: +

+
i
+

Pass the 1st input. +

+
+
d
+

Pass the 2nd input. +

+
+
o
+

Pass filtered samples. +

+
+
n
+

Pass difference between desired and filtered samples. +

+

Default value is o. +

+
+
+
+ + +

29.30.1 Examples

+ +
    +
  • One of many usages of this filter is noise reduction, input audio is filtered +with same samples that are delayed by fixed amount, one such example for stereo audio is: +
    +
    asplit[a][b],[a]adelay=32S|32S[a],[b][a]anlms=order=128:leakage=0.0005:mu=.5:out_mode=o
+
    +
+ + +

29.30.2 Commands

+ +

This filter supports the same commands as options, excluding option order. +

+ +

29.31 anull

+ +

Pass the audio source unchanged to the output. +

+ +

29.32 apad

+ +

Pad the end of an audio stream with silence. +

+

This can be used together with ffmpeg -shortest to +extend audio streams to the same length as the video stream. +

+

A description of the accepted options follows. +

+
+
packet_size
+

Set silence packet size. Default value is 4096. +

+
+
pad_len
+

Set the number of samples of silence to add to the end. After the +value is reached, the stream is terminated. This option is mutually +exclusive with whole_len. +

+
+
whole_len
+

Set the minimum total number of samples in the output audio stream. If +the value is longer than the input audio length, silence is added to +the end, until the value is reached. This option is mutually exclusive +with pad_len. +

+
+
pad_dur
+

Specify the duration of samples of silence to add. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. Used only if set to non-zero value. +

+
+
whole_dur
+

Specify the minimum total duration in the output audio stream. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. Used only if set to non-zero value. If the value is longer than +the input audio length, silence is added to the end, until the value is reached. +This option is mutually exclusive with pad_dur +

+
+ +

If neither the pad_len nor the whole_len nor pad_dur +nor whole_dur option is set, the filter will add silence to the end of +the input stream indefinitely. +

+ +

29.32.1 Examples

+ +
    +
  • Add 1024 samples of silence to the end of the input: +
    +
    apad=pad_len=1024
+
    + +
  • Make sure the audio output will contain at least 10000 samples, pad +the input with silence if required: +
    +
    apad=whole_len=10000
+
    + +
  • Use ffmpeg to pad the audio input with silence, so that the +video stream will always result the shortest and will be converted +until the end in the output file when using the shortest +option: +
    +
    ffmpeg -i VIDEO -i AUDIO -filter_complex "[1:0]apad" -shortest OUTPUT
+
    +
+ + +

29.33 aphaser

+

Add a phasing effect to the input audio. +

+

A phaser filter creates series of peaks and troughs in the frequency spectrum. +The position of the peaks and troughs are modulated so that they vary over time, creating a sweeping effect. +

+

A description of the accepted parameters follows. +

+
+
in_gain
+

Set input gain. Default is 0.4. +

+
+
out_gain
+

Set output gain. Default is 0.74 +

+
+
delay
+

Set delay in milliseconds. Default is 3.0. +

+
+
decay
+

Set decay. Default is 0.4. +

+
+
speed
+

Set modulation speed in Hz. Default is 0.5. +

+
+
type
+

Set modulation type. Default is triangular. +

+

It accepts the following values: +

+
‘triangular, t’
+
‘sinusoidal, s’
+
+
+
+ + +

29.34 apulsator

+ +

Audio pulsator is something between an autopanner and a tremolo. +But it can produce funny stereo effects as well. Pulsator changes the volume +of the left and right channel based on a LFO (low frequency oscillator) with +different waveforms and shifted phases. +This filter have the ability to define an offset between left and right +channel. An offset of 0 means that both LFO shapes match each other. +The left and right channel are altered equally - a conventional tremolo. +An offset of 50% means that the shape of the right channel is exactly shifted +in phase (or moved backwards about half of the frequency) - pulsator acts as +an autopanner. At 1 both curves match again. Every setting in between moves the +phase shift gapless between all stages and produces some "bypassing" sounds with +sine and triangle waveforms. The more you set the offset near 1 (starting from +the 0.5) the faster the signal passes from the left to the right speaker. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. By default it is 1. Range is [0.015625 - 64]. +

+
+
level_out
+

Set output gain. By default it is 1. Range is [0.015625 - 64]. +

+
+
mode
+

Set waveform shape the LFO will use. Can be one of: sine, triangle, square, +sawup or sawdown. Default is sine. +

+
+
amount
+

Set modulation. Define how much of original signal is affected by the LFO. +

+
+
offset_l
+

Set left channel offset. Default is 0. Allowed range is [0 - 1]. +

+
+
offset_r
+

Set right channel offset. Default is 0.5. Allowed range is [0 - 1]. +

+
+
width
+

Set pulse width. Default is 1. Allowed range is [0 - 2]. +

+
+
timing
+

Set possible timing mode. Can be one of: bpm, ms or hz. Default is hz. +

+
+
bpm
+

Set bpm. Default is 120. Allowed range is [30 - 300]. Only used if timing +is set to bpm. +

+
+
ms
+

Set ms. Default is 500. Allowed range is [10 - 2000]. Only used if timing +is set to ms. +

+
+
hz
+

Set frequency in Hz. Default is 2. Allowed range is [0.01 - 100]. Only used +if timing is set to hz. +

+
+ + +

29.35 aresample

+ +

Resample the input audio to the specified parameters, using the +libswresample library. If none are specified then the filter will +automatically convert between its input and output. +

+

This filter is also able to stretch/squeeze the audio data to make it match +the timestamps or to inject silence / cut out audio to make it match the +timestamps, do a combination of both or do neither. +

+

The filter accepts the syntax +[sample_rate:]resampler_options, where sample_rate +expresses a sample rate and resampler_options is a list of +key=value pairs, separated by ":". See the +(ffmpeg-resampler)"Resampler Options" section in the +ffmpeg-resampler(1) manual +for the complete list of supported options. +

+ +

29.35.1 Examples

+ +
    +
  • Resample the input audio to 44100Hz: +
    +
    aresample=44100
+
    + +
  • Stretch/squeeze samples to the given timestamps, with a maximum of 1000 +samples per second compensation: +
    +
    aresample=async=1000
+
    +
+ + +

29.36 areverse

+ +

Reverse an audio clip. +

+

Warning: This filter requires memory to buffer the entire clip, so trimming +is suggested. +

+ +

29.36.1 Examples

+ +
    +
  • Take the first 5 seconds of a clip, and reverse it. +
    +
    atrim=end=5,areverse
+
    +
+ + +

29.37 arnndn

+ +

Reduce noise from speech using Recurrent Neural Networks. +

+

This filter accepts the following options: +

+
+
model, m
+

Set train model file to load. This option is always required. +

+
+ + +

29.38 asetnsamples

+ +

Set the number of samples per each output audio frame. +

+

The last output packet may contain a different number of samples, as +the filter will flush all the remaining samples when the input audio +signals its end. +

+

The filter accepts the following options: +

+
+
nb_out_samples, n
+

Set the number of frames per each output audio frame. The number is +intended as the number of samples per each channel. +Default value is 1024. +

+
+
pad, p
+

If set to 1, the filter will pad the last audio frame with zeroes, so +that the last frame will contain the same number of samples as the +previous ones. Default value is 1. +

+
+ +

For example, to set the number of per-frame samples to 1234 and +disable padding for the last frame, use: +

+
asetnsamples=n=1234:p=0
+
+ + +

29.39 asetrate

+ +

Set the sample rate without altering the PCM data. +This will result in a change of speed and pitch. +

+

The filter accepts the following options: +

+
+
sample_rate, r
+

Set the output sample rate. Default is 44100 Hz. +

+
+ + +

29.40 ashowinfo

+ +

Show a line containing various information for each input audio frame. +The input audio is not modified. +

+

The shown line contains a sequence of key/value pairs of the form +key:value. +

+

The following values are shown in the output: +

+
+
n
+

The (sequential) number of the input frame, starting from 0. +

+
+
pts
+

The presentation timestamp of the input frame, in time base units; the time base +depends on the filter input pad, and is usually 1/sample_rate. +

+
+
pts_time
+

The presentation timestamp of the input frame in seconds. +

+
+
pos
+

position of the frame in the input stream, -1 if this information in +unavailable and/or meaningless (for example in case of synthetic audio) +

+
+
fmt
+

The sample format. +

+
+
chlayout
+

The channel layout. +

+
+
rate
+

The sample rate for the audio frame. +

+
+
nb_samples
+

The number of samples (per channel) in the frame. +

+
+
checksum
+

The Adler-32 checksum (printed in hexadecimal) of the audio data. For planar +audio, the data is treated as if all the planes were concatenated. +

+
+
plane_checksums
+

A list of Adler-32 checksums for each data plane. +

+
+ + +

29.41 asoftclip

+

Apply audio soft clipping. +

+

Soft clipping is a type of distortion effect where the amplitude of a signal is saturated +along a smooth curve, rather than the abrupt shape of hard-clipping. +

+

This filter accepts the following options: +

+
+
type
+

Set type of soft-clipping. +

+

It accepts the following values: +

+
tanh
+
atan
+
cubic
+
exp
+
alg
+
quintic
+
sin
+
+ +
+
param
+

Set additional parameter which controls sigmoid function. +

+
+ + +

29.41.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

29.42 asr

+

Automatic Speech Recognition +

+

This filter uses PocketSphinx for speech recognition. To enable +compilation of this filter, you need to configure FFmpeg with +--enable-pocketsphinx. +

+

It accepts the following options: +

+
+
rate
+

Set sampling rate of input audio. Defaults is 16000. +This need to match speech models, otherwise one will get poor results. +

+
+
hmm
+

Set dictionary containing acoustic model files. +

+
+
dict
+

Set pronunciation dictionary. +

+
+
lm
+

Set language model file. +

+
+
lmctl
+

Set language model set. +

+
+
lmname
+

Set which language model to use. +

+
+
logfn
+

Set output for log messages. +

+
+ +

The filter exports recognized speech as the frame metadata lavfi.asr.text. +

+ +

29.43 astats

+ +

Display time domain statistical information about the audio channels. +Statistics are calculated and displayed for each audio channel and, +where applicable, an overall figure is also given. +

+

It accepts the following option: +

+
length
+

Short window length in seconds, used for peak and trough RMS measurement. +Default is 0.05 (50 milliseconds). Allowed range is [0.01 - 10]. +

+
+
metadata
+
+

Set metadata injection. All the metadata keys are prefixed with lavfi.astats.X, +where X is channel number starting from 1 or string Overall. Default is +disabled. +

+

Available keys for each channel are: +DC_offset +Min_level +Max_level +Min_difference +Max_difference +Mean_difference +RMS_difference +Peak_level +RMS_peak +RMS_trough +Crest_factor +Flat_factor +Peak_count +Noise_floor +Noise_floor_count +Bit_depth +Dynamic_range +Zero_crossings +Zero_crossings_rate +Number_of_NaNs +Number_of_Infs +Number_of_denormals +

+

and for Overall: +DC_offset +Min_level +Max_level +Min_difference +Max_difference +Mean_difference +RMS_difference +Peak_level +RMS_level +RMS_peak +RMS_trough +Flat_factor +Peak_count +Noise_floor +Noise_floor_count +Bit_depth +Number_of_samples +Number_of_NaNs +Number_of_Infs +Number_of_denormals +

+

For example full key look like this lavfi.astats.1.DC_offset or +this lavfi.astats.Overall.Peak_count. +

+

For description what each key means read below. +

+
+
reset
+

Set number of frame after which stats are going to be recalculated. +Default is disabled. +

+
+
measure_perchannel
+

Select the entries which need to be measured per channel. The metadata keys can +be used as flags, default is all which measures everything. +none disables all per channel measurement. +

+
+
measure_overall
+

Select the entries which need to be measured overall. The metadata keys can +be used as flags, default is all which measures everything. +none disables all overall measurement. +

+
+
+ +

A description of each shown parameter follows: +

+
+
DC offset
+

Mean amplitude displacement from zero. +

+
+
Min level
+

Minimal sample level. +

+
+
Max level
+

Maximal sample level. +

+
+
Min difference
+

Minimal difference between two consecutive samples. +

+
+
Max difference
+

Maximal difference between two consecutive samples. +

+
+
Mean difference
+

Mean difference between two consecutive samples. +The average of each difference between two consecutive samples. +

+
+
RMS difference
+

Root Mean Square difference between two consecutive samples. +

+
+
Peak level dB
+
RMS level dB
+

Standard peak and RMS level measured in dBFS. +

+
+
RMS peak dB
+
RMS trough dB
+

Peak and trough values for RMS level measured over a short window. +

+
+
Crest factor
+

Standard ratio of peak to RMS level (note: not in dB). +

+
+
Flat factor
+

Flatness (i.e. consecutive samples with the same value) of the signal at its peak levels +(i.e. either Min level or Max level). +

+
+
Peak count
+

Number of occasions (not the number of samples) that the signal attained either +Min level or Max level. +

+
+
Noise floor dB
+

Minimum local peak measured in dBFS over a short window. +

+
+
Noise floor count
+

Number of occasions (not the number of samples) that the signal attained +Noise floor. +

+
+
Bit depth
+

Overall bit depth of audio. Number of bits used for each sample. +

+
+
Dynamic range
+

Measured dynamic range of audio in dB. +

+
+
Zero crossings
+

Number of points where the waveform crosses the zero level axis. +

+
+
Zero crossings rate
+

Rate of Zero crossings and number of audio samples. +

+
+ + +

29.44 asubboost

+

Boost subwoofer frequencies. +

+

The filter accepts the following options: +

+
+
dry
+

Set dry gain, how much of original signal is kept. Allowed range is from 0 to 1. +Default value is 0.5. +

+
+
wet
+

Set wet gain, how much of filtered signal is kept. Allowed range is from 0 to 1. +Default value is 0.8. +

+
+
decay
+

Set delay line decay gain value. Allowed range is from 0 to 1. +Default value is 0.7. +

+
+
feedback
+

Set delay line feedback gain value. Allowed range is from 0 to 1. +Default value is 0.5. +

+
+
cutoff
+

Set cutoff frequency in herz. Allowed range is 50 to 900. +Default value is 100. +

+
+
slope
+

Set slope amount for cutoff frequency. Allowed range is 0.0001 to 1. +Default value is 0.5. +

+
+
delay
+

Set delay. Allowed range is from 1 to 100. +Default value is 20. +

+
+ + +

29.44.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

29.45 atempo

+ +

Adjust audio tempo. +

+

The filter accepts exactly one parameter, the audio tempo. If not +specified then the filter will assume nominal 1.0 tempo. Tempo must +be in the [0.5, 100.0] range. +

+

Note that tempo greater than 2 will skip some samples rather than +blend them in. If for any reason this is a concern it is always +possible to daisy-chain several instances of atempo to achieve the +desired product tempo. +

+ +

29.45.1 Examples

+ +
    +
  • Slow down audio to 80% tempo: +
    +
    atempo=0.8
+
    + +
  • To speed up audio to 300% tempo: +
    +
    atempo=3
+
    + +
  • To speed up audio to 300% tempo by daisy-chaining two atempo instances: +
    +
    atempo=sqrt(3),atempo=sqrt(3)
+
    +
+ + +

29.45.2 Commands

+ +

This filter supports the following commands: +

+
tempo
+

Change filter tempo scale factor. +Syntax for the command is : "tempo" +

+
+ + +

29.46 atrim

+ +

Trim the input so that the output contains one continuous subpart of the input. +

+

It accepts the following parameters: +

+
start
+

Timestamp (in seconds) of the start of the section to keep. I.e. the audio +sample with the timestamp start will be the first sample in the output. +

+
+
end
+

Specify time of the first audio sample that will be dropped, i.e. the +audio sample immediately preceding the one with the timestamp end will be +the last sample in the output. +

+
+
start_pts
+

Same as start, except this option sets the start timestamp in samples +instead of seconds. +

+
+
end_pts
+

Same as end, except this option sets the end timestamp in samples instead +of seconds. +

+
+
duration
+

The maximum duration of the output in seconds. +

+
+
start_sample
+

The number of the first sample that should be output. +

+
+
end_sample
+

The number of the first sample that should be dropped. +

+
+ +

start, end, and duration are expressed as time +duration specifications; see +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual. +

+

Note that the first two sets of the start/end options and the duration +option look at the frame timestamp, while the _sample options simply count the +samples that pass through the filter. So start/end_pts and start/end_sample will +give different results when the timestamps are wrong, inexact or do not start at +zero. Also note that this filter does not modify the timestamps. If you wish +to have the output timestamps start at zero, insert the asetpts filter after the +atrim filter. +

+

If multiple start or end options are set, this filter tries to be greedy and +keep all samples that match at least one of the specified constraints. To keep +only the part that matches all the constraints at once, chain multiple atrim +filters. +

+

The defaults are such that all the input is kept. So it is possible to set e.g. +just the end values to keep everything before the specified time. +

+

Examples: +

    +
  • Drop everything except the second minute of input: +
    +
    ffmpeg -i INPUT -af atrim=60:120
+
    + +
  • Keep only the first 1000 samples: +
    +
    ffmpeg -i INPUT -af atrim=end_sample=1000
+
    + +
+ + +

29.47 axcorrelate

+

Calculate normalized cross-correlation between two input audio streams. +

+

Resulted samples are always between -1 and 1 inclusive. +If result is 1 it means two input samples are highly correlated in that selected segment. +Result 0 means they are not correlated at all. +If result is -1 it means two input samples are out of phase, which means they cancel each +other. +

+

The filter accepts the following options: +

+
+
size
+

Set size of segment over which cross-correlation is calculated. +Default is 256. Allowed range is from 2 to 131072. +

+
+
algo
+

Set algorithm for cross-correlation. Can be slow or fast. +Default is slow. Fast algorithm assumes mean values over any given segment +are always zero and thus need much less calculations to make. +This is generally not true, but is valid for typical audio streams. +

+
+ + +

29.47.1 Examples

+ +
    +
  • Calculate correlation between channels in stereo audio stream: +
    +
    ffmpeg -i stereo.wav -af channelsplit,axcorrelate=size=1024:algo=fast correlation.wav
+
    +
+ + +

29.48 bandpass

+ +

Apply a two-pole Butterworth band-pass filter with central +frequency frequency, and (3dB-point) band-width width. +The csg option selects a constant skirt gain (peak gain = Q) +instead of the default: constant 0dB peak gain. +The filter roll off at 6dB per octave (20dB per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the filter’s central frequency. Default is 3000. +

+
+
csg
+

Constant skirt gain if set to 1. Defaults to 0. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

29.48.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change bandpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change bandpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change bandpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change bandpass mix. +Syntax for the command is : "mix" +

+
+ + +

29.49 bandreject

+ +

Apply a two-pole Butterworth band-reject filter with central +frequency frequency, and (3dB-point) band-width width. +The filter roll off at 6dB per octave (20dB per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the filter’s central frequency. Default is 3000. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

29.49.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change bandreject frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change bandreject width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change bandreject width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change bandreject mix. +Syntax for the command is : "mix" +

+
+ + +

29.50 bass, lowshelf

+ +

Boost or cut the bass (lower) frequencies of the audio using a two-pole +shelving filter with a response similar to that of a standard +hi-fi’s tone-controls. This is also known as shelving equalisation (EQ). +

+

The filter accepts the following options: +

+
+
gain, g
+

Give the gain at 0 Hz. Its useful range is about -20 +(for a large cut) to +20 (for a large boost). +Beware of clipping when using a positive gain. +

+
+
frequency, f
+

Set the filter’s central frequency and so can be used +to extend or reduce the frequency range to be boosted or cut. +The default value is 100 Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Determine how steep is the filter’s shelf transition. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

29.50.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change bass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change bass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change bass width. +Syntax for the command is : "width" +

+
+
gain, g
+

Change bass gain. +Syntax for the command is : "gain" +

+
+
mix, m
+

Change bass mix. +Syntax for the command is : "mix" +

+
+ + +

29.51 biquad

+ +

Apply a biquad IIR filter with the given coefficients. +Where b0, b1, b2 and a0, a1, a2 +are the numerator and denominator coefficients respectively. +and channels, c specify which channels to filter, by default all +available are filtered. +

+ +

29.51.1 Commands

+ +

This filter supports the following commands: +

+
a0
+
a1
+
a2
+
b0
+
b1
+
b2
+

Change biquad parameter. +Syntax for the command is : "value" +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

29.52 bs2b

+

Bauer stereo to binaural transformation, which improves headphone listening of +stereo audio records. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libbs2b. +

+

It accepts the following parameters: +

+
profile
+

Pre-defined crossfeed level. +

+
default
+

Default level (fcut=700, feed=50). +

+
+
cmoy
+

Chu Moy circuit (fcut=700, feed=60). +

+
+
jmeier
+

Jan Meier circuit (fcut=650, feed=95). +

+
+
+ +
+
fcut
+

Cut frequency (in Hz). +

+
+
feed
+

Feed level (in Hz). +

+
+
+ + +

29.53 channelmap

+ +

Remap input channels to new locations. +

+

It accepts the following parameters: +

+
map
+

Map channels from input to output. The argument is a ’|’-separated list of +mappings, each in the in_channel-out_channel or +in_channel form. in_channel can be either the name of the input +channel (e.g. FL for front left) or its index in the input channel layout. +out_channel is the name of the output channel or its index in the output +channel layout. If out_channel is not given then it is implicitly an +index, starting with zero and increasing by one for each mapping. +

+
+
channel_layout
+

The channel layout of the output stream. +

+
+ +

If no mapping is present, the filter will implicitly map input channels to +output channels, preserving indices. +

+ +

29.53.1 Examples

+ +
    +
  • For example, assuming a 5.1+downmix input MOV file, +
    +
    ffmpeg -i in.mov -filter 'channelmap=map=DL-FL|DR-FR' out.wav
+
    +

    will create an output WAV file tagged as stereo from the downmix channels of +the input. +

    +
  • To fix a 5.1 WAV improperly encoded in AAC’s native channel order +
    +
    ffmpeg -i in.wav -filter 'channelmap=1|2|0|5|3|4:5.1' out.wav
+
    +
+ + +

29.54 channelsplit

+ +

Split each channel from an input audio stream into a separate output stream. +

+

It accepts the following parameters: +

+
channel_layout
+

The channel layout of the input stream. The default is "stereo". +

+
channels
+

A channel layout describing the channels to be extracted as separate output streams +or "all" to extract each input channel as a separate stream. The default is "all". +

+

Choosing channels not present in channel layout in the input will result in an error. +

+
+ + +

29.54.1 Examples

+ +
    +
  • For example, assuming a stereo input MP3 file, +
    +
    ffmpeg -i in.mp3 -filter_complex channelsplit out.mkv
+
    +

    will create an output Matroska file with two audio streams, one containing only +the left channel and the other the right channel. +

    +
  • Split a 5.1 WAV file into per-channel files: +
    +
    ffmpeg -i in.wav -filter_complex
+'channelsplit=channel_layout=5.1[FL][FR][FC][LFE][SL][SR]'
+-map '[FL]' front_left.wav -map '[FR]' front_right.wav -map '[FC]'
+front_center.wav -map '[LFE]' lfe.wav -map '[SL]' side_left.wav -map '[SR]'
+side_right.wav
+
    + +
  • Extract only LFE from a 5.1 WAV file: +
    +
    ffmpeg -i in.wav -filter_complex 'channelsplit=channel_layout=5.1:channels=LFE[LFE]'
+-map '[LFE]' lfe.wav
+
    +
+ + +

29.55 chorus

+

Add a chorus effect to the audio. +

+

Can make a single vocal sound like a chorus, but can also be applied to instrumentation. +

+

Chorus resembles an echo effect with a short delay, but whereas with echo the delay is +constant, with chorus, it is varied using using sinusoidal or triangular modulation. +The modulation depth defines the range the modulated delay is played before or after +the delay. Hence the delayed sound will sound slower or faster, that is the delayed +sound tuned around the original one, like in a chorus where some vocals are slightly +off key. +

+

It accepts the following parameters: +

+
in_gain
+

Set input gain. Default is 0.4. +

+
+
out_gain
+

Set output gain. Default is 0.4. +

+
+
delays
+

Set delays. A typical delay is around 40ms to 60ms. +

+
+
decays
+

Set decays. +

+
+
speeds
+

Set speeds. +

+
+
depths
+

Set depths. +

+
+ + +

29.55.1 Examples

+ +
    +
  • A single delay: +
    +
    chorus=0.7:0.9:55:0.4:0.25:2
+
    + +
  • Two delays: +
    +
    chorus=0.6:0.9:50|60:0.4|0.32:0.25|0.4:2|1.3
+
    + +
  • Fuller sounding chorus with three delays: +
    +
    chorus=0.5:0.9:50|60|40:0.4|0.32|0.3:0.25|0.4|0.3:2|2.3|1.3
+
    +
+ + +

29.56 compand

+

Compress or expand the audio’s dynamic range. +

+

It accepts the following parameters: +

+
+
attacks
+
decays
+

A list of times in seconds for each channel over which the instantaneous level +of the input signal is averaged to determine its volume. attacks refers to +increase of volume and decays refers to decrease of volume. For most +situations, the attack time (response to the audio getting louder) should be +shorter than the decay time, because the human ear is more sensitive to sudden +loud audio than sudden soft audio. A typical value for attack is 0.3 seconds and +a typical value for decay is 0.8 seconds. +If specified number of attacks & decays is lower than number of channels, the last +set attack/decay will be used for all remaining channels. +

+
+
points
+

A list of points for the transfer function, specified in dB relative to the +maximum possible signal amplitude. Each key points list must be defined using +the following syntax: x0/y0|x1/y1|x2/y2|.... or +x0/y0 x1/y1 x2/y2 .... +

+

The input values must be in strictly increasing order but the transfer function +does not have to be monotonically rising. The point 0/0 is assumed but +may be overridden (by 0/out-dBn). Typical values for the transfer +function are -70/-70|-60/-20|1/0. +

+
+
soft-knee
+

Set the curve radius in dB for all joints. It defaults to 0.01. +

+
+
gain
+

Set the additional gain in dB to be applied at all points on the transfer +function. This allows for easy adjustment of the overall gain. +It defaults to 0. +

+
+
volume
+

Set an initial volume, in dB, to be assumed for each channel when filtering +starts. This permits the user to supply a nominal level initially, so that, for +example, a very large gain is not applied to initial signal levels before the +companding has begun to operate. A typical value for audio which is initially +quiet is -90 dB. It defaults to 0. +

+
+
delay
+

Set a delay, in seconds. The input audio is analyzed immediately, but audio is +delayed before being fed to the volume adjuster. Specifying a delay +approximately equal to the attack/decay times allows the filter to effectively +operate in predictive rather than reactive mode. It defaults to 0. +

+
+
+ + +

29.56.1 Examples

+ +
    +
  • Make music with both quiet and loud passages suitable for listening to in a +noisy environment: +
    +
    compand=.3|.3:1|1:-90/-60|-60/-40|-40/-30|-20/-20:6:0:-90:0.2
+
    + +

    Another example for audio with whisper and explosion parts: +

    +
    compand=0|0:1|1:-90/-900|-70/-70|-30/-9|0/-3:6:0:0:0
+
    + +
  • A noise gate for when the noise is at a lower level than the signal: +
    +
    compand=.1|.1:.2|.2:-900/-900|-50.1/-900|-50/-50:.01:0:-90:.1
+
    + +
  • Here is another noise gate, this time for when the noise is at a higher level +than the signal (making it, in some ways, similar to squelch): +
    +
    compand=.1|.1:.1|.1:-45.1/-45.1|-45/-900|0/-900:.01:45:-90:.1
+
    + +
  • 2:1 compression starting at -6dB: +
    +
    compand=points=-80/-80|-6/-6|0/-3.8|20/3.5
+
    + +
  • 2:1 compression starting at -9dB: +
    +
    compand=points=-80/-80|-9/-9|0/-5.3|20/2.9
+
    + +
  • 2:1 compression starting at -12dB: +
    +
    compand=points=-80/-80|-12/-12|0/-6.8|20/1.9
+
    + +
  • 2:1 compression starting at -18dB: +
    +
    compand=points=-80/-80|-18/-18|0/-9.8|20/0.7
+
    + +
  • 3:1 compression starting at -15dB: +
    +
    compand=points=-80/-80|-15/-15|0/-10.8|20/-5.2
+
    + +
  • Compressor/Gate: +
    +
    compand=points=-80/-105|-62/-80|-15.4/-15.4|0/-12|20/-7.6
+
    + +
  • Expander: +
    +
    compand=attacks=0:points=-80/-169|-54/-80|-49.5/-64.6|-41.1/-41.1|-25.8/-15|-10.8/-4.5|0/0|20/8.3
+
    + +
  • Hard limiter at -6dB: +
    +
    compand=attacks=0:points=-80/-80|-6/-6|20/-6
+
    + +
  • Hard limiter at -12dB: +
    +
    compand=attacks=0:points=-80/-80|-12/-12|20/-12
+
    + +
  • Hard noise gate at -35 dB: +
    +
    compand=attacks=0:points=-80/-115|-35.1/-80|-35/-35|20/20
+
    + +
  • Soft limiter: +
    +
    compand=attacks=0:points=-80/-80|-12.4/-12.4|-6/-8|0/-6.8|20/-2.8
+
    +
+ + +

29.57 compensationdelay

+ +

Compensation Delay Line is a metric based delay to compensate differing +positions of microphones or speakers. +

+

For example, you have recorded guitar with two microphones placed in +different locations. Because the front of sound wave has fixed speed in +normal conditions, the phasing of microphones can vary and depends on +their location and interposition. The best sound mix can be achieved when +these microphones are in phase (synchronized). Note that a distance of +~30 cm between microphones makes one microphone capture the signal in +antiphase to the other microphone. That makes the final mix sound moody. +This filter helps to solve phasing problems by adding different delays +to each microphone track and make them synchronized. +

+

The best result can be reached when you take one track as base and +synchronize other tracks one by one with it. +Remember that synchronization/delay tolerance depends on sample rate, too. +Higher sample rates will give more tolerance. +

+

The filter accepts the following parameters: +

+
+
mm
+

Set millimeters distance. This is compensation distance for fine tuning. +Default is 0. +

+
+
cm
+

Set cm distance. This is compensation distance for tightening distance setup. +Default is 0. +

+
+
m
+

Set meters distance. This is compensation distance for hard distance setup. +Default is 0. +

+
+
dry
+

Set dry amount. Amount of unprocessed (dry) signal. +Default is 0. +

+
+
wet
+

Set wet amount. Amount of processed (wet) signal. +Default is 1. +

+
+
temp
+

Set temperature in degrees Celsius. This is the temperature of the environment. +Default is 20. +

+
+ + +

29.58 crossfeed

+

Apply headphone crossfeed filter. +

+

Crossfeed is the process of blending the left and right channels of stereo +audio recording. +It is mainly used to reduce extreme stereo separation of low frequencies. +

+

The intent is to produce more speaker like sound to the listener. +

+

The filter accepts the following options: +

+
+
strength
+

Set strength of crossfeed. Default is 0.2. Allowed range is from 0 to 1. +This sets gain of low shelf filter for side part of stereo image. +Default is -6dB. Max allowed is -30db when strength is set to 1. +

+
+
range
+

Set soundstage wideness. Default is 0.5. Allowed range is from 0 to 1. +This sets cut off frequency of low shelf filter. Default is cut off near +1550 Hz. With range set to 1 cut off frequency is set to 2100 Hz. +

+
+
slope
+

Set curve slope of low shelf filter. Default is 0.5. +Allowed range is from 0.01 to 1. +

+
+
level_in
+

Set input gain. Default is 0.9. +

+
+
level_out
+

Set output gain. Default is 1. +

+
+ + +

29.58.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

29.59 crystalizer

+

Simple algorithm to expand audio dynamic range. +

+

The filter accepts the following options: +

+
+
i
+

Sets the intensity of effect (default: 2.0). Must be in range between 0.0 +(unchanged sound) to 10.0 (maximum effect). +

+
+
c
+

Enable clipping. By default is enabled. +

+
+ + +

29.59.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

29.60 dcshift

+

Apply a DC shift to the audio. +

+

This can be useful to remove a DC offset (caused perhaps by a hardware problem +in the recording chain) from the audio. The effect of a DC offset is reduced +headroom and hence volume. The astats filter can be used to determine if +a signal has a DC offset. +

+
+
shift
+

Set the DC shift, allowed range is [-1, 1]. It indicates the amount to shift +the audio. +

+
+
limitergain
+

Optional. It should have a value much less than 1 (e.g. 0.05 or 0.02) and is +used to prevent clipping. +

+
+ + +

29.61 deesser

+ +

Apply de-essing to the audio samples. +

+
+
i
+

Set intensity for triggering de-essing. Allowed range is from 0 to 1. +Default is 0. +

+
+
m
+

Set amount of ducking on treble part of sound. Allowed range is from 0 to 1. +Default is 0.5. +

+
+
f
+

How much of original frequency content to keep when de-essing. Allowed range is from 0 to 1. +Default is 0.5. +

+
+
s
+

Set the output mode. +

+

It accepts the following values: +

+
i
+

Pass input unchanged. +

+
+
o
+

Pass ess filtered out. +

+
+
e
+

Pass only ess. +

+

Default value is o. +

+
+ +
+
+ + +

29.62 drmeter

+

Measure audio dynamic range. +

+

DR values of 14 and higher is found in very dynamic material. DR of 8 to 13 +is found in transition material. And anything less that 8 have very poor dynamics +and is very compressed. +

+

The filter accepts the following options: +

+
+
length
+

Set window length in seconds used to split audio into segments of equal length. +Default is 3 seconds. +

+
+ + +

29.63 dynaudnorm

+

Dynamic Audio Normalizer. +

+

This filter applies a certain amount of gain to the input audio in order +to bring its peak magnitude to a target level (e.g. 0 dBFS). However, in +contrast to more "simple" normalization algorithms, the Dynamic Audio +Normalizer *dynamically* re-adjusts the gain factor to the input audio. +This allows for applying extra gain to the "quiet" sections of the audio +while avoiding distortions or clipping the "loud" sections. In other words: +The Dynamic Audio Normalizer will "even out" the volume of quiet and loud +sections, in the sense that the volume of each section is brought to the +same target level. Note, however, that the Dynamic Audio Normalizer achieves +this goal *without* applying "dynamic range compressing". It will retain 100% +of the dynamic range *within* each section of the audio file. +

+
+
framelen, f
+

Set the frame length in milliseconds. In range from 10 to 8000 milliseconds. +Default is 500 milliseconds. +The Dynamic Audio Normalizer processes the input audio in small chunks, +referred to as frames. This is required, because a peak magnitude has no +meaning for just a single sample value. Instead, we need to determine the +peak magnitude for a contiguous sequence of sample values. While a "standard" +normalizer would simply use the peak magnitude of the complete file, the +Dynamic Audio Normalizer determines the peak magnitude individually for each +frame. The length of a frame is specified in milliseconds. By default, the +Dynamic Audio Normalizer uses a frame length of 500 milliseconds, which has +been found to give good results with most files. +Note that the exact frame length, in number of samples, will be determined +automatically, based on the sampling rate of the individual input audio file. +

+
+
gausssize, g
+

Set the Gaussian filter window size. In range from 3 to 301, must be odd +number. Default is 31. +Probably the most important parameter of the Dynamic Audio Normalizer is the +window size of the Gaussian smoothing filter. The filter’s window size +is specified in frames, centered around the current frame. For the sake of +simplicity, this must be an odd number. Consequently, the default value of 31 +takes into account the current frame, as well as the 15 preceding frames and +the 15 subsequent frames. Using a larger window results in a stronger +smoothing effect and thus in less gain variation, i.e. slower gain +adaptation. Conversely, using a smaller window results in a weaker smoothing +effect and thus in more gain variation, i.e. faster gain adaptation. +In other words, the more you increase this value, the more the Dynamic Audio +Normalizer will behave like a "traditional" normalization filter. On the +contrary, the more you decrease this value, the more the Dynamic Audio +Normalizer will behave like a dynamic range compressor. +

+
+
peak, p
+

Set the target peak value. This specifies the highest permissible magnitude +level for the normalized audio input. This filter will try to approach the +target peak magnitude as closely as possible, but at the same time it also +makes sure that the normalized signal will never exceed the peak magnitude. +A frame’s maximum local gain factor is imposed directly by the target peak +magnitude. The default value is 0.95 and thus leaves a headroom of 5%*. +It is not recommended to go above this value. +

+
+
maxgain, m
+

Set the maximum gain factor. In range from 1.0 to 100.0. Default is 10.0. +The Dynamic Audio Normalizer determines the maximum possible (local) gain +factor for each input frame, i.e. the maximum gain factor that does not +result in clipping or distortion. The maximum gain factor is determined by +the frame’s highest magnitude sample. However, the Dynamic Audio Normalizer +additionally bounds the frame’s maximum gain factor by a predetermined +(global) maximum gain factor. This is done in order to avoid excessive gain +factors in "silent" or almost silent frames. By default, the maximum gain +factor is 10.0, For most inputs the default value should be sufficient and +it usually is not recommended to increase this value. Though, for input +with an extremely low overall volume level, it may be necessary to allow even +higher gain factors. Note, however, that the Dynamic Audio Normalizer does +not simply apply a "hard" threshold (i.e. cut off values above the threshold). +Instead, a "sigmoid" threshold function will be applied. This way, the +gain factors will smoothly approach the threshold value, but never exceed that +value. +

+
+
targetrms, r
+

Set the target RMS. In range from 0.0 to 1.0. Default is 0.0 - disabled. +By default, the Dynamic Audio Normalizer performs "peak" normalization. +This means that the maximum local gain factor for each frame is defined +(only) by the frame’s highest magnitude sample. This way, the samples can +be amplified as much as possible without exceeding the maximum signal +level, i.e. without clipping. Optionally, however, the Dynamic Audio +Normalizer can also take into account the frame’s root mean square, +abbreviated RMS. In electrical engineering, the RMS is commonly used to +determine the power of a time-varying signal. It is therefore considered +that the RMS is a better approximation of the "perceived loudness" than +just looking at the signal’s peak magnitude. Consequently, by adjusting all +frames to a constant RMS value, a uniform "perceived loudness" can be +established. If a target RMS value has been specified, a frame’s local gain +factor is defined as the factor that would result in exactly that RMS value. +Note, however, that the maximum local gain factor is still restricted by the +frame’s highest magnitude sample, in order to prevent clipping. +

+
+
coupling, n
+

Enable channels coupling. By default is enabled. +By default, the Dynamic Audio Normalizer will amplify all channels by the same +amount. This means the same gain factor will be applied to all channels, i.e. +the maximum possible gain factor is determined by the "loudest" channel. +However, in some recordings, it may happen that the volume of the different +channels is uneven, e.g. one channel may be "quieter" than the other one(s). +In this case, this option can be used to disable the channel coupling. This way, +the gain factor will be determined independently for each channel, depending +only on the individual channel’s highest magnitude sample. This allows for +harmonizing the volume of the different channels. +

+
+
correctdc, c
+

Enable DC bias correction. By default is disabled. +An audio signal (in the time domain) is a sequence of sample values. +In the Dynamic Audio Normalizer these sample values are represented in the +-1.0 to 1.0 range, regardless of the original input format. Normally, the +audio signal, or "waveform", should be centered around the zero point. +That means if we calculate the mean value of all samples in a file, or in a +single frame, then the result should be 0.0 or at least very close to that +value. If, however, there is a significant deviation of the mean value from +0.0, in either positive or negative direction, this is referred to as a +DC bias or DC offset. Since a DC bias is clearly undesirable, the Dynamic +Audio Normalizer provides optional DC bias correction. +With DC bias correction enabled, the Dynamic Audio Normalizer will determine +the mean value, or "DC correction" offset, of each input frame and subtract +that value from all of the frame’s sample values which ensures those samples +are centered around 0.0 again. Also, in order to avoid "gaps" at the frame +boundaries, the DC correction offset values will be interpolated smoothly +between neighbouring frames. +

+
+
altboundary, b
+

Enable alternative boundary mode. By default is disabled. +The Dynamic Audio Normalizer takes into account a certain neighbourhood +around each frame. This includes the preceding frames as well as the +subsequent frames. However, for the "boundary" frames, located at the very +beginning and at the very end of the audio file, not all neighbouring +frames are available. In particular, for the first few frames in the audio +file, the preceding frames are not known. And, similarly, for the last few +frames in the audio file, the subsequent frames are not known. Thus, the +question arises which gain factors should be assumed for the missing frames +in the "boundary" region. The Dynamic Audio Normalizer implements two modes +to deal with this situation. The default boundary mode assumes a gain factor +of exactly 1.0 for the missing frames, resulting in a smooth "fade in" and +"fade out" at the beginning and at the end of the input, respectively. +

+
+
compress, s
+

Set the compress factor. In range from 0.0 to 30.0. Default is 0.0. +By default, the Dynamic Audio Normalizer does not apply "traditional" +compression. This means that signal peaks will not be pruned and thus the +full dynamic range will be retained within each local neighbourhood. However, +in some cases it may be desirable to combine the Dynamic Audio Normalizer’s +normalization algorithm with a more "traditional" compression. +For this purpose, the Dynamic Audio Normalizer provides an optional compression +(thresholding) function. If (and only if) the compression feature is enabled, +all input frames will be processed by a soft knee thresholding function prior +to the actual normalization process. Put simply, the thresholding function is +going to prune all samples whose magnitude exceeds a certain threshold value. +However, the Dynamic Audio Normalizer does not simply apply a fixed threshold +value. Instead, the threshold value will be adjusted for each individual +frame. +In general, smaller parameters result in stronger compression, and vice versa. +Values below 3.0 are not recommended, because audible distortion may appear. +

+
+
threshold, t
+

Set the target threshold value. This specifies the lowest permissible +magnitude level for the audio input which will be normalized. +If input frame volume is above this value frame will be normalized. +Otherwise frame may not be normalized at all. The default value is set +to 0, which means all input frames will be normalized. +This option is mostly useful if digital noise is not wanted to be amplified. +

+
+ + +

29.63.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

29.64 earwax

+ +

Make audio easier to listen to on headphones. +

+

This filter adds ‘cues’ to 44.1kHz stereo (i.e. audio CD format) audio +so that when listened to on headphones the stereo image is moved from +inside your head (standard for headphones) to outside and in front of +the listener (standard for speakers). +

+

Ported from SoX. +

+ +

29.65 equalizer

+ +

Apply a two-pole peaking equalisation (EQ) filter. With this +filter, the signal-level at and around a selected frequency can +be increased or decreased, whilst (unlike bandpass and bandreject +filters) that at all other frequencies is unchanged. +

+

In order to produce complex equalisation curves, this filter can +be given several times, each with a different central frequency. +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the filter’s central frequency in Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +

+
+
gain, g
+

Set the required gain or attenuation in dB. +Beware of clipping when using a positive gain. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

29.65.1 Examples

+
    +
  • Attenuate 10 dB at 1000 Hz, with a bandwidth of 200 Hz: +
    +
    equalizer=f=1000:t=h:width=200:g=-10
+
    + +
  • Apply 2 dB gain at 1000 Hz with Q 1 and attenuate 5 dB at 100 Hz with Q 2: +
    +
    equalizer=f=1000:t=q:w=1:g=2,equalizer=f=100:t=q:w=2:g=-5
+
    +
+ + +

29.65.2 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change equalizer frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change equalizer width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change equalizer width. +Syntax for the command is : "width" +

+
+
gain, g
+

Change equalizer gain. +Syntax for the command is : "gain" +

+
+
mix, m
+

Change equalizer mix. +Syntax for the command is : "mix" +

+
+ + +

29.66 extrastereo

+ +

Linearly increases the difference between left and right channels which +adds some sort of "live" effect to playback. +

+

The filter accepts the following options: +

+
+
m
+

Sets the difference coefficient (default: 2.5). 0.0 means mono sound +(average of both channels), with 1.0 sound will be unchanged, with +-1.0 left and right channels will be swapped. +

+
+
c
+

Enable clipping. By default is enabled. +

+
+ + +

29.66.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

29.67 firequalizer

+

Apply FIR Equalization using arbitrary frequency response. +

+

The filter accepts the following option: +

+
+
gain
+

Set gain curve equation (in dB). The expression can contain variables: +

+
f
+

the evaluated frequency +

+
sr
+

sample rate +

+
ch
+

channel number, set to 0 when multichannels evaluation is disabled +

+
chid
+

channel id, see libavutil/channel_layout.h, set to the first channel id when +multichannels evaluation is disabled +

+
chs
+

number of channels +

+
chlayout
+

channel_layout, see libavutil/channel_layout.h +

+
+
+

and functions: +

+
gain_interpolate(f)
+

interpolate gain on frequency f based on gain_entry +

+
cubic_interpolate(f)
+

same as gain_interpolate, but smoother +

+
+

This option is also available as command. Default is gain_interpolate(f). +

+
+
gain_entry
+

Set gain entry for gain_interpolate function. The expression can +contain functions: +

+
entry(f, g)
+

store gain entry at frequency f with value g +

+
+

This option is also available as command. +

+
+
delay
+

Set filter delay in seconds. Higher value means more accurate. +Default is 0.01. +

+
+
accuracy
+

Set filter accuracy in Hz. Lower value means more accurate. +Default is 5. +

+
+
wfunc
+

Set window function. Acceptable values are: +

+
rectangular
+

rectangular window, useful when gain curve is already smooth +

+
hann
+

hann window (default) +

+
hamming
+

hamming window +

+
blackman
+

blackman window +

+
nuttall3
+

3-terms continuous 1st derivative nuttall window +

+
mnuttall3
+

minimum 3-terms discontinuous nuttall window +

+
nuttall
+

4-terms continuous 1st derivative nuttall window +

+
bnuttall
+

minimum 4-terms discontinuous nuttall (blackman-nuttall) window +

+
bharris
+

blackman-harris window +

+
tukey
+

tukey window +

+
+ +
+
fixed
+

If enabled, use fixed number of audio samples. This improves speed when +filtering with large delay. Default is disabled. +

+
+
multi
+

Enable multichannels evaluation on gain. Default is disabled. +

+
+
zero_phase
+

Enable zero phase mode by subtracting timestamp to compensate delay. +Default is disabled. +

+
+
scale
+

Set scale used by gain. Acceptable values are: +

+
linlin
+

linear frequency, linear gain +

+
linlog
+

linear frequency, logarithmic (in dB) gain (default) +

+
loglin
+

logarithmic (in octave scale where 20 Hz is 0) frequency, linear gain +

+
loglog
+

logarithmic frequency, logarithmic gain +

+
+ +
+
dumpfile
+

Set file for dumping, suitable for gnuplot. +

+
+
dumpscale
+

Set scale for dumpfile. Acceptable values are same with scale option. +Default is linlog. +

+
+
fft2
+

Enable 2-channel convolution using complex FFT. This improves speed significantly. +Default is disabled. +

+
+
min_phase
+

Enable minimum phase impulse response. Default is disabled. +

+
+ + +

29.67.1 Examples

+
    +
  • lowpass at 1000 Hz: +
    +
    firequalizer=gain='if(lt(f,1000), 0, -INF)'
+
    +
  • lowpass at 1000 Hz with gain_entry: +
    +
    firequalizer=gain_entry='entry(1000,0); entry(1001, -INF)'
+
    +
  • custom equalization: +
    +
    firequalizer=gain_entry='entry(100,0); entry(400, -4); entry(1000, -6); entry(2000, 0)'
+
    +
  • higher delay with zero phase to compensate delay: +
    +
    firequalizer=delay=0.1:fixed=on:zero_phase=on
+
    +
  • lowpass on left channel, highpass on right channel: +
    +
    firequalizer=gain='if(eq(chid,1), gain_interpolate(f), if(eq(chid,2), gain_interpolate(1e6+f), 0))'
+:gain_entry='entry(1000, 0); entry(1001,-INF); entry(1e6+1000,0)':multi=on
+
    +
+ + +

29.68 flanger

+

Apply a flanging effect to the audio. +

+

The filter accepts the following options: +

+
+
delay
+

Set base delay in milliseconds. Range from 0 to 30. Default value is 0. +

+
+
depth
+

Set added sweep delay in milliseconds. Range from 0 to 10. Default value is 2. +

+
+
regen
+

Set percentage regeneration (delayed signal feedback). Range from -95 to 95. +Default value is 0. +

+
+
width
+

Set percentage of delayed signal mixed with original. Range from 0 to 100. +Default value is 71. +

+
+
speed
+

Set sweeps per second (Hz). Range from 0.1 to 10. Default value is 0.5. +

+
+
shape
+

Set swept wave shape, can be triangular or sinusoidal. +Default value is sinusoidal. +

+
+
phase
+

Set swept wave percentage-shift for multi channel. Range from 0 to 100. +Default value is 25. +

+
+
interp
+

Set delay-line interpolation, linear or quadratic. +Default is linear. +

+
+ + +

29.69 haas

+

Apply Haas effect to audio. +

+

Note that this makes most sense to apply on mono signals. +With this filter applied to mono signals it give some directionality and +stretches its stereo image. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input level. By default is 1, or 0dB +

+
+
level_out
+

Set output level. By default is 1, or 0dB. +

+
+
side_gain
+

Set gain applied to side part of signal. By default is 1. +

+
+
middle_source
+

Set kind of middle source. Can be one of the following: +

+
+
‘left’
+

Pick left channel. +

+
+
‘right’
+

Pick right channel. +

+
+
‘mid’
+

Pick middle part signal of stereo image. +

+
+
‘side’
+

Pick side part signal of stereo image. +

+
+ +
+
middle_phase
+

Change middle phase. By default is disabled. +

+
+
left_delay
+

Set left channel delay. By default is 2.05 milliseconds. +

+
+
left_balance
+

Set left channel balance. By default is -1. +

+
+
left_gain
+

Set left channel gain. By default is 1. +

+
+
left_phase
+

Change left phase. By default is disabled. +

+
+
right_delay
+

Set right channel delay. By defaults is 2.12 milliseconds. +

+
+
right_balance
+

Set right channel balance. By default is 1. +

+
+
right_gain
+

Set right channel gain. By default is 1. +

+
+
right_phase
+

Change right phase. By default is enabled. +

+
+ + +

29.70 hdcd

+ +

Decodes High Definition Compatible Digital (HDCD) data. A 16-bit PCM stream with +embedded HDCD codes is expanded into a 20-bit PCM stream. +

+

The filter supports the Peak Extend and Low-level Gain Adjustment features +of HDCD, and detects the Transient Filter flag. +

+
+
ffmpeg -i HDCD16.flac -af hdcd OUT24.flac
+
+ +

When using the filter with wav, note the default encoding for wav is 16-bit, +so the resulting 20-bit stream will be truncated back to 16-bit. Use something +like -acodec pcm_s24le after the filter to get 24-bit PCM output. +

+
ffmpeg -i HDCD16.wav -af hdcd OUT16.wav
+ffmpeg -i HDCD16.wav -af hdcd -c:a pcm_s24le OUT24.wav
+
+ +

The filter accepts the following options: +

+
+
disable_autoconvert
+

Disable any automatic format conversion or resampling in the filter graph. +

+
+
process_stereo
+

Process the stereo channels together. If target_gain does not match between +channels, consider it invalid and use the last valid target_gain. +

+
+
cdt_ms
+

Set the code detect timer period in ms. +

+
+
force_pe
+

Always extend peaks above -3dBFS even if PE isn’t signaled. +

+
+
analyze_mode
+

Replace audio with a solid tone and adjust the amplitude to signal some +specific aspect of the decoding process. The output file can be loaded in +an audio editor alongside the original to aid analysis. +

+

analyze_mode=pe:force_pe=true can be used to see all samples above the PE level. +

+

Modes are: +

+
‘0, off’
+

Disabled +

+
‘1, lle’
+

Gain adjustment level at each sample +

+
‘2, pe’
+

Samples where peak extend occurs +

+
‘3, cdt’
+

Samples where the code detect timer is active +

+
‘4, tgm’
+

Samples where the target gain does not match between channels +

+
+
+
+ + +

29.71 headphone

+ +

Apply head-related transfer functions (HRTFs) to create virtual +loudspeakers around the user for binaural listening via headphones. +The HRIRs are provided via additional streams, for each channel +one stereo input stream is needed. +

+

The filter accepts the following options: +

+
+
map
+

Set mapping of input streams for convolution. +The argument is a ’|’-separated list of channel names in order as they +are given as additional stream inputs for filter. +This also specify number of input streams. Number of input streams +must be not less than number of channels in first stream plus one. +

+
+
gain
+

Set gain applied to audio. Value is in dB. Default is 0. +

+
+
type
+

Set processing type. Can be time or freq. time is +processing audio in time domain which is slow. +freq is processing audio in frequency domain which is fast. +Default is freq. +

+
+
lfe
+

Set custom gain for LFE channels. Value is in dB. Default is 0. +

+
+
size
+

Set size of frame in number of samples which will be processed at once. +Default value is 1024. Allowed range is from 1024 to 96000. +

+
+
hrir
+

Set format of hrir stream. +Default value is stereo. Alternative value is multich. +If value is set to stereo, number of additional streams should +be greater or equal to number of input channels in first input stream. +Also each additional stream should have stereo number of channels. +If value is set to multich, number of additional streams should +be exactly one. Also number of input channels of additional stream +should be equal or greater than twice number of channels of first input +stream. +

+
+ + +

29.71.1 Examples

+ +
    +
  • Full example using wav files as coefficients with amovie filters for 7.1 downmix, +each amovie filter use stereo file with IR coefficients as input. +The files give coefficients for each position of virtual loudspeaker: +
    +
    ffmpeg -i input.wav
+-filter_complex "amovie=azi_270_ele_0_DFC.wav[sr];amovie=azi_90_ele_0_DFC.wav[sl];amovie=azi_225_ele_0_DFC.wav[br];amovie=azi_135_ele_0_DFC.wav[bl];amovie=azi_0_ele_0_DFC.wav,asplit[fc][lfe];amovie=azi_35_ele_0_DFC.wav[fl];amovie=azi_325_ele_0_DFC.wav[fr];[0:a][fl][fr][fc][lfe][bl][br][sl][sr]headphone=FL|FR|FC|LFE|BL|BR|SL|SR"
+output.wav
+
    + +
  • Full example using wav files as coefficients with amovie filters for 7.1 downmix, +but now in multich hrir format. +
    +
    ffmpeg -i input.wav -filter_complex "amovie=minp.wav[hrirs];[0:a][hrirs]headphone=map=FL|FR|FC|LFE|BL|BR|SL|SR:hrir=multich"
+output.wav
+
    +
+ + +

29.72 highpass

+ +

Apply a high-pass filter with 3dB point frequency. +The filter can be either single-pole, or double-pole (the default). +The filter roll off at 6dB per pole per octave (20dB per pole per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set frequency in Hz. Default is 3000. +

+
+
poles, p
+

Set number of poles. Default is 2. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +Applies only to double-pole filter. +The default is 0.707q and gives a Butterworth response. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

29.72.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change highpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change highpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change highpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change highpass mix. +Syntax for the command is : "mix" +

+
+ + +

29.73 join

+ +

Join multiple input streams into one multi-channel stream. +

+

It accepts the following parameters: +

+
inputs
+

The number of input streams. It defaults to 2. +

+
+
channel_layout
+

The desired output channel layout. It defaults to stereo. +

+
+
map
+

Map channels from inputs to output. The argument is a ’|’-separated list of +mappings, each in the input_idx.in_channel-out_channel +form. input_idx is the 0-based index of the input stream. in_channel +can be either the name of the input channel (e.g. FL for front left) or its +index in the specified input stream. out_channel is the name of the output +channel. +

+
+ +

The filter will attempt to guess the mappings when they are not specified +explicitly. It does so by first trying to find an unused matching input channel +and if that fails it picks the first unused input channel. +

+

Join 3 inputs (with properly set channel layouts): +

+
ffmpeg -i INPUT1 -i INPUT2 -i INPUT3 -filter_complex join=inputs=3 OUTPUT
+
+ +

Build a 5.1 output from 6 single-channel streams: +

+
ffmpeg -i fl -i fr -i fc -i sl -i sr -i lfe -filter_complex
+'join=inputs=6:channel_layout=5.1:map=0.0-FL|1.0-FR|2.0-FC|3.0-SL|4.0-SR|5.0-LFE'
+out
+
+ + +

29.74 ladspa

+ +

Load a LADSPA (Linux Audio Developer’s Simple Plugin API) plugin. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-ladspa. +

+
+
file, f
+

Specifies the name of LADSPA plugin library to load. If the environment +variable LADSPA_PATH is defined, the LADSPA plugin is searched in +each one of the directories specified by the colon separated list in +LADSPA_PATH, otherwise in the standard LADSPA paths, which are in +this order: HOME/.ladspa/lib/, /usr/local/lib/ladspa/, +/usr/lib/ladspa/. +

+
+
plugin, p
+

Specifies the plugin within the library. Some libraries contain only +one plugin, but others contain many of them. If this is not set filter +will list all available plugins within the specified library. +

+
+
controls, c
+

Set the ’|’ separated list of controls which are zero or more floating point +values that determine the behavior of the loaded plugin (for example delay, +threshold or gain). +Controls need to be defined using the following syntax: +c0=value0|c1=value1|c2=value2|..., where +valuei is the value set on the i-th control. +Alternatively they can be also defined using the following syntax: +value0|value1|value2|..., where +valuei is the value set on the i-th control. +If controls is set to help, all available controls and +their valid ranges are printed. +

+
+
sample_rate, s
+

Specify the sample rate, default to 44100. Only used if plugin have +zero inputs. +

+
+
nb_samples, n
+

Set the number of samples per channel per each output frame, default +is 1024. Only used if plugin have zero inputs. +

+
+
duration, d
+

Set the minimum duration of the sourced audio. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +Note that the resulting duration may be greater than the specified duration, +as the generated audio is always cut at the end of a complete frame. +If not specified, or the expressed duration is negative, the audio is +supposed to be generated forever. +Only used if plugin have zero inputs. +

+
+
+ + +

29.74.1 Examples

+ +
    +
  • List all available plugins within amp (LADSPA example plugin) library: +
    +
    ladspa=file=amp
+
    + +
  • List all available controls and their valid ranges for vcf_notch +plugin from VCF library: +
    +
    ladspa=f=vcf:p=vcf_notch:c=help
+
    + +
  • Simulate low quality audio equipment using Computer Music Toolkit (CMT) +plugin library: +
    +
    ladspa=file=cmt:plugin=lofi:controls=c0=22|c1=12|c2=12
+
    + +
  • Add reverberation to the audio using TAP-plugins +(Tom’s Audio Processing plugins): +
    +
    ladspa=file=tap_reverb:tap_reverb
+
    + +
  • Generate white noise, with 0.2 amplitude: +
    +
    ladspa=file=cmt:noise_source_white:c=c0=.2
+
    + +
  • Generate 20 bpm clicks using plugin C* Click - Metronome from the +C* Audio Plugin Suite (CAPS) library: +
    +
    ladspa=file=caps:Click:c=c1=20'
+
    + +
  • Apply C* Eq10X2 - Stereo 10-band equaliser effect: +
    +
    ladspa=caps:Eq10X2:c=c0=-48|c9=-24|c3=12|c4=2
+
    + +
  • Increase volume by 20dB using fast lookahead limiter from Steve Harris +SWH Plugins collection: +
    +
    ladspa=fast_lookahead_limiter_1913:fastLookaheadLimiter:20|0|2
+
    + +
  • Attenuate low frequencies using Multiband EQ from Steve Harris +SWH Plugins collection: +
    +
    ladspa=mbeq_1197:mbeq:-24|-24|-24|0|0|0|0|0|0|0|0|0|0|0|0
+
    + +
  • Reduce stereo image using Narrower from the C* Audio Plugin Suite +(CAPS) library: +
    +
    ladspa=caps:Narrower
+
    + +
  • Another white noise, now using C* Audio Plugin Suite (CAPS) library: +
    +
    ladspa=caps:White:.2
+
    + +
  • Some fractal noise, using C* Audio Plugin Suite (CAPS) library: +
    +
    ladspa=caps:Fractal:c=c1=1
+
    + +
  • Dynamic volume normalization using VLevel plugin: +
    +
    ladspa=vlevel-ladspa:vlevel_mono
+
    +
+ + +

29.74.2 Commands

+ +

This filter supports the following commands: +

+
cN
+

Modify the N-th control value. +

+

If the specified value is not valid, it is ignored and prior one is kept. +

+
+ + +

29.75 loudnorm

+ +

EBU R128 loudness normalization. Includes both dynamic and linear normalization modes. +Support for both single pass (livestreams, files) and double pass (files) modes. +This algorithm can target IL, LRA, and maximum true peak. In dynamic mode, to accurately +detect true peaks, the audio stream will be upsampled to 192 kHz. +Use the -ar option or aresample filter to explicitly set an output sample rate. +

+

The filter accepts the following options: +

+
+
I, i
+

Set integrated loudness target. +Range is -70.0 - -5.0. Default value is -24.0. +

+
+
LRA, lra
+

Set loudness range target. +Range is 1.0 - 20.0. Default value is 7.0. +

+
+
TP, tp
+

Set maximum true peak. +Range is -9.0 - +0.0. Default value is -2.0. +

+
+
measured_I, measured_i
+

Measured IL of input file. +Range is -99.0 - +0.0. +

+
+
measured_LRA, measured_lra
+

Measured LRA of input file. +Range is 0.0 - 99.0. +

+
+
measured_TP, measured_tp
+

Measured true peak of input file. +Range is -99.0 - +99.0. +

+
+
measured_thresh
+

Measured threshold of input file. +Range is -99.0 - +0.0. +

+
+
offset
+

Set offset gain. Gain is applied before the true-peak limiter. +Range is -99.0 - +99.0. Default is +0.0. +

+
+
linear
+

Normalize by linearly scaling the source audio. +measured_I, measured_LRA, measured_TP, +and measured_thresh must all be specified. Target LRA shouldn’t +be lower than source LRA and the change in integrated loudness shouldn’t +result in a true peak which exceeds the target TP. If any of these +conditions aren’t met, normalization mode will revert to dynamic. +Options are true or false. Default is true. +

+
+
dual_mono
+

Treat mono input files as "dual-mono". If a mono file is intended for playback +on a stereo system, its EBU R128 measurement will be perceptually incorrect. +If set to true, this option will compensate for this effect. +Multi-channel input files are not affected by this option. +Options are true or false. Default is false. +

+
+
print_format
+

Set print format for stats. Options are summary, json, or none. +Default value is none. +

+
+ + +

29.76 lowpass

+ +

Apply a low-pass filter with 3dB point frequency. +The filter can be either single-pole or double-pole (the default). +The filter roll off at 6dB per pole per octave (20dB per pole per decade). +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set frequency in Hz. Default is 500. +

+
+
poles, p
+

Set number of poles. Default is 2. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Specify the band-width of a filter in width_type units. +Applies only to double-pole filter. +The default is 0.707q and gives a Butterworth response. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

29.76.1 Examples

+
    +
  • Lowpass only LFE channel, it LFE is not present it does nothing: +
    +
    lowpass=c=LFE
+
    +
+ + +

29.76.2 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change lowpass frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change lowpass width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change lowpass width. +Syntax for the command is : "width" +

+
+
mix, m
+

Change lowpass mix. +Syntax for the command is : "mix" +

+
+ + +

29.77 lv2

+ +

Load a LV2 (LADSPA Version 2) plugin. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-lv2. +

+
+
plugin, p
+

Specifies the plugin URI. You may need to escape ’:’. +

+
+
controls, c
+

Set the ’|’ separated list of controls which are zero or more floating point +values that determine the behavior of the loaded plugin (for example delay, +threshold or gain). +If controls is set to help, all available controls and +their valid ranges are printed. +

+
+
sample_rate, s
+

Specify the sample rate, default to 44100. Only used if plugin have +zero inputs. +

+
+
nb_samples, n
+

Set the number of samples per channel per each output frame, default +is 1024. Only used if plugin have zero inputs. +

+
+
duration, d
+

Set the minimum duration of the sourced audio. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +Note that the resulting duration may be greater than the specified duration, +as the generated audio is always cut at the end of a complete frame. +If not specified, or the expressed duration is negative, the audio is +supposed to be generated forever. +Only used if plugin have zero inputs. +

+
+ + +

29.77.1 Examples

+ +
    +
  • Apply bass enhancer plugin from Calf: +
    +
    lv2=p=http\\\\://calf.sourceforge.net/plugins/BassEnhancer:c=amount=2
+
    + +
  • Apply vinyl plugin from Calf: +
    +
    lv2=p=http\\\\://calf.sourceforge.net/plugins/Vinyl:c=drone=0.2|aging=0.5
+
    + +
  • Apply bit crusher plugin from ArtyFX: +
    +
    lv2=p=http\\\\://www.openavproductions.com/artyfx#bitta:c=crush=0.3
+
    +
+ + +

29.78 mcompand

+

Multiband Compress or expand the audio’s dynamic range. +

+

The input audio is divided into bands using 4th order Linkwitz-Riley IIRs. +This is akin to the crossover of a loudspeaker, and results in flat frequency +response when absent compander action. +

+

It accepts the following parameters: +

+
+
args
+

This option syntax is: +attack,decay,[attack,decay..] soft-knee points crossover_frequency [delay [initial_volume [gain]]] | attack,decay ... +For explanation of each item refer to compand filter documentation. +

+
+ + +

29.79 pan

+ +

Mix channels with specific gain levels. The filter accepts the output +channel layout followed by a set of channels definitions. +

+

This filter is also designed to efficiently remap the channels of an audio +stream. +

+

The filter accepts parameters of the form: +"l|outdef|outdef|..." +

+
+
l
+

output channel layout or number of channels +

+
+
outdef
+

output channel specification, of the form: +"out_name=[gain*]in_name[(+-)[gain*]in_name...]" +

+
+
out_name
+

output channel to define, either a channel name (FL, FR, etc.) or a channel +number (c0, c1, etc.) +

+
+
gain
+

multiplicative coefficient for the channel, 1 leaving the volume unchanged +

+
+
in_name
+

input channel to use, see out_name for details; it is not possible to mix +named and numbered input channels +

+
+ +

If the ‘=’ in a channel specification is replaced by ‘<’, then the gains for +that specification will be renormalized so that the total is 1, thus +avoiding clipping noise. +

+ +

29.79.1 Mixing examples

+ +

For example, if you want to down-mix from stereo to mono, but with a bigger +factor for the left channel: +

+
pan=1c|c0=0.9*c0+0.1*c1
+
+ +

A customized down-mix to stereo that works automatically for 3-, 4-, 5- and +7-channels surround: +

+
pan=stereo| FL < FL + 0.5*FC + 0.6*BL + 0.6*SL | FR < FR + 0.5*FC + 0.6*BR + 0.6*SR
+
+ +

Note that ffmpeg integrates a default down-mix (and up-mix) system +that should be preferred (see "-ac" option) unless you have very specific +needs. +

+ +

29.79.2 Remapping examples

+ +

The channel remapping will be effective if, and only if: +

+
    +
  • gain coefficients are zeroes or ones, +
  • only one input per channel output, +
+ +

If all these conditions are satisfied, the filter will notify the user ("Pure +channel mapping detected"), and use an optimized and lossless method to do the +remapping. +

+

For example, if you have a 5.1 source and want a stereo audio stream by +dropping the extra channels: +

+
pan="stereo| c0=FL | c1=FR"
+
+ +

Given the same source, you can also switch front left and front right channels +and keep the input channel layout: +

+
pan="5.1| c0=c1 | c1=c0 | c2=c2 | c3=c3 | c4=c4 | c5=c5"
+
+ +

If the input is a stereo audio stream, you can mute the front left channel (and +still keep the stereo channel layout) with: +

+
pan="stereo|c1=c1"
+
+ +

Still with a stereo audio stream input, you can copy the right channel in both +front left and right: +

+
pan="stereo| c0=FR | c1=FR"
+
+ + +

29.80 replaygain

+ +

ReplayGain scanner filter. This filter takes an audio stream as an input and +outputs it unchanged. +At end of filtering it displays track_gain and track_peak. +

+ +

29.81 resample

+ +

Convert the audio sample format, sample rate and channel layout. It is +not meant to be used directly. +

+ +

29.82 rubberband

+

Apply time-stretching and pitch-shifting with librubberband. +

+

To enable compilation of this filter, you need to configure FFmpeg with +--enable-librubberband. +

+

The filter accepts the following options: +

+
+
tempo
+

Set tempo scale factor. +

+
+
pitch
+

Set pitch scale factor. +

+
+
transients
+

Set transients detector. +Possible values are: +

+
crisp
+
mixed
+
smooth
+
+ +
+
detector
+

Set detector. +Possible values are: +

+
compound
+
percussive
+
soft
+
+ +
+
phase
+

Set phase. +Possible values are: +

+
laminar
+
independent
+
+ +
+
window
+

Set processing window size. +Possible values are: +

+
standard
+
short
+
long
+
+ +
+
smoothing
+

Set smoothing. +Possible values are: +

+
off
+
on
+
+ +
+
formant
+

Enable formant preservation when shift pitching. +Possible values are: +

+
shifted
+
preserved
+
+ +
+
pitchq
+

Set pitch quality. +Possible values are: +

+
quality
+
speed
+
consistency
+
+ +
+
channels
+

Set channels. +Possible values are: +

+
apart
+
together
+
+
+
+ + +

29.82.1 Commands

+ +

This filter supports the following commands: +

+
tempo
+

Change filter tempo scale factor. +Syntax for the command is : "tempo" +

+
+
pitch
+

Change filter pitch scale factor. +Syntax for the command is : "pitch" +

+
+ + +

29.83 sidechaincompress

+ +

This filter acts like normal compressor but has the ability to compress +detected signal using second input signal. +It needs two input streams and returns one output stream. +First input stream will be processed depending on second stream signal. +The filtered signal then can be filtered with other filters in later stages of +processing. See pan and amerge filter. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input gain. Default is 1. Range is between 0.015625 and 64. +

+
+
mode
+

Set mode of compressor operation. Can be upward or downward. +Default is downward. +

+
+
threshold
+

If a signal of second stream raises above this level it will affect the gain +reduction of first stream. +By default is 0.125. Range is between 0.00097563 and 1. +

+
+
ratio
+

Set a ratio about which the signal is reduced. 1:2 means that if the level +raised 4dB above the threshold, it will be only 2dB above after the reduction. +Default is 2. Range is between 1 and 20. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction starts. Default is 20. Range is between 0.01 and 2000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before +reduction is decreased again. Default is 250. Range is between 0.01 and 9000. +

+
+
makeup
+

Set the amount by how much signal will be amplified after processing. +Default is 1. Range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.82843. Range is between 1 and 8. +

+
+
link
+

Choose if the average level between all channels of side-chain stream +or the louder(maximum) channel of side-chain stream affects the +reduction. Default is average. +

+
+
detection
+

Should the exact signal be taken in case of peak or an RMS one in case +of rms. Default is rms which is mainly smoother. +

+
+
level_sc
+

Set sidechain gain. Default is 1. Range is between 0.015625 and 64. +

+
+
mix
+

How much to use compressed signal in output. Default is 1. +Range is between 0 and 1. +

+
+ + +

29.83.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

29.83.2 Examples

+ +
    +
  • Full ffmpeg example taking 2 audio inputs, 1st input to be compressed +depending on the signal of 2nd input and later compressed signal to be +merged with 2nd input: +
    +
    ffmpeg -i main.flac -i sidechain.flac -filter_complex "[1:a]asplit=2[sc][mix];[0:a][sc]sidechaincompress[compr];[compr][mix]amerge"
+
    +
+ + +

29.84 sidechaingate

+ +

A sidechain gate acts like a normal (wideband) gate but has the ability to +filter the detected signal before sending it to the gain reduction stage. +Normally a gate uses the full range signal to detect a level above the +threshold. +For example: If you cut all lower frequencies from your sidechain signal +the gate will decrease the volume of your track only if not enough highs +appear. With this technique you are able to reduce the resonation of a +natural drum or remove "rumbling" of muted strokes from a heavily distorted +guitar. +It needs two input streams and returns one output stream. +First input stream will be processed depending on second stream signal. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input level before filtering. +Default is 1. Allowed range is from 0.015625 to 64. +

+
+
mode
+

Set the mode of operation. Can be upward or downward. +Default is downward. If set to upward mode, higher parts of signal +will be amplified, expanding dynamic range in upward direction. +Otherwise, in case of downward lower parts of signal will be reduced. +

+
+
range
+

Set the level of gain reduction when the signal is below the threshold. +Default is 0.06125. Allowed range is from 0 to 1. +Setting this to 0 disables reduction and then filter behaves like expander. +

+
+
threshold
+

If a signal rises above this level the gain reduction is released. +Default is 0.125. Allowed range is from 0 to 1. +

+
+
ratio
+

Set a ratio about which the signal is reduced. +Default is 2. Allowed range is from 1 to 9000. +

+
+
attack
+

Amount of milliseconds the signal has to rise above the threshold before gain +reduction stops. +Default is 20 milliseconds. Allowed range is from 0.01 to 9000. +

+
+
release
+

Amount of milliseconds the signal has to fall below the threshold before the +reduction is increased again. Default is 250 milliseconds. +Allowed range is from 0.01 to 9000. +

+
+
makeup
+

Set amount of amplification of signal after processing. +Default is 1. Allowed range is from 1 to 64. +

+
+
knee
+

Curve the sharp knee around the threshold to enter gain reduction more softly. +Default is 2.828427125. Allowed range is from 1 to 8. +

+
+
detection
+

Choose if exact signal should be taken for detection or an RMS like one. +Default is rms. Can be peak or rms. +

+
+
link
+

Choose if the average level between all channels or the louder channel affects +the reduction. +Default is average. Can be average or maximum. +

+
+
level_sc
+

Set sidechain gain. Default is 1. Range is from 0.015625 to 64. +

+
+ + +

29.85 silencedetect

+ +

Detect silence in an audio stream. +

+

This filter logs a message when it detects that the input audio volume is less +or equal to a noise tolerance value for a duration greater or equal to the +minimum detected noise duration. +

+

The printed times and duration are expressed in seconds. The +lavfi.silence_start or lavfi.silence_start.X metadata key +is set on the first frame whose timestamp equals or exceeds the detection +duration and it contains the timestamp of the first frame of the silence. +

+

The lavfi.silence_duration or lavfi.silence_duration.X +and lavfi.silence_end or lavfi.silence_end.X metadata +keys are set on the first frame after the silence. If mono is +enabled, and each channel is evaluated separately, the .X +suffixed keys are used, and X corresponds to the channel number. +

+

The filter accepts the following options: +

+
+
noise, n
+

Set noise tolerance. Can be specified in dB (in case "dB" is appended to the +specified value) or amplitude ratio. Default is -60dB, or 0.001. +

+
+
duration, d
+

Set silence duration until notification (default is 2 seconds). See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+
+
mono, m
+

Process each channel separately, instead of combined. By default is disabled. +

+
+ + +

29.85.1 Examples

+ +
    +
  • Detect 5 seconds of silence with -50dB noise tolerance: +
    +
    silencedetect=n=-50dB:d=5
+
    + +
  • Complete example with ffmpeg to detect silence with 0.0001 noise +tolerance in silence.mp3: +
    +
    ffmpeg -i silence.mp3 -af silencedetect=noise=0.0001 -f null -
+
    +
+ + +

29.86 silenceremove

+ +

Remove silence from the beginning, middle or end of the audio. +

+

The filter accepts the following options: +

+
+
start_periods
+

This value is used to indicate if audio should be trimmed at beginning of +the audio. A value of zero indicates no silence should be trimmed from the +beginning. When specifying a non-zero value, it trims audio up until it +finds non-silence. Normally, when trimming silence from beginning of audio +the start_periods will be 1 but it can be increased to higher +values to trim all audio up to specific count of non-silence periods. +Default value is 0. +

+
+
start_duration
+

Specify the amount of time that non-silence must be detected before it stops +trimming audio. By increasing the duration, bursts of noises can be treated +as silence and trimmed off. Default value is 0. +

+
+
start_threshold
+

This indicates what sample value should be treated as silence. For digital +audio, a value of 0 may be fine but for audio recorded from analog, +you may wish to increase the value to account for background noise. +Can be specified in dB (in case "dB" is appended to the specified value) +or amplitude ratio. Default value is 0. +

+
+
start_silence
+

Specify max duration of silence at beginning that will be kept after +trimming. Default is 0, which is equal to trimming all samples detected +as silence. +

+
+
start_mode
+

Specify mode of detection of silence end in start of multi-channel audio. +Can be any or all. Default is any. +With any, any sample that is detected as non-silence will cause +stopped trimming of silence. +With all, only if all channels are detected as non-silence will cause +stopped trimming of silence. +

+
+
stop_periods
+

Set the count for trimming silence from the end of audio. +To remove silence from the middle of a file, specify a stop_periods +that is negative. This value is then treated as a positive value and is +used to indicate the effect should restart processing as specified by +start_periods, making it suitable for removing periods of silence +in the middle of the audio. +Default value is 0. +

+
+
stop_duration
+

Specify a duration of silence that must exist before audio is not copied any +more. By specifying a higher duration, silence that is wanted can be left in +the audio. +Default value is 0. +

+
+
stop_threshold
+

This is the same as start_threshold but for trimming silence from +the end of audio. +Can be specified in dB (in case "dB" is appended to the specified value) +or amplitude ratio. Default value is 0. +

+
+
stop_silence
+

Specify max duration of silence at end that will be kept after +trimming. Default is 0, which is equal to trimming all samples detected +as silence. +

+
+
stop_mode
+

Specify mode of detection of silence start in end of multi-channel audio. +Can be any or all. Default is any. +With any, any sample that is detected as non-silence will cause +stopped trimming of silence. +With all, only if all channels are detected as non-silence will cause +stopped trimming of silence. +

+
+
detection
+

Set how is silence detected. Can be rms or peak. Second is faster +and works better with digital silence which is exactly 0. +Default value is rms. +

+
+
window
+

Set duration in number of seconds used to calculate size of window in number +of samples for detecting silence. +Default value is 0.02. Allowed range is from 0 to 10. +

+
+ + +

29.86.1 Examples

+ +
    +
  • The following example shows how this filter can be used to start a recording +that does not contain the delay at the start which usually occurs between +pressing the record button and the start of the performance: +
    +
    silenceremove=start_periods=1:start_duration=5:start_threshold=0.02
+
    + +
  • Trim all silence encountered from beginning to end where there is more than 1 +second of silence in audio: +
    +
    silenceremove=stop_periods=-1:stop_duration=1:stop_threshold=-90dB
+
    + +
  • Trim all digital silence samples, using peak detection, from beginning to end +where there is more than 0 samples of digital silence in audio and digital +silence is detected in all channels at same positions in stream: +
    +
    silenceremove=window=0:detection=peak:stop_mode=all:start_mode=all:stop_periods=-1:stop_threshold=0
+
    +
+ + +

29.87 sofalizer

+ +

SOFAlizer uses head-related transfer functions (HRTFs) to create virtual +loudspeakers around the user for binaural listening via headphones (audio +formats up to 9 channels supported). +The HRTFs are stored in SOFA files (see http://www.sofacoustics.org/ for a database). +SOFAlizer is developed at the Acoustics Research Institute (ARI) of the +Austrian Academy of Sciences. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libmysofa. +

+

The filter accepts the following options: +

+
+
sofa
+

Set the SOFA file used for rendering. +

+
+
gain
+

Set gain applied to audio. Value is in dB. Default is 0. +

+
+
rotation
+

Set rotation of virtual loudspeakers in deg. Default is 0. +

+
+
elevation
+

Set elevation of virtual speakers in deg. Default is 0. +

+
+
radius
+

Set distance in meters between loudspeakers and the listener with near-field +HRTFs. Default is 1. +

+
+
type
+

Set processing type. Can be time or freq. time is +processing audio in time domain which is slow. +freq is processing audio in frequency domain which is fast. +Default is freq. +

+
+
speakers
+

Set custom positions of virtual loudspeakers. Syntax for this option is: +<CH> <AZIM> <ELEV>[|<CH> <AZIM> <ELEV>|...]. +Each virtual loudspeaker is described with short channel name following with +azimuth and elevation in degrees. +Each virtual loudspeaker description is separated by ’|’. +For example to override front left and front right channel positions use: +’speakers=FL 45 15|FR 345 15’. +Descriptions with unrecognised channel names are ignored. +

+
+
lfegain
+

Set custom gain for LFE channels. Value is in dB. Default is 0. +

+
+
framesize
+

Set custom frame size in number of samples. Default is 1024. +Allowed range is from 1024 to 96000. Only used if option ‘type’ +is set to freq. +

+
+
normalize
+

Should all IRs be normalized upon importing SOFA file. +By default is enabled. +

+
+
interpolate
+

Should nearest IRs be interpolated with neighbor IRs if exact position +does not match. By default is disabled. +

+
+
minphase
+

Minphase all IRs upon loading of SOFA file. By default is disabled. +

+
+
anglestep
+

Set neighbor search angle step. Only used if option interpolate is enabled. +

+
+
radstep
+

Set neighbor search radius step. Only used if option interpolate is enabled. +

+
+ + +

29.87.1 Examples

+ +
    +
  • Using ClubFritz6 sofa file: +
    +
    sofalizer=sofa=/path/to/ClubFritz6.sofa:type=freq:radius=1
+
    + +
  • Using ClubFritz12 sofa file and bigger radius with small rotation: +
    +
    sofalizer=sofa=/path/to/ClubFritz12.sofa:type=freq:radius=2:rotation=5
+
    + +
  • Similar as above but with custom speaker positions for front left, front right, back left and back right +and also with custom gain: +
    +
    "sofalizer=sofa=/path/to/ClubFritz6.sofa:type=freq:radius=2:speakers=FL 45|FR 315|BL 135|BR 225:gain=28"
+
    +
+ + +

29.88 stereotools

+ +

This filter has some handy utilities to manage stereo signals, for converting +M/S stereo recordings to L/R signal while having control over the parameters +or spreading the stereo image of master track. +

+

The filter accepts the following options: +

+
+
level_in
+

Set input level before filtering for both channels. Defaults is 1. +Allowed range is from 0.015625 to 64. +

+
+
level_out
+

Set output level after filtering for both channels. Defaults is 1. +Allowed range is from 0.015625 to 64. +

+
+
balance_in
+

Set input balance between both channels. Default is 0. +Allowed range is from -1 to 1. +

+
+
balance_out
+

Set output balance between both channels. Default is 0. +Allowed range is from -1 to 1. +

+
+
softclip
+

Enable softclipping. Results in analog distortion instead of harsh digital 0dB +clipping. Disabled by default. +

+
+
mutel
+

Mute the left channel. Disabled by default. +

+
+
muter
+

Mute the right channel. Disabled by default. +

+
+
phasel
+

Change the phase of the left channel. Disabled by default. +

+
+
phaser
+

Change the phase of the right channel. Disabled by default. +

+
+
mode
+

Set stereo mode. Available values are: +

+
+
‘lr>lr’
+

Left/Right to Left/Right, this is default. +

+
+
‘lr>ms’
+

Left/Right to Mid/Side. +

+
+
‘ms>lr’
+

Mid/Side to Left/Right. +

+
+
‘lr>ll’
+

Left/Right to Left/Left. +

+
+
‘lr>rr’
+

Left/Right to Right/Right. +

+
+
‘lr>l+r’
+

Left/Right to Left + Right. +

+
+
‘lr>rl’
+

Left/Right to Right/Left. +

+
+
‘ms>ll’
+

Mid/Side to Left/Left. +

+
+
‘ms>rr’
+

Mid/Side to Right/Right. +

+
+ +
+
slev
+

Set level of side signal. Default is 1. +Allowed range is from 0.015625 to 64. +

+
+
sbal
+

Set balance of side signal. Default is 0. +Allowed range is from -1 to 1. +

+
+
mlev
+

Set level of the middle signal. Default is 1. +Allowed range is from 0.015625 to 64. +

+
+
mpan
+

Set middle signal pan. Default is 0. Allowed range is from -1 to 1. +

+
+
base
+

Set stereo base between mono and inversed channels. Default is 0. +Allowed range is from -1 to 1. +

+
+
delay
+

Set delay in milliseconds how much to delay left from right channel and +vice versa. Default is 0. Allowed range is from -20 to 20. +

+
+
sclevel
+

Set S/C level. Default is 1. Allowed range is from 1 to 100. +

+
+
phase
+

Set the stereo phase in degrees. Default is 0. Allowed range is from 0 to 360. +

+
+
bmode_in, bmode_out
+

Set balance mode for balance_in/balance_out option. +

+

Can be one of the following: +

+
+
‘balance’
+

Classic balance mode. Attenuate one channel at time. +Gain is raised up to 1. +

+
+
‘amplitude’
+

Similar as classic mode above but gain is raised up to 2. +

+
+
‘power’
+

Equal power distribution, from -6dB to +6dB range. +

+
+
+
+ + +

29.88.1 Examples

+ +
    +
  • Apply karaoke like effect: +
    +
    stereotools=mlev=0.015625
+
    + +
  • Convert M/S signal to L/R: +
    +
    "stereotools=mode=ms>lr"
+
    +
+ + +

29.89 stereowiden

+ +

This filter enhance the stereo effect by suppressing signal common to both +channels and by delaying the signal of left into right and vice versa, +thereby widening the stereo effect. +

+

The filter accepts the following options: +

+
+
delay
+

Time in milliseconds of the delay of left signal into right and vice versa. +Default is 20 milliseconds. +

+
+
feedback
+

Amount of gain in delayed signal into right and vice versa. Gives a delay +effect of left signal in right output and vice versa which gives widening +effect. Default is 0.3. +

+
+
crossfeed
+

Cross feed of left into right with inverted phase. This helps in suppressing +the mono. If the value is 1 it will cancel all the signal common to both +channels. Default is 0.3. +

+
+
drymix
+

Set level of input signal of original channel. Default is 0.8. +

+
+ + +

29.89.1 Commands

+ +

This filter supports the all above options except delay as commands. +

+ +

29.90 superequalizer

+

Apply 18 band equalizer. +

+

The filter accepts the following options: +

+
1b
+

Set 65Hz band gain. +

+
2b
+

Set 92Hz band gain. +

+
3b
+

Set 131Hz band gain. +

+
4b
+

Set 185Hz band gain. +

+
5b
+

Set 262Hz band gain. +

+
6b
+

Set 370Hz band gain. +

+
7b
+

Set 523Hz band gain. +

+
8b
+

Set 740Hz band gain. +

+
9b
+

Set 1047Hz band gain. +

+
10b
+

Set 1480Hz band gain. +

+
11b
+

Set 2093Hz band gain. +

+
12b
+

Set 2960Hz band gain. +

+
13b
+

Set 4186Hz band gain. +

+
14b
+

Set 5920Hz band gain. +

+
15b
+

Set 8372Hz band gain. +

+
16b
+

Set 11840Hz band gain. +

+
17b
+

Set 16744Hz band gain. +

+
18b
+

Set 20000Hz band gain. +

+
+ + +

29.91 surround

+

Apply audio surround upmix filter. +

+

This filter allows to produce multichannel output from audio stream. +

+

The filter accepts the following options: +

+
+
chl_out
+

Set output channel layout. By default, this is 5.1. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+
chl_in
+

Set input channel layout. By default, this is stereo. +

+

See (ffmpeg-utils)the Channel Layout section in the ffmpeg-utils(1) manual +for the required syntax. +

+
+
level_in
+

Set input volume level. By default, this is 1. +

+
+
level_out
+

Set output volume level. By default, this is 1. +

+
+
lfe
+

Enable LFE channel output if output channel layout has it. By default, this is enabled. +

+
+
lfe_low
+

Set LFE low cut off frequency. By default, this is 128 Hz. +

+
+
lfe_high
+

Set LFE high cut off frequency. By default, this is 256 Hz. +

+
+
lfe_mode
+

Set LFE mode, can be add or sub. Default is add. +In add mode, LFE channel is created from input audio and added to output. +In sub mode, LFE channel is created from input audio and added to output but +also all non-LFE output channels are subtracted with output LFE channel. +

+
+
angle
+

Set angle of stereo surround transform, Allowed range is from 0 to 360. +Default is 90. +

+
+
fc_in
+

Set front center input volume. By default, this is 1. +

+
+
fc_out
+

Set front center output volume. By default, this is 1. +

+
+
fl_in
+

Set front left input volume. By default, this is 1. +

+
+
fl_out
+

Set front left output volume. By default, this is 1. +

+
+
fr_in
+

Set front right input volume. By default, this is 1. +

+
+
fr_out
+

Set front right output volume. By default, this is 1. +

+
+
sl_in
+

Set side left input volume. By default, this is 1. +

+
+
sl_out
+

Set side left output volume. By default, this is 1. +

+
+
sr_in
+

Set side right input volume. By default, this is 1. +

+
+
sr_out
+

Set side right output volume. By default, this is 1. +

+
+
bl_in
+

Set back left input volume. By default, this is 1. +

+
+
bl_out
+

Set back left output volume. By default, this is 1. +

+
+
br_in
+

Set back right input volume. By default, this is 1. +

+
+
br_out
+

Set back right output volume. By default, this is 1. +

+
+
bc_in
+

Set back center input volume. By default, this is 1. +

+
+
bc_out
+

Set back center output volume. By default, this is 1. +

+
+
lfe_in
+

Set LFE input volume. By default, this is 1. +

+
+
lfe_out
+

Set LFE output volume. By default, this is 1. +

+
+
allx
+

Set spread usage of stereo image across X axis for all channels. +

+
+
ally
+

Set spread usage of stereo image across Y axis for all channels. +

+
+
fcx, flx, frx, blx, brx, slx, srx, bcx
+

Set spread usage of stereo image across X axis for each channel. +

+
+
fcy, fly, fry, bly, bry, sly, sry, bcy
+

Set spread usage of stereo image across Y axis for each channel. +

+
+
win_size
+

Set window size. Allowed range is from 1024 to 65536. Default size is 4096. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann, hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+

Default is hann. +

+
+
overlap
+

Set window overlap. If set to 1, the recommended overlap for selected +window function will be picked. Default is 0.5. +

+
+ + +

29.92 treble, highshelf

+ +

Boost or cut treble (upper) frequencies of the audio using a two-pole +shelving filter with a response similar to that of a standard +hi-fi’s tone-controls. This is also known as shelving equalisation (EQ). +

+

The filter accepts the following options: +

+
+
gain, g
+

Give the gain at whichever is the lower of ~22 kHz and the +Nyquist frequency. Its useful range is about -20 (for a large cut) +to +20 (for a large boost). Beware of clipping when using a positive gain. +

+
+
frequency, f
+

Set the filter’s central frequency and so can be used +to extend or reduce the frequency range to be boosted or cut. +The default value is 3000 Hz. +

+
+
width_type, t
+

Set method to specify band-width of filter. +

+
h
+

Hz +

+
q
+

Q-Factor +

+
o
+

octave +

+
s
+

slope +

+
k
+

kHz +

+
+ +
+
width, w
+

Determine how steep is the filter’s shelf transition. +

+
+
mix, m
+

How much to use filtered signal in output. Default is 1. +Range is between 0 and 1. +

+
+
channels, c
+

Specify which channels to filter, by default all available are filtered. +

+
+
normalize, n
+

Normalize biquad coefficients, by default is disabled. +Enabling it will normalize magnitude response at DC to 0dB. +

+
+ + +

29.92.1 Commands

+ +

This filter supports the following commands: +

+
frequency, f
+

Change treble frequency. +Syntax for the command is : "frequency" +

+
+
width_type, t
+

Change treble width_type. +Syntax for the command is : "width_type" +

+
+
width, w
+

Change treble width. +Syntax for the command is : "width" +

+
+
gain, g
+

Change treble gain. +Syntax for the command is : "gain" +

+
+
mix, m
+

Change treble mix. +Syntax for the command is : "mix" +

+
+ + +

29.93 tremolo

+ +

Sinusoidal amplitude modulation. +

+

The filter accepts the following options: +

+
+
f
+

Modulation frequency in Hertz. Modulation frequencies in the subharmonic range +(20 Hz or lower) will result in a tremolo effect. +This filter may also be used as a ring modulator by specifying +a modulation frequency higher than 20 Hz. +Range is 0.1 - 20000.0. Default value is 5.0 Hz. +

+
+
d
+

Depth of modulation as a percentage. Range is 0.0 - 1.0. +Default value is 0.5. +

+
+ + +

29.94 vibrato

+ +

Sinusoidal phase modulation. +

+

The filter accepts the following options: +

+
+
f
+

Modulation frequency in Hertz. +Range is 0.1 - 20000.0. Default value is 5.0 Hz. +

+
+
d
+

Depth of modulation as a percentage. Range is 0.0 - 1.0. +Default value is 0.5. +

+
+ + +

29.95 volume

+ +

Adjust the input audio volume. +

+

It accepts the following parameters: +

+
volume
+

Set audio volume expression. +

+

Output values are clipped to the maximum value. +

+

The output audio volume is given by the relation: +

+
output_volume = volume * input_volume
+
+ +

The default value for volume is "1.0". +

+
+
precision
+

This parameter represents the mathematical precision. +

+

It determines which input sample formats will be allowed, which affects the +precision of the volume scaling. +

+
+
fixed
+

8-bit fixed-point; this limits input sample format to U8, S16, and S32. +

+
float
+

32-bit floating-point; this limits input sample format to FLT. (default) +

+
double
+

64-bit floating-point; this limits input sample format to DBL. +

+
+ +
+
replaygain
+

Choose the behaviour on encountering ReplayGain side data in input frames. +

+
+
drop
+

Remove ReplayGain side data, ignoring its contents (the default). +

+
+
ignore
+

Ignore ReplayGain side data, but leave it in the frame. +

+
+
track
+

Prefer the track gain, if present. +

+
+
album
+

Prefer the album gain, if present. +

+
+ +
+
replaygain_preamp
+

Pre-amplification gain in dB to apply to the selected replaygain gain. +

+

Default value for replaygain_preamp is 0.0. +

+
+
replaygain_noclip
+

Prevent clipping by limiting the gain applied. +

+

Default value for replaygain_noclip is 1. +

+
+
eval
+

Set when the volume expression is evaluated. +

+

It accepts the following values: +

+
‘once’
+

only evaluate expression once during the filter initialization, or +when the ‘volume’ command is sent +

+
+
‘frame’
+

evaluate expression for each incoming frame +

+
+ +

Default value is ‘once’. +

+
+ +

The volume expression can contain the following parameters. +

+
+
n
+

frame number (starting at zero) +

+
nb_channels
+

number of channels +

+
nb_consumed_samples
+

number of samples consumed by the filter +

+
nb_samples
+

number of samples in the current frame +

+
pos
+

original frame position in the file +

+
pts
+

frame PTS +

+
sample_rate
+

sample rate +

+
startpts
+

PTS at start of stream +

+
startt
+

time at start of stream +

+
t
+

frame time +

+
tb
+

timestamp timebase +

+
volume
+

last set volume value +

+
+ +

Note that when eval is set to ‘once’ only the +sample_rate and tb variables are available, all other +variables will evaluate to NAN. +

+ +

29.95.1 Commands

+ +

This filter supports the following commands: +

+
volume
+

Modify the volume expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

29.95.2 Examples

+ +
    +
  • Halve the input audio volume: +
    +
    volume=volume=0.5
+volume=volume=1/2
+volume=volume=-6.0206dB
+
    + +

    In all the above example the named key for volume can be +omitted, for example like in: +

    +
    volume=0.5
+
    + +
  • Increase input audio power by 6 decibels using fixed-point precision: +
    +
    volume=volume=6dB:precision=fixed
+
    + +
  • Fade volume after time 10 with an annihilation period of 5 seconds: +
    +
    volume='if(lt(t,10),1,max(1-(t-10)/5,0))':eval=frame
+
    +
+ + +

29.96 volumedetect

+ +

Detect the volume of the input video. +

+

The filter has no parameters. The input is not modified. Statistics about +the volume will be printed in the log when the input stream end is reached. +

+

In particular it will show the mean volume (root mean square), maximum +volume (on a per-sample basis), and the beginning of a histogram of the +registered volume values (from the maximum value to a cumulated 1/1000 of +the samples). +

+

All volumes are in decibels relative to the maximum PCM value. +

+ +

29.96.1 Examples

+ +

Here is an excerpt of the output: +

+
[Parsed_volumedetect_0  0xa23120] mean_volume: -27 dB
+[Parsed_volumedetect_0  0xa23120] max_volume: -4 dB
+[Parsed_volumedetect_0  0xa23120] histogram_4db: 6
+[Parsed_volumedetect_0  0xa23120] histogram_5db: 62
+[Parsed_volumedetect_0  0xa23120] histogram_6db: 286
+[Parsed_volumedetect_0  0xa23120] histogram_7db: 1042
+[Parsed_volumedetect_0  0xa23120] histogram_8db: 2551
+[Parsed_volumedetect_0  0xa23120] histogram_9db: 4609
+[Parsed_volumedetect_0  0xa23120] histogram_10db: 8409
+
+ +

It means that: +

    +
  • The mean square energy is approximately -27 dB, or 10^-2.7. +
  • The largest sample is at -4 dB, or more precisely between -4 dB and -5 dB. +
  • There are 6 samples at -4 dB, 62 at -5 dB, 286 at -6 dB, etc. +
+ +

In other words, raising the volume by +4 dB does not cause any clipping, +raising it by +5 dB causes clipping for 6 samples, etc. +

+ + +

30 Audio Sources

+ +

Below is a description of the currently available audio sources. +

+ +

30.1 abuffer

+ +

Buffer audio frames, and make them available to the filter chain. +

+

This source is mainly intended for a programmatic use, in particular +through the interface defined in libavfilter/asrc_abuffer.h. +

+

It accepts the following parameters: +

+
time_base
+

The timebase which will be used for timestamps of submitted frames. It must be +either a floating-point number or in numerator/denominator form. +

+
+
sample_rate
+

The sample rate of the incoming audio buffers. +

+
+
sample_fmt
+

The sample format of the incoming audio buffers. +Either a sample format name or its corresponding integer representation from +the enum AVSampleFormat in libavutil/samplefmt.h +

+
+
channel_layout
+

The channel layout of the incoming audio buffers. +Either a channel layout name from channel_layout_map in +libavutil/channel_layout.c or its corresponding integer representation +from the AV_CH_LAYOUT_* macros in libavutil/channel_layout.h +

+
+
channels
+

The number of channels of the incoming audio buffers. +If both channels and channel_layout are specified, then they +must be consistent. +

+
+
+ + +

30.1.1 Examples

+ +
+
abuffer=sample_rate=44100:sample_fmt=s16p:channel_layout=stereo
+
+ +

will instruct the source to accept planar 16bit signed stereo at 44100Hz. +Since the sample format with name "s16p" corresponds to the number +6 and the "stereo" channel layout corresponds to the value 0x3, this is +equivalent to: +

+
abuffer=sample_rate=44100:sample_fmt=6:channel_layout=0x3
+
+ + +

30.2 aevalsrc

+ +

Generate an audio signal specified by an expression. +

+

This source accepts in input one or more expressions (one for each +channel), which are evaluated and used to generate a corresponding +audio signal. +

+

This source accepts the following options: +

+
+
exprs
+

Set the ’|’-separated expressions list for each separate channel. In case the +channel_layout option is not specified, the selected channel layout +depends on the number of provided expressions. Otherwise the last +specified expression is applied to the remaining output channels. +

+
+
channel_layout, c
+

Set the channel layout. The number of channels in the specified layout +must be equal to the number of specified expressions. +

+
+
duration, d
+

Set the minimum duration of the sourced audio. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +Note that the resulting duration may be greater than the specified +duration, as the generated audio is always cut at the end of a +complete frame. +

+

If not specified, or the expressed duration is negative, the audio is +supposed to be generated forever. +

+
+
nb_samples, n
+

Set the number of samples per channel per each output frame, +default to 1024. +

+
+
sample_rate, s
+

Specify the sample rate, default to 44100. +

+
+ +

Each expression in exprs can contain the following constants: +

+
+
n
+

number of the evaluated sample, starting from 0 +

+
+
t
+

time of the evaluated sample expressed in seconds, starting from 0 +

+
+
s
+

sample rate +

+
+
+ + +

30.2.1 Examples

+ +
    +
  • Generate silence: +
    +
    aevalsrc=0
+
    + +
  • Generate a sin signal with frequency of 440 Hz, set sample rate to +8000 Hz: +
    +
    aevalsrc="sin(440*2*PI*t):s=8000"
+
    + +
  • Generate a two channels signal, specify the channel layout (Front +Center + Back Center) explicitly: +
    +
    aevalsrc="sin(420*2*PI*t)|cos(430*2*PI*t):c=FC|BC"
+
    + +
  • Generate white noise: +
    +
    aevalsrc="-2+random(0)"
+
    + +
  • Generate an amplitude modulated signal: +
    +
    aevalsrc="sin(10*2*PI*t)*sin(880*2*PI*t)"
+
    + +
  • Generate 2.5 Hz binaural beats on a 360 Hz carrier: +
    +
    aevalsrc="0.1*sin(2*PI*(360-2.5/2)*t) | 0.1*sin(2*PI*(360+2.5/2)*t)"
+
    + +
+ + +

30.3 afirsrc

+ +

Generate a FIR coefficients using frequency sampling method. +

+

The resulting stream can be used with afir filter for filtering the audio signal. +

+

The filter accepts the following options: +

+
+
taps, t
+

Set number of filter coefficents in output audio stream. +Default value is 1025. +

+
+
frequency, f
+

Set frequency points from where magnitude and phase are set. +This must be in non decreasing order, and first element must be 0, while last element +must be 1. Elements are separated by white spaces. +

+
+
magnitude, m
+

Set magnitude value for every frequency point set by frequency. +Number of values must be same as number of frequency points. +Values are separated by white spaces. +

+
+
phase, p
+

Set phase value for every frequency point set by frequency. +Number of values must be same as number of frequency points. +Values are separated by white spaces. +

+
+
sample_rate, r
+

Set sample rate, default is 44100. +

+
+
nb_samples, n
+

Set number of samples per each frame. Default is 1024. +

+
+
win_func, w
+

Set window function. Default is blackman. +

+
+ + +

30.4 anullsrc

+ +

The null audio source, return unprocessed audio frames. It is mainly useful +as a template and to be employed in analysis / debugging tools, or as +the source for filters which ignore the input data (for example the sox +synth filter). +

+

This source accepts the following options: +

+
+
channel_layout, cl
+
+

Specifies the channel layout, and can be either an integer or a string +representing a channel layout. The default value of channel_layout +is "stereo". +

+

Check the channel_layout_map definition in +libavutil/channel_layout.c for the mapping between strings and +channel layout values. +

+
+
sample_rate, r
+

Specifies the sample rate, and defaults to 44100. +

+
+
nb_samples, n
+

Set the number of samples per requested frames. +

+
+
+ + +

30.4.1 Examples

+ +
    +
  • Set the sample rate to 48000 Hz and the channel layout to AV_CH_LAYOUT_MONO. +
    +
    anullsrc=r=48000:cl=4
+
    + +
  • Do the same operation with a more obvious syntax: +
    +
    anullsrc=r=48000:cl=mono
+
    +
+ +

All the parameters need to be explicitly defined. +

+ +

30.5 flite

+ +

Synthesize a voice utterance using the libflite library. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libflite. +

+

Note that versions of the flite library prior to 2.0 are not thread-safe. +

+

The filter accepts the following options: +

+
+
list_voices
+

If set to 1, list the names of the available voices and exit +immediately. Default value is 0. +

+
+
nb_samples, n
+

Set the maximum number of samples per frame. Default value is 512. +

+
+
textfile
+

Set the filename containing the text to speak. +

+
+
text
+

Set the text to speak. +

+
+
voice, v
+

Set the voice to use for the speech synthesis. Default value is +kal. See also the list_voices option. +

+
+ + +

30.5.1 Examples

+ +
    +
  • Read from file speech.txt, and synthesize the text using the +standard flite voice: +
    +
    flite=textfile=speech.txt
+
    + +
  • Read the specified text selecting the slt voice: +
    +
    flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
+
    + +
  • Input text to ffmpeg: +
    +
    ffmpeg -f lavfi -i flite=text='So fare thee well, poor devil of a Sub-Sub, whose commentator I am':voice=slt
+
    + +
  • Make ffplay speak the specified text, using flite and +the lavfi device: +
    +
    ffplay -f lavfi flite=text='No more be grieved for which that thou hast done.'
+
    +
+ +

For more information about libflite, check: +http://www.festvox.org/flite/ +

+ +

30.6 anoisesrc

+ +

Generate a noise audio signal. +

+

The filter accepts the following options: +

+
+
sample_rate, r
+

Specify the sample rate. Default value is 48000 Hz. +

+
+
amplitude, a
+

Specify the amplitude (0.0 - 1.0) of the generated audio stream. Default value +is 1.0. +

+
+
duration, d
+

Specify the duration of the generated audio stream. Not specifying this option +results in noise with an infinite length. +

+
+
color, colour, c
+

Specify the color of noise. Available noise colors are white, pink, brown, +blue, violet and velvet. Default color is white. +

+
+
seed, s
+

Specify a value used to seed the PRNG. +

+
+
nb_samples, n
+

Set the number of samples per each output frame, default is 1024. +

+
+ + +

30.6.1 Examples

+ +
    +
  • Generate 60 seconds of pink noise, with a 44.1 kHz sampling rate and an amplitude of 0.5: +
    +
    anoisesrc=d=60:c=pink:r=44100:a=0.5
+
    +
+ + +

30.7 hilbert

+ +

Generate odd-tap Hilbert transform FIR coefficients. +

+

The resulting stream can be used with afir filter for phase-shifting +the signal by 90 degrees. +

+

This is used in many matrix coding schemes and for analytic signal generation. +The process is often written as a multiplication by i (or j), the imaginary unit. +

+

The filter accepts the following options: +

+
+
sample_rate, s
+

Set sample rate, default is 44100. +

+
+
taps, t
+

Set length of FIR filter, default is 22051. +

+
+
nb_samples, n
+

Set number of samples per each frame. +

+
+
win_func, w
+

Set window function to be used when generating FIR coefficients. +

+
+ + +

30.8 sinc

+ +

Generate a sinc kaiser-windowed low-pass, high-pass, band-pass, or band-reject FIR coefficients. +

+

The resulting stream can be used with afir filter for filtering the audio signal. +

+

The filter accepts the following options: +

+
+
sample_rate, r
+

Set sample rate, default is 44100. +

+
+
nb_samples, n
+

Set number of samples per each frame. Default is 1024. +

+
+
hp
+

Set high-pass frequency. Default is 0. +

+
+
lp
+

Set low-pass frequency. Default is 0. +If high-pass frequency is lower than low-pass frequency and low-pass frequency +is higher than 0 then filter will create band-pass filter coefficients, +otherwise band-reject filter coefficients. +

+
+
phase
+

Set filter phase response. Default is 50. Allowed range is from 0 to 100. +

+
+
beta
+

Set Kaiser window beta. +

+
+
att
+

Set stop-band attenuation. Default is 120dB, allowed range is from 40 to 180 dB. +

+
+
round
+

Enable rounding, by default is disabled. +

+
+
hptaps
+

Set number of taps for high-pass filter. +

+
+
lptaps
+

Set number of taps for low-pass filter. +

+
+ + +

30.9 sine

+ +

Generate an audio signal made of a sine wave with amplitude 1/8. +

+

The audio signal is bit-exact. +

+

The filter accepts the following options: +

+
+
frequency, f
+

Set the carrier frequency. Default is 440 Hz. +

+
+
beep_factor, b
+

Enable a periodic beep every second with frequency beep_factor times +the carrier frequency. Default is 0, meaning the beep is disabled. +

+
+
sample_rate, r
+

Specify the sample rate, default is 44100. +

+
+
duration, d
+

Specify the duration of the generated audio stream. +

+
+
samples_per_frame
+

Set the number of samples per output frame. +

+

The expression can contain the following constants: +

+
+
n
+

The (sequential) number of the output audio frame, starting from 0. +

+
+
pts
+

The PTS (Presentation TimeStamp) of the output audio frame, +expressed in TB units. +

+
+
t
+

The PTS of the output audio frame, expressed in seconds. +

+
+
TB
+

The timebase of the output audio frames. +

+
+ +

Default is 1024. +

+
+ + +

30.9.1 Examples

+ +
    +
  • Generate a simple 440 Hz sine wave: +
    +
    sine
+
    + +
  • Generate a 220 Hz sine wave with a 880 Hz beep each second, for 5 seconds: +
    +
    sine=220:4:d=5
+sine=f=220:b=4:d=5
+sine=frequency=220:beep_factor=4:duration=5
+
    + +
  • Generate a 1 kHz sine wave following 1602,1601,1602,1601,1602 NTSC +pattern: +
    +
    sine=1000:samples_per_frame='st(0,mod(n,5)); 1602-not(not(eq(ld(0),1)+eq(ld(0),3)))'
+
    +
+ + + +

31 Audio Sinks

+ +

Below is a description of the currently available audio sinks. +

+ +

31.1 abuffersink

+ +

Buffer audio frames, and make them available to the end of filter chain. +

+

This sink is mainly intended for programmatic use, in particular +through the interface defined in libavfilter/buffersink.h +or the options system. +

+

It accepts a pointer to an AVABufferSinkContext structure, which +defines the incoming buffers’ formats, to be passed as the opaque +parameter to avfilter_init_filter for initialization. +

+

31.2 anullsink

+ +

Null audio sink; do absolutely nothing with the input audio. It is +mainly useful as a template and for use in analysis / debugging +tools. +

+ + +

32 Video Filters

+ +

When you configure your FFmpeg build, you can disable any of the +existing filters using --disable-filters. +The configure output will show the video filters included in your +build. +

+

Below is a description of the currently available video filters. +

+ +

32.1 addroi

+ +

Mark a region of interest in a video frame. +

+

The frame data is passed through unchanged, but metadata is attached +to the frame indicating regions of interest which can affect the +behaviour of later encoding. Multiple regions can be marked by +applying the filter multiple times. +

+
+
x
+

Region distance in pixels from the left edge of the frame. +

+
y
+

Region distance in pixels from the top edge of the frame. +

+
w
+

Region width in pixels. +

+
h
+

Region height in pixels. +

+

The parameters x, y, w and h are expressions, +and may contain the following variables: +

+
iw
+

Width of the input frame. +

+
ih
+

Height of the input frame. +

+
+ +
+
qoffset
+

Quantisation offset to apply within the region. +

+

This must be a real value in the range -1 to +1. A value of zero +indicates no quality change. A negative value asks for better quality +(less quantisation), while a positive value asks for worse quality +(greater quantisation). +

+

The range is calibrated so that the extreme values indicate the +largest possible offset - if the rest of the frame is encoded with the +worst possible quality, an offset of -1 indicates that this region +should be encoded with the best possible quality anyway. Intermediate +values are then interpolated in some codec-dependent way. +

+

For example, in 10-bit H.264 the quantisation parameter varies between +-12 and 51. A typical qoffset value of -1/10 therefore indicates that +this region should be encoded with a QP around one-tenth of the full +range better than the rest of the frame. So, if most of the frame +were to be encoded with a QP of around 30, this region would get a QP +of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3). +An extreme value of -1 would indicate that this region should be +encoded with the best possible quality regardless of the treatment of +the rest of the frame - that is, should be encoded at a QP of -12. +

+
clear
+

If set to true, remove any existing regions of interest marked on the +frame before adding the new one. +

+
+ + +

32.1.1 Examples

+ +
    +
  • Mark the centre quarter of the frame as interesting. +
    +
    addroi=iw/4:ih/4:iw/2:ih/2:-1/10
+
    +
  • Mark the 100-pixel-wide region on the left edge of the frame as very +uninteresting (to be encoded at much lower quality than the rest of +the frame). +
    +
    addroi=0:0:100:ih:+1/5
+
    +
+ + +

32.2 alphaextract

+ +

Extract the alpha component from the input as a grayscale video. This +is especially useful with the alphamerge filter. +

+ +

32.3 alphamerge

+ +

Add or replace the alpha component of the primary input with the +grayscale value of a second input. This is intended for use with +alphaextract to allow the transmission or storage of frame +sequences that have alpha in a format that doesn’t support an alpha +channel. +

+

For example, to reconstruct full frames from a normal YUV-encoded video +and a separate video created with alphaextract, you might use: +

+
movie=in_alpha.mkv [alpha]; [in][alpha] alphamerge [out]
+
+ +

Since this filter is designed for reconstruction, it operates on frame +sequences without considering timestamps, and terminates when either +input reaches end of stream. This will cause problems if your encoding +pipeline drops frames. If you’re trying to apply an image as an +overlay to a video stream, consider the overlay filter instead. +

+ +

32.4 amplify

+ +

Amplify differences between current pixel and pixels of adjacent frames in +same pixel location. +

+

This filter accepts the following options: +

+
+
radius
+

Set frame radius. Default is 2. Allowed range is from 1 to 63. +For example radius of 3 will instruct filter to calculate average of 7 frames. +

+
+
factor
+

Set factor to amplify difference. Default is 2. Allowed range is from 0 to 65535. +

+
+
threshold
+

Set threshold for difference amplification. Any difference greater or equal to +this value will not alter source pixel. Default is 10. +Allowed range is from 0 to 65535. +

+
+
tolerance
+

Set tolerance for difference amplification. Any difference lower to +this value will not alter source pixel. Default is 0. +Allowed range is from 0 to 65535. +

+
+
low
+

Set lower limit for changing source pixel. Default is 65535. Allowed range is from 0 to 65535. +This option controls maximum possible value that will decrease source pixel value. +

+
+
high
+

Set high limit for changing source pixel. Default is 65535. Allowed range is from 0 to 65535. +This option controls maximum possible value that will increase source pixel value. +

+
+
planes
+

Set which planes to filter. Default is all. Allowed range is from 0 to 15. +

+
+ + +

32.4.1 Commands

+ +

This filter supports the following commands that corresponds to option of same name: +

+
factor
+
threshold
+
tolerance
+
low
+
high
+
planes
+
+ + +

32.5 ass

+ +

Same as the subtitles filter, except that it doesn’t require libavcodec +and libavformat to work. On the other hand, it is limited to ASS (Advanced +Substation Alpha) subtitles files. +

+

This filter accepts the following option in addition to the common options from +the subtitles filter: +

+
+
shaping
+

Set the shaping engine +

+

Available values are: +

+
‘auto’
+

The default libass shaping engine, which is the best available. +

+
‘simple’
+

Fast, font-agnostic shaper that can do only substitutions +

+
‘complex’
+

Slower shaper using OpenType for substitutions and positioning +

+
+ +

The default is auto. +

+
+ + +

32.6 atadenoise

+

Apply an Adaptive Temporal Averaging Denoiser to the video input. +

+

The filter accepts the following options: +

+
+
0a
+

Set threshold A for 1st plane. Default is 0.02. +Valid range is 0 to 0.3. +

+
+
0b
+

Set threshold B for 1st plane. Default is 0.04. +Valid range is 0 to 5. +

+
+
1a
+

Set threshold A for 2nd plane. Default is 0.02. +Valid range is 0 to 0.3. +

+
+
1b
+

Set threshold B for 2nd plane. Default is 0.04. +Valid range is 0 to 5. +

+
+
2a
+

Set threshold A for 3rd plane. Default is 0.02. +Valid range is 0 to 0.3. +

+
+
2b
+

Set threshold B for 3rd plane. Default is 0.04. +Valid range is 0 to 5. +

+

Threshold A is designed to react on abrupt changes in the input signal and +threshold B is designed to react on continuous changes in the input signal. +

+
+
s
+

Set number of frames filter will use for averaging. Default is 9. Must be odd +number in range [5, 129]. +

+
+
p
+

Set what planes of frame filter will use for averaging. Default is all. +

+
+
a
+

Set what variant of algorithm filter will use for averaging. Default is p parallel. +Alternatively can be set to s serial. +

+

Parallel can be faster then serial, while other way around is never true. +Parallel will abort early on first change being greater then thresholds, while serial +will continue processing other side of frames if they are equal or bellow thresholds. +

+
+ + +

32.6.1 Commands

+

This filter supports same commands as options except option s. +The command accepts the same syntax of the corresponding option. +

+ +

32.7 avgblur

+ +

Apply average blur filter. +

+

The filter accepts the following options: +

+
+
sizeX
+

Set horizontal radius size. +

+
+
planes
+

Set which planes to filter. By default all planes are filtered. +

+
+
sizeY
+

Set vertical radius size, if zero it will be same as sizeX. +Default is 0. +

+
+ + +

32.7.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.8 bbox

+ +

Compute the bounding box for the non-black pixels in the input frame +luminance plane. +

+

This filter computes the bounding box containing all the pixels with a +luminance value greater than the minimum allowed value. +The parameters describing the bounding box are printed on the filter +log. +

+

The filter accepts the following option: +

+
+
min_val
+

Set the minimal luminance value. Default is 16. +

+
+ + +

32.9 bilateral

+

Apply bilateral filter, spatial smoothing while preserving edges. +

+

The filter accepts the following options: +

+
sigmaS
+

Set sigma of gaussian function to calculate spatial weight. +Allowed range is 0 to 10. Default is 0.1. +

+
+
sigmaR
+

Set sigma of gaussian function to calculate range weight. +Allowed range is 0 to 1. Default is 0.1. +

+
+
planes
+

Set planes to filter. Default is first only. +

+
+ + +

32.10 bitplanenoise

+ +

Show and measure bit plane noise. +

+

The filter accepts the following options: +

+
+
bitplane
+

Set which plane to analyze. Default is 1. +

+
+
filter
+

Filter out noisy pixels from bitplane set above. +Default is disabled. +

+
+ + +

32.11 blackdetect

+ +

Detect video intervals that are (almost) completely black. Can be +useful to detect chapter transitions, commercials, or invalid +recordings. +

+

The filter outputs its detection analysis to both the log as well as +frame metadata. If a black segment of at least the specified minimum +duration is found, a line with the start and end timestamps as well +as duration is printed to the log with level info. In addition, +a log line with level debug is printed per frame showing the +black amount detected for that frame. +

+

The filter also attaches metadata to the first frame of a black +segment with key lavfi.black_start and to the first frame +after the black segment ends with key lavfi.black_end. The +value is the frame’s timestamp. This metadata is added regardless +of the minimum duration specified. +

+

The filter accepts the following options: +

+
+
black_min_duration, d
+

Set the minimum detected black duration expressed in seconds. It must +be a non-negative floating point number. +

+

Default value is 2.0. +

+
+
picture_black_ratio_th, pic_th
+

Set the threshold for considering a picture "black". +Express the minimum value for the ratio: +

+
nb_black_pixels / nb_pixels
+
+ +

for which a picture is considered black. +Default value is 0.98. +

+
+
pixel_black_th, pix_th
+

Set the threshold for considering a pixel "black". +

+

The threshold expresses the maximum pixel luminance value for which a +pixel is considered "black". The provided value is scaled according to +the following equation: +

+
absolute_threshold = luminance_minimum_value + pixel_black_th * luminance_range_size
+
+ +

luminance_range_size and luminance_minimum_value depend on +the input video format, the range is [0-255] for YUV full-range +formats and [16-235] for YUV non full-range formats. +

+

Default value is 0.10. +

+
+ +

The following example sets the maximum pixel threshold to the minimum +value, and detects only black intervals of 2 or more seconds: +

+
blackdetect=d=2:pix_th=0.00
+
+ + +

32.12 blackframe

+ +

Detect frames that are (almost) completely black. Can be useful to +detect chapter transitions or commercials. Output lines consist of +the frame number of the detected frame, the percentage of blackness, +the position in the file if known or -1 and the timestamp in seconds. +

+

In order to display the output lines, you need to set the loglevel at +least to the AV_LOG_INFO value. +

+

This filter exports frame metadata lavfi.blackframe.pblack. +The value represents the percentage of pixels in the picture that +are below the threshold value. +

+

It accepts the following parameters: +

+
+
amount
+

The percentage of the pixels that have to be below the threshold; it defaults to +98. +

+
+
threshold, thresh
+

The threshold below which a pixel value is considered black; it defaults to +32. +

+
+
+ + +

32.13 blend

+ +

Blend two video frames into each other. +

+

The blend filter takes two input streams and outputs one +stream, the first input is the "top" layer and second input is +"bottom" layer. By default, the output terminates when the longest input terminates. +

+

The tblend (time blend) filter takes two consecutive frames +from one single stream, and outputs the result obtained by blending +the new frame on top of the old frame. +

+

A description of the accepted options follows. +

+
+
c0_mode
+
c1_mode
+
c2_mode
+
c3_mode
+
all_mode
+

Set blend mode for specific pixel component or all pixel components in case +of all_mode. Default value is normal. +

+

Available values for component modes are: +

+
‘addition’
+
‘grainmerge’
+
‘and’
+
‘average’
+
‘burn’
+
‘darken’
+
‘difference’
+
‘grainextract’
+
‘divide’
+
‘dodge’
+
‘freeze’
+
‘exclusion’
+
‘extremity’
+
‘glow’
+
‘hardlight’
+
‘hardmix’
+
‘heat’
+
‘lighten’
+
‘linearlight’
+
‘multiply’
+
‘multiply128’
+
‘negation’
+
‘normal’
+
‘or’
+
‘overlay’
+
‘phoenix’
+
‘pinlight’
+
‘reflect’
+
‘screen’
+
‘softlight’
+
‘subtract’
+
‘vividlight’
+
‘xor’
+
+ +
+
c0_opacity
+
c1_opacity
+
c2_opacity
+
c3_opacity
+
all_opacity
+

Set blend opacity for specific pixel component or all pixel components in case +of all_opacity. Only used in combination with pixel component blend modes. +

+
+
c0_expr
+
c1_expr
+
c2_expr
+
c3_expr
+
all_expr
+

Set blend expression for specific pixel component or all pixel components in case +of all_expr. Note that related mode options will be ignored if those are set. +

+

The expressions can use the following variables: +

+
+
N
+

The sequential number of the filtered frame, starting from 0. +

+
+
X
+
Y
+

the coordinates of the current sample +

+
+
W
+
H
+

the width and height of currently filtered plane +

+
+
SW
+
SH
+

Width and height scale for the plane being filtered. It is the +ratio between the dimensions of the current plane to the luma plane, +e.g. for a yuv420p frame, the values are 1,1 for +the luma plane and 0.5,0.5 for the chroma planes. +

+
+
T
+

Time of the current frame, expressed in seconds. +

+
+
TOP, A
+

Value of pixel component at current location for first video frame (top layer). +

+
+
BOTTOM, B
+

Value of pixel component at current location for second video frame (bottom layer). +

+
+
+
+ +

The blend filter also supports the framesync options. +

+ +

32.13.1 Examples

+ +
    +
  • Apply transition from bottom layer to top layer in first 10 seconds: +
    +
    blend=all_expr='A*(if(gte(T,10),1,T/10))+B*(1-(if(gte(T,10),1,T/10)))'
+
    + +
  • Apply linear horizontal transition from top layer to bottom layer: +
    +
    blend=all_expr='A*(X/W)+B*(1-X/W)'
+
    + +
  • Apply 1x1 checkerboard effect: +
    +
    blend=all_expr='if(eq(mod(X,2),mod(Y,2)),A,B)'
+
    + +
  • Apply uncover left effect: +
    +
    blend=all_expr='if(gte(N*SW+X,W),A,B)'
+
    + +
  • Apply uncover down effect: +
    +
    blend=all_expr='if(gte(Y-N*SH,0),A,B)'
+
    + +
  • Apply uncover up-left effect: +
    +
    blend=all_expr='if(gte(T*SH*40+Y,H)*gte((T*40*SW+X)*W/H,W),A,B)'
+
    + +
  • Split diagonally video and shows top and bottom layer on each side: +
    +
    blend=all_expr='if(gt(X,Y*(W/H)),A,B)'
+
    + +
  • Display differences between the current and the previous frame: +
    +
    tblend=all_mode=grainextract
+
    +
+ + +

32.14 bm3d

+ +

Denoise frames using Block-Matching 3D algorithm. +

+

The filter accepts the following options. +

+
+
sigma
+

Set denoising strength. Default value is 1. +Allowed range is from 0 to 999.9. +The denoising algorithm is very sensitive to sigma, so adjust it +according to the source. +

+
+
block
+

Set local patch size. This sets dimensions in 2D. +

+
+
bstep
+

Set sliding step for processing blocks. Default value is 4. +Allowed range is from 1 to 64. +Smaller values allows processing more reference blocks and is slower. +

+
+
group
+

Set maximal number of similar blocks for 3rd dimension. Default value is 1. +When set to 1, no block matching is done. Larger values allows more blocks +in single group. +Allowed range is from 1 to 256. +

+
+
range
+

Set radius for search block matching. Default is 9. +Allowed range is from 1 to INT32_MAX. +

+
+
mstep
+

Set step between two search locations for block matching. Default is 1. +Allowed range is from 1 to 64. Smaller is slower. +

+
+
thmse
+

Set threshold of mean square error for block matching. Valid range is 0 to +INT32_MAX. +

+
+
hdthr
+

Set thresholding parameter for hard thresholding in 3D transformed domain. +Larger values results in stronger hard-thresholding filtering in frequency +domain. +

+
+
estim
+

Set filtering estimation mode. Can be basic or final. +Default is basic. +

+
+
ref
+

If enabled, filter will use 2nd stream for block matching. +Default is disabled for basic value of estim option, +and always enabled if value of estim is final. +

+
+
planes
+

Set planes to filter. Default is all available except alpha. +

+
+ + +

32.14.1 Examples

+ +
    +
  • Basic filtering with bm3d: +
    +
    bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic
+
    + +
  • Same as above, but filtering only luma: +
    +
    bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic:planes=1
+
    + +
  • Same as above, but with both estimation modes: +
    +
    split[a][b],[a]bm3d=sigma=3:block=4:bstep=2:group=1:estim=basic[a],[b][a]bm3d=sigma=3:block=4:bstep=2:group=16:estim=final:ref=1
+
    + +
  • Same as above, but prefilter with nlmeans filter instead: +
    +
    split[a][b],[a]nlmeans=s=3:r=7:p=3[a],[b][a]bm3d=sigma=3:block=4:bstep=2:group=16:estim=final:ref=1
+
    +
+ + +

32.15 boxblur

+ +

Apply a boxblur algorithm to the input video. +

+

It accepts the following parameters: +

+
+
luma_radius, lr
+
luma_power, lp
+
chroma_radius, cr
+
chroma_power, cp
+
alpha_radius, ar
+
alpha_power, ap
+
+ +

A description of the accepted options follows. +

+
+
luma_radius, lr
+
chroma_radius, cr
+
alpha_radius, ar
+

Set an expression for the box radius in pixels used for blurring the +corresponding input plane. +

+

The radius value must be a non-negative number, and must not be +greater than the value of the expression min(w,h)/2 for the +luma and alpha planes, and of min(cw,ch)/2 for the chroma +planes. +

+

Default value for luma_radius is "2". If not specified, +chroma_radius and alpha_radius default to the +corresponding value set for luma_radius. +

+

The expressions can contain the following constants: +

+
w
+
h
+

The input width and height in pixels. +

+
+
cw
+
ch
+

The input chroma image width and height in pixels. +

+
+
hsub
+
vsub
+

The horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p", hsub is 2 and vsub is 1. +

+
+ +
+
luma_power, lp
+
chroma_power, cp
+
alpha_power, ap
+

Specify how many times the boxblur filter is applied to the +corresponding plane. +

+

Default value for luma_power is 2. If not specified, +chroma_power and alpha_power default to the +corresponding value set for luma_power. +

+

A value of 0 will disable the effect. +

+
+ + +

32.15.1 Examples

+ +
    +
  • Apply a boxblur filter with the luma, chroma, and alpha radii +set to 2: +
    +
    boxblur=luma_radius=2:luma_power=1
+boxblur=2:1
+
    + +
  • Set the luma radius to 2, and alpha and chroma radius to 0: +
    +
    boxblur=2:1:cr=0:ar=0
+
    + +
  • Set the luma and chroma radii to a fraction of the video dimension: +
    +
    boxblur=luma_radius=min(h\,w)/10:luma_power=1:chroma_radius=min(cw\,ch)/10:chroma_power=1
+
    +
+ + +

32.16 bwdif

+ +

Deinterlace the input video ("bwdif" stands for "Bob Weaver +Deinterlacing Filter"). +

+

Motion adaptive deinterlacing based on yadif with the use of w3fdif and cubic +interpolation algorithms. +It accepts the following parameters: +

+
+
mode
+

The interlacing mode to adopt. It accepts one of the following values: +

+
+
0, send_frame
+

Output one frame for each frame. +

+
1, send_field
+

Output one frame for each field. +

+
+ +

The default value is send_field. +

+
+
parity
+

The picture field parity assumed for the input interlaced video. It accepts one +of the following values: +

+
+
0, tff
+

Assume the top field is first. +

+
1, bff
+

Assume the bottom field is first. +

+
-1, auto
+

Enable automatic detection of field parity. +

+
+ +

The default value is auto. +If the interlacing is unknown or the decoder does not export this information, +top field first will be assumed. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following +values: +

+
+
0, all
+

Deinterlace all frames. +

+
1, interlaced
+

Only deinterlace frames marked as interlaced. +

+
+ +

The default value is all. +

+
+ + +

32.17 cas

+ +

Apply Contrast Adaptive Sharpen filter to video stream. +

+

The filter accepts the following options: +

+
+
strength
+

Set the sharpening strength. Default value is 0. +

+
+
planes
+

Set planes to filter. Default value is to filter all +planes except alpha plane. +

+
+ + +

32.18 chromahold

+

Remove all color information for all colors except for certain one. +

+

The filter accepts the following options: +

+
+
color
+

The color which will not be replaced with neutral chroma. +

+
+
similarity
+

Similarity percentage with the above color. +0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +0.0 makes pixels either fully gray, or not gray at all. +Higher values result in more preserved color. +

+
+
yuv
+

Signals that the color passed is already in YUV instead of RGB. +

+

Literal colors like "green" or "red" don’t make sense with this enabled anymore. +This can be used to pass exact YUV values as hexadecimal numbers. +

+
+ + +

32.18.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.19 chromakey

+

YUV colorspace color/chroma keying. +

+

The filter accepts the following options: +

+
+
color
+

The color which will be replaced with transparency. +

+
+
similarity
+

Similarity percentage with the key color. +

+

0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +

+

0.0 makes pixels either fully transparent, or not transparent at all. +

+

Higher values result in semi-transparent pixels, with a higher transparency +the more similar the pixels color is to the key color. +

+
+
yuv
+

Signals that the color passed is already in YUV instead of RGB. +

+

Literal colors like "green" or "red" don’t make sense with this enabled anymore. +This can be used to pass exact YUV values as hexadecimal numbers. +

+
+ + +

32.19.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.19.2 Examples

+ +
    +
  • Make every green pixel in the input image transparent: +
    +
    ffmpeg -i input.png -vf chromakey=green out.png
+
    + +
  • Overlay a greenscreen-video on top of a static black background. +
    +
    ffmpeg -f lavfi -i color=c=black:s=1280x720 -i video.mp4 -shortest -filter_complex "[1:v]chromakey=0x70de77:0.1:0.2[ckout];[0:v][ckout]overlay[out]" -map "[out]" output.mkv
+
    +
+ + +

32.20 chromashift

+

Shift chroma pixels horizontally and/or vertically. +

+

The filter accepts the following options: +

+
cbh
+

Set amount to shift chroma-blue horizontally. +

+
cbv
+

Set amount to shift chroma-blue vertically. +

+
crh
+

Set amount to shift chroma-red horizontally. +

+
crv
+

Set amount to shift chroma-red vertically. +

+
edge
+

Set edge mode, can be smear, default, or warp. +

+
+ + +

32.20.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

32.21 ciescope

+ +

Display CIE color diagram with pixels overlaid onto it. +

+

The filter accepts the following options: +

+
+
system
+

Set color system. +

+
+
‘ntsc, 470m’
+
‘ebu, 470bg’
+
‘smpte’
+
‘240m’
+
‘apple’
+
‘widergb’
+
‘cie1931’
+
‘rec709, hdtv’
+
‘uhdtv, rec2020’
+
‘dcip3’
+
+ +
+
cie
+

Set CIE system. +

+
+
‘xyy’
+
‘ucs’
+
‘luv’
+
+ +
+
gamuts
+

Set what gamuts to draw. +

+

See system option for available values. +

+
+
size, s
+

Set ciescope size, by default set to 512. +

+
+
intensity, i
+

Set intensity used to map input pixel values to CIE diagram. +

+
+
contrast
+

Set contrast used to draw tongue colors that are out of active color system gamut. +

+
+
corrgamma
+

Correct gamma displayed on scope, by default enabled. +

+
+
showwhite
+

Show white point on CIE diagram, by default disabled. +

+
+
gamma
+

Set input gamma. Used only with XYZ input color space. +

+
+ + +

32.22 codecview

+ +

Visualize information exported by some codecs. +

+

Some codecs can export information through frames using side-data or other +means. For example, some MPEG based codecs export motion vectors through the +export_mvs flag in the codec flags2 option. +

+

The filter accepts the following option: +

+
+
mv
+

Set motion vectors to visualize. +

+

Available flags for mv are: +

+
+
‘pf’
+

forward predicted MVs of P-frames +

+
‘bf’
+

forward predicted MVs of B-frames +

+
‘bb’
+

backward predicted MVs of B-frames +

+
+ +
+
qp
+

Display quantization parameters using the chroma planes. +

+
+
mv_type, mvt
+

Set motion vectors type to visualize. Includes MVs from all frames unless specified by frame_type option. +

+

Available flags for mv_type are: +

+
+
‘fp’
+

forward predicted MVs +

+
‘bp’
+

backward predicted MVs +

+
+ +
+
frame_type, ft
+

Set frame type to visualize motion vectors of. +

+

Available flags for frame_type are: +

+
+
‘if’
+

intra-coded frames (I-frames) +

+
‘pf’
+

predicted frames (P-frames) +

+
‘bf’
+

bi-directionally predicted frames (B-frames) +

+
+
+
+ + +

32.22.1 Examples

+ +
    +
  • Visualize forward predicted MVs of all frames using ffplay: +
    +
    ffplay -flags2 +export_mvs input.mp4 -vf codecview=mv_type=fp
+
    + +
  • Visualize multi-directionals MVs of P and B-Frames using ffplay: +
    +
    ffplay -flags2 +export_mvs input.mp4 -vf codecview=mv=pf+bf+bb
+
    +
+ + +

32.23 colorbalance

+

Modify intensity of primary colors (red, green and blue) of input frames. +

+

The filter allows an input frame to be adjusted in the shadows, midtones or highlights +regions for the red-cyan, green-magenta or blue-yellow balance. +

+

A positive adjustment value shifts the balance towards the primary color, a negative +value towards the complementary color. +

+

The filter accepts the following options: +

+
+
rs
+
gs
+
bs
+

Adjust red, green and blue shadows (darkest pixels). +

+
+
rm
+
gm
+
bm
+

Adjust red, green and blue midtones (medium pixels). +

+
+
rh
+
gh
+
bh
+

Adjust red, green and blue highlights (brightest pixels). +

+

Allowed ranges for options are [-1.0, 1.0]. Defaults are 0. +

+
+
pl
+

Preserve lightness when changing color balance. Default is disabled. +

+
+ + +

32.23.1 Examples

+ +
    +
  • Add red color cast to shadows: +
    +
    colorbalance=rs=.3
+
    +
+ + +

32.23.2 Commands

+ +

This filter supports the all above options as commands. +

+ +

32.24 colorchannelmixer

+ +

Adjust video input frames by re-mixing color channels. +

+

This filter modifies a color channel by adding the values associated to +the other channels of the same pixels. For example if the value to +modify is red, the output value will be: +

+
red=red*rr + blue*rb + green*rg + alpha*ra
+
+ +

The filter accepts the following options: +

+
+
rr
+
rg
+
rb
+
ra
+

Adjust contribution of input red, green, blue and alpha channels for output red channel. +Default is 1 for rr, and 0 for rg, rb and ra. +

+
+
gr
+
gg
+
gb
+
ga
+

Adjust contribution of input red, green, blue and alpha channels for output green channel. +Default is 1 for gg, and 0 for gr, gb and ga. +

+
+
br
+
bg
+
bb
+
ba
+

Adjust contribution of input red, green, blue and alpha channels for output blue channel. +Default is 1 for bb, and 0 for br, bg and ba. +

+
+
ar
+
ag
+
ab
+
aa
+

Adjust contribution of input red, green, blue and alpha channels for output alpha channel. +Default is 1 for aa, and 0 for ar, ag and ab. +

+

Allowed ranges for options are [-2.0, 2.0]. +

+
+ + +

32.24.1 Examples

+ +
    +
  • Convert source to grayscale: +
    +
    colorchannelmixer=.3:.4:.3:0:.3:.4:.3:0:.3:.4:.3
+
    +
  • Simulate sepia tones: +
    +
    colorchannelmixer=.393:.769:.189:0:.349:.686:.168:0:.272:.534:.131
+
    +
+ + +

32.24.2 Commands

+ +

This filter supports the all above options as commands. +

+ +

32.25 colorkey

+

RGB colorspace color keying. +

+

The filter accepts the following options: +

+
+
color
+

The color which will be replaced with transparency. +

+
+
similarity
+

Similarity percentage with the key color. +

+

0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +

+

0.0 makes pixels either fully transparent, or not transparent at all. +

+

Higher values result in semi-transparent pixels, with a higher transparency +the more similar the pixels color is to the key color. +

+
+ + +

32.25.1 Examples

+ +
    +
  • Make every green pixel in the input image transparent: +
    +
    ffmpeg -i input.png -vf colorkey=green out.png
+
    + +
  • Overlay a greenscreen-video on top of a static background image. +
    +
    ffmpeg -i background.png -i video.mp4 -filter_complex "[1:v]colorkey=0x3BBD1E:0.3:0.2[ckout];[0:v][ckout]overlay[out]" -map "[out]" output.flv
+
    +
+ + +

32.25.2 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.26 colorhold

+

Remove all color information for all RGB colors except for certain one. +

+

The filter accepts the following options: +

+
+
color
+

The color which will not be replaced with neutral gray. +

+
+
similarity
+

Similarity percentage with the above color. +0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. 0.0 makes pixels fully gray. +Higher values result in more preserved color. +

+
+ + +

32.26.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.27 colorlevels

+ +

Adjust video input frames using levels. +

+

The filter accepts the following options: +

+
+
rimin
+
gimin
+
bimin
+
aimin
+

Adjust red, green, blue and alpha input black point. +Allowed ranges for options are [-1.0, 1.0]. Defaults are 0. +

+
+
rimax
+
gimax
+
bimax
+
aimax
+

Adjust red, green, blue and alpha input white point. +Allowed ranges for options are [-1.0, 1.0]. Defaults are 1. +

+

Input levels are used to lighten highlights (bright tones), darken shadows +(dark tones), change the balance of bright and dark tones. +

+
+
romin
+
gomin
+
bomin
+
aomin
+

Adjust red, green, blue and alpha output black point. +Allowed ranges for options are [0, 1.0]. Defaults are 0. +

+
+
romax
+
gomax
+
bomax
+
aomax
+

Adjust red, green, blue and alpha output white point. +Allowed ranges for options are [0, 1.0]. Defaults are 1. +

+

Output levels allows manual selection of a constrained output level range. +

+
+ + +

32.27.1 Examples

+ +
    +
  • Make video output darker: +
    +
    colorlevels=rimin=0.058:gimin=0.058:bimin=0.058
+
    + +
  • Increase contrast: +
    +
    colorlevels=rimin=0.039:gimin=0.039:bimin=0.039:rimax=0.96:gimax=0.96:bimax=0.96
+
    + +
  • Make video output lighter: +
    +
    colorlevels=rimax=0.902:gimax=0.902:bimax=0.902
+
    + +
  • Increase brightness: +
    +
    colorlevels=romin=0.5:gomin=0.5:bomin=0.5
+
    +
+ + +

32.27.2 Commands

+ +

This filter supports the all above options as commands. +

+ +

32.28 colormatrix

+ +

Convert color matrix. +

+

The filter accepts the following options: +

+
+
src
+
dst
+

Specify the source and destination color matrix. Both values must be +specified. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘fcc’
+

FCC +

+
+
‘bt601’
+

BT.601 +

+
+
‘bt470’
+

BT.470 +

+
+
‘bt470bg’
+

BT.470BG +

+
+
‘smpte170m’
+

SMPTE-170M +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘bt2020’
+

BT.2020 +

+
+
+
+ +

For example to convert from BT.601 to SMPTE-240M, use the command: +

+
colormatrix=bt601:smpte240m
+
+ + +

32.29 colorspace

+ +

Convert colorspace, transfer characteristics or color primaries. +Input video needs to have an even size. +

+

The filter accepts the following options: +

+
+
+
all
+

Specify all color properties at once. +

+

The accepted values are: +

+
‘bt470m’
+

BT.470M +

+
+
‘bt470bg’
+

BT.470BG +

+
+
‘bt601-6-525’
+

BT.601-6 525 +

+
+
‘bt601-6-625’
+

BT.601-6 625 +

+
+
‘bt709’
+

BT.709 +

+
+
‘smpte170m’
+

SMPTE-170M +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘bt2020’
+

BT.2020 +

+
+
+ +
+
space
+

Specify output colorspace. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘fcc’
+

FCC +

+
+
‘bt470bg’
+

BT.470BG or BT.601-6 625 +

+
+
‘smpte170m’
+

SMPTE-170M or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘ycgco’
+

YCgCo +

+
+
‘bt2020ncl’
+

BT.2020 with non-constant luminance +

+
+
+ +
+
trc
+

Specify output transfer characteristics. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘bt470m’
+

BT.470M +

+
+
‘bt470bg’
+

BT.470BG +

+
+
‘gamma22’
+

Constant gamma of 2.2 +

+
+
‘gamma28’
+

Constant gamma of 2.8 +

+
+
‘smpte170m’
+

SMPTE-170M, BT.601-6 625 or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘srgb’
+

SRGB +

+
+
‘iec61966-2-1’
+

iec61966-2-1 +

+
+
‘iec61966-2-4’
+

iec61966-2-4 +

+
+
‘xvycc’
+

xvycc +

+
+
‘bt2020-10’
+

BT.2020 for 10-bits content +

+
+
‘bt2020-12’
+

BT.2020 for 12-bits content +

+
+
+ +
+
primaries
+

Specify output color primaries. +

+

The accepted values are: +

+
‘bt709’
+

BT.709 +

+
+
‘bt470m’
+

BT.470M +

+
+
‘bt470bg’
+

BT.470BG or BT.601-6 625 +

+
+
‘smpte170m’
+

SMPTE-170M or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘film’
+

film +

+
+
‘smpte431’
+

SMPTE-431 +

+
+
‘smpte432’
+

SMPTE-432 +

+
+
‘bt2020’
+

BT.2020 +

+
+
‘jedec-p22’
+

JEDEC P22 phosphors +

+
+
+ +
+
range
+

Specify output color range. +

+

The accepted values are: +

+
‘tv’
+

TV (restricted) range +

+
+
‘mpeg’
+

MPEG (restricted) range +

+
+
‘pc’
+

PC (full) range +

+
+
‘jpeg’
+

JPEG (full) range +

+
+
+ +
+
format
+

Specify output color format. +

+

The accepted values are: +

+
‘yuv420p’
+

YUV 4:2:0 planar 8-bits +

+
+
‘yuv420p10’
+

YUV 4:2:0 planar 10-bits +

+
+
‘yuv420p12’
+

YUV 4:2:0 planar 12-bits +

+
+
‘yuv422p’
+

YUV 4:2:2 planar 8-bits +

+
+
‘yuv422p10’
+

YUV 4:2:2 planar 10-bits +

+
+
‘yuv422p12’
+

YUV 4:2:2 planar 12-bits +

+
+
‘yuv444p’
+

YUV 4:4:4 planar 8-bits +

+
+
‘yuv444p10’
+

YUV 4:4:4 planar 10-bits +

+
+
‘yuv444p12’
+

YUV 4:4:4 planar 12-bits +

+
+
+ +
+
fast
+

Do a fast conversion, which skips gamma/primary correction. This will take +significantly less CPU, but will be mathematically incorrect. To get output +compatible with that produced by the colormatrix filter, use fast=1. +

+
+
dither
+

Specify dithering mode. +

+

The accepted values are: +

+
‘none’
+

No dithering +

+
+
‘fsb’
+

Floyd-Steinberg dithering +

+
+ +
+
wpadapt
+

Whitepoint adaptation mode. +

+

The accepted values are: +

+
‘bradford’
+

Bradford whitepoint adaptation +

+
+
‘vonkries’
+

von Kries whitepoint adaptation +

+
+
‘identity’
+

identity whitepoint adaptation (i.e. no whitepoint adaptation) +

+
+ +
+
iall
+

Override all input properties at once. Same accepted values as all. +

+
+
ispace
+

Override input colorspace. Same accepted values as space. +

+
+
iprimaries
+

Override input color primaries. Same accepted values as primaries. +

+
+
itrc
+

Override input transfer characteristics. Same accepted values as trc. +

+
+
irange
+

Override input color range. Same accepted values as range. +

+
+
+ +

The filter converts the transfer characteristics, color space and color +primaries to the specified user values. The output value, if not specified, +is set to a default value based on the "all" property. If that property is +also not specified, the filter will log an error. The output color range and +format default to the same value as the input color range and format. The +input transfer characteristics, color space, color primaries and color range +should be set on the input data. If any of these are missing, the filter will +log an error and no conversion will take place. +

+

For example to convert the input to SMPTE-240M, use the command: +

+
colorspace=smpte240m
+
+ + +

32.30 convolution

+ +

Apply convolution of 3x3, 5x5, 7x7 or horizontal/vertical up to 49 elements. +

+

The filter accepts the following options: +

+
+
0m
+
1m
+
2m
+
3m
+

Set matrix for each plane. +Matrix is sequence of 9, 25 or 49 signed integers in square mode, +and from 1 to 49 odd number of signed integers in row mode. +

+
+
0rdiv
+
1rdiv
+
2rdiv
+
3rdiv
+

Set multiplier for calculated value for each plane. +If unset or 0, it will be sum of all matrix elements. +

+
+
0bias
+
1bias
+
2bias
+
3bias
+

Set bias for each plane. This value is added to the result of the multiplication. +Useful for making the overall image brighter or darker. Default is 0.0. +

+
+
0mode
+
1mode
+
2mode
+
3mode
+

Set matrix mode for each plane. Can be square, row or column. +Default is square. +

+
+ + +

32.30.1 Examples

+ +
    +
  • Apply sharpen: +
    +
    convolution="0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0"
+
    + +
  • Apply blur: +
    +
    convolution="1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1/9:1/9:1/9:1/9"
+
    + +
  • Apply edge enhance: +
    +
    convolution="0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:5:1:1:1:0:128:128:128"
+
    + +
  • Apply edge detect: +
    +
    convolution="0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:5:5:5:1:0:128:128:128"
+
    + +
  • Apply laplacian edge detector which includes diagonals: +
    +
    convolution="1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:5:5:5:1:0:128:128:0"
+
    + +
  • Apply emboss: +
    +
    convolution="-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2"
+
    +
+ + +

32.31 convolve

+ +

Apply 2D convolution of video stream in frequency domain using second stream +as impulse. +

+

The filter accepts the following options: +

+
+
planes
+

Set which planes to process. +

+
+
impulse
+

Set which impulse video frames will be processed, can be first +or all. Default is all. +

+
+ +

The convolve filter also supports the framesync options. +

+ +

32.32 copy

+ +

Copy the input video source unchanged to the output. This is mainly useful for +testing purposes. +

+ +

32.33 coreimage

+

Video filtering on GPU using Apple’s CoreImage API on OSX. +

+

Hardware acceleration is based on an OpenGL context. Usually, this means it is +processed by video hardware. However, software-based OpenGL implementations +exist which means there is no guarantee for hardware processing. It depends on +the respective OSX. +

+

There are many filters and image generators provided by Apple that come with a +large variety of options. The filter has to be referenced by its name along +with its options. +

+

The coreimage filter accepts the following options: +

+
list_filters
+

List all available filters and generators along with all their respective +options as well as possible minimum and maximum values along with the default +values. +

+
list_filters=true
+
+ +
+
filter
+

Specify all filters by their respective name and options. +Use list_filters to determine all valid filter names and options. +Numerical options are specified by a float value and are automatically clamped +to their respective value range. Vector and color options have to be specified +by a list of space separated float values. Character escaping has to be done. +A special option name default is available to use default options for a +filter. +

+

It is required to specify either default or at least one of the filter options. +All omitted options are used with their default values. +The syntax of the filter string is as follows: +

+
filter=<NAME>@<OPTION>=<VALUE>[@<OPTION>=<VALUE>][@...][#<NAME>@<OPTION>=<VALUE>[@<OPTION>=<VALUE>][@...]][#...]
+
+ +
+
output_rect
+

Specify a rectangle where the output of the filter chain is copied into the +input image. It is given by a list of space separated float values: +

+
output_rect=x\ y\ width\ height
+
+

If not given, the output rectangle equals the dimensions of the input image. +The output rectangle is automatically cropped at the borders of the input +image. Negative values are valid for each component. +

+
output_rect=25\ 25\ 100\ 100
+
+
+
+ +

Several filters can be chained for successive processing without GPU-HOST +transfers allowing for fast processing of complex filter chains. +Currently, only filters with zero (generators) or exactly one (filters) input +image and one output image are supported. Also, transition filters are not yet +usable as intended. +

+

Some filters generate output images with additional padding depending on the +respective filter kernel. The padding is automatically removed to ensure the +filter output has the same size as the input image. +

+

For image generators, the size of the output image is determined by the +previous output image of the filter chain or the input image of the whole +filterchain, respectively. The generators do not use the pixel information of +this image to generate their output. However, the generated output is +blended onto this image, resulting in partial or complete coverage of the +output image. +

+

The coreimagesrc video source can be used for generating input images +which are directly fed into the filter chain. By using it, providing input +images by another video source or an input video is not required. +

+ +

32.33.1 Examples

+ +
    +
  • List all filters available: +
    +
    coreimage=list_filters=true
+
    + +
  • Use the CIBoxBlur filter with default options to blur an image: +
    +
    coreimage=filter=CIBoxBlur@default
+
    + +
  • Use a filter chain with CISepiaTone at default values and CIVignetteEffect with +its center at 100x100 and a radius of 50 pixels: +
    +
    coreimage=filter=CIBoxBlur@default#CIVignetteEffect@inputCenter=100\ 100@inputRadius=50
+
    + +
  • Use nullsrc and CIQRCodeGenerator to create a QR code for the FFmpeg homepage, +given as complete and escaped command-line for Apple’s standard bash shell: +
    +
    ffmpeg -f lavfi -i nullsrc=s=100x100,coreimage=filter=CIQRCodeGenerator@inputMessage=https\\\\\://FFmpeg.org/@inputCorrectionLevel=H -frames:v 1 QRCode.png
+
    +
+ + +

32.34 cover_rect

+ +

Cover a rectangular object +

+

It accepts the following options: +

+
+
cover
+

Filepath of the optional cover image, needs to be in yuv420. +

+
+
mode
+

Set covering mode. +

+

It accepts the following values: +

+
‘cover’
+

cover it by the supplied image +

+
‘blur’
+

cover it by interpolating the surrounding pixels +

+
+ +

Default value is blur. +

+
+ + +

32.34.1 Examples

+ +
    +
  • Cover a rectangular object by the supplied image of a given video using ffmpeg: +
    +
    ffmpeg -i file.ts -vf find_rect=newref.pgm,cover_rect=cover.jpg:mode=cover new.mkv
+
    +
+ + +

32.35 crop

+ +

Crop the input video to given dimensions. +

+

It accepts the following parameters: +

+
+
w, out_w
+

The width of the output video. It defaults to iw. +This expression is evaluated only once during the filter +configuration, or when the ‘w’ or ‘out_w’ command is sent. +

+
+
h, out_h
+

The height of the output video. It defaults to ih. +This expression is evaluated only once during the filter +configuration, or when the ‘h’ or ‘out_h’ command is sent. +

+
+
x
+

The horizontal position, in the input video, of the left edge of the output +video. It defaults to (in_w-out_w)/2. +This expression is evaluated per-frame. +

+
+
y
+

The vertical position, in the input video, of the top edge of the output video. +It defaults to (in_h-out_h)/2. +This expression is evaluated per-frame. +

+
+
keep_aspect
+

If set to 1 will force the output display aspect ratio +to be the same of the input, by changing the output sample aspect +ratio. It defaults to 0. +

+
+
exact
+

Enable exact cropping. If enabled, subsampled videos will be cropped at exact +width/height/x/y as specified and will not be rounded to nearest smaller value. +It defaults to 0. +

+
+ +

The out_w, out_h, x, y parameters are +expressions containing the following constants: +

+
+
x
+
y
+

The computed values for x and y. They are evaluated for +each new frame. +

+
+
in_w
+
in_h
+

The input width and height. +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output (cropped) width and height. +

+
+
ow
+
oh
+

These are the same as out_w and out_h. +

+
+
a
+

same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (iw / ih) * sar +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
n
+

The number of the input frame, starting from 0. +

+
+
pos
+

the position in the file of the input frame, NAN if unknown +

+
+
t
+

The timestamp expressed in seconds. It’s NAN if the input timestamp is unknown. +

+
+
+ +

The expression for out_w may depend on the value of out_h, +and the expression for out_h may depend on out_w, but they +cannot depend on x and y, as x and y are +evaluated after out_w and out_h. +

+

The x and y parameters specify the expressions for the +position of the top-left corner of the output (non-cropped) area. They +are evaluated for each frame. If the evaluated value is not valid, it +is approximated to the nearest valid value. +

+

The expression for x may depend on y, and the expression +for y may depend on x. +

+ +

32.35.1 Examples

+ +
    +
  • Crop area with size 100x100 at position (12,34). +
    +
    crop=100:100:12:34
+
    + +

    Using named options, the example above becomes: +

    +
    crop=w=100:h=100:x=12:y=34
+
    + +
  • Crop the central input area with size 100x100: +
    +
    crop=100:100
+
    + +
  • Crop the central input area with size 2/3 of the input video: +
    +
    crop=2/3*in_w:2/3*in_h
+
    + +
  • Crop the input video central square: +
    +
    crop=out_w=in_h
+crop=in_h
+
    + +
  • Delimit the rectangle with the top-left corner placed at position +100:100 and the right-bottom corner corresponding to the right-bottom +corner of the input image. +
    +
    crop=in_w-100:in_h-100:100:100
+
    + +
  • Crop 10 pixels from the left and right borders, and 20 pixels from +the top and bottom borders +
    +
    crop=in_w-2*10:in_h-2*20
+
    + +
  • Keep only the bottom right quarter of the input image: +
    +
    crop=in_w/2:in_h/2:in_w/2:in_h/2
+
    + +
  • Crop height for getting Greek harmony: +
    +
    crop=in_w:1/PHI*in_w
+
    + +
  • Apply trembling effect: +
    +
    crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(n/10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(n/7)
+
    + +
  • Apply erratic camera effect depending on timestamp: +
    +
    crop=in_w/2:in_h/2:(in_w-out_w)/2+((in_w-out_w)/2)*sin(t*10):(in_h-out_h)/2 +((in_h-out_h)/2)*sin(t*13)"
+
    + +
  • Set x depending on the value of y: +
    +
    crop=in_w/2:in_h/2:y:10+10*sin(n/10)
+
    +
+ + +

32.35.2 Commands

+ +

This filter supports the following commands: +

+
w, out_w
+
h, out_h
+
x
+
y
+

Set width/height of the output video and the horizontal/vertical position +in the input video. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

32.36 cropdetect

+ +

Auto-detect the crop size. +

+

It calculates the necessary cropping parameters and prints the +recommended parameters via the logging system. The detected dimensions +correspond to the non-black area of the input video. +

+

It accepts the following parameters: +

+
+
limit
+

Set higher black value threshold, which can be optionally specified +from nothing (0) to everything (255 for 8-bit based formats). An intensity +value greater to the set value is considered non-black. It defaults to 24. +You can also specify a value between 0.0 and 1.0 which will be scaled depending +on the bitdepth of the pixel format. +

+
+
round
+

The value which the width/height should be divisible by. It defaults to +16. The offset is automatically adjusted to center the video. Use 2 to +get only even dimensions (needed for 4:2:2 video). 16 is best when +encoding to most video codecs. +

+
+
reset_count, reset
+

Set the counter that determines after how many frames cropdetect will +reset the previously detected largest video area and start over to +detect the current optimal crop area. Default value is 0. +

+

This can be useful when channel logos distort the video area. 0 +indicates ’never reset’, and returns the largest area encountered during +playback. +

+
+ + +

32.37 cue

+ +

Delay video filtering until a given wallclock timestamp. The filter first +passes on preroll amount of frames, then it buffers at most +buffer amount of frames and waits for the cue. After reaching the cue +it forwards the buffered frames and also any subsequent frames coming in its +input. +

+

The filter can be used synchronize the output of multiple ffmpeg processes for +realtime output devices like decklink. By putting the delay in the filtering +chain and pre-buffering frames the process can pass on data to output almost +immediately after the target wallclock timestamp is reached. +

+

Perfect frame accuracy cannot be guaranteed, but the result is good enough for +some use cases. +

+
+
cue
+

The cue timestamp expressed in a UNIX timestamp in microseconds. Default is 0. +

+
+
preroll
+

The duration of content to pass on as preroll expressed in seconds. Default is 0. +

+
+
buffer
+

The maximum duration of content to buffer before waiting for the cue expressed +in seconds. Default is 0. +

+
+
+ + +

32.38 curves

+ +

Apply color adjustments using curves. +

+

This filter is similar to the Adobe Photoshop and GIMP curves tools. Each +component (red, green and blue) has its values defined by N key points +tied from each other using a smooth curve. The x-axis represents the pixel +values from the input frame, and the y-axis the new pixel values to be set for +the output frame. +

+

By default, a component curve is defined by the two points (0;0) and +(1;1). This creates a straight line where each original pixel value is +"adjusted" to its own value, which means no change to the image. +

+

The filter allows you to redefine these two points and add some more. A new +curve (using a natural cubic spline interpolation) will be define to pass +smoothly through all these new coordinates. The new defined points needs to be +strictly increasing over the x-axis, and their x and y values must +be in the [0;1] interval. If the computed curves happened to go outside +the vector spaces, the values will be clipped accordingly. +

+

The filter accepts the following options: +

+
+
preset
+

Select one of the available color presets. This option can be used in addition +to the r, g, b parameters; in this case, the later +options takes priority on the preset values. +Available presets are: +

+
‘none’
+
‘color_negative’
+
‘cross_process’
+
‘darker’
+
‘increase_contrast’
+
‘lighter’
+
‘linear_contrast’
+
‘medium_contrast’
+
‘negative’
+
‘strong_contrast’
+
‘vintage’
+
+

Default is none. +

+
master, m
+

Set the master key points. These points will define a second pass mapping. It +is sometimes called a "luminance" or "value" mapping. It can be used with +r, g, b or all since it acts like a +post-processing LUT. +

+
red, r
+

Set the key points for the red component. +

+
green, g
+

Set the key points for the green component. +

+
blue, b
+

Set the key points for the blue component. +

+
all
+

Set the key points for all components (not including master). +Can be used in addition to the other key points component +options. In this case, the unset component(s) will fallback on this +all setting. +

+
psfile
+

Specify a Photoshop curves file (.acv) to import the settings from. +

+
plot
+

Save Gnuplot script of the curves in specified file. +

+
+ +

To avoid some filtergraph syntax conflicts, each key points list need to be +defined using the following syntax: x0/y0 x1/y1 x2/y2 .... +

+ +

32.38.1 Examples

+ +
    +
  • Increase slightly the middle level of blue: +
    +
    curves=blue='0/0 0.5/0.58 1/1'
+
    + +
  • Vintage effect: +
    +
    curves=r='0/0.11 .42/.51 1/0.95':g='0/0 0.50/0.48 1/1':b='0/0.22 .49/.44 1/0.8'
+
    +

    Here we obtain the following coordinates for each components: +

    +
    red
    +

    (0;0.11) (0.42;0.51) (1;0.95) +

    +
    green
    +

    (0;0) (0.50;0.48) (1;1) +

    +
    blue
    +

    (0;0.22) (0.49;0.44) (1;0.80) +

    +
    + +
  • The previous example can also be achieved with the associated built-in preset: +
    +
    curves=preset=vintage
+
    + +
  • Or simply: +
    +
    curves=vintage
+
    + +
  • Use a Photoshop preset and redefine the points of the green component: +
    +
    curves=psfile='MyCurvesPresets/purple.acv':green='0/0 0.45/0.53 1/1'
+
    + +
  • Check out the curves of the cross_process profile using ffmpeg +and gnuplot: +
    +
    ffmpeg -f lavfi -i color -vf curves=cross_process:plot=/tmp/curves.plt -frames:v 1 -f null -
+gnuplot -p /tmp/curves.plt
+
    +
+ + +

32.39 datascope

+ +

Video data analysis filter. +

+

This filter shows hexadecimal pixel values of part of video. +

+

The filter accepts the following options: +

+
+
size, s
+

Set output video size. +

+
+
x
+

Set x offset from where to pick pixels. +

+
+
y
+

Set y offset from where to pick pixels. +

+
+
mode
+

Set scope mode, can be one of the following: +

+
‘mono’
+

Draw hexadecimal pixel values with white color on black background. +

+
+
‘color’
+

Draw hexadecimal pixel values with input video pixel color on black +background. +

+
+
‘color2’
+

Draw hexadecimal pixel values on color background picked from input video, +the text color is picked in such way so its always visible. +

+
+ +
+
axis
+

Draw rows and columns numbers on left and top of video. +

+
+
opacity
+

Set background opacity. +

+
+
format
+

Set display number format. Can be hex, or dec. Default is hex. +

+
+ + +

32.40 dblur

+

Apply Directional blur filter. +

+

The filter accepts the following options: +

+
+
angle
+

Set angle of directional blur. Default is 45. +

+
+
radius
+

Set radius of directional blur. Default is 5. +

+
+
planes
+

Set which planes to filter. By default all planes are filtered. +

+
+ + +

32.40.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.41 dctdnoiz

+ +

Denoise frames using 2D DCT (frequency domain filtering). +

+

This filter is not designed for real time. +

+

The filter accepts the following options: +

+
+
sigma, s
+

Set the noise sigma constant. +

+

This sigma defines a hard threshold of 3 * sigma; every DCT +coefficient (absolute value) below this threshold with be dropped. +

+

If you need a more advanced filtering, see expr. +

+

Default is 0. +

+
+
overlap
+

Set number overlapping pixels for each block. Since the filter can be slow, you +may want to reduce this value, at the cost of a less effective filter and the +risk of various artefacts. +

+

If the overlapping value doesn’t permit processing the whole input width or +height, a warning will be displayed and according borders won’t be denoised. +

+

Default value is blocksize-1, which is the best possible setting. +

+
+
expr, e
+

Set the coefficient factor expression. +

+

For each coefficient of a DCT block, this expression will be evaluated as a +multiplier value for the coefficient. +

+

If this is option is set, the sigma option will be ignored. +

+

The absolute value of the coefficient can be accessed through the c +variable. +

+
+
n
+

Set the blocksize using the number of bits. 1<<n defines the +blocksize, which is the width and height of the processed blocks. +

+

The default value is 3 (8x8) and can be raised to 4 for a +blocksize of 16x16. Note that changing this setting has huge consequences +on the speed processing. Also, a larger block size does not necessarily means a +better de-noising. +

+
+ + +

32.41.1 Examples

+ +

Apply a denoise with a sigma of 4.5: +

+
dctdnoiz=4.5
+
+ +

The same operation can be achieved using the expression system: +

+
dctdnoiz=e='gte(c, 4.5*3)'
+
+ +

Violent denoise using a block size of 16x16: +

+
dctdnoiz=15:n=4
+
+ + +

32.42 deband

+ +

Remove banding artifacts from input video. +It works by replacing banded pixels with average value of referenced pixels. +

+

The filter accepts the following options: +

+
+
1thr
+
2thr
+
3thr
+
4thr
+

Set banding detection threshold for each plane. Default is 0.02. +Valid range is 0.00003 to 0.5. +If difference between current pixel and reference pixel is less than threshold, +it will be considered as banded. +

+
+
range, r
+

Banding detection range in pixels. Default is 16. If positive, random number +in range 0 to set value will be used. If negative, exact absolute value +will be used. +The range defines square of four pixels around current pixel. +

+
+
direction, d
+

Set direction in radians from which four pixel will be compared. If positive, +random direction from 0 to set direction will be picked. If negative, exact of +absolute value will be picked. For example direction 0, -PI or -2*PI radians +will pick only pixels on same row and -PI/2 will pick only pixels on same +column. +

+
+
blur, b
+

If enabled, current pixel is compared with average value of all four +surrounding pixels. The default is enabled. If disabled current pixel is +compared with all four surrounding pixels. The pixel is considered banded +if only all four differences with surrounding pixels are less than threshold. +

+
+
coupling, c
+

If enabled, current pixel is changed if and only if all pixel components are banded, +e.g. banding detection threshold is triggered for all color components. +The default is disabled. +

+
+ + +

32.43 deblock

+ +

Remove blocking artifacts from input video. +

+

The filter accepts the following options: +

+
+
filter
+

Set filter type, can be weak or strong. Default is strong. +This controls what kind of deblocking is applied. +

+
+
block
+

Set size of block, allowed range is from 4 to 512. Default is 8. +

+
+
alpha
+
beta
+
gamma
+
delta
+

Set blocking detection thresholds. Allowed range is 0 to 1. +Defaults are: 0.098 for alpha and 0.05 for the rest. +Using higher threshold gives more deblocking strength. +Setting alpha controls threshold detection at exact edge of block. +Remaining options controls threshold detection near the edge. Each one for +below/above or left/right. Setting any of those to 0 disables +deblocking. +

+
+
planes
+

Set planes to filter. Default is to filter all available planes. +

+
+ + +

32.43.1 Examples

+ +
    +
  • Deblock using weak filter and block size of 4 pixels. +
    +
    deblock=filter=weak:block=4
+
    + +
  • Deblock using strong filter, block size of 4 pixels and custom thresholds for +deblocking more edges. +
    +
    deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05
+
    + +
  • Similar as above, but filter only first plane. +
    +
    deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05:planes=1
+
    + +
  • Similar as above, but filter only second and third plane. +
    +
    deblock=filter=strong:block=4:alpha=0.12:beta=0.07:gamma=0.06:delta=0.05:planes=6
+
    +
+ + +

32.44 decimate

+ +

Drop duplicated frames at regular intervals. +

+

The filter accepts the following options: +

+
+
cycle
+

Set the number of frames from which one will be dropped. Setting this to +N means one frame in every batch of N frames will be dropped. +Default is 5. +

+
+
dupthresh
+

Set the threshold for duplicate detection. If the difference metric for a frame +is less than or equal to this value, then it is declared as duplicate. Default +is 1.1 +

+
+
scthresh
+

Set scene change threshold. Default is 15. +

+
+
blockx
+
blocky
+

Set the size of the x and y-axis blocks used during metric calculations. +Larger blocks give better noise suppression, but also give worse detection of +small movements. Must be a power of two. Default is 32. +

+
+
ppsrc
+

Mark main input as a pre-processed input and activate clean source input +stream. This allows the input to be pre-processed with various filters to help +the metrics calculation while keeping the frame selection lossless. When set to +1, the first stream is for the pre-processed input, and the second +stream is the clean source from where the kept frames are chosen. Default is +0. +

+
+
chroma
+

Set whether or not chroma is considered in the metric calculations. Default is +1. +

+
+ + +

32.45 deconvolve

+ +

Apply 2D deconvolution of video stream in frequency domain using second stream +as impulse. +

+

The filter accepts the following options: +

+
+
planes
+

Set which planes to process. +

+
+
impulse
+

Set which impulse video frames will be processed, can be first +or all. Default is all. +

+
+
noise
+

Set noise when doing divisions. Default is 0.0000001. Useful when width +and height are not same and not power of 2 or if stream prior to convolving +had noise. +

+
+ +

The deconvolve filter also supports the framesync options. +

+ +

32.46 dedot

+ +

Reduce cross-luminance (dot-crawl) and cross-color (rainbows) from video. +

+

It accepts the following options: +

+
+
m
+

Set mode of operation. Can be combination of dotcrawl for cross-luminance reduction and/or +rainbows for cross-color reduction. +

+
+
lt
+

Set spatial luma threshold. Lower values increases reduction of cross-luminance. +

+
+
tl
+

Set tolerance for temporal luma. Higher values increases reduction of cross-luminance. +

+
+
tc
+

Set tolerance for chroma temporal variation. Higher values increases reduction of cross-color. +

+
+
ct
+

Set temporal chroma threshold. Lower values increases reduction of cross-color. +

+
+ + +

32.47 deflate

+ +

Apply deflate effect to the video. +

+

This filter replaces the pixel by the local(3x3) average by taking into account +only values lower than the pixel. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+ + +

32.47.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

32.48 deflicker

+ +

Remove temporal frame luminance variations. +

+

It accepts the following options: +

+
+
size, s
+

Set moving-average filter size in frames. Default is 5. Allowed range is 2 - 129. +

+
+
mode, m
+

Set averaging mode to smooth temporal luminance variations. +

+

Available values are: +

+
‘am’
+

Arithmetic mean +

+
+
‘gm’
+

Geometric mean +

+
+
‘hm’
+

Harmonic mean +

+
+
‘qm’
+

Quadratic mean +

+
+
‘cm’
+

Cubic mean +

+
+
‘pm’
+

Power mean +

+
+
‘median’
+

Median +

+
+ +
+
bypass
+

Do not actually modify frame. Useful when one only wants metadata. +

+
+ + +

32.49 dejudder

+ +

Remove judder produced by partially interlaced telecined content. +

+

Judder can be introduced, for instance, by pullup filter. If the original +source was partially telecined content then the output of pullup,dejudder +will have a variable frame rate. May change the recorded frame rate of the +container. Aside from that change, this filter will not affect constant frame +rate video. +

+

The option available in this filter is: +

+
cycle
+

Specify the length of the window over which the judder repeats. +

+

Accepts any integer greater than 1. Useful values are: +

+
‘4’
+

If the original was telecined from 24 to 30 fps (Film to NTSC). +

+
+
‘5’
+

If the original was telecined from 25 to 30 fps (PAL to NTSC). +

+
+
‘20’
+

If a mixture of the two. +

+
+ +

The default is ‘4’. +

+
+ + +

32.50 delogo

+ +

Suppress a TV station logo by a simple interpolation of the surrounding +pixels. Just set a rectangle covering the logo and watch it disappear +(and sometimes something even uglier appear - your mileage may vary). +

+

It accepts the following parameters: +

+
x
+
y
+

Specify the top left corner coordinates of the logo. They must be +specified. +

+
+
w
+
h
+

Specify the width and height of the logo to clear. They must be +specified. +

+
+
band, t
+

Specify the thickness of the fuzzy edge of the rectangle (added to +w and h). The default value is 1. This option is +deprecated, setting higher values should no longer be necessary and +is not recommended. +

+
+
show
+

When set to 1, a green rectangle is drawn on the screen to simplify +finding the right x, y, w, and h parameters. +The default value is 0. +

+

The rectangle is drawn on the outermost pixels which will be (partly) +replaced with interpolated values. The values of the next pixels +immediately outside this rectangle in each direction will be used to +compute the interpolated pixel values inside the rectangle. +

+
+
+ + +

32.50.1 Examples

+ +
    +
  • Set a rectangle covering the area with top left corner coordinates 0,0 +and size 100x77, and a band of size 10: +
    +
    delogo=x=0:y=0:w=100:h=77:band=10
+
    + +
+ + +

32.51 derain

+ +

Remove the rain in the input image/video by applying the derain methods based on +convolutional neural networks. Supported models: +

+ + +

Training as well as model generation scripts are provided in +the repository at https://github.com/XueweiMeng/derain_filter.git. +

+

Native model files (.model) can be generated from TensorFlow model +files (.pb) by using tools/python/convert.py +

+

The filter accepts the following options: +

+
+
filter_type
+

Specify which filter to use. This option accepts the following values: +

+
+
‘derain’
+

Derain filter. To conduct derain filter, you need to use a derain model. +

+
+
‘dehaze’
+

Dehaze filter. To conduct dehaze filter, you need to use a dehaze model. +

+
+

Default value is ‘derain’. +

+
+
dnn_backend
+

Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +

+
+
‘native’
+

Native implementation of DNN loading and execution. +

+
+
‘tensorflow’
+

TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +https://www.tensorflow.org/install/install_c) and configure FFmpeg with +--enable-libtensorflow +

+
+

Default value is ‘native’. +

+
+
model
+

Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow and native +backend can load files for only its format. +

+
+ +

It can also be finished with dnn_processing filter. +

+ +

32.52 deshake

+ +

Attempt to fix small changes in horizontal and/or vertical shift. This +filter helps remove camera shake from hand-holding a camera, bumping a +tripod, moving on a vehicle, etc. +

+

The filter accepts the following options: +

+
+
x
+
y
+
w
+
h
+

Specify a rectangular area where to limit the search for motion +vectors. +If desired the search for motion vectors can be limited to a +rectangular area of the frame defined by its top left corner, width +and height. These parameters have the same meaning as the drawbox +filter which can be used to visualise the position of the bounding +box. +

+

This is useful when simultaneous movement of subjects within the frame +might be confused for camera motion by the motion vector search. +

+

If any or all of x, y, w and h are set to -1 +then the full frame is used. This allows later options to be set +without specifying the bounding box for the motion vector search. +

+

Default - search the whole frame. +

+
+
rx
+
ry
+

Specify the maximum extent of movement in x and y directions in the +range 0-64 pixels. Default 16. +

+
+
edge
+

Specify how to generate pixels to fill blanks at the edge of the +frame. Available values are: +

+
‘blank, 0’
+

Fill zeroes at blank locations +

+
‘original, 1’
+

Original image at blank locations +

+
‘clamp, 2’
+

Extruded edge value at blank locations +

+
‘mirror, 3’
+

Mirrored edge at blank locations +

+
+

Default value is ‘mirror’. +

+
+
blocksize
+

Specify the blocksize to use for motion search. Range 4-128 pixels, +default 8. +

+
+
contrast
+

Specify the contrast threshold for blocks. Only blocks with more than +the specified contrast (difference between darkest and lightest +pixels) will be considered. Range 1-255, default 125. +

+
+
search
+

Specify the search strategy. Available values are: +

+
‘exhaustive, 0’
+

Set exhaustive search +

+
‘less, 1’
+

Set less exhaustive search. +

+
+

Default value is ‘exhaustive’. +

+
+
filename
+

If set then a detailed log of the motion search is written to the +specified file. +

+
+
+ + +

32.53 despill

+ +

Remove unwanted contamination of foreground colors, caused by reflected color of +greenscreen or bluescreen. +

+

This filter accepts the following options: +

+
+
type
+

Set what type of despill to use. +

+
+
mix
+

Set how spillmap will be generated. +

+
+
expand
+

Set how much to get rid of still remaining spill. +

+
+
red
+

Controls amount of red in spill area. +

+
+
green
+

Controls amount of green in spill area. +Should be -1 for greenscreen. +

+
+
blue
+

Controls amount of blue in spill area. +Should be -1 for bluescreen. +

+
+
brightness
+

Controls brightness of spill area, preserving colors. +

+
+
alpha
+

Modify alpha from generated spillmap. +

+
+ + +

32.54 detelecine

+ +

Apply an exact inverse of the telecine operation. It requires a predefined +pattern specified using the pattern option which must be the same as that passed +to the telecine filter. +

+

This filter accepts the following options: +

+
+
first_field
+
+
‘top, t’
+

top field first +

+
‘bottom, b’
+

bottom field first +The default value is top. +

+
+ +
+
pattern
+

A string of numbers representing the pulldown pattern you wish to apply. +The default value is 23. +

+
+
start_frame
+

A number representing position of the first frame with respect to the telecine +pattern. This is to be used if the stream is cut. The default value is 0. +

+
+ + +

32.55 dilation

+ +

Apply dilation effect to the video. +

+

This filter replaces the pixel by the local(3x3) maximum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. Default is 255 i.e. all eight +pixels are used. +

+

Flags to local 3x3 coordinates maps like this: +

+

1 2 3 + 4 5 + 6 7 8 +

+
+ + +

32.55.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

32.56 displace

+ +

Displace pixels as indicated by second and third input stream. +

+

It takes three input streams and outputs one stream, the first input is the +source, and second and third input are displacement maps. +

+

The second input specifies how much to displace pixels along the +x-axis, while the third input specifies how much to displace pixels +along the y-axis. +If one of displacement map streams terminates, last frame from that +displacement map will be used. +

+

Note that once generated, displacements maps can be reused over and over again. +

+

A description of the accepted options follows. +

+
+
edge
+

Set displace behavior for pixels that are out of range. +

+

Available values are: +

+
‘blank’
+

Missing pixels are replaced by black pixels. +

+
+
‘smear’
+

Adjacent pixels will spread out to replace missing pixels. +

+
+
‘wrap’
+

Out of range pixels are wrapped so they point to pixels of other side. +

+
+
‘mirror’
+

Out of range pixels will be replaced with mirrored pixels. +

+
+

Default is ‘smear’. +

+
+
+ + +

32.56.1 Examples

+ +
    +
  • Add ripple effect to rgb input of video size hd720: +
    +
    ffmpeg -i INPUT -f lavfi -i nullsrc=s=hd720,lutrgb=128:128:128 -f lavfi -i nullsrc=s=hd720,geq='r=128+30*sin(2*PI*X/400+T):g=128+30*sin(2*PI*X/400+T):b=128+30*sin(2*PI*X/400+T)' -lavfi '[0][1][2]displace' OUTPUT
+
    + +
  • Add wave effect to rgb input of video size hd720: +
    +
    ffmpeg -i INPUT -f lavfi -i nullsrc=hd720,geq='r=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T)):g=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T)):b=128+80*(sin(sqrt((X-W/2)*(X-W/2)+(Y-H/2)*(Y-H/2))/220*2*PI+T))' -lavfi '[1]split[x][y],[0][x][y]displace' OUTPUT
+
    +
+ + +

32.57 dnn_processing

+ +

Do image processing with deep neural networks. It works together with another filter +which converts the pixel format of the Frame to what the dnn network requires. +

+

The filter accepts the following options: +

+
+
dnn_backend
+

Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +

+
+
‘native’
+

Native implementation of DNN loading and execution. +

+
+
‘tensorflow’
+

TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +https://www.tensorflow.org/install/install_c) and configure FFmpeg with +--enable-libtensorflow +

+
+ +

Default value is ‘native’. +

+
+
model
+

Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow and native +backend can load files for only its format. +

+

Native model file (.model) can be generated from TensorFlow model file (.pb) by using tools/python/convert.py +

+
+
input
+

Set the input name of the dnn network. +

+
+
output
+

Set the output name of the dnn network. +

+
+
+ + +

32.57.1 Examples

+ +
    +
  • Remove rain in rgb24 frame with can.pb (see derain filter): +
    +
    ./ffmpeg -i rain.jpg -vf format=rgb24,dnn_processing=dnn_backend=tensorflow:model=can.pb:input=x:output=y derain.jpg
+
    + +
  • Halve the pixel value of the frame with format gray32f: +
    +
    ffmpeg -i input.jpg -vf format=grayf32,dnn_processing=model=halve_gray_float.model:input=dnn_in:output=dnn_out:dnn_backend=native -y out.native.png
+
    + +
  • Handle the Y channel with srcnn.pb (see sr filter) for frame with yuv420p (planar YUV formats supported): +
    +
    ./ffmpeg -i 480p.jpg -vf format=yuv420p,scale=w=iw*2:h=ih*2,dnn_processing=dnn_backend=tensorflow:model=srcnn.pb:input=x:output=y -y srcnn.jpg
+
    + +
  • Handle the Y channel with espcn.pb (see sr filter), which changes frame size, for format yuv420p (planar YUV formats supported): +
    +
    ./ffmpeg -i 480p.jpg -vf format=yuv420p,dnn_processing=dnn_backend=tensorflow:model=espcn.pb:input=x:output=y -y tmp.espcn.jpg
+
    + +
+ + +

32.58 drawbox

+ +

Draw a colored box on the input image. +

+

It accepts the following parameters: +

+
+
x
+
y
+

The expressions which specify the top left corner coordinates of the box. It defaults to 0. +

+
+
width, w
+
height, h
+

The expressions which specify the width and height of the box; if 0 they are interpreted as +the input width and height. It defaults to 0. +

+
+
color, c
+

Specify the color of the box to write. For the general syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. If the special +value invert is used, the box edge color is the same as the +video with inverted luma. +

+
+
thickness, t
+

The expression which sets the thickness of the box edge. +A value of fill will create a filled box. Default value is 3. +

+

See below for the list of accepted constants. +

+
+
replace
+

Applicable if the input has alpha. With value 1, the pixels of the painted box +will overwrite the video’s color and alpha pixels. +Default is 0, which composites the box onto the input, leaving the video’s alpha intact. +

+
+ +

The parameters for x, y, w and h and t are expressions containing the +following constants: +

+
+
dar
+

The input display aspect ratio, it is the same as (w / h) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
in_h, ih
+
in_w, iw
+

The input width and height. +

+
+
sar
+

The input sample aspect ratio. +

+
+
x
+
y
+

The x and y offset coordinates where the box is drawn. +

+
+
w
+
h
+

The width and height of the drawn box. +

+
+
t
+

The thickness of the drawn box. +

+

These constants allow the x, y, w, h and t expressions to refer to +each other, so you may for example specify y=x/dar or h=w/dar. +

+
+
+ + +

32.58.1 Examples

+ +
    +
  • Draw a black box around the edge of the input image: +
    +
    drawbox
+
    + +
  • Draw a box with color red and an opacity of 50%: +
    +
    drawbox=10:20:200:60:red@0.5
+
    + +

    The previous example can be specified as: +

    +
    drawbox=x=10:y=20:w=200:h=60:color=red@0.5
+
    + +
  • Fill the box with pink color: +
    +
    drawbox=x=10:y=10:w=100:h=100:color=pink@0.5:t=fill
+
    + +
  • Draw a 2-pixel red 2.40:1 mask: +
    +
    drawbox=x=-t:y=0.5*(ih-iw/2.4)-t:w=iw+t*2:h=iw/2.4+t*2:t=2:c=red
+
    +
+ + +

32.58.2 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.59 drawgraph

+

Draw a graph using input video metadata. +

+

It accepts the following parameters: +

+
+
m1
+

Set 1st frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg1
+

Set 1st foreground color expression. +

+
+
m2
+

Set 2nd frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg2
+

Set 2nd foreground color expression. +

+
+
m3
+

Set 3rd frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg3
+

Set 3rd foreground color expression. +

+
+
m4
+

Set 4th frame metadata key from which metadata values will be used to draw a graph. +

+
+
fg4
+

Set 4th foreground color expression. +

+
+
min
+

Set minimal value of metadata value. +

+
+
max
+

Set maximal value of metadata value. +

+
+
bg
+

Set graph background color. Default is white. +

+
+
mode
+

Set graph mode. +

+

Available values for mode is: +

+
‘bar’
+
‘dot’
+
‘line’
+
+ +

Default is line. +

+
+
slide
+

Set slide mode. +

+

Available values for slide is: +

+
‘frame’
+

Draw new frame when right border is reached. +

+
+
‘replace’
+

Replace old columns with new ones. +

+
+
‘scroll’
+

Scroll from right to left. +

+
+
‘rscroll’
+

Scroll from left to right. +

+
+
‘picture’
+

Draw single picture. +

+
+ +

Default is frame. +

+
+
size
+

Set size of graph video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +The default value is 900x256. +

+
+
rate, r
+

Set the output frame rate. Default value is 25. +

+

The foreground color expressions can use the following variables: +

+
MIN
+

Minimal value of metadata value. +

+
+
MAX
+

Maximal value of metadata value. +

+
+
VAL
+

Current metadata key value. +

+
+ +

The color is defined as 0xAABBGGRR. +

+
+ +

Example using metadata from signalstats filter: +

+
signalstats,drawgraph=lavfi.signalstats.YAVG:min=0:max=255
+
+ +

Example using metadata from ebur128 filter: +

+
ebur128=metadata=1,adrawgraph=lavfi.r128.M:min=-120:max=5
+
+ + +

32.60 drawgrid

+ +

Draw a grid on the input image. +

+

It accepts the following parameters: +

+
+
x
+
y
+

The expressions which specify the coordinates of some point of grid intersection (meant to configure offset). Both default to 0. +

+
+
width, w
+
height, h
+

The expressions which specify the width and height of the grid cell, if 0 they are interpreted as the +input width and height, respectively, minus thickness, so image gets +framed. Default to 0. +

+
+
color, c
+

Specify the color of the grid. For the general syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. If the special +value invert is used, the grid color is the same as the +video with inverted luma. +

+
+
thickness, t
+

The expression which sets the thickness of the grid line. Default value is 1. +

+

See below for the list of accepted constants. +

+
+
replace
+

Applicable if the input has alpha. With 1 the pixels of the painted grid +will overwrite the video’s color and alpha pixels. +Default is 0, which composites the grid onto the input, leaving the video’s alpha intact. +

+
+ +

The parameters for x, y, w and h and t are expressions containing the +following constants: +

+
+
dar
+

The input display aspect ratio, it is the same as (w / h) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
in_h, ih
+
in_w, iw
+

The input grid cell width and height. +

+
+
sar
+

The input sample aspect ratio. +

+
+
x
+
y
+

The x and y coordinates of some point of grid intersection (meant to configure offset). +

+
+
w
+
h
+

The width and height of the drawn cell. +

+
+
t
+

The thickness of the drawn cell. +

+

These constants allow the x, y, w, h and t expressions to refer to +each other, so you may for example specify y=x/dar or h=w/dar. +

+
+
+ + +

32.60.1 Examples

+ +
    +
  • Draw a grid with cell 100x100 pixels, thickness 2 pixels, with color red and an opacity of 50%: +
    +
    drawgrid=width=100:height=100:thickness=2:color=red@0.5
+
    + +
  • Draw a white 3x3 grid with an opacity of 50%: +
    +
    drawgrid=w=iw/3:h=ih/3:t=2:c=white@0.5
+
    +
+ + +

32.60.2 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.61 drawtext

+ +

Draw a text string or text from a specified file on top of a video, using the +libfreetype library. +

+

To enable compilation of this filter, you need to configure FFmpeg with +--enable-libfreetype. +To enable default font fallback and the font option you need to +configure FFmpeg with --enable-libfontconfig. +To enable the text_shaping option, you need to configure FFmpeg with +--enable-libfribidi. +

+ +

32.61.1 Syntax

+ +

It accepts the following parameters: +

+
+
box
+

Used to draw a box around text using the background color. +The value must be either 1 (enable) or 0 (disable). +The default value of box is 0. +

+
+
boxborderw
+

Set the width of the border to be drawn around the box using boxcolor. +The default value of boxborderw is 0. +

+
+
boxcolor
+

The color to be used for drawing box around text. For the syntax of this +option, check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+

The default value of boxcolor is "white". +

+
+
line_spacing
+

Set the line spacing in pixels of the border to be drawn around the box using box. +The default value of line_spacing is 0. +

+
+
borderw
+

Set the width of the border to be drawn around the text using bordercolor. +The default value of borderw is 0. +

+
+
bordercolor
+

Set the color to be used for drawing border around text. For the syntax of this +option, check the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+

The default value of bordercolor is "black". +

+
+
expansion
+

Select how the text is expanded. Can be either none, +strftime (deprecated) or +normal (default). See the Text expansion section +below for details. +

+
+
basetime
+

Set a start time for the count. Value is in microseconds. Only applied +in the deprecated strftime expansion mode. To emulate in normal expansion +mode use the pts function, supplying the start time (in seconds) +as the second argument. +

+
+
fix_bounds
+

If true, check and fix text coords to avoid clipping. +

+
+
fontcolor
+

The color to be used for drawing fonts. For the syntax of this option, check +the (ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+

The default value of fontcolor is "black". +

+
+
fontcolor_expr
+

String which is expanded the same way as text to obtain dynamic +fontcolor value. By default this option has empty value and is not +processed. When this option is set, it overrides fontcolor option. +

+
+
font
+

The font family to be used for drawing text. By default Sans. +

+
+
fontfile
+

The font file to be used for drawing text. The path must be included. +This parameter is mandatory if the fontconfig support is disabled. +

+
+
alpha
+

Draw the text applying alpha blending. The value can +be a number between 0.0 and 1.0. +The expression accepts the same variables x, y as well. +The default value is 1. +Please see fontcolor_expr. +

+
+
fontsize
+

The font size to be used for drawing text. +The default value of fontsize is 16. +

+
+
text_shaping
+

If set to 1, attempt to shape the text (for example, reverse the order of +right-to-left text and join Arabic characters) before drawing it. +Otherwise, just draw the text exactly as given. +By default 1 (if supported). +

+
+
ft_load_flags
+

The flags to be used for loading the fonts. +

+

The flags map the corresponding flags supported by libfreetype, and are +a combination of the following values: +

+
default
+
no_scale
+
no_hinting
+
render
+
no_bitmap
+
vertical_layout
+
force_autohint
+
crop_bitmap
+
pedantic
+
ignore_global_advance_width
+
no_recurse
+
ignore_transform
+
monochrome
+
linear_design
+
no_autohint
+
+ +

Default value is "default". +

+

For more information consult the documentation for the FT_LOAD_* +libfreetype flags. +

+
+
shadowcolor
+

The color to be used for drawing a shadow behind the drawn text. For the +syntax of this option, check the (ffmpeg-utils)"Color" section in the +ffmpeg-utils manual. +

+

The default value of shadowcolor is "black". +

+
+
shadowx
+
shadowy
+

The x and y offsets for the text shadow position with respect to the +position of the text. They can be either positive or negative +values. The default value for both is "0". +

+
+
start_number
+

The starting frame number for the n/frame_num variable. The default value +is "0". +

+
+
tabsize
+

The size in number of spaces to use for rendering the tab. +Default value is 4. +

+
+
timecode
+

Set the initial timecode representation in "hh:mm:ss[:;.]ff" +format. It can be used with or without text parameter. timecode_rate +option must be specified. +

+
+
timecode_rate, rate, r
+

Set the timecode frame rate (timecode only). Value will be rounded to nearest +integer. Minimum value is "1". +Drop-frame timecode is supported for frame rates 30 & 60. +

+
+
tc24hmax
+

If set to 1, the output of the timecode option will wrap around at 24 hours. +Default is 0 (disabled). +

+
+
text
+

The text string to be drawn. The text must be a sequence of UTF-8 +encoded characters. +This parameter is mandatory if no file is specified with the parameter +textfile. +

+
+
textfile
+

A text file containing text to be drawn. The text must be a sequence +of UTF-8 encoded characters. +

+

This parameter is mandatory if no text string is specified with the +parameter text. +

+

If both text and textfile are specified, an error is thrown. +

+
+
reload
+

If set to 1, the textfile will be reloaded before each frame. +Be sure to update it atomically, or it may be read partially, or even fail. +

+
+
x
+
y
+

The expressions which specify the offsets where text will be drawn +within the video frame. They are relative to the top/left border of the +output image. +

+

The default value of x and y is "0". +

+

See below for the list of accepted constants and functions. +

+
+ +

The parameters for x and y are expressions containing the +following constants and functions: +

+
+
dar
+

input display aspect ratio, it is the same as (w / h) * sar +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
line_h, lh
+

the height of each text line +

+
+
main_h, h, H
+

the input height +

+
+
main_w, w, W
+

the input width +

+
+
max_glyph_a, ascent
+

the maximum distance from the baseline to the highest/upper grid +coordinate used to place a glyph outline point, for all the rendered +glyphs. +It is a positive value, due to the grid’s orientation with the Y axis +upwards. +

+
+
max_glyph_d, descent
+

the maximum distance from the baseline to the lowest grid coordinate +used to place a glyph outline point, for all the rendered glyphs. +This is a negative value, due to the grid’s orientation, with the Y axis +upwards. +

+
+
max_glyph_h
+

maximum glyph height, that is the maximum height for all the glyphs +contained in the rendered text, it is equivalent to ascent - +descent. +

+
+
max_glyph_w
+

maximum glyph width, that is the maximum width for all the glyphs +contained in the rendered text +

+
+
n
+

the number of input frame, starting from 0 +

+
+
rand(min, max)
+

return a random number included between min and max +

+
+
sar
+

The input sample aspect ratio. +

+
+
t
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+
text_h, th
+

the height of the rendered text +

+
+
text_w, tw
+

the width of the rendered text +

+
+
x
+
y
+

the x and y offset coordinates where the text is drawn. +

+

These parameters allow the x and y expressions to refer +to each other, so you can for example specify y=x/dar. +

+
+
pict_type
+

A one character description of the current frame’s picture type. +

+
+
pkt_pos
+

The current packet’s position in the input file or stream +(in bytes, from the start of the input). A value of -1 indicates +this info is not available. +

+
+
pkt_duration
+

The current packet’s duration, in seconds. +

+
+
pkt_size
+

The current packet’s size (in bytes). +

+
+ + +

32.61.2 Text expansion

+ +

If expansion is set to strftime, +the filter recognizes strftime() sequences in the provided text and +expands them accordingly. Check the documentation of strftime(). This +feature is deprecated. +

+

If expansion is set to none, the text is printed verbatim. +

+

If expansion is set to normal (which is the default), +the following expansion mechanism is used. +

+

The backslash character ‘\’, followed by any character, always expands to +the second character. +

+

Sequences of the form %{...} are expanded. The text between the +braces is a function name, possibly followed by arguments separated by ’:’. +If the arguments contain special characters or delimiters (’:’ or ’}’), +they should be escaped. +

+

Note that they probably must also be escaped as the value for the +text option in the filter argument string and as the filter +argument in the filtergraph description, and possibly also for the shell, +that makes up to four levels of escaping; using a text file avoids these +problems. +

+

The following functions are available: +

+
+
expr, e
+

The expression evaluation result. +

+

It must take one argument specifying the expression to be evaluated, +which accepts the same constants and functions as the x and +y values. Note that not all constants should be used, for +example the text size is not known when evaluating the expression, so +the constants text_w and text_h will have an undefined +value. +

+
+
expr_int_format, eif
+

Evaluate the expression’s value and output as formatted integer. +

+

The first argument is the expression to be evaluated, just as for the expr function. +The second argument specifies the output format. Allowed values are ‘x’, +‘X’, ‘d’ and ‘u’. They are treated exactly as in the +printf function. +The third parameter is optional and sets the number of positions taken by the output. +It can be used to add padding with zeros from the left. +

+
+
gmtime
+

The time at which the filter is running, expressed in UTC. +It can accept an argument: a strftime() format string. +

+
+
localtime
+

The time at which the filter is running, expressed in the local time zone. +It can accept an argument: a strftime() format string. +

+
+
metadata
+

Frame metadata. Takes one or two arguments. +

+

The first argument is mandatory and specifies the metadata key. +

+

The second argument is optional and specifies a default value, used when the +metadata key is not found or empty. +

+

Available metadata can be identified by inspecting entries +starting with TAG included within each frame section +printed by running ffprobe -show_frames. +

+

String metadata generated in filters leading to +the drawtext filter are also available. +

+
+
n, frame_num
+

The frame number, starting from 0. +

+
+
pict_type
+

A one character description of the current picture type. +

+
+
pts
+

The timestamp of the current frame. +It can take up to three arguments. +

+

The first argument is the format of the timestamp; it defaults to flt +for seconds as a decimal number with microsecond accuracy; hms stands +for a formatted [-]HH:MM:SS.mmm timestamp with millisecond accuracy. +gmtime stands for the timestamp of the frame formatted as UTC time; +localtime stands for the timestamp of the frame formatted as +local time zone time. +

+

The second argument is an offset added to the timestamp. +

+

If the format is set to hms, a third argument 24HH may be +supplied to present the hour part of the formatted timestamp in 24h format +(00-23). +

+

If the format is set to localtime or gmtime, +a third argument may be supplied: a strftime() format string. +By default, YYYY-MM-DD HH:MM:SS format will be used. +

+
+ + +

32.61.3 Commands

+ +

This filter supports altering parameters via commands: +

+
reinit
+

Alter existing filter parameters. +

+

Syntax for the argument is the same as for filter invocation, e.g. +

+
+
fontsize=56:fontcolor=green:text='Hello World'
+
+ +

Full filter invocation with sendcmd would look like this: +

+
+
sendcmd=c='56.0 drawtext reinit fontsize=56\:fontcolor=green\:text=Hello\\ World'
+
+
+
+ +

If the entire argument can’t be parsed or applied as valid values then the filter will +continue with its existing parameters. +

+ +

32.61.4 Examples

+ +
    +
  • Draw "Test Text" with font FreeSerif, using the default values for the +optional parameters. + +
    +
    drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
+
    + +
  • Draw ’Test Text’ with font FreeSerif of size 24 at position x=100 +and y=50 (counting from the top-left corner of the screen), text is +yellow with a red box around it. Both the text and the box have an +opacity of 20%. + +
    +
    drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
+          x=100: y=50: fontsize=24: fontcolor=yellow@0.2: box=1: boxcolor=red@0.2"
+
    + +

    Note that the double quotes are not necessary if spaces are not used +within the parameter list. +

    +
  • Show the text at the center of the video frame: +
    +
    drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=(w-text_w)/2:y=(h-text_h)/2"
+
    + +
  • Show the text at a random position, switching to a new position every 30 seconds: +
    +
    drawtext="fontsize=30:fontfile=FreeSerif.ttf:text='hello world':x=if(eq(mod(t\,30)\,0)\,rand(0\,(w-text_w))\,x):y=if(eq(mod(t\,30)\,0)\,rand(0\,(h-text_h))\,y)"
+
    + +
  • Show a text line sliding from right to left in the last row of the video +frame. The file LONG_LINE is assumed to contain a single line +with no newlines. +
    +
    drawtext="fontsize=15:fontfile=FreeSerif.ttf:text=LONG_LINE:y=h-line_h:x=-50*t"
+
    + +
  • Show the content of file CREDITS off the bottom of the frame and scroll up. +
    +
    drawtext="fontsize=20:fontfile=FreeSerif.ttf:textfile=CREDITS:y=h-20*t"
+
    + +
  • Draw a single green letter "g", at the center of the input video. +The glyph baseline is placed at half screen height. +
    +
    drawtext="fontsize=60:fontfile=FreeSerif.ttf:fontcolor=green:text=g:x=(w-max_glyph_w)/2:y=h/2-ascent"
+
    + +
  • Show text for 1 second every 3 seconds: +
    +
    drawtext="fontfile=FreeSerif.ttf:fontcolor=white:x=100:y=x/dar:enable=lt(mod(t\,3)\,1):text='blink'"
+
    + +
  • Use fontconfig to set the font. Note that the colons need to be escaped. +
    +
    drawtext='fontfile=Linux Libertine O-40\:style=Semibold:text=FFmpeg'
+
    + +
  • Print the date of a real-time encoding (see strftime(3)): +
    +
    drawtext='fontfile=FreeSans.ttf:text=%{localtime\:%a %b %d %Y}'
+
    + +
  • Show text fading in and out (appearing/disappearing): +
    +
    #!/bin/sh
+DS=1.0 # display start
+DE=10.0 # display end
+FID=1.5 # fade in duration
+FOD=5 # fade out duration
+ffplay -f lavfi "color,drawtext=text=TEST:fontsize=50:fontfile=FreeSerif.ttf:fontcolor_expr=ff0000%{eif\\\\: clip(255*(1*between(t\\, $DS + $FID\\, $DE - $FOD) + ((t - $DS)/$FID)*between(t\\, $DS\\, $DS + $FID) + (-(t - $DE)/$FOD)*between(t\\, $DE - $FOD\\, $DE) )\\, 0\\, 255) \\\\: x\\\\: 2 }"
+
    + +
  • Horizontally align multiple separate texts. Note that max_glyph_a +and the fontsize value are included in the y offset. +
    +
    drawtext=fontfile=FreeSans.ttf:text=DOG:fontsize=24:x=10:y=20+24-max_glyph_a,
+drawtext=fontfile=FreeSans.ttf:text=cow:fontsize=24:x=80:y=20+24-max_glyph_a
+
    + +
  • Plot special lavf.image2dec.source_basename metadata onto each frame if +such metadata exists. Otherwise, plot the string "NA". Note that image2 demuxer +must have option -export_path_metadata 1 for the special metadata fields +to be available for filters. +
    +
    drawtext="fontsize=20:fontcolor=white:fontfile=FreeSans.ttf:text='%{metadata\:lavf.image2dec.source_basename\:NA}':x=10:y=10"
+
    + +
+ +

For more information about libfreetype, check: +http://www.freetype.org/. +

+

For more information about fontconfig, check: +http://freedesktop.org/software/fontconfig/fontconfig-user.html. +

+

For more information about libfribidi, check: +http://fribidi.org/. +

+ +

32.62 edgedetect

+ +

Detect and draw edges. The filter uses the Canny Edge Detection algorithm. +

+

The filter accepts the following options: +

+
+
low
+
high
+

Set low and high threshold values used by the Canny thresholding +algorithm. +

+

The high threshold selects the "strong" edge pixels, which are then +connected through 8-connectivity with the "weak" edge pixels selected +by the low threshold. +

+

low and high threshold values must be chosen in the range +[0,1], and low should be lesser or equal to high. +

+

Default value for low is 20/255, and default value for high +is 50/255. +

+
+
mode
+

Define the drawing mode. +

+
+
‘wires’
+

Draw white/gray wires on black background. +

+
+
‘colormix’
+

Mix the colors to create a paint/cartoon effect. +

+
+
‘canny’
+

Apply Canny edge detector on all selected planes. +

+
+

Default value is wires. +

+
+
planes
+

Select planes for filtering. By default all available planes are filtered. +

+
+ + +

32.62.1 Examples

+ +
    +
  • Standard edge detection with custom values for the hysteresis thresholding: +
    +
    edgedetect=low=0.1:high=0.4
+
    + +
  • Painting effect without thresholding: +
    +
    edgedetect=mode=colormix:high=0
+
    +
+ + +

32.63 elbg

+ +

Apply a posterize effect using the ELBG (Enhanced LBG) algorithm. +

+

For each input image, the filter will compute the optimal mapping from +the input to the output given the codebook length, that is the number +of distinct output colors. +

+

This filter accepts the following options. +

+
+
codebook_length, l
+

Set codebook length. The value must be a positive integer, and +represents the number of distinct output colors. Default value is 256. +

+
+
nb_steps, n
+

Set the maximum number of iterations to apply for computing the optimal +mapping. The higher the value the better the result and the higher the +computation time. Default value is 1. +

+
+
seed, s
+

Set a random seed, must be an integer included between 0 and +UINT32_MAX. If not specified, or if explicitly set to -1, the filter +will try to use a good random seed on a best effort basis. +

+
+
pal8
+

Set pal8 output pixel format. This option does not work with codebook +length greater than 256. +

+
+ + +

32.64 entropy

+ +

Measure graylevel entropy in histogram of color channels of video frames. +

+

It accepts the following parameters: +

+
+
mode
+

Can be either normal or diff. Default is normal. +

+

diff mode measures entropy of histogram delta values, absolute differences +between neighbour histogram values. +

+
+ + +

32.65 eq

+

Set brightness, contrast, saturation and approximate gamma adjustment. +

+

The filter accepts the following options: +

+
+
contrast
+

Set the contrast expression. The value must be a float value in range +-1000.0 to 1000.0. The default value is "1". +

+
+
brightness
+

Set the brightness expression. The value must be a float value in +range -1.0 to 1.0. The default value is "0". +

+
+
saturation
+

Set the saturation expression. The value must be a float in +range 0.0 to 3.0. The default value is "1". +

+
+
gamma
+

Set the gamma expression. The value must be a float in range +0.1 to 10.0. The default value is "1". +

+
+
gamma_r
+

Set the gamma expression for red. The value must be a float in +range 0.1 to 10.0. The default value is "1". +

+
+
gamma_g
+

Set the gamma expression for green. The value must be a float in range +0.1 to 10.0. The default value is "1". +

+
+
gamma_b
+

Set the gamma expression for blue. The value must be a float in range +0.1 to 10.0. The default value is "1". +

+
+
gamma_weight
+

Set the gamma weight expression. It can be used to reduce the effect +of a high gamma value on bright image areas, e.g. keep them from +getting overamplified and just plain white. The value must be a float +in range 0.0 to 1.0. A value of 0.0 turns the +gamma correction all the way down while 1.0 leaves it at its +full strength. Default is "1". +

+
+
eval
+

Set when the expressions for brightness, contrast, saturation and +gamma expressions are evaluated. +

+

It accepts the following values: +

+
‘init’
+

only evaluate expressions once during the filter initialization or +when a command is processed +

+
+
‘frame’
+

evaluate expressions for each incoming frame +

+
+ +

Default value is ‘init’. +

+
+ +

The expressions accept the following parameters: +

+
n
+

frame count of the input frame starting from 0 +

+
+
pos
+

byte position of the corresponding packet in the input file, NAN if +unspecified +

+
+
r
+

frame rate of the input video, NAN if the input frame rate is unknown +

+
+
t
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+ + +

32.65.1 Commands

+

The filter supports the following commands: +

+
+
contrast
+

Set the contrast expression. +

+
+
brightness
+

Set the brightness expression. +

+
+
saturation
+

Set the saturation expression. +

+
+
gamma
+

Set the gamma expression. +

+
+
gamma_r
+

Set the gamma_r expression. +

+
+
gamma_g
+

Set gamma_g expression. +

+
+
gamma_b
+

Set gamma_b expression. +

+
+
gamma_weight
+

Set gamma_weight expression. +

+

The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+
+ + +

32.66 erosion

+ +

Apply erosion effect to the video. +

+

This filter replaces the pixel by the local(3x3) minimum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. Default is 255 i.e. all eight +pixels are used. +

+

Flags to local 3x3 coordinates maps like this: +

+

1 2 3 + 4 5 + 6 7 8 +

+
+ + +

32.66.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

32.67 extractplanes

+ +

Extract color channel components from input video stream into +separate grayscale video streams. +

+

The filter accepts the following option: +

+
+
planes
+

Set plane(s) to extract. +

+

Available values for planes are: +

+
‘y’
+
‘u’
+
‘v’
+
‘a’
+
‘r’
+
‘g’
+
‘b’
+
+ +

Choosing planes not available in the input will result in an error. +That means you cannot select r, g, b planes +with y, u, v planes at same time. +

+
+ + +

32.67.1 Examples

+ +
    +
  • Extract luma, u and v color channel component from input video frame +into 3 grayscale outputs: +
    +
    ffmpeg -i video.avi -filter_complex 'extractplanes=y+u+v[y][u][v]' -map '[y]' y.avi -map '[u]' u.avi -map '[v]' v.avi
+
    +
+ + +

32.68 fade

+ +

Apply a fade-in/out effect to the input video. +

+

It accepts the following parameters: +

+
+
type, t
+

The effect type can be either "in" for a fade-in, or "out" for a fade-out +effect. +Default is in. +

+
+
start_frame, s
+

Specify the number of the frame to start applying the fade +effect at. Default is 0. +

+
+
nb_frames, n
+

The number of frames that the fade effect lasts. At the end of the +fade-in effect, the output video will have the same intensity as the input video. +At the end of the fade-out transition, the output video will be filled with the +selected color. +Default is 25. +

+
+
alpha
+

If set to 1, fade only alpha channel, if one exists on the input. +Default value is 0. +

+
+
start_time, st
+

Specify the timestamp (in seconds) of the frame to start to apply the fade +effect. If both start_frame and start_time are specified, the fade will start at +whichever comes last. Default is 0. +

+
+
duration, d
+

The number of seconds for which the fade effect has to last. At the end of the +fade-in effect the output video will have the same intensity as the input video, +at the end of the fade-out transition the output video will be filled with the +selected color. +If both duration and nb_frames are specified, duration is used. Default is 0 +(nb_frames is used by default). +

+
+
color, c
+

Specify the color of the fade. Default is "black". +

+
+ + +

32.68.1 Examples

+ +
    +
  • Fade in the first 30 frames of video: +
    +
    fade=in:0:30
+
    + +

    The command above is equivalent to: +

    +
    fade=t=in:s=0:n=30
+
    + +
  • Fade out the last 45 frames of a 200-frame video: +
    +
    fade=out:155:45
+fade=type=out:start_frame=155:nb_frames=45
+
    + +
  • Fade in the first 25 frames and fade out the last 25 frames of a 1000-frame video: +
    +
    fade=in:0:25, fade=out:975:25
+
    + +
  • Make the first 5 frames yellow, then fade in from frame 5-24: +
    +
    fade=in:5:20:color=yellow
+
    + +
  • Fade in alpha over first 25 frames of video: +
    +
    fade=in:0:25:alpha=1
+
    + +
  • Make the first 5.5 seconds black, then fade in for 0.5 seconds: +
    +
    fade=t=in:st=5.5:d=0.5
+
    + +
+ + +

32.69 fftdnoiz

+

Denoise frames using 3D FFT (frequency domain filtering). +

+

The filter accepts the following options: +

+
+
sigma
+

Set the noise sigma constant. This sets denoising strength. +Default value is 1. Allowed range is from 0 to 30. +Using very high sigma with low overlap may give blocking artifacts. +

+
+
amount
+

Set amount of denoising. By default all detected noise is reduced. +Default value is 1. Allowed range is from 0 to 1. +

+
+
block
+

Set size of block, Default is 4, can be 3, 4, 5 or 6. +Actual size of block in pixels is 2 to power of block, so by default +block size in pixels is 2^4 which is 16. +

+
+
overlap
+

Set block overlap. Default is 0.5. Allowed range is from 0.2 to 0.8. +

+
+
prev
+

Set number of previous frames to use for denoising. By default is set to 0. +

+
+
next
+

Set number of next frames to to use for denoising. By default is set to 0. +

+
+
planes
+

Set planes which will be filtered, by default are all available filtered +except alpha. +

+
+ + +

32.70 fftfilt

+

Apply arbitrary expressions to samples in frequency domain +

+
+
dc_Y
+

Adjust the dc value (gain) of the luma plane of the image. The filter +accepts an integer value in range 0 to 1000. The default +value is set to 0. +

+
+
dc_U
+

Adjust the dc value (gain) of the 1st chroma plane of the image. The +filter accepts an integer value in range 0 to 1000. The +default value is set to 0. +

+
+
dc_V
+

Adjust the dc value (gain) of the 2nd chroma plane of the image. The +filter accepts an integer value in range 0 to 1000. The +default value is set to 0. +

+
+
weight_Y
+

Set the frequency domain weight expression for the luma plane. +

+
+
weight_U
+

Set the frequency domain weight expression for the 1st chroma plane. +

+
+
weight_V
+

Set the frequency domain weight expression for the 2nd chroma plane. +

+
+
eval
+

Set when the expressions are evaluated. +

+

It accepts the following values: +

+
‘init’
+

Only evaluate expressions once during the filter initialization. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. +

+
+ +

Default value is ‘init’. +

+

The filter accepts the following variables: +

+
X
+
Y
+

The coordinates of the current sample. +

+
+
W
+
H
+

The width and height of the image. +

+
+
N
+

The number of input frame, starting from 0. +

+
+ + +

32.70.1 Examples

+ +
    +
  • High-pass: +
    +
    fftfilt=dc_Y=128:weight_Y='squish(1-(Y+X)/100)'
+
    + +
  • Low-pass: +
    +
    fftfilt=dc_Y=0:weight_Y='squish((Y+X)/100-1)'
+
    + +
  • Sharpen: +
    +
    fftfilt=dc_Y=0:weight_Y='1+squish(1-(Y+X)/100)'
+
    + +
  • Blur: +
    +
    fftfilt=dc_Y=0:weight_Y='exp(-4 * ((Y+X)/(W+H)))'
+
    + +
+ + +

32.71 field

+ +

Extract a single field from an interlaced image using stride +arithmetic to avoid wasting CPU time. The output frames are marked as +non-interlaced. +

+

The filter accepts the following options: +

+
+
type
+

Specify whether to extract the top (if the value is 0 or +top) or the bottom field (if the value is 1 or +bottom). +

+
+ + +

32.72 fieldhint

+ +

Create new frames by copying the top and bottom fields from surrounding frames +supplied as numbers by the hint file. +

+
+
hint
+

Set file containing hints: absolute/relative frame numbers. +

+

There must be one line for each frame in a clip. Each line must contain two +numbers separated by the comma, optionally followed by - or +. +Numbers supplied on each line of file can not be out of [N-1,N+1] where N +is current frame number for absolute mode or out of [-1, 1] range +for relative mode. First number tells from which frame to pick up top +field and second number tells from which frame to pick up bottom field. +

+

If optionally followed by + output frame will be marked as interlaced, +else if followed by - output frame will be marked as progressive, else +it will be marked same as input frame. +If optionally followed by t output frame will use only top field, or in +case of b it will use only bottom field. +If line starts with # or ; that line is skipped. +

+
+
mode
+

Can be item absolute or relative. Default is absolute. +

+
+ +

Example of first several lines of hint file for relative mode: +

+
0,0 - # first frame
+1,0 - # second frame, use third's frame top field and second's frame bottom field
+1,0 - # third frame, use fourth's frame top field and third's frame bottom field
+1,0 -
+0,0 -
+0,0 -
+1,0 -
+1,0 -
+1,0 -
+0,0 -
+0,0 -
+1,0 -
+1,0 -
+1,0 -
+0,0 -
+
+ + +

32.73 fieldmatch

+ +

Field matching filter for inverse telecine. It is meant to reconstruct the +progressive frames from a telecined stream. The filter does not drop duplicated +frames, so to achieve a complete inverse telecine fieldmatch needs to be +followed by a decimation filter such as decimate in the filtergraph. +

+

The separation of the field matching and the decimation is notably motivated by +the possibility of inserting a de-interlacing filter fallback between the two. +If the source has mixed telecined and real interlaced content, +fieldmatch will not be able to match fields for the interlaced parts. +But these remaining combed frames will be marked as interlaced, and thus can be +de-interlaced by a later filter such as yadif before decimation. +

+

In addition to the various configuration options, fieldmatch can take an +optional second stream, activated through the ppsrc option. If +enabled, the frames reconstruction will be based on the fields and frames from +this second stream. This allows the first input to be pre-processed in order to +help the various algorithms of the filter, while keeping the output lossless +(assuming the fields are matched properly). Typically, a field-aware denoiser, +or brightness/contrast adjustments can help. +

+

Note that this filter uses the same algorithms as TIVTC/TFM (AviSynth project) +and VIVTC/VFM (VapourSynth project). The later is a light clone of TFM from +which fieldmatch is based on. While the semantic and usage are very +close, some behaviour and options names can differ. +

+

The decimate filter currently only works for constant frame rate input. +If your input has mixed telecined (30fps) and progressive content with a lower +framerate like 24fps use the following filterchain to produce the necessary cfr +stream: dejudder,fps=30000/1001,fieldmatch,decimate. +

+

The filter accepts the following options: +

+
+
order
+

Specify the assumed field order of the input stream. Available values are: +

+
+
‘auto’
+

Auto detect parity (use FFmpeg’s internal parity value). +

+
‘bff’
+

Assume bottom field first. +

+
‘tff’
+

Assume top field first. +

+
+ +

Note that it is sometimes recommended not to trust the parity announced by the +stream. +

+

Default value is auto. +

+
+
mode
+

Set the matching mode or strategy to use. pc mode is the safest in the +sense that it won’t risk creating jerkiness due to duplicate frames when +possible, but if there are bad edits or blended fields it will end up +outputting combed frames when a good match might actually exist. On the other +hand, pcn_ub mode is the most risky in terms of creating jerkiness, +but will almost always find a good frame if there is one. The other values are +all somewhere in between pc and pcn_ub in terms of risking +jerkiness and creating duplicate frames versus finding good matches in sections +with bad edits, orphaned fields, blended fields, etc. +

+

More details about p/c/n/u/b are available in p/c/n/u/b meaning section. +

+

Available values are: +

+
+
‘pc’
+

2-way matching (p/c) +

+
‘pc_n’
+

2-way matching, and trying 3rd match if still combed (p/c + n) +

+
‘pc_u’
+

2-way matching, and trying 3rd match (same order) if still combed (p/c + u) +

+
‘pc_n_ub’
+

2-way matching, trying 3rd match if still combed, and trying 4th/5th matches if +still combed (p/c + n + u/b) +

+
‘pcn’
+

3-way matching (p/c/n) +

+
‘pcn_ub’
+

3-way matching, and trying 4th/5th matches if all 3 of the original matches are +detected as combed (p/c/n + u/b) +

+
+ +

The parenthesis at the end indicate the matches that would be used for that +mode assuming order=tff (and field on auto or +top). +

+

In terms of speed pc mode is by far the fastest and pcn_ub is +the slowest. +

+

Default value is pc_n. +

+
+
ppsrc
+

Mark the main input stream as a pre-processed input, and enable the secondary +input stream as the clean source to pick the fields from. See the filter +introduction for more details. It is similar to the clip2 feature from +VFM/TFM. +

+

Default value is 0 (disabled). +

+
+
field
+

Set the field to match from. It is recommended to set this to the same value as +order unless you experience matching failures with that setting. In +certain circumstances changing the field that is used to match from can have a +large impact on matching performance. Available values are: +

+
+
‘auto’
+

Automatic (same value as order). +

+
‘bottom’
+

Match from the bottom field. +

+
‘top’
+

Match from the top field. +

+
+ +

Default value is auto. +

+
+
mchroma
+

Set whether or not chroma is included during the match comparisons. In most +cases it is recommended to leave this enabled. You should set this to 0 +only if your clip has bad chroma problems such as heavy rainbowing or other +artifacts. Setting this to 0 could also be used to speed things up at +the cost of some accuracy. +

+

Default value is 1. +

+
+
y0
+
y1
+

These define an exclusion band which excludes the lines between y0 and +y1 from being included in the field matching decision. An exclusion +band can be used to ignore subtitles, a logo, or other things that may +interfere with the matching. y0 sets the starting scan line and +y1 sets the ending line; all lines in between y0 and +y1 (including y0 and y1) will be ignored. Setting +y0 and y1 to the same value will disable the feature. +y0 and y1 defaults to 0. +

+
+
scthresh
+

Set the scene change detection threshold as a percentage of maximum change on +the luma plane. Good values are in the [8.0, 14.0] range. Scene change +detection is only relevant in case combmatch=sc. The range for +scthresh is [0.0, 100.0]. +

+

Default value is 12.0. +

+
+
combmatch
+

When combatch is not none, fieldmatch will take into +account the combed scores of matches when deciding what match to use as the +final match. Available values are: +

+
+
‘none’
+

No final matching based on combed scores. +

+
‘sc’
+

Combed scores are only used when a scene change is detected. +

+
‘full’
+

Use combed scores all the time. +

+
+ +

Default is sc. +

+
+
combdbg
+

Force fieldmatch to calculate the combed metrics for certain matches and +print them. This setting is known as micout in TFM/VFM vocabulary. +Available values are: +

+
+
‘none’
+

No forced calculation. +

+
‘pcn’
+

Force p/c/n calculations. +

+
‘pcnub’
+

Force p/c/n/u/b calculations. +

+
+ +

Default value is none. +

+
+
cthresh
+

This is the area combing threshold used for combed frame detection. This +essentially controls how "strong" or "visible" combing must be to be detected. +Larger values mean combing must be more visible and smaller values mean combing +can be less visible or strong and still be detected. Valid settings are from +-1 (every pixel will be detected as combed) to 255 (no pixel will +be detected as combed). This is basically a pixel difference value. A good +range is [8, 12]. +

+

Default value is 9. +

+
+
chroma
+

Sets whether or not chroma is considered in the combed frame decision. Only +disable this if your source has chroma problems (rainbowing, etc.) that are +causing problems for the combed frame detection with chroma enabled. Actually, +using chroma=0 is usually more reliable, except for the case +where there is chroma only combing in the source. +

+

Default value is 0. +

+
+
blockx
+
blocky
+

Respectively set the x-axis and y-axis size of the window used during combed +frame detection. This has to do with the size of the area in which +combpel pixels are required to be detected as combed for a frame to be +declared combed. See the combpel parameter description for more info. +Possible values are any number that is a power of 2 starting at 4 and going up +to 512. +

+

Default value is 16. +

+
+
combpel
+

The number of combed pixels inside any of the blocky by +blockx size blocks on the frame for the frame to be detected as +combed. While cthresh controls how "visible" the combing must be, this +setting controls "how much" combing there must be in any localized area (a +window defined by the blockx and blocky settings) on the +frame. Minimum value is 0 and maximum is blocky x blockx (at +which point no frames will ever be detected as combed). This setting is known +as MI in TFM/VFM vocabulary. +

+

Default value is 80. +

+
+ + +

32.73.1 p/c/n/u/b meaning

+ + +

32.73.1.1 p/c/n

+ +

We assume the following telecined stream: +

+
+
Top fields:     1 2 2 3 4
+Bottom fields:  1 2 3 4 4
+
+ +

The numbers correspond to the progressive frame the fields relate to. Here, the +first two frames are progressive, the 3rd and 4th are combed, and so on. +

+

When fieldmatch is configured to run a matching from bottom +(field=bottom) this is how this input stream get transformed: +

+
+
Input stream:
+                T     1 2 2 3 4
+                B     1 2 3 4 4   <-- matching reference
+
+Matches:              c c n n c
+
+Output stream:
+                T     1 2 3 4 4
+                B     1 2 3 4 4
+
+ +

As a result of the field matching, we can see that some frames get duplicated. +To perform a complete inverse telecine, you need to rely on a decimation filter +after this operation. See for instance the decimate filter. +

+

The same operation now matching from top fields (field=top) +looks like this: +

+
+
Input stream:
+                T     1 2 2 3 4   <-- matching reference
+                B     1 2 3 4 4
+
+Matches:              c c p p c
+
+Output stream:
+                T     1 2 2 3 4
+                B     1 2 2 3 4
+
+ +

In these examples, we can see what p, c and n mean; +basically, they refer to the frame and field of the opposite parity: +

+
    +
  • p matches the field of the opposite parity in the previous frame +
  • c matches the field of the opposite parity in the current frame +
  • n matches the field of the opposite parity in the next frame +
+ + +

32.73.1.2 u/b

+ +

The u and b matching are a bit special in the sense that they match +from the opposite parity flag. In the following examples, we assume that we are +currently matching the 2nd frame (Top:2, bottom:2). According to the match, a +’x’ is placed above and below each matched fields. +

+

With bottom matching (field=bottom): +

+
Match:           c         p           n          b          u
+
+                 x       x               x        x          x
+  Top          1 2 2     1 2 2       1 2 2      1 2 2      1 2 2
+  Bottom       1 2 3     1 2 3       1 2 3      1 2 3      1 2 3
+                 x         x           x        x              x
+
+Output frames:
+                 2          1          2          2          2
+                 2          2          2          1          3
+
+ +

With top matching (field=top): +

+
Match:           c         p           n          b          u
+
+                 x         x           x        x              x
+  Top          1 2 2     1 2 2       1 2 2      1 2 2      1 2 2
+  Bottom       1 2 3     1 2 3       1 2 3      1 2 3      1 2 3
+                 x       x               x        x          x
+
+Output frames:
+                 2          2          2          1          2
+                 2          1          3          2          2
+
+ + +

32.73.2 Examples

+ +

Simple IVTC of a top field first telecined stream: +

+
fieldmatch=order=tff:combmatch=none, decimate
+
+ +

Advanced IVTC, with fallback on yadif for still combed frames: +

+
fieldmatch=order=tff:combmatch=full, yadif=deint=interlaced, decimate
+
+ + +

32.74 fieldorder

+ +

Transform the field order of the input video. +

+

It accepts the following parameters: +

+
+
order
+

The output field order. Valid values are tff for top field first or bff +for bottom field first. +

+
+ +

The default value is ‘tff’. +

+

The transformation is done by shifting the picture content up or down +by one line, and filling the remaining line with appropriate picture content. +This method is consistent with most broadcast field order converters. +

+

If the input video is not flagged as being interlaced, or it is already +flagged as being of the required output field order, then this filter does +not alter the incoming video. +

+

It is very useful when converting to or from PAL DV material, +which is bottom field first. +

+

For example: +

+
ffmpeg -i in.vob -vf "fieldorder=bff" out.dv
+
+ + +

32.75 fifo, afifo

+ +

Buffer input images and send them when they are requested. +

+

It is mainly useful when auto-inserted by the libavfilter +framework. +

+

It does not take parameters. +

+ +

32.76 fillborders

+ +

Fill borders of the input video, without changing video stream dimensions. +Sometimes video can have garbage at the four edges and you may not want to +crop video input to keep size multiple of some number. +

+

This filter accepts the following options: +

+
+
left
+

Number of pixels to fill from left border. +

+
+
right
+

Number of pixels to fill from right border. +

+
+
top
+

Number of pixels to fill from top border. +

+
+
bottom
+

Number of pixels to fill from bottom border. +

+
+
mode
+

Set fill mode. +

+

It accepts the following values: +

+
‘smear’
+

fill pixels using outermost pixels +

+
+
‘mirror’
+

fill pixels using mirroring +

+
+
‘fixed’
+

fill pixels with constant value +

+
+ +

Default is smear. +

+
+
color
+

Set color for pixels in fixed mode. Default is black. +

+
+ + +

32.76.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.77 find_rect

+ +

Find a rectangular object +

+

It accepts the following options: +

+
+
object
+

Filepath of the object image, needs to be in gray8. +

+
+
threshold
+

Detection threshold, default is 0.5. +

+
+
mipmaps
+

Number of mipmaps, default is 3. +

+
+
xmin, ymin, xmax, ymax
+

Specifies the rectangle in which to search. +

+
+ + +

32.77.1 Examples

+ +
    +
  • Cover a rectangular object by the supplied image of a given video using ffmpeg: +
    +
    ffmpeg -i file.ts -vf find_rect=newref.pgm,cover_rect=cover.jpg:mode=cover new.mkv
+
    +
+ + +

32.78 floodfill

+ +

Flood area with values of same pixel components with another values. +

+

It accepts the following options: +

+
x
+

Set pixel x coordinate. +

+
+
y
+

Set pixel y coordinate. +

+
+
s0
+

Set source #0 component value. +

+
+
s1
+

Set source #1 component value. +

+
+
s2
+

Set source #2 component value. +

+
+
s3
+

Set source #3 component value. +

+
+
d0
+

Set destination #0 component value. +

+
+
d1
+

Set destination #1 component value. +

+
+
d2
+

Set destination #2 component value. +

+
+
d3
+

Set destination #3 component value. +

+
+ + +

32.79 format

+ +

Convert the input video to one of the specified pixel formats. +Libavfilter will try to pick one that is suitable as input to +the next filter. +

+

It accepts the following parameters: +

+
pix_fmts
+

A ’|’-separated list of pixel format names, such as +"pix_fmts=yuv420p|monow|rgb24". +

+
+
+ + +

32.79.1 Examples

+ +
    +
  • Convert the input video to the yuv420p format +
    +
    format=pix_fmts=yuv420p
+
    + +

    Convert the input video to any of the formats in the list +

    +
    format=pix_fmts=yuv420p|yuv444p|yuv410p
+
    +
+ + +

32.80 fps

+ +

Convert the video to specified constant frame rate by duplicating or dropping +frames as necessary. +

+

It accepts the following parameters: +

+
fps
+

The desired output frame rate. The default is 25. +

+
+
start_time
+

Assume the first PTS should be the given value, in seconds. This allows for +padding/trimming at the start of stream. By default, no assumption is made +about the first frame’s expected PTS, so no padding or trimming is done. +For example, this could be set to 0 to pad the beginning with duplicates of +the first frame if a video stream starts after the audio stream or to trim any +frames with a negative PTS. +

+
+
round
+

Timestamp (PTS) rounding method. +

+

Possible values are: +

+
zero
+

round towards 0 +

+
inf
+

round away from 0 +

+
down
+

round towards -infinity +

+
up
+

round towards +infinity +

+
near
+

round to nearest +

+
+

The default is near. +

+
+
eof_action
+

Action performed when reading the last frame. +

+

Possible values are: +

+
round
+

Use same timestamp rounding method as used for other frames. +

+
pass
+

Pass through last frame if input duration has not been reached yet. +

+
+

The default is round. +

+
+
+ +

Alternatively, the options can be specified as a flat string: +fps[:start_time[:round]]. +

+

See also the setpts filter. +

+ +

32.80.1 Examples

+ +
    +
  • A typical usage in order to set the fps to 25: +
    +
    fps=fps=25
+
    + +
  • Sets the fps to 24, using abbreviation and rounding method to round to nearest: +
    +
    fps=fps=film:round=near
+
    +
+ + +

32.81 framepack

+ +

Pack two different video streams into a stereoscopic video, setting proper +metadata on supported codecs. The two views should have the same size and +framerate and processing will stop when the shorter video ends. Please note +that you may conveniently adjust view properties with the scale and +fps filters. +

+

It accepts the following parameters: +

+
format
+

The desired packing format. Supported values are: +

+
+
sbs
+

The views are next to each other (default). +

+
+
tab
+

The views are on top of each other. +

+
+
lines
+

The views are packed by line. +

+
+
columns
+

The views are packed by column. +

+
+
frameseq
+

The views are temporally interleaved. +

+
+
+ +
+
+ +

Some examples: +

+
+
# Convert left and right views into a frame-sequential video
+ffmpeg -i LEFT -i RIGHT -filter_complex framepack=frameseq OUTPUT
+
+# Convert views into a side-by-side video with the same output resolution as the input
+ffmpeg -i LEFT -i RIGHT -filter_complex [0:v]scale=w=iw/2[left],[1:v]scale=w=iw/2[right],[left][right]framepack=sbs OUTPUT
+
+ + +

32.82 framerate

+ +

Change the frame rate by interpolating new video output frames from the source +frames. +

+

This filter is not designed to function correctly with interlaced media. If +you wish to change the frame rate of interlaced media then you are required +to deinterlace before this filter and re-interlace after this filter. +

+

A description of the accepted options follows. +

+
+
fps
+

Specify the output frames per second. This option can also be specified +as a value alone. The default is 50. +

+
+
interp_start
+

Specify the start of a range where the output frame will be created as a +linear interpolation of two frames. The range is [0-255], +the default is 15. +

+
+
interp_end
+

Specify the end of a range where the output frame will be created as a +linear interpolation of two frames. The range is [0-255], +the default is 240. +

+
+
scene
+

Specify the level at which a scene change is detected as a value between +0 and 100 to indicate a new scene; a low value reflects a low +probability for the current frame to introduce a new scene, while a higher +value means the current frame is more likely to be one. +The default is 8.2. +

+
+
flags
+

Specify flags influencing the filter process. +

+

Available value for flags is: +

+
+
scene_change_detect, scd
+

Enable scene change detection using the value of the option scene. +This flag is enabled by default. +

+
+
+
+ + +

32.83 framestep

+ +

Select one frame every N-th frame. +

+

This filter accepts the following option: +

+
step
+

Select frame after every step frames. +Allowed values are positive integers higher than 0. Default value is 1. +

+
+ + +

32.84 freezedetect

+ +

Detect frozen video. +

+

This filter logs a message and sets frame metadata when it detects that the +input video has no significant change in content during a specified duration. +Video freeze detection calculates the mean average absolute difference of all +the components of video frames and compares it to a noise floor. +

+

The printed times and duration are expressed in seconds. The +lavfi.freezedetect.freeze_start metadata key is set on the first frame +whose timestamp equals or exceeds the detection duration and it contains the +timestamp of the first frame of the freeze. The +lavfi.freezedetect.freeze_duration and +lavfi.freezedetect.freeze_end metadata keys are set on the first frame +after the freeze. +

+

The filter accepts the following options: +

+
+
noise, n
+

Set noise tolerance. Can be specified in dB (in case "dB" is appended to the +specified value) or as a difference ratio between 0 and 1. Default is -60dB, or +0.001. +

+
+
duration, d
+

Set freeze duration until notification (default is 2 seconds). +

+
+ + +

32.85 freezeframes

+ +

Freeze video frames. +

+

This filter freezes video frames using frame from 2nd input. +

+

The filter accepts the following options: +

+
+
first
+

Set number of first frame from which to start freeze. +

+
+
last
+

Set number of last frame from which to end freeze. +

+
+
replace
+

Set number of frame from 2nd input which will be used instead of replaced frames. +

+
+ + +

32.86 frei0r

+ +

Apply a frei0r effect to the input video. +

+

To enable the compilation of this filter, you need to install the frei0r +header and configure FFmpeg with --enable-frei0r. +

+

It accepts the following parameters: +

+
+
filter_name
+

The name of the frei0r effect to load. If the environment variable +FREI0R_PATH is defined, the frei0r effect is searched for in each of the +directories specified by the colon-separated list in FREI0R_PATH. +Otherwise, the standard frei0r paths are searched, in this order: +HOME/.frei0r-1/lib/, /usr/local/lib/frei0r-1/, +/usr/lib/frei0r-1/. +

+
+
filter_params
+

A ’|’-separated list of parameters to pass to the frei0r effect. +

+
+
+ +

A frei0r effect parameter can be a boolean (its value is either +"y" or "n"), a double, a color (specified as +R/G/B, where R, G, and B are floating point +numbers between 0.0 and 1.0, inclusive) or a color description as specified in the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual, +a position (specified as X/Y, where +X and Y are floating point numbers) and/or a string. +

+

The number and types of parameters depend on the loaded effect. If an +effect parameter is not specified, the default value is set. +

+ +

32.86.1 Examples

+ +
    +
  • Apply the distort0r effect, setting the first two double parameters: +
    +
    frei0r=filter_name=distort0r:filter_params=0.5|0.01
+
    + +
  • Apply the colordistance effect, taking a color as the first parameter: +
    +
    frei0r=colordistance:0.2/0.3/0.4
+frei0r=colordistance:violet
+frei0r=colordistance:0x112233
+
    + +
  • Apply the perspective effect, specifying the top left and top right image +positions: +
    +
    frei0r=perspective:0.2/0.2|0.8/0.2
+
    +
+ +

For more information, see +http://frei0r.dyne.org +

+ +

32.87 fspp

+ +

Apply fast and simple postprocessing. It is a faster version of spp. +

+

It splits (I)DCT into horizontal/vertical passes. Unlike the simple post- +processing filter, one of them is performed once per block, not per pixel. +This allows for much higher speed. +

+

The filter accepts the following options: +

+
+
quality
+

Set quality. This option defines the number of levels for averaging. It accepts +an integer in the range 4-5. Default value is 4. +

+
+
qp
+

Force a constant quantization parameter. It accepts an integer in range 0-63. +If not set, the filter will use the QP from the video stream (if available). +

+
+
strength
+

Set filter strength. It accepts an integer in range -15 to 32. Lower values mean +more details but also more artifacts, while higher values make the image smoother +but also blurrier. Default value is 0 − PSNR optimal. +

+
+
use_bframe_qp
+

Enable the use of the QP from the B-Frames if set to 1. Using this +option may cause flicker since the B-Frames have often larger QP. Default is +0 (not enabled). +

+
+
+ + +

32.88 gblur

+ +

Apply Gaussian blur filter. +

+

The filter accepts the following options: +

+
+
sigma
+

Set horizontal sigma, standard deviation of Gaussian blur. Default is 0.5. +

+
+
steps
+

Set number of steps for Gaussian approximation. Default is 1. +

+
+
planes
+

Set which planes to filter. By default all planes are filtered. +

+
+
sigmaV
+

Set vertical sigma, if negative it will be same as sigma. +Default is -1. +

+
+ + +

32.88.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.89 geq

+ +

Apply generic equation to each pixel. +

+

The filter accepts the following options: +

+
+
lum_expr, lum
+

Set the luminance expression. +

+
cb_expr, cb
+

Set the chrominance blue expression. +

+
cr_expr, cr
+

Set the chrominance red expression. +

+
alpha_expr, a
+

Set the alpha expression. +

+
red_expr, r
+

Set the red expression. +

+
green_expr, g
+

Set the green expression. +

+
blue_expr, b
+

Set the blue expression. +

+
+ +

The colorspace is selected according to the specified options. If one +of the lum_expr, cb_expr, or cr_expr +options is specified, the filter will automatically select a YCbCr +colorspace. If one of the red_expr, green_expr, or +blue_expr options is specified, it will select an RGB +colorspace. +

+

If one of the chrominance expression is not defined, it falls back on the other +one. If no alpha expression is specified it will evaluate to opaque value. +If none of chrominance expressions are specified, they will evaluate +to the luminance expression. +

+

The expressions can use the following variables and functions: +

+
+
N
+

The sequential number of the filtered frame, starting from 0. +

+
+
X
+
Y
+

The coordinates of the current sample. +

+
+
W
+
H
+

The width and height of the image. +

+
+
SW
+
SH
+

Width and height scale depending on the currently filtered plane. It is the +ratio between the corresponding luma plane number of pixels and the current +plane ones. E.g. for YUV4:2:0 the values are 1,1 for the luma plane, and +0.5,0.5 for chroma planes. +

+
+
T
+

Time of the current frame, expressed in seconds. +

+
+
p(x, y)
+

Return the value of the pixel at location (x,y) of the current +plane. +

+
+
lum(x, y)
+

Return the value of the pixel at location (x,y) of the luminance +plane. +

+
+
cb(x, y)
+

Return the value of the pixel at location (x,y) of the +blue-difference chroma plane. Return 0 if there is no such plane. +

+
+
cr(x, y)
+

Return the value of the pixel at location (x,y) of the +red-difference chroma plane. Return 0 if there is no such plane. +

+
+
r(x, y)
+
g(x, y)
+
b(x, y)
+

Return the value of the pixel at location (x,y) of the +red/green/blue component. Return 0 if there is no such component. +

+
+
alpha(x, y)
+

Return the value of the pixel at location (x,y) of the alpha +plane. Return 0 if there is no such plane. +

+
+
psum(x,y), lumsum(x, y), cbsum(x,y), crsum(x,y), rsum(x,y), gsum(x,y), bsum(x,y), alphasum(x,y)
+

Sum of sample values in the rectangle from (0,0) to (x,y), this allows obtaining +sums of samples within a rectangle. See the functions without the sum postfix. +

+
+
interpolation
+

Set one of interpolation methods: +

+
nearest, n
+
bilinear, b
+
+

Default is bilinear. +

+
+ +

For functions, if x and y are outside the area, the value will be +automatically clipped to the closer edge. +

+

Please note that this filter can use multiple threads in which case each slice +will have its own expression state. If you want to use only a single expression +state because your expressions depend on previous state then you should limit +the number of filter threads to 1. +

+ +

32.89.1 Examples

+ +
    +
  • Flip the image horizontally: +
    +
    geq=p(W-X\,Y)
+
    + +
  • Generate a bidimensional sine wave, with angle PI/3 and a +wavelength of 100 pixels: +
    +
    geq=128 + 100*sin(2*(PI/100)*(cos(PI/3)*(X-50*T) + sin(PI/3)*Y)):128:128
+
    + +
  • Generate a fancy enigmatic moving light: +
    +
    nullsrc=s=256x256,geq=random(1)/hypot(X-cos(N*0.07)*W/2-W/2\,Y-sin(N*0.09)*H/2-H/2)^2*1000000*sin(N*0.02):128:128
+
    + +
  • Generate a quick emboss effect: +
    +
    format=gray,geq=lum_expr='(p(X,Y)+(256-p(X-4,Y-4)))/2'
+
    + +
  • Modify RGB components depending on pixel position: +
    +
    geq=r='X/W*r(X,Y)':g='(1-X/W)*g(X,Y)':b='(H-Y)/H*b(X,Y)'
+
    + +
  • Create a radial gradient that is the same size as the input (also see +the vignette filter): +
    +
    geq=lum=255*gauss((X/W-0.5)*3)*gauss((Y/H-0.5)*3)/gauss(0)/gauss(0),format=gray
+
    +
+ + +

32.90 gradfun

+ +

Fix the banding artifacts that are sometimes introduced into nearly flat +regions by truncation to 8-bit color depth. +Interpolate the gradients that should go where the bands are, and +dither them. +

+

It is designed for playback only. Do not use it prior to +lossy compression, because compression tends to lose the dither and +bring back the bands. +

+

It accepts the following parameters: +

+
+
strength
+

The maximum amount by which the filter will change any one pixel. This is also +the threshold for detecting nearly flat regions. Acceptable values range from +.51 to 64; the default value is 1.2. Out-of-range values will be clipped to the +valid range. +

+
+
radius
+

The neighborhood to fit the gradient to. A larger radius makes for smoother +gradients, but also prevents the filter from modifying the pixels near detailed +regions. Acceptable values are 8-32; the default value is 16. Out-of-range +values will be clipped to the valid range. +

+
+
+ +

Alternatively, the options can be specified as a flat string: +strength[:radius] +

+ +

32.90.1 Examples

+ +
    +
  • Apply the filter with a 3.5 strength and radius of 8: +
    +
    gradfun=3.5:8
+
    + +
  • Specify radius, omitting the strength (which will fall-back to the default +value): +
    +
    gradfun=radius=8
+
    + +
+ + +

32.91 graphmonitor

+

Show various filtergraph stats. +

+

With this filter one can debug complete filtergraph. +Especially issues with links filling with queued frames. +

+

The filter accepts the following options: +

+
+
size, s
+

Set video output size. Default is hd720. +

+
+
opacity, o
+

Set video opacity. Default is 0.9. Allowed range is from 0 to 1. +

+
+
mode, m
+

Set output mode, can be fulll or compact. +In compact mode only filters with some queued frames have displayed stats. +

+
+
flags, f
+

Set flags which enable which stats are shown in video. +

+

Available values for flags are: +

+
‘queue’
+

Display number of queued frames in each link. +

+
+
‘frame_count_in’
+

Display number of frames taken from filter. +

+
+
‘frame_count_out’
+

Display number of frames given out from filter. +

+
+
‘pts’
+

Display current filtered frame pts. +

+
+
‘time’
+

Display current filtered frame time. +

+
+
‘timebase’
+

Display time base for filter link. +

+
+
‘format’
+

Display used format for filter link. +

+
+
‘size’
+

Display video size or number of audio channels in case of audio used by filter link. +

+
+
‘rate’
+

Display video frame rate or sample rate in case of audio used by filter link. +

+
+ +
+
rate, r
+

Set upper limit for video rate of output stream, Default value is 25. +This guarantee that output video frame rate will not be higher than this value. +

+
+ + +

32.92 greyedge

+

A color constancy variation filter which estimates scene illumination via grey edge algorithm +and corrects the scene colors accordingly. +

+

See: https://staff.science.uva.nl/th.gevers/pub/GeversTIP07.pdf +

+

The filter accepts the following options: +

+
+
difford
+

The order of differentiation to be applied on the scene. Must be chosen in the range +[0,2] and default value is 1. +

+
+
minknorm
+

The Minkowski parameter to be used for calculating the Minkowski distance. Must +be chosen in the range [0,20] and default value is 1. Set to 0 for getting +max value instead of calculating Minkowski distance. +

+
+
sigma
+

The standard deviation of Gaussian blur to be applied on the scene. Must be +chosen in the range [0,1024.0] and default value = 1. floor( sigma * break_off_sigma(3) ) +can’t be equal to 0 if difford is greater than 0. +

+
+ + +

32.92.1 Examples

+
    +
  • Grey Edge: +
    +
    greyedge=difford=1:minknorm=5:sigma=2
+
    + +
  • Max Edge: +
    +
    greyedge=difford=1:minknorm=0:sigma=2
+
    + +
+ + +

32.93 haldclut

+ +

Apply a Hald CLUT to a video stream. +

+

First input is the video stream to process, and second one is the Hald CLUT. +The Hald CLUT input can be a simple picture or a complete video stream. +

+

The filter accepts the following options: +

+
+
shortest
+

Force termination when the shortest input terminates. Default is 0. +

+
repeatlast
+

Continue applying the last CLUT after the end of the stream. A value of +0 disable the filter after the last frame of the CLUT is reached. +Default is 1. +

+
+ +

haldclut also has the same interpolation options as lut3d (both +filters share the same internals). +

+

This filter also supports the framesync options. +

+

More information about the Hald CLUT can be found on Eskil Steenberg’s website +(Hald CLUT author) at http://www.quelsolaar.com/technology/clut.html. +

+ +

32.93.1 Workflow examples

+ + +

32.93.1.1 Hald CLUT video stream

+ +

Generate an identity Hald CLUT stream altered with various effects: +

+
ffmpeg -f lavfi -i haldclutsrc=8 -vf "hue=H=2*PI*t:s=sin(2*PI*t)+1, curves=cross_process" -t 10 -c:v ffv1 clut.nut
+
+ +

Note: make sure you use a lossless codec. +

+

Then use it with haldclut to apply it on some random stream: +

+
ffmpeg -f lavfi -i mandelbrot -i clut.nut -filter_complex '[0][1] haldclut' -t 20 mandelclut.mkv
+
+ +

The Hald CLUT will be applied to the 10 first seconds (duration of +clut.nut), then the latest picture of that CLUT stream will be applied +to the remaining frames of the mandelbrot stream. +

+ +

32.93.1.2 Hald CLUT with preview

+ +

A Hald CLUT is supposed to be a squared image of Level*Level*Level by +Level*Level*Level pixels. For a given Hald CLUT, FFmpeg will select the +biggest possible square starting at the top left of the picture. The remaining +padding pixels (bottom or right) will be ignored. This area can be used to add +a preview of the Hald CLUT. +

+

Typically, the following generated Hald CLUT will be supported by the +haldclut filter: +

+
+
ffmpeg -f lavfi -i haldclutsrc=8 -vf "
+   pad=iw+320 [padded_clut];
+   smptebars=s=320x256, split [a][b];
+   [padded_clut][a] overlay=W-320:h, curves=color_negative [main];
+   [main][b] overlay=W-320" -frames:v 1 clut.png
+
+ +

It contains the original and a preview of the effect of the CLUT: SMPTE color +bars are displayed on the right-top, and below the same color bars processed by +the color changes. +

+

Then, the effect of this Hald CLUT can be visualized with: +

+
ffplay input.mkv -vf "movie=clut.png, [in] haldclut"
+
+ + +

32.94 hflip

+ +

Flip the input video horizontally. +

+

For example, to horizontally flip the input video with ffmpeg: +

+
ffmpeg -i in.avi -vf "hflip" out.avi
+
+ + +

32.95 histeq

+

This filter applies a global color histogram equalization on a +per-frame basis. +

+

It can be used to correct video that has a compressed range of pixel +intensities. The filter redistributes the pixel intensities to +equalize their distribution across the intensity range. It may be +viewed as an "automatically adjusting contrast filter". This filter is +useful only for correcting degraded or poorly captured source +video. +

+

The filter accepts the following options: +

+
+
strength
+

Determine the amount of equalization to be applied. As the strength +is reduced, the distribution of pixel intensities more-and-more +approaches that of the input frame. The value must be a float number +in the range [0,1] and defaults to 0.200. +

+
+
intensity
+

Set the maximum intensity that can generated and scale the output +values appropriately. The strength should be set as desired and then +the intensity can be limited if needed to avoid washing-out. The value +must be a float number in the range [0,1] and defaults to 0.210. +

+
+
antibanding
+

Set the antibanding level. If enabled the filter will randomly vary +the luminance of output pixels by a small amount to avoid banding of +the histogram. Possible values are none, weak or +strong. It defaults to none. +

+
+ + +

32.96 histogram

+ +

Compute and draw a color distribution histogram for the input video. +

+

The computed histogram is a representation of the color component +distribution in an image. +

+

Standard histogram displays the color components distribution in an image. +Displays color graph for each color component. Shows distribution of +the Y, U, V, A or R, G, B components, depending on input format, in the +current frame. Below each graph a color component scale meter is shown. +

+

The filter accepts the following options: +

+
+
level_height
+

Set height of level. Default value is 200. +Allowed range is [50, 2048]. +

+
+
scale_height
+

Set height of color scale. Default value is 12. +Allowed range is [0, 40]. +

+
+
display_mode
+

Set display mode. +It accepts the following values: +

+
‘stack’
+

Per color component graphs are placed below each other. +

+
+
‘parade’
+

Per color component graphs are placed side by side. +

+
+
‘overlay’
+

Presents information identical to that in the parade, except +that the graphs representing color components are superimposed directly +over one another. +

+
+

Default is stack. +

+
+
levels_mode
+

Set mode. Can be either linear, or logarithmic. +Default is linear. +

+
+
components
+

Set what color components to display. +Default is 7. +

+
+
fgopacity
+

Set foreground opacity. Default is 0.7. +

+
+
bgopacity
+

Set background opacity. Default is 0.5. +

+
+ + +

32.96.1 Examples

+ +
    +
  • Calculate and draw histogram: +
    +
    ffplay -i input -vf histogram
+
    + +
+ + +

32.97 hqdn3d

+ +

This is a high precision/quality 3d denoise filter. It aims to reduce +image noise, producing smooth images and making still images really +still. It should enhance compressibility. +

+

It accepts the following optional parameters: +

+
+
luma_spatial
+

A non-negative floating point number which specifies spatial luma strength. +It defaults to 4.0. +

+
+
chroma_spatial
+

A non-negative floating point number which specifies spatial chroma strength. +It defaults to 3.0*luma_spatial/4.0. +

+
+
luma_tmp
+

A floating point number which specifies luma temporal strength. It defaults to +6.0*luma_spatial/4.0. +

+
+
chroma_tmp
+

A floating point number which specifies chroma temporal strength. It defaults to +luma_tmp*chroma_spatial/luma_spatial. +

+
+ + +

32.97.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.98 hwdownload

+ +

Download hardware frames to system memory. +

+

The input must be in hardware frames, and the output a non-hardware format. +Not all formats will be supported on the output - it may be necessary to insert +an additional format filter immediately following in the graph to get +the output in a supported format. +

+ +

32.99 hwmap

+ +

Map hardware frames to system memory or to another device. +

+

This filter has several different modes of operation; which one is used depends +on the input and output formats: +

    +
  • Hardware frame input, normal frame output + +

    Map the input frames to system memory and pass them to the output. If the +original hardware frame is later required (for example, after overlaying +something else on part of it), the hwmap filter can be used again +in the next mode to retrieve it. +

  • Normal frame input, hardware frame output + +

    If the input is actually a software-mapped hardware frame, then unmap it - +that is, return the original hardware frame. +

    +

    Otherwise, a device must be provided. Create new hardware surfaces on that +device for the output, then map them back to the software format at the input +and give those frames to the preceding filter. This will then act like the +hwupload filter, but may be able to avoid an additional copy when +the input is already in a compatible format. +

  • Hardware frame input and output + +

    A device must be supplied for the output, either directly or with the +derive_device option. The input and output devices must be of +different types and compatible - the exact meaning of this is +system-dependent, but typically it means that they must refer to the same +underlying hardware context (for example, refer to the same graphics card). +

    +

    If the input frames were originally created on the output device, then unmap +to retrieve the original frames. +

    +

    Otherwise, map the frames to the output device - create new hardware frames +on the output corresponding to the frames on the input. +

+ +

The following additional parameters are accepted: +

+
+
mode
+

Set the frame mapping mode. Some combination of: +

+
read
+

The mapped frame should be readable. +

+
write
+

The mapped frame should be writeable. +

+
overwrite
+

The mapping will always overwrite the entire frame. +

+

This may improve performance in some cases, as the original contents of the +frame need not be loaded. +

+
direct
+

The mapping must not involve any copying. +

+

Indirect mappings to copies of frames are created in some cases where either +direct mapping is not possible or it would have unexpected properties. +Setting this flag ensures that the mapping is direct and will fail if that is +not possible. +

+
+

Defaults to read+write if not specified. +

+
+
derive_device type
+

Rather than using the device supplied at initialisation, instead derive a new +device of type type from the device the input frames exist on. +

+
+
reverse
+

In a hardware to hardware mapping, map in reverse - create frames in the sink +and map them back to the source. This may be necessary in some cases where +a mapping in one direction is required but only the opposite direction is +supported by the devices being used. +

+

This option is dangerous - it may break the preceding filter in undefined +ways if there are any additional constraints on that filter’s output. +Do not use it without fully understanding the implications of its use. +

+
+ + +

32.100 hwupload

+ +

Upload system memory frames to hardware surfaces. +

+

The device to upload to must be supplied when the filter is initialised. If +using ffmpeg, select the appropriate device with the -filter_hw_device +option or with the derive_device option. The input and output devices +must be of different types and compatible - the exact meaning of this is +system-dependent, but typically it means that they must refer to the same +underlying hardware context (for example, refer to the same graphics card). +

+

The following additional parameters are accepted: +

+
+
derive_device type
+

Rather than using the device supplied at initialisation, instead derive a new +device of type type from the device the input frames exist on. +

+
+ + +

32.101 hwupload_cuda

+ +

Upload system memory frames to a CUDA device. +

+

It accepts the following optional parameters: +

+
+
device
+

The number of the CUDA device to use +

+
+ + +

32.102 hqx

+ +

Apply a high-quality magnification filter designed for pixel art. This filter +was originally created by Maxim Stepin. +

+

It accepts the following option: +

+
+
n
+

Set the scaling dimension: 2 for hq2x, 3 for +hq3x and 4 for hq4x. +Default is 3. +

+
+ + +

32.103 hstack

+

Stack input videos horizontally. +

+

All streams must be of same pixel format and of same height. +

+

Note that this filter is faster than using overlay and pad filter +to create same output. +

+

The filter accepts the following option: +

+
+
inputs
+

Set number of input streams. Default is 2. +

+
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+ + +

32.104 hue

+ +

Modify the hue and/or the saturation of the input. +

+

It accepts the following parameters: +

+
+
h
+

Specify the hue angle as a number of degrees. It accepts an expression, +and defaults to "0". +

+
+
s
+

Specify the saturation in the [-10,10] range. It accepts an expression and +defaults to "1". +

+
+
H
+

Specify the hue angle as a number of radians. It accepts an +expression, and defaults to "0". +

+
+
b
+

Specify the brightness in the [-10,10] range. It accepts an expression and +defaults to "0". +

+
+ +

h and H are mutually exclusive, and can’t be +specified at the same time. +

+

The b, h, H and s option values are +expressions containing the following constants: +

+
+
n
+

frame count of the input frame starting from 0 +

+
+
pts
+

presentation timestamp of the input frame expressed in time base units +

+
+
r
+

frame rate of the input video, NAN if the input frame rate is unknown +

+
+
t
+

timestamp expressed in seconds, NAN if the input timestamp is unknown +

+
+
tb
+

time base of the input video +

+
+ + +

32.104.1 Examples

+ +
    +
  • Set the hue to 90 degrees and the saturation to 1.0: +
    +
    hue=h=90:s=1
+
    + +
  • Same command but expressing the hue in radians: +
    +
    hue=H=PI/2:s=1
+
    + +
  • Rotate hue and make the saturation swing between 0 +and 2 over a period of 1 second: +
    +
    hue="H=2*PI*t: s=sin(2*PI*t)+1"
+
    + +
  • Apply a 3 seconds saturation fade-in effect starting at 0: +
    +
    hue="s=min(t/3\,1)"
+
    + +

    The general fade-in expression can be written as: +

    +
    hue="s=min(0\, max((t-START)/DURATION\, 1))"
+
    + +
  • Apply a 3 seconds saturation fade-out effect starting at 5 seconds: +
    +
    hue="s=max(0\, min(1\, (8-t)/3))"
+
    + +

    The general fade-out expression can be written as: +

    +
    hue="s=max(0\, min(1\, (START+DURATION-t)/DURATION))"
+
    + +
+ + +

32.104.2 Commands

+ +

This filter supports the following commands: +

+
b
+
s
+
h
+
H
+

Modify the hue and/or the saturation and/or brightness of the input video. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

32.105 hysteresis

+ +

Grow first stream into second stream by connecting components. +This makes it possible to build more robust edge masks. +

+

This filter accepts the following options: +

+
+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+
threshold
+

Set threshold which is used in filtering. If pixel component value is higher than +this value filter algorithm for connecting components is activated. +By default value is 0. +

+
+ +

The hysteresis filter also supports the framesync options. +

+ +

32.106 idet

+ +

Detect video interlacing type. +

+

This filter tries to detect if the input frames are interlaced, progressive, +top or bottom field first. It will also try to detect fields that are +repeated between adjacent frames (a sign of telecine). +

+

Single frame detection considers only immediately adjacent frames when classifying each frame. +Multiple frame detection incorporates the classification history of previous frames. +

+

The filter will log these metadata values: +

+
+
single.current_frame
+

Detected type of current frame using single-frame detection. One of: +“tff” (top field first), “bff” (bottom field first), +“progressive”, or “undetermined” +

+
+
single.tff
+

Cumulative number of frames detected as top field first using single-frame detection. +

+
+
multiple.tff
+

Cumulative number of frames detected as top field first using multiple-frame detection. +

+
+
single.bff
+

Cumulative number of frames detected as bottom field first using single-frame detection. +

+
+
multiple.current_frame
+

Detected type of current frame using multiple-frame detection. One of: +“tff” (top field first), “bff” (bottom field first), +“progressive”, or “undetermined” +

+
+
multiple.bff
+

Cumulative number of frames detected as bottom field first using multiple-frame detection. +

+
+
single.progressive
+

Cumulative number of frames detected as progressive using single-frame detection. +

+
+
multiple.progressive
+

Cumulative number of frames detected as progressive using multiple-frame detection. +

+
+
single.undetermined
+

Cumulative number of frames that could not be classified using single-frame detection. +

+
+
multiple.undetermined
+

Cumulative number of frames that could not be classified using multiple-frame detection. +

+
+
repeated.current_frame
+

Which field in the current frame is repeated from the last. One of “neither”, “top”, or “bottom”. +

+
+
repeated.neither
+

Cumulative number of frames with no repeated field. +

+
+
repeated.top
+

Cumulative number of frames with the top field repeated from the previous frame’s top field. +

+
+
repeated.bottom
+

Cumulative number of frames with the bottom field repeated from the previous frame’s bottom field. +

+
+ +

The filter accepts the following options: +

+
+
intl_thres
+

Set interlacing threshold. +

+
prog_thres
+

Set progressive threshold. +

+
rep_thres
+

Threshold for repeated field detection. +

+
half_life
+

Number of frames after which a given frame’s contribution to the +statistics is halved (i.e., it contributes only 0.5 to its +classification). The default of 0 means that all frames seen are given +full weight of 1.0 forever. +

+
analyze_interlaced_flag
+

When this is not 0 then idet will use the specified number of frames to determine +if the interlaced flag is accurate, it will not count undetermined frames. +If the flag is found to be accurate it will be used without any further +computations, if it is found to be inaccurate it will be cleared without any +further computations. This allows inserting the idet filter as a low computational +method to clean up the interlaced flag +

+
+ + +

32.107 il

+ +

Deinterleave or interleave fields. +

+

This filter allows one to process interlaced images fields without +deinterlacing them. Deinterleaving splits the input frame into 2 +fields (so called half pictures). Odd lines are moved to the top +half of the output image, even lines to the bottom half. +You can process (filter) them independently and then re-interleave them. +

+

The filter accepts the following options: +

+
+
luma_mode, l
+
chroma_mode, c
+
alpha_mode, a
+

Available values for luma_mode, chroma_mode and +alpha_mode are: +

+
+
‘none’
+

Do nothing. +

+
+
‘deinterleave, d’
+

Deinterleave fields, placing one above the other. +

+
+
‘interleave, i’
+

Interleave fields. Reverse the effect of deinterleaving. +

+
+

Default value is none. +

+
+
luma_swap, ls
+
chroma_swap, cs
+
alpha_swap, as
+

Swap luma/chroma/alpha fields. Exchange even & odd lines. Default value is 0. +

+
+ + +

32.107.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

32.108 inflate

+ +

Apply inflate effect to the video. +

+

This filter replaces the pixel by the local(3x3) average by taking into account +only values higher than the pixel. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane, default is 65535. +If 0, plane will remain unchanged. +

+
+ + +

32.108.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

32.109 interlace

+ +

Simple interlacing filter from progressive contents. This interleaves upper (or +lower) lines from odd frames with lower (or upper) lines from even frames, +halving the frame rate and preserving image height. +

+
+
   Original        Original             New Frame
+   Frame 'j'      Frame 'j+1'             (tff)
+  ==========      ===========       ==================
+    Line 0  -------------------->    Frame 'j' Line 0
+    Line 1          Line 1  ---->   Frame 'j+1' Line 1
+    Line 2 --------------------->    Frame 'j' Line 2
+    Line 3          Line 3  ---->   Frame 'j+1' Line 3
+     ...             ...                   ...
+New Frame + 1 will be generated by Frame 'j+2' and Frame 'j+3' and so on
+
+ +

It accepts the following optional parameters: +

+
+
scan
+

This determines whether the interlaced frame is taken from the even +(tff - default) or odd (bff) lines of the progressive frame. +

+
+
lowpass
+

Vertical lowpass filter to avoid twitter interlacing and +reduce moire patterns. +

+
+
‘0, off’
+

Disable vertical lowpass filter +

+
+
‘1, linear’
+

Enable linear filter (default) +

+
+
‘2, complex’
+

Enable complex filter. This will slightly less reduce twitter and moire +but better retain detail and subjective sharpness impression. +

+
+
+
+
+ + +

32.110 kerndeint

+ +

Deinterlace input video by applying Donald Graft’s adaptive kernel +deinterling. Work on interlaced parts of a video to produce +progressive frames. +

+

The description of the accepted parameters follows. +

+
+
thresh
+

Set the threshold which affects the filter’s tolerance when +determining if a pixel line must be processed. It must be an integer +in the range [0,255] and defaults to 10. A value of 0 will result in +applying the process on every pixels. +

+
+
map
+

Paint pixels exceeding the threshold value to white if set to 1. +Default is 0. +

+
+
order
+

Set the fields order. Swap fields if set to 1, leave fields alone if +0. Default is 0. +

+
+
sharp
+

Enable additional sharpening if set to 1. Default is 0. +

+
+
twoway
+

Enable twoway sharpening if set to 1. Default is 0. +

+
+ + +

32.110.1 Examples

+ +
    +
  • Apply default values: +
    +
    kerndeint=thresh=10:map=0:order=0:sharp=0:twoway=0
+
    + +
  • Enable additional sharpening: +
    +
    kerndeint=sharp=1
+
    + +
  • Paint processed pixels in white: +
    +
    kerndeint=map=1
+
    +
+ + +

32.111 lagfun

+ +

Slowly update darker pixels. +

+

This filter makes short flashes of light appear longer. +This filter accepts the following options: +

+
+
decay
+

Set factor for decaying. Default is .95. Allowed range is from 0 to 1. +

+
+
planes
+

Set which planes to filter. Default is all. Allowed range is from 0 to 15. +

+
+ + +

32.112 lenscorrection

+ +

Correct radial lens distortion +

+

This filter can be used to correct for radial distortion as can result from the use +of wide angle lenses, and thereby re-rectify the image. To find the right parameters +one can use tools available for example as part of opencv or simply trial-and-error. +To use opencv use the calibration sample (under samples/cpp) from the opencv sources +and extract the k1 and k2 coefficients from the resulting matrix. +

+

Note that effectively the same filter is available in the open-source tools Krita and +Digikam from the KDE project. +

+

In contrast to the vignette filter, which can also be used to compensate lens errors, +this filter corrects the distortion of the image, whereas vignette corrects the +brightness distribution, so you may want to use both filters together in certain +cases, though you will have to take care of ordering, i.e. whether vignetting should +be applied before or after lens correction. +

+ +

32.112.1 Options

+ +

The filter accepts the following options: +

+
+
cx
+

Relative x-coordinate of the focal point of the image, and thereby the center of the +distortion. This value has a range [0,1] and is expressed as fractions of the image +width. Default is 0.5. +

+
cy
+

Relative y-coordinate of the focal point of the image, and thereby the center of the +distortion. This value has a range [0,1] and is expressed as fractions of the image +height. Default is 0.5. +

+
k1
+

Coefficient of the quadratic correction term. This value has a range [-1,1]. 0 means +no correction. Default is 0. +

+
k2
+

Coefficient of the double quadratic correction term. This value has a range [-1,1]. +0 means no correction. Default is 0. +

+
+ +

The formula that generates the correction is: +

+

r_src = r_tgt * (1 + k1 * (r_tgt / r_0)^2 + k2 * (r_tgt / r_0)^4) +

+

where r_0 is halve of the image diagonal and r_src and r_tgt are the +distances from the focal point in the source and target images, respectively. +

+ +

32.113 lensfun

+ +

Apply lens correction via the lensfun library (http://lensfun.sourceforge.net/). +

+

The lensfun filter requires the camera make, camera model, and lens model +to apply the lens correction. The filter will load the lensfun database and +query it to find the corresponding camera and lens entries in the database. As +long as these entries can be found with the given options, the filter can +perform corrections on frames. Note that incomplete strings will result in the +filter choosing the best match with the given options, and the filter will +output the chosen camera and lens models (logged with level "info"). You must +provide the make, camera model, and lens model as they are required. +

+

The filter accepts the following options: +

+
+
make
+

The make of the camera (for example, "Canon"). This option is required. +

+
+
model
+

The model of the camera (for example, "Canon EOS 100D"). This option is +required. +

+
+
lens_model
+

The model of the lens (for example, "Canon EF-S 18-55mm f/3.5-5.6 IS STM"). This +option is required. +

+
+
mode
+

The type of correction to apply. The following values are valid options: +

+
+
‘vignetting’
+

Enables fixing lens vignetting. +

+
+
‘geometry’
+

Enables fixing lens geometry. This is the default. +

+
+
‘subpixel’
+

Enables fixing chromatic aberrations. +

+
+
‘vig_geo’
+

Enables fixing lens vignetting and lens geometry. +

+
+
‘vig_subpixel’
+

Enables fixing lens vignetting and chromatic aberrations. +

+
+
‘distortion’
+

Enables fixing both lens geometry and chromatic aberrations. +

+
+
‘all’
+

Enables all possible corrections. +

+
+
+
+
focal_length
+

The focal length of the image/video (zoom; expected constant for video). For +example, a 18–55mm lens has focal length range of [18–55], so a value in that +range should be chosen when using that lens. Default 18. +

+
+
aperture
+

The aperture of the image/video (expected constant for video). Note that +aperture is only used for vignetting correction. Default 3.5. +

+
+
focus_distance
+

The focus distance of the image/video (expected constant for video). Note that +focus distance is only used for vignetting and only slightly affects the +vignetting correction process. If unknown, leave it at the default value (which +is 1000). +

+
+
scale
+

The scale factor which is applied after transformation. After correction the +video is no longer necessarily rectangular. This parameter controls how much of +the resulting image is visible. The value 0 means that a value will be chosen +automatically such that there is little or no unmapped area in the output +image. 1.0 means that no additional scaling is done. Lower values may result +in more of the corrected image being visible, while higher values may avoid +unmapped areas in the output. +

+
+
target_geometry
+

The target geometry of the output image/video. The following values are valid +options: +

+
+
‘rectilinear (default)’
+
‘fisheye’
+
‘panoramic’
+
‘equirectangular’
+
‘fisheye_orthographic’
+
‘fisheye_stereographic’
+
‘fisheye_equisolid’
+
‘fisheye_thoby’
+
+
+
reverse
+

Apply the reverse of image correction (instead of correcting distortion, apply +it). +

+
+
interpolation
+

The type of interpolation used when correcting distortion. The following values +are valid options: +

+
+
‘nearest’
+
‘linear (default)’
+
‘lanczos’
+
+
+
+ + +

32.113.1 Examples

+ +
    +
  • Apply lens correction with make "Canon", camera model "Canon EOS 100D", and lens +model "Canon EF-S 18-55mm f/3.5-5.6 IS STM" with focal length of "18" and +aperture of "8.0". + +
    +
    ffmpeg -i input.mov -vf lensfun=make=Canon:model="Canon EOS 100D":lens_model="Canon EF-S 18-55mm f/3.5-5.6 IS STM":focal_length=18:aperture=8 -c:v h264 -b:v 8000k output.mov
+
    + +
  • Apply the same as before, but only for the first 5 seconds of video. + +
    +
    ffmpeg -i input.mov -vf lensfun=make=Canon:model="Canon EOS 100D":lens_model="Canon EF-S 18-55mm f/3.5-5.6 IS STM":focal_length=18:aperture=8:enable='lte(t\,5)' -c:v h264 -b:v 8000k output.mov
+
    + +
+ + +

32.114 libvmaf

+ +

Obtain the VMAF (Video Multi-Method Assessment Fusion) +score between two input videos. +

+

The obtained VMAF score is printed through the logging system. +

+

It requires Netflix’s vmaf library (libvmaf) as a pre-requisite. +After installing the library it can be enabled using: +./configure --enable-libvmaf --enable-version3. +If no model path is specified it uses the default model: vmaf_v0.6.1.pkl. +

+

The filter has following options: +

+
+
model_path
+

Set the model path which is to be used for SVM. +Default value: "/usr/local/share/model/vmaf_v0.6.1.pkl" +

+
+
log_path
+

Set the file path to be used to store logs. +

+
+
log_fmt
+

Set the format of the log file (xml or json). +

+
+
enable_transform
+

This option can enable/disable the score_transform applied to the final predicted VMAF score, +if you have specified score_transform option in the input parameter file passed to run_vmaf_training.py +Default value: false +

+
+
phone_model
+

Invokes the phone model which will generate VMAF scores higher than in the +regular model, which is more suitable for laptop, TV, etc. viewing conditions. +Default value: false +

+
+
psnr
+

Enables computing psnr along with vmaf. +Default value: false +

+
+
ssim
+

Enables computing ssim along with vmaf. +Default value: false +

+
+
ms_ssim
+

Enables computing ms_ssim along with vmaf. +Default value: false +

+
+
pool
+

Set the pool method to be used for computing vmaf. +Options are min, harmonic_mean or mean (default). +

+
+
n_threads
+

Set number of threads to be used when computing vmaf. +Default value: 0, which makes use of all available logical processors. +

+
+
n_subsample
+

Set interval for frame subsampling used when computing vmaf. +Default value: 1 +

+
+
enable_conf_interval
+

Enables confidence interval. +Default value: false +

+
+ +

This filter also supports the framesync options. +

+ +

32.114.1 Examples

+
    +
  • On the below examples the input file main.mpg being processed is +compared with the reference file ref.mpg. + +
    +
    ffmpeg -i main.mpg -i ref.mpg -lavfi libvmaf -f null -
+
    + +
  • Example with options: +
    +
    ffmpeg -i main.mpg -i ref.mpg -lavfi libvmaf="psnr=1:log_fmt=json" -f null -
+
    + +
  • Example with options and different containers: +
    +
    ffmpeg -i main.mpg -i ref.mkv -lavfi "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]libvmaf=psnr=1:log_fmt=json" -f null -
+
    +
+ + +

32.115 limiter

+ +

Limits the pixel components values to the specified range [min, max]. +

+

The filter accepts the following options: +

+
+
min
+

Lower bound. Defaults to the lowest allowed value for the input. +

+
+
max
+

Upper bound. Defaults to the highest allowed value for the input. +

+
+
planes
+

Specify which planes will be processed. Defaults to all available. +

+
+ + +

32.116 loop

+ +

Loop video frames. +

+

The filter accepts the following options: +

+
+
loop
+

Set the number of loops. Setting this value to -1 will result in infinite loops. +Default is 0. +

+
+
size
+

Set maximal size in number of frames. Default is 0. +

+
+
start
+

Set first frame of loop. Default is 0. +

+
+ + +

32.116.1 Examples

+ +
    +
  • Loop single first frame infinitely: +
    +
    loop=loop=-1:size=1:start=0
+
    + +
  • Loop single first frame 10 times: +
    +
    loop=loop=10:size=1:start=0
+
    + +
  • Loop 10 first frames 5 times: +
    +
    loop=loop=5:size=10:start=0
+
    +
+ + +

32.117 lut1d

+ +

Apply a 1D LUT to an input video. +

+

The filter accepts the following options: +

+
+
file
+

Set the 1D LUT file name. +

+

Currently supported formats: +

+
‘cube’
+

Iridas +

+
‘csp’
+

cineSpace +

+
+ +
+
interp
+

Select interpolation mode. +

+

Available values are: +

+
+
‘nearest’
+

Use values from the nearest defined point. +

+
‘linear’
+

Interpolate values using the linear interpolation. +

+
‘cosine’
+

Interpolate values using the cosine interpolation. +

+
‘cubic’
+

Interpolate values using the cubic interpolation. +

+
‘spline’
+

Interpolate values using the spline interpolation. +

+
+
+
+ + +

32.118 lut3d

+ +

Apply a 3D LUT to an input video. +

+

The filter accepts the following options: +

+
+
file
+

Set the 3D LUT file name. +

+

Currently supported formats: +

+
‘3dl’
+

AfterEffects +

+
‘cube’
+

Iridas +

+
‘dat’
+

DaVinci +

+
‘m3d’
+

Pandora +

+
‘csp’
+

cineSpace +

+
+
+
interp
+

Select interpolation mode. +

+

Available values are: +

+
+
‘nearest’
+

Use values from the nearest defined point. +

+
‘trilinear’
+

Interpolate values using the 8 points defining a cube. +

+
‘tetrahedral’
+

Interpolate values using a tetrahedron. +

+
+
+
+ + +

32.119 lumakey

+ +

Turn certain luma values into transparency. +

+

The filter accepts the following options: +

+
+
threshold
+

Set the luma which will be used as base for transparency. +Default value is 0. +

+
+
tolerance
+

Set the range of luma values to be keyed out. +Default value is 0.01. +

+
+
softness
+

Set the range of softness. Default value is 0. +Use this to control gradual transition from zero to full transparency. +

+
+ + +

32.119.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.120 lut, lutrgb, lutyuv

+ +

Compute a look-up table for binding each pixel component input value +to an output value, and apply it to the input video. +

+

lutyuv applies a lookup table to a YUV input video, lutrgb +to an RGB input video. +

+

These filters accept the following parameters: +

+
c0
+

set first pixel component expression +

+
c1
+

set second pixel component expression +

+
c2
+

set third pixel component expression +

+
c3
+

set fourth pixel component expression, corresponds to the alpha component +

+
+
r
+

set red component expression +

+
g
+

set green component expression +

+
b
+

set blue component expression +

+
a
+

alpha component expression +

+
+
y
+

set Y/luminance component expression +

+
u
+

set U/Cb component expression +

+
v
+

set V/Cr component expression +

+
+ +

Each of them specifies the expression to use for computing the lookup table for +the corresponding pixel component values. +

+

The exact component associated to each of the c* options depends on the +format in input. +

+

The lut filter requires either YUV or RGB pixel formats in input, +lutrgb requires RGB pixel formats in input, and lutyuv requires YUV. +

+

The expressions can contain the following constants and functions: +

+
+
w
+
h
+

The input width and height. +

+
+
val
+

The input value for the pixel component. +

+
+
clipval
+

The input value, clipped to the minval-maxval range. +

+
+
maxval
+

The maximum value for the pixel component. +

+
+
minval
+

The minimum value for the pixel component. +

+
+
negval
+

The negated value for the pixel component value, clipped to the +minval-maxval range; it corresponds to the expression +"maxval-clipval+minval". +

+
+
clip(val)
+

The computed value in val, clipped to the +minval-maxval range. +

+
+
gammaval(gamma)
+

The computed gamma correction value of the pixel component value, +clipped to the minval-maxval range. It corresponds to the +expression +"pow((clipval-minval)/(maxval-minval)\,gamma)*(maxval-minval)+minval" +

+
+
+ +

All expressions default to "val". +

+ +

32.120.1 Examples

+ +
    +
  • Negate input video: +
    +
    lutrgb="r=maxval+minval-val:g=maxval+minval-val:b=maxval+minval-val"
+lutyuv="y=maxval+minval-val:u=maxval+minval-val:v=maxval+minval-val"
+
    + +

    The above is the same as: +

    +
    lutrgb="r=negval:g=negval:b=negval"
+lutyuv="y=negval:u=negval:v=negval"
+
    + +
  • Negate luminance: +
    +
    lutyuv=y=negval
+
    + +
  • Remove chroma components, turning the video into a graytone image: +
    +
    lutyuv="u=128:v=128"
+
    + +
  • Apply a luma burning effect: +
    +
    lutyuv="y=2*val"
+
    + +
  • Remove green and blue components: +
    +
    lutrgb="g=0:b=0"
+
    + +
  • Set a constant alpha channel value on input: +
    +
    format=rgba,lutrgb=a="maxval-minval/2"
+
    + +
  • Correct luminance gamma by a factor of 0.5: +
    +
    lutyuv=y=gammaval(0.5)
+
    + +
  • Discard least significant bits of luma: +
    +
    lutyuv=y='bitand(val, 128+64+32)'
+
    + +
  • Technicolor like effect: +
    +
    lutyuv=u='(val-maxval/2)*2+maxval/2':v='(val-maxval/2)*2+maxval/2'
+
    +
+ + +

32.121 lut2, tlut2

+ +

The lut2 filter takes two input streams and outputs one +stream. +

+

The tlut2 (time lut2) filter takes two consecutive frames +from one single stream. +

+

This filter accepts the following parameters: +

+
c0
+

set first pixel component expression +

+
c1
+

set second pixel component expression +

+
c2
+

set third pixel component expression +

+
c3
+

set fourth pixel component expression, corresponds to the alpha component +

+
+
d
+

set output bit depth, only available for lut2 filter. By default is 0, +which means bit depth is automatically picked from first input format. +

+
+ +

The lut2 filter also supports the framesync options. +

+

Each of them specifies the expression to use for computing the lookup table for +the corresponding pixel component values. +

+

The exact component associated to each of the c* options depends on the +format in inputs. +

+

The expressions can contain the following constants: +

+
+
w
+
h
+

The input width and height. +

+
+
x
+

The first input value for the pixel component. +

+
+
y
+

The second input value for the pixel component. +

+
+
bdx
+

The first input video bit depth. +

+
+
bdy
+

The second input video bit depth. +

+
+ +

All expressions default to "x". +

+ +

32.121.1 Examples

+ +
    +
  • Highlight differences between two RGB video streams: +
    +
    lut2='ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,0,pow(2,bdx)-1)'
+
    + +
  • Highlight differences between two YUV video streams: +
    +
    lut2='ifnot(x-y,0,pow(2,bdx)-1):ifnot(x-y,pow(2,bdx-1),pow(2,bdx)-1):ifnot(x-y,pow(2,bdx-1),pow(2,bdx)-1)'
+
    + +
  • Show max difference between two video streams: +
    +
    lut2='if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1))):if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1))):if(lt(x,y),0,if(gt(x,y),pow(2,bdx)-1,pow(2,bdx-1)))'
+
    +
+ + +

32.122 maskedclamp

+ +

Clamp the first input stream with the second input and third input stream. +

+

Returns the value of first stream to be between second input +stream - undershoot and third input stream + overshoot. +

+

This filter accepts the following options: +

+
undershoot
+

Default value is 0. +

+
+
overshoot
+

Default value is 0. +

+
+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

32.123 maskedmax

+ +

Merge the second and third input stream into output stream using absolute differences +between second input stream and first input stream and absolute difference between +third input stream and first input stream. The picked value will be from second input +stream if second absolute difference is greater than first one or from third input stream +otherwise. +

+

This filter accepts the following options: +

+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

32.124 maskedmerge

+ +

Merge the first input stream with the second input stream using per pixel +weights in the third input stream. +

+

A value of 0 in the third stream pixel component means that pixel component +from first stream is returned unchanged, while maximum value (eg. 255 for +8-bit videos) means that pixel component from second stream is returned +unchanged. Intermediate values define the amount of merging between both +input stream’s pixel components. +

+

This filter accepts the following options: +

+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

32.125 maskedmin

+ +

Merge the second and third input stream into output stream using absolute differences +between second input stream and first input stream and absolute difference between +third input stream and first input stream. The picked value will be from second input +stream if second absolute difference is less than first one or from third input stream +otherwise. +

+

This filter accepts the following options: +

+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from first stream. +By default value 0xf, all planes will be processed. +

+
+ + +

32.126 maskedthreshold

+

Pick pixels comparing absolute difference of two video streams with fixed +threshold. +

+

If absolute difference between pixel component of first and second video +stream is equal or lower than user supplied threshold than pixel component +from first video stream is picked, otherwise pixel component from second +video stream is picked. +

+

This filter accepts the following options: +

+
threshold
+

Set threshold used when picking pixels from absolute difference from two input +video streams. +

+
+
planes
+

Set which planes will be processed as bitmap, unprocessed planes will be +copied from second stream. +By default value 0xf, all planes will be processed. +

+
+ + +

32.127 maskfun

+

Create mask from input video. +

+

For example it is useful to create motion masks after tblend filter. +

+

This filter accepts the following options: +

+
+
low
+

Set low threshold. Any pixel component lower or exact than this value will be set to 0. +

+
+
high
+

Set high threshold. Any pixel component higher than this value will be set to max value +allowed for current pixel format. +

+
+
planes
+

Set planes to filter, by default all available planes are filtered. +

+
+
fill
+

Fill all frame pixels with this value. +

+
+
sum
+

Set max average pixel value for frame. If sum of all pixel components is higher that this +average, output frame will be completely filled with value set by fill option. +Typically useful for scene changes when used in combination with tblend filter. +

+
+ + +

32.128 mcdeint

+ +

Apply motion-compensation deinterlacing. +

+

It needs one field per frame as input and must thus be used together +with yadif=1/3 or equivalent. +

+

This filter accepts the following options: +

+
mode
+

Set the deinterlacing mode. +

+

It accepts one of the following values: +

+
‘fast’
+
‘medium’
+
‘slow’
+

use iterative motion estimation +

+
‘extra_slow’
+

like ‘slow’, but use multiple reference frames. +

+
+

Default value is ‘fast’. +

+
+
parity
+

Set the picture field parity assumed for the input video. It must be +one of the following values: +

+
+
‘0, tff’
+

assume top field first +

+
‘1, bff’
+

assume bottom field first +

+
+ +

Default value is ‘bff’. +

+
+
qp
+

Set per-block quantization parameter (QP) used by the internal +encoder. +

+

Higher values should result in a smoother motion vector field but less +optimal individual vectors. Default value is 1. +

+
+ + +

32.129 median

+ +

Pick median pixel from certain rectangle defined by radius. +

+

This filter accepts the following options: +

+
+
radius
+

Set horizontal radius size. Default value is 1. +Allowed range is integer from 1 to 127. +

+
+
planes
+

Set which planes to process. Default is 15, which is all available planes. +

+
+
radiusV
+

Set vertical radius size. Default value is 0. +Allowed range is integer from 0 to 127. +If it is 0, value will be picked from horizontal radius option. +

+
+
percentile
+

Set median percentile. Default value is 0.5. +Default value of 0.5 will pick always median values, while 0 will pick +minimum values, and 1 maximum values. +

+
+ + +

32.129.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.130 mergeplanes

+ +

Merge color channel components from several video streams. +

+

The filter accepts up to 4 input streams, and merge selected input +planes to the output video. +

+

This filter accepts the following options: +

+
mapping
+

Set input to output plane mapping. Default is 0. +

+

The mappings is specified as a bitmap. It should be specified as a +hexadecimal number in the form 0xAa[Bb[Cc[Dd]]]. ’Aa’ describes the +mapping for the first plane of the output stream. ’A’ sets the number of +the input stream to use (from 0 to 3), and ’a’ the plane number of the +corresponding input to use (from 0 to 3). The rest of the mappings is +similar, ’Bb’ describes the mapping for the output stream second +plane, ’Cc’ describes the mapping for the output stream third plane and +’Dd’ describes the mapping for the output stream fourth plane. +

+
+
format
+

Set output pixel format. Default is yuva444p. +

+
+ + +

32.130.1 Examples

+ +
    +
  • Merge three gray video streams of same width and height into single video stream: +
    +
    [a0][a1][a2]mergeplanes=0x001020:yuv444p
+
    + +
  • Merge 1st yuv444p stream and 2nd gray video stream into yuva444p video stream: +
    +
    [a0][a1]mergeplanes=0x00010210:yuva444p
+
    + +
  • Swap Y and A plane in yuva444p stream: +
    +
    format=yuva444p,mergeplanes=0x03010200:yuva444p
+
    + +
  • Swap U and V plane in yuv420p stream: +
    +
    format=yuv420p,mergeplanes=0x000201:yuv420p
+
    + +
  • Cast a rgb24 clip to yuv444p: +
    +
    format=rgb24,mergeplanes=0x000102:yuv444p
+
    +
+ + +

32.131 mestimate

+ +

Estimate and export motion vectors using block matching algorithms. +Motion vectors are stored in frame side data to be used by other filters. +

+

This filter accepts the following options: +

+
method
+

Specify the motion estimation method. Accepts one of the following values: +

+
+
‘esa’
+

Exhaustive search algorithm. +

+
‘tss’
+

Three step search algorithm. +

+
‘tdls’
+

Two dimensional logarithmic search algorithm. +

+
‘ntss’
+

New three step search algorithm. +

+
‘fss’
+

Four step search algorithm. +

+
‘ds’
+

Diamond search algorithm. +

+
‘hexbs’
+

Hexagon-based search algorithm. +

+
‘epzs’
+

Enhanced predictive zonal search algorithm. +

+
‘umh’
+

Uneven multi-hexagon search algorithm. +

+
+

Default value is ‘esa’. +

+
+
mb_size
+

Macroblock size. Default 16. +

+
+
search_param
+

Search parameter. Default 7. +

+
+ + +

32.132 midequalizer

+ +

Apply Midway Image Equalization effect using two video streams. +

+

Midway Image Equalization adjusts a pair of images to have the same +histogram, while maintaining their dynamics as much as possible. It’s +useful for e.g. matching exposures from a pair of stereo cameras. +

+

This filter has two inputs and one output, which must be of same pixel format, but +may be of different sizes. The output of filter is first input adjusted with +midway histogram of both inputs. +

+

This filter accepts the following option: +

+
+
planes
+

Set which planes to process. Default is 15, which is all available planes. +

+
+ + +

32.133 minterpolate

+ +

Convert the video to specified frame rate using motion interpolation. +

+

This filter accepts the following options: +

+
fps
+

Specify the output frame rate. This can be rational e.g. 60000/1001. Frames are dropped if fps is lower than source fps. Default 60. +

+
+
mi_mode
+

Motion interpolation mode. Following values are accepted: +

+
‘dup’
+

Duplicate previous or next frame for interpolating new ones. +

+
‘blend’
+

Blend source frames. Interpolated frame is mean of previous and next frames. +

+
‘mci’
+

Motion compensated interpolation. Following options are effective when this mode is selected: +

+
+
‘mc_mode’
+

Motion compensation mode. Following values are accepted: +

+
‘obmc’
+

Overlapped block motion compensation. +

+
‘aobmc’
+

Adaptive overlapped block motion compensation. Window weighting coefficients are controlled adaptively according to the reliabilities of the neighboring motion vectors to reduce oversmoothing. +

+
+

Default mode is ‘obmc’. +

+
+
‘me_mode’
+

Motion estimation mode. Following values are accepted: +

+
‘bidir’
+

Bidirectional motion estimation. Motion vectors are estimated for each source frame in both forward and backward directions. +

+
‘bilat’
+

Bilateral motion estimation. Motion vectors are estimated directly for interpolated frame. +

+
+

Default mode is ‘bilat’. +

+
+
‘me’
+

The algorithm to be used for motion estimation. Following values are accepted: +

+
‘esa’
+

Exhaustive search algorithm. +

+
‘tss’
+

Three step search algorithm. +

+
‘tdls’
+

Two dimensional logarithmic search algorithm. +

+
‘ntss’
+

New three step search algorithm. +

+
‘fss’
+

Four step search algorithm. +

+
‘ds’
+

Diamond search algorithm. +

+
‘hexbs’
+

Hexagon-based search algorithm. +

+
‘epzs’
+

Enhanced predictive zonal search algorithm. +

+
‘umh’
+

Uneven multi-hexagon search algorithm. +

+
+

Default algorithm is ‘epzs’. +

+
+
‘mb_size’
+

Macroblock size. Default 16. +

+
+
‘search_param’
+

Motion estimation search parameter. Default 32. +

+
+
‘vsbmc’
+

Enable variable-size block motion compensation. Motion estimation is applied with smaller block sizes at object boundaries in order to make the them less blur. Default is 0 (disabled). +

+
+
+
+ +
+
scd
+

Scene change detection method. Scene change leads motion vectors to be in random direction. Scene change detection replace interpolated frames by duplicate ones. May not be needed for other modes. Following values are accepted: +

+
‘none’
+

Disable scene change detection. +

+
‘fdiff’
+

Frame difference. Corresponding pixel values are compared and if it satisfies scd_threshold scene change is detected. +

+
+

Default method is ‘fdiff’. +

+
+
scd_threshold
+

Scene change detection threshold. Default is 10.. +

+
+ + +

32.134 mix

+ +

Mix several video input streams into one video stream. +

+

A description of the accepted options follows. +

+
+
nb_inputs
+

The number of inputs. If unspecified, it defaults to 2. +

+
+
weights
+

Specify weight of each input video stream as sequence. +Each weight is separated by space. If number of weights +is smaller than number of frames last specified +weight will be used for all remaining unset weights. +

+
+
scale
+

Specify scale, if it is set it will be multiplied with sum +of each weight multiplied with pixel values to give final destination +pixel value. By default scale is auto scaled to sum of weights. +

+
+
duration
+

Specify how end of stream is determined. +

+
‘longest’
+

The duration of the longest input. (default) +

+
+
‘shortest’
+

The duration of the shortest input. +

+
+
‘first’
+

The duration of the first input. +

+
+
+
+ + +

32.135 mpdecimate

+ +

Drop frames that do not differ greatly from the previous frame in +order to reduce frame rate. +

+

The main use of this filter is for very-low-bitrate encoding +(e.g. streaming over dialup modem), but it could in theory be used for +fixing movies that were inverse-telecined incorrectly. +

+

A description of the accepted options follows. +

+
+
max
+

Set the maximum number of consecutive frames which can be dropped (if +positive), or the minimum interval between dropped frames (if +negative). If the value is 0, the frame is dropped disregarding the +number of previous sequentially dropped frames. +

+

Default value is 0. +

+
+
hi
+
lo
+
frac
+

Set the dropping threshold values. +

+

Values for hi and lo are for 8x8 pixel blocks and +represent actual pixel value differences, so a threshold of 64 +corresponds to 1 unit of difference for each pixel, or the same spread +out differently over the block. +

+

A frame is a candidate for dropping if no 8x8 blocks differ by more +than a threshold of hi, and if no more than frac blocks (1 +meaning the whole image) differ by more than a threshold of lo. +

+

Default value for hi is 64*12, default value for lo is +64*5, and default value for frac is 0.33. +

+
+ + + +

32.136 negate

+ +

Negate (invert) the input video. +

+

It accepts the following option: +

+
+
negate_alpha
+

With value 1, it negates the alpha component, if present. Default value is 0. +

+
+ + +

32.137 nlmeans

+ +

Denoise frames using Non-Local Means algorithm. +

+

Each pixel is adjusted by looking for other pixels with similar contexts. This +context similarity is defined by comparing their surrounding patches of size +pxp. Patches are searched in an area of rxr +around the pixel. +

+

Note that the research area defines centers for patches, which means some +patches will be made of pixels outside that research area. +

+

The filter accepts the following options. +

+
+
s
+

Set denoising strength. Default is 1.0. Must be in range [1.0, 30.0]. +

+
+
p
+

Set patch size. Default is 7. Must be odd number in range [0, 99]. +

+
+
pc
+

Same as p but for chroma planes. +

+

The default value is 0 and means automatic. +

+
+
r
+

Set research size. Default is 15. Must be odd number in range [0, 99]. +

+
+
rc
+

Same as r but for chroma planes. +

+

The default value is 0 and means automatic. +

+
+ + +

32.138 nnedi

+ +

Deinterlace video using neural network edge directed interpolation. +

+

This filter accepts the following options: +

+
+
weights
+

Mandatory option, without binary file filter can not work. +Currently file can be found here: +https://github.com/dubhater/vapoursynth-nnedi3/blob/master/src/nnedi3_weights.bin +

+
+
deint
+

Set which frames to deinterlace, by default it is all. +Can be all or interlaced. +

+
+
field
+

Set mode of operation. +

+

Can be one of the following: +

+
+
‘af’
+

Use frame flags, both fields. +

+
‘a’
+

Use frame flags, single field. +

+
‘t’
+

Use top field only. +

+
‘b’
+

Use bottom field only. +

+
‘tf’
+

Use both fields, top first. +

+
‘bf’
+

Use both fields, bottom first. +

+
+ +
+
planes
+

Set which planes to process, by default filter process all frames. +

+
+
nsize
+

Set size of local neighborhood around each pixel, used by the predictor neural +network. +

+

Can be one of the following: +

+
+
‘s8x6’
+
‘s16x6’
+
‘s32x6’
+
‘s48x6’
+
‘s8x4’
+
‘s16x4’
+
‘s32x4’
+
+ +
+
nns
+

Set the number of neurons in predictor neural network. +Can be one of the following: +

+
+
‘n16’
+
‘n32’
+
‘n64’
+
‘n128’
+
‘n256’
+
+ +
+
qual
+

Controls the number of different neural network predictions that are blended +together to compute the final output value. Can be fast, default or +slow. +

+
+
etype
+

Set which set of weights to use in the predictor. +Can be one of the following: +

+
+
‘a’
+

weights trained to minimize absolute error +

+
‘s’
+

weights trained to minimize squared error +

+
+ +
+
pscrn
+

Controls whether or not the prescreener neural network is used to decide +which pixels should be processed by the predictor neural network and which +can be handled by simple cubic interpolation. +The prescreener is trained to know whether cubic interpolation will be +sufficient for a pixel or whether it should be predicted by the predictor nn. +The computational complexity of the prescreener nn is much less than that of +the predictor nn. Since most pixels can be handled by cubic interpolation, +using the prescreener generally results in much faster processing. +The prescreener is pretty accurate, so the difference between using it and not +using it is almost always unnoticeable. +

+

Can be one of the following: +

+
+
‘none’
+
‘original’
+
‘new’
+
+ +

Default is new. +

+
+
fapprox
+

Set various debugging flags. +

+
+ + +

32.139 noformat

+ +

Force libavfilter not to use any of the specified pixel formats for the +input to the next filter. +

+

It accepts the following parameters: +

+
pix_fmts
+

A ’|’-separated list of pixel format names, such as +pix_fmts=yuv420p|monow|rgb24". +

+
+
+ + +

32.139.1 Examples

+ +
    +
  • Force libavfilter to use a format different from yuv420p for the +input to the vflip filter: +
    +
    noformat=pix_fmts=yuv420p,vflip
+
    + +
  • Convert the input video to any of the formats not contained in the list: +
    +
    noformat=yuv420p|yuv444p|yuv410p
+
    +
+ + +

32.140 noise

+ +

Add noise on video input frame. +

+

The filter accepts the following options: +

+
+
all_seed
+
c0_seed
+
c1_seed
+
c2_seed
+
c3_seed
+

Set noise seed for specific pixel component or all pixel components in case +of all_seed. Default value is 123457. +

+
+
all_strength, alls
+
c0_strength, c0s
+
c1_strength, c1s
+
c2_strength, c2s
+
c3_strength, c3s
+

Set noise strength for specific pixel component or all pixel components in case +all_strength. Default value is 0. Allowed range is [0, 100]. +

+
+
all_flags, allf
+
c0_flags, c0f
+
c1_flags, c1f
+
c2_flags, c2f
+
c3_flags, c3f
+

Set pixel component flags or set flags for all components if all_flags. +Available values for component flags are: +

+
‘a’
+

averaged temporal noise (smoother) +

+
‘p’
+

mix random noise with a (semi)regular pattern +

+
‘t’
+

temporal noise (noise pattern changes between frames) +

+
‘u’
+

uniform noise (gaussian otherwise) +

+
+
+
+ + +

32.140.1 Examples

+ +

Add temporal and uniform noise to input video: +

+
noise=alls=20:allf=t+u
+
+ + +

32.141 normalize

+ +

Normalize RGB video (aka histogram stretching, contrast stretching). +See: https://en.wikipedia.org/wiki/Normalization_(image_processing) +

+

For each channel of each frame, the filter computes the input range and maps +it linearly to the user-specified output range. The output range defaults +to the full dynamic range from pure black to pure white. +

+

Temporal smoothing can be used on the input range to reduce flickering (rapid +changes in brightness) caused when small dark or bright objects enter or leave +the scene. This is similar to the auto-exposure (automatic gain control) on a +video camera, and, like a video camera, it may cause a period of over- or +under-exposure of the video. +

+

The R,G,B channels can be normalized independently, which may cause some +color shifting, or linked together as a single channel, which prevents +color shifting. Linked normalization preserves hue. Independent normalization +does not, so it can be used to remove some color casts. Independent and linked +normalization can be combined in any ratio. +

+

The normalize filter accepts the following options: +

+
+
blackpt
+
whitept
+

Colors which define the output range. The minimum input value is mapped to +the blackpt. The maximum input value is mapped to the whitept. +The defaults are black and white respectively. Specifying white for +blackpt and black for whitept will give color-inverted, +normalized video. Shades of grey can be used to reduce the dynamic range +(contrast). Specifying saturated colors here can create some interesting +effects. +

+
+
smoothing
+

The number of previous frames to use for temporal smoothing. The input range +of each channel is smoothed using a rolling average over the current frame +and the smoothing previous frames. The default is 0 (no temporal +smoothing). +

+
+
independence
+

Controls the ratio of independent (color shifting) channel normalization to +linked (color preserving) normalization. 0.0 is fully linked, 1.0 is fully +independent. Defaults to 1.0 (fully independent). +

+
+
strength
+

Overall strength of the filter. 1.0 is full strength. 0.0 is a rather +expensive no-op. Defaults to 1.0 (full strength). +

+
+
+ + +

32.141.1 Commands

+

This filter supports same commands as options, excluding smoothing option. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.141.2 Examples

+ +

Stretch video contrast to use the full dynamic range, with no temporal +smoothing; may flicker depending on the source content: +

+
normalize=blackpt=black:whitept=white:smoothing=0
+
+ +

As above, but with 50 frames of temporal smoothing; flicker should be +reduced, depending on the source content: +

+
normalize=blackpt=black:whitept=white:smoothing=50
+
+ +

As above, but with hue-preserving linked channel normalization: +

+
normalize=blackpt=black:whitept=white:smoothing=50:independence=0
+
+ +

As above, but with half strength: +

+
normalize=blackpt=black:whitept=white:smoothing=50:independence=0:strength=0.5
+
+ +

Map the darkest input color to red, the brightest input color to cyan: +

+
normalize=blackpt=red:whitept=cyan
+
+ + +

32.142 null

+ +

Pass the video source unchanged to the output. +

+ +

32.143 ocr

+

Optical Character Recognition +

+

This filter uses Tesseract for optical character recognition. To enable +compilation of this filter, you need to configure FFmpeg with +--enable-libtesseract. +

+

It accepts the following options: +

+
+
datapath
+

Set datapath to tesseract data. Default is to use whatever was +set at installation. +

+
+
language
+

Set language, default is "eng". +

+
+
whitelist
+

Set character whitelist. +

+
+
blacklist
+

Set character blacklist. +

+
+ +

The filter exports recognized text as the frame metadata lavfi.ocr.text. +The filter exports confidence of recognized words as the frame metadata lavfi.ocr.confidence. +

+ +

32.144 ocv

+ +

Apply a video transform using libopencv. +

+

To enable this filter, install the libopencv library and headers and +configure FFmpeg with --enable-libopencv. +

+

It accepts the following parameters: +

+
+
filter_name
+

The name of the libopencv filter to apply. +

+
+
filter_params
+

The parameters to pass to the libopencv filter. If not specified, the default +values are assumed. +

+
+
+ +

Refer to the official libopencv documentation for more precise +information: +http://docs.opencv.org/master/modules/imgproc/doc/filtering.html +

+

Several libopencv filters are supported; see the following subsections. +

+ +

32.144.1 dilate

+ +

Dilate an image by using a specific structuring element. +It corresponds to the libopencv function cvDilate. +

+

It accepts the parameters: struct_el|nb_iterations. +

+

struct_el represents a structuring element, and has the syntax: +colsxrows+anchor_xxanchor_y/shape +

+

cols and rows represent the number of columns and rows of +the structuring element, anchor_x and anchor_y the anchor +point, and shape the shape for the structuring element. shape +must be "rect", "cross", "ellipse", or "custom". +

+

If the value for shape is "custom", it must be followed by a +string of the form "=filename". The file with name +filename is assumed to represent a binary image, with each +printable character corresponding to a bright pixel. When a custom +shape is used, cols and rows are ignored, the number +or columns and rows of the read file are assumed instead. +

+

The default value for struct_el is "3x3+0x0/rect". +

+

nb_iterations specifies the number of times the transform is +applied to the image, and defaults to 1. +

+

Some examples: +

+
# Use the default values
+ocv=dilate
+
+# Dilate using a structuring element with a 5x5 cross, iterating two times
+ocv=filter_name=dilate:filter_params=5x5+2x2/cross|2
+
+# Read the shape from the file diamond.shape, iterating two times.
+# The file diamond.shape may contain a pattern of characters like this
+#   *
+#  ***
+# *****
+#  ***
+#   *
+# The specified columns and rows are ignored
+# but the anchor point coordinates are not
+ocv=dilate:0x0+2x2/custom=diamond.shape|2
+
+ + +

32.144.2 erode

+ +

Erode an image by using a specific structuring element. +It corresponds to the libopencv function cvErode. +

+

It accepts the parameters: struct_el:nb_iterations, +with the same syntax and semantics as the dilate filter. +

+ +

32.144.3 smooth

+ +

Smooth the input video. +

+

The filter takes the following parameters: +type|param1|param2|param3|param4. +

+

type is the type of smooth filter to apply, and must be one of +the following values: "blur", "blur_no_scale", "median", "gaussian", +or "bilateral". The default value is "gaussian". +

+

The meaning of param1, param2, param3, and param4 +depends on the smooth type. param1 and +param2 accept integer positive values or 0. param3 and +param4 accept floating point values. +

+

The default value for param1 is 3. The default value for the +other parameters is 0. +

+

These parameters correspond to the parameters assigned to the +libopencv function cvSmooth. +

+ +

32.145 oscilloscope

+ +

2D Video Oscilloscope. +

+

Useful to measure spatial impulse, step responses, chroma delays, etc. +

+

It accepts the following parameters: +

+
+
x
+

Set scope center x position. +

+
+
y
+

Set scope center y position. +

+
+
s
+

Set scope size, relative to frame diagonal. +

+
+
t
+

Set scope tilt/rotation. +

+
+
o
+

Set trace opacity. +

+
+
tx
+

Set trace center x position. +

+
+
ty
+

Set trace center y position. +

+
+
tw
+

Set trace width, relative to width of frame. +

+
+
th
+

Set trace height, relative to height of frame. +

+
+
c
+

Set which components to trace. By default it traces first three components. +

+
+
g
+

Draw trace grid. By default is enabled. +

+
+
st
+

Draw some statistics. By default is enabled. +

+
+
sc
+

Draw scope. By default is enabled. +

+
+ + +

32.145.1 Commands

+

This filter supports same commands as options. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+ +

32.145.2 Examples

+ +
    +
  • Inspect full first row of video frame. +
    +
    oscilloscope=x=0.5:y=0:s=1
+
    + +
  • Inspect full last row of video frame. +
    +
    oscilloscope=x=0.5:y=1:s=1
+
    + +
  • Inspect full 5th line of video frame of height 1080. +
    +
    oscilloscope=x=0.5:y=5/1080:s=1
+
    + +
  • Inspect full last column of video frame. +
    +
    oscilloscope=x=1:y=0.5:s=1:t=1
+
    + +
+ + +

32.146 overlay

+ +

Overlay one video on top of another. +

+

It takes two inputs and has one output. The first input is the "main" +video on which the second input is overlaid. +

+

It accepts the following parameters: +

+

A description of the accepted options follows. +

+
+
x
+
y
+

Set the expression for the x and y coordinates of the overlaid video +on the main video. Default value is "0" for both expressions. In case +the expression is invalid, it is set to a huge value (meaning that the +overlay will not be displayed within the output visible area). +

+
+
eof_action
+

See framesync. +

+
+
eval
+

Set when the expressions for x, and y are evaluated. +

+

It accepts the following values: +

+
‘init’
+

only evaluate expressions once during the filter initialization or +when a command is processed +

+
+
‘frame’
+

evaluate expressions for each incoming frame +

+
+ +

Default value is ‘frame’. +

+
+
shortest
+

See framesync. +

+
+
format
+

Set the format for the output video. +

+

It accepts the following values: +

+
‘yuv420’
+

force YUV420 output +

+
+
‘yuv422’
+

force YUV422 output +

+
+
‘yuv444’
+

force YUV444 output +

+
+
‘rgb’
+

force packed RGB output +

+
+
‘gbrp’
+

force planar RGB output +

+
+
‘auto’
+

automatically pick format +

+
+ +

Default value is ‘yuv420’. +

+
+
repeatlast
+

See framesync. +

+
+
alpha
+

Set format of alpha of the overlaid video, it can be straight or +premultiplied. Default is straight. +

+
+ +

The x, and y expressions can contain the following +parameters. +

+
+
main_w, W
+
main_h, H
+

The main input width and height. +

+
+
overlay_w, w
+
overlay_h, h
+

The overlay input width and height. +

+
+
x
+
y
+

The computed values for x and y. They are evaluated for +each new frame. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values of the output +format. For example for the pixel format "yuv422p" hsub is 2 and +vsub is 1. +

+
+
n
+

the number of input frame, starting from 0 +

+
+
pos
+

the position in the file of the input frame, NAN if unknown +

+
+
t
+

The timestamp, expressed in seconds. It’s NAN if the input timestamp is unknown. +

+
+
+ +

This filter also supports the framesync options. +

+

Note that the n, pos, t variables are available only +when evaluation is done per frame, and will evaluate to NAN +when eval is set to ‘init’. +

+

Be aware that frames are taken from each input video in timestamp +order, hence, if their initial timestamps differ, it is a good idea +to pass the two inputs through a setpts=PTS-STARTPTS filter to +have them begin in the same zero timestamp, as the example for +the movie filter does. +

+

You can chain together more overlays but you should test the +efficiency of such approach. +

+ +

32.146.1 Commands

+ +

This filter supports the following commands: +

+
x
+
y
+

Modify the x and y of the overlay input. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

32.146.2 Examples

+ +
    +
  • Draw the overlay at 10 pixels from the bottom right corner of the main +video: +
    +
    overlay=main_w-overlay_w-10:main_h-overlay_h-10
+
    + +

    Using named options the example above becomes: +

    +
    overlay=x=main_w-overlay_w-10:y=main_h-overlay_h-10
+
    + +
  • Insert a transparent PNG logo in the bottom left corner of the input, +using the ffmpeg tool with the -filter_complex option: +
    +
    ffmpeg -i input -i logo -filter_complex 'overlay=10:main_h-overlay_h-10' output
+
    + +
  • Insert 2 different transparent PNG logos (second logo on bottom +right corner) using the ffmpeg tool: +
    +
    ffmpeg -i input -i logo1 -i logo2 -filter_complex 'overlay=x=10:y=H-h-10,overlay=x=W-w-10:y=H-h-10' output
+
    + +
  • Add a transparent color layer on top of the main video; WxH +must specify the size of the main input to the overlay filter: +
    +
    color=color=red@.3:size=WxH [over]; [in][over] overlay [out]
+
    + +
  • Play an original video and a filtered version (here with the deshake +filter) side by side using the ffplay tool: +
    +
    ffplay input.avi -vf 'split[a][b]; [a]pad=iw*2:ih[src]; [b]deshake[filt]; [src][filt]overlay=w'
+
    + +

    The above command is the same as: +

    +
    ffplay input.avi -vf 'split[b], pad=iw*2[src], [b]deshake, [src]overlay=w'
+
    + +
  • Make a sliding overlay appearing from the left to the right top part of the +screen starting since time 2: +
    +
    overlay=x='if(gte(t,2), -w+(t-2)*20, NAN)':y=0
+
    + +
  • Compose output by putting two input videos side to side: +
    +
    ffmpeg -i left.avi -i right.avi -filter_complex "
+nullsrc=size=200x100 [background];
+[0:v] setpts=PTS-STARTPTS, scale=100x100 [left];
+[1:v] setpts=PTS-STARTPTS, scale=100x100 [right];
+[background][left]       overlay=shortest=1       [background+left];
+[background+left][right] overlay=shortest=1:x=100 [left+right]
+"
+
    + +
  • Mask 10-20 seconds of a video by applying the delogo filter to a section +
    +
    ffmpeg -i test.avi -codec:v:0 wmv2 -ar 11025 -b:v 9000k
+-vf '[in]split[split_main][split_delogo];[split_delogo]trim=start=360:end=371,delogo=0:0:640:480[delogoed];[split_main][delogoed]overlay=eof_action=pass[out]'
+masked.avi
+
    + +
  • Chain several overlays in cascade: +
    +
    nullsrc=s=200x200 [bg];
+testsrc=s=100x100, split=4 [in0][in1][in2][in3];
+[in0] lutrgb=r=0, [bg]   overlay=0:0     [mid0];
+[in1] lutrgb=g=0, [mid0] overlay=100:0   [mid1];
+[in2] lutrgb=b=0, [mid1] overlay=0:100   [mid2];
+[in3] null,       [mid2] overlay=100:100 [out0]
+
    + +
+ + +

32.147 overlay_cuda

+ +

Overlay one video on top of another. +

+

This is the CUDA cariant of the overlay filter. +It only accepts CUDA frames. The underlying input pixel formats have to match. +

+

It takes two inputs and has one output. The first input is the "main" +video on which the second input is overlaid. +

+

It accepts the following parameters: +

+
+
x
+
y
+

Set the x and y coordinates of the overlaid video on the main video. +Default value is "0" for both expressions. +

+
+
eof_action
+

See framesync. +

+
+
shortest
+

See framesync. +

+
+
repeatlast
+

See framesync. +

+
+
+ +

This filter also supports the framesync options. +

+ +

32.148 owdenoise

+ +

Apply Overcomplete Wavelet denoiser. +

+

The filter accepts the following options: +

+
+
depth
+

Set depth. +

+

Larger depth values will denoise lower frequency components more, but +slow down filtering. +

+

Must be an int in the range 8-16, default is 8. +

+
+
luma_strength, ls
+

Set luma strength. +

+

Must be a double value in the range 0-1000, default is 1.0. +

+
+
chroma_strength, cs
+

Set chroma strength. +

+

Must be a double value in the range 0-1000, default is 1.0. +

+
+ + +

32.149 pad

+ +

Add paddings to the input image, and place the original input at the +provided x, y coordinates. +

+

It accepts the following parameters: +

+
+
width, w
+
height, h
+

Specify an expression for the size of the output image with the +paddings added. If the value for width or height is 0, the +corresponding input size is used for the output. +

+

The width expression can reference the value set by the +height expression, and vice versa. +

+

The default value of width and height is 0. +

+
+
x
+
y
+

Specify the offsets to place the input image at within the padded area, +with respect to the top/left border of the output image. +

+

The x expression can reference the value set by the y +expression, and vice versa. +

+

The default value of x and y is 0. +

+

If x or y evaluate to a negative number, they’ll be changed +so the input image is centered on the padded area. +

+
+
color
+

Specify the color of the padded area. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. +

+

The default value of color is "black". +

+
+
eval
+

Specify when to evaluate width, height, x and y expression. +

+

It accepts the following values: +

+
+
‘init’
+

Only evaluate expressions once during the filter initialization or when +a command is processed. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. +

+
+
+ +

Default value is ‘init’. +

+
+
aspect
+

Pad to aspect instead to a resolution. +

+
+
+ +

The value for the width, height, x, and y +options are expressions containing the following constants: +

+
+
in_w
+
in_h
+

The input video width and height. +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output width and height (the size of the padded area), as +specified by the width and height expressions. +

+
+
ow
+
oh
+

These are the same as out_w and out_h. +

+
+
x
+
y
+

The x and y offsets as specified by the x and y +expressions, or NAN if not yet specified. +

+
+
a
+

same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (iw / ih) * sar +

+
+
hsub
+
vsub
+

The horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+ + +

32.149.1 Examples

+ +
    +
  • Add paddings with the color "violet" to the input video. The output video +size is 640x480, and the top-left corner of the input video is placed at +column 0, row 40 +
    +
    pad=640:480:0:40:violet
+
    + +

    The example above is equivalent to the following command: +

    +
    pad=width=640:height=480:x=0:y=40:color=violet
+
    + +
  • Pad the input to get an output with dimensions increased by 3/2, +and put the input video at the center of the padded area: +
    +
    pad="3/2*iw:3/2*ih:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • Pad the input to get a squared output with size equal to the maximum +value between the input width and height, and put the input video at +the center of the padded area: +
    +
    pad="max(iw\,ih):ow:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • Pad the input to get a final w/h ratio of 16:9: +
    +
    pad="ih*16/9:ih:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • In case of anamorphic video, in order to set the output display aspect +correctly, it is necessary to use sar in the expression, +according to the relation: +
    +
    (ih * X / ih) * sar = output_dar
+X = output_dar / sar
+
    + +

    Thus the previous example needs to be modified to: +

    +
    pad="ih*16/9/sar:ih:(ow-iw)/2:(oh-ih)/2"
+
    + +
  • Double the output size and put the input video in the bottom-right +corner of the output padded area: +
    +
    pad="2*iw:2*ih:ow-iw:oh-ih"
+
    +
+ + +

32.150 palettegen

+ +

Generate one palette for a whole video stream. +

+

It accepts the following options: +

+
+
max_colors
+

Set the maximum number of colors to quantize in the palette. +Note: the palette will still contain 256 colors; the unused palette entries +will be black. +

+
+
reserve_transparent
+

Create a palette of 255 colors maximum and reserve the last one for +transparency. Reserving the transparency color is useful for GIF optimization. +If not set, the maximum of colors in the palette will be 256. You probably want +to disable this option for a standalone image. +Set by default. +

+
+
transparency_color
+

Set the color that will be used as background for transparency. +

+
+
stats_mode
+

Set statistics mode. +

+

It accepts the following values: +

+
‘full’
+

Compute full frame histograms. +

+
‘diff’
+

Compute histograms only for the part that differs from previous frame. This +might be relevant to give more importance to the moving part of your input if +the background is static. +

+
‘single’
+

Compute new histogram for each frame. +

+
+ +

Default value is full. +

+
+ +

The filter also exports the frame metadata lavfi.color_quant_ratio +(nb_color_in / nb_color_out) which you can use to evaluate the degree of +color quantization of the palette. This information is also visible at +info logging level. +

+ +

32.150.1 Examples

+ +
    +
  • Generate a representative palette of a given video using ffmpeg: +
    +
    ffmpeg -i input.mkv -vf palettegen palette.png
+
    +
+ + +

32.151 paletteuse

+ +

Use a palette to downsample an input video stream. +

+

The filter takes two inputs: one video stream and a palette. The palette must +be a 256 pixels image. +

+

It accepts the following options: +

+
+
dither
+

Select dithering mode. Available algorithms are: +

+
‘bayer’
+

Ordered 8x8 bayer dithering (deterministic) +

+
‘heckbert’
+

Dithering as defined by Paul Heckbert in 1982 (simple error diffusion). +Note: this dithering is sometimes considered "wrong" and is included as a +reference. +

+
‘floyd_steinberg’
+

Floyd and Steingberg dithering (error diffusion) +

+
‘sierra2’
+

Frankie Sierra dithering v2 (error diffusion) +

+
‘sierra2_4a’
+

Frankie Sierra dithering v2 "Lite" (error diffusion) +

+
+ +

Default is sierra2_4a. +

+
+
bayer_scale
+

When bayer dithering is selected, this option defines the scale of the +pattern (how much the crosshatch pattern is visible). A low value means more +visible pattern for less banding, and higher value means less visible pattern +at the cost of more banding. +

+

The option must be an integer value in the range [0,5]. Default is 2. +

+
+
diff_mode
+

If set, define the zone to process +

+
+
‘rectangle’
+

Only the changing rectangle will be reprocessed. This is similar to GIF +cropping/offsetting compression mechanism. This option can be useful for speed +if only a part of the image is changing, and has use cases such as limiting the +scope of the error diffusal dither to the rectangle that bounds the +moving scene (it leads to more deterministic output if the scene doesn’t change +much, and as a result less moving noise and better GIF compression). +

+
+ +

Default is none. +

+
+
new
+

Take new palette for each output frame. +

+
+
alpha_threshold
+

Sets the alpha threshold for transparency. Alpha values above this threshold +will be treated as completely opaque, and values below this threshold will be +treated as completely transparent. +

+

The option must be an integer value in the range [0,255]. Default is 128. +

+
+ + +

32.151.1 Examples

+ +
    +
  • Use a palette (generated for example with palettegen) to encode a GIF +using ffmpeg: +
    +
    ffmpeg -i input.mkv -i palette.png -lavfi paletteuse output.gif
+
    +
+ + +

32.152 perspective

+ +

Correct perspective of video not recorded perpendicular to the screen. +

+

A description of the accepted parameters follows. +

+
+
x0
+
y0
+
x1
+
y1
+
x2
+
y2
+
x3
+
y3
+

Set coordinates expression for top left, top right, bottom left and bottom right corners. +Default values are 0:0:W:0:0:H:W:H with which perspective will remain unchanged. +If the sense option is set to source, then the specified points will be sent +to the corners of the destination. If the sense option is set to destination, +then the corners of the source will be sent to the specified coordinates. +

+

The expressions can use the following variables: +

+
+
W
+
H
+

the width and height of video frame. +

+
in
+

Input frame count. +

+
on
+

Output frame count. +

+
+ +
+
interpolation
+

Set interpolation for perspective correction. +

+

It accepts the following values: +

+
‘linear’
+
‘cubic’
+
+ +

Default value is ‘linear’. +

+
+
sense
+

Set interpretation of coordinate options. +

+

It accepts the following values: +

+
‘0, source’
+
+

Send point in the source specified by the given coordinates to +the corners of the destination. +

+
+
‘1, destination’
+
+

Send the corners of the source to the point in the destination specified +by the given coordinates. +

+

Default value is ‘source’. +

+
+ +
+
eval
+

Set when the expressions for coordinates x0,y0,...x3,y3 are evaluated. +

+

It accepts the following values: +

+
‘init’
+

only evaluate expressions once during the filter initialization or +when a command is processed +

+
+
‘frame’
+

evaluate expressions for each incoming frame +

+
+ +

Default value is ‘init’. +

+
+ + +

32.153 phase

+ +

Delay interlaced video by one field time so that the field order changes. +

+

The intended use is to fix PAL movies that have been captured with the +opposite field order to the film-to-video transfer. +

+

A description of the accepted parameters follows. +

+
+
mode
+

Set phase mode. +

+

It accepts the following values: +

+
‘t’
+

Capture field order top-first, transfer bottom-first. +Filter will delay the bottom field. +

+
+
‘b’
+

Capture field order bottom-first, transfer top-first. +Filter will delay the top field. +

+
+
‘p’
+

Capture and transfer with the same field order. This mode only exists +for the documentation of the other options to refer to, but if you +actually select it, the filter will faithfully do nothing. +

+
+
‘a’
+

Capture field order determined automatically by field flags, transfer +opposite. +Filter selects among ‘t’ and ‘b’ modes on a frame by frame +basis using field flags. If no field information is available, +then this works just like ‘u’. +

+
+
‘u’
+

Capture unknown or varying, transfer opposite. +Filter selects among ‘t’ and ‘b’ on a frame by frame basis by +analyzing the images and selecting the alternative that produces best +match between the fields. +

+
+
‘T’
+

Capture top-first, transfer unknown or varying. +Filter selects among ‘t’ and ‘p’ using image analysis. +

+
+
‘B’
+

Capture bottom-first, transfer unknown or varying. +Filter selects among ‘b’ and ‘p’ using image analysis. +

+
+
‘A’
+

Capture determined by field flags, transfer unknown or varying. +Filter selects among ‘t’, ‘b’ and ‘p’ using field flags and +image analysis. If no field information is available, then this works just +like ‘U’. This is the default mode. +

+
+
‘U’
+

Both capture and transfer unknown or varying. +Filter selects among ‘t’, ‘b’ and ‘p’ using image analysis only. +

+
+
+
+ + +

32.154 photosensitivity

+

Reduce various flashes in video, so to help users with epilepsy. +

+

It accepts the following options: +

+
frames, f
+

Set how many frames to use when filtering. Default is 30. +

+
+
threshold, t
+

Set detection threshold factor. Default is 1. +Lower is stricter. +

+
+
skip
+

Set how many pixels to skip when sampling frames. Default is 1. +Allowed range is from 1 to 1024. +

+
+
bypass
+

Leave frames unchanged. Default is disabled. +

+
+ + +

32.155 pixdesctest

+ +

Pixel format descriptor test filter, mainly useful for internal +testing. The output video should be equal to the input video. +

+

For example: +

+
format=monow, pixdesctest
+
+ +

can be used to test the monowhite pixel format descriptor definition. +

+ +

32.156 pixscope

+ +

Display sample values of color channels. Mainly useful for checking color +and levels. Minimum supported resolution is 640x480. +

+

The filters accept the following options: +

+
+
x
+

Set scope X position, relative offset on X axis. +

+
+
y
+

Set scope Y position, relative offset on Y axis. +

+
+
w
+

Set scope width. +

+
+
h
+

Set scope height. +

+
+
o
+

Set window opacity. This window also holds statistics about pixel area. +

+
+
wx
+

Set window X position, relative offset on X axis. +

+
+
wy
+

Set window Y position, relative offset on Y axis. +

+
+ + +

32.157 pp

+ +

Enable the specified chain of postprocessing subfilters using libpostproc. This +library should be automatically selected with a GPL build (--enable-gpl). +Subfilters must be separated by ’/’ and can be disabled by prepending a ’-’. +Each subfilter and some options have a short and a long name that can be used +interchangeably, i.e. dr/dering are the same. +

+

The filters accept the following options: +

+
+
subfilters
+

Set postprocessing subfilters string. +

+
+ +

All subfilters share common options to determine their scope: +

+
+
a/autoq
+

Honor the quality commands for this subfilter. +

+
+
c/chrom
+

Do chrominance filtering, too (default). +

+
+
y/nochrom
+

Do luminance filtering only (no chrominance). +

+
+
n/noluma
+

Do chrominance filtering only (no luminance). +

+
+ +

These options can be appended after the subfilter name, separated by a ’|’. +

+

Available subfilters are: +

+
+
hb/hdeblock[|difference[|flatness]]
+

Horizontal deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+ +
+
vb/vdeblock[|difference[|flatness]]
+

Vertical deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+ +
+
ha/hadeblock[|difference[|flatness]]
+

Accurate horizontal deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+ +
+
va/vadeblock[|difference[|flatness]]
+

Accurate vertical deblocking filter +

+
difference
+

Difference factor where higher values mean more deblocking (default: 32). +

+
flatness
+

Flatness threshold where lower values mean more deblocking (default: 39). +

+
+
+
+ +

The horizontal and vertical deblocking filters share the difference and +flatness values so you cannot set different horizontal and vertical +thresholds. +

+
+
h1/x1hdeblock
+

Experimental horizontal deblocking filter +

+
+
v1/x1vdeblock
+

Experimental vertical deblocking filter +

+
+
dr/dering
+

Deringing filter +

+
+
tn/tmpnoise[|threshold1[|threshold2[|threshold3]]], temporal noise reducer
+
+
threshold1
+

larger -> stronger filtering +

+
threshold2
+

larger -> stronger filtering +

+
threshold3
+

larger -> stronger filtering +

+
+ +
+
al/autolevels[:f/fullyrange], automatic brightness / contrast correction
+
+
f/fullyrange
+

Stretch luminance to 0-255. +

+
+ +
+
lb/linblenddeint
+

Linear blend deinterlacing filter that deinterlaces the given block by +filtering all lines with a (1 2 1) filter. +

+
+
li/linipoldeint
+

Linear interpolating deinterlacing filter that deinterlaces the given block by +linearly interpolating every second line. +

+
+
ci/cubicipoldeint
+

Cubic interpolating deinterlacing filter deinterlaces the given block by +cubically interpolating every second line. +

+
+
md/mediandeint
+

Median deinterlacing filter that deinterlaces the given block by applying a +median filter to every second line. +

+
+
fd/ffmpegdeint
+

FFmpeg deinterlacing filter that deinterlaces the given block by filtering every +second line with a (-1 4 2 4 -1) filter. +

+
+
l5/lowpass5
+

Vertically applied FIR lowpass deinterlacing filter that deinterlaces the given +block by filtering all lines with a (-1 2 6 2 -1) filter. +

+
+
fq/forceQuant[|quantizer]
+

Overrides the quantizer table from the input with the constant quantizer you +specify. +

+
quantizer
+

Quantizer to use +

+
+ +
+
de/default
+

Default pp filter combination (hb|a,vb|a,dr|a) +

+
+
fa/fast
+

Fast pp filter combination (h1|a,v1|a,dr|a) +

+
+
ac
+

High quality pp filter combination (ha|a|128|7,va|a,dr|a) +

+
+ + +

32.157.1 Examples

+ +
    +
  • Apply horizontal and vertical deblocking, deringing and automatic +brightness/contrast: +
    +
    pp=hb/vb/dr/al
+
    + +
  • Apply default filters without brightness/contrast correction: +
    +
    pp=de/-al
+
    + +
  • Apply default filters and temporal denoiser: +
    +
    pp=default/tmpnoise|1|2|3
+
    + +
  • Apply deblocking on luminance only, and switch vertical deblocking on or off +automatically depending on available CPU time: +
    +
    pp=hb|y/vb|a
+
    +
+ + +

32.158 pp7

+

Apply Postprocessing filter 7. It is variant of the spp filter, +similar to spp = 6 with 7 point DCT, where only the center sample is +used after IDCT. +

+

The filter accepts the following options: +

+
+
qp
+

Force a constant quantization parameter. It accepts an integer in range +0 to 63. If not set, the filter will use the QP from the video stream +(if available). +

+
+
mode
+

Set thresholding mode. Available modes are: +

+
+
‘hard’
+

Set hard thresholding. +

+
‘soft’
+

Set soft thresholding (better de-ringing effect, but likely blurrier). +

+
‘medium’
+

Set medium thresholding (good results, default). +

+
+
+
+ + +

32.159 premultiply

+

Apply alpha premultiply effect to input video stream using first plane +of second stream as alpha. +

+

Both streams must have same dimensions and same pixel format. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
inplace
+

Do not require 2nd input for processing, instead use alpha plane from input stream. +

+
+ + +

32.160 prewitt

+

Apply prewitt operator to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +

+
+
delta
+

Set value which will be added to filtered result. +

+
+ + +

32.161 pseudocolor

+ +

Alter frame colors in video with pseudocolors. +

+

This filter accepts the following options: +

+
+
c0
+

set pixel first component expression +

+
+
c1
+

set pixel second component expression +

+
+
c2
+

set pixel third component expression +

+
+
c3
+

set pixel fourth component expression, corresponds to the alpha component +

+
+
i
+

set component to use as base for altering colors +

+
+ +

Each of them specifies the expression to use for computing the lookup table for +the corresponding pixel component values. +

+

The expressions can contain the following constants and functions: +

+
+
w
+
h
+

The input width and height. +

+
+
val
+

The input value for the pixel component. +

+
+
ymin, umin, vmin, amin
+

The minimum allowed component value. +

+
+
ymax, umax, vmax, amax
+

The maximum allowed component value. +

+
+ +

All expressions default to "val". +

+ +

32.161.1 Examples

+ +
    +
  • Change too high luma values to gradient: +
    +
    pseudocolor="'if(between(val,ymax,amax),lerp(ymin,ymax,(val-ymax)/(amax-ymax)),-1):if(between(val,ymax,amax),lerp(umax,umin,(val-ymax)/(amax-ymax)),-1):if(between(val,ymax,amax),lerp(vmin,vmax,(val-ymax)/(amax-ymax)),-1):-1'"
+
    +
+ + +

32.162 psnr

+ +

Obtain the average, maximum and minimum PSNR (Peak Signal to Noise +Ratio) between two input videos. +

+

This filter takes in input two input videos, the first input is +considered the "main" source and is passed unchanged to the +output. The second input is used as a "reference" video for computing +the PSNR. +

+

Both video inputs must have the same resolution and pixel format for +this filter to work correctly. Also it assumes that both inputs +have the same number of frames, which are compared one by one. +

+

The obtained average PSNR is printed through the logging system. +

+

The filter stores the accumulated MSE (mean squared error) of each +frame, and at the end of the processing it is averaged across all frames +equally, and the following formula is applied to obtain the PSNR: +

+
+
PSNR = 10*log10(MAX^2/MSE)
+
+ +

Where MAX is the average of the maximum values of each component of the +image. +

+

The description of the accepted parameters follows. +

+
+
stats_file, f
+

If specified the filter will use the named file to save the PSNR of +each individual frame. When filename equals "-" the data is sent to +standard output. +

+
+
stats_version
+

Specifies which version of the stats file format to use. Details of +each format are written below. +Default value is 1. +

+
+
stats_add_max
+

Determines whether the max value is output to the stats log. +Default value is 0. +Requires stats_version >= 2. If this is set and stats_version < 2, +the filter will return an error. +

+
+ +

This filter also supports the framesync options. +

+

The file printed if stats_file is selected, contains a sequence of +key/value pairs of the form key:value for each compared +couple of frames. +

+

If a stats_version greater than 1 is specified, a header line precedes +the list of per-frame-pair stats, with key value pairs following the frame +format with the following parameters: +

+
+
psnr_log_version
+

The version of the log file format. Will match stats_version. +

+
+
fields
+

A comma separated list of the per-frame-pair parameters included in +the log. +

+
+ +

A description of each shown per-frame-pair parameter follows: +

+
+
n
+

sequential number of the input frame, starting from 1 +

+
+
mse_avg
+

Mean Square Error pixel-by-pixel average difference of the compared +frames, averaged over all the image components. +

+
+
mse_y, mse_u, mse_v, mse_r, mse_g, mse_b, mse_a
+

Mean Square Error pixel-by-pixel average difference of the compared +frames for the component specified by the suffix. +

+
+
psnr_y, psnr_u, psnr_v, psnr_r, psnr_g, psnr_b, psnr_a
+

Peak Signal to Noise ratio of the compared frames for the component +specified by the suffix. +

+
+
max_avg, max_y, max_u, max_v
+

Maximum allowed value for each channel, and average over all +channels. +

+
+ + +

32.162.1 Examples

+
    +
  • For example: +
    +
    movie=ref_movie.mpg, setpts=PTS-STARTPTS [main];
+[main][ref] psnr="stats_file=stats.log" [out]
+
    + +

    On this example the input file being processed is compared with the +reference file ref_movie.mpg. The PSNR of each individual frame +is stored in stats.log. +

    +
  • Another example with different containers: +
    +
    ffmpeg -i main.mpg -i ref.mkv -lavfi  "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]psnr" -f null -
+
    +
+ + +

32.163 pullup

+ +

Pulldown reversal (inverse telecine) filter, capable of handling mixed +hard-telecine, 24000/1001 fps progressive, and 30000/1001 fps progressive +content. +

+

The pullup filter is designed to take advantage of future context in making +its decisions. This filter is stateless in the sense that it does not lock +onto a pattern to follow, but it instead looks forward to the following +fields in order to identify matches and rebuild progressive frames. +

+

To produce content with an even framerate, insert the fps filter after +pullup, use fps=24000/1001 if the input frame rate is 29.97fps, +fps=24 for 30fps and the (rare) telecined 25fps input. +

+

The filter accepts the following options: +

+
+
jl
+
jr
+
jt
+
jb
+

These options set the amount of "junk" to ignore at the left, right, top, and +bottom of the image, respectively. Left and right are in units of 8 pixels, +while top and bottom are in units of 2 lines. +The default is 8 pixels on each side. +

+
+
sb
+

Set the strict breaks. Setting this option to 1 will reduce the chances of +filter generating an occasional mismatched frame, but it may also cause an +excessive number of frames to be dropped during high motion sequences. +Conversely, setting it to -1 will make filter match fields more easily. +This may help processing of video where there is slight blurring between +the fields, but may also cause there to be interlaced frames in the output. +Default value is 0. +

+
+
mp
+

Set the metric plane to use. It accepts the following values: +

+
‘l’
+

Use luma plane. +

+
+
‘u’
+

Use chroma blue plane. +

+
+
‘v’
+

Use chroma red plane. +

+
+ +

This option may be set to use chroma plane instead of the default luma plane +for doing filter’s computations. This may improve accuracy on very clean +source material, but more likely will decrease accuracy, especially if there +is chroma noise (rainbow effect) or any grayscale video. +The main purpose of setting mp to a chroma plane is to reduce CPU +load and make pullup usable in realtime on slow machines. +

+
+ +

For best results (without duplicated frames in the output file) it is +necessary to change the output frame rate. For example, to inverse +telecine NTSC input: +

+
ffmpeg -i input -vf pullup -r 24000/1001 ...
+
+ + +

32.164 qp

+ +

Change video quantization parameters (QP). +

+

The filter accepts the following option: +

+
+
qp
+

Set expression for quantization parameter. +

+
+ +

The expression is evaluated through the eval API and can contain, among others, +the following constants: +

+
+
known
+

1 if index is not 129, 0 otherwise. +

+
+
qp
+

Sequential index starting from -129 to 128. +

+
+ + +

32.164.1 Examples

+ +
    +
  • Some equation like: +
    +
    qp=2+2*sin(PI*qp)
+
    +
+ + +

32.165 random

+ +

Flush video frames from internal cache of frames into a random order. +No frame is discarded. +Inspired by frei0r nervous filter. +

+
+
frames
+

Set size in number of frames of internal cache, in range from 2 to +512. Default is 30. +

+
+
seed
+

Set seed for random number generator, must be an integer included between +0 and UINT32_MAX. If not specified, or if explicitly set to +less than 0, the filter will try to use a good random seed on a +best effort basis. +

+
+ + +

32.166 readeia608

+ +

Read closed captioning (EIA-608) information from the top lines of a video frame. +

+

This filter adds frame metadata for lavfi.readeia608.X.cc and +lavfi.readeia608.X.line, where X is the number of the identified line +with EIA-608 data (starting from 0). A description of each metadata value follows: +

+
+
lavfi.readeia608.X.cc
+

The two bytes stored as EIA-608 data (printed in hexadecimal). +

+
+
lavfi.readeia608.X.line
+

The number of the line on which the EIA-608 data was identified and read. +

+
+ +

This filter accepts the following options: +

+
+
scan_min
+

Set the line to start scanning for EIA-608 data. Default is 0. +

+
+
scan_max
+

Set the line to end scanning for EIA-608 data. Default is 29. +

+
+
spw
+

Set the ratio of width reserved for sync code detection. +Default is 0.27. Allowed range is [0.1 - 0.7]. +

+
+
chp
+

Enable checking the parity bit. In the event of a parity error, the filter will output +0x00 for that character. Default is false. +

+
+
lp
+

Lowpass lines prior to further processing. Default is enabled. +

+
+ + +

32.166.1 Examples

+ +
    +
  • Output a csv with presentation time and the first two lines of identified EIA-608 captioning data. +
    +
    ffprobe -f lavfi -i movie=captioned_video.mov,readeia608 -show_entries frame=pkt_pts_time:frame_tags=lavfi.readeia608.0.cc,lavfi.readeia608.1.cc -of csv
+
    +
+ + +

32.167 readvitc

+ +

Read vertical interval timecode (VITC) information from the top lines of a +video frame. +

+

The filter adds frame metadata key lavfi.readvitc.tc_str with the +timecode value, if a valid timecode has been detected. Further metadata key +lavfi.readvitc.found is set to 0/1 depending on whether +timecode data has been found or not. +

+

This filter accepts the following options: +

+
+
scan_max
+

Set the maximum number of lines to scan for VITC data. If the value is set to +-1 the full video frame is scanned. Default is 45. +

+
+
thr_b
+

Set the luma threshold for black. Accepts float numbers in the range [0.0,1.0], +default value is 0.2. The value must be equal or less than thr_w. +

+
+
thr_w
+

Set the luma threshold for white. Accepts float numbers in the range [0.0,1.0], +default value is 0.6. The value must be equal or greater than thr_b. +

+
+ + +

32.167.1 Examples

+ +
    +
  • Detect and draw VITC data onto the video frame; if no valid VITC is detected, +draw --:--:--:-- as a placeholder: +
    +
    ffmpeg -i input.avi -filter:v 'readvitc,drawtext=fontfile=FreeMono.ttf:text=%{metadata\\:lavfi.readvitc.tc_str\\:--\\\\\\:--\\\\\\:--\\\\\\:--}:x=(w-tw)/2:y=400-ascent'
+
    +
+ + +

32.168 remap

+ +

Remap pixels using 2nd: Xmap and 3rd: Ymap input video stream. +

+

Destination pixel at position (X, Y) will be picked from source (x, y) position +where x = Xmap(X, Y) and y = Ymap(X, Y). If mapping values are out of range, zero +value for pixel will be used for destination pixel. +

+

Xmap and Ymap input video streams must be of same dimensions. Output video stream +will have Xmap/Ymap video stream dimensions. +Xmap and Ymap input video streams are 16bit depth, single channel. +

+
+
format
+

Specify pixel format of output from this filter. Can be color or gray. +Default is color. +

+
+
fill
+

Specify the color of the unmapped pixels. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. Default color is black. +

+
+ + +

32.169 removegrain

+ +

The removegrain filter is a spatial denoiser for progressive video. +

+
+
m0
+

Set mode for the first plane. +

+
+
m1
+

Set mode for the second plane. +

+
+
m2
+

Set mode for the third plane. +

+
+
m3
+

Set mode for the fourth plane. +

+
+ +

Range of mode is from 0 to 24. Description of each mode follows: +

+
+
0
+

Leave input plane unchanged. Default. +

+
+
1
+

Clips the pixel with the minimum and maximum of the 8 neighbour pixels. +

+
+
2
+

Clips the pixel with the second minimum and maximum of the 8 neighbour pixels. +

+
+
3
+

Clips the pixel with the third minimum and maximum of the 8 neighbour pixels. +

+
+
4
+

Clips the pixel with the fourth minimum and maximum of the 8 neighbour pixels. +This is equivalent to a median filter. +

+
+
5
+

Line-sensitive clipping giving the minimal change. +

+
+
6
+

Line-sensitive clipping, intermediate. +

+
+
7
+

Line-sensitive clipping, intermediate. +

+
+
8
+

Line-sensitive clipping, intermediate. +

+
+
9
+

Line-sensitive clipping on a line where the neighbours pixels are the closest. +

+
+
10
+

Replaces the target pixel with the closest neighbour. +

+
+
11
+

[1 2 1] horizontal and vertical kernel blur. +

+
+
12
+

Same as mode 11. +

+
+
13
+

Bob mode, interpolates top field from the line where the neighbours +pixels are the closest. +

+
+
14
+

Bob mode, interpolates bottom field from the line where the neighbours +pixels are the closest. +

+
+
15
+

Bob mode, interpolates top field. Same as 13 but with a more complicated +interpolation formula. +

+
+
16
+

Bob mode, interpolates bottom field. Same as 14 but with a more complicated +interpolation formula. +

+
+
17
+

Clips the pixel with the minimum and maximum of respectively the maximum and +minimum of each pair of opposite neighbour pixels. +

+
+
18
+

Line-sensitive clipping using opposite neighbours whose greatest distance from +the current pixel is minimal. +

+
+
19
+

Replaces the pixel with the average of its 8 neighbours. +

+
+
20
+

Averages the 9 pixels ([1 1 1] horizontal and vertical blur). +

+
+
21
+

Clips pixels using the averages of opposite neighbour. +

+
+
22
+

Same as mode 21 but simpler and faster. +

+
+
23
+

Small edge and halo removal, but reputed useless. +

+
+
24
+

Similar as 23. +

+
+ + +

32.170 removelogo

+ +

Suppress a TV station logo, using an image file to determine which +pixels comprise the logo. It works by filling in the pixels that +comprise the logo with neighboring pixels. +

+

The filter accepts the following options: +

+
+
filename, f
+

Set the filter bitmap file, which can be any image format supported by +libavformat. The width and height of the image file must match those of the +video stream being processed. +

+
+ +

Pixels in the provided bitmap image with a value of zero are not +considered part of the logo, non-zero pixels are considered part of +the logo. If you use white (255) for the logo and black (0) for the +rest, you will be safe. For making the filter bitmap, it is +recommended to take a screen capture of a black frame with the logo +visible, and then using a threshold filter followed by the erode +filter once or twice. +

+

If needed, little splotches can be fixed manually. Remember that if +logo pixels are not covered, the filter quality will be much +reduced. Marking too many pixels as part of the logo does not hurt as +much, but it will increase the amount of blurring needed to cover over +the image and will destroy more information than necessary, and extra +pixels will slow things down on a large logo. +

+ +

32.171 repeatfields

+ +

This filter uses the repeat_field flag from the Video ES headers and hard repeats +fields based on its value. +

+ +

32.172 reverse

+ +

Reverse a video clip. +

+

Warning: This filter requires memory to buffer the entire clip, so trimming +is suggested. +

+ +

32.172.1 Examples

+ +
    +
  • Take the first 5 seconds of a clip, and reverse it. +
    +
    trim=end=5,reverse
+
    +
+ + +

32.173 rgbashift

+

Shift R/G/B/A pixels horizontally and/or vertically. +

+

The filter accepts the following options: +

+
rh
+

Set amount to shift red horizontally. +

+
rv
+

Set amount to shift red vertically. +

+
gh
+

Set amount to shift green horizontally. +

+
gv
+

Set amount to shift green vertically. +

+
bh
+

Set amount to shift blue horizontally. +

+
bv
+

Set amount to shift blue vertically. +

+
ah
+

Set amount to shift alpha horizontally. +

+
av
+

Set amount to shift alpha vertically. +

+
edge
+

Set edge mode, can be smear, default, or warp. +

+
+ + +

32.173.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

32.174 roberts

+

Apply roberts cross operator to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +

+
+
delta
+

Set value which will be added to filtered result. +

+
+ + +

32.175 rotate

+ +

Rotate video by an arbitrary angle expressed in radians. +

+

The filter accepts the following options: +

+

A description of the optional parameters follows. +

+
angle, a
+

Set an expression for the angle by which to rotate the input video +clockwise, expressed as a number of radians. A negative value will +result in a counter-clockwise rotation. By default it is set to "0". +

+

This expression is evaluated for each frame. +

+
+
out_w, ow
+

Set the output width expression, default value is "iw". +This expression is evaluated just once during configuration. +

+
+
out_h, oh
+

Set the output height expression, default value is "ih". +This expression is evaluated just once during configuration. +

+
+
bilinear
+

Enable bilinear interpolation if set to 1, a value of 0 disables +it. Default value is 1. +

+
+
fillcolor, c
+

Set the color used to fill the output area not covered by the rotated +image. For the general syntax of this option, check the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +If the special value "none" is selected then no +background is printed (useful for example if the background is never shown). +

+

Default value is "black". +

+
+ +

The expressions for the angle and the output size can contain the +following constants and functions: +

+
+
n
+

sequential number of the input frame, starting from 0. It is always NAN +before the first frame is filtered. +

+
+
t
+

time in seconds of the input frame, it is set to 0 when the filter is +configured. It is always NAN before the first frame is filtered. +

+
+
hsub
+
vsub
+

horizontal and vertical chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
in_w, iw
+
in_h, ih
+

the input video width and height +

+
+
out_w, ow
+
out_h, oh
+

the output width and height, that is the size of the padded area as +specified by the width and height expressions +

+
+
rotw(a)
+
roth(a)
+

the minimal width/height required for completely containing the input +video rotated by a radians. +

+

These are only available when computing the out_w and +out_h expressions. +

+
+ + +

32.175.1 Examples

+ +
    +
  • Rotate the input by PI/6 radians clockwise: +
    +
    rotate=PI/6
+
    + +
  • Rotate the input by PI/6 radians counter-clockwise: +
    +
    rotate=-PI/6
+
    + +
  • Rotate the input by 45 degrees clockwise: +
    +
    rotate=45*PI/180
+
    + +
  • Apply a constant rotation with period T, starting from an angle of PI/3: +
    +
    rotate=PI/3+2*PI*t/T
+
    + +
  • Make the input video rotation oscillating with a period of T +seconds and an amplitude of A radians: +
    +
    rotate=A*sin(2*PI/T*t)
+
    + +
  • Rotate the video, output size is chosen so that the whole rotating +input video is always completely contained in the output: +
    +
    rotate='2*PI*t:ow=hypot(iw,ih):oh=ow'
+
    + +
  • Rotate the video, reduce the output size so that no background is ever +shown: +
    +
    rotate=2*PI*t:ow='min(iw,ih)/sqrt(2)':oh=ow:c=none
+
    +
+ + +

32.175.2 Commands

+ +

The filter supports the following commands: +

+
+
a, angle
+

Set the angle expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

32.176 sab

+ +

Apply Shape Adaptive Blur. +

+

The filter accepts the following options: +

+
+
luma_radius, lr
+

Set luma blur filter strength, must be a value in range 0.1-4.0, default +value is 1.0. A greater value will result in a more blurred image, and +in slower processing. +

+
+
luma_pre_filter_radius, lpfr
+

Set luma pre-filter radius, must be a value in the 0.1-2.0 range, default +value is 1.0. +

+
+
luma_strength, ls
+

Set luma maximum difference between pixels to still be considered, must +be a value in the 0.1-100.0 range, default value is 1.0. +

+
+
chroma_radius, cr
+

Set chroma blur filter strength, must be a value in range -0.9-4.0. A +greater value will result in a more blurred image, and in slower +processing. +

+
+
chroma_pre_filter_radius, cpfr
+

Set chroma pre-filter radius, must be a value in the -0.9-2.0 range. +

+
+
chroma_strength, cs
+

Set chroma maximum difference between pixels to still be considered, +must be a value in the -0.9-100.0 range. +

+
+ +

Each chroma option value, if not explicitly specified, is set to the +corresponding luma option value. +

+ +

32.177 scale

+ +

Scale (resize) the input video, using the libswscale library. +

+

The scale filter forces the output display aspect ratio to be the same +of the input, by changing the output sample aspect ratio. +

+

If the input image format is different from the format requested by +the next filter, the scale filter will convert the input to the +requested format. +

+ +

32.177.1 Options

+

The filter accepts the following options, or any of the options +supported by the libswscale scaler. +

+

See (ffmpeg-scaler)the ffmpeg-scaler manual for +the complete list of scaler options. +

+
+
width, w
+
height, h
+

Set the output video dimension expression. Default value is the input +dimension. +

+

If the width or w value is 0, the input width is used for +the output. If the height or h value is 0, the input height +is used for the output. +

+

If one and only one of the values is -n with n >= 1, the scale filter +will use a value that maintains the aspect ratio of the input image, +calculated from the other specified dimension. After that it will, +however, make sure that the calculated dimension is divisible by n and +adjust the value if necessary. +

+

If both values are -n with n >= 1, the behavior will be identical to +both values being set to 0 as previously detailed. +

+

See below for the list of accepted constants for use in the dimension +expression. +

+
+
eval
+

Specify when to evaluate width and height expression. It accepts the following values: +

+
+
‘init’
+

Only evaluate expressions once during the filter initialization or when a command is processed. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. +

+
+
+ +

Default value is ‘init’. +

+ +
+
interl
+

Set the interlacing mode. It accepts the following values: +

+
+
‘1’
+

Force interlaced aware scaling. +

+
+
‘0’
+

Do not apply interlaced scaling. +

+
+
‘-1’
+

Select interlaced aware scaling depending on whether the source frames +are flagged as interlaced or not. +

+
+ +

Default value is ‘0’. +

+
+
flags
+

Set libswscale scaling flags. See +(ffmpeg-scaler)the ffmpeg-scaler manual for the +complete list of values. If not explicitly specified the filter applies +the default flags. +

+ +
+
param0, param1
+

Set libswscale input parameters for scaling algorithms that need them. See +(ffmpeg-scaler)the ffmpeg-scaler manual for the +complete documentation. If not explicitly specified the filter applies +empty parameters. +

+ + +
+
size, s
+

Set the video size. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
in_color_matrix
+
out_color_matrix
+

Set in/output YCbCr color space type. +

+

This allows the autodetected value to be overridden as well as allows forcing +a specific value used for the output and encoder. +

+

If not specified, the color space type depends on the pixel format. +

+

Possible values: +

+
+
‘auto’
+

Choose automatically. +

+
+
‘bt709’
+

Format conforming to International Telecommunication Union (ITU) +Recommendation BT.709. +

+
+
‘fcc’
+

Set color space conforming to the United States Federal Communications +Commission (FCC) Code of Federal Regulations (CFR) Title 47 (2003) 73.682 (a). +

+
+
‘bt601’
+
‘bt470’
+
‘smpte170m’
+

Set color space conforming to: +

+
    +
  • ITU Radiocommunication Sector (ITU-R) Recommendation BT.601 + +
  • ITU-R Rec. BT.470-6 (1998) Systems B, B1, and G + +
  • Society of Motion Picture and Television Engineers (SMPTE) ST 170:2004 + +
+ +
+
‘smpte240m’
+

Set color space conforming to SMPTE ST 240:1999. +

+
+
‘bt2020’
+

Set color space conforming to ITU-R BT.2020 non-constant luminance system. +

+
+ +
+
in_range
+
out_range
+

Set in/output YCbCr sample range. +

+

This allows the autodetected value to be overridden as well as allows forcing +a specific value used for the output and encoder. If not specified, the +range depends on the pixel format. Possible values: +

+
+
‘auto/unknown’
+

Choose automatically. +

+
+
‘jpeg/full/pc’
+

Set full range (0-255 in case of 8-bit luma). +

+
+
‘mpeg/limited/tv’
+

Set "MPEG" range (16-235 in case of 8-bit luma). +

+
+ +
+
force_original_aspect_ratio
+

Enable decreasing or increasing output video width or height if necessary to +keep the original aspect ratio. Possible values: +

+
+
‘disable’
+

Scale the video as specified and disable this feature. +

+
+
‘decrease’
+

The output video dimensions will automatically be decreased if needed. +

+
+
‘increase’
+

The output video dimensions will automatically be increased if needed. +

+
+
+ +

One useful instance of this option is that when you know a specific device’s +maximum allowed resolution, you can use this to limit the output video to +that, while retaining the aspect ratio. For example, device A allows +1280x720 playback, and your video is 1920x800. Using this option (set it to +decrease) and specifying 1280x720 to the command line makes the output +1280x533. +

+

Please note that this is a different thing than specifying -1 for w +or h, you still need to specify the output resolution for this option +to work. +

+
+
force_divisible_by
+

Ensures that both the output dimensions, width and height, are divisible by the +given integer when used together with force_original_aspect_ratio. This +works similar to using -n in the w and h options. +

+

This option respects the value set for force_original_aspect_ratio, +increasing or decreasing the resolution accordingly. The video’s aspect ratio +may be slightly modified. +

+

This option can be handy if you need to have a video fit within or exceed +a defined resolution using force_original_aspect_ratio but also have +encoder restrictions on width or height divisibility. +

+
+
+ +

The values of the w and h options are expressions +containing the following constants: +

+
+
in_w
+
in_h
+

The input width and height +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output (scaled) width and height +

+
+
ow
+
oh
+

These are the same as out_w and out_h +

+
+
a
+

The same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

The input display aspect ratio. Calculated from (iw / ih) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical input chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
ohsub
+
ovsub
+

horizontal and vertical output chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
n
+

The (sequential) number of the input frame, starting from 0. +Only available with eval=frame. +

+
+
t
+

The presentation timestamp of the input frame, expressed as a number of +seconds. Only available with eval=frame. +

+
+
pos
+

The position (byte offset) of the frame in the input stream, or NaN if +this information is unavailable and/or meaningless (for example in case of synthetic video). +Only available with eval=frame. +

+
+ + +

32.177.2 Examples

+ +
    +
  • Scale the input video to a size of 200x100 +
    +
    scale=w=200:h=100
+
    + +

    This is equivalent to: +

    +
    scale=200:100
+
    + +

    or: +

    +
    scale=200x100
+
    + +
  • Specify a size abbreviation for the output size: +
    +
    scale=qcif
+
    + +

    which can also be written as: +

    +
    scale=size=qcif
+
    + +
  • Scale the input to 2x: +
    +
    scale=w=2*iw:h=2*ih
+
    + +
  • The above is the same as: +
    +
    scale=2*in_w:2*in_h
+
    + +
  • Scale the input to 2x with forced interlaced scaling: +
    +
    scale=2*iw:2*ih:interl=1
+
    + +
  • Scale the input to half size: +
    +
    scale=w=iw/2:h=ih/2
+
    + +
  • Increase the width, and set the height to the same size: +
    +
    scale=3/2*iw:ow
+
    + +
  • Seek Greek harmony: +
    +
    scale=iw:1/PHI*iw
+scale=ih*PHI:ih
+
    + +
  • Increase the height, and set the width to 3/2 of the height: +
    +
    scale=w=3/2*oh:h=3/5*ih
+
    + +
  • Increase the size, making the size a multiple of the chroma +subsample values: +
    +
    scale="trunc(3/2*iw/hsub)*hsub:trunc(3/2*ih/vsub)*vsub"
+
    + +
  • Increase the width to a maximum of 500 pixels, +keeping the same aspect ratio as the input: +
    +
    scale=w='min(500\, iw*3/2):h=-1'
+
    + +
  • Make pixels square by combining scale and setsar: +
    +
    scale='trunc(ih*dar):ih',setsar=1/1
+
    + +
  • Make pixels square by combining scale and setsar, +making sure the resulting resolution is even (required by some codecs): +
    +
    scale='trunc(ih*dar/2)*2:trunc(ih/2)*2',setsar=1/1
+
    +
+ + +

32.177.3 Commands

+ +

This filter supports the following commands: +

+
width, w
+
height, h
+

Set the output video dimension expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

32.178 scale_npp

+ +

Use the NVIDIA Performance Primitives (libnpp) to perform scaling and/or pixel +format conversion on CUDA video frames. Setting the output width and height +works in the same way as for the scale filter. +

+

The following additional options are accepted: +

+
format
+

The pixel format of the output CUDA frames. If set to the string "same" (the +default), the input format will be kept. Note that automatic format negotiation +and conversion is not yet supported for hardware frames +

+
+
interp_algo
+

The interpolation algorithm used for resizing. One of the following: +

+
nn
+

Nearest neighbour. +

+
+
linear
+
cubic
+
cubic2p_bspline
+

2-parameter cubic (B=1, C=0) +

+
+
cubic2p_catmullrom
+

2-parameter cubic (B=0, C=1/2) +

+
+
cubic2p_b05c03
+

2-parameter cubic (B=1/2, C=3/10) +

+
+
super
+

Supersampling +

+
+
lanczos
+
+ +
+
force_original_aspect_ratio
+

Enable decreasing or increasing output video width or height if necessary to +keep the original aspect ratio. Possible values: +

+
+
‘disable’
+

Scale the video as specified and disable this feature. +

+
+
‘decrease’
+

The output video dimensions will automatically be decreased if needed. +

+
+
‘increase’
+

The output video dimensions will automatically be increased if needed. +

+
+
+ +

One useful instance of this option is that when you know a specific device’s +maximum allowed resolution, you can use this to limit the output video to +that, while retaining the aspect ratio. For example, device A allows +1280x720 playback, and your video is 1920x800. Using this option (set it to +decrease) and specifying 1280x720 to the command line makes the output +1280x533. +

+

Please note that this is a different thing than specifying -1 for w +or h, you still need to specify the output resolution for this option +to work. +

+
+
force_divisible_by
+

Ensures that both the output dimensions, width and height, are divisible by the +given integer when used together with force_original_aspect_ratio. This +works similar to using -n in the w and h options. +

+

This option respects the value set for force_original_aspect_ratio, +increasing or decreasing the resolution accordingly. The video’s aspect ratio +may be slightly modified. +

+

This option can be handy if you need to have a video fit within or exceed +a defined resolution using force_original_aspect_ratio but also have +encoder restrictions on width or height divisibility. +

+
+
+ + +

32.179 scale2ref

+ +

Scale (resize) the input video, based on a reference video. +

+

See the scale filter for available options, scale2ref supports the same but +uses the reference video instead of the main input as basis. scale2ref also +supports the following additional constants for the w and +h options: +

+
+
main_w
+
main_h
+

The main input video’s width and height +

+
+
main_a
+

The same as main_w / main_h +

+
+
main_sar
+

The main input video’s sample aspect ratio +

+
+
main_dar, mdar
+

The main input video’s display aspect ratio. Calculated from +(main_w / main_h) * main_sar. +

+
+
main_hsub
+
main_vsub
+

The main input video’s horizontal and vertical chroma subsample values. +For example for the pixel format "yuv422p" hsub is 2 and vsub +is 1. +

+
+
main_n
+

The (sequential) number of the main input frame, starting from 0. +Only available with eval=frame. +

+
+
main_t
+

The presentation timestamp of the main input frame, expressed as a number of +seconds. Only available with eval=frame. +

+
+
main_pos
+

The position (byte offset) of the frame in the main input stream, or NaN if +this information is unavailable and/or meaningless (for example in case of synthetic video). +Only available with eval=frame. +

+
+ + +

32.179.1 Examples

+ +
    +
  • Scale a subtitle stream (b) to match the main video (a) in size before overlaying +
    +
    'scale2ref[b][a];[a][b]overlay'
+
    + +
  • Scale a logo to 1/10th the height of a video, while preserving its display aspect ratio. +
    +
    [logo-in][video-in]scale2ref=w=oh*mdar:h=ih/10[logo-out][video-out]
+
    +
+ + +

32.179.2 Commands

+ +

This filter supports the following commands: +

+
width, w
+
height, h
+

Set the output video dimension expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + +

32.180 scroll

+

Scroll input video horizontally and/or vertically by constant speed. +

+

The filter accepts the following options: +

+
horizontal, h
+

Set the horizontal scrolling speed. Default is 0. Allowed range is from -1 to 1. +Negative values changes scrolling direction. +

+
+
vertical, v
+

Set the vertical scrolling speed. Default is 0. Allowed range is from -1 to 1. +Negative values changes scrolling direction. +

+
+
hpos
+

Set the initial horizontal scrolling position. Default is 0. Allowed range is from 0 to 1. +

+
+
vpos
+

Set the initial vertical scrolling position. Default is 0. Allowed range is from 0 to 1. +

+
+ + +

32.180.1 Commands

+ +

This filter supports the following commands: +

+
horizontal, h
+

Set the horizontal scrolling speed. +

+
vertical, v
+

Set the vertical scrolling speed. +

+
+ + +

32.181 scdet

+ +

Detect video scene change. +

+

This filter sets frame metadata with mafd between frame, the scene score, and +forward the frame to the next filter, so they can use these metadata to detect +scene change or others. +

+

In addition, this filter logs a message and sets frame metadata when it detects +a scene change by threshold. +

+

lavfi.scd.mafd metadata keys are set with mafd for every frame. +

+

lavfi.scd.score metadata keys are set with scene change score for every frame +to detect scene change. +

+

lavfi.scd.time metadata keys are set with current filtered frame time which +detect scene change with threshold. +

+

The filter accepts the following options: +

+
+
threshold, t
+

Set the scene change detection threshold as a percentage of maximum change. Good +values are in the [8.0, 14.0] range. The range for threshold is +[0., 100.]. +

+

Default value is 10.. +

+
+
sc_pass, s
+

Set the flag to pass scene change frames to the next filter. Default value is 0 +You can enable it if you want to get snapshot of scene change frames only. +

+
+ + +

32.182 selectivecolor

+ +

Adjust cyan, magenta, yellow and black (CMYK) to certain ranges of colors (such +as "reds", "yellows", "greens", "cyans", ...). The adjustment range is defined +by the "purity" of the color (that is, how saturated it already is). +

+

This filter is similar to the Adobe Photoshop Selective Color tool. +

+

The filter accepts the following options: +

+
+
correction_method
+

Select color correction method. +

+

Available values are: +

+
‘absolute’
+

Specified adjustments are applied "as-is" (added/subtracted to original pixel +component value). +

+
‘relative’
+

Specified adjustments are relative to the original component value. +

+
+

Default is absolute. +

+
reds
+

Adjustments for red pixels (pixels where the red component is the maximum) +

+
yellows
+

Adjustments for yellow pixels (pixels where the blue component is the minimum) +

+
greens
+

Adjustments for green pixels (pixels where the green component is the maximum) +

+
cyans
+

Adjustments for cyan pixels (pixels where the red component is the minimum) +

+
blues
+

Adjustments for blue pixels (pixels where the blue component is the maximum) +

+
magentas
+

Adjustments for magenta pixels (pixels where the green component is the minimum) +

+
whites
+

Adjustments for white pixels (pixels where all components are greater than 128) +

+
neutrals
+

Adjustments for all pixels except pure black and pure white +

+
blacks
+

Adjustments for black pixels (pixels where all components are lesser than 128) +

+
psfile
+

Specify a Photoshop selective color file (.asv) to import the settings from. +

+
+ +

All the adjustment settings (reds, yellows, ...) accept up to +4 space separated floating point adjustment values in the [-1,1] range, +respectively to adjust the amount of cyan, magenta, yellow and black for the +pixels of its range. +

+ +

32.182.1 Examples

+ +
    +
  • Increase cyan by 50% and reduce yellow by 33% in every green areas, and +increase magenta by 27% in blue areas: +
    +
    selectivecolor=greens=.5 0 -.33 0:blues=0 .27
+
    + +
  • Use a Photoshop selective color preset: +
    +
    selectivecolor=psfile=MySelectiveColorPresets/Misty.asv
+
    +
+ + +

32.183 separatefields

+ +

The separatefields takes a frame-based video input and splits +each frame into its components fields, producing a new half height clip +with twice the frame rate and twice the frame count. +

+

This filter use field-dominance information in frame to decide which +of each pair of fields to place first in the output. +If it gets it wrong use setfield filter before separatefields filter. +

+ +

32.184 setdar, setsar

+ +

The setdar filter sets the Display Aspect Ratio for the filter +output video. +

+

This is done by changing the specified Sample (aka Pixel) Aspect +Ratio, according to the following equation: +

+
DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR
+
+ +

Keep in mind that the setdar filter does not modify the pixel +dimensions of the video frame. Also, the display aspect ratio set by +this filter may be changed by later filters in the filterchain, +e.g. in case of scaling or if another "setdar" or a "setsar" filter is +applied. +

+

The setsar filter sets the Sample (aka Pixel) Aspect Ratio for +the filter output video. +

+

Note that as a consequence of the application of this filter, the +output display aspect ratio will change according to the equation +above. +

+

Keep in mind that the sample aspect ratio set by the setsar +filter may be changed by later filters in the filterchain, e.g. if +another "setsar" or a "setdar" filter is applied. +

+

It accepts the following parameters: +

+
+
r, ratio, dar (setdar only), sar (setsar only)
+

Set the aspect ratio used by the filter. +

+

The parameter can be a floating point number string, an expression, or +a string of the form num:den, where num and +den are the numerator and denominator of the aspect ratio. If +the parameter is not specified, it is assumed the value "0". +In case the form "num:den" is used, the : character +should be escaped. +

+
+
max
+

Set the maximum integer value to use for expressing numerator and +denominator when reducing the expressed aspect ratio to a rational. +Default value is 100. +

+
+
+ +

The parameter sar is an expression containing +the following constants: +

+
+
E, PI, PHI
+

These are approximated values for the mathematical constants e +(Euler’s number), pi (Greek pi), and phi (the golden ratio). +

+
+
w, h
+

The input width and height. +

+
+
a
+

These are the same as w / h. +

+
+
sar
+

The input sample aspect ratio. +

+
+
dar
+

The input display aspect ratio. It is the same as +(w / h) * sar. +

+
+
hsub, vsub
+

Horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+ + +

32.184.1 Examples

+ +
    +
  • To change the display aspect ratio to 16:9, specify one of the following: +
    +
    setdar=dar=1.77777
+setdar=dar=16/9
+
    + +
  • To change the sample aspect ratio to 10:11, specify: +
    +
    setsar=sar=10/11
+
    + +
  • To set a display aspect ratio of 16:9, and specify a maximum integer value of +1000 in the aspect ratio reduction, use the command: +
    +
    setdar=ratio=16/9:max=1000
+
    + +
+ + +

32.185 setfield

+ +

Force field for the output video frame. +

+

The setfield filter marks the interlace type field for the +output frames. It does not change the input frame, but only sets the +corresponding property, which affects how the frame is treated by +following filters (e.g. fieldorder or yadif). +

+

The filter accepts the following options: +

+
+
mode
+

Available values are: +

+
+
‘auto’
+

Keep the same field property. +

+
+
‘bff’
+

Mark the frame as bottom-field-first. +

+
+
‘tff’
+

Mark the frame as top-field-first. +

+
+
‘prog’
+

Mark the frame as progressive. +

+
+
+
+ + +

32.186 setparams

+ +

Force frame parameter for the output video frame. +

+

The setparams filter marks interlace and color range for the +output frames. It does not change the input frame, but only sets the +corresponding property, which affects how the frame is treated by +filters/encoders. +

+
+
field_mode
+

Available values are: +

+
+
‘auto’
+

Keep the same field property (default). +

+
+
‘bff’
+

Mark the frame as bottom-field-first. +

+
+
‘tff’
+

Mark the frame as top-field-first. +

+
+
‘prog’
+

Mark the frame as progressive. +

+
+ +
+
range
+

Available values are: +

+
+
‘auto’
+

Keep the same color range property (default). +

+
+
‘unspecified, unknown’
+

Mark the frame as unspecified color range. +

+
+
‘limited, tv, mpeg’
+

Mark the frame as limited range. +

+
+
‘full, pc, jpeg’
+

Mark the frame as full range. +

+
+ +
+
color_primaries
+

Set the color primaries. +Available values are: +

+
+
‘auto’
+

Keep the same color primaries property (default). +

+
+
‘bt709’
+
‘unknown’
+
‘bt470m’
+
‘bt470bg’
+
‘smpte170m’
+
‘smpte240m’
+
‘film’
+
‘bt2020’
+
‘smpte428’
+
‘smpte431’
+
‘smpte432’
+
‘jedec-p22’
+
+ +
+
color_trc
+

Set the color transfer. +Available values are: +

+
+
‘auto’
+

Keep the same color trc property (default). +

+
+
‘bt709’
+
‘unknown’
+
‘bt470m’
+
‘bt470bg’
+
‘smpte170m’
+
‘smpte240m’
+
‘linear’
+
‘log100’
+
‘log316’
+
‘iec61966-2-4’
+
‘bt1361e’
+
‘iec61966-2-1’
+
‘bt2020-10’
+
‘bt2020-12’
+
‘smpte2084’
+
‘smpte428’
+
‘arib-std-b67’
+
+ +
+
colorspace
+

Set the colorspace. +Available values are: +

+
+
‘auto’
+

Keep the same colorspace property (default). +

+
+
‘gbr’
+
‘bt709’
+
‘unknown’
+
‘fcc’
+
‘bt470bg’
+
‘smpte170m’
+
‘smpte240m’
+
‘ycgco’
+
‘bt2020nc’
+
‘bt2020c’
+
‘smpte2085’
+
‘chroma-derived-nc’
+
‘chroma-derived-c’
+
‘ictcp’
+
+
+
+ + +

32.187 showinfo

+ +

Show a line containing various information for each input video frame. +The input video is not modified. +

+

This filter supports the following options: +

+
+
checksum
+

Calculate checksums of each plane. By default enabled. +

+
+ +

The shown line contains a sequence of key/value pairs of the form +key:value. +

+

The following values are shown in the output: +

+
+
n
+

The (sequential) number of the input frame, starting from 0. +

+
+
pts
+

The Presentation TimeStamp of the input frame, expressed as a number of +time base units. The time base unit depends on the filter input pad. +

+
+
pts_time
+

The Presentation TimeStamp of the input frame, expressed as a number of +seconds. +

+
+
pos
+

The position of the frame in the input stream, or -1 if this information is +unavailable and/or meaningless (for example in case of synthetic video). +

+
+
fmt
+

The pixel format name. +

+
+
sar
+

The sample aspect ratio of the input frame, expressed in the form +num/den. +

+
+
s
+

The size of the input frame. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
i
+

The type of interlaced mode ("P" for "progressive", "T" for top field first, "B" +for bottom field first). +

+
+
iskey
+

This is 1 if the frame is a key frame, 0 otherwise. +

+
+
type
+

The picture type of the input frame ("I" for an I-frame, "P" for a +P-frame, "B" for a B-frame, or "?" for an unknown type). +Also refer to the documentation of the AVPictureType enum and of +the av_get_picture_type_char function defined in +libavutil/avutil.h. +

+
+
checksum
+

The Adler-32 checksum (printed in hexadecimal) of all the planes of the input frame. +

+
+
plane_checksum
+

The Adler-32 checksum (printed in hexadecimal) of each plane of the input frame, +expressed in the form "[c0 c1 c2 c3]". +

+
+
mean
+

The mean value of pixels in each plane of the input frame, expressed in the form +"[mean0 mean1 mean2 mean3]". +

+
+
stdev
+

The standard deviation of pixel values in each plane of the input frame, expressed +in the form "[stdev0 stdev1 stdev2 stdev3]". +

+
+
+ + +

32.188 showpalette

+ +

Displays the 256 colors palette of each frame. This filter is only relevant for +pal8 pixel format frames. +

+

It accepts the following option: +

+
+
s
+

Set the size of the box used to represent one palette color entry. Default is +30 (for a 30x30 pixel box). +

+
+ + +

32.189 shuffleframes

+ +

Reorder and/or duplicate and/or drop video frames. +

+

It accepts the following parameters: +

+
+
mapping
+

Set the destination indexes of input frames. +This is space or ’|’ separated list of indexes that maps input frames to output +frames. Number of indexes also sets maximal value that each index may have. +’-1’ index have special meaning and that is to drop frame. +

+
+ +

The first frame has the index 0. The default is to keep the input unchanged. +

+ +

32.189.1 Examples

+ +
    +
  • Swap second and third frame of every three frames of the input: +
    +
    ffmpeg -i INPUT -vf "shuffleframes=0 2 1" OUTPUT
+
    + +
  • Swap 10th and 1st frame of every ten frames of the input: +
    +
    ffmpeg -i INPUT -vf "shuffleframes=9 1 2 3 4 5 6 7 8 0" OUTPUT
+
    +
+ + +

32.190 shuffleplanes

+ +

Reorder and/or duplicate video planes. +

+

It accepts the following parameters: +

+
+
map0
+

The index of the input plane to be used as the first output plane. +

+
+
map1
+

The index of the input plane to be used as the second output plane. +

+
+
map2
+

The index of the input plane to be used as the third output plane. +

+
+
map3
+

The index of the input plane to be used as the fourth output plane. +

+
+
+ +

The first plane has the index 0. The default is to keep the input unchanged. +

+ +

32.190.1 Examples

+ +
    +
  • Swap the second and third planes of the input: +
    +
    ffmpeg -i INPUT -vf shuffleplanes=0:2:1:3 OUTPUT
+
    +
+ + +

32.191 signalstats

+

Evaluate various visual metrics that assist in determining issues associated +with the digitization of analog video media. +

+

By default the filter will log these metadata values: +

+
+
YMIN
+

Display the minimal Y value contained within the input frame. Expressed in +range of [0-255]. +

+
+
YLOW
+

Display the Y value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
YAVG
+

Display the average Y value within the input frame. Expressed in range of +[0-255]. +

+
+
YHIGH
+

Display the Y value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
YMAX
+

Display the maximum Y value contained within the input frame. Expressed in +range of [0-255]. +

+
+
UMIN
+

Display the minimal U value contained within the input frame. Expressed in +range of [0-255]. +

+
+
ULOW
+

Display the U value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
UAVG
+

Display the average U value within the input frame. Expressed in range of +[0-255]. +

+
+
UHIGH
+

Display the U value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
UMAX
+

Display the maximum U value contained within the input frame. Expressed in +range of [0-255]. +

+
+
VMIN
+

Display the minimal V value contained within the input frame. Expressed in +range of [0-255]. +

+
+
VLOW
+

Display the V value at the 10% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
VAVG
+

Display the average V value within the input frame. Expressed in range of +[0-255]. +

+
+
VHIGH
+

Display the V value at the 90% percentile within the input frame. Expressed in +range of [0-255]. +

+
+
VMAX
+

Display the maximum V value contained within the input frame. Expressed in +range of [0-255]. +

+
+
SATMIN
+

Display the minimal saturation value contained within the input frame. +Expressed in range of [0-~181.02]. +

+
+
SATLOW
+

Display the saturation value at the 10% percentile within the input frame. +Expressed in range of [0-~181.02]. +

+
+
SATAVG
+

Display the average saturation value within the input frame. Expressed in range +of [0-~181.02]. +

+
+
SATHIGH
+

Display the saturation value at the 90% percentile within the input frame. +Expressed in range of [0-~181.02]. +

+
+
SATMAX
+

Display the maximum saturation value contained within the input frame. +Expressed in range of [0-~181.02]. +

+
+
HUEMED
+

Display the median value for hue within the input frame. Expressed in range of +[0-360]. +

+
+
HUEAVG
+

Display the average value for hue within the input frame. Expressed in range of +[0-360]. +

+
+
YDIF
+

Display the average of sample value difference between all values of the Y +plane in the current frame and corresponding values of the previous input frame. +Expressed in range of [0-255]. +

+
+
UDIF
+

Display the average of sample value difference between all values of the U +plane in the current frame and corresponding values of the previous input frame. +Expressed in range of [0-255]. +

+
+
VDIF
+

Display the average of sample value difference between all values of the V +plane in the current frame and corresponding values of the previous input frame. +Expressed in range of [0-255]. +

+
+
YBITDEPTH
+

Display bit depth of Y plane in current frame. +Expressed in range of [0-16]. +

+
+
UBITDEPTH
+

Display bit depth of U plane in current frame. +Expressed in range of [0-16]. +

+
+
VBITDEPTH
+

Display bit depth of V plane in current frame. +Expressed in range of [0-16]. +

+
+ +

The filter accepts the following options: +

+
+
stat
+
out
+
+

stat specify an additional form of image analysis. +out output video with the specified type of pixel highlighted. +

+

Both options accept the following values: +

+
+
‘tout’
+

Identify temporal outliers pixels. A temporal outlier is a pixel +unlike the neighboring pixels of the same field. Examples of temporal outliers +include the results of video dropouts, head clogs, or tape tracking issues. +

+
+
‘vrep’
+

Identify vertical line repetition. Vertical line repetition includes +similar rows of pixels within a frame. In born-digital video vertical line +repetition is common, but this pattern is uncommon in video digitized from an +analog source. When it occurs in video that results from the digitization of an +analog source it can indicate concealment from a dropout compensator. +

+
+
‘brng’
+

Identify pixels that fall outside of legal broadcast range. +

+
+ +
+
color, c
+

Set the highlight color for the out option. The default color is +yellow. +

+
+ + +

32.191.1 Examples

+ +
    +
  • Output data of various video metrics: +
    +
    ffprobe -f lavfi movie=example.mov,signalstats="stat=tout+vrep+brng" -show_frames
+
    + +
  • Output specific data about the minimum and maximum values of the Y plane per frame: +
    +
    ffprobe -f lavfi movie=example.mov,signalstats -show_entries frame_tags=lavfi.signalstats.YMAX,lavfi.signalstats.YMIN
+
    + +
  • Playback video while highlighting pixels that are outside of broadcast range in red. +
    +
    ffplay example.mov -vf signalstats="out=brng:color=red"
+
    + +
  • Playback video with signalstats metadata drawn over the frame. +
    +
    ffplay example.mov -vf signalstats=stat=brng+vrep+tout,drawtext=fontfile=FreeSerif.ttf:textfile=signalstat_drawtext.txt
+
    + +

    The contents of signalstat_drawtext.txt used in the command are: +

    +
    time %{pts:hms}
+Y (%{metadata:lavfi.signalstats.YMIN}-%{metadata:lavfi.signalstats.YMAX})
+U (%{metadata:lavfi.signalstats.UMIN}-%{metadata:lavfi.signalstats.UMAX})
+V (%{metadata:lavfi.signalstats.VMIN}-%{metadata:lavfi.signalstats.VMAX})
+saturation maximum: %{metadata:lavfi.signalstats.SATMAX}
+
+
    +
+ + +

32.192 signature

+ +

Calculates the MPEG-7 Video Signature. The filter can handle more than one +input. In this case the matching between the inputs can be calculated additionally. +The filter always passes through the first input. The signature of each stream can +be written into a file. +

+

It accepts the following options: +

+
+
detectmode
+

Enable or disable the matching process. +

+

Available values are: +

+
+
‘off’
+

Disable the calculation of a matching (default). +

+
‘full’
+

Calculate the matching for the whole video and output whether the whole video +matches or only parts. +

+
‘fast’
+

Calculate only until a matching is found or the video ends. Should be faster in +some cases. +

+
+ +
+
nb_inputs
+

Set the number of inputs. The option value must be a non negative integer. +Default value is 1. +

+
+
filename
+

Set the path to which the output is written. If there is more than one input, +the path must be a prototype, i.e. must contain %d or %0nd (where n is a positive +integer), that will be replaced with the input number. If no filename is +specified, no output will be written. This is the default. +

+
+
format
+

Choose the output format. +

+

Available values are: +

+
+
‘binary’
+

Use the specified binary representation (default). +

+
‘xml’
+

Use the specified xml representation. +

+
+ +
+
th_d
+

Set threshold to detect one word as similar. The option value must be an integer +greater than zero. The default value is 9000. +

+
+
th_dc
+

Set threshold to detect all words as similar. The option value must be an integer +greater than zero. The default value is 60000. +

+
+
th_xh
+

Set threshold to detect frames as similar. The option value must be an integer +greater than zero. The default value is 116. +

+
+
th_di
+

Set the minimum length of a sequence in frames to recognize it as matching +sequence. The option value must be a non negative integer value. +The default value is 0. +

+
+
th_it
+

Set the minimum relation, that matching frames to all frames must have. +The option value must be a double value between 0 and 1. The default value is 0.5. +

+
+ + +

32.192.1 Examples

+ +
    +
  • To calculate the signature of an input video and store it in signature.bin: +
    +
    ffmpeg -i input.mkv -vf signature=filename=signature.bin -map 0:v -f null -
+
    + +
  • To detect whether two videos match and store the signatures in XML format in +signature0.xml and signature1.xml: +
    +
    ffmpeg -i input1.mkv -i input2.mkv -filter_complex "[0:v][1:v] signature=nb_inputs=2:detectmode=full:format=xml:filename=signature%d.xml" -map :v -f null -
+
    + +
+ + +

32.193 smartblur

+ +

Blur the input video without impacting the outlines. +

+

It accepts the following options: +

+
+
luma_radius, lr
+

Set the luma radius. The option value must be a float number in +the range [0.1,5.0] that specifies the variance of the gaussian filter +used to blur the image (slower if larger). Default value is 1.0. +

+
+
luma_strength, ls
+

Set the luma strength. The option value must be a float number +in the range [-1.0,1.0] that configures the blurring. A value included +in [0.0,1.0] will blur the image whereas a value included in +[-1.0,0.0] will sharpen the image. Default value is 1.0. +

+
+
luma_threshold, lt
+

Set the luma threshold used as a coefficient to determine +whether a pixel should be blurred or not. The option value must be an +integer in the range [-30,30]. A value of 0 will filter all the image, +a value included in [0,30] will filter flat areas and a value included +in [-30,0] will filter edges. Default value is 0. +

+
+
chroma_radius, cr
+

Set the chroma radius. The option value must be a float number in +the range [0.1,5.0] that specifies the variance of the gaussian filter +used to blur the image (slower if larger). Default value is luma_radius. +

+
+
chroma_strength, cs
+

Set the chroma strength. The option value must be a float number +in the range [-1.0,1.0] that configures the blurring. A value included +in [0.0,1.0] will blur the image whereas a value included in +[-1.0,0.0] will sharpen the image. Default value is luma_strength. +

+
+
chroma_threshold, ct
+

Set the chroma threshold used as a coefficient to determine +whether a pixel should be blurred or not. The option value must be an +integer in the range [-30,30]. A value of 0 will filter all the image, +a value included in [0,30] will filter flat areas and a value included +in [-30,0] will filter edges. Default value is luma_threshold. +

+
+ +

If a chroma option is not explicitly set, the corresponding luma value +is set. +

+ +

32.194 sobel

+

Apply sobel operator to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +

+
+
delta
+

Set value which will be added to filtered result. +

+
+ + +

32.195 spp

+ +

Apply a simple postprocessing filter that compresses and decompresses the image +at several (or - in the case of quality level 6 - all) shifts +and average the results. +

+

The filter accepts the following options: +

+
+
quality
+

Set quality. This option defines the number of levels for averaging. It accepts +an integer in the range 0-6. If set to 0, the filter will have no +effect. A value of 6 means the higher quality. For each increment of +that value the speed drops by a factor of approximately 2. Default value is +3. +

+
+
qp
+

Force a constant quantization parameter. If not set, the filter will use the QP +from the video stream (if available). +

+
+
mode
+

Set thresholding mode. Available modes are: +

+
+
‘hard’
+

Set hard thresholding (default). +

+
‘soft’
+

Set soft thresholding (better de-ringing effect, but likely blurrier). +

+
+ +
+
use_bframe_qp
+

Enable the use of the QP from the B-Frames if set to 1. Using this +option may cause flicker since the B-Frames have often larger QP. Default is +0 (not enabled). +

+
+ + +

32.195.1 Commands

+ +

This filter supports the following commands: +

+
quality, level
+

Set quality level. The value max can be used to set the maximum level, +currently 6. +

+
+ + +

32.196 sr

+ +

Scale the input by applying one of the super-resolution methods based on +convolutional neural networks. Supported models: +

+ + +

Training scripts as well as scripts for model file (.pb) saving can be found at +https://github.com/XueweiMeng/sr/tree/sr_dnn_native. Original repository +is at https://github.com/HighVoltageRocknRoll/sr.git. +

+

Native model files (.model) can be generated from TensorFlow model +files (.pb) by using tools/python/convert.py +

+

The filter accepts the following options: +

+
+
dnn_backend
+

Specify which DNN backend to use for model loading and execution. This option accepts +the following values: +

+
+
‘native’
+

Native implementation of DNN loading and execution. +

+
+
‘tensorflow’
+

TensorFlow backend. To enable this backend you +need to install the TensorFlow for C library (see +https://www.tensorflow.org/install/install_c) and configure FFmpeg with +--enable-libtensorflow +

+
+ +

Default value is ‘native’. +

+
+
model
+

Set path to model file specifying network architecture and its parameters. +Note that different backends use different file formats. TensorFlow backend +can load files for both formats, while native backend can load files for only +its format. +

+
+
scale_factor
+

Set scale factor for SRCNN model. Allowed values are 2, 3 and 4. +Default value is 2. Scale factor is necessary for SRCNN model, because it accepts +input upscaled using bicubic upscaling with proper scale factor. +

+
+ +

This feature can also be finished with dnn_processing filter. +

+ +

32.197 ssim

+ +

Obtain the SSIM (Structural SImilarity Metric) between two input videos. +

+

This filter takes in input two input videos, the first input is +considered the "main" source and is passed unchanged to the +output. The second input is used as a "reference" video for computing +the SSIM. +

+

Both video inputs must have the same resolution and pixel format for +this filter to work correctly. Also it assumes that both inputs +have the same number of frames, which are compared one by one. +

+

The filter stores the calculated SSIM of each frame. +

+

The description of the accepted parameters follows. +

+
+
stats_file, f
+

If specified the filter will use the named file to save the SSIM of +each individual frame. When filename equals "-" the data is sent to +standard output. +

+
+ +

The file printed if stats_file is selected, contains a sequence of +key/value pairs of the form key:value for each compared +couple of frames. +

+

A description of each shown parameter follows: +

+
+
n
+

sequential number of the input frame, starting from 1 +

+
+
Y, U, V, R, G, B
+

SSIM of the compared frames for the component specified by the suffix. +

+
+
All
+

SSIM of the compared frames for the whole frame. +

+
+
dB
+

Same as above but in dB representation. +

+
+ +

This filter also supports the framesync options. +

+ +

32.197.1 Examples

+
    +
  • For example: +
    +
    movie=ref_movie.mpg, setpts=PTS-STARTPTS [main];
+[main][ref] ssim="stats_file=stats.log" [out]
+
    + +

    On this example the input file being processed is compared with the +reference file ref_movie.mpg. The SSIM of each individual frame +is stored in stats.log. +

    +
  • Another example with both psnr and ssim at same time: +
    +
    ffmpeg -i main.mpg -i ref.mpg -lavfi  "ssim;[0:v][1:v]psnr" -f null -
+
    + +
  • Another example with different containers: +
    +
    ffmpeg -i main.mpg -i ref.mkv -lavfi  "[0:v]settb=AVTB,setpts=PTS-STARTPTS[main];[1:v]settb=AVTB,setpts=PTS-STARTPTS[ref];[main][ref]ssim" -f null -
+
    +
+ + +

32.198 stereo3d

+ +

Convert between different stereoscopic image formats. +

+

The filters accept the following options: +

+
+
in
+

Set stereoscopic image format of input. +

+

Available values for input image formats are: +

+
‘sbsl’
+

side by side parallel (left eye left, right eye right) +

+
+
‘sbsr’
+

side by side crosseye (right eye left, left eye right) +

+
+
‘sbs2l’
+

side by side parallel with half width resolution +(left eye left, right eye right) +

+
+
‘sbs2r’
+

side by side crosseye with half width resolution +(right eye left, left eye right) +

+
+
‘abl’
+
‘tbl’
+

above-below (left eye above, right eye below) +

+
+
‘abr’
+
‘tbr’
+

above-below (right eye above, left eye below) +

+
+
‘ab2l’
+
‘tb2l’
+

above-below with half height resolution +(left eye above, right eye below) +

+
+
‘ab2r’
+
‘tb2r’
+

above-below with half height resolution +(right eye above, left eye below) +

+
+
‘al’
+

alternating frames (left eye first, right eye second) +

+
+
‘ar’
+

alternating frames (right eye first, left eye second) +

+
+
‘irl’
+

interleaved rows (left eye has top row, right eye starts on next row) +

+
+
‘irr’
+

interleaved rows (right eye has top row, left eye starts on next row) +

+
+
‘icl’
+

interleaved columns, left eye first +

+
+
‘icr’
+

interleaved columns, right eye first +

+

Default value is ‘sbsl’. +

+
+ +
+
out
+

Set stereoscopic image format of output. +

+
+
‘sbsl’
+

side by side parallel (left eye left, right eye right) +

+
+
‘sbsr’
+

side by side crosseye (right eye left, left eye right) +

+
+
‘sbs2l’
+

side by side parallel with half width resolution +(left eye left, right eye right) +

+
+
‘sbs2r’
+

side by side crosseye with half width resolution +(right eye left, left eye right) +

+
+
‘abl’
+
‘tbl’
+

above-below (left eye above, right eye below) +

+
+
‘abr’
+
‘tbr’
+

above-below (right eye above, left eye below) +

+
+
‘ab2l’
+
‘tb2l’
+

above-below with half height resolution +(left eye above, right eye below) +

+
+
‘ab2r’
+
‘tb2r’
+

above-below with half height resolution +(right eye above, left eye below) +

+
+
‘al’
+

alternating frames (left eye first, right eye second) +

+
+
‘ar’
+

alternating frames (right eye first, left eye second) +

+
+
‘irl’
+

interleaved rows (left eye has top row, right eye starts on next row) +

+
+
‘irr’
+

interleaved rows (right eye has top row, left eye starts on next row) +

+
+
‘arbg’
+

anaglyph red/blue gray +(red filter on left eye, blue filter on right eye) +

+
+
‘argg’
+

anaglyph red/green gray +(red filter on left eye, green filter on right eye) +

+
+
‘arcg’
+

anaglyph red/cyan gray +(red filter on left eye, cyan filter on right eye) +

+
+
‘arch’
+

anaglyph red/cyan half colored +(red filter on left eye, cyan filter on right eye) +

+
+
‘arcc’
+

anaglyph red/cyan color +(red filter on left eye, cyan filter on right eye) +

+
+
‘arcd’
+

anaglyph red/cyan color optimized with the least squares projection of dubois +(red filter on left eye, cyan filter on right eye) +

+
+
‘agmg’
+

anaglyph green/magenta gray +(green filter on left eye, magenta filter on right eye) +

+
+
‘agmh’
+

anaglyph green/magenta half colored +(green filter on left eye, magenta filter on right eye) +

+
+
‘agmc’
+

anaglyph green/magenta colored +(green filter on left eye, magenta filter on right eye) +

+
+
‘agmd’
+

anaglyph green/magenta color optimized with the least squares projection of dubois +(green filter on left eye, magenta filter on right eye) +

+
+
‘aybg’
+

anaglyph yellow/blue gray +(yellow filter on left eye, blue filter on right eye) +

+
+
‘aybh’
+

anaglyph yellow/blue half colored +(yellow filter on left eye, blue filter on right eye) +

+
+
‘aybc’
+

anaglyph yellow/blue colored +(yellow filter on left eye, blue filter on right eye) +

+
+
‘aybd’
+

anaglyph yellow/blue color optimized with the least squares projection of dubois +(yellow filter on left eye, blue filter on right eye) +

+
+
‘ml’
+

mono output (left eye only) +

+
+
‘mr’
+

mono output (right eye only) +

+
+
‘chl’
+

checkerboard, left eye first +

+
+
‘chr’
+

checkerboard, right eye first +

+
+
‘icl’
+

interleaved columns, left eye first +

+
+
‘icr’
+

interleaved columns, right eye first +

+
+
‘hdmi’
+

HDMI frame pack +

+
+ +

Default value is ‘arcd’. +

+
+ + +

32.198.1 Examples

+ +
    +
  • Convert input video from side by side parallel to anaglyph yellow/blue dubois: +
    +
    stereo3d=sbsl:aybd
+
    + +
  • Convert input video from above below (left eye above, right eye below) to side by side crosseye. +
    +
    stereo3d=abl:sbsr
+
    +
+ + +

32.199 streamselect, astreamselect

+

Select video or audio streams. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of inputs. Default is 2. +

+
+
map
+

Set input indexes to remap to outputs. +

+
+ + +

32.199.1 Commands

+ +

The streamselect and astreamselect filter supports the following +commands: +

+
+
map
+

Set input indexes to remap to outputs. +

+
+ + +

32.199.2 Examples

+ +
    +
  • Select first 5 seconds 1st stream and rest of time 2nd stream: +
    +
    sendcmd='5.0 streamselect map 1',streamselect=inputs=2:map=0
+
    + +
  • Same as above, but for audio: +
    +
    asendcmd='5.0 astreamselect map 1',astreamselect=inputs=2:map=0
+
    +
+ + +

32.200 subtitles

+ +

Draw subtitles on top of input video using the libass library. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libass. This filter also requires a build with libavcodec and +libavformat to convert the passed subtitles file to ASS (Advanced Substation +Alpha) subtitles format. +

+

The filter accepts the following options: +

+
+
filename, f
+

Set the filename of the subtitle file to read. It must be specified. +

+
+
original_size
+

Specify the size of the original video, the video for which the ASS file +was composed. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Due to a misdesign in ASS aspect ratio arithmetic, this is necessary to +correctly scale the fonts if the aspect ratio has been changed. +

+
+
fontsdir
+

Set a directory path containing fonts that can be used by the filter. +These fonts will be used in addition to whatever the font provider uses. +

+
+
alpha
+

Process alpha channel, by default alpha channel is untouched. +

+
+
charenc
+

Set subtitles input character encoding. subtitles filter only. Only +useful if not UTF-8. +

+
+
stream_index, si
+

Set subtitles stream index. subtitles filter only. +

+
+
force_style
+

Override default style or script info parameters of the subtitles. It accepts a +string containing ASS style format KEY=VALUE couples separated by ",". +

+
+ +

If the first key is not specified, it is assumed that the first value +specifies the filename. +

+

For example, to render the file sub.srt on top of the input +video, use the command: +

+
subtitles=sub.srt
+
+ +

which is equivalent to: +

+
subtitles=filename=sub.srt
+
+ +

To render the default subtitles stream from file video.mkv, use: +

+
subtitles=video.mkv
+
+ +

To render the second subtitles stream from that file, use: +

+
subtitles=video.mkv:si=1
+
+ +

To make the subtitles stream from sub.srt appear in 80% transparent blue +DejaVu Serif, use: +

+
subtitles=sub.srt:force_style='FontName=DejaVu Serif,PrimaryColour=&HCCFF0000'
+
+ + +

32.201 super2xsai

+ +

Scale the input by 2x and smooth using the Super2xSaI (Scale and +Interpolate) pixel art scaling algorithm. +

+

Useful for enlarging pixel art images without reducing sharpness. +

+ +

32.202 swaprect

+ +

Swap two rectangular objects in video. +

+

This filter accepts the following options: +

+
+
w
+

Set object width. +

+
+
h
+

Set object height. +

+
+
x1
+

Set 1st rect x coordinate. +

+
+
y1
+

Set 1st rect y coordinate. +

+
+
x2
+

Set 2nd rect x coordinate. +

+
+
y2
+

Set 2nd rect y coordinate. +

+

All expressions are evaluated once for each frame. +

+
+ +

The all options are expressions containing the following constants: +

+
+
w
+
h
+

The input width and height. +

+
+
a
+

same as w / h +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (w / h) * sar +

+
+
n
+

The number of the input frame, starting from 0. +

+
+
t
+

The timestamp expressed in seconds. It’s NAN if the input timestamp is unknown. +

+
+
pos
+

the position in the file of the input frame, NAN if unknown +

+
+ + +

32.203 swapuv

+

Swap U & V plane. +

+ +

32.204 tblend

+

Blend successive video frames. +

+

See blend +

+ +

32.205 telecine

+ +

Apply telecine process to the video. +

+

This filter accepts the following options: +

+
+
first_field
+
+
‘top, t’
+

top field first +

+
‘bottom, b’
+

bottom field first +The default value is top. +

+
+ +
+
pattern
+

A string of numbers representing the pulldown pattern you wish to apply. +The default value is 23. +

+
+ +
+
Some typical patterns:
+
+NTSC output (30i):
+27.5p: 32222
+24p: 23 (classic)
+24p: 2332 (preferred)
+20p: 33
+18p: 334
+16p: 3444
+
+PAL output (25i):
+27.5p: 12222
+24p: 222222222223 ("Euro pulldown")
+16.67p: 33
+16p: 33333334
+
+ + +

32.206 thistogram

+ +

Compute and draw a color distribution histogram for the input video across time. +

+

Unlike histogram video filter which only shows histogram of single input frame +at certain time, this filter shows also past histograms of number of frames defined +by width option. +

+

The computed histogram is a representation of the color component +distribution in an image. +

+

The filter accepts the following options: +

+
+
width, w
+

Set width of single color component output. Default value is 0. +Value of 0 means width will be picked from input video. +This also set number of passed histograms to keep. +Allowed range is [0, 8192]. +

+
+
display_mode, d
+

Set display mode. +It accepts the following values: +

+
‘stack’
+

Per color component graphs are placed below each other. +

+
+
‘parade’
+

Per color component graphs are placed side by side. +

+
+
‘overlay’
+

Presents information identical to that in the parade, except +that the graphs representing color components are superimposed directly +over one another. +

+
+

Default is stack. +

+
+
levels_mode, m
+

Set mode. Can be either linear, or logarithmic. +Default is linear. +

+
+
components, c
+

Set what color components to display. +Default is 7. +

+
+
bgopacity, b
+

Set background opacity. Default is 0.9. +

+
+
envelope, e
+

Show envelope. Default is disabled. +

+
+
ecolor, ec
+

Set envelope color. Default is gold. +

+
+ + +

32.207 threshold

+ +

Apply threshold effect to video stream. +

+

This filter needs four video streams to perform thresholding. +First stream is stream we are filtering. +Second stream is holding threshold values, third stream is holding min values, +and last, fourth stream is holding max values. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+
+ +

For example if first stream pixel’s component value is less then threshold value +of pixel component from 2nd threshold stream, third stream value will picked, +otherwise fourth stream pixel component value will be picked. +

+

Using color source filter one can perform various types of thresholding: +

+ +

32.207.1 Examples

+ +
    +
  • Binary threshold, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=black -f lavfi -i color=white -lavfi threshold output.avi
+
    + +
  • Inverted binary threshold, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=white -f lavfi -i color=black -lavfi threshold output.avi
+
    + +
  • Truncate binary threshold, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -i 320x240.avi -f lavfi -i color=gray -lavfi threshold output.avi
+
    + +
  • Threshold to zero, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -f lavfi -i color=white -i 320x240.avi -lavfi threshold output.avi
+
    + +
  • Inverted threshold to zero, using gray color as threshold: +
    +
    ffmpeg -i 320x240.avi -f lavfi -i color=gray -i 320x240.avi -f lavfi -i color=white -lavfi threshold output.avi
+
    +
+ + +

32.208 thumbnail

+

Select the most representative frame in a given sequence of consecutive frames. +

+

The filter accepts the following options: +

+
+
n
+

Set the frames batch size to analyze; in a set of n frames, the filter +will pick one of them, and then handle the next batch of n frames until +the end. Default is 100. +

+
+ +

Since the filter keeps track of the whole frames sequence, a bigger n +value will result in a higher memory usage, so a high value is not recommended. +

+ +

32.208.1 Examples

+ +
    +
  • Extract one picture each 50 frames: +
    +
    thumbnail=50
+
    + +
  • Complete example of a thumbnail creation with ffmpeg: +
    +
    ffmpeg -i in.avi -vf thumbnail,scale=300:200 -frames:v 1 out.png
+
    +
+ + +

32.209 tile

+ +

Tile several successive frames together. +

+

The untile filter can do the reverse. +

+

The filter accepts the following options: +

+
+
layout
+

Set the grid size (i.e. the number of lines and columns). For the syntax of +this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
nb_frames
+

Set the maximum number of frames to render in the given area. It must be less +than or equal to wxh. The default value is 0, meaning all +the area will be used. +

+
+
margin
+

Set the outer border margin in pixels. +

+
+
padding
+

Set the inner border thickness (i.e. the number of pixels between frames). For +more advanced padding options (such as having different values for the edges), +refer to the pad video filter. +

+
+
color
+

Specify the color of the unused area. For the syntax of this option, check the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +The default value of color is "black". +

+
+
overlap
+

Set the number of frames to overlap when tiling several successive frames together. +The value must be between 0 and nb_frames - 1. +

+
+
init_padding
+

Set the number of frames to initially be empty before displaying first output frame. +This controls how soon will one get first output frame. +The value must be between 0 and nb_frames - 1. +

+
+ + +

32.209.1 Examples

+ +
    +
  • Produce 8x8 PNG tiles of all keyframes (-skip_frame nokey) in a movie: +
    +
    ffmpeg -skip_frame nokey -i file.avi -vf 'scale=128:72,tile=8x8' -an -vsync 0 keyframes%03d.png
+
    +

    The -vsync 0 is necessary to prevent ffmpeg from +duplicating each output frame to accommodate the originally detected frame +rate. +

    +
  • Display 5 pictures in an area of 3x2 frames, +with 7 pixels between them, and 2 pixels of initial margin, using +mixed flat and named options: +
    +
    tile=3x2:nb_frames=5:padding=7:margin=2
+
    +
+ + +

32.210 tinterlace

+ +

Perform various types of temporal field interlacing. +

+

Frames are counted starting from 1, so the first input frame is +considered odd. +

+

The filter accepts the following options: +

+
+
mode
+

Specify the mode of the interlacing. This option can also be specified +as a value alone. See below for a list of values for this option. +

+

Available values are: +

+
+
‘merge, 0’
+

Move odd frames into the upper field, even into the lower field, +generating a double height frame at half frame rate. +

+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+
+ +
+
‘drop_even, 1’
+

Only output odd frames, even frames are dropped, generating a frame with +unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111                           33333
+11111                           33333
+11111                           33333
+11111                           33333
+
+ +
+
‘drop_odd, 2’
+

Only output even frames, odd frames are dropped, generating a frame with +unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+                22222                           44444
+                22222                           44444
+                22222                           44444
+                22222                           44444
+
+ +
+
‘pad, 3’
+

Expand each frame to full height, but pad alternate lines with black, +generating a frame with double height at the same input frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111           .....           33333           .....
+.....           22222           .....           44444
+11111           .....           33333           .....
+.....           22222           .....           44444
+11111           .....           33333           .....
+.....           22222           .....           44444
+11111           .....           33333           .....
+.....           22222           .....           44444
+
+ + +
+
‘interleave_top, 4’
+

Interleave the upper field from odd frames with the lower field from +even frames, generating a frame with unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111<-         22222           33333<-         44444
+11111           22222<-         33333           44444<-
+11111<-         22222           33333<-         44444
+11111           22222<-         33333           44444<-
+
+Output:
+11111                           33333
+22222                           44444
+11111                           33333
+22222                           44444
+
+ + +
+
‘interleave_bottom, 5’
+

Interleave the lower field from odd frames with the upper field from +even frames, generating a frame with unchanged height at half frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222<-         33333           44444<-
+11111<-         22222           33333<-         44444
+11111           22222<-         33333           44444<-
+11111<-         22222           33333<-         44444
+
+Output:
+22222                           44444
+11111                           33333
+22222                           44444
+11111                           33333
+
+ + +
+
‘interlacex2, 6’
+

Double frame rate with unchanged height. Frames are inserted each +containing the second temporal field from the previous input frame and +the first temporal field from the next input frame. This mode relies on +the top_field_first flag. Useful for interlaced video displays with no +field synchronisation. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+ 11111           22222           33333           44444
+11111           22222           33333           44444
+ 11111           22222           33333           44444
+
+Output:
+11111   22222   22222   33333   33333   44444   44444
+ 11111   11111   22222   22222   33333   33333   44444
+11111   22222   22222   33333   33333   44444   44444
+ 11111   11111   22222   22222   33333   33333   44444
+
+ + +
+
‘mergex2, 7’
+

Move odd frames into the upper field, even into the lower field, +generating a double height frame at same frame rate. +

+
+
 ------> time
+Input:
+Frame 1         Frame 2         Frame 3         Frame 4
+
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+11111           22222           33333           44444
+
+Output:
+11111           33333           33333           55555
+22222           22222           44444           44444
+11111           33333           33333           55555
+22222           22222           44444           44444
+11111           33333           33333           55555
+22222           22222           44444           44444
+11111           33333           33333           55555
+22222           22222           44444           44444
+
+ +
+
+ +

Numeric values are deprecated but are accepted for backward +compatibility reasons. +

+

Default mode is merge. +

+
+
flags
+

Specify flags influencing the filter process. +

+

Available value for flags is: +

+
+
low_pass_filter, vlpf
+

Enable linear vertical low-pass filtering in the filter. +Vertical low-pass filtering is required when creating an interlaced +destination from a progressive source which contains high-frequency +vertical detail. Filtering will reduce interlace ’twitter’ and Moire +patterning. +

+
+
complex_filter, cvlpf
+

Enable complex vertical low-pass filtering. +This will slightly less reduce interlace ’twitter’ and Moire +patterning but better retain detail and subjective sharpness impression. +

+
+
bypass_il
+

Bypass already interlaced frames, only adjust the frame rate. +

+
+ +

Vertical low-pass filtering and bypassing already interlaced frames can only be +enabled for mode interleave_top and interleave_bottom. +

+
+
+ + +

32.211 tmedian

+

Pick median pixels from several successive input video frames. +

+

The filter accepts the following options: +

+
+
radius
+

Set radius of median filter. +Default is 1. Allowed range is from 1 to 127. +

+
+
planes
+

Set which planes to filter. Default value is 15, by which all planes are processed. +

+
+
percentile
+

Set median percentile. Default value is 0.5. +Default value of 0.5 will pick always median values, while 0 will pick +minimum values, and 1 maximum values. +

+
+ + +

32.212 tmix

+ +

Mix successive video frames. +

+

A description of the accepted options follows. +

+
+
frames
+

The number of successive frames to mix. If unspecified, it defaults to 3. +

+
+
weights
+

Specify weight of each input video frame. +Each weight is separated by space. If number of weights is smaller than +number of frames last specified weight will be used for all remaining +unset weights. +

+
+
scale
+

Specify scale, if it is set it will be multiplied with sum +of each weight multiplied with pixel values to give final destination +pixel value. By default scale is auto scaled to sum of weights. +

+
+ + +

32.212.1 Examples

+ +
    +
  • Average 7 successive frames: +
    +
    tmix=frames=7:weights="1 1 1 1 1 1 1"
+
    + +
  • Apply simple temporal convolution: +
    +
    tmix=frames=3:weights="-1 3 -1"
+
    + +
  • Similar as above but only showing temporal differences: +
    +
    tmix=frames=3:weights="-1 2 -1":scale=1
+
    +
+ + +

32.213 tonemap

+

Tone map colors from different dynamic ranges. +

+

This filter expects data in single precision floating point, as it needs to +operate on (and can output) out-of-range values. Another filter, such as +zscale, is needed to convert the resulting frame to a usable format. +

+

The tonemapping algorithms implemented only work on linear light, so input +data should be linearized beforehand (and possibly correctly tagged). +

+
+
ffmpeg -i INPUT -vf zscale=transfer=linear,tonemap=clip,zscale=transfer=bt709,format=yuv420p OUTPUT
+
+ + +

32.213.1 Options

+

The filter accepts the following options. +

+
+
tonemap
+

Set the tone map algorithm to use. +

+

Possible values are: +

+
none
+

Do not apply any tone map, only desaturate overbright pixels. +

+
+
clip
+

Hard-clip any out-of-range values. Use it for perfect color accuracy for +in-range values, while distorting out-of-range values. +

+
+
linear
+

Stretch the entire reference gamut to a linear multiple of the display. +

+
+
gamma
+

Fit a logarithmic transfer between the tone curves. +

+
+
reinhard
+

Preserve overall image brightness with a simple curve, using nonlinear +contrast, which results in flattening details and degrading color accuracy. +

+
+
hable
+

Preserve both dark and bright details better than reinhard, at the cost +of slightly darkening everything. Use it when detail preservation is more +important than color and brightness accuracy. +

+
+
mobius
+

Smoothly map out-of-range values, while retaining contrast and colors for +in-range material as much as possible. Use it when color accuracy is more +important than detail preservation. +

+
+ +

Default is none. +

+
+
param
+

Tune the tone mapping algorithm. +

+

This affects the following algorithms: +

+
none
+

Ignored. +

+
+
linear
+

Specifies the scale factor to use while stretching. +Default to 1.0. +

+
+
gamma
+

Specifies the exponent of the function. +Default to 1.8. +

+
+
clip
+

Specify an extra linear coefficient to multiply into the signal before clipping. +Default to 1.0. +

+
+
reinhard
+

Specify the local contrast coefficient at the display peak. +Default to 0.5, which means that in-gamut values will be about half as bright +as when clipping. +

+
+
hable
+

Ignored. +

+
+
mobius
+

Specify the transition point from linear to mobius transform. Every value +below this point is guaranteed to be mapped 1:1. The higher the value, the +more accurate the result will be, at the cost of losing bright details. +Default to 0.3, which due to the steep initial slope still preserves in-range +colors fairly accurately. +

+
+ +
+
desat
+

Apply desaturation for highlights that exceed this level of brightness. The +higher the parameter, the more color information will be preserved. This +setting helps prevent unnaturally blown-out colors for super-highlights, by +(smoothly) turning into white instead. This makes images feel more natural, +at the cost of reducing information about out-of-range colors. +

+

The default of 2.0 is somewhat conservative and will mostly just apply to +skies or directly sunlit surfaces. A setting of 0.0 disables this option. +

+

This option works only if the input frame has a supported color tag. +

+
+
peak
+

Override signal/nominal/reference peak with this value. Useful when the +embedded peak information in display metadata is not reliable or when tone +mapping from a lower range to a higher range. +

+
+ + +

32.214 tpad

+ +

Temporarily pad video frames. +

+

The filter accepts the following options: +

+
+
start
+

Specify number of delay frames before input video stream. Default is 0. +

+
+
stop
+

Specify number of padding frames after input video stream. +Set to -1 to pad indefinitely. Default is 0. +

+
+
start_mode
+

Set kind of frames added to beginning of stream. +Can be either add or clone. +With add frames of solid-color are added. +With clone frames are clones of first frame. +Default is add. +

+
+
stop_mode
+

Set kind of frames added to end of stream. +Can be either add or clone. +With add frames of solid-color are added. +With clone frames are clones of last frame. +Default is add. +

+
+
start_duration, stop_duration
+

Specify the duration of the start/stop delay. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +These options override start and stop. Default is 0. +

+
+
color
+

Specify the color of the padded area. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. +

+

The default value of color is "black". +

+
+ + +

32.215 transpose

+ +

Transpose rows with columns in the input video and optionally flip it. +

+

It accepts the following parameters: +

+
+
dir
+

Specify the transposition direction. +

+

Can assume the following values: +

+
‘0, 4, cclock_flip’
+

Rotate by 90 degrees counterclockwise and vertically flip (default), that is: +

+
L.R     L.l
+. . ->  . .
+l.r     R.r
+
+ +
+
‘1, 5, clock’
+

Rotate by 90 degrees clockwise, that is: +

+
L.R     l.L
+. . ->  . .
+l.r     r.R
+
+ +
+
‘2, 6, cclock’
+

Rotate by 90 degrees counterclockwise, that is: +

+
L.R     R.r
+. . ->  . .
+l.r     L.l
+
+ +
+
‘3, 7, clock_flip’
+

Rotate by 90 degrees clockwise and vertically flip, that is: +

+
L.R     r.R
+. . ->  . .
+l.r     l.L
+
+
+
+ +

For values between 4-7, the transposition is only done if the input +video geometry is portrait and not landscape. These values are +deprecated, the passthrough option should be used instead. +

+

Numerical values are deprecated, and should be dropped in favor of +symbolic constants. +

+
+
passthrough
+

Do not apply the transposition if the input geometry matches the one +specified by the specified value. It accepts the following values: +

+
‘none’
+

Always apply transposition. +

+
‘portrait’
+

Preserve portrait geometry (when height >= width). +

+
‘landscape’
+

Preserve landscape geometry (when width >= height). +

+
+ +

Default value is none. +

+
+ +

For example to rotate by 90 degrees clockwise and preserve portrait +layout: +

+
transpose=dir=1:passthrough=portrait
+
+ +

The command above can also be specified as: +

+
transpose=1:portrait
+
+ + +

32.216 transpose_npp

+ +

Transpose rows with columns in the input video and optionally flip it. +For more in depth examples see the transpose video filter, which shares mostly the same options. +

+

It accepts the following parameters: +

+
+
dir
+

Specify the transposition direction. +

+

Can assume the following values: +

+
‘cclock_flip’
+

Rotate by 90 degrees counterclockwise and vertically flip. (default) +

+
+
‘clock’
+

Rotate by 90 degrees clockwise. +

+
+
‘cclock’
+

Rotate by 90 degrees counterclockwise. +

+
+
‘clock_flip’
+

Rotate by 90 degrees clockwise and vertically flip. +

+
+ +
+
passthrough
+

Do not apply the transposition if the input geometry matches the one +specified by the specified value. It accepts the following values: +

+
‘none’
+

Always apply transposition. (default) +

+
‘portrait’
+

Preserve portrait geometry (when height >= width). +

+
‘landscape’
+

Preserve landscape geometry (when width >= height). +

+
+ +
+
+ + +

32.217 trim

+

Trim the input so that the output contains one continuous subpart of the input. +

+

It accepts the following parameters: +

+
start
+

Specify the time of the start of the kept section, i.e. the frame with the +timestamp start will be the first frame in the output. +

+
+
end
+

Specify the time of the first frame that will be dropped, i.e. the frame +immediately preceding the one with the timestamp end will be the last +frame in the output. +

+
+
start_pts
+

This is the same as start, except this option sets the start timestamp +in timebase units instead of seconds. +

+
+
end_pts
+

This is the same as end, except this option sets the end timestamp +in timebase units instead of seconds. +

+
+
duration
+

The maximum duration of the output in seconds. +

+
+
start_frame
+

The number of the first frame that should be passed to the output. +

+
+
end_frame
+

The number of the first frame that should be dropped. +

+
+ +

start, end, and duration are expressed as time +duration specifications; see +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

Note that the first two sets of the start/end options and the duration +option look at the frame timestamp, while the _frame variants simply count the +frames that pass through the filter. Also note that this filter does not modify +the timestamps. If you wish for the output timestamps to start at zero, insert a +setpts filter after the trim filter. +

+

If multiple start or end options are set, this filter tries to be greedy and +keep all the frames that match at least one of the specified constraints. To keep +only the part that matches all the constraints at once, chain multiple trim +filters. +

+

The defaults are such that all the input is kept. So it is possible to set e.g. +just the end values to keep everything before the specified time. +

+

Examples: +

    +
  • Drop everything except the second minute of input: +
    +
    ffmpeg -i INPUT -vf trim=60:120
+
    + +
  • Keep only the first second: +
    +
    ffmpeg -i INPUT -vf trim=duration=1
+
    + +
+ + +

32.218 unpremultiply

+

Apply alpha unpremultiply effect to input video stream using first plane +of second stream as alpha. +

+

Both streams must have same dimensions and same pixel format. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes will be processed, unprocessed planes will be copied. +By default value 0xf, all planes will be processed. +

+

If the format has 1 or 2 components, then luma is bit 0. +If the format has 3 or 4 components: +for RGB formats bit 0 is green, bit 1 is blue and bit 2 is red; +for YUV formats bit 0 is luma, bit 1 is chroma-U and bit 2 is chroma-V. +If present, the alpha channel is always the last bit. +

+
+
inplace
+

Do not require 2nd input for processing, instead use alpha plane from input stream. +

+
+ + +

32.219 unsharp

+ +

Sharpen or blur the input video. +

+

It accepts the following parameters: +

+
+
luma_msize_x, lx
+

Set the luma matrix horizontal size. It must be an odd integer between +3 and 23. The default value is 5. +

+
+
luma_msize_y, ly
+

Set the luma matrix vertical size. It must be an odd integer between 3 +and 23. The default value is 5. +

+
+
luma_amount, la
+

Set the luma effect strength. It must be a floating point number, reasonable +values lay between -1.5 and 1.5. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+

Default value is 1.0. +

+
+
chroma_msize_x, cx
+

Set the chroma matrix horizontal size. It must be an odd integer +between 3 and 23. The default value is 5. +

+
+
chroma_msize_y, cy
+

Set the chroma matrix vertical size. It must be an odd integer +between 3 and 23. The default value is 5. +

+
+
chroma_amount, ca
+

Set the chroma effect strength. It must be a floating point number, reasonable +values lay between -1.5 and 1.5. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+

Default value is 0.0. +

+
+
+ +

All parameters are optional and default to the equivalent of the +string ’5:5:1.0:5:5:0.0’. +

+ +

32.219.1 Examples

+ +
    +
  • Apply strong luma sharpen effect: +
    +
    unsharp=luma_msize_x=7:luma_msize_y=7:luma_amount=2.5
+
    + +
  • Apply a strong blur of both luma and chroma parameters: +
    +
    unsharp=7:7:-2:7:7:-2
+
    +
+ + +

32.220 untile

+ +

Decompose a video made of tiled images into the individual images. +

+

The frame rate of the output video is the frame rate of the input video +multiplied by the number of tiles. +

+

This filter does the reverse of tile. +

+

The filter accepts the following options: +

+
+
layout
+

Set the grid size (i.e. the number of lines and columns). For the syntax of +this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+ + +

32.220.1 Examples

+ +
    +
  • Produce a 1-second video from a still image file made of 25 frames stacked +vertically, like an analogic film reel: +
    +
    ffmpeg -r 1 -i image.jpg -vf untile=1x25 movie.mkv
+
    +
+ + +

32.221 uspp

+ +

Apply ultra slow/simple postprocessing filter that compresses and decompresses +the image at several (or - in the case of quality level 8 - all) +shifts and average the results. +

+

The way this differs from the behavior of spp is that uspp actually encodes & +decodes each case with libavcodec Snow, whereas spp uses a simplified intra only 8x8 +DCT similar to MJPEG. +

+

The filter accepts the following options: +

+
+
quality
+

Set quality. This option defines the number of levels for averaging. It accepts +an integer in the range 0-8. If set to 0, the filter will have no +effect. A value of 8 means the higher quality. For each increment of +that value the speed drops by a factor of approximately 2. Default value is +3. +

+
+
qp
+

Force a constant quantization parameter. If not set, the filter will use the QP +from the video stream (if available). +

+
+ + +

32.222 v360

+ +

Convert 360 videos between various formats. +

+

The filter accepts the following options: +

+
+
input
+
output
+

Set format of the input/output video. +

+

Available formats: +

+
+
‘e’
+
‘equirect’
+

Equirectangular projection. +

+
+
‘c3x2’
+
‘c6x1’
+
‘c1x6’
+

Cubemap with 3x2/6x1/1x6 layout. +

+

Format specific options: +

+
+
in_pad
+
out_pad
+

Set padding proportion for the input/output cubemap. Values in decimals. +

+

Example values: +

+
‘0’
+

No padding. +

+
‘0.01’
+

1% of face is padding. For example, with 1920x1280 resolution face size would be 640x640 and padding would be 3 pixels from each side. (640 * 0.01 = 6 pixels) +

+
+ +

Default value is ‘0’. +Maximum value is ‘0.1’. +

+
+
fin_pad
+
fout_pad
+

Set fixed padding for the input/output cubemap. Values in pixels. +

+

Default value is ‘0’. If greater than zero it overrides other padding options. +

+
+
in_forder
+
out_forder
+

Set order of faces for the input/output cubemap. Choose one direction for each position. +

+

Designation of directions: +

+
‘r’
+

right +

+
‘l’
+

left +

+
‘u’
+

up +

+
‘d’
+

down +

+
‘f’
+

forward +

+
‘b’
+

back +

+
+ +

Default value is ‘rludfb’. +

+
+
in_frot
+
out_frot
+

Set rotation of faces for the input/output cubemap. Choose one angle for each position. +

+

Designation of angles: +

+
‘0’
+

0 degrees clockwise +

+
‘1’
+

90 degrees clockwise +

+
‘2’
+

180 degrees clockwise +

+
‘3’
+

270 degrees clockwise +

+
+ +

Default value is ‘000000’. +

+
+ +
+
‘eac’
+

Equi-Angular Cubemap. +

+
+
‘flat’
+
‘gnomonic’
+
‘rectilinear’
+

Regular video. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘dfisheye’
+

Dual fisheye. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘barrel’
+
‘fb’
+
‘barrelsplit’
+

Facebook’s 360 formats. +

+
+
‘sg’
+

Stereographic format. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘mercator’
+

Mercator format. +

+
+
‘ball’
+

Ball format, gives significant distortion toward the back. +

+
+
‘hammer’
+

Hammer-Aitoff map projection format. +

+
+
‘sinusoidal’
+

Sinusoidal map projection format. +

+
+
‘fisheye’
+

Fisheye projection. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘pannini’
+

Pannini projection. +

+

Format specific options: +

+
h_fov
+

Set output pannini parameter. +

+
+
ih_fov
+

Set input pannini parameter. +

+
+ +
+
‘cylindrical’
+

Cylindrical projection. +

+

Format specific options: +

+
h_fov
+
v_fov
+
d_fov
+

Set output horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+
ih_fov
+
iv_fov
+
id_fov
+

Set input horizontal/vertical/diagonal field of view. Values in degrees. +

+

If diagonal field of view is set it overrides horizontal and vertical field of view. +

+
+ +
+
‘perspective’
+

Perspective projection. (output only) +

+

Format specific options: +

+
v_fov
+

Set perspective parameter. +

+
+ +
+
‘tetrahedron’
+

Tetrahedron projection. +

+
+
‘tsp’
+

Truncated square pyramid projection. +

+
+
‘he’
+
‘hequirect’
+

Half equirectangular projection. +

+
+ +
+
interp
+

Set interpolation method.
+Note: more complex interpolation methods require much more memory to run. +

+

Available methods: +

+
+
‘near’
+
‘nearest’
+

Nearest neighbour. +

+
‘line’
+
‘linear’
+

Bilinear interpolation. +

+
‘lagrange9’
+

Lagrange9 interpolation. +

+
‘cube’
+
‘cubic’
+

Bicubic interpolation. +

+
‘lanc’
+
‘lanczos’
+

Lanczos interpolation. +

+
‘sp16’
+
‘spline16’
+

Spline16 interpolation. +

+
‘gauss’
+
‘gaussian’
+

Gaussian interpolation. +

+
+ +

Default value is ‘line’. +

+
+
w
+
h
+

Set the output video resolution. +

+

Default resolution depends on formats. +

+
+
in_stereo
+
out_stereo
+

Set the input/output stereo format. +

+
+
‘2d’
+

2D mono +

+
‘sbs’
+

Side by side +

+
‘tb’
+

Top bottom +

+
+ +

Default value is ‘2d’ for input and output format. +

+
+
yaw
+
pitch
+
roll
+

Set rotation for the output video. Values in degrees. +

+
+
rorder
+

Set rotation order for the output video. Choose one item for each position. +

+
+
‘y, Y’
+

yaw +

+
‘p, P’
+

pitch +

+
‘r, R’
+

roll +

+
+ +

Default value is ‘ypr’. +

+
+
h_flip
+
v_flip
+
d_flip
+

Flip the output video horizontally(swaps left-right)/vertically(swaps up-down)/in-depth(swaps back-forward). Boolean values. +

+
+
ih_flip
+
iv_flip
+

Set if input video is flipped horizontally/vertically. Boolean values. +

+
+
in_trans
+

Set if input video is transposed. Boolean value, by default disabled. +

+
+
out_trans
+

Set if output video needs to be transposed. Boolean value, by default disabled. +

+
+
alpha_mask
+

Build mask in alpha plane for all unmapped pixels by marking them fully transparent. Boolean value, by default disabled. +

+
+ + +

32.222.1 Examples

+ +
    +
  • Convert equirectangular video to cubemap with 3x2 layout and 1% padding using bicubic interpolation: +
    +
    ffmpeg -i input.mkv -vf v360=e:c3x2:cubic:out_pad=0.01 output.mkv
+
    +
  • Extract back view of Equi-Angular Cubemap: +
    +
    ffmpeg -i input.mkv -vf v360=eac:flat:yaw=180 output.mkv
+
    +
  • Convert transposed and horizontally flipped Equi-Angular Cubemap in side-by-side stereo format to equirectangular top-bottom stereo format: +
    +
    v360=eac:equirect:in_stereo=sbs:in_trans=1:ih_flip=1:out_stereo=tb
+
    +
+ + +

32.222.2 Commands

+ +

This filter supports subset of above options as commands. +

+ +

32.223 vaguedenoiser

+ +

Apply a wavelet based denoiser. +

+

It transforms each frame from the video input into the wavelet domain, +using Cohen-Daubechies-Feauveau 9/7. Then it applies some filtering to +the obtained coefficients. It does an inverse wavelet transform after. +Due to wavelet properties, it should give a nice smoothed result, and +reduced noise, without blurring picture features. +

+

This filter accepts the following options: +

+
+
threshold
+

The filtering strength. The higher, the more filtered the video will be. +Hard thresholding can use a higher threshold than soft thresholding +before the video looks overfiltered. Default value is 2. +

+
+
method
+

The filtering method the filter will use. +

+

It accepts the following values: +

+
‘hard’
+

All values under the threshold will be zeroed. +

+
+
‘soft’
+

All values under the threshold will be zeroed. All values above will be +reduced by the threshold. +

+
+
‘garrote’
+

Scales or nullifies coefficients - intermediary between (more) soft and +(less) hard thresholding. +

+
+ +

Default is garrote. +

+
+
nsteps
+

Number of times, the wavelet will decompose the picture. Picture can’t +be decomposed beyond a particular point (typically, 8 for a 640x480 +frame - as 2^9 = 512 > 480). Valid values are integers between 1 and 32. Default value is 6. +

+
+
percent
+

Partial of full denoising (limited coefficients shrinking), from 0 to 100. Default value is 85. +

+
+
planes
+

A list of the planes to process. By default all planes are processed. +

+
+
type
+

The threshold type the filter will use. +

+

It accepts the following values: +

+
‘universal’
+

Threshold used is same for all decompositions. +

+
+
‘bayes’
+

Threshold used depends also on each decomposition coefficients. +

+
+ +

Default is universal. +

+
+ + +

32.224 vectorscope

+ +

Display 2 color component values in the two dimensional graph (which is called +a vectorscope). +

+

This filter accepts the following options: +

+
+
mode, m
+

Set vectorscope mode. +

+

It accepts the following values: +

+
‘gray’
+
‘tint’
+

Gray values are displayed on graph, higher brightness means more pixels have +same component color value on location in graph. This is the default mode. +

+
+
‘color’
+

Gray values are displayed on graph. Surrounding pixels values which are not +present in video frame are drawn in gradient of 2 color components which are +set by option x and y. The 3rd color component is static. +

+
+
‘color2’
+

Actual color components values present in video frame are displayed on graph. +

+
+
‘color3’
+

Similar as color2 but higher frequency of same values x and y +on graph increases value of another color component, which is luminance by +default values of x and y. +

+
+
‘color4’
+

Actual colors present in video frame are displayed on graph. If two different +colors map to same position on graph then color with higher value of component +not present in graph is picked. +

+
+
‘color5’
+

Gray values are displayed on graph. Similar to color but with 3rd color +component picked from radial gradient. +

+
+ +
+
x
+

Set which color component will be represented on X-axis. Default is 1. +

+
+
y
+

Set which color component will be represented on Y-axis. Default is 2. +

+
+
intensity, i
+

Set intensity, used by modes: gray, color, color3 and color5 for increasing brightness +of color component which represents frequency of (X, Y) location in graph. +

+
+
envelope, e
+
+
‘none’
+

No envelope, this is default. +

+
+
‘instant’
+

Instant envelope, even darkest single pixel will be clearly highlighted. +

+
+
‘peak’
+

Hold maximum and minimum values presented in graph over time. This way you +can still spot out of range values without constantly looking at vectorscope. +

+
+
‘peak+instant’
+

Peak and instant envelope combined together. +

+
+ +
+
graticule, g
+

Set what kind of graticule to draw. +

+
‘none’
+
‘green’
+
‘color’
+
‘invert’
+
+ +
+
opacity, o
+

Set graticule opacity. +

+
+
flags, f
+

Set graticule flags. +

+
+
‘white’
+

Draw graticule for white point. +

+
+
‘black’
+

Draw graticule for black point. +

+
+
‘name’
+

Draw color points short names. +

+
+ +
+
bgopacity, b
+

Set background opacity. +

+
+
lthreshold, l
+

Set low threshold for color component not represented on X or Y axis. +Values lower than this value will be ignored. Default is 0. +Note this value is multiplied with actual max possible value one pixel component +can have. So for 8-bit input and low threshold value of 0.1 actual threshold +is 0.1 * 255 = 25. +

+
+
hthreshold, h
+

Set high threshold for color component not represented on X or Y axis. +Values higher than this value will be ignored. Default is 1. +Note this value is multiplied with actual max possible value one pixel component +can have. So for 8-bit input and high threshold value of 0.9 actual threshold +is 0.9 * 255 = 230. +

+
+
colorspace, c
+

Set what kind of colorspace to use when drawing graticule. +

+
‘auto’
+
‘601’
+
‘709’
+
+

Default is auto. +

+
+
tint0, t0
+
tint1, t1
+

Set color tint for gray/tint vectorscope mode. By default both options are zero. +This means no tint, and output will remain gray. +

+
+ + +

32.225 vidstabdetect

+ +

Analyze video stabilization/deshaking. Perform pass 1 of 2, see +vidstabtransform for pass 2. +

+

This filter generates a file with relative translation and rotation +transform information about subsequent frames, which is then used by +the vidstabtransform filter. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libvidstab. +

+

This filter accepts the following options: +

+
+
result
+

Set the path to the file used to write the transforms information. +Default value is transforms.trf. +

+
+
shakiness
+

Set how shaky the video is and how quick the camera is. It accepts an +integer in the range 1-10, a value of 1 means little shakiness, a +value of 10 means strong shakiness. Default value is 5. +

+
+
accuracy
+

Set the accuracy of the detection process. It must be a value in the +range 1-15. A value of 1 means low accuracy, a value of 15 means high +accuracy. Default value is 15. +

+
+
stepsize
+

Set stepsize of the search process. The region around minimum is +scanned with 1 pixel resolution. Default value is 6. +

+
+
mincontrast
+

Set minimum contrast. Below this value a local measurement field is +discarded. Must be a floating point value in the range 0-1. Default +value is 0.3. +

+
+
tripod
+

Set reference frame number for tripod mode. +

+

If enabled, the motion of the frames is compared to a reference frame +in the filtered stream, identified by the specified number. The idea +is to compensate all movements in a more-or-less static scene and keep +the camera view absolutely still. +

+

If set to 0, it is disabled. The frames are counted starting from 1. +

+
+
show
+

Show fields and transforms in the resulting frames. It accepts an +integer in the range 0-2. Default value is 0, which disables any +visualization. +

+
+ + +

32.225.1 Examples

+ +
    +
  • Use default values: +
    +
    vidstabdetect
+
    + +
  • Analyze strongly shaky movie and put the results in file +mytransforms.trf: +
    +
    vidstabdetect=shakiness=10:accuracy=15:result="mytransforms.trf"
+
    + +
  • Visualize the result of internal transformations in the resulting +video: +
    +
    vidstabdetect=show=1
+
    + +
  • Analyze a video with medium shakiness using ffmpeg: +
    +
    ffmpeg -i input -vf vidstabdetect=shakiness=5:show=1 dummy.avi
+
    +
+ + +

32.226 vidstabtransform

+ +

Video stabilization/deshaking: pass 2 of 2, +see vidstabdetect for pass 1. +

+

Read a file with transform information for each frame and +apply/compensate them. Together with the vidstabdetect +filter this can be used to deshake videos. See also +http://public.hronopik.de/vid.stab. It is important to also use +the unsharp filter, see below. +

+

To enable compilation of this filter you need to configure FFmpeg with +--enable-libvidstab. +

+ +

32.226.1 Options

+ +
+
input
+

Set path to the file used to read the transforms. Default value is +transforms.trf. +

+
+
smoothing
+

Set the number of frames (value*2 + 1) used for lowpass filtering the +camera movements. Default value is 10. +

+

For example a number of 10 means that 21 frames are used (10 in the +past and 10 in the future) to smoothen the motion in the video. A +larger value leads to a smoother video, but limits the acceleration of +the camera (pan/tilt movements). 0 is a special case where a static +camera is simulated. +

+
+
optalgo
+

Set the camera path optimization algorithm. +

+

Accepted values are: +

+
‘gauss’
+

gaussian kernel low-pass filter on camera motion (default) +

+
‘avg’
+

averaging on transformations +

+
+ +
+
maxshift
+

Set maximal number of pixels to translate frames. Default value is -1, +meaning no limit. +

+
+
maxangle
+

Set maximal angle in radians (degree*PI/180) to rotate frames. Default +value is -1, meaning no limit. +

+
+
crop
+

Specify how to deal with borders that may be visible due to movement +compensation. +

+

Available values are: +

+
‘keep’
+

keep image information from previous frame (default) +

+
‘black’
+

fill the border black +

+
+ +
+
invert
+

Invert transforms if set to 1. Default value is 0. +

+
+
relative
+

Consider transforms as relative to previous frame if set to 1, +absolute if set to 0. Default value is 0. +

+
+
zoom
+

Set percentage to zoom. A positive value will result in a zoom-in +effect, a negative value in a zoom-out effect. Default value is 0 (no +zoom). +

+
+
optzoom
+

Set optimal zooming to avoid borders. +

+

Accepted values are: +

+
‘0’
+

disabled +

+
‘1’
+

optimal static zoom value is determined (only very strong movements +will lead to visible borders) (default) +

+
‘2’
+

optimal adaptive zoom value is determined (no borders will be +visible), see zoomspeed +

+
+ +

Note that the value given at zoom is added to the one calculated here. +

+
+
zoomspeed
+

Set percent to zoom maximally each frame (enabled when +optzoom is set to 2). Range is from 0 to 5, default value is +0.25. +

+
+
interpol
+

Specify type of interpolation. +

+

Available values are: +

+
‘no’
+

no interpolation +

+
‘linear’
+

linear only horizontal +

+
‘bilinear’
+

linear in both directions (default) +

+
‘bicubic’
+

cubic in both directions (slow) +

+
+ +
+
tripod
+

Enable virtual tripod mode if set to 1, which is equivalent to +relative=0:smoothing=0. Default value is 0. +

+

Use also tripod option of vidstabdetect. +

+
+
debug
+

Increase log verbosity if set to 1. Also the detected global motions +are written to the temporary file global_motions.trf. Default +value is 0. +

+
+ + +

32.226.2 Examples

+ +
    +
  • Use ffmpeg for a typical stabilization with default values: +
    +
    ffmpeg -i inp.mpeg -vf vidstabtransform,unsharp=5:5:0.8:3:3:0.4 inp_stabilized.mpeg
+
    + +

    Note the use of the unsharp filter which is always recommended. +

    +
  • Zoom in a bit more and load transform data from a given file: +
    +
    vidstabtransform=zoom=5:input="mytransforms.trf"
+
    + +
  • Smoothen the video even more: +
    +
    vidstabtransform=smoothing=30
+
    +
+ + +

32.227 vflip

+ +

Flip the input video vertically. +

+

For example, to vertically flip a video with ffmpeg: +

+
ffmpeg -i in.avi -vf "vflip" out.avi
+
+ + +

32.228 vfrdet

+ +

Detect variable frame rate video. +

+

This filter tries to detect if the input is variable or constant frame rate. +

+

At end it will output number of frames detected as having variable delta pts, +and ones with constant delta pts. +If there was frames with variable delta, than it will also show min, max and +average delta encountered. +

+ +

32.229 vibrance

+ +

Boost or alter saturation. +

+

The filter accepts the following options: +

+
intensity
+

Set strength of boost if positive value or strength of alter if negative value. +Default is 0. Allowed range is from -2 to 2. +

+
+
rbal
+

Set the red balance. Default is 1. Allowed range is from -10 to 10. +

+
+
gbal
+

Set the green balance. Default is 1. Allowed range is from -10 to 10. +

+
+
bbal
+

Set the blue balance. Default is 1. Allowed range is from -10 to 10. +

+
+
rlum
+

Set the red luma coefficient. +

+
+
glum
+

Set the green luma coefficient. +

+
+
blum
+

Set the blue luma coefficient. +

+
+
alternate
+

If intensity is negative and this is set to 1, colors will change, +otherwise colors will be less saturated, more towards gray. +

+
+ + +

32.229.1 Commands

+ +

This filter supports the all above options as commands. +

+ +

32.230 vignette

+ +

Make or reverse a natural vignetting effect. +

+

The filter accepts the following options: +

+
+
angle, a
+

Set lens angle expression as a number of radians. +

+

The value is clipped in the [0,PI/2] range. +

+

Default value: "PI/5" +

+
+
x0
+
y0
+

Set center coordinates expressions. Respectively "w/2" and "h/2" +by default. +

+
+
mode
+

Set forward/backward mode. +

+

Available modes are: +

+
‘forward’
+

The larger the distance from the central point, the darker the image becomes. +

+
+
‘backward’
+

The larger the distance from the central point, the brighter the image becomes. +This can be used to reverse a vignette effect, though there is no automatic +detection to extract the lens angle and other settings (yet). It can +also be used to create a burning effect. +

+
+ +

Default value is ‘forward’. +

+
+
eval
+

Set evaluation mode for the expressions (angle, x0, y0). +

+

It accepts the following values: +

+
‘init’
+

Evaluate expressions only once during the filter initialization. +

+
+
‘frame’
+

Evaluate expressions for each incoming frame. This is way slower than the +‘init’ mode since it requires all the scalers to be re-computed, but it +allows advanced dynamic expressions. +

+
+ +

Default value is ‘init’. +

+
+
dither
+

Set dithering to reduce the circular banding effects. Default is 1 +(enabled). +

+
+
aspect
+

Set vignette aspect. This setting allows one to adjust the shape of the vignette. +Setting this value to the SAR of the input will make a rectangular vignetting +following the dimensions of the video. +

+

Default is 1/1. +

+
+ + +

32.230.1 Expressions

+ +

The alpha, x0 and y0 expressions can contain the +following parameters. +

+
+
w
+
h
+

input width and height +

+
+
n
+

the number of input frame, starting from 0 +

+
+
pts
+

the PTS (Presentation TimeStamp) time of the filtered video frame, expressed in +TB units, NAN if undefined +

+
+
r
+

frame rate of the input video, NAN if the input frame rate is unknown +

+
+
t
+

the PTS (Presentation TimeStamp) of the filtered video frame, +expressed in seconds, NAN if undefined +

+
+
tb
+

time base of the input video +

+
+ + + +

32.230.2 Examples

+ +
    +
  • Apply simple strong vignetting effect: +
    +
    vignette=PI/4
+
    + +
  • Make a flickering vignetting: +
    +
    vignette='PI/4+random(1)*PI/50':eval=frame
+
    + +
+ + +

32.231 vmafmotion

+ +

Obtain the average VMAF motion score of a video. +It is one of the component metrics of VMAF. +

+

The obtained average motion score is printed through the logging system. +

+

The filter accepts the following options: +

+
+
stats_file
+

If specified, the filter will use the named file to save the motion score of +each frame with respect to the previous frame. +When filename equals "-" the data is sent to standard output. +

+
+ +

Example: +

+
ffmpeg -i ref.mpg -vf vmafmotion -f null -
+
+ + +

32.232 vstack

+

Stack input videos vertically. +

+

All streams must be of same pixel format and of same width. +

+

Note that this filter is faster than using overlay and pad filter +to create same output. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of input streams. Default is 2. +

+
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+ + +

32.233 w3fdif

+ +

Deinterlace the input video ("w3fdif" stands for "Weston 3 Field +Deinterlacing Filter"). +

+

Based on the process described by Martin Weston for BBC R&D, and +implemented based on the de-interlace algorithm written by Jim +Easterbrook for BBC R&D, the Weston 3 field deinterlacing filter +uses filter coefficients calculated by BBC R&D. +

+

This filter uses field-dominance information in frame to decide which +of each pair of fields to place first in the output. +If it gets it wrong use setfield filter before w3fdif filter. +

+

There are two sets of filter coefficients, so called "simple" +and "complex". Which set of filter coefficients is used can +be set by passing an optional parameter: +

+
+
filter
+

Set the interlacing filter coefficients. Accepts one of the following values: +

+
+
‘simple’
+

Simple filter coefficient set. +

+
‘complex’
+

More-complex filter coefficient set. +

+
+

Default value is ‘complex’. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following values: +

+
+
‘all’
+

Deinterlace all frames, +

+
‘interlaced’
+

Only deinterlace frames marked as interlaced. +

+
+ +

Default value is ‘all’. +

+
+ + +

32.234 waveform

+

Video waveform monitor. +

+

The waveform monitor plots color component intensity. By default luminance +only. Each column of the waveform corresponds to a column of pixels in the +source video. +

+

It accepts the following options: +

+
+
mode, m
+

Can be either row, or column. Default is column. +In row mode, the graph on the left side represents color component value 0 and +the right side represents value = 255. In column mode, the top side represents +color component value = 0 and bottom side represents value = 255. +

+
+
intensity, i
+

Set intensity. Smaller values are useful to find out how many values of the same +luminance are distributed across input rows/columns. +Default value is 0.04. Allowed range is [0, 1]. +

+
+
mirror, r
+

Set mirroring mode. 0 means unmirrored, 1 means mirrored. +In mirrored mode, higher values will be represented on the left +side for row mode and at the top for column mode. Default is +1 (mirrored). +

+
+
display, d
+

Set display mode. +It accepts the following values: +

+
‘overlay’
+

Presents information identical to that in the parade, except +that the graphs representing color components are superimposed directly +over one another. +

+

This display mode makes it easier to spot relative differences or similarities +in overlapping areas of the color components that are supposed to be identical, +such as neutral whites, grays, or blacks. +

+
+
‘stack’
+

Display separate graph for the color components side by side in +row mode or one below the other in column mode. +

+
+
‘parade’
+

Display separate graph for the color components side by side in +column mode or one below the other in row mode. +

+

Using this display mode makes it easy to spot color casts in the highlights +and shadows of an image, by comparing the contours of the top and the bottom +graphs of each waveform. Since whites, grays, and blacks are characterized +by exactly equal amounts of red, green, and blue, neutral areas of the picture +should display three waveforms of roughly equal width/height. If not, the +correction is easy to perform by making level adjustments the three waveforms. +

+
+

Default is stack. +

+
+
components, c
+

Set which color components to display. Default is 1, which means only luminance +or red color component if input is in RGB colorspace. If is set for example to +7 it will display all 3 (if) available color components. +

+
+
envelope, e
+
+
‘none’
+

No envelope, this is default. +

+
+
‘instant’
+

Instant envelope, minimum and maximum values presented in graph will be easily +visible even with small step value. +

+
+
‘peak’
+

Hold minimum and maximum values presented in graph across time. This way you +can still spot out of range values without constantly looking at waveforms. +

+
+
‘peak+instant’
+

Peak and instant envelope combined together. +

+
+ +
+
filter, f
+
+
‘lowpass’
+

No filtering, this is default. +

+
+
‘flat’
+

Luma and chroma combined together. +

+
+
‘aflat’
+

Similar as above, but shows difference between blue and red chroma. +

+
+
‘xflat’
+

Similar as above, but use different colors. +

+
+
‘yflat’
+

Similar as above, but again with different colors. +

+
+
‘chroma’
+

Displays only chroma. +

+
+
‘color’
+

Displays actual color value on waveform. +

+
+
‘acolor’
+

Similar as above, but with luma showing frequency of chroma values. +

+
+ +
+
graticule, g
+

Set which graticule to display. +

+
+
‘none’
+

Do not display graticule. +

+
+
‘green’
+

Display green graticule showing legal broadcast ranges. +

+
+
‘orange’
+

Display orange graticule showing legal broadcast ranges. +

+
+
‘invert’
+

Display invert graticule showing legal broadcast ranges. +

+
+ +
+
opacity, o
+

Set graticule opacity. +

+
+
flags, fl
+

Set graticule flags. +

+
+
‘numbers’
+

Draw numbers above lines. By default enabled. +

+
+
‘dots’
+

Draw dots instead of lines. +

+
+ +
+
scale, s
+

Set scale used for displaying graticule. +

+
+
‘digital’
+
‘millivolts’
+
‘ire’
+
+

Default is digital. +

+
+
bgopacity, b
+

Set background opacity. +

+
+
tint0, t0
+
tint1, t1
+

Set tint for output. +Only used with lowpass filter and when display is not overlay and input +pixel formats are not RGB. +

+
+ + +

32.235 weave, doubleweave

+ +

The weave takes a field-based video input and join +each two sequential fields into single frame, producing a new double +height clip with half the frame rate and half the frame count. +

+

The doubleweave works same as weave but without +halving frame rate and frame count. +

+

It accepts the following option: +

+
+
first_field
+

Set first field. Available values are: +

+
+
‘top, t’
+

Set the frame as top-field-first. +

+
+
‘bottom, b’
+

Set the frame as bottom-field-first. +

+
+
+
+ + +

32.235.1 Examples

+ +
    +
  • Interlace video using select and separatefields filter: +
    +
    separatefields,select=eq(mod(n,4),0)+eq(mod(n,4),3),weave
+
    +
+ + +

32.236 xbr

+

Apply the xBR high-quality magnification filter which is designed for pixel +art. It follows a set of edge-detection rules, see +https://forums.libretro.com/t/xbr-algorithm-tutorial/123. +

+

It accepts the following option: +

+
+
n
+

Set the scaling dimension: 2 for 2xBR, 3 for +3xBR and 4 for 4xBR. +Default is 3. +

+
+ + +

32.237 xfade

+ +

Apply cross fade from one input video stream to another input video stream. +The cross fade is applied for specified duration. +

+

The filter accepts the following options: +

+
+
transition
+

Set one of available transition effects: +

+
+
‘custom’
+
‘fade’
+
‘wipeleft’
+
‘wiperight’
+
‘wipeup’
+
‘wipedown’
+
‘slideleft’
+
‘slideright’
+
‘slideup’
+
‘slidedown’
+
‘circlecrop’
+
‘rectcrop’
+
‘distance’
+
‘fadeblack’
+
‘fadewhite’
+
‘radial’
+
‘smoothleft’
+
‘smoothright’
+
‘smoothup’
+
‘smoothdown’
+
‘circleopen’
+
‘circleclose’
+
‘vertopen’
+
‘vertclose’
+
‘horzopen’
+
‘horzclose’
+
‘dissolve’
+
‘pixelize’
+
‘diagtl’
+
‘diagtr’
+
‘diagbl’
+
‘diagbr’
+
‘hlslice’
+
‘hrslice’
+
‘vuslice’
+
‘vdslice’
+
+

Default transition effect is fade. +

+
+
duration
+

Set cross fade duration in seconds. +Default duration is 1 second. +

+
+
offset
+

Set cross fade start relative to first input stream in seconds. +Default offset is 0. +

+
+
expr
+

Set expression for custom transition effect. +

+

The expressions can use the following variables and functions: +

+
+
X
+
Y
+

The coordinates of the current sample. +

+
+
W
+
H
+

The width and height of the image. +

+
+
P
+

Progress of transition effect. +

+
+
PLANE
+

Currently processed plane. +

+
+
A
+

Return value of first input at current location and plane. +

+
+
B
+

Return value of second input at current location and plane. +

+
+
a0(x, y)
+
a1(x, y)
+
a2(x, y)
+
a3(x, y)
+

Return the value of the pixel at location (x,y) of the +first/second/third/fourth component of first input. +

+
+
b0(x, y)
+
b1(x, y)
+
b2(x, y)
+
b3(x, y)
+

Return the value of the pixel at location (x,y) of the +first/second/third/fourth component of second input. +

+
+
+
+ + +

32.237.1 Examples

+ +
    +
  • Cross fade from one input video to another input video, with fade transition and duration of transition +of 2 seconds starting at offset of 5 seconds: +
    +
    ffmpeg -i first.mp4 -i second.mp4 -filter_complex xfade=transition=fade:duration=2:offset=5 output.mp4
+
    +
+ + +

32.238 xmedian

+

Pick median pixels from several input videos. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of inputs. +Default is 3. Allowed range is from 3 to 255. +If number of inputs is even number, than result will be mean value between two median values. +

+
+
planes
+

Set which planes to filter. Default value is 15, by which all planes are processed. +

+
+
percentile
+

Set median percentile. Default value is 0.5. +Default value of 0.5 will pick always median values, while 0 will pick +minimum values, and 1 maximum values. +

+
+ + +

32.239 xstack

+

Stack video inputs into custom layout. +

+

All streams must be of same pixel format. +

+

The filter accepts the following options: +

+
+
inputs
+

Set number of input streams. Default is 2. +

+
+
layout
+

Specify layout of inputs. +This option requires the desired layout configuration to be explicitly set by the user. +This sets position of each video input in output. Each input +is separated by ’|’. +The first number represents the column, and the second number represents the row. +Numbers start at 0 and are separated by ’_’. Optionally one can use wX and hX, +where X is video input from which to take width or height. +Multiple values can be used when separated by ’+’. In such +case values are summed together. +

+

Note that if inputs are of different sizes gaps may appear, as not all of +the output video frame will be filled. Similarly, videos can overlap each +other if their position doesn’t leave enough space for the full frame of +adjoining videos. +

+

For 2 inputs, a default layout of 0_0|w0_0 is set. In all other cases, +a layout must be set by the user. +

+
+
shortest
+

If set to 1, force the output to terminate when the shortest input +terminates. Default value is 0. +

+
+
fill
+

If set to valid color, all unused pixels will be filled with that color. +By default fill is set to none, so it is disabled. +

+
+ + +

32.239.1 Examples

+ +
    +
  • Display 4 inputs into 2x2 grid. + +

    Layout: +

    +
    input1(0, 0)  | input3(w0, 0)
+input2(0, h0) | input4(w0, h0)
+
    + +
    +
    xstack=inputs=4:layout=0_0|0_h0|w0_0|w0_h0
+
    + +

    Note that if inputs are of different sizes, gaps or overlaps may occur. +

    +
  • Display 4 inputs into 1x4 grid. + +

    Layout: +

    +
    input1(0, 0)
+input2(0, h0)
+input3(0, h0+h1)
+input4(0, h0+h1+h2)
+
    + +
    +
    xstack=inputs=4:layout=0_0|0_h0|0_h0+h1|0_h0+h1+h2
+
    + +

    Note that if inputs are of different widths, unused space will appear. +

    +
  • Display 9 inputs into 3x3 grid. + +

    Layout: +

    +
    input1(0, 0)       | input4(w0, 0)      | input7(w0+w3, 0)
+input2(0, h0)      | input5(w0, h0)     | input8(w0+w3, h0)
+input3(0, h0+h1)   | input6(w0, h0+h1)  | input9(w0+w3, h0+h1)
+
    + +
    +
    xstack=inputs=9:layout=0_0|0_h0|0_h0+h1|w0_0|w0_h0|w0_h0+h1|w0+w3_0|w0+w3_h0|w0+w3_h0+h1
+
    + +

    Note that if inputs are of different sizes, gaps or overlaps may occur. +

    +
  • Display 16 inputs into 4x4 grid. + +

    Layout: +

    +
    input1(0, 0)       | input5(w0, 0)       | input9 (w0+w4, 0)       | input13(w0+w4+w8, 0)
+input2(0, h0)      | input6(w0, h0)      | input10(w0+w4, h0)      | input14(w0+w4+w8, h0)
+input3(0, h0+h1)   | input7(w0, h0+h1)   | input11(w0+w4, h0+h1)   | input15(w0+w4+w8, h0+h1)
+input4(0, h0+h1+h2)| input8(w0, h0+h1+h2)| input12(w0+w4, h0+h1+h2)| input16(w0+w4+w8, h0+h1+h2)
+
    + +
    +
    xstack=inputs=16:layout=0_0|0_h0|0_h0+h1|0_h0+h1+h2|w0_0|w0_h0|w0_h0+h1|w0_h0+h1+h2|w0+w4_0|
+w0+w4_h0|w0+w4_h0+h1|w0+w4_h0+h1+h2|w0+w4+w8_0|w0+w4+w8_h0|w0+w4+w8_h0+h1|w0+w4+w8_h0+h1+h2
+
    + +

    Note that if inputs are of different sizes, gaps or overlaps may occur. +

    +
+ + +

32.240 yadif

+ +

Deinterlace the input video ("yadif" means "yet another deinterlacing +filter"). +

+

It accepts the following parameters: +

+ +
+
mode
+

The interlacing mode to adopt. It accepts one of the following values: +

+
+
0, send_frame
+

Output one frame for each frame. +

+
1, send_field
+

Output one frame for each field. +

+
2, send_frame_nospatial
+

Like send_frame, but it skips the spatial interlacing check. +

+
3, send_field_nospatial
+

Like send_field, but it skips the spatial interlacing check. +

+
+ +

The default value is send_frame. +

+
+
parity
+

The picture field parity assumed for the input interlaced video. It accepts one +of the following values: +

+
+
0, tff
+

Assume the top field is first. +

+
1, bff
+

Assume the bottom field is first. +

+
-1, auto
+

Enable automatic detection of field parity. +

+
+ +

The default value is auto. +If the interlacing is unknown or the decoder does not export this information, +top field first will be assumed. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following +values: +

+
+
0, all
+

Deinterlace all frames. +

+
1, interlaced
+

Only deinterlace frames marked as interlaced. +

+
+ +

The default value is all. +

+
+ + +

32.241 yadif_cuda

+ +

Deinterlace the input video using the yadif algorithm, but implemented +in CUDA so that it can work as part of a GPU accelerated pipeline with nvdec +and/or nvenc. +

+

It accepts the following parameters: +

+ +
+
mode
+

The interlacing mode to adopt. It accepts one of the following values: +

+
+
0, send_frame
+

Output one frame for each frame. +

+
1, send_field
+

Output one frame for each field. +

+
2, send_frame_nospatial
+

Like send_frame, but it skips the spatial interlacing check. +

+
3, send_field_nospatial
+

Like send_field, but it skips the spatial interlacing check. +

+
+ +

The default value is send_frame. +

+
+
parity
+

The picture field parity assumed for the input interlaced video. It accepts one +of the following values: +

+
+
0, tff
+

Assume the top field is first. +

+
1, bff
+

Assume the bottom field is first. +

+
-1, auto
+

Enable automatic detection of field parity. +

+
+ +

The default value is auto. +If the interlacing is unknown or the decoder does not export this information, +top field first will be assumed. +

+
+
deint
+

Specify which frames to deinterlace. Accepts one of the following +values: +

+
+
0, all
+

Deinterlace all frames. +

+
1, interlaced
+

Only deinterlace frames marked as interlaced. +

+
+ +

The default value is all. +

+
+ + +

32.242 yaepblur

+ +

Apply blur filter while preserving edges ("yaepblur" means "yet another edge preserving blur filter"). +The algorithm is described in +"J. S. Lee, Digital image enhancement and noise filtering by use of local statistics, IEEE Trans. Pattern Anal. Mach. Intell. PAMI-2, 1980." +

+

It accepts the following parameters: +

+
+
radius, r
+

Set the window radius. Default value is 3. +

+
+
planes, p
+

Set which planes to filter. Default is only the first plane. +

+
+
sigma, s
+

Set blur strength. Default value is 128. +

+
+ + +

32.242.1 Commands

+

This filter supports same commands as options. +

+ +

32.243 zoompan

+ +

Apply Zoom & Pan effect. +

+

This filter accepts the following options: +

+
+
zoom, z
+

Set the zoom expression. Range is 1-10. Default is 1. +

+
+
x
+
y
+

Set the x and y expression. Default is 0. +

+
+
d
+

Set the duration expression in number of frames. +This sets for how many number of frames effect will last for +single input image. +

+
+
s
+

Set the output image size, default is ’hd720’. +

+
+
fps
+

Set the output frame rate, default is ’25’. +

+
+ +

Each expression can contain the following constants: +

+
+
in_w, iw
+

Input width. +

+
+
in_h, ih
+

Input height. +

+
+
out_w, ow
+

Output width. +

+
+
out_h, oh
+

Output height. +

+
+
in
+

Input frame count. +

+
+
on
+

Output frame count. +

+
+
x
+
y
+

Last calculated ’x’ and ’y’ position from ’x’ and ’y’ expression +for current input frame. +

+
+
px
+
py
+

’x’ and ’y’ of last output frame of previous input frame or 0 when there was +not yet such frame (first input frame). +

+
+
zoom
+

Last calculated zoom from ’z’ expression for current input frame. +

+
+
pzoom
+

Last calculated zoom of last output frame of previous input frame. +

+
+
duration
+

Number of output frames for current input frame. Calculated from ’d’ expression +for each input frame. +

+
+
pduration
+

number of output frames created for previous input frame +

+
+
a
+

Rational number: input width / input height +

+
+
sar
+

sample aspect ratio +

+
+
dar
+

display aspect ratio +

+
+
+ + +

32.243.1 Examples

+ +
    +
  • Zoom-in up to 1.5 and pan at same time to some spot near center of picture: +
    +
    zoompan=z='min(zoom+0.0015,1.5)':d=700:x='if(gte(zoom,1.5),x,x+1/a)':y='if(gte(zoom,1.5),y,y+1)':s=640x360
+
    + +
  • Zoom-in up to 1.5 and pan always at center of picture: +
    +
    zoompan=z='min(zoom+0.0015,1.5)':d=700:x='iw/2-(iw/zoom/2)':y='ih/2-(ih/zoom/2)'
+
    + +
  • Same as above but without pausing: +
    +
    zoompan=z='min(max(zoom,pzoom)+0.0015,1.5)':d=1:x='iw/2-(iw/zoom/2)':y='ih/2-(ih/zoom/2)'
+
    +
+ + +

32.244 zscale

+

Scale (resize) the input video, using the z.lib library: +https://github.com/sekrit-twc/zimg. To enable compilation of this +filter, you need to configure FFmpeg with --enable-libzimg. +

+

The zscale filter forces the output display aspect ratio to be the same +as the input, by changing the output sample aspect ratio. +

+

If the input image format is different from the format requested by +the next filter, the zscale filter will convert the input to the +requested format. +

+ +

32.244.1 Options

+

The filter accepts the following options. +

+
+
width, w
+
height, h
+

Set the output video dimension expression. Default value is the input +dimension. +

+

If the width or w value is 0, the input width is used for +the output. If the height or h value is 0, the input height +is used for the output. +

+

If one and only one of the values is -n with n >= 1, the zscale filter +will use a value that maintains the aspect ratio of the input image, +calculated from the other specified dimension. After that it will, +however, make sure that the calculated dimension is divisible by n and +adjust the value if necessary. +

+

If both values are -n with n >= 1, the behavior will be identical to +both values being set to 0 as previously detailed. +

+

See below for the list of accepted constants for use in the dimension +expression. +

+
+
size, s
+

Set the video size. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
dither, d
+

Set the dither type. +

+

Possible values are: +

+
none
+
ordered
+
random
+
error_diffusion
+
+ +

Default is none. +

+
+
filter, f
+

Set the resize filter type. +

+

Possible values are: +

+
point
+
bilinear
+
bicubic
+
spline16
+
spline36
+
lanczos
+
+ +

Default is bilinear. +

+
+
range, r
+

Set the color range. +

+

Possible values are: +

+
input
+
limited
+
full
+
+ +

Default is same as input. +

+
+
primaries, p
+

Set the color primaries. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
170m
+
240m
+
2020
+
+ +

Default is same as input. +

+
+
transfer, t
+

Set the transfer characteristics. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
601
+
linear
+
2020_10
+
2020_12
+
smpte2084
+
iec61966-2-1
+
arib-std-b67
+
+ +

Default is same as input. +

+
+
matrix, m
+

Set the colorspace matrix. +

+

Possible value are: +

+
input
+
709
+
unspecified
+
470bg
+
170m
+
2020_ncl
+
2020_cl
+
+ +

Default is same as input. +

+
+
rangein, rin
+

Set the input color range. +

+

Possible values are: +

+
input
+
limited
+
full
+
+ +

Default is same as input. +

+
+
primariesin, pin
+

Set the input color primaries. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
170m
+
240m
+
2020
+
+ +

Default is same as input. +

+
+
transferin, tin
+

Set the input transfer characteristics. +

+

Possible values are: +

+
input
+
709
+
unspecified
+
601
+
linear
+
2020_10
+
2020_12
+
+ +

Default is same as input. +

+
+
matrixin, min
+

Set the input colorspace matrix. +

+

Possible value are: +

+
input
+
709
+
unspecified
+
470bg
+
170m
+
2020_ncl
+
2020_cl
+
+ +
+
chromal, c
+

Set the output chroma location. +

+

Possible values are: +

+
input
+
left
+
center
+
topleft
+
top
+
bottomleft
+
bottom
+
+ +
+
chromalin, cin
+

Set the input chroma location. +

+

Possible values are: +

+
input
+
left
+
center
+
topleft
+
top
+
bottomleft
+
bottom
+
+ +
+
npl
+

Set the nominal peak luminance. +

+
+ +

The values of the w and h options are expressions +containing the following constants: +

+
+
in_w
+
in_h
+

The input width and height +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output (scaled) width and height +

+
+
ow
+
oh
+

These are the same as out_w and out_h +

+
+
a
+

The same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

The input display aspect ratio. Calculated from (iw / ih) * sar. +

+
+
hsub
+
vsub
+

horizontal and vertical input chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+
ohsub
+
ovsub
+

horizontal and vertical output chroma subsample values. For example for the +pixel format "yuv422p" hsub is 2 and vsub is 1. +

+
+ + +

32.244.2 Commands

+ +

This filter supports the following commands: +

+
width, w
+
height, h
+

Set the output video dimension expression. +The command accepts the same syntax of the corresponding option. +

+

If the specified expression is not valid, it is kept at its current +value. +

+
+ + + +

33 OpenCL Video Filters

+ +

Below is a description of the currently available OpenCL video filters. +

+

To enable compilation of these filters you need to configure FFmpeg with +--enable-opencl. +

+

Running OpenCL filters requires you to initialize a hardware device and to pass that device to all filters in any filter graph. +

+
-init_hw_device opencl[=name][:device[,key=value...]]
+

Initialise a new hardware device of type opencl called name, using the +given device parameters. +

+
+
-filter_hw_device name
+

Pass the hardware device called name to all filters in any filter graph. +

+
+
+ +

For more detailed information see https://www.ffmpeg.org/ffmpeg.html#Advanced-Video-options +

+
    +
  • Example of choosing the first device on the second platform and running avgblur_opencl filter with default parameters on it. +
    +
    -init_hw_device opencl=gpu:1.0 -filter_hw_device gpu -i INPUT -vf "hwupload, avgblur_opencl, hwdownload" OUTPUT
+
    +
+ +

Since OpenCL filters are not able to access frame data in normal memory, all frame data needs to be uploaded(hwupload) to hardware surfaces connected to the appropriate device before being used and then downloaded(hwdownload) back to normal memory. Note that hwupload will upload to a surface with the same layout as the software frame, so it may be necessary to add a format filter immediately before to get the input into the right format and hwdownload does not support all formats on the output - it may be necessary to insert an additional format filter immediately following in the graph to get the output in a supported format. +

+ +

33.1 avgblur_opencl

+ +

Apply average blur filter. +

+

The filter accepts the following options: +

+
+
sizeX
+

Set horizontal radius size. +Range is [1, 1024] and default value is 1. +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
sizeY
+

Set vertical radius size. Range is [1, 1024] and default value is 0. If zero, sizeX value will be used. +

+
+ + +

33.1.1 Example

+ +
    +
  • Apply average blur filter with horizontal and vertical size of 3, setting each pixel of the output to the average value of the 7x7 region centered on it in the input. For pixels on the edges of the image, the region does not extend beyond the image boundaries, and so out-of-range coordinates are not used in the calculations. +
    +
    -i INPUT -vf "hwupload, avgblur_opencl=3, hwdownload" OUTPUT
+
    +
+ + +

33.2 boxblur_opencl

+ +

Apply a boxblur algorithm to the input video. +

+

It accepts the following parameters: +

+
+
luma_radius, lr
+
luma_power, lp
+
chroma_radius, cr
+
chroma_power, cp
+
alpha_radius, ar
+
alpha_power, ap
+
+ +

A description of the accepted options follows. +

+
+
luma_radius, lr
+
chroma_radius, cr
+
alpha_radius, ar
+

Set an expression for the box radius in pixels used for blurring the +corresponding input plane. +

+

The radius value must be a non-negative number, and must not be +greater than the value of the expression min(w,h)/2 for the +luma and alpha planes, and of min(cw,ch)/2 for the chroma +planes. +

+

Default value for luma_radius is "2". If not specified, +chroma_radius and alpha_radius default to the +corresponding value set for luma_radius. +

+

The expressions can contain the following constants: +

+
w
+
h
+

The input width and height in pixels. +

+
+
cw
+
ch
+

The input chroma image width and height in pixels. +

+
+
hsub
+
vsub
+

The horizontal and vertical chroma subsample values. For example, for the +pixel format "yuv422p", hsub is 2 and vsub is 1. +

+
+ +
+
luma_power, lp
+
chroma_power, cp
+
alpha_power, ap
+

Specify how many times the boxblur filter is applied to the +corresponding plane. +

+

Default value for luma_power is 2. If not specified, +chroma_power and alpha_power default to the +corresponding value set for luma_power. +

+

A value of 0 will disable the effect. +

+
+ + +

33.2.1 Examples

+ +

Apply boxblur filter, setting each pixel of the output to the average value of box-radiuses luma_radius, chroma_radius, alpha_radius for each plane respectively. The filter will apply luma_power, chroma_power, alpha_power times onto the corresponding plane. For pixels on the edges of the image, the radius does not extend beyond the image boundaries, and so out-of-range coordinates are not used in the calculations. +

+
    +
  • Apply a boxblur filter with the luma, chroma, and alpha radius +set to 2 and luma, chroma, and alpha power set to 3. The filter will run 3 times with box-radius set to 2 for every plane of the image. +
    +
    -i INPUT -vf "hwupload, boxblur_opencl=luma_radius=2:luma_power=3, hwdownload" OUTPUT
+-i INPUT -vf "hwupload, boxblur_opencl=2:3, hwdownload" OUTPUT
+
    + +
  • Apply a boxblur filter with luma radius set to 2, luma_power to 1, chroma_radius to 4, chroma_power to 5, alpha_radius to 3 and alpha_power to 7. + +

    For the luma plane, a 2x2 box radius will be run once. +

    +

    For the chroma plane, a 4x4 box radius will be run 5 times. +

    +

    For the alpha plane, a 3x3 box radius will be run 7 times. +

    +
    -i INPUT -vf "hwupload, boxblur_opencl=2:1:4:5:3:7, hwdownload" OUTPUT
+
    +
+ + +

33.3 colorkey_opencl

+

RGB colorspace color keying. +

+

The filter accepts the following options: +

+
+
color
+

The color which will be replaced with transparency. +

+
+
similarity
+

Similarity percentage with the key color. +

+

0.01 matches only the exact key color, while 1.0 matches everything. +

+
+
blend
+

Blend percentage. +

+

0.0 makes pixels either fully transparent, or not transparent at all. +

+

Higher values result in semi-transparent pixels, with a higher transparency +the more similar the pixels color is to the key color. +

+
+ + +

33.3.1 Examples

+ +
    +
  • Make every semi-green pixel in the input transparent with some slight blending: +
    +
    -i INPUT -vf "hwupload, colorkey_opencl=green:0.3:0.1, hwdownload" OUTPUT
+
    +
+ + +

33.4 convolution_opencl

+ +

Apply convolution of 3x3, 5x5, 7x7 matrix. +

+

The filter accepts the following options: +

+
+
0m
+
1m
+
2m
+
3m
+

Set matrix for each plane. +Matrix is sequence of 9, 25 or 49 signed numbers. +Default value for each plane is 0 0 0 0 1 0 0 0 0. +

+
+
0rdiv
+
1rdiv
+
2rdiv
+
3rdiv
+

Set multiplier for calculated value for each plane. +If unset or 0, it will be sum of all matrix elements. +The option value must be a float number greater or equal to 0.0. Default value is 1.0. +

+
+
0bias
+
1bias
+
2bias
+
3bias
+

Set bias for each plane. This value is added to the result of the multiplication. +Useful for making the overall image brighter or darker. +The option value must be a float number greater or equal to 0.0. Default value is 0.0. +

+
+
+ + +

33.4.1 Examples

+ +
    +
  • Apply sharpen: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0:0 -1 0 -1 5 -1 0 -1 0, hwdownload" OUTPUT
+
    + +
  • Apply blur: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1 1 1 1 1 1 1 1 1:1/9:1/9:1/9:1/9, hwdownload" OUTPUT
+
    + +
  • Apply edge enhance: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:0 0 0 -1 1 0 0 0 0:5:1:1:1:0:128:128:128, hwdownload" OUTPUT
+
    + +
  • Apply edge detect: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:0 1 0 1 -4 1 0 1 0:5:5:5:1:0:128:128:128, hwdownload" OUTPUT
+
    + +
  • Apply laplacian edge detector which includes diagonals: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:1 1 1 1 -8 1 1 1 1:5:5:5:1:0:128:128:0, hwdownload" OUTPUT
+
    + +
  • Apply emboss: +
    +
    -i INPUT -vf "hwupload, convolution_opencl=-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2:-2 -1 0 -1 1 1 0 1 2, hwdownload" OUTPUT
+
    +
+ + +

33.5 erosion_opencl

+ +

Apply erosion effect to the video. +

+

This filter replaces the pixel by the local(3x3) minimum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane. Range is [0, 65535] and default value is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. +Range is [0, 255] and default value is 255, i.e. all eight pixels are used. +

+

Flags to local 3x3 coordinates region centered on x: +

+

1 2 3 +

+

4 x 5 +

+

6 7 8 +

+
+ + +

33.5.1 Example

+ +
    +
  • Apply erosion filter with threshold0 set to 30, threshold1 set 40, threshold2 set to 50 and coordinates set to 231, setting each pixel of the output to the local minimum between pixels: 1, 2, 3, 6, 7, 8 of the 3x3 region centered on it in the input. If the difference between input pixel and local minimum is more then threshold of the corresponding plane, output pixel will be set to input pixel - threshold of corresponding plane. +
    +
    -i INPUT -vf "hwupload, erosion_opencl=30:40:50:coordinates=231, hwdownload" OUTPUT
+
    +
+ + +

33.6 deshake_opencl

+

Feature-point based video stabilization filter. +

+

The filter accepts the following options: +

+
+
tripod
+

Simulates a tripod by preventing any camera movement whatsoever from the original frame. Defaults to 0. +

+
+
debug
+

Whether or not additional debug info should be displayed, both in the processed output and in the console. +

+

Note that in order to see console debug output you will also need to pass -v verbose to ffmpeg. +

+

Viewing point matches in the output video is only supported for RGB input. +

+

Defaults to 0. +

+
+
adaptive_crop
+

Whether or not to do a tiny bit of cropping at the borders to cut down on the amount of mirrored pixels. +

+

Defaults to 1. +

+
+
refine_features
+

Whether or not feature points should be refined at a sub-pixel level. +

+

This can be turned off for a slight performance gain at the cost of precision. +

+

Defaults to 1. +

+
+
smooth_strength
+

The strength of the smoothing applied to the camera path from 0.0 to 1.0. +

+

1.0 is the maximum smoothing strength while values less than that result in less smoothing. +

+

0.0 causes the filter to adaptively choose a smoothing strength on a per-frame basis. +

+

Defaults to 0.0. +

+
+
smooth_window_multiplier
+

Controls the size of the smoothing window (the number of frames buffered to determine motion information from). +

+

The size of the smoothing window is determined by multiplying the framerate of the video by this number. +

+

Acceptable values range from 0.1 to 10.0. +

+

Larger values increase the amount of motion data available for determining how to smooth the camera path, +potentially improving smoothness, but also increase latency and memory usage. +

+

Defaults to 2.0. +

+
+
+ + +

33.6.1 Examples

+ +
    +
  • Stabilize a video with a fixed, medium smoothing strength: +
    +
    -i INPUT -vf "hwupload, deshake_opencl=smooth_strength=0.5, hwdownload" OUTPUT
+
    + +
  • Stabilize a video with debugging (both in console and in rendered video): +
    +
    -i INPUT -filter_complex "[0:v]format=rgba, hwupload, deshake_opencl=debug=1, hwdownload, format=rgba, format=yuv420p" -v verbose OUTPUT
+
    +
+ + +

33.7 dilation_opencl

+ +

Apply dilation effect to the video. +

+

This filter replaces the pixel by the local(3x3) maximum. +

+

It accepts the following options: +

+
+
threshold0
+
threshold1
+
threshold2
+
threshold3
+

Limit the maximum change for each plane. Range is [0, 65535] and default value is 65535. +If 0, plane will remain unchanged. +

+
+
coordinates
+

Flag which specifies the pixel to refer to. +Range is [0, 255] and default value is 255, i.e. all eight pixels are used. +

+

Flags to local 3x3 coordinates region centered on x: +

+

1 2 3 +

+

4 x 5 +

+

6 7 8 +

+
+ + +

33.7.1 Example

+ +
    +
  • Apply dilation filter with threshold0 set to 30, threshold1 set 40, threshold2 set to 50 and coordinates set to 231, setting each pixel of the output to the local maximum between pixels: 1, 2, 3, 6, 7, 8 of the 3x3 region centered on it in the input. If the difference between input pixel and local maximum is more then threshold of the corresponding plane, output pixel will be set to input pixel + threshold of corresponding plane. +
    +
    -i INPUT -vf "hwupload, dilation_opencl=30:40:50:coordinates=231, hwdownload" OUTPUT
+
    +
+ + +

33.8 nlmeans_opencl

+ +

Non-local Means denoise filter through OpenCL, this filter accepts same options as nlmeans. +

+ +

33.9 overlay_opencl

+ +

Overlay one video on top of another. +

+

It takes two inputs and has one output. The first input is the "main" video on which the second input is overlaid. +This filter requires same memory layout for all the inputs. So, format conversion may be needed. +

+

The filter accepts the following options: +

+
+
x
+

Set the x coordinate of the overlaid video on the main video. +Default value is 0. +

+
+
y
+

Set the y coordinate of the overlaid video on the main video. +Default value is 0. +

+
+
+ + +

33.9.1 Examples

+ +
    +
  • Overlay an image LOGO at the top-left corner of the INPUT video. Both inputs are yuv420p format. +
    +
    -i INPUT -i LOGO -filter_complex "[0:v]hwupload[a], [1:v]format=yuv420p, hwupload[b], [a][b]overlay_opencl, hwdownload" OUTPUT
+
    +
  • The inputs have same memory layout for color channels , the overlay has additional alpha plane, like INPUT is yuv420p, and the LOGO is yuva420p. +
    +
    -i INPUT -i LOGO -filter_complex "[0:v]hwupload[a], [1:v]format=yuva420p, hwupload[b], [a][b]overlay_opencl, hwdownload" OUTPUT
+
    + +
+ + +

33.10 pad_opencl

+ +

Add paddings to the input image, and place the original input at the +provided x, y coordinates. +

+

It accepts the following options: +

+
+
width, w
+
height, h
+

Specify an expression for the size of the output image with the +paddings added. If the value for width or height is 0, the +corresponding input size is used for the output. +

+

The width expression can reference the value set by the +height expression, and vice versa. +

+

The default value of width and height is 0. +

+
+
x
+
y
+

Specify the offsets to place the input image at within the padded area, +with respect to the top/left border of the output image. +

+

The x expression can reference the value set by the y +expression, and vice versa. +

+

The default value of x and y is 0. +

+

If x or y evaluate to a negative number, they’ll be changed +so the input image is centered on the padded area. +

+
+
color
+

Specify the color of the padded area. For the syntax of this option, +check the (ffmpeg-utils)"Color" section in the ffmpeg-utils +manual. +

+
+
aspect
+

Pad to an aspect instead to a resolution. +

+
+ +

The value for the width, height, x, and y +options are expressions containing the following constants: +

+
+
in_w
+
in_h
+

The input video width and height. +

+
+
iw
+
ih
+

These are the same as in_w and in_h. +

+
+
out_w
+
out_h
+

The output width and height (the size of the padded area), as +specified by the width and height expressions. +

+
+
ow
+
oh
+

These are the same as out_w and out_h. +

+
+
x
+
y
+

The x and y offsets as specified by the x and y +expressions, or NAN if not yet specified. +

+
+
a
+

same as iw / ih +

+
+
sar
+

input sample aspect ratio +

+
+
dar
+

input display aspect ratio, it is the same as (iw / ih) * sar +

+
+ + +

33.11 prewitt_opencl

+ +

Apply the Prewitt operator (https://en.wikipedia.org/wiki/Prewitt_operator) to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +Range is [0.0, 65535] and default value is 1.0. +

+
+
delta
+

Set value which will be added to filtered result. +Range is [-65535, 65535] and default value is 0.0. +

+
+ + +

33.11.1 Example

+ +
    +
  • Apply the Prewitt operator with scale set to 2 and delta set to 10. +
    +
    -i INPUT -vf "hwupload, prewitt_opencl=scale=2:delta=10, hwdownload" OUTPUT
+
    +
+ + +

33.12 program_opencl

+ +

Filter video using an OpenCL program. +

+
+
source
+

OpenCL program source file. +

+
+
kernel
+

Kernel name in program. +

+
+
inputs
+

Number of inputs to the filter. Defaults to 1. +

+
+
size, s
+

Size of output frames. Defaults to the same as the first input. +

+
+
+ +

The program_opencl filter also supports the framesync options. +

+

The program source file must contain a kernel function with the given name, +which will be run once for each plane of the output. Each run on a plane +gets enqueued as a separate 2D global NDRange with one work-item for each +pixel to be generated. The global ID offset for each work-item is therefore +the coordinates of a pixel in the destination image. +

+

The kernel function needs to take the following arguments: +

    +
  • Destination image, __write_only image2d_t. + +

    This image will become the output; the kernel should write all of it. +

  • Frame index, unsigned int. + +

    This is a counter starting from zero and increasing by one for each frame. +

  • Source images, __read_only image2d_t. + +

    These are the most recent images on each input. The kernel may read from +them to generate the output, but they can’t be written to. +

+ +

Example programs: +

+
    +
  • Copy the input to the output (output must be the same size as the input). +
    __kernel void copy(__write_only image2d_t destination,
+                   unsigned int index,
+                   __read_only  image2d_t source)
+{
+    const sampler_t sampler = CLK_NORMALIZED_COORDS_FALSE;
+
+    int2 location = (int2)(get_global_id(0), get_global_id(1));
+
+    float4 value = read_imagef(source, sampler, location);
+
+    write_imagef(destination, location, value);
+}
+
    +
  • Apply a simple transformation, rotating the input by an amount increasing +with the index counter. Pixel values are linearly interpolated by the +sampler, and the output need not have the same dimensions as the input. +
    __kernel void rotate_image(__write_only image2d_t dst,
+                           unsigned int index,
+                           __read_only  image2d_t src)
+{
+    const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE |
+                               CLK_FILTER_LINEAR);
+
+    float angle = (float)index / 100.0f;
+
+    float2 dst_dim = convert_float2(get_image_dim(dst));
+    float2 src_dim = convert_float2(get_image_dim(src));
+
+    float2 dst_cen = dst_dim / 2.0f;
+    float2 src_cen = src_dim / 2.0f;
+
+    int2   dst_loc = (int2)(get_global_id(0), get_global_id(1));
+
+    float2 dst_pos = convert_float2(dst_loc) - dst_cen;
+    float2 src_pos = {
+        cos(angle) * dst_pos.x - sin(angle) * dst_pos.y,
+        sin(angle) * dst_pos.x + cos(angle) * dst_pos.y
+    };
+    src_pos = src_pos * src_dim / dst_dim;
+
+    float2 src_loc = src_pos + src_cen;
+
+    if (src_loc.x < 0.0f      || src_loc.y < 0.0f ||
+        src_loc.x > src_dim.x || src_loc.y > src_dim.y)
+        write_imagef(dst, dst_loc, 0.5f);
+    else
+        write_imagef(dst, dst_loc, read_imagef(src, sampler, src_loc));
+}
+
    +
  • Blend two inputs together, with the amount of each input used varying +with the index counter. +
    __kernel void blend_images(__write_only image2d_t dst,
+                           unsigned int index,
+                           __read_only  image2d_t src1,
+                           __read_only  image2d_t src2)
+{
+    const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE |
+                               CLK_FILTER_LINEAR);
+
+    float blend = (cos((float)index / 50.0f) + 1.0f) / 2.0f;
+
+    int2  dst_loc = (int2)(get_global_id(0), get_global_id(1));
+    int2 src1_loc = dst_loc * get_image_dim(src1) / get_image_dim(dst);
+    int2 src2_loc = dst_loc * get_image_dim(src2) / get_image_dim(dst);
+
+    float4 val1 = read_imagef(src1, sampler, src1_loc);
+    float4 val2 = read_imagef(src2, sampler, src2_loc);
+
+    write_imagef(dst, dst_loc, val1 * blend + val2 * (1.0f - blend));
+}
+
    +
+ + +

33.13 roberts_opencl

+

Apply the Roberts cross operator (https://en.wikipedia.org/wiki/Roberts_cross) to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +Range is [0.0, 65535] and default value is 1.0. +

+
+
delta
+

Set value which will be added to filtered result. +Range is [-65535, 65535] and default value is 0.0. +

+
+ + +

33.13.1 Example

+ +
    +
  • Apply the Roberts cross operator with scale set to 2 and delta set to 10 +
    +
    -i INPUT -vf "hwupload, roberts_opencl=scale=2:delta=10, hwdownload" OUTPUT
+
    +
+ + +

33.14 sobel_opencl

+ +

Apply the Sobel operator (https://en.wikipedia.org/wiki/Sobel_operator) to input video stream. +

+

The filter accepts the following option: +

+
+
planes
+

Set which planes to filter. Default value is 0xf, by which all planes are processed. +

+
+
scale
+

Set value which will be multiplied with filtered result. +Range is [0.0, 65535] and default value is 1.0. +

+
+
delta
+

Set value which will be added to filtered result. +Range is [-65535, 65535] and default value is 0.0. +

+
+ + +

33.14.1 Example

+ +
    +
  • Apply sobel operator with scale set to 2 and delta set to 10 +
    +
    -i INPUT -vf "hwupload, sobel_opencl=scale=2:delta=10, hwdownload" OUTPUT
+
    +
+ + +

33.15 tonemap_opencl

+ +

Perform HDR(PQ/HLG) to SDR conversion with tone-mapping. +

+

It accepts the following parameters: +

+
+
tonemap
+

Specify the tone-mapping operator to be used. Same as tonemap option in tonemap. +

+
+
param
+

Tune the tone mapping algorithm. same as param option in tonemap. +

+
+
desat
+

Apply desaturation for highlights that exceed this level of brightness. The +higher the parameter, the more color information will be preserved. This +setting helps prevent unnaturally blown-out colors for super-highlights, by +(smoothly) turning into white instead. This makes images feel more natural, +at the cost of reducing information about out-of-range colors. +

+

The default value is 0.5, and the algorithm here is a little different from +the cpu version tonemap currently. A setting of 0.0 disables this option. +

+
+
threshold
+

The tonemapping algorithm parameters is fine-tuned per each scene. And a threshold +is used to detect whether the scene has changed or not. If the distance between +the current frame average brightness and the current running average exceeds +a threshold value, we would re-calculate scene average and peak brightness. +The default value is 0.2. +

+
+
format
+

Specify the output pixel format. +

+

Currently supported formats are: +

+
p010
+
nv12
+
+ +
+
range, r
+

Set the output color range. +

+

Possible values are: +

+
tv/mpeg
+
pc/jpeg
+
+ +

Default is same as input. +

+
+
primaries, p
+

Set the output color primaries. +

+

Possible values are: +

+
bt709
+
bt2020
+
+ +

Default is same as input. +

+
+
transfer, t
+

Set the output transfer characteristics. +

+

Possible values are: +

+
bt709
+
bt2020
+
+ +

Default is bt709. +

+
+
matrix, m
+

Set the output colorspace matrix. +

+

Possible value are: +

+
bt709
+
bt2020
+
+ +

Default is same as input. +

+
+
+ + +

33.15.1 Example

+ +
    +
  • Convert HDR(PQ/HLG) video to bt2020-transfer-characteristic p010 format using linear operator. +
    +
    -i INPUT -vf "format=p010,hwupload,tonemap_opencl=t=bt2020:tonemap=linear:format=p010,hwdownload,format=p010" OUTPUT
+
    +
+ + +

33.16 unsharp_opencl

+ +

Sharpen or blur the input video. +

+

It accepts the following parameters: +

+
+
luma_msize_x, lx
+

Set the luma matrix horizontal size. +Range is [1, 23] and default value is 5. +

+
+
luma_msize_y, ly
+

Set the luma matrix vertical size. +Range is [1, 23] and default value is 5. +

+
+
luma_amount, la
+

Set the luma effect strength. +Range is [-10, 10] and default value is 1.0. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+
+
chroma_msize_x, cx
+

Set the chroma matrix horizontal size. +Range is [1, 23] and default value is 5. +

+
+
chroma_msize_y, cy
+

Set the chroma matrix vertical size. +Range is [1, 23] and default value is 5. +

+
+
chroma_amount, ca
+

Set the chroma effect strength. +Range is [-10, 10] and default value is 0.0. +

+

Negative values will blur the input video, while positive values will +sharpen it, a value of zero will disable the effect. +

+
+
+ +

All parameters are optional and default to the equivalent of the +string ’5:5:1.0:5:5:0.0’. +

+ +

33.16.1 Examples

+ +
    +
  • Apply strong luma sharpen effect: +
    +
    -i INPUT -vf "hwupload, unsharp_opencl=luma_msize_x=7:luma_msize_y=7:luma_amount=2.5, hwdownload" OUTPUT
+
    + +
  • Apply a strong blur of both luma and chroma parameters: +
    +
    -i INPUT -vf "hwupload, unsharp_opencl=7:7:-2:7:7:-2, hwdownload" OUTPUT
+
    +
+ + +

33.17 xfade_opencl

+ +

Cross fade two videos with custom transition effect by using OpenCL. +

+

It accepts the following options: +

+
+
transition
+

Set one of possible transition effects. +

+
+
custom
+

Select custom transition effect, the actual transition description +will be picked from source and kernel options. +

+
+
fade
+
wipeleft
+
wiperight
+
wipeup
+
wipedown
+
slideleft
+
slideright
+
slideup
+
slidedown
+
+

Default transition is fade. +

+
+ +
+
source
+

OpenCL program source file for custom transition. +

+
+
kernel
+

Set name of kernel to use for custom transition from program source file. +

+
+
duration
+

Set duration of video transition. +

+
+
offset
+

Set time of start of transition relative to first video. +

+
+ +

The program source file must contain a kernel function with the given name, +which will be run once for each plane of the output. Each run on a plane +gets enqueued as a separate 2D global NDRange with one work-item for each +pixel to be generated. The global ID offset for each work-item is therefore +the coordinates of a pixel in the destination image. +

+

The kernel function needs to take the following arguments: +

    +
  • Destination image, __write_only image2d_t. + +

    This image will become the output; the kernel should write all of it. +

    +
  • First Source image, __read_only image2d_t. +Second Source image, __read_only image2d_t. + +

    These are the most recent images on each input. The kernel may read from +them to generate the output, but they can’t be written to. +

    +
  • Transition progress, float. This value is always between 0 and 1 inclusive. +
+ +

Example programs: +

+
    +
  • Apply dots curtain transition effect: +
    __kernel void blend_images(__write_only image2d_t dst,
+                           __read_only  image2d_t src1,
+                           __read_only  image2d_t src2,
+                           float progress)
+{
+    const sampler_t sampler = (CLK_NORMALIZED_COORDS_FALSE |
+                               CLK_FILTER_LINEAR);
+    int2  p = (int2)(get_global_id(0), get_global_id(1));
+    float2 rp = (float2)(get_global_id(0), get_global_id(1));
+    float2 dim = (float2)(get_image_dim(src1).x, get_image_dim(src1).y);
+    rp = rp / dim;
+
+    float2 dots = (float2)(20.0, 20.0);
+    float2 center = (float2)(0,0);
+    float2 unused;
+
+    float4 val1 = read_imagef(src1, sampler, p);
+    float4 val2 = read_imagef(src2, sampler, p);
+    bool next = distance(fract(rp * dots, &unused), (float2)(0.5, 0.5)) < (progress / distance(rp, center));
+
+    write_imagef(dst, p, next ? val1 : val2);
+}
+
    +
+ + + +

34 VAAPI Video Filters

+ +

VAAPI Video filters are usually used with VAAPI decoder and VAAPI encoder. Below is a description of VAAPI video filters. +

+

To enable compilation of these filters you need to configure FFmpeg with +--enable-vaapi. +

+

To use vaapi filters, you need to setup the vaapi device correctly. For more information, please read https://trac.ffmpeg.org/wiki/Hardware/VAAPI +

+ +

34.1 tonemap_vaapi

+ +

Perform HDR(High Dynamic Range) to SDR(Standard Dynamic Range) conversion with tone-mapping. +It maps the dynamic range of HDR10 content to the SDR content. +It currently only accepts HDR10 as input. +

+

It accepts the following parameters: +

+
+
format
+

Specify the output pixel format. +

+

Currently supported formats are: +

+
p010
+
nv12
+
+ +

Default is nv12. +

+
+
primaries, p
+

Set the output color primaries. +

+

Default is same as input. +

+
+
transfer, t
+

Set the output transfer characteristics. +

+

Default is bt709. +

+
+
matrix, m
+

Set the output colorspace matrix. +

+

Default is same as input. +

+
+
+ + +

34.1.1 Example

+ +
    +
  • Convert HDR(HDR10) video to bt2020-transfer-characteristic p010 format +
    +
    tonemap_vaapi=format=p010:t=bt2020-10
+
    +
+ + + +

35 Video Sources

+ +

Below is a description of the currently available video sources. +

+ +

35.1 buffer

+ +

Buffer video frames, and make them available to the filter chain. +

+

This source is mainly intended for a programmatic use, in particular +through the interface defined in libavfilter/vsrc_buffer.h. +

+

It accepts the following parameters: +

+
+
video_size
+

Specify the size (width and height) of the buffered video frames. For the +syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
width
+

The input video width. +

+
+
height
+

The input video height. +

+
+
pix_fmt
+

A string representing the pixel format of the buffered video frames. +It may be a number corresponding to a pixel format, or a pixel format +name. +

+
+
time_base
+

Specify the timebase assumed by the timestamps of the buffered frames. +

+
+
frame_rate
+

Specify the frame rate expected for the video stream. +

+
+
pixel_aspect, sar
+

The sample (pixel) aspect ratio of the input video. +

+
+
sws_param
+

This option is deprecated and ignored. Prepend sws_flags=flags; +to the filtergraph description to specify swscale flags for automatically +inserted scalers. See Filtergraph syntax. +

+
+
hw_frames_ctx
+

When using a hardware pixel format, this should be a reference to an +AVHWFramesContext describing input frames. +

+
+ +

For example: +

+
buffer=width=320:height=240:pix_fmt=yuv410p:time_base=1/24:sar=1
+
+ +

will instruct the source to accept video frames with size 320x240 and +with format "yuv410p", assuming 1/24 as the timestamps timebase and +square pixels (1:1 sample aspect ratio). +Since the pixel format with name "yuv410p" corresponds to the number 6 +(check the enum AVPixelFormat definition in libavutil/pixfmt.h), +this example corresponds to: +

+
buffer=size=320x240:pixfmt=6:time_base=1/24:pixel_aspect=1/1
+
+ +

Alternatively, the options can be specified as a flat string, but this +syntax is deprecated: +

+

width:height:pix_fmt:time_base.num:time_base.den:pixel_aspect.num:pixel_aspect.den +

+ +

35.2 cellauto

+ +

Create a pattern generated by an elementary cellular automaton. +

+

The initial state of the cellular automaton can be defined through the +filename and pattern options. If such options are +not specified an initial state is created randomly. +

+

At each new frame a new row in the video is filled with the result of +the cellular automaton next generation. The behavior when the whole +frame is filled is defined by the scroll option. +

+

This source accepts the following options: +

+
+
filename, f
+

Read the initial cellular automaton state, i.e. the starting row, from +the specified file. +In the file, each non-whitespace character is considered an alive +cell, a newline will terminate the row, and further characters in the +file will be ignored. +

+
+
pattern, p
+

Read the initial cellular automaton state, i.e. the starting row, from +the specified string. +

+

Each non-whitespace character in the string is considered an alive +cell, a newline will terminate the row, and further characters in the +string will be ignored. +

+
+
rate, r
+

Set the video rate, that is the number of frames generated per second. +Default is 25. +

+
+
random_fill_ratio, ratio
+

Set the random fill ratio for the initial cellular automaton row. It +is a floating point number value ranging from 0 to 1, defaults to +1/PHI. +

+

This option is ignored when a file or a pattern is specified. +

+
+
random_seed, seed
+

Set the seed for filling randomly the initial row, must be an integer +included between 0 and UINT32_MAX. If not specified, or if explicitly +set to -1, the filter will try to use a good random seed on a best +effort basis. +

+
+
rule
+

Set the cellular automaton rule, it is a number ranging from 0 to 255. +Default value is 110. +

+
+
size, s
+

Set the size of the output video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+

If filename or pattern is specified, the size is set +by default to the width of the specified initial state row, and the +height is set to width * PHI. +

+

If size is set, it must contain the width of the specified +pattern string, and the specified pattern will be centered in the +larger row. +

+

If a filename or a pattern string is not specified, the size value +defaults to "320x518" (used for a randomly generated initial state). +

+
+
scroll
+

If set to 1, scroll the output upward when all the rows in the output +have been already filled. If set to 0, the new generated row will be +written over the top row just after the bottom row is filled. +Defaults to 1. +

+
+
start_full, full
+

If set to 1, completely fill the output with generated rows before +outputting the first frame. +This is the default behavior, for disabling set the value to 0. +

+
+
stitch
+

If set to 1, stitch the left and right row edges together. +This is the default behavior, for disabling set the value to 0. +

+
+ + +

35.2.1 Examples

+ +
    +
  • Read the initial state from pattern, and specify an output of +size 200x400. +
    +
    cellauto=f=pattern:s=200x400
+
    + +
  • Generate a random initial row with a width of 200 cells, with a fill +ratio of 2/3: +
    +
    cellauto=ratio=2/3:s=200x200
+
    + +
  • Create a pattern generated by rule 18 starting by a single alive cell +centered on an initial row with width 100: +
    +
    cellauto=p=@:s=100x400:full=0:rule=18
+
    + +
  • Specify a more elaborated initial pattern: +
    +
    cellauto=p='@@ @ @@':s=100x400:full=0:rule=18
+
    + +
+ + +

35.3 coreimagesrc

+

Video source generated on GPU using Apple’s CoreImage API on OSX. +

+

This video source is a specialized version of the coreimage video filter. +Use a core image generator at the beginning of the applied filterchain to +generate the content. +

+

The coreimagesrc video source accepts the following options: +

+
list_generators
+

List all available generators along with all their respective options as well as +possible minimum and maximum values along with the default values. +

+
list_generators=true
+
+ +
+
size, s
+

Specify the size of the sourced video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +The default value is 320x240. +

+
+
rate, r
+

Specify the frame rate of the sourced video, as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a floating point +number or a valid video frame rate abbreviation. The default value is +"25". +

+
+
sar
+

Set the sample aspect ratio of the sourced video. +

+
+
duration, d
+

Set the duration of the sourced video. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

If not specified, or the expressed duration is negative, the video is +supposed to be generated forever. +

+
+ +

Additionally, all options of the coreimage video filter are accepted. +A complete filterchain can be used for further processing of the +generated input without CPU-HOST transfer. See coreimage documentation +and examples for details. +

+ +

35.3.1 Examples

+ +
    +
  • Use CIQRCodeGenerator to create a QR code for the FFmpeg homepage, +given as complete and escaped command-line for Apple’s standard bash shell: +
    +
    ffmpeg -f lavfi -i coreimagesrc=s=100x100:filter=CIQRCodeGenerator@inputMessage=https\\\\\://FFmpeg.org/@inputCorrectionLevel=H -frames:v 1 QRCode.png
+
    +

    This example is equivalent to the QRCode example of coreimage without the +need for a nullsrc video source. +

+ + + +

35.4 gradients

+

Generate several gradients. +

+
+
size, s
+

Set frame size. For the syntax of this option, check the (ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual. Default value is "640x480". +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
c0, c1, c2, c3, c4, c5, c6, c7
+

Set 8 colors. Default values for colors is to pick random one. +

+
+
x0, y0, y0, y1
+

Set gradient line source and destination points. If negative or out of range, random ones +are picked. +

+
+
nb_colors, n
+

Set number of colors to use at once. Allowed range is from 2 to 8. Default value is 2. +

+
+
seed
+

Set seed for picking gradient line points. +

+
+ + + +

35.5 mandelbrot

+ +

Generate a Mandelbrot set fractal, and progressively zoom towards the +point specified with start_x and start_y. +

+

This source accepts the following options: +

+
+
end_pts
+

Set the terminal pts value. Default value is 400. +

+
+
end_scale
+

Set the terminal scale value. +Must be a floating point value. Default value is 0.3. +

+
+
inner
+

Set the inner coloring mode, that is the algorithm used to draw the +Mandelbrot fractal internal region. +

+

It shall assume one of the following values: +

+
black
+

Set black mode. +

+
convergence
+

Show time until convergence. +

+
mincol
+

Set color based on point closest to the origin of the iterations. +

+
period
+

Set period mode. +

+
+ +

Default value is mincol. +

+
+
bailout
+

Set the bailout value. Default value is 10.0. +

+
+
maxiter
+

Set the maximum of iterations performed by the rendering +algorithm. Default value is 7189. +

+
+
outer
+

Set outer coloring mode. +It shall assume one of following values: +

+
iteration_count
+

Set iteration count mode. +

+
normalized_iteration_count
+

set normalized iteration count mode. +

+
+

Default value is normalized_iteration_count. +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
size, s
+

Set frame size. For the syntax of this option, check the (ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual. Default value is "640x480". +

+
+
start_scale
+

Set the initial scale value. Default value is 3.0. +

+
+
start_x
+

Set the initial x position. Must be a floating point value between +-100 and 100. Default value is -0.743643887037158704752191506114774. +

+
+
start_y
+

Set the initial y position. Must be a floating point value between +-100 and 100. Default value is -0.131825904205311970493132056385139. +

+
+ + +

35.6 mptestsrc

+ +

Generate various test patterns, as generated by the MPlayer test filter. +

+

The size of the generated video is fixed, and is 256x256. +This source is useful in particular for testing encoding features. +

+

This source accepts the following options: +

+
+
rate, r
+

Specify the frame rate of the sourced video, as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a floating point +number or a valid video frame rate abbreviation. The default value is +"25". +

+
+
duration, d
+

Set the duration of the sourced video. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

If not specified, or the expressed duration is negative, the video is +supposed to be generated forever. +

+
+
test, t
+
+

Set the number or the name of the test to perform. Supported tests are: +

+
dc_luma
+
dc_chroma
+
freq_luma
+
freq_chroma
+
amp_luma
+
amp_chroma
+
cbp
+
mv
+
ring1
+
ring2
+
all
+
max_frames, m
+

Set the maximum number of frames generated for each test, default value is 30. +

+
+
+ +

Default value is "all", which will cycle through the list of all tests. +

+
+ +

Some examples: +

+
mptestsrc=t=dc_luma
+
+ +

will generate a "dc_luma" test pattern. +

+ +

35.7 frei0r_src

+ +

Provide a frei0r source. +

+

To enable compilation of this filter you need to install the frei0r +header and configure FFmpeg with --enable-frei0r. +

+

This source accepts the following parameters: +

+
+
size
+

The size of the video to generate. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+
+
framerate
+

The framerate of the generated video. It may be a string of the form +num/den or a frame rate abbreviation. +

+
+
filter_name
+

The name to the frei0r source to load. For more information regarding frei0r and +how to set the parameters, read the frei0r section in the video filters +documentation. +

+
+
filter_params
+

A ’|’-separated list of parameters to pass to the frei0r source. +

+
+
+ +

For example, to generate a frei0r partik0l source with size 200x200 +and frame rate 10 which is overlaid on the overlay filter main input: +

+
frei0r_src=size=200x200:framerate=10:filter_name=partik0l:filter_params=1234 [overlay]; [in][overlay] overlay
+
+ + +

35.8 life

+ +

Generate a life pattern. +

+

This source is based on a generalization of John Conway’s life game. +

+

The sourced input represents a life grid, each pixel represents a cell +which can be in one of two possible states, alive or dead. Every cell +interacts with its eight neighbours, which are the cells that are +horizontally, vertically, or diagonally adjacent. +

+

At each interaction the grid evolves according to the adopted rule, +which specifies the number of neighbor alive cells which will make a +cell stay alive or born. The rule option allows one to specify +the rule to adopt. +

+

This source accepts the following options: +

+
+
filename, f
+

Set the file from which to read the initial grid state. In the file, +each non-whitespace character is considered an alive cell, and newline +is used to delimit the end of each row. +

+

If this option is not specified, the initial grid is generated +randomly. +

+
+
rate, r
+

Set the video rate, that is the number of frames generated per second. +Default is 25. +

+
+
random_fill_ratio, ratio
+

Set the random fill ratio for the initial random grid. It is a +floating point number value ranging from 0 to 1, defaults to 1/PHI. +It is ignored when a file is specified. +

+
+
random_seed, seed
+

Set the seed for filling the initial random grid, must be an integer +included between 0 and UINT32_MAX. If not specified, or if explicitly +set to -1, the filter will try to use a good random seed on a best +effort basis. +

+
+
rule
+

Set the life rule. +

+

A rule can be specified with a code of the kind "SNS/BNB", +where NS and NB are sequences of numbers in the range 0-8, +NS specifies the number of alive neighbor cells which make a +live cell stay alive, and NB the number of alive neighbor cells +which make a dead cell to become alive (i.e. to "born"). +"s" and "b" can be used in place of "S" and "B", respectively. +

+

Alternatively a rule can be specified by an 18-bits integer. The 9 +high order bits are used to encode the next cell state if it is alive +for each number of neighbor alive cells, the low order bits specify +the rule for "borning" new cells. Higher order bits encode for an +higher number of neighbor cells. +For example the number 6153 = (12<<9)+9 specifies a stay alive +rule of 12 and a born rule of 9, which corresponds to "S23/B03". +

+

Default value is "S23/B3", which is the original Conway’s game of life +rule, and will keep a cell alive if it has 2 or 3 neighbor alive +cells, and will born a new cell if there are three alive cells around +a dead cell. +

+
+
size, s
+

Set the size of the output video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +

+

If filename is specified, the size is set by default to the +same size of the input file. If size is set, it must contain +the size specified in the input file, and the initial grid defined in +that file is centered in the larger resulting area. +

+

If a filename is not specified, the size value defaults to "320x240" +(used for a randomly generated initial grid). +

+
+
stitch
+

If set to 1, stitch the left and right grid edges together, and the +top and bottom edges also. Defaults to 1. +

+
+
mold
+

Set cell mold speed. If set, a dead cell will go from death_color to +mold_color with a step of mold. mold can have a +value from 0 to 255. +

+
+
life_color
+

Set the color of living (or new born) cells. +

+
+
death_color
+

Set the color of dead cells. If mold is set, this is the first color +used to represent a dead cell. +

+
+
mold_color
+

Set mold color, for definitely dead and moldy cells. +

+

For the syntax of these 3 color options, check the (ffmpeg-utils)"Color" section in the +ffmpeg-utils manual. +

+
+ + +

35.8.1 Examples

+ +
    +
  • Read a grid from pattern, and center it on a grid of size +300x300 pixels: +
    +
    life=f=pattern:s=300x300
+
    + +
  • Generate a random grid of size 200x200, with a fill ratio of 2/3: +
    +
    life=ratio=2/3:s=200x200
+
    + +
  • Specify a custom rule for evolving a randomly generated grid: +
    +
    life=rule=S14/B34
+
    + +
  • Full example with slow death effect (mold) using ffplay: +
    +
    ffplay -f lavfi life=s=300x200:mold=10:r=60:ratio=0.1:death_color=#C83232:life_color=#00ff00,scale=1200:800:flags=16
+
    +
+ + +

35.9 allrgb, allyuv, color, haldclutsrc, nullsrc, pal75bars, pal100bars, rgbtestsrc, smptebars, smptehdbars, testsrc, testsrc2, yuvtestsrc

+ +

The allrgb source returns frames of size 4096x4096 of all rgb colors. +

+

The allyuv source returns frames of size 4096x4096 of all yuv colors. +

+

The color source provides an uniformly colored input. +

+

The haldclutsrc source provides an identity Hald CLUT. See also +haldclut filter. +

+

The nullsrc source returns unprocessed video frames. It is +mainly useful to be employed in analysis / debugging tools, or as the +source for filters which ignore the input data. +

+

The pal75bars source generates a color bars pattern, based on +EBU PAL recommendations with 75% color levels. +

+

The pal100bars source generates a color bars pattern, based on +EBU PAL recommendations with 100% color levels. +

+

The rgbtestsrc source generates an RGB test pattern useful for +detecting RGB vs BGR issues. You should see a red, green and blue +stripe from top to bottom. +

+

The smptebars source generates a color bars pattern, based on +the SMPTE Engineering Guideline EG 1-1990. +

+

The smptehdbars source generates a color bars pattern, based on +the SMPTE RP 219-2002. +

+

The testsrc source generates a test video pattern, showing a +color pattern, a scrolling gradient and a timestamp. This is mainly +intended for testing purposes. +

+

The testsrc2 source is similar to testsrc, but supports more +pixel formats instead of just rgb24. This allows using it as an +input for other tests without requiring a format conversion. +

+

The yuvtestsrc source generates an YUV test pattern. You should +see a y, cb and cr stripe from top to bottom. +

+

The sources accept the following parameters: +

+
+
level
+

Specify the level of the Hald CLUT, only available in the haldclutsrc +source. A level of N generates a picture of N*N*N by N*N*N +pixels to be used as identity matrix for 3D lookup tables. Each component is +coded on a 1/(N*N) scale. +

+
+
color, c
+

Specify the color of the source, only available in the color +source. For the syntax of this option, check the +(ffmpeg-utils)"Color" section in the ffmpeg-utils manual. +

+
+
size, s
+

Specify the size of the sourced video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +The default value is 320x240. +

+

This option is not available with the allrgb, allyuv, and +haldclutsrc filters. +

+
+
rate, r
+

Specify the frame rate of the sourced video, as the number of frames +generated per second. It has to be a string in the format +frame_rate_num/frame_rate_den, an integer number, a floating point +number or a valid video frame rate abbreviation. The default value is +"25". +

+
+
duration, d
+

Set the duration of the sourced video. See +(ffmpeg-utils)the Time duration section in the ffmpeg-utils(1) manual +for the accepted syntax. +

+

If not specified, or the expressed duration is negative, the video is +supposed to be generated forever. +

+
+
sar
+

Set the sample aspect ratio of the sourced video. +

+
+
alpha
+

Specify the alpha (opacity) of the background, only available in the +testsrc2 source. The value must be between 0 (fully transparent) and +255 (fully opaque, the default). +

+
+
decimals, n
+

Set the number of decimals to show in the timestamp, only available in the +testsrc source. +

+

The displayed timestamp value will correspond to the original +timestamp value multiplied by the power of 10 of the specified +value. Default value is 0. +

+
+ + +

35.9.1 Examples

+ +
    +
  • Generate a video with a duration of 5.3 seconds, with size +176x144 and a frame rate of 10 frames per second: +
    +
    testsrc=duration=5.3:size=qcif:rate=10
+
    + +
  • The following graph description will generate a red source +with an opacity of 0.2, with size "qcif" and a frame rate of 10 +frames per second: +
    +
    color=c=red@0.2:s=qcif:r=10
+
    + +
  • If the input content is to be ignored, nullsrc can be used. The +following command generates noise in the luminance plane by employing +the geq filter: +
    +
    nullsrc=s=256x256, geq=random(1)*255:128:128
+
    +
+ + +

35.9.2 Commands

+ +

The color source supports the following commands: +

+
+
c, color
+

Set the color of the created image. Accepts the same syntax of the +corresponding color option. +

+
+ + +

35.10 openclsrc

+ +

Generate video using an OpenCL program. +

+
+
source
+

OpenCL program source file. +

+
+
kernel
+

Kernel name in program. +

+
+
size, s
+

Size of frames to generate. This must be set. +

+
+
format
+

Pixel format to use for the generated frames. This must be set. +

+
+
rate, r
+

Number of frames generated every second. Default value is ’25’. +

+
+
+ +

For details of how the program loading works, see the program_opencl +filter. +

+

Example programs: +

+
    +
  • Generate a colour ramp by setting pixel values from the position of the pixel +in the output image. (Note that this will work with all pixel formats, but +the generated output will not be the same.) +
    __kernel void ramp(__write_only image2d_t dst,
+                   unsigned int index)
+{
+    int2 loc = (int2)(get_global_id(0), get_global_id(1));
+
+    float4 val;
+    val.xy = val.zw = convert_float2(loc) / convert_float2(get_image_dim(dst));
+
+    write_imagef(dst, loc, val);
+}
+
    +
  • Generate a Sierpinski carpet pattern, panning by a single pixel each frame. +
    __kernel void sierpinski_carpet(__write_only image2d_t dst,
+                                unsigned int index)
+{
+    int2 loc = (int2)(get_global_id(0), get_global_id(1));
+
+    float4 value = 0.0f;
+    int x = loc.x + index;
+    int y = loc.y + index;
+    while (x > 0 || y > 0) {
+        if (x % 3 == 1 && y % 3 == 1) {
+            value = 1.0f;
+            break;
+        }
+        x /= 3;
+        y /= 3;
+    }
+
+    write_imagef(dst, loc, value);
+}
+
    +
+ + +

35.11 sierpinski

+ +

Generate a Sierpinski carpet/triangle fractal, and randomly pan around. +

+

This source accepts the following options: +

+
+
size, s
+

Set frame size. For the syntax of this option, check the (ffmpeg-utils)"Video +size" section in the ffmpeg-utils manual. Default value is "640x480". +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
seed
+

Set seed which is used for random panning. +

+
+
jump
+

Set max jump for single pan destination. Allowed range is from 1 to 10000. +

+
+
type
+

Set fractal type, can be default carpet or triangle. +

+
+ + + +

36 Video Sinks

+ +

Below is a description of the currently available video sinks. +

+ +

36.1 buffersink

+ +

Buffer video frames, and make them available to the end of the filter +graph. +

+

This sink is mainly intended for programmatic use, in particular +through the interface defined in libavfilter/buffersink.h +or the options system. +

+

It accepts a pointer to an AVBufferSinkContext structure, which +defines the incoming buffers’ formats, to be passed as the opaque +parameter to avfilter_init_filter for initialization. +

+ +

36.2 nullsink

+ +

Null video sink: do absolutely nothing with the input video. It is +mainly useful as a template and for use in analysis / debugging +tools. +

+ + +

37 Multimedia Filters

+ +

Below is a description of the currently available multimedia filters. +

+ +

37.1 abitscope

+ +

Convert input audio to a video output, displaying the audio bit scope. +

+

The filter accepts the following options: +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 1024x256. +

+
+
colors
+

Specify list of colors separated by space or by ’|’ which will be used to +draw channels. Unrecognized or missing colors will be replaced +by white color. +

+
+ + +

37.2 adrawgraph

+

Draw a graph using input audio metadata. +

+

See drawgraph +

+ +

37.3 agraphmonitor

+ +

See graphmonitor. +

+ +

37.4 ahistogram

+ +

Convert input audio to a video output, displaying the volume histogram. +

+

The filter accepts the following options: +

+
+
dmode
+

Specify how histogram is calculated. +

+

It accepts the following values: +

+
‘single’
+

Use single histogram for all channels. +

+
‘separate’
+

Use separate histogram for each channel. +

+
+

Default is single. +

+
+
rate, r
+

Set frame rate, expressed as number of frames per second. Default +value is "25". +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is hd720. +

+
+
scale
+

Set display scale. +

+

It accepts the following values: +

+
‘log’
+

logarithmic +

+
‘sqrt’
+

square root +

+
‘cbrt’
+

cubic root +

+
‘lin’
+

linear +

+
‘rlog’
+

reverse logarithmic +

+
+

Default is log. +

+
+
ascale
+

Set amplitude scale. +

+

It accepts the following values: +

+
‘log’
+

logarithmic +

+
‘lin’
+

linear +

+
+

Default is log. +

+
+
acount
+

Set how much frames to accumulate in histogram. +Default is 1. Setting this to -1 accumulates all frames. +

+
+
rheight
+

Set histogram ratio of window height. +

+
+
slide
+

Set sonogram sliding. +

+

It accepts the following values: +

+
‘replace’
+

replace old rows with new ones. +

+
‘scroll’
+

scroll from top to bottom. +

+
+

Default is replace. +

+
+ + +

37.5 aphasemeter

+ +

Measures phase of input audio, which is exported as metadata lavfi.aphasemeter.phase, +representing mean phase of current audio frame. A video output can also be produced and is +enabled by default. The audio is passed through as first output. +

+

Audio will be rematrixed to stereo if it has a different channel layout. Phase value is in +range [-1, 1] where -1 means left and right channels are completely out of phase +and 1 means channels are in phase. +

+

The filter accepts the following options, all related to its video output: +

+
+
rate, r
+

Set the output frame rate. Default value is 25. +

+
+
size, s
+

Set the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 800x400. +

+
+
rc
+
gc
+
bc
+

Specify the red, green, blue contrast. Default values are 2, +7 and 1. +Allowed range is [0, 255]. +

+
+
mpc
+

Set color which will be used for drawing median phase. If color is +none which is default, no median phase value will be drawn. +

+
+
video
+

Enable video output. Default is enabled. +

+
+ + +

37.6 avectorscope

+ +

Convert input audio to a video output, representing the audio vector +scope. +

+

The filter is used to measure the difference between channels of stereo +audio stream. A monaural signal, consisting of identical left and right +signal, results in straight vertical line. Any stereo separation is visible +as a deviation from this line, creating a Lissajous figure. +If the straight (or deviation from it) but horizontal line appears this +indicates that the left and right channels are out of phase. +

+

The filter accepts the following options: +

+
+
mode, m
+

Set the vectorscope mode. +

+

Available values are: +

+
‘lissajous’
+

Lissajous rotated by 45 degrees. +

+
+
‘lissajous_xy’
+

Same as above but not rotated. +

+
+
‘polar’
+

Shape resembling half of circle. +

+
+ +

Default value is ‘lissajous’. +

+
+
size, s
+

Set the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 400x400. +

+
+
rate, r
+

Set the output frame rate. Default value is 25. +

+
+
rc
+
gc
+
bc
+
ac
+

Specify the red, green, blue and alpha contrast. Default values are 40, +160, 80 and 255. +Allowed range is [0, 255]. +

+
+
rf
+
gf
+
bf
+
af
+

Specify the red, green, blue and alpha fade. Default values are 15, +10, 5 and 5. +Allowed range is [0, 255]. +

+
+
zoom
+

Set the zoom factor. Default value is 1. Allowed range is [0, 10]. +Values lower than 1 will auto adjust zoom factor to maximal possible value. +

+
+
draw
+

Set the vectorscope drawing mode. +

+

Available values are: +

+
‘dot’
+

Draw dot for each sample. +

+
+
‘line’
+

Draw line between previous and current sample. +

+
+ +

Default value is ‘dot’. +

+
+
scale
+

Specify amplitude scale of audio samples. +

+

Available values are: +

+
‘lin’
+

Linear. +

+
+
‘sqrt’
+

Square root. +

+
+
‘cbrt’
+

Cubic root. +

+
+
‘log’
+

Logarithmic. +

+
+ +
+
swap
+

Swap left channel axis with right channel axis. +

+
+
mirror
+

Mirror axis. +

+
+
‘none’
+

No mirror. +

+
+
‘x’
+

Mirror only x axis. +

+
+
‘y’
+

Mirror only y axis. +

+
+
‘xy’
+

Mirror both axis. +

+
+ +
+
+ + +

37.6.1 Examples

+ +
    +
  • Complete example using ffplay: +
    +
    ffplay -f lavfi 'amovie=input.mp3, asplit [a][out1];
+             [a] avectorscope=zoom=1.3:rc=2:gc=200:bc=10:rf=1:gf=8:bf=7 [out0]'
+
    +
+ + +

37.7 bench, abench

+ +

Benchmark part of a filtergraph. +

+

The filter accepts the following options: +

+
+
action
+

Start or stop a timer. +

+

Available values are: +

+
‘start’
+

Get the current time, set it as frame metadata (using the key +lavfi.bench.start_time), and forward the frame to the next filter. +

+
+
‘stop’
+

Get the current time and fetch the lavfi.bench.start_time metadata from +the input frame metadata to get the time difference. Time difference, average, +maximum and minimum time (respectively t, avg, max and +min) are then printed. The timestamps are expressed in seconds. +

+
+
+
+ + +

37.7.1 Examples

+ +
    +
  • Benchmark selectivecolor filter: +
    +
    bench=start,selectivecolor=reds=-.2 .12 -.49,bench=stop
+
    +
+ + +

37.8 concat

+ +

Concatenate audio and video streams, joining them together one after the +other. +

+

The filter works on segments of synchronized video and audio streams. All +segments must have the same number of streams of each type, and that will +also be the number of streams at output. +

+

The filter accepts the following options: +

+
+
n
+

Set the number of segments. Default is 2. +

+
+
v
+

Set the number of output video streams, that is also the number of video +streams in each segment. Default is 1. +

+
+
a
+

Set the number of output audio streams, that is also the number of audio +streams in each segment. Default is 0. +

+
+
unsafe
+

Activate unsafe mode: do not fail if segments have a different format. +

+
+
+ +

The filter has v+a outputs: first v video outputs, then +a audio outputs. +

+

There are nx(v+a) inputs: first the inputs for the first +segment, in the same order as the outputs, then the inputs for the second +segment, etc. +

+

Related streams do not always have exactly the same duration, for various +reasons including codec frame size or sloppy authoring. For that reason, +related synchronized streams (e.g. a video and its audio track) should be +concatenated at once. The concat filter will use the duration of the longest +stream in each segment (except the last one), and if necessary pad shorter +audio streams with silence. +

+

For this filter to work correctly, all segments must start at timestamp 0. +

+

All corresponding streams must have the same parameters in all segments; the +filtering system will automatically select a common pixel format for video +streams, and a common sample format, sample rate and channel layout for +audio streams, but other settings, such as resolution, must be converted +explicitly by the user. +

+

Different frame rates are acceptable but will result in variable frame rate +at output; be sure to configure the output file to handle it. +

+ +

37.8.1 Examples

+ +
    +
  • Concatenate an opening, an episode and an ending, all in bilingual version +(video in stream 0, audio in streams 1 and 2): +
    +
    ffmpeg -i opening.mkv -i episode.mkv -i ending.mkv -filter_complex \
+  '[0:0] [0:1] [0:2] [1:0] [1:1] [1:2] [2:0] [2:1] [2:2]
+   concat=n=3:v=1:a=2 [v] [a1] [a2]' \
+  -map '[v]' -map '[a1]' -map '[a2]' output.mkv
+
    + +
  • Concatenate two parts, handling audio and video separately, using the +(a)movie sources, and adjusting the resolution: +
    +
    movie=part1.mp4, scale=512:288 [v1] ; amovie=part1.mp4 [a1] ;
+movie=part2.mp4, scale=512:288 [v2] ; amovie=part2.mp4 [a2] ;
+[v1] [v2] concat [outv] ; [a1] [a2] concat=v=0:a=1 [outa]
+
    +

    Note that a desync will happen at the stitch if the audio and video streams +do not have exactly the same duration in the first file. +

    +
+ + +

37.8.2 Commands

+ +

This filter supports the following commands: +

+
next
+

Close the current segment and step to the next one +

+
+ + +

37.9 ebur128

+ +

EBU R128 scanner filter. This filter takes an audio stream and analyzes its loudness +level. By default, it logs a message at a frequency of 10Hz with the +Momentary loudness (identified by M), Short-term loudness (S), +Integrated loudness (I) and Loudness Range (LRA). +

+

The filter can only analyze streams which have a sampling rate of 48000 Hz and whose +sample format is double-precision floating point. The input stream will be converted to +this specification, if needed. Users may need to insert aformat and/or aresample filters +after this filter to obtain the original parameters. +

+

The filter also has a video output (see the video option) with a real +time graph to observe the loudness evolution. The graphic contains the logged +message mentioned above, so it is not printed anymore when this option is set, +unless the verbose logging is set. The main graphing area contains the +short-term loudness (3 seconds of analysis), and the gauge on the right is for +the momentary loudness (400 milliseconds), but can optionally be configured +to instead display short-term loudness (see gauge). +

+

The green area marks a +/- 1LU target range around the target loudness +(-23LUFS by default, unless modified through target). +

+

More information about the Loudness Recommendation EBU R128 on +http://tech.ebu.ch/loudness. +

+

The filter accepts the following options: +

+
+
video
+

Activate the video output. The audio stream is passed unchanged whether this +option is set or no. The video stream will be the first output stream if +activated. Default is 0. +

+
+
size
+

Set the video size. This option is for video only. For the syntax of this +option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default and minimum resolution is 640x480. +

+
+
meter
+

Set the EBU scale meter. Default is 9. Common values are 9 and +18, respectively for EBU scale meter +9 and EBU scale meter +18. Any +other integer value between this range is allowed. +

+
+
metadata
+

Set metadata injection. If set to 1, the audio input will be segmented +into 100ms output frames, each of them containing various loudness information +in metadata. All the metadata keys are prefixed with lavfi.r128.. +

+

Default is 0. +

+
+
framelog
+

Force the frame logging level. +

+

Available values are: +

+
‘info’
+

information logging level +

+
‘verbose’
+

verbose logging level +

+
+ +

By default, the logging level is set to info. If the video or +the metadata options are set, it switches to verbose. +

+
+
peak
+

Set peak mode(s). +

+

Available modes can be cumulated (the option is a flag type). Possible +values are: +

+
‘none’
+

Disable any peak mode (default). +

+
‘sample’
+

Enable sample-peak mode. +

+

Simple peak mode looking for the higher sample value. It logs a message +for sample-peak (identified by SPK). +

+
‘true’
+

Enable true-peak mode. +

+

If enabled, the peak lookup is done on an over-sampled version of the input +stream for better peak accuracy. It logs a message for true-peak. +(identified by TPK) and true-peak per frame (identified by FTPK). +This mode requires a build with libswresample. +

+
+ +
+
dualmono
+

Treat mono input files as "dual mono". If a mono file is intended for playback +on a stereo system, its EBU R128 measurement will be perceptually incorrect. +If set to true, this option will compensate for this effect. +Multi-channel input files are not affected by this option. +

+
+
panlaw
+

Set a specific pan law to be used for the measurement of dual mono files. +This parameter is optional, and has a default value of -3.01dB. +

+
+
target
+

Set a specific target level (in LUFS) used as relative zero in the visualization. +This parameter is optional and has a default value of -23LUFS as specified +by EBU R128. However, material published online may prefer a level of -16LUFS +(e.g. for use with podcasts or video platforms). +

+
+
gauge
+

Set the value displayed by the gauge. Valid values are momentary and s +shortterm. By default the momentary value will be used, but in certain +scenarios it may be more useful to observe the short term value instead (e.g. +live mixing). +

+
+
scale
+

Sets the display scale for the loudness. Valid parameters are absolute +(in LUFS) or relative (LU) relative to the target. This only affects the +video output, not the summary or continuous log output. +

+
+ + +

37.9.1 Examples

+ +
    +
  • Real-time graph using ffplay, with a EBU scale meter +18: +
    +
    ffplay -f lavfi -i "amovie=input.mp3,ebur128=video=1:meter=18 [out0][out1]"
+
    + +
  • Run an analysis with ffmpeg: +
    +
    ffmpeg -nostats -i input.mp3 -filter_complex ebur128 -f null -
+
    +
+ + +

37.10 interleave, ainterleave

+ +

Temporally interleave frames from several inputs. +

+

interleave works with video inputs, ainterleave with audio. +

+

These filters read frames from several inputs and send the oldest +queued frame to the output. +

+

Input streams must have well defined, monotonically increasing frame +timestamp values. +

+

In order to submit one frame to output, these filters need to enqueue +at least one frame for each input, so they cannot work in case one +input is not yet terminated and will not receive incoming frames. +

+

For example consider the case when one input is a select filter +which always drops input frames. The interleave filter will keep +reading from that input, but it will never be able to send new frames +to output until the input sends an end-of-stream signal. +

+

Also, depending on inputs synchronization, the filters will drop +frames in case one input receives more frames than the other ones, and +the queue is already filled. +

+

These filters accept the following options: +

+
+
nb_inputs, n
+

Set the number of different inputs, it is 2 by default. +

+
+
duration
+

How to determine the end-of-stream. +

+
+
longest
+

The duration of the longest input. (default) +

+
+
shortest
+

The duration of the shortest input. +

+
+
first
+

The duration of the first input. +

+
+ +
+
+ + +

37.10.1 Examples

+ +
    +
  • Interleave frames belonging to different streams using ffmpeg: +
    +
    ffmpeg -i bambi.avi -i pr0n.mkv -filter_complex "[0:v][1:v] interleave" out.avi
+
    + +
  • Add flickering blur effect: +
    +
    select='if(gt(random(0), 0.2), 1, 2)':n=2 [tmp], boxblur=2:2, [tmp] interleave
+
    +
+ + +

37.11 metadata, ametadata

+ +

Manipulate frame metadata. +

+

This filter accepts the following options: +

+
+
mode
+

Set mode of operation of the filter. +

+

Can be one of the following: +

+
+
‘select’
+

If both value and key is set, select frames +which have such metadata. If only key is set, select +every frame that has such key in metadata. +

+
+
‘add’
+

Add new metadata key and value. If key is already available +do nothing. +

+
+
‘modify’
+

Modify value of already present key. +

+
+
‘delete’
+

If value is set, delete only keys that have such value. +Otherwise, delete key. If key is not set, delete all metadata values in +the frame. +

+
+
‘print’
+

Print key and its value if metadata was found. If key is not set print all +metadata values available in frame. +

+
+ +
+
key
+

Set key used with all modes. Must be set for all modes except print and delete. +

+
+
value
+

Set metadata value which will be used. This option is mandatory for +modify and add mode. +

+
+
function
+

Which function to use when comparing metadata value and value. +

+

Can be one of following: +

+
+
‘same_str’
+

Values are interpreted as strings, returns true if metadata value is same as value. +

+
+
‘starts_with’
+

Values are interpreted as strings, returns true if metadata value starts with +the value option string. +

+
+
‘less’
+

Values are interpreted as floats, returns true if metadata value is less than value. +

+
+
‘equal’
+

Values are interpreted as floats, returns true if value is equal with metadata value. +

+
+
‘greater’
+

Values are interpreted as floats, returns true if metadata value is greater than value. +

+
+
‘expr’
+

Values are interpreted as floats, returns true if expression from option expr +evaluates to true. +

+
+
‘ends_with’
+

Values are interpreted as strings, returns true if metadata value ends with +the value option string. +

+
+ +
+
expr
+

Set expression which is used when function is set to expr. +The expression is evaluated through the eval API and can contain the following +constants: +

+
+
VALUE1
+

Float representation of value from metadata key. +

+
+
VALUE2
+

Float representation of value as supplied by user in value option. +

+
+ +
+
file
+

If specified in print mode, output is written to the named file. Instead of +plain filename any writable url can be specified. Filename “-” is a shorthand +for standard output. If file option is not set, output is written to the log +with AV_LOG_INFO loglevel. +

+
+
direct
+

Reduces buffering in print mode when output is written to a URL set using file. +

+
+
+ + +

37.11.1 Examples

+ +
    +
  • Print all metadata values for frames with key lavfi.signalstats.YDIF with values +between 0 and 1. +
    +
    signalstats,metadata=print:key=lavfi.signalstats.YDIF:value=0:function=expr:expr='between(VALUE1,0,1)'
+
    +
  • Print silencedetect output to file metadata.txt. +
    +
    silencedetect,ametadata=mode=print:file=metadata.txt
+
    +
  • Direct all metadata to a pipe with file descriptor 4. +
    +
    metadata=mode=print:file='pipe\:4'
+
    +
+ + +

37.12 perms, aperms

+ +

Set read/write permissions for the output frames. +

+

These filters are mainly aimed at developers to test direct path in the +following filter in the filtergraph. +

+

The filters accept the following options: +

+
+
mode
+

Select the permissions mode. +

+

It accepts the following values: +

+
‘none’
+

Do nothing. This is the default. +

+
‘ro’
+

Set all the output frames read-only. +

+
‘rw’
+

Set all the output frames directly writable. +

+
‘toggle’
+

Make the frame read-only if writable, and writable if read-only. +

+
‘random’
+

Set each output frame read-only or writable randomly. +

+
+ +
+
seed
+

Set the seed for the random mode, must be an integer included between +0 and UINT32_MAX. If not specified, or if explicitly set to +-1, the filter will try to use a good random seed on a best effort +basis. +

+
+ +

Note: in case of auto-inserted filter between the permission filter and the +following one, the permission might not be received as expected in that +following filter. Inserting a format or aformat filter before the +perms/aperms filter can avoid this problem. +

+ +

37.13 realtime, arealtime

+ +

Slow down filtering to match real time approximately. +

+

These filters will pause the filtering for a variable amount of time to +match the output rate with the input timestamps. +They are similar to the re option to ffmpeg. +

+

They accept the following options: +

+
+
limit
+

Time limit for the pauses. Any pause longer than that will be considered +a timestamp discontinuity and reset the timer. Default is 2 seconds. +

+
speed
+

Speed factor for processing. The value must be a float larger than zero. +Values larger than 1.0 will result in faster than realtime processing, +smaller will slow processing down. The limit is automatically adapted +accordingly. Default is 1.0. +

+

A processing speed faster than what is possible without these filters cannot +be achieved. +

+
+ + +

37.14 select, aselect

+ +

Select frames to pass in output. +

+

This filter accepts the following options: +

+
+
expr, e
+

Set expression, which is evaluated for each input frame. +

+

If the expression is evaluated to zero, the frame is discarded. +

+

If the evaluation result is negative or NaN, the frame is sent to the +first output; otherwise it is sent to the output with index +ceil(val)-1, assuming that the input index starts from 0. +

+

For example a value of 1.2 corresponds to the output with index +ceil(1.2)-1 = 2-1 = 1, that is the second output. +

+
+
outputs, n
+

Set the number of outputs. The output to which to send the selected +frame is based on the result of the evaluation. Default value is 1. +

+
+ +

The expression can contain the following constants: +

+
+
n
+

The (sequential) number of the filtered frame, starting from 0. +

+
+
selected_n
+

The (sequential) number of the selected frame, starting from 0. +

+
+
prev_selected_n
+

The sequential number of the last selected frame. It’s NAN if undefined. +

+
+
TB
+

The timebase of the input timestamps. +

+
+
pts
+

The PTS (Presentation TimeStamp) of the filtered video frame, +expressed in TB units. It’s NAN if undefined. +

+
+
t
+

The PTS of the filtered video frame, +expressed in seconds. It’s NAN if undefined. +

+
+
prev_pts
+

The PTS of the previously filtered video frame. It’s NAN if undefined. +

+
+
prev_selected_pts
+

The PTS of the last previously filtered video frame. It’s NAN if undefined. +

+
+
prev_selected_t
+

The PTS of the last previously selected video frame, expressed in seconds. It’s NAN if undefined. +

+
+
start_pts
+

The PTS of the first video frame in the video. It’s NAN if undefined. +

+
+
start_t
+

The time of the first video frame in the video. It’s NAN if undefined. +

+
+
pict_type (video only)
+

The type of the filtered frame. It can assume one of the following +values: +

+
I
+
P
+
B
+
S
+
SI
+
SP
+
BI
+
+ +
+
interlace_type (video only)
+

The frame interlace type. It can assume one of the following values: +

+
PROGRESSIVE
+

The frame is progressive (not interlaced). +

+
TOPFIRST
+

The frame is top-field-first. +

+
BOTTOMFIRST
+

The frame is bottom-field-first. +

+
+ +
+
consumed_sample_n (audio only)
+

the number of selected samples before the current frame +

+
+
samples_n (audio only)
+

the number of samples in the current frame +

+
+
sample_rate (audio only)
+

the input sample rate +

+
+
key
+

This is 1 if the filtered frame is a key-frame, 0 otherwise. +

+
+
pos
+

the position in the file of the filtered frame, -1 if the information +is not available (e.g. for synthetic video) +

+
+
scene (video only)
+

value between 0 and 1 to indicate a new scene; a low value reflects a low +probability for the current frame to introduce a new scene, while a higher +value means the current frame is more likely to be one (see the example below) +

+
+
concatdec_select
+

The concat demuxer can select only part of a concat input file by setting an +inpoint and an outpoint, but the output packets may not be entirely contained +in the selected interval. By using this variable, it is possible to skip frames +generated by the concat demuxer which are not exactly contained in the selected +interval. +

+

This works by comparing the frame pts against the lavf.concat.start_time +and the lavf.concat.duration packet metadata values which are also +present in the decoded frames. +

+

The concatdec_select variable is -1 if the frame pts is at least +start_time and either the duration metadata is missing or the frame pts is less +than start_time + duration, 0 otherwise, and NaN if the start_time metadata is +missing. +

+

That basically means that an input frame is selected if its pts is within the +interval set by the concat demuxer. +

+
+
+ +

The default value of the select expression is "1". +

+ +

37.14.1 Examples

+ +
    +
  • Select all frames in input: +
    +
    select
+
    + +

    The example above is the same as: +

    +
    select=1
+
    + +
  • Skip all frames: +
    +
    select=0
+
    + +
  • Select only I-frames: +
    +
    select='eq(pict_type\,I)'
+
    + +
  • Select one frame every 100: +
    +
    select='not(mod(n\,100))'
+
    + +
  • Select only frames contained in the 10-20 time interval: +
    +
    select=between(t\,10\,20)
+
    + +
  • Select only I-frames contained in the 10-20 time interval: +
    +
    select=between(t\,10\,20)*eq(pict_type\,I)
+
    + +
  • Select frames with a minimum distance of 10 seconds: +
    +
    select='isnan(prev_selected_t)+gte(t-prev_selected_t\,10)'
+
    + +
  • Use aselect to select only audio frames with samples number > 100: +
    +
    aselect='gt(samples_n\,100)'
+
    + +
  • Create a mosaic of the first scenes: +
    +
    ffmpeg -i video.avi -vf select='gt(scene\,0.4)',scale=160:120,tile -frames:v 1 preview.png
+
    + +

    Comparing scene against a value between 0.3 and 0.5 is generally a sane +choice. +

    +
  • Send even and odd frames to separate outputs, and compose them: +
    +
    select=n=2:e='mod(n, 2)+1' [odd][even]; [odd] pad=h=2*ih [tmp]; [tmp][even] overlay=y=h
+
    + +
  • Select useful frames from an ffconcat file which is using inpoints and +outpoints but where the source files are not intra frame only. +
    +
    ffmpeg -copyts -vsync 0 -segment_time_metadata 1 -i input.ffconcat -vf select=concatdec_select -af aselect=concatdec_select output.avi
+
    +
+ + +

37.15 sendcmd, asendcmd

+ +

Send commands to filters in the filtergraph. +

+

These filters read commands to be sent to other filters in the +filtergraph. +

+

sendcmd must be inserted between two video filters, +asendcmd must be inserted between two audio filters, but apart +from that they act the same way. +

+

The specification of commands can be provided in the filter arguments +with the commands option, or in a file specified by the +filename option. +

+

These filters accept the following options: +

+
commands, c
+

Set the commands to be read and sent to the other filters. +

+
filename, f
+

Set the filename of the commands to be read and sent to the other +filters. +

+
+ + +

37.15.1 Commands syntax

+ +

A commands description consists of a sequence of interval +specifications, comprising a list of commands to be executed when a +particular event related to that interval occurs. The occurring event +is typically the current frame time entering or leaving a given time +interval. +

+

An interval is specified by the following syntax: +

+
START[-END] COMMANDS;
+
+ +

The time interval is specified by the START and END times. +END is optional and defaults to the maximum time. +

+

The current frame time is considered within the specified interval if +it is included in the interval [START, END), that is when +the time is greater or equal to START and is lesser than +END. +

+

COMMANDS consists of a sequence of one or more command +specifications, separated by ",", relating to that interval. The +syntax of a command specification is given by: +

+
[FLAGS] TARGET COMMAND ARG
+
+ +

FLAGS is optional and specifies the type of events relating to +the time interval which enable sending the specified command, and must +be a non-null sequence of identifier flags separated by "+" or "|" and +enclosed between "[" and "]". +

+

The following flags are recognized: +

+
enter
+

The command is sent when the current frame timestamp enters the +specified interval. In other words, the command is sent when the +previous frame timestamp was not in the given interval, and the +current is. +

+
+
leave
+

The command is sent when the current frame timestamp leaves the +specified interval. In other words, the command is sent when the +previous frame timestamp was in the given interval, and the +current is not. +

+
+
expr
+

The command ARG is interpreted as expression and result of +expression is passed as ARG. +

+

The expression is evaluated through the eval API and can contain the following +constants: +

+
+
POS
+

Original position in the file of the frame, or undefined if undefined +for the current frame. +

+
+
PTS
+

The presentation timestamp in input. +

+
+
N
+

The count of the input frame for video or audio, starting from 0. +

+
+
T
+

The time in seconds of the current frame. +

+
+
TS
+

The start time in seconds of the current command interval. +

+
+
TE
+

The end time in seconds of the current command interval. +

+
+
TI
+

The interpolated time of the current command interval, TI = (T - TS) / (TE - TS). +

+
+ +
+
+ +

If FLAGS is not specified, a default value of [enter] is +assumed. +

+

TARGET specifies the target of the command, usually the name of +the filter class or a specific filter instance name. +

+

COMMAND specifies the name of the command for the target filter. +

+

ARG is optional and specifies the optional list of argument for +the given COMMAND. +

+

Between one interval specification and another, whitespaces, or +sequences of characters starting with # until the end of line, +are ignored and can be used to annotate comments. +

+

A simplified BNF description of the commands specification syntax +follows: +

+
COMMAND_FLAG  ::= "enter" | "leave"
+COMMAND_FLAGS ::= COMMAND_FLAG [(+|"|")COMMAND_FLAG]
+COMMAND       ::= ["[" COMMAND_FLAGS "]"] TARGET COMMAND [ARG]
+COMMANDS      ::= COMMAND [,COMMANDS]
+INTERVAL      ::= START[-END] COMMANDS
+INTERVALS     ::= INTERVAL[;INTERVALS]
+
+ + +

37.15.2 Examples

+ +
    +
  • Specify audio tempo change at second 4: +
    +
    asendcmd=c='4.0 atempo tempo 1.5',atempo
+
    + +
  • Target a specific filter instance: +
    +
    asendcmd=c='4.0 atempo@my tempo 1.5',atempo@my
+
    + +
  • Specify a list of drawtext and hue commands in a file. +
    +
    # show text in the interval 5-10
+5.0-10.0 [enter] drawtext reinit 'fontfile=FreeSerif.ttf:text=hello world',
+         [leave] drawtext reinit 'fontfile=FreeSerif.ttf:text=';
+
+# desaturate the image in the interval 15-20
+15.0-20.0 [enter] hue s 0,
+          [enter] drawtext reinit 'fontfile=FreeSerif.ttf:text=nocolor',
+          [leave] hue s 1,
+          [leave] drawtext reinit 'fontfile=FreeSerif.ttf:text=color';
+
+# apply an exponential saturation fade-out effect, starting from time 25
+25 [enter] hue s exp(25-t)
+
    + +

    A filtergraph allowing to read and process the above command list +stored in a file test.cmd, can be specified with: +

    +
    sendcmd=f=test.cmd,drawtext=fontfile=FreeSerif.ttf:text='',hue
+
    +
+ + +

37.16 setpts, asetpts

+ +

Change the PTS (presentation timestamp) of the input frames. +

+

setpts works on video frames, asetpts on audio frames. +

+

This filter accepts the following options: +

+
+
expr
+

The expression which is evaluated for each frame to construct its timestamp. +

+
+
+ +

The expression is evaluated through the eval API and can contain the following +constants: +

+
+
FRAME_RATE, FR
+

frame rate, only defined for constant frame-rate video +

+
+
PTS
+

The presentation timestamp in input +

+
+
N
+

The count of the input frame for video or the number of consumed samples, +not including the current frame for audio, starting from 0. +

+
+
NB_CONSUMED_SAMPLES
+

The number of consumed samples, not including the current frame (only +audio) +

+
+
NB_SAMPLES, S
+

The number of samples in the current frame (only audio) +

+
+
SAMPLE_RATE, SR
+

The audio sample rate. +

+
+
STARTPTS
+

The PTS of the first frame. +

+
+
STARTT
+

the time in seconds of the first frame +

+
+
INTERLACED
+

State whether the current frame is interlaced. +

+
+
T
+

the time in seconds of the current frame +

+
+
POS
+

original position in the file of the frame, or undefined if undefined +for the current frame +

+
+
PREV_INPTS
+

The previous input PTS. +

+
+
PREV_INT
+

previous input time in seconds +

+
+
PREV_OUTPTS
+

The previous output PTS. +

+
+
PREV_OUTT
+

previous output time in seconds +

+
+
RTCTIME
+

The wallclock (RTC) time in microseconds. This is deprecated, use time(0) +instead. +

+
+
RTCSTART
+

The wallclock (RTC) time at the start of the movie in microseconds. +

+
+
TB
+

The timebase of the input timestamps. +

+
+
+ + +

37.16.1 Examples

+ +
    +
  • Start counting PTS from zero +
    +
    setpts=PTS-STARTPTS
+
    + +
  • Apply fast motion effect: +
    +
    setpts=0.5*PTS
+
    + +
  • Apply slow motion effect: +
    +
    setpts=2.0*PTS
+
    + +
  • Set fixed rate of 25 frames per second: +
    +
    setpts=N/(25*TB)
+
    + +
  • Set fixed rate 25 fps with some jitter: +
    +
    setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
+
    + +
  • Apply an offset of 10 seconds to the input PTS: +
    +
    setpts=PTS+10/TB
+
    + +
  • Generate timestamps from a "live source" and rebase onto the current timebase: +
    +
    setpts='(RTCTIME - RTCSTART) / (TB * 1000000)'
+
    + +
  • Generate timestamps by counting samples: +
    +
    asetpts=N/SR/TB
+
    + +
+ + +

37.17 setrange

+ +

Force color range for the output video frame. +

+

The setrange filter marks the color range property for the +output frames. It does not change the input frame, but only sets the +corresponding property, which affects how the frame is treated by +following filters. +

+

The filter accepts the following options: +

+
+
range
+

Available values are: +

+
+
‘auto’
+

Keep the same color range property. +

+
+
‘unspecified, unknown’
+

Set the color range as unspecified. +

+
+
‘limited, tv, mpeg’
+

Set the color range as limited. +

+
+
‘full, pc, jpeg’
+

Set the color range as full. +

+
+
+
+ + +

37.18 settb, asettb

+ +

Set the timebase to use for the output frames timestamps. +It is mainly useful for testing timebase configuration. +

+

It accepts the following parameters: +

+
+
expr, tb
+

The expression which is evaluated into the output timebase. +

+
+
+ +

The value for tb is an arithmetic expression representing a +rational. The expression can contain the constants "AVTB" (the default +timebase), "intb" (the input timebase) and "sr" (the sample rate, +audio only). Default value is "intb". +

+ +

37.18.1 Examples

+ +
    +
  • Set the timebase to 1/25: +
    +
    settb=expr=1/25
+
    + +
  • Set the timebase to 1/10: +
    +
    settb=expr=0.1
+
    + +
  • Set the timebase to 1001/1000: +
    +
    settb=1+0.001
+
    + +
  • Set the timebase to 2*intb: +
    +
    settb=2*intb
+
    + +
  • Set the default timebase value: +
    +
    settb=AVTB
+
    +
+ + +

37.19 showcqt

+

Convert input audio to a video output representing frequency spectrum +logarithmically using Brown-Puckette constant Q transform algorithm with +direct frequency domain coefficient calculation (but the transform itself +is not really constant Q, instead the Q factor is actually variable/clamped), +with musical tone scale, from E0 to D#10. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. It must be even. For the syntax of this option, +check the (ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 1920x1080. +

+
+
fps, rate, r
+

Set the output frame rate. Default value is 25. +

+
+
bar_h
+

Set the bargraph height. It must be even. Default value is -1 which +computes the bargraph height automatically. +

+
+
axis_h
+

Set the axis height. It must be even. Default value is -1 which computes +the axis height automatically. +

+
+
sono_h
+

Set the sonogram height. It must be even. Default value is -1 which +computes the sonogram height automatically. +

+
+
fullhd
+

Set the fullhd resolution. This option is deprecated, use size, s +instead. Default value is 1. +

+
+
sono_v, volume
+

Specify the sonogram volume expression. It can contain variables: +

+
bar_v
+

the bar_v evaluated expression +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option +

+
+

and functions: +

+
a_weighting(f)
+

A-weighting of equal loudness +

+
b_weighting(f)
+

B-weighting of equal loudness +

+
c_weighting(f)
+

C-weighting of equal loudness. +

+
+

Default value is 16. +

+
+
bar_v, volume2
+

Specify the bargraph volume expression. It can contain variables: +

+
sono_v
+

the sono_v evaluated expression +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option +

+
+

and functions: +

+
a_weighting(f)
+

A-weighting of equal loudness +

+
b_weighting(f)
+

B-weighting of equal loudness +

+
c_weighting(f)
+

C-weighting of equal loudness. +

+
+

Default value is sono_v. +

+
+
sono_g, gamma
+

Specify the sonogram gamma. Lower gamma makes the spectrum more contrast, +higher gamma makes the spectrum having more range. Default value is 3. +Acceptable range is [1, 7]. +

+
+
bar_g, gamma2
+

Specify the bargraph gamma. Default value is 1. Acceptable range is +[1, 7]. +

+
+
bar_t
+

Specify the bargraph transparency level. Lower value makes the bargraph sharper. +Default value is 1. Acceptable range is [0, 1]. +

+
+
timeclamp, tc
+

Specify the transform timeclamp. At low frequency, there is trade-off between +accuracy in time domain and frequency domain. If timeclamp is lower, +event in time domain is represented more accurately (such as fast bass drum), +otherwise event in frequency domain is represented more accurately +(such as bass guitar). Acceptable range is [0.002, 1]. Default value is 0.17. +

+
+
attack
+

Set attack time in seconds. The default is 0 (disabled). Otherwise, it +limits future samples by applying asymmetric windowing in time domain, useful +when low latency is required. Accepted range is [0, 1]. +

+
+
basefreq
+

Specify the transform base frequency. Default value is 20.01523126408007475, +which is frequency 50 cents below E0. Acceptable range is [10, 100000]. +

+
+
endfreq
+

Specify the transform end frequency. Default value is 20495.59681441799654, +which is frequency 50 cents above D#10. Acceptable range is [10, 100000]. +

+
+
coeffclamp
+

This option is deprecated and ignored. +

+
+
tlength
+

Specify the transform length in time domain. Use this option to control accuracy +trade-off between time domain and frequency domain at every frequency sample. +It can contain variables: +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option. +

+
+

Default value is 384*tc/(384+tc*f). +

+
+
count
+

Specify the transform count for every video frame. Default value is 6. +Acceptable range is [1, 30]. +

+
+
fcount
+

Specify the transform count for every single pixel. Default value is 0, +which makes it computed automatically. Acceptable range is [0, 10]. +

+
+
fontfile
+

Specify font file for use with freetype to draw the axis. If not specified, +use embedded font. Note that drawing with font file or embedded font is not +implemented with custom basefreq and endfreq, use axisfile +option instead. +

+
+
font
+

Specify fontconfig pattern. This has lower priority than fontfile. The +: in the pattern may be replaced by | to avoid unnecessary +escaping. +

+
+
fontcolor
+

Specify font color expression. This is arithmetic expression that should return +integer value 0xRRGGBB. It can contain variables: +

+
frequency, freq, f
+

the frequency where it is evaluated +

+
timeclamp, tc
+

the value of timeclamp option +

+
+

and functions: +

+
midi(f)
+

midi number of frequency f, some midi numbers: E0(16), C1(24), C2(36), A4(69) +

+
r(x), g(x), b(x)
+

red, green, and blue value of intensity x. +

+
+

Default value is st(0, (midi(f)-59.5)/12); +st(1, if(between(ld(0),0,1), 0.5-0.5*cos(2*PI*ld(0)), 0)); +r(1-ld(1)) + b(ld(1)). +

+
+
axisfile
+

Specify image file to draw the axis. This option override fontfile and +fontcolor option. +

+
+
axis, text
+

Enable/disable drawing text to the axis. If it is set to 0, drawing to +the axis is disabled, ignoring fontfile and axisfile option. +Default value is 1. +

+
+
csp
+

Set colorspace. The accepted values are: +

+
‘unspecified’
+

Unspecified (default) +

+
+
‘bt709’
+

BT.709 +

+
+
‘fcc’
+

FCC +

+
+
‘bt470bg’
+

BT.470BG or BT.601-6 625 +

+
+
‘smpte170m’
+

SMPTE-170M or BT.601-6 525 +

+
+
‘smpte240m’
+

SMPTE-240M +

+
+
‘bt2020ncl’
+

BT.2020 with non-constant luminance +

+
+
+ +
+
cscheme
+

Set spectrogram color scheme. This is list of floating point values with format +left_r|left_g|left_b|right_r|right_g|right_b. +The default is 1|0.5|0|0|0.5|1. +

+
+
+ + +

37.19.1 Examples

+ +
    +
  • Playing audio while showing the spectrum: +
    +
    ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt [out0]'
+
    + +
  • Same as above, but with frame rate 30 fps: +
    +
    ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt=fps=30:count=5 [out0]'
+
    + +
  • Playing at 1280x720: +
    +
    ffplay -f lavfi 'amovie=a.mp3, asplit [a][out1]; [a] showcqt=s=1280x720:count=4 [out0]'
+
    + +
  • Disable sonogram display: +
    +
    sono_h=0
+
    + +
  • A1 and its harmonics: A1, A2, (near)E3, A3: +
    +
    ffplay -f lavfi 'aevalsrc=0.1*sin(2*PI*55*t)+0.1*sin(4*PI*55*t)+0.1*sin(6*PI*55*t)+0.1*sin(8*PI*55*t),
+                 asplit[a][out1]; [a] showcqt [out0]'
+
    + +
  • Same as above, but with more accuracy in frequency domain: +
    +
    ffplay -f lavfi 'aevalsrc=0.1*sin(2*PI*55*t)+0.1*sin(4*PI*55*t)+0.1*sin(6*PI*55*t)+0.1*sin(8*PI*55*t),
+                 asplit[a][out1]; [a] showcqt=timeclamp=0.5 [out0]'
+
    + +
  • Custom volume: +
    +
    bar_v=10:sono_v=bar_v*a_weighting(f)
+
    + +
  • Custom gamma, now spectrum is linear to the amplitude. +
    +
    bar_g=2:sono_g=2
+
    + +
  • Custom tlength equation: +
    +
    tc=0.33:tlength='st(0,0.17); 384*tc / (384 / ld(0) + tc*f /(1-ld(0))) + 384*tc / (tc*f / ld(0) + 384 /(1-ld(0)))'
+
    + +
  • Custom fontcolor and fontfile, C-note is colored green, others are colored blue: +
    +
    fontcolor='if(mod(floor(midi(f)+0.5),12), 0x0000FF, g(1))':fontfile=myfont.ttf
+
    + +
  • Custom font using fontconfig: +
    +
    font='Courier New,Monospace,mono|bold'
+
    + +
  • Custom frequency range with custom axis using image file: +
    +
    axisfile=myaxis.png:basefreq=40:endfreq=10000
+
    +
+ + +

37.20 showfreqs

+ +

Convert input audio to video output representing the audio power spectrum. +Audio amplitude is on Y-axis while frequency is on X-axis. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify size of video. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default is 1024x512. +

+
+
mode
+

Set display mode. +This set how each frequency bin will be represented. +

+

It accepts the following values: +

+
‘line’
+
‘bar’
+
‘dot’
+
+

Default is bar. +

+
+
ascale
+

Set amplitude scale. +

+

It accepts the following values: +

+
‘lin’
+

Linear scale. +

+
+
‘sqrt’
+

Square root scale. +

+
+
‘cbrt’
+

Cubic root scale. +

+
+
‘log’
+

Logarithmic scale. +

+
+

Default is log. +

+
+
fscale
+

Set frequency scale. +

+

It accepts the following values: +

+
‘lin’
+

Linear scale. +

+
+
‘log’
+

Logarithmic scale. +

+
+
‘rlog’
+

Reverse logarithmic scale. +

+
+

Default is lin. +

+
+
win_size
+

Set window size. Allowed range is from 16 to 65536. +

+

Default is 2048 +

+
+
win_func
+

Set windowing function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+

Default is hanning. +

+
+
overlap
+

Set window overlap. In range [0, 1]. Default is 1, +which means optimal overlap for selected window function will be picked. +

+
+
averaging
+

Set time averaging. Setting this to 0 will display current maximal peaks. +Default is 1, which means time averaging is disabled. +

+
+
colors
+

Specify list of colors separated by space or by ’|’ which will be used to +draw channel frequencies. Unrecognized or missing colors will be replaced +by white color. +

+
+
cmode
+

Set channel display mode. +

+

It accepts the following values: +

+
‘combined’
+
‘separate’
+
+

Default is combined. +

+
+
minamp
+

Set minimum amplitude used in log amplitude scaler. +

+
+
+ + +

37.21 showspatial

+ +

Convert stereo input audio to a video output, representing the spatial relationship +between two channels. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 512x512. +

+
+
win_size
+

Set window size. Allowed range is from 1024 to 65536. Default size is 4096. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+ +

Default value is hann. +

+
+
overlap
+

Set ratio of overlap window. Default value is 0.5. +When value is 1 overlap is set to recommended size for specific +window function currently used. +

+
+ + +

37.22 showspectrum

+ +

Convert input audio to a video output, representing the audio frequency +spectrum. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 640x512. +

+
+
slide
+

Specify how the spectrum should slide along the window. +

+

It accepts the following values: +

+
‘replace’
+

the samples start again on the left when they reach the right +

+
‘scroll’
+

the samples scroll from right to left +

+
‘fullframe’
+

frames are only produced when the samples reach the right +

+
‘rscroll’
+

the samples scroll from left to right +

+
+ +

Default value is replace. +

+
+
mode
+

Specify display mode. +

+

It accepts the following values: +

+
‘combined’
+

all channels are displayed in the same row +

+
‘separate’
+

all channels are displayed in separate rows +

+
+ +

Default value is ‘combined’. +

+
+
color
+

Specify display color mode. +

+

It accepts the following values: +

+
‘channel’
+

each channel is displayed in a separate color +

+
‘intensity’
+

each channel is displayed using the same color scheme +

+
‘rainbow’
+

each channel is displayed using the rainbow color scheme +

+
‘moreland’
+

each channel is displayed using the moreland color scheme +

+
‘nebulae’
+

each channel is displayed using the nebulae color scheme +

+
‘fire’
+

each channel is displayed using the fire color scheme +

+
‘fiery’
+

each channel is displayed using the fiery color scheme +

+
‘fruit’
+

each channel is displayed using the fruit color scheme +

+
‘cool’
+

each channel is displayed using the cool color scheme +

+
‘magma’
+

each channel is displayed using the magma color scheme +

+
‘green’
+

each channel is displayed using the green color scheme +

+
‘viridis’
+

each channel is displayed using the viridis color scheme +

+
‘plasma’
+

each channel is displayed using the plasma color scheme +

+
‘cividis’
+

each channel is displayed using the cividis color scheme +

+
‘terrain’
+

each channel is displayed using the terrain color scheme +

+
+ +

Default value is ‘channel’. +

+
+
scale
+

Specify scale used for calculating intensity color values. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘sqrt’
+

square root, default +

+
‘cbrt’
+

cubic root +

+
‘log’
+

logarithmic +

+
‘4thrt’
+

4th root +

+
‘5thrt’
+

5th root +

+
+ +

Default value is ‘sqrt’. +

+
+
fscale
+

Specify frequency scale. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘log’
+

logarithmic +

+
+ +

Default value is ‘lin’. +

+
+
saturation
+

Set saturation modifier for displayed colors. Negative values provide +alternative color scheme. 0 is no saturation at all. +Saturation must be in [-10.0, 10.0] range. +Default value is 1. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+ +

Default value is hann. +

+
+
orientation
+

Set orientation of time vs frequency axis. Can be vertical or +horizontal. Default is vertical. +

+
+
overlap
+

Set ratio of overlap window. Default value is 0. +When value is 1 overlap is set to recommended size for specific +window function currently used. +

+
+
gain
+

Set scale gain for calculating intensity color values. +Default value is 1. +

+
+
data
+

Set which data to display. Can be magnitude, default or phase. +

+
+
rotation
+

Set color rotation, must be in [-1.0, 1.0] range. +Default value is 0. +

+
+
start
+

Set start frequency from which to display spectrogram. Default is 0. +

+
+
stop
+

Set stop frequency to which to display spectrogram. Default is 0. +

+
+
fps
+

Set upper frame rate limit. Default is auto, unlimited. +

+
+
legend
+

Draw time and frequency axes and legends. Default is disabled. +

+
+ +

The usage is very similar to the showwaves filter; see the examples in that +section. +

+ +

37.22.1 Examples

+ +
    +
  • Large window with logarithmic color scaling: +
    +
    showspectrum=s=1280x480:scale=log
+
    + +
  • Complete example for a colored and sliding spectrum per channel using ffplay: +
    +
    ffplay -f lavfi 'amovie=input.mp3, asplit [a][out1];
+             [a] showspectrum=mode=separate:color=intensity:slide=1:scale=cbrt [out0]'
+
    +
+ + +

37.23 showspectrumpic

+ +

Convert input audio to a single video frame, representing the audio frequency +spectrum. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 4096x2048. +

+
+
mode
+

Specify display mode. +

+

It accepts the following values: +

+
‘combined’
+

all channels are displayed in the same row +

+
‘separate’
+

all channels are displayed in separate rows +

+
+

Default value is ‘combined’. +

+
+
color
+

Specify display color mode. +

+

It accepts the following values: +

+
‘channel’
+

each channel is displayed in a separate color +

+
‘intensity’
+

each channel is displayed using the same color scheme +

+
‘rainbow’
+

each channel is displayed using the rainbow color scheme +

+
‘moreland’
+

each channel is displayed using the moreland color scheme +

+
‘nebulae’
+

each channel is displayed using the nebulae color scheme +

+
‘fire’
+

each channel is displayed using the fire color scheme +

+
‘fiery’
+

each channel is displayed using the fiery color scheme +

+
‘fruit’
+

each channel is displayed using the fruit color scheme +

+
‘cool’
+

each channel is displayed using the cool color scheme +

+
‘magma’
+

each channel is displayed using the magma color scheme +

+
‘green’
+

each channel is displayed using the green color scheme +

+
‘viridis’
+

each channel is displayed using the viridis color scheme +

+
‘plasma’
+

each channel is displayed using the plasma color scheme +

+
‘cividis’
+

each channel is displayed using the cividis color scheme +

+
‘terrain’
+

each channel is displayed using the terrain color scheme +

+
+

Default value is ‘intensity’. +

+
+
scale
+

Specify scale used for calculating intensity color values. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘sqrt’
+

square root, default +

+
‘cbrt’
+

cubic root +

+
‘log’
+

logarithmic +

+
‘4thrt’
+

4th root +

+
‘5thrt’
+

5th root +

+
+

Default value is ‘log’. +

+
+
fscale
+

Specify frequency scale. +

+

It accepts the following values: +

+
‘lin’
+

linear +

+
‘log’
+

logarithmic +

+
+ +

Default value is ‘lin’. +

+
+
saturation
+

Set saturation modifier for displayed colors. Negative values provide +alternative color scheme. 0 is no saturation at all. +Saturation must be in [-10.0, 10.0] range. +Default value is 1. +

+
+
win_func
+

Set window function. +

+

It accepts the following values: +

+
‘rect’
+
‘bartlett’
+
‘hann’
+
‘hanning’
+
‘hamming’
+
‘blackman’
+
‘welch’
+
‘flattop’
+
‘bharris’
+
‘bnuttall’
+
‘bhann’
+
‘sine’
+
‘nuttall’
+
‘lanczos’
+
‘gauss’
+
‘tukey’
+
‘dolph’
+
‘cauchy’
+
‘parzen’
+
‘poisson’
+
‘bohman’
+
+

Default value is hann. +

+
+
orientation
+

Set orientation of time vs frequency axis. Can be vertical or +horizontal. Default is vertical. +

+
+
gain
+

Set scale gain for calculating intensity color values. +Default value is 1. +

+
+
legend
+

Draw time and frequency axes and legends. Default is enabled. +

+
+
rotation
+

Set color rotation, must be in [-1.0, 1.0] range. +Default value is 0. +

+
+
start
+

Set start frequency from which to display spectrogram. Default is 0. +

+
+
stop
+

Set stop frequency to which to display spectrogram. Default is 0. +

+
+ + +

37.23.1 Examples

+ +
    +
  • Extract an audio spectrogram of a whole audio track +in a 1024x1024 picture using ffmpeg: +
    +
    ffmpeg -i audio.flac -lavfi showspectrumpic=s=1024x1024 spectrogram.png
+
    +
+ + +

37.24 showvolume

+ +

Convert input audio volume to a video output. +

+

The filter accepts the following options: +

+
+
rate, r
+

Set video rate. +

+
+
b
+

Set border width, allowed range is [0, 5]. Default is 1. +

+
+
w
+

Set channel width, allowed range is [80, 8192]. Default is 400. +

+
+
h
+

Set channel height, allowed range is [1, 900]. Default is 20. +

+
+
f
+

Set fade, allowed range is [0, 1]. Default is 0.95. +

+
+
c
+

Set volume color expression. +

+

The expression can use the following variables: +

+
+
VOLUME
+

Current max volume of channel in dB. +

+
+
PEAK
+

Current peak. +

+
+
CHANNEL
+

Current channel number, starting from 0. +

+
+ +
+
t
+

If set, displays channel names. Default is enabled. +

+
+
v
+

If set, displays volume values. Default is enabled. +

+
+
o
+

Set orientation, can be horizontal: h or vertical: v, +default is h. +

+
+
s
+

Set step size, allowed range is [0, 5]. Default is 0, which means +step is disabled. +

+
+
p
+

Set background opacity, allowed range is [0, 1]. Default is 0. +

+
+
m
+

Set metering mode, can be peak: p or rms: r, +default is p. +

+
+
ds
+

Set display scale, can be linear: lin or log: log, +default is lin. +

+
+
dm
+

In second. +If set to > 0., display a line for the max level +in the previous seconds. +default is disabled: 0. +

+
+
dmc
+

The color of the max line. Use when dm option is set to > 0. +default is: orange +

+
+ + +

37.25 showwaves

+ +

Convert input audio to a video output, representing the samples waves. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 600x240. +

+
+
mode
+

Set display mode. +

+

Available values are: +

+
‘point’
+

Draw a point for each sample. +

+
+
‘line’
+

Draw a vertical line for each sample. +

+
+
‘p2p’
+

Draw a point for each sample and a line between them. +

+
+
‘cline’
+

Draw a centered vertical line for each sample. +

+
+ +

Default value is point. +

+
+
n
+

Set the number of samples which are printed on the same column. A +larger value will decrease the frame rate. Must be a positive +integer. This option can be set only if the value for rate +is not explicitly specified. +

+
+
rate, r
+

Set the (approximate) output frame rate. This is done by setting the +option n. Default value is "25". +

+
+
split_channels
+

Set if channels should be drawn separately or overlap. Default value is 0. +

+
+
colors
+

Set colors separated by ’|’ which are going to be used for drawing of each channel. +

+
+
scale
+

Set amplitude scale. +

+

Available values are: +

+
‘lin’
+

Linear. +

+
+
‘log’
+

Logarithmic. +

+
+
‘sqrt’
+

Square root. +

+
+
‘cbrt’
+

Cubic root. +

+
+ +

Default is linear. +

+
+
draw
+

Set the draw mode. This is mostly useful to set for high n. +

+

Available values are: +

+
‘scale’
+

Scale pixel values for each drawn sample. +

+
+
‘full’
+

Draw every sample directly. +

+
+ +

Default value is scale. +

+
+ + +

37.25.1 Examples

+ +
    +
  • Output the input file audio and the corresponding video representation +at the same time: +
    +
    amovie=a.mp3,asplit[out0],showwaves[out1]
+
    + +
  • Create a synthetic signal and show it with showwaves, forcing a +frame rate of 30 frames per second: +
    +
    aevalsrc=sin(1*2*PI*t)*sin(880*2*PI*t):cos(2*PI*200*t),asplit[out0],showwaves=r=30[out1]
+
    +
+ + +

37.26 showwavespic

+ +

Convert input audio to a single video frame, representing the samples waves. +

+

The filter accepts the following options: +

+
+
size, s
+

Specify the video size for the output. For the syntax of this option, check the +(ffmpeg-utils)"Video size" section in the ffmpeg-utils manual. +Default value is 600x240. +

+
+
split_channels
+

Set if channels should be drawn separately or overlap. Default value is 0. +

+
+
colors
+

Set colors separated by ’|’ which are going to be used for drawing of each channel. +

+
+
scale
+

Set amplitude scale. +

+

Available values are: +

+
‘lin’
+

Linear. +

+
+
‘log’
+

Logarithmic. +

+
+
‘sqrt’
+

Square root. +

+
+
‘cbrt’
+

Cubic root. +

+
+ +

Default is linear. +

+
+
draw
+

Set the draw mode. +

+

Available values are: +

+
‘scale’
+

Scale pixel values for each drawn sample. +

+
+
‘full’
+

Draw every sample directly. +

+
+ +

Default value is scale. +

+
+ + +

37.26.1 Examples

+ +
    +
  • Extract a channel split representation of the wave form of a whole audio track +in a 1024x800 picture using ffmpeg: +
    +
    ffmpeg -i audio.flac -lavfi showwavespic=split_channels=1:s=1024x800 waveform.png
+
    +
+ + +

37.27 sidedata, asidedata

+ +

Delete frame side data, or select frames based on it. +

+

This filter accepts the following options: +

+
+
mode
+

Set mode of operation of the filter. +

+

Can be one of the following: +

+
+
‘select’
+

Select every frame with side data of type. +

+
+
‘delete’
+

Delete side data of type. If type is not set, delete all side +data in the frame. +

+
+
+ +
+
type
+

Set side data type used with all modes. Must be set for select mode. For +the list of frame side data types, refer to the AVFrameSideDataType enum +in libavutil/frame.h. For example, to choose +AV_FRAME_DATA_PANSCAN side data, you must specify PANSCAN. +

+
+
+ + +

37.28 spectrumsynth

+ +

Synthesize audio from 2 input video spectrums, first input stream represents +magnitude across time and second represents phase across time. +The filter will transform from frequency domain as displayed in videos back +to time domain as presented in audio output. +

+

This filter is primarily created for reversing processed showspectrum +filter outputs, but can synthesize sound from other spectrograms too. +But in such case results are going to be poor if the phase data is not +available, because in such cases phase data need to be recreated, usually +it’s just recreated from random noise. +For best results use gray only output (channel color mode in +showspectrum filter) and log scale for magnitude video and +lin scale for phase video. To produce phase, for 2nd video, use +data option. Inputs videos should generally use fullframe +slide mode as that saves resources needed for decoding video. +

+

The filter accepts the following options: +

+
+
sample_rate
+

Specify sample rate of output audio, the sample rate of audio from which +spectrum was generated may differ. +

+
+
channels
+

Set number of channels represented in input video spectrums. +

+
+
scale
+

Set scale which was used when generating magnitude input spectrum. +Can be lin or log. Default is log. +

+
+
slide
+

Set slide which was used when generating inputs spectrums. +Can be replace, scroll, fullframe or rscroll. +Default is fullframe. +

+
+
win_func
+

Set window function used for resynthesis. +

+
+
overlap
+

Set window overlap. In range [0, 1]. Default is 1, +which means optimal overlap for selected window function will be picked. +

+
+
orientation
+

Set orientation of input videos. Can be vertical or horizontal. +Default is vertical. +

+
+ + +

37.28.1 Examples

+ +
    +
  • First create magnitude and phase videos from audio, assuming audio is stereo with 44100 sample rate, +then resynthesize videos back to audio with spectrumsynth: +
    +
    ffmpeg -i input.flac -lavfi showspectrum=mode=separate:scale=log:overlap=0.875:color=channel:slide=fullframe:data=magnitude -an -c:v rawvideo magnitude.nut
+ffmpeg -i input.flac -lavfi showspectrum=mode=separate:scale=lin:overlap=0.875:color=channel:slide=fullframe:data=phase -an -c:v rawvideo phase.nut
+ffmpeg -i magnitude.nut -i phase.nut -lavfi spectrumsynth=channels=2:sample_rate=44100:win_func=hann:overlap=0.875:slide=fullframe output.flac
+
    +
+ + +

37.29 split, asplit

+ +

Split input into several identical outputs. +

+

asplit works with audio input, split with video. +

+

The filter accepts a single parameter which specifies the number of outputs. If +unspecified, it defaults to 2. +

+ +

37.29.1 Examples

+ +
    +
  • Create two separate outputs from the same input: +
    +
    [in] split [out0][out1]
+
    + +
  • To create 3 or more outputs, you need to specify the number of +outputs, like in: +
    +
    [in] asplit=3 [out0][out1][out2]
+
    + +
  • Create two separate outputs from the same input, one cropped and +one padded: +
    +
    [in] split [splitout1][splitout2];
+[splitout1] crop=100:100:0:0    [cropout];
+[splitout2] pad=200:200:100:100 [padout];
+
    + +
  • Create 5 copies of the input audio with ffmpeg: +
    +
    ffmpeg -i INPUT -filter_complex asplit=5 OUTPUT
+
    +
+ + +

37.30 zmq, azmq

+ +

Receive commands sent through a libzmq client, and forward them to +filters in the filtergraph. +

+

zmq and azmq work as a pass-through filters. zmq +must be inserted between two video filters, azmq between two +audio filters. Both are capable to send messages to any filter type. +

+

To enable these filters you need to install the libzmq library and +headers and configure FFmpeg with --enable-libzmq. +

+

For more information about libzmq see: +http://www.zeromq.org/ +

+

The zmq and azmq filters work as a libzmq server, which +receives messages sent through a network interface defined by the +bind_address (or the abbreviation "b") option. +Default value of this option is tcp://localhost:5555. You may +want to alter this value to your needs, but do not forget to escape any +’:’ signs (see filtergraph escaping). +

+

The received message must be in the form: +

+
TARGET COMMAND [ARG]
+
+ +

TARGET specifies the target of the command, usually the name of +the filter class or a specific filter instance name. The default +filter instance name uses the pattern ‘Parsed_<filter_name>_<index>’, +but you can override this by using the ‘filter_name@id’ syntax +(see Filtergraph syntax). +

+

COMMAND specifies the name of the command for the target filter. +

+

ARG is optional and specifies the optional argument list for the +given COMMAND. +

+

Upon reception, the message is processed and the corresponding command +is injected into the filtergraph. Depending on the result, the filter +will send a reply to the client, adopting the format: +

+
ERROR_CODE ERROR_REASON
+MESSAGE
+
+ +

MESSAGE is optional. +

+ +

37.30.1 Examples

+ +

Look at tools/zmqsend for an example of a zmq client which can +be used to send commands processed by these filters. +

+

Consider the following filtergraph generated by ffplay. +In this example the last overlay filter has an instance name. All other +filters will have default instance names. +

+
+
ffplay -dumpgraph 1 -f lavfi "
+color=s=100x100:c=red  [l];
+color=s=100x100:c=blue [r];
+nullsrc=s=200x100, zmq [bg];
+[bg][l]   overlay     [bg+l];
+[bg+l][r] overlay@my=x=100 "
+
+ +

To change the color of the left side of the video, the following +command can be used: +

+
echo Parsed_color_0 c yellow | tools/zmqsend
+
+ +

To change the right side: +

+
echo Parsed_color_1 c pink | tools/zmqsend
+
+ +

To change the position of the right side: +

+
echo overlay@my x 150 | tools/zmqsend
+
+ + + + +

38 Multimedia Sources

+ +

Below is a description of the currently available multimedia sources. +

+ +

38.1 amovie

+ +

This is the same as movie source, except it selects an audio +stream by default. +

+ +

38.2 movie

+ +

Read audio and/or video stream(s) from a movie container. +

+

It accepts the following parameters: +

+
+
filename
+

The name of the resource to read (not necessarily a file; it can also be a +device or a stream accessed through some protocol). +

+
+
format_name, f
+

Specifies the format assumed for the movie to read, and can be either +the name of a container or an input device. If not specified, the +format is guessed from movie_name or by probing. +

+
+
seek_point, sp
+

Specifies the seek point in seconds. The frames will be output +starting from this seek point. The parameter is evaluated with +av_strtod, so the numerical value may be suffixed by an IS +postfix. The default value is "0". +

+
+
streams, s
+

Specifies the streams to read. Several streams can be specified, +separated by "+". The source will then have as many outputs, in the +same order. The syntax is explained in the (ffmpeg)"Stream specifiers" +section in the ffmpeg manual. Two special names, "dv" and "da" specify +respectively the default (best suited) video and audio stream. Default +is "dv", or "da" if the filter is called as "amovie". +

+
+
stream_index, si
+

Specifies the index of the video stream to read. If the value is -1, +the most suitable video stream will be automatically selected. The default +value is "-1". Deprecated. If the filter is called "amovie", it will select +audio instead of video. +

+
+
loop
+

Specifies how many times to read the stream in sequence. +If the value is 0, the stream will be looped infinitely. +Default value is "1". +

+

Note that when the movie is looped the source timestamps are not +changed, so it will generate non monotonically increasing timestamps. +

+
+
discontinuity
+

Specifies the time difference between frames above which the point is +considered a timestamp discontinuity which is removed by adjusting the later +timestamps. +

+
+ +

It allows overlaying a second video on top of the main input of +a filtergraph, as shown in this graph: +

+
input -----------> deltapts0 --> overlay --> output
+                                    ^
+                                    |
+movie --> scale--> deltapts1 -------+
+
+ +

38.2.1 Examples

+ +
    +
  • Skip 3.2 seconds from the start of the AVI file in.avi, and overlay it +on top of the input labelled "in": +
    +
    movie=in.avi:seek_point=3.2, scale=180:-1, setpts=PTS-STARTPTS [over];
+[in] setpts=PTS-STARTPTS [main];
+[main][over] overlay=16:16 [out]
+
    + +
  • Read from a video4linux2 device, and overlay it on top of the input +labelled "in": +
    +
    movie=/dev/video0:f=video4linux2, scale=180:-1, setpts=PTS-STARTPTS [over];
+[in] setpts=PTS-STARTPTS [main];
+[main][over] overlay=16:16 [out]
+
    + +
  • Read the first video stream and the audio stream with id 0x81 from +dvd.vob; the video is connected to the pad named "video" and the audio is +connected to the pad named "audio": +
    +
    movie=dvd.vob:s=v:0+#0x81 [video] [audio]
+
    +
+ + +

38.2.2 Commands

+ +

Both movie and amovie support the following commands: +

+
seek
+

Perform seek using "av_seek_frame". +The syntax is: seek stream_index|timestamp|flags +

    +
  • stream_index: If stream_index is -1, a default +stream is selected, and timestamp is automatically converted +from AV_TIME_BASE units to the stream specific time_base. +
  • timestamp: Timestamp in AVStream.time_base units +or, if no stream is specified, in AV_TIME_BASE units. +
  • flags: Flags which select direction and seeking mode. +
+ +
+
get_duration
+

Get movie duration in AV_TIME_BASE units. +

+
+
+ + + +

39 See Also

+ +

ffprobe, +ffmpeg, ffplay, +ffmpeg-utils, +ffmpeg-scaler, +ffmpeg-resampler, +ffmpeg-codecs, +ffmpeg-bitstream-filters, +ffmpeg-formats, +ffmpeg-devices, +ffmpeg-protocols, +ffmpeg-filters +

+ + +

40 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffprobe.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffprobe.html new file mode 100644 index 0000000..d19b288 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/ffprobe.html @@ -0,0 +1,1177 @@ + + + + + + + ffprobe Documentation + + + + + + +
+

+ ffprobe Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Synopsis

+ +

ffprobe [options] [input_url] +

+ +

2 Description

+ +

ffprobe gathers information from multimedia streams and prints it in +human- and machine-readable fashion. +

+

For example it can be used to check the format of the container used +by a multimedia stream and the format and type of each media stream +contained in it. +

+

If a url is specified in input, ffprobe will try to open and +probe the url content. If the url cannot be opened or recognized as +a multimedia file, a positive exit code is returned. +

+

ffprobe may be employed both as a standalone application or in +combination with a textual filter, which may perform more +sophisticated processing, e.g. statistical processing or plotting. +

+

Options are used to list some of the formats supported by ffprobe or +for specifying which information to display, and for setting how +ffprobe will show it. +

+

ffprobe output is designed to be easily parsable by a textual filter, +and consists of one or more sections of a form defined by the selected +writer, which is specified by the print_format option. +

+

Sections may contain other nested sections, and are identified by a +name (which may be shared by other sections), and an unique +name. See the output of sections. +

+

Metadata tags stored in the container or in the streams are recognized +and printed in the corresponding "FORMAT", "STREAM" or "PROGRAM_STREAM" +section. +

+ + +

3 Options

+ +

All the numerical options, if not specified otherwise, accept a string +representing a number as input, which may be followed by one of the SI +unit prefixes, for example: ’K’, ’M’, or ’G’. +

+

If ’i’ is appended to the SI unit prefix, the complete prefix will be +interpreted as a unit prefix for binary multiples, which are based on +powers of 1024 instead of powers of 1000. Appending ’B’ to the SI unit +prefix multiplies the value by 8. This allows using, for example: +’KB’, ’MiB’, ’G’ and ’B’ as number suffixes. +

+

Options which do not take arguments are boolean options, and set the +corresponding value to true. They can be set to false by prefixing +the option name with "no". For example using "-nofoo" +will set the boolean option with name "foo" to false. +

+ +

3.1 Stream specifiers

+

Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers +are used to precisely specify which stream(s) a given option belongs to. +

+

A stream specifier is a string generally appended to the option name and +separated from it by a colon. E.g. -codec:a:1 ac3 contains the +a:1 stream specifier, which matches the second audio stream. Therefore, it +would select the ac3 codec for the second audio stream. +

+

A stream specifier can match several streams, so that the option is applied to all +of them. E.g. the stream specifier in -b:a 128k matches all audio +streams. +

+

An empty stream specifier matches all streams. For example, -codec copy +or -codec: copy would copy all the streams without reencoding. +

+

Possible forms of stream specifiers are: +

+
stream_index
+

Matches the stream with this index. E.g. -threads:1 4 would set the +thread count for the second stream to 4. If stream_index is used as an +additional stream specifier (see below), then it selects stream number +stream_index from the matching streams. Stream numbering is based on the +order of the streams as detected by libavformat except when a program ID is +also specified. In this case it is based on the ordering of the streams in the +program. +

+
stream_type[:additional_stream_specifier]
+

stream_type is one of following: ’v’ or ’V’ for video, ’a’ for audio, ’s’ +for subtitle, ’d’ for data, and ’t’ for attachments. ’v’ matches all video +streams, ’V’ only matches video streams which are not attached pictures, video +thumbnails or cover arts. If additional_stream_specifier is used, then +it matches streams which both have this type and match the +additional_stream_specifier. Otherwise, it matches all streams of the +specified type. +

+
p:program_id[:additional_stream_specifier]
+

Matches streams which are in the program with the id program_id. If +additional_stream_specifier is used, then it matches streams which both +are part of the program and match the additional_stream_specifier. +

+
+
#stream_id or i:stream_id
+

Match the stream by stream id (e.g. PID in MPEG-TS container). +

+
m:key[:value]
+

Matches streams with the metadata tag key having the specified value. If +value is not given, matches streams that contain the given tag with any +value. +

+
u
+

Matches streams with usable configuration, the codec must be defined and the +essential information such as video dimension or audio sample rate must be present. +

+

Note that in ffmpeg, matching by metadata will only work properly for +input files. +

+
+ + +

3.2 Generic options

+ +

These options are shared amongst the ff* tools. +

+
+
-L
+

Show license. +

+
+
-h, -?, -help, --help [arg]
+

Show help. An optional parameter may be specified to print help about a specific +item. If no argument is specified, only basic (non advanced) tool +options are shown. +

+

Possible values of arg are: +

+
long
+

Print advanced tool options in addition to the basic tool options. +

+
+
full
+

Print complete list of options, including shared and private options +for encoders, decoders, demuxers, muxers, filters, etc. +

+
+
decoder=decoder_name
+

Print detailed information about the decoder named decoder_name. Use the +-decoders option to get a list of all decoders. +

+
+
encoder=encoder_name
+

Print detailed information about the encoder named encoder_name. Use the +-encoders option to get a list of all encoders. +

+
+
demuxer=demuxer_name
+

Print detailed information about the demuxer named demuxer_name. Use the +-formats option to get a list of all demuxers and muxers. +

+
+
muxer=muxer_name
+

Print detailed information about the muxer named muxer_name. Use the +-formats option to get a list of all muxers and demuxers. +

+
+
filter=filter_name
+

Print detailed information about the filter name filter_name. Use the +-filters option to get a list of all filters. +

+
+
bsf=bitstream_filter_name
+

Print detailed information about the bitstream filter name bitstream_filter_name. +Use the -bsfs option to get a list of all bitstream filters. +

+
+ +
+
-version
+

Show version. +

+
+
-formats
+

Show available formats (including devices). +

+
+
-demuxers
+

Show available demuxers. +

+
+
-muxers
+

Show available muxers. +

+
+
-devices
+

Show available devices. +

+
+
-codecs
+

Show all codecs known to libavcodec. +

+

Note that the term ’codec’ is used throughout this documentation as a shortcut +for what is more correctly called a media bitstream format. +

+
+
-decoders
+

Show available decoders. +

+
+
-encoders
+

Show all available encoders. +

+
+
-bsfs
+

Show available bitstream filters. +

+
+
-protocols
+

Show available protocols. +

+
+
-filters
+

Show available libavfilter filters. +

+
+
-pix_fmts
+

Show available pixel formats. +

+
+
-sample_fmts
+

Show available sample formats. +

+
+
-layouts
+

Show channel names and standard channel layouts. +

+
+
-colors
+

Show recognized color names. +

+
+
-sources device[,opt1=val1[,opt2=val2]...]
+

Show autodetected sources of the input device. +Some devices may provide system-dependent source names that cannot be autodetected. +The returned list cannot be assumed to be always complete. +

+
ffmpeg -sources pulse,server=192.168.0.4
+
+ +
+
-sinks device[,opt1=val1[,opt2=val2]...]
+

Show autodetected sinks of the output device. +Some devices may provide system-dependent sink names that cannot be autodetected. +The returned list cannot be assumed to be always complete. +

+
ffmpeg -sinks pulse,server=192.168.0.4
+
+ +
+
-loglevel [flags+]loglevel | -v [flags+]loglevel
+

Set logging level and flags used by the library. +

+

The optional flags prefix can consist of the following values: +

+
‘repeat’
+

Indicates that repeated log output should not be compressed to the first line +and the "Last message repeated n times" line will be omitted. +

+
‘level’
+

Indicates that log output should add a [level] prefix to each message +line. This can be used as an alternative to log coloring, e.g. when dumping the +log to file. +

+
+

Flags can also be used alone by adding a ’+’/’-’ prefix to set/reset a single +flag without affecting other flags or changing loglevel. When +setting both flags and loglevel, a ’+’ separator is expected +between the last flags value and before loglevel. +

+

loglevel is a string or a number containing one of the following values: +

+
‘quiet, -8’
+

Show nothing at all; be silent. +

+
‘panic, 0’
+

Only show fatal errors which could lead the process to crash, such as +an assertion failure. This is not currently used for anything. +

+
‘fatal, 8’
+

Only show fatal errors. These are errors after which the process absolutely +cannot continue. +

+
‘error, 16’
+

Show all errors, including ones which can be recovered from. +

+
‘warning, 24’
+

Show all warnings and errors. Any message related to possibly +incorrect or unexpected events will be shown. +

+
‘info, 32’
+

Show informative messages during processing. This is in addition to +warnings and errors. This is the default value. +

+
‘verbose, 40’
+

Same as info, except more verbose. +

+
‘debug, 48’
+

Show everything, including debugging information. +

+
‘trace, 56’
+
+ +

For example to enable repeated log output, add the level prefix, and set +loglevel to verbose: +

+
ffmpeg -loglevel repeat+level+verbose -i input output
+
+

Another example that enables repeated log output without affecting current +state of level prefix flag or loglevel: +

+
ffmpeg [...] -loglevel +repeat
+
+ +

By default the program logs to stderr. If coloring is supported by the +terminal, colors are used to mark errors and warnings. Log coloring +can be disabled setting the environment variable +AV_LOG_FORCE_NOCOLOR, or can be forced setting +the environment variable AV_LOG_FORCE_COLOR. +

+
+
-report
+

Dump full command line and log output to a file named +program-YYYYMMDD-HHMMSS.log in the current +directory. +This file can be useful for bug reports. +It also implies -loglevel debug. +

+

Setting the environment variable FFREPORT to any value has the +same effect. If the value is a ’:’-separated key=value sequence, these +options will affect the report; option values must be escaped if they +contain special characters or the options delimiter ’:’ (see the +“Quoting and escaping” section in the ffmpeg-utils manual). +

+

The following options are recognized: +

+
file
+

set the file name to use for the report; %p is expanded to the name +of the program, %t is expanded to a timestamp, %% is expanded +to a plain % +

+
level
+

set the log verbosity level using a numerical value (see -loglevel). +

+
+ +

For example, to output a report to a file named ffreport.log +using a log level of 32 (alias for log level info): +

+
+
FFREPORT=file=ffreport.log:level=32 ffmpeg -i input output
+
+ +

Errors in parsing the environment variable are not fatal, and will not +appear in the report. +

+
+
-hide_banner
+

Suppress printing banner. +

+

All FFmpeg tools will normally show a copyright notice, build options +and library versions. This option can be used to suppress printing +this information. +

+
+
-cpuflags flags (global)
+

Allows setting and clearing cpu flags. This option is intended +for testing. Do not use it unless you know what you’re doing. +

+
ffmpeg -cpuflags -sse+mmx ...
+ffmpeg -cpuflags mmx ...
+ffmpeg -cpuflags 0 ...
+
+

Possible flags for this option are: +

+
‘x86’
+
+
‘mmx’
+
‘mmxext’
+
‘sse’
+
‘sse2’
+
‘sse2slow’
+
‘sse3’
+
‘sse3slow’
+
‘ssse3’
+
‘atom’
+
‘sse4.1’
+
‘sse4.2’
+
‘avx’
+
‘avx2’
+
‘xop’
+
‘fma3’
+
‘fma4’
+
‘3dnow’
+
‘3dnowext’
+
‘bmi1’
+
‘bmi2’
+
‘cmov’
+
+
+
‘ARM’
+
+
‘armv5te’
+
‘armv6’
+
‘armv6t2’
+
‘vfp’
+
‘vfpv3’
+
‘neon’
+
‘setend’
+
+
+
‘AArch64’
+
+
‘armv8’
+
‘vfp’
+
‘neon’
+
+
+
‘PowerPC’
+
+
‘altivec’
+
+
+
‘Specific Processors’
+
+
‘pentium2’
+
‘pentium3’
+
‘pentium4’
+
‘k6’
+
‘k62’
+
‘athlon’
+
‘athlonxp’
+
‘k8’
+
+
+
+
+
+ + +

3.3 AVOptions

+ +

These options are provided directly by the libavformat, libavdevice and +libavcodec libraries. To see the list of available AVOptions, use the +-help option. They are separated into two categories: +

+
generic
+

These options can be set for any container, codec or device. Generic options +are listed under AVFormatContext options for containers/devices and under +AVCodecContext options for codecs. +

+
private
+

These options are specific to the given container, device or codec. Private +options are listed under their corresponding containers/devices/codecs. +

+
+ +

For example to write an ID3v2.3 header instead of a default ID3v2.4 to +an MP3 file, use the id3v2_version private option of the MP3 +muxer: +

+
ffmpeg -i input.flac -id3v2_version 3 out.mp3
+
+ +

All codec AVOptions are per-stream, and thus a stream specifier +should be attached to them: +

+
ffmpeg -i multichannel.mxf -map 0:v:0 -map 0:a:0 -map 0:a:0 -c:a:0 ac3 -b:a:0 640k -ac:a:1 2 -c:a:1 aac -b:2 128k out.mp4
+
+ +

In the above example, a multichannel audio stream is mapped twice for output. +The first instance is encoded with codec ac3 and bitrate 640k. +The second instance is downmixed to 2 channels and encoded with codec aac. A bitrate of 128k is specified for it using +absolute index of the output stream. +

+

Note: the -nooption syntax cannot be used for boolean +AVOptions, use -option 0/-option 1. +

+

Note: the old undocumented way of specifying per-stream AVOptions by +prepending v/a/s to the options name is now obsolete and will be +removed soon. +

+ +

3.4 Main options

+ +
+
-f format
+

Force format to use. +

+
+
-unit
+

Show the unit of the displayed values. +

+
+
-prefix
+

Use SI prefixes for the displayed values. +Unless the "-byte_binary_prefix" option is used all the prefixes +are decimal. +

+
+
-byte_binary_prefix
+

Force the use of binary prefixes for byte values. +

+
+
-sexagesimal
+

Use sexagesimal format HH:MM:SS.MICROSECONDS for time values. +

+
+
-pretty
+

Prettify the format of the displayed values, it corresponds to the +options "-unit -prefix -byte_binary_prefix -sexagesimal". +

+
+
-of, -print_format writer_name[=writer_options]
+

Set the output printing format. +

+

writer_name specifies the name of the writer, and +writer_options specifies the options to be passed to the writer. +

+

For example for printing the output in JSON format, specify: +

+
-print_format json
+
+ +

For more details on the available output printing formats, see the +Writers section below. +

+
+
-sections
+

Print sections structure and section information, and exit. The output +is not meant to be parsed by a machine. +

+
+
-select_streams stream_specifier
+

Select only the streams specified by stream_specifier. This +option affects only the options related to streams +(e.g. show_streams, show_packets, etc.). +

+

For example to show only audio streams, you can use the command: +

+
ffprobe -show_streams -select_streams a INPUT
+
+ +

To show only video packets belonging to the video stream with index 1: +

+
ffprobe -show_packets -select_streams v:1 INPUT
+
+ +
+
-show_data
+

Show payload data, as a hexadecimal and ASCII dump. Coupled with +-show_packets, it will dump the packets’ data. Coupled with +-show_streams, it will dump the codec extradata. +

+

The dump is printed as the "data" field. It may contain newlines. +

+
+
-show_data_hash algorithm
+

Show a hash of payload data, for packets with -show_packets and for +codec extradata with -show_streams. +

+
+
-show_error
+

Show information about the error found when trying to probe the input. +

+

The error information is printed within a section with name "ERROR". +

+
+
-show_format
+

Show information about the container format of the input multimedia +stream. +

+

All the container format information is printed within a section with +name "FORMAT". +

+
+
-show_format_entry name
+

Like -show_format, but only prints the specified entry of the +container format information, rather than all. This option may be given more +than once, then all specified entries will be shown. +

+

This option is deprecated, use show_entries instead. +

+
+
-show_entries section_entries
+

Set list of entries to show. +

+

Entries are specified according to the following +syntax. section_entries contains a list of section entries +separated by :. Each section entry is composed by a section +name (or unique name), optionally followed by a list of entries local +to that section, separated by ,. +

+

If section name is specified but is followed by no =, all +entries are printed to output, together with all the contained +sections. Otherwise only the entries specified in the local section +entries list are printed. In particular, if = is specified but +the list of local entries is empty, then no entries will be shown for +that section. +

+

Note that the order of specification of the local section entries is +not honored in the output, and the usual display order will be +retained. +

+

The formal syntax is given by: +

+
LOCAL_SECTION_ENTRIES ::= SECTION_ENTRY_NAME[,LOCAL_SECTION_ENTRIES]
+SECTION_ENTRY         ::= SECTION_NAME[=[LOCAL_SECTION_ENTRIES]]
+SECTION_ENTRIES       ::= SECTION_ENTRY[:SECTION_ENTRIES]
+
+ +

For example, to show only the index and type of each stream, and the PTS +time, duration time, and stream index of the packets, you can specify +the argument: +

+
packet=pts_time,duration_time,stream_index : stream=index,codec_type
+
+ +

To show all the entries in the section "format", but only the codec +type in the section "stream", specify the argument: +

+
format : stream=codec_type
+
+ +

To show all the tags in the stream and format sections: +

+
stream_tags : format_tags
+
+ +

To show only the title tag (if available) in the stream +sections: +

+
stream_tags=title
+
+ +
+
-show_packets
+

Show information about each packet contained in the input multimedia +stream. +

+

The information for each single packet is printed within a dedicated +section with name "PACKET". +

+
+
-show_frames
+

Show information about each frame and subtitle contained in the input +multimedia stream. +

+

The information for each single frame is printed within a dedicated +section with name "FRAME" or "SUBTITLE". +

+
+
-show_log loglevel
+

Show logging information from the decoder about each frame according to +the value set in loglevel, (see -loglevel). This option requires -show_frames. +

+

The information for each log message is printed within a dedicated +section with name "LOG". +

+
+
-show_streams
+

Show information about each media stream contained in the input +multimedia stream. +

+

Each media stream information is printed within a dedicated section +with name "STREAM". +

+
+
-show_programs
+

Show information about programs and their streams contained in the input +multimedia stream. +

+

Each media stream information is printed within a dedicated section +with name "PROGRAM_STREAM". +

+
+
-show_chapters
+

Show information about chapters stored in the format. +

+

Each chapter is printed within a dedicated section with name "CHAPTER". +

+
+
-count_frames
+

Count the number of frames per stream and report it in the +corresponding stream section. +

+
+
-count_packets
+

Count the number of packets per stream and report it in the +corresponding stream section. +

+
+
-read_intervals read_intervals
+
+

Read only the specified intervals. read_intervals must be a +sequence of interval specifications separated by ",". +ffprobe will seek to the interval starting point, and will +continue reading from that. +

+

Each interval is specified by two optional parts, separated by "%". +

+

The first part specifies the interval start position. It is +interpreted as an absolute position, or as a relative offset from the +current position if it is preceded by the "+" character. If this first +part is not specified, no seeking will be performed when reading this +interval. +

+

The second part specifies the interval end position. It is interpreted +as an absolute position, or as a relative offset from the current +position if it is preceded by the "+" character. If the offset +specification starts with "#", it is interpreted as the number of +packets to read (not including the flushing packets) from the interval +start. If no second part is specified, the program will read until the +end of the input. +

+

Note that seeking is not accurate, thus the actual interval start +point may be different from the specified position. Also, when an +interval duration is specified, the absolute end time will be computed +by adding the duration to the interval start point found by seeking +the file, rather than to the specified start value. +

+

The formal syntax is given by: +

+
INTERVAL  ::= [START|+START_OFFSET][%[END|+END_OFFSET]]
+INTERVALS ::= INTERVAL[,INTERVALS]
+
+ +

A few examples follow. +

    +
  • Seek to time 10, read packets until 20 seconds after the found seek +point, then seek to position 01:30 (1 minute and thirty +seconds) and read packets until position 01:45. +
    +
    10%+20,01:30%01:45
+
    + +
  • Read only 42 packets after seeking to position 01:23: +
    +
    01:23%+#42
+
    + +
  • Read only the first 20 seconds from the start: +
    +
    %+20
+
    + +
  • Read from the start until position 02:30: +
    +
    %02:30
+
    +
+ +
+
-show_private_data, -private
+

Show private data, that is data depending on the format of the +particular shown element. +This option is enabled by default, but you may need to disable it +for specific uses, for example when creating XSD-compliant XML output. +

+
+
-show_program_version
+

Show information related to program version. +

+

Version information is printed within a section with name +"PROGRAM_VERSION". +

+
+
-show_library_versions
+

Show information related to library versions. +

+

Version information for each library is printed within a section with +name "LIBRARY_VERSION". +

+
+
-show_versions
+

Show information related to program and library versions. This is the +equivalent of setting both -show_program_version and +-show_library_versions options. +

+
+
-show_pixel_formats
+

Show information about all pixel formats supported by FFmpeg. +

+

Pixel format information for each format is printed within a section +with name "PIXEL_FORMAT". +

+
+
-bitexact
+

Force bitexact output, useful to produce output which is not dependent +on the specific build. +

+
+
-i input_url
+

Read input_url. +

+
+
+ + +

4 Writers

+ +

A writer defines the output format adopted by ffprobe, and will be +used for printing all the parts of the output. +

+

A writer may accept one or more arguments, which specify the options +to adopt. The options are specified as a list of key=value +pairs, separated by ":". +

+

All writers support the following options: +

+
+
string_validation, sv
+

Set string validation mode. +

+

The following values are accepted. +

+
‘fail’
+

The writer will fail immediately in case an invalid string (UTF-8) +sequence or code point is found in the input. This is especially +useful to validate input metadata. +

+
+
‘ignore’
+

Any validation error will be ignored. This will result in possibly +broken output, especially with the json or xml writer. +

+
+
‘replace’
+

The writer will substitute invalid UTF-8 sequences or code points with +the string specified with the string_validation_replacement. +

+
+ +

Default value is ‘replace’. +

+
+
string_validation_replacement, svr
+

Set replacement string to use in case string_validation is +set to ‘replace’. +

+

In case the option is not specified, the writer will assume the empty +string, that is it will remove the invalid sequences from the input +strings. +

+
+ +

A description of the currently available writers follows. +

+ +

4.1 default

+

Default format. +

+

Print each section in the form: +

+
[SECTION]
+key1=val1
+...
+keyN=valN
+[/SECTION]
+
+ +

Metadata tags are printed as a line in the corresponding FORMAT, STREAM or +PROGRAM_STREAM section, and are prefixed by the string "TAG:". +

+

A description of the accepted options follows. +

+
+
nokey, nk
+

If set to 1 specify not to print the key of each field. Default value +is 0. +

+
+
noprint_wrappers, nw
+

If set to 1 specify not to print the section header and footer. +Default value is 0. +

+
+ + +

4.2 compact, csv

+

Compact and CSV format. +

+

The csv writer is equivalent to compact, but supports +different defaults. +

+

Each section is printed on a single line. +If no option is specified, the output has the form: +

+
section|key1=val1| ... |keyN=valN
+
+ +

Metadata tags are printed in the corresponding "format" or "stream" +section. A metadata tag key, if printed, is prefixed by the string +"tag:". +

+

The description of the accepted options follows. +

+
+
item_sep, s
+

Specify the character to use for separating fields in the output line. +It must be a single printable character, it is "|" by default ("," for +the csv writer). +

+
+
nokey, nk
+

If set to 1 specify not to print the key of each field. Its default +value is 0 (1 for the csv writer). +

+
+
escape, e
+

Set the escape mode to use, default to "c" ("csv" for the csv +writer). +

+

It can assume one of the following values: +

+
c
+

Perform C-like escaping. Strings containing a newline (‘\n’), carriage +return (‘\r’), a tab (‘\t’), a form feed (‘\f’), the escaping +character (‘\’) or the item separator character SEP are escaped +using C-like fashioned escaping, so that a newline is converted to the +sequence ‘\n’, a carriage return to ‘\r’, ‘\’ to ‘\\’ and +the separator SEP is converted to ‘\SEP’. +

+
+
csv
+

Perform CSV-like escaping, as described in RFC4180. Strings +containing a newline (‘\n’), a carriage return (‘\r’), a double quote +(‘"’), or SEP are enclosed in double-quotes. +

+
+
none
+

Perform no escaping. +

+
+ +
+
print_section, p
+

Print the section name at the beginning of each line if the value is +1, disable it with value set to 0. Default value is +1. +

+
+
+ + +

4.3 flat

+

Flat format. +

+

A free-form output where each line contains an explicit key=value, such as +"streams.stream.3.tags.foo=bar". The output is shell escaped, so it can be +directly embedded in sh scripts as long as the separator character is an +alphanumeric character or an underscore (see sep_char option). +

+

The description of the accepted options follows. +

+
+
sep_char, s
+

Separator character used to separate the chapter, the section name, IDs and +potential tags in the printed field key. +

+

Default value is ‘.’. +

+
+
hierarchical, h
+

Specify if the section name specification should be hierarchical. If +set to 1, and if there is more than one section in the current +chapter, the section name will be prefixed by the name of the +chapter. A value of 0 will disable this behavior. +

+

Default value is 1. +

+
+ + +

4.4 ini

+

INI format output. +

+

Print output in an INI based format. +

+

The following conventions are adopted: +

+
    +
  • all key and values are UTF-8 +
  • ‘.’ is the subgroup separator +
  • newline, ‘\t’, ‘\f’, ‘\b’ and the following characters are +escaped +
  • ‘\’ is the escape character +
  • ‘#’ is the comment indicator +
  • ‘=’ is the key/value separator +
  • ‘:’ is not used but usually parsed as key/value separator +
+ +

This writer accepts options as a list of key=value pairs, +separated by ‘:’. +

+

The description of the accepted options follows. +

+
+
hierarchical, h
+

Specify if the section name specification should be hierarchical. If +set to 1, and if there is more than one section in the current +chapter, the section name will be prefixed by the name of the +chapter. A value of 0 will disable this behavior. +

+

Default value is 1. +

+
+ + +

4.5 json

+

JSON based format. +

+

Each section is printed using JSON notation. +

+

The description of the accepted options follows. +

+
+
compact, c
+

If set to 1 enable compact output, that is each section will be +printed on a single line. Default value is 0. +

+
+ +

For more information about JSON, see http://www.json.org/. +

+ +

4.6 xml

+

XML based format. +

+

The XML output is described in the XML schema description file +ffprobe.xsd installed in the FFmpeg datadir. +

+

An updated version of the schema can be retrieved at the url +http://www.ffmpeg.org/schema/ffprobe.xsd, which redirects to the +latest schema committed into the FFmpeg development source code tree. +

+

Note that the output issued will be compliant to the +ffprobe.xsd schema only when no special global output options +(unit, prefix, byte_binary_prefix, +sexagesimal etc.) are specified. +

+

The description of the accepted options follows. +

+
+
fully_qualified, q
+

If set to 1 specify if the output should be fully qualified. Default +value is 0. +This is required for generating an XML file which can be validated +through an XSD file. +

+
+
xsd_strict, x
+

If set to 1 perform more checks for ensuring that the output is XSD +compliant. Default value is 0. +This option automatically sets fully_qualified to 1. +

+
+ +

For more information about the XML format, see +https://www.w3.org/XML/. +

+ +

5 Timecode

+ +

ffprobe supports Timecode extraction: +

+
    +
  • MPEG1/2 timecode is extracted from the GOP, and is available in the video +stream details (-show_streams, see timecode). + +
  • MOV timecode is extracted from tmcd track, so is available in the tmcd +stream metadata (-show_streams, see TAG:timecode). + +
  • DV, GXF and AVI timecodes are available in format metadata +(-show_format, see TAG:timecode). + +
+ + + +

6 See Also

+ +

ffprobe-all, +ffmpeg, ffplay, +ffmpeg-utils, +ffmpeg-scaler, +ffmpeg-resampler, +ffmpeg-codecs, +ffmpeg-bitstream-filters, +ffmpeg-formats, +ffmpeg-devices, +ffmpeg-protocols, +ffmpeg-filters +

+ + +

7 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/general.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/general.html new file mode 100644 index 0000000..ce0db2a --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/general.html @@ -0,0 +1,1263 @@ + + + + + + + General Documentation + + + + + + +
+

+ General Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 External libraries

+ +

FFmpeg can be hooked up with a number of external libraries to add support +for more formats. None of them are used by default, their use has to be +explicitly requested by passing the appropriate flags to +./configure. +

+ +

1.1 Alliance for Open Media (AOM)

+ +

FFmpeg can make use of the AOM library for AV1 decoding and encoding. +

+

Go to http://aomedia.org/ and follow the instructions for +installing the library. Then pass --enable-libaom to configure to +enable it. +

+ +

1.2 AMD AMF/VCE

+ +

FFmpeg can use the AMD Advanced Media Framework library +for accelerated H.264 and HEVC(only windows) encoding on hardware with Video Coding Engine (VCE). +

+

To enable support you must obtain the AMF framework header files(version 1.4.9+) from +https://github.com/GPUOpen-LibrariesAndSDKs/AMF.git. +

+

Create an AMF/ directory in the system include path. +Copy the contents of AMF/amf/public/include/ into that directory. +Then configure FFmpeg with --enable-amf. +

+

Initialization of amf encoder occurs in this order: +1) trying to initialize through dx11(only windows) +2) trying to initialize through dx9(only windows) +3) trying to initialize through vulkan +

+

To use h.264(AMD VCE) encoder on linux amdgru-pro version 19.20+ and amf-amdgpu-pro +package(amdgru-pro contains, but does not install automatically) are required. +

+

This driver can be installed using amdgpu-pro-install script in official amd driver archive. +

+ +

1.3 AviSynth

+ +

FFmpeg can read AviSynth scripts as input. To enable support, pass +--enable-avisynth to configure after installing the headers +provided by AviSynth+. +AviSynth+ can be configured to install only the headers by either +passing -DHEADERS_ONLY:bool=on to the normal CMake-based build +system, or by using the supplied GNUmakefile. +

+

For Windows, supported AviSynth variants are +AviSynth 2.6 RC1 or higher for 32-bit builds and +AviSynth+ r1718 or higher for 32-bit and 64-bit builds. +

+

For Linux, macOS, and BSD, the only supported AviSynth variant is +AviSynth+, starting with version 3.5. +

+
+

In 2016, AviSynth+ added support for building with GCC. However, due to +the eccentricities of Windows’ calling conventions, 32-bit GCC builds +of AviSynth+ are not compatible with typical 32-bit builds of FFmpeg. +

+

By default, FFmpeg assumes compatibility with 32-bit MSVC builds of +AviSynth+ since that is the most widely-used and entrenched build +configuration. Users can override this and enable support for 32-bit +GCC builds of AviSynth+ by passing -DAVSC_WIN32_GCC32 to +--extra-cflags when configuring FFmpeg. +

+

64-bit builds of FFmpeg are not affected, and can use either MSVC or +GCC builds of AviSynth+ without any special flags. +

+
+

AviSynth(+) is loaded dynamically. Distributors can build FFmpeg +with --enable-avisynth, and the binaries will work regardless +of the end user having AviSynth installed. If/when an end user +would like to use AviSynth scripts, then they can install AviSynth(+) +and FFmpeg will be able to find and use it to open scripts. +

+ +

1.4 Chromaprint

+ +

FFmpeg can make use of the Chromaprint library for generating audio fingerprints. +Pass --enable-chromaprint to configure to +enable it. See https://acoustid.org/chromaprint. +

+ +

1.5 codec2

+ +

FFmpeg can make use of the codec2 library for codec2 decoding and encoding. +There is currently no native decoder, so libcodec2 must be used for decoding. +

+

Go to http://freedv.org/, download "Codec 2 source archive". +Build and install using CMake. Debian users can install the libcodec2-dev package instead. +Once libcodec2 is installed you can pass --enable-libcodec2 to configure to enable it. +

+

The easiest way to use codec2 is with .c2 files, since they contain the mode information required for decoding. +To encode such a file, use a .c2 file extension and give the libcodec2 encoder the -mode option: +ffmpeg -i input.wav -mode 700C output.c2. +Playback is as simple as ffplay output.c2. +For a list of supported modes, run ffmpeg -h encoder=libcodec2. +Raw codec2 files are also supported. +To make sense of them the mode in use needs to be specified as a format option: +ffmpeg -f codec2raw -mode 1300 -i input.raw output.wav. +

+ +

1.6 dav1d

+ +

FFmpeg can make use of the dav1d library for AV1 video decoding. +

+

Go to https://code.videolan.org/videolan/dav1d and follow the instructions for +installing the library. Then pass --enable-libdav1d to configure to enable it. +

+ +

1.7 davs2

+ +

FFmpeg can make use of the davs2 library for AVS2-P2/IEEE1857.4 video decoding. +

+

Go to https://github.com/pkuvcl/davs2 and follow the instructions for +installing the library. Then pass --enable-libdavs2 to configure to +enable it. +

+
+

libdavs2 is under the GNU Public License Version 2 or later +(see http://www.gnu.org/licenses/old-licenses/gpl-2.0.html for +details), you must upgrade FFmpeg’s license to GPL in order to use it. +

+ +

1.8 Game Music Emu

+ +

FFmpeg can make use of the Game Music Emu library to read audio from supported video game +music file formats. Pass --enable-libgme to configure to +enable it. See https://bitbucket.org/mpyne/game-music-emu/overview. +

+ +

1.9 Intel QuickSync Video

+ +

FFmpeg can use Intel QuickSync Video (QSV) for accelerated decoding and encoding +of multiple codecs. To use QSV, FFmpeg must be linked against the libmfx +dispatcher, which loads the actual decoding libraries. +

+

The dispatcher is open source and can be downloaded from +https://github.com/lu-zero/mfx_dispatch.git. FFmpeg needs to be configured +with the --enable-libmfx option and pkg-config needs to be able to +locate the dispatcher’s .pc files. +

+ +

1.10 Kvazaar

+ +

FFmpeg can make use of the Kvazaar library for HEVC encoding. +

+

Go to https://github.com/ultravideo/kvazaar and follow the +instructions for installing the library. Then pass +--enable-libkvazaar to configure to enable it. +

+ +

1.11 LAME

+ +

FFmpeg can make use of the LAME library for MP3 encoding. +

+

Go to http://lame.sourceforge.net/ and follow the +instructions for installing the library. +Then pass --enable-libmp3lame to configure to enable it. +

+ +

1.12 libilbc

+ +

iLBC is a narrowband speech codec that has been made freely available +by Google as part of the WebRTC project. libilbc is a packaging friendly +copy of the iLBC codec. FFmpeg can make use of the libilbc library for +iLBC decoding and encoding. +

+

Go to https://github.com/TimothyGu/libilbc and follow the instructions for +installing the library. Then pass --enable-libilbc to configure to +enable it. +

+ +

1.13 libvpx

+ +

FFmpeg can make use of the libvpx library for VP8/VP9 decoding and encoding. +

+

Go to http://www.webmproject.org/ and follow the instructions for +installing the library. Then pass --enable-libvpx to configure to +enable it. +

+ +

1.14 ModPlug

+ +

FFmpeg can make use of this library, originating in Modplug-XMMS, to read from MOD-like music files. +See https://github.com/Konstanty/libmodplug. Pass --enable-libmodplug to configure to +enable it. +

+ +

1.15 OpenCORE, VisualOn, and Fraunhofer libraries

+ +

Spun off Google Android sources, OpenCore, VisualOn and Fraunhofer +libraries provide encoders for a number of audio codecs. +

+
+

OpenCORE and VisualOn libraries are under the Apache License 2.0 +(see http://www.apache.org/licenses/LICENSE-2.0 for details), which is +incompatible to the LGPL version 2.1 and GPL version 2. You have to +upgrade FFmpeg’s license to LGPL version 3 (or if you have enabled +GPL components, GPL version 3) by passing --enable-version3 to configure in +order to use it. +

+

The license of the Fraunhofer AAC library is incompatible with the GPL. +Therefore, for GPL builds, you have to pass --enable-nonfree to +configure in order to use it. To the best of our knowledge, it is +compatible with the LGPL. +

+ +

1.15.1 OpenCORE AMR

+ +

FFmpeg can make use of the OpenCORE libraries for AMR-NB +decoding/encoding and AMR-WB decoding. +

+

Go to http://sourceforge.net/projects/opencore-amr/ and follow the +instructions for installing the libraries. +Then pass --enable-libopencore-amrnb and/or +--enable-libopencore-amrwb to configure to enable them. +

+ +

1.15.2 VisualOn AMR-WB encoder library

+ +

FFmpeg can make use of the VisualOn AMR-WBenc library for AMR-WB encoding. +

+

Go to http://sourceforge.net/projects/opencore-amr/ and follow the +instructions for installing the library. +Then pass --enable-libvo-amrwbenc to configure to enable it. +

+ +

1.15.3 Fraunhofer AAC library

+ +

FFmpeg can make use of the Fraunhofer AAC library for AAC decoding & encoding. +

+

Go to http://sourceforge.net/projects/opencore-amr/ and follow the +instructions for installing the library. +Then pass --enable-libfdk-aac to configure to enable it. +

+ +

1.16 OpenH264

+ +

FFmpeg can make use of the OpenH264 library for H.264 decoding and encoding. +

+

Go to http://www.openh264.org/ and follow the instructions for +installing the library. Then pass --enable-libopenh264 to configure to +enable it. +

+

For decoding, this library is much more limited than the built-in decoder +in libavcodec; currently, this library lacks support for decoding B-frames +and some other main/high profile features. (It currently only supports +constrained baseline profile and CABAC.) Using it is mostly useful for +testing and for taking advantage of Cisco’s patent portfolio license +(http://www.openh264.org/BINARY_LICENSE.txt). +

+ +

1.17 OpenJPEG

+ +

FFmpeg can use the OpenJPEG libraries for decoding/encoding J2K videos. Go to +http://www.openjpeg.org/ to get the libraries and follow the installation +instructions. To enable using OpenJPEG in FFmpeg, pass --enable-libopenjpeg to +./configure. +

+ +

1.18 rav1e

+ +

FFmpeg can make use of rav1e (Rust AV1 Encoder) via its C bindings to encode videos. +Go to https://github.com/xiph/rav1e/ and follow the instructions to build +the C library. To enable using rav1e in FFmpeg, pass --enable-librav1e +to ./configure. +

+ +

1.19 TwoLAME

+ +

FFmpeg can make use of the TwoLAME library for MP2 encoding. +

+

Go to http://www.twolame.org/ and follow the +instructions for installing the library. +Then pass --enable-libtwolame to configure to enable it. +

+ +

1.20 VapourSynth

+ +

FFmpeg can read VapourSynth scripts as input. To enable support, pass +--enable-vapoursynth to configure. Vapoursynth is detected via +pkg-config. Versions 42 or greater supported. +See http://www.vapoursynth.com/. +

+

Due to security concerns, Vapoursynth scripts will not +be autodetected so the input format has to be forced. For ff* CLI tools, +add -f vapoursynth before the input -i yourscript.vpy. +

+ +

1.21 WavPack

+ +

FFmpeg can make use of the libwavpack library for WavPack encoding. +

+

Go to http://www.wavpack.com/ and follow the instructions for +installing the library. Then pass --enable-libwavpack to configure to +enable it. +

+ +

1.22 x264

+ +

FFmpeg can make use of the x264 library for H.264 encoding. +

+

Go to http://www.videolan.org/developers/x264.html and follow the +instructions for installing the library. Then pass --enable-libx264 to +configure to enable it. +

+
+

x264 is under the GNU Public License Version 2 or later +(see http://www.gnu.org/licenses/old-licenses/gpl-2.0.html for +details), you must upgrade FFmpeg’s license to GPL in order to use it. +

+ +

1.23 x265

+ +

FFmpeg can make use of the x265 library for HEVC encoding. +

+

Go to http://x265.org/developers.html and follow the instructions +for installing the library. Then pass --enable-libx265 to configure +to enable it. +

+
+

x265 is under the GNU Public License Version 2 or later +(see http://www.gnu.org/licenses/old-licenses/gpl-2.0.html for +details), you must upgrade FFmpeg’s license to GPL in order to use it. +

+ +

1.24 xavs

+ +

FFmpeg can make use of the xavs library for AVS encoding. +

+

Go to http://xavs.sf.net/ and follow the instructions for +installing the library. Then pass --enable-libxavs to configure to +enable it. +

+ +

1.25 xavs2

+ +

FFmpeg can make use of the xavs2 library for AVS2-P2/IEEE1857.4 video encoding. +

+

Go to https://github.com/pkuvcl/xavs2 and follow the instructions for +installing the library. Then pass --enable-libxavs2 to configure to +enable it. +

+
+

libxavs2 is under the GNU Public License Version 2 or later +(see http://www.gnu.org/licenses/old-licenses/gpl-2.0.html for +details), you must upgrade FFmpeg’s license to GPL in order to use it. +

+ +

1.26 ZVBI

+ +

ZVBI is a VBI decoding library which can be used by FFmpeg to decode DVB +teletext pages and DVB teletext subtitles. +

+

Go to http://sourceforge.net/projects/zapping/ and follow the instructions for +installing the library. Then pass --enable-libzvbi to configure to +enable it. +

+ +

2 Supported File Formats, Codecs or Features

+ +

You can use the -formats and -codecs options to have an exhaustive list. +

+ +

2.1 File Formats

+ +

FFmpeg supports the following file formats through the libavformat +library: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameEncodingDecodingComments
3dostrX
4xmX4X Technologies format, used in some games.
8088flex TMVX
AAXXAudible Enhanced Audio format, used in audiobooks.
AAXAudible Format 2, 3, and 4, used in audiobooks.
ACT VoiceXcontains G.729 audio
Adobe FilmstripXX
Audio IFF (AIFF)XX
American Laser Games MMXMultimedia format used in games like Mad Dog McCree.
3GPP AMRXX
Amazing Studio Packed Animation FileXMultimedia format used in game Heart Of Darkness.
Apple HTTP Live StreamingX
Artworx Data FormatX
Interplay ACMXAudio only format used in some Interplay games.
ADPXAudio format used on the Nintendo Gamecube.
AFCXAudio format used on the Nintendo Gamecube.
ADS/SS2XAudio format used on the PS2.
APNGXX
ASFXX
ASTXXAudio format used on the Nintendo Wii.
AVIXX
AviSynthX
AVRXAudio format used on Mac.
AVSXMultimedia format used by the Creature Shock game.
Beam Software SIFFXAudio and video format used in some games by Beam Software.
Bethesda Softworks VIDXUsed in some games from Bethesda Softworks.
Binary textX
BinkXMultimedia format used by many games.
Bitmap Brothers JVXUsed in Z and Z95 games.
Brute Force & IgnoranceXUsed in the game Flash Traffic: City of Angels.
BFSTMXAudio format used on the Nintendo WiiU (based on BRSTM).
BRSTMXAudio format used on the Nintendo Wii.
BWFXX
codec2 (raw)XXMust be given -mode format option to decode correctly.
codec2 (.c2 files)XXContains header with version and mode info, simplifying playback.
CRI ADXXXAudio-only format used in console video games.
CRI AIXX
CRI HCAXAudio-only format used in console video games.
Discworld II BMVX
Interplay C93XUsed in the game Cyberia from Interplay.
Delphine Software International CINXMultimedia format used by Delphine Software games.
Digital Speech Standard (DSS)X
Canopus HQX
Canopus HQAX
Canopus HQXX
CD+GXVideo format used by CD+G karaoke disks
Phantom CineX
Cineform HDX
Commodore CDXLXAmiga CD video format
Core Audio FormatXXApple Core Audio Format
CRC testing formatX
Creative VoiceXXCreated for the Sound Blaster Pro.
CRYO APCXAudio format used in some games by CRYO Interactive Entertainment.
D-Cinema audioXX
Deluxe Paint AnimationX
DCSTRX
DFAXThis format is used in Chronomaster game
DirectDraw SurfaceX
DSD Stream File (DSF)X
DV videoXX
DXAXThis format is used in the non-Windows version of the Feeble Files + game and different game cutscenes repacked for use with ScummVM.
Electronic Arts cdataX
Electronic Arts MultimediaXUsed in various EA games; files have extensions like WVE and UV2.
Ensoniq Paris Audio FileX
FFM (FFserver live feed)XX
Flash (SWF)XX
Flash 9 (AVM2)XXOnly embedded audio is decoded.
FLI/FLC/FLX animationX.fli/.flc files
Flash Video (FLV)XXMacromedia Flash video files
framecrc testing formatX
FunCom ISSXAudio format used in various games from FunCom like The Longest Journey.
G.723.1XX
G.726XBoth left- and right-justified.
G.729 BITXX
G.729 rawX
GENHXAudio format for various games.
GIF AnimationXX
GXFXXGeneral eXchange Format SMPTE 360M, used by Thomson Grass Valley + playout servers.
HNMXOnly version 4 supported, used in some games from Cryo Interactive
iCEDraw FileX
ICOXXMicrosoft Windows ICO
id Quake II CIN videoX
id RoQXXUsed in Quake III, Jedi Knight 2 and other computer games.
IEC61937 encapsulationXX
IFFXInterchange File Format
IFVXA format used by some old CCTV DVRs.
iLBCXX
Interplay MVEXFormat used in various Interplay computer games.
Iterated Systems ClearVideoXI-frames only
IV8XA format generated by IndigoVision 8000 video server.
IVF (On2)XXA format used by libvpx
Internet Video RecordingX
IRCAMXX
LATMXX
LMLM4XUsed by Linux Media Labs MPEG-4 PCI boards
LOASXcontains LATM multiplexed AAC audio
LRCXX
LVFX
LXFXVR native stream format, used by Leitch/Harris’ video servers.
Magic Lantern Video (MLV)X
MatroskaXX
Matroska audioX
FFmpeg metadataXXMetadata in text format.
MAXIS XAXUsed in Sim City 3000; file extension .xa.
MD StudioX
Metal Gear Solid: The Twin SnakesX
Megalux FrameXUsed by Megalux Ultimate Paint
Mobotix .mxgX
Monkey’s AudioX
Motion Pixels MVIX
MOV/QuickTime/MP4XX3GP, 3GP2, PSP, iPod variants supported
MP2XX
MP3XX
MPEG-1 SystemXXmuxed audio and video, VCD format supported
MPEG-PS (program stream)XXalso known as VOB file, SVCD and DVD format supported
MPEG-TS (transport stream)XXalso known as DVB Transport Stream
MPEG-4XXMPEG-4 is a variant of QuickTime.
MSFXAudio format used on the PS3.
Mirillis FIC videoXNo cursor rendering.
MIDI Sample Dump StandardX
MIME multipart JPEGX
MSN TCP webcamXUsed by MSN Messenger webcam streams.
MTVX
MusepackX
Musepack SV8X
Material eXchange Format (MXF)XXSMPTE 377M, used by D-Cinema, broadcast industry.
Material eXchange Format (MXF), D-10 MappingXXSMPTE 386M, D-10/IMX Mapping.
NC camera feedXNC (AVIP NC4600) camera streams
NIST SPeech HEader REsourcesX
Computerized Speech Lab NSPX
NTT TwinVQ (VQF)XNippon Telegraph and Telephone Corporation TwinVQ.
Nullsoft Streaming VideoX
NuppelVideoX
NUTXXNUT Open Container Format
OggXX
Playstation Portable PMPX
Portable Voice FormatX
TechnoTrend PVAXUsed by TechnoTrend DVB PCI boards.
QCPX
raw ADTS (AAC)XX
raw AC-3XX
raw AMR-NBX
raw AMR-WBX
raw aptXXX
raw aptX HDXX
raw Chinese AVS videoXX
raw DiracXX
raw DNxHDXX
raw DTSXX
raw DTS-HDX
raw E-AC-3XX
raw FLACXX
raw GSMX
raw H.261XX
raw H.263XX
raw H.264XX
raw HEVCXX
raw Ingenient MJPEGX
raw MJPEGXX
raw MLPX
raw MPEGX
raw MPEG-1X
raw MPEG-2X
raw MPEG-4XX
raw NULLX
raw videoXX
raw id RoQX
raw SBCXX
raw ShortenX
raw TAKX
raw TrueHDXX
raw VC-1XX
raw PCM A-lawXX
raw PCM mu-lawXX
raw PCM Archimedes VIDCXX
raw PCM signed 8 bitXX
raw PCM signed 16 bit big-endianXX
raw PCM signed 16 bit little-endianXX
raw PCM signed 24 bit big-endianXX
raw PCM signed 24 bit little-endianXX
raw PCM signed 32 bit big-endianXX
raw PCM signed 32 bit little-endianXX
raw PCM signed 64 bit big-endianXX
raw PCM signed 64 bit little-endianXX
raw PCM unsigned 8 bitXX
raw PCM unsigned 16 bit big-endianXX
raw PCM unsigned 16 bit little-endianXX
raw PCM unsigned 24 bit big-endianXX
raw PCM unsigned 24 bit little-endianXX
raw PCM unsigned 32 bit big-endianXX
raw PCM unsigned 32 bit little-endianXX
raw PCM 16.8 floating point little-endianX
raw PCM 24.0 floating point little-endianX
raw PCM floating-point 32 bit big-endianXX
raw PCM floating-point 32 bit little-endianXX
raw PCM floating-point 64 bit big-endianXX
raw PCM floating-point 64 bit little-endianXX
RDTX
REDCODE R3DXFile format used by RED Digital cameras, contains JPEG 2000 frames and PCM audio.
RealMediaXX
RedirectorX
RedSparkX
Renderware TeXture DictionaryX
Resolume DXVX
RL2XAudio and video format used in some games by Entertainment Software Partners.
RPL/ARMovieX
Lego Mindstorms RSOXX
RSDX
RTMPXXOutput is performed by publishing stream to RTMP server
RTPXX
RTSPXX
Sample Dump eXchangeX
SAPXX
SBGX
SDPX
SERX
Sega FILM/CPKXXUsed in many Sega Saturn console games.
Silicon Graphics MovieX
Sierra SOLX.sol files used in Sierra Online games.
Sierra VMDXUsed in Sierra CD-ROM games.
SmackerXMultimedia format used by many games.
SMJPEGXXUsed in certain Loki game ports.
SMPTE 337M encapsulationX
SmushXMultimedia format used in some LucasArts games.
Sony OpenMG (OMA)XXAudio format used in Sony Sonic Stage and Sony Vegas.
Sony PlayStation STRX
Sony Wave64 (W64)XX
SoX native formatXX
SUN AU formatXX
SUP raw PGS subtitlesXX
SVAGXAudio format used in Konami PS2 games.
TDSCX
Text filesX
THPXUsed on the Nintendo GameCube.
Tiertex Limited SEQXTiertex .seq files used in the DOS CD-ROM version of the game Flashback.
True AudioXX
VAGXAudio format used in many Sony PS2 games.
VC-1 test bitstreamXX
Vidvox HapXX
VivoX
VPKXAudio format used in Sony PS games.
WAVXX
WavPackXX
WebMXX
Windows Televison (WTV)XX
Wing Commander III movieXMultimedia format used in Origin’s Wing Commander III computer game.
Westwood Studios audioXMultimedia format used in Westwood Studios games.
Westwood Studios VQAXMultimedia format used in Westwood Studios games.
Wideband Single-bit Data (WSD)X
WVEX
XMVXMicrosoft video container used in Xbox games.
XVAGXAudio format used on the PS3.
xWMAXMicrosoft audio container used by XAudio 2.
eXtended BINary text (XBIN)X
YUV4MPEG pipeXX
Psygnosis YOPX
+ +

X means that the feature in that column (encoding / decoding) is supported. +

+ +

2.2 Image Formats

+ +

FFmpeg can read and write images for each frame of a video sequence. The +following image formats are supported: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameEncodingDecodingComments
.Y.U.VXXone raw file per component
Alias PIXXXAlias/Wavefront PIX image format
animated GIFXX
APNGXX
BMPXXMicrosoft BMP image
BRender PIXXArgonaut BRender 3D engine image format.
DPXXXDigital Picture Exchange
EXRXOpenEXR
FITSXXFlexible Image Transport System
JPEGXXProgressive JPEG is not supported.
JPEG 2000XX
JPEG-LSXX
LJPEGXLossless JPEG
PAMXXPAM is a PNM extension with alpha support.
PBMXXPortable BitMap image
PCXXXPC Paintbrush
PGMXXPortable GrayMap image
PGMYUVXXPGM with U and V components in YUV 4:2:0
PICXPictor/PC Paint
PNGXX
PPMXXPortable PixelMap image
PSDXPhotoshop
PTXXV.Flash PTX format
SGIXXSGI RGB image format
Sun RasterfileXXSun RAS image format
TIFFXXYUV, JPEG and some extension is not supported yet.
Truevision TargaXXTarga (.TGA) image format
WebPEXWebP image format, encoding supported through external library libwebp
XBMXXX BitMap image format
XFaceXXX-Face image format
XPMXX PixMap image format
XWDXXX Window Dump image format
+ +

X means that the feature in that column (encoding / decoding) is supported. +

+

E means that support is provided through an external library. +

+ +

2.3 Video Codecs

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameEncodingDecodingComments
4X MovieXUsed in certain computer games.
8088flex TMVX
A64 multicolorXCreates video suitable to be played on a commodore 64 (multicolor mode).
Amazing Studio PAF VideoX
American Laser Games MMXUsed in games like Mad Dog McCree.
AMV VideoXXUsed in Chinese MP3 players.
ANSI/ASCII artX
Apple Intermediate CodecX
Apple MJPEG-BX
Apple PixletX
Apple ProResXX
Apple QuickDrawXfourcc: qdrw
Asus v1XXfourcc: ASV1
Asus v2XXfourcc: ASV2
ATI VCR1Xfourcc: VCR1
ATI VCR2Xfourcc: VCR2
Auravision AuraX
Auravision Aura 2X
Autodesk Animator Flic videoX
Autodesk RLEXfourcc: AASC
AV1EESupported through external libraries libaom, libdav1d and librav1e
Avid 1:1 10-bit RGB PackerXXfourcc: AVrp
AVS (Audio Video Standard) videoXVideo encoding used by the Creature Shock game.
AVS2-P2/IEEE1857.4EESupported through external libraries libxavs2 and libdavs2
AYUVXXMicrosoft uncompressed packed 4:4:4:4
Beam Software VBX
Bethesda VID videoXUsed in some games from Bethesda Softworks.
Bink VideoX
BitJazz SheerVideoX
Bitmap Brothers JV videoX
y41p Brooktree uncompressed 4:1:1 12-bitXX
Brute Force & IgnoranceXUsed in the game Flash Traffic: City of Angels.
C93 videoXCodec used in Cyberia game.
CamStudioXfourcc: CSCD
CD+GXVideo codec for CD+G karaoke disks
CDXLXAmiga CD video codec
Chinese AVS videoEXAVS1-P2, JiZhun profile, encoding through external library libxavs
Delphine Software International CIN videoXCodec used in Delphine Software International games.
Discworld II BMV VideoX
Canopus Lossless CodecX
CDToonsXCodec used in various Broderbund games.
CinepakX
Cirrus Logic AccuPakXXfourcc: CLJR
CPiA Video FormatX
Creative YUV (CYUV)X
DFAXCodec used in Chronomaster game.
DiracEXsupported though the native vc2 (Dirac Pro) encoder
Deluxe Paint AnimationX
DNxHDXXaka SMPTE VC3
Duck TrueMotion 1.0Xfourcc: DUCK
Duck TrueMotion 2.0Xfourcc: TM20
Duck TrueMotion 2.0 RTXfourcc: TR20
DV (Digital Video)XX
Dxtory capture formatX
Feeble Files/ScummVM DXAXCodec originally used in Feeble Files game.
Electronic Arts CMV videoXUsed in NHL 95 game.
Electronic Arts Madcow videoX
Electronic Arts TGV videoX
Electronic Arts TGQ videoX
Electronic Arts TQI videoX
Escape 124X
Escape 130X
FFmpeg video codec #1XXlossless codec (fourcc: FFV1)
Flash Screen Video v1XXfourcc: FSV1
Flash Screen Video v2XX
Flash Video (FLV)XXSorenson H.263 used in Flash
FM Screen Capture CodecX
Forward UncompressedX
FrapsX
Go2MeetingXfourcc: G2M2, G2M3
Go2WebinarXfourcc: G2M4
Gremlin Digital VideoX
H.261XX
H.263 / H.263-1996XX
H.263+ / H.263-1998 / H.263 version 2XX
H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10EXencoding supported through external library libx264 and OpenH264
HEVCXXencoding supported through external library libx265 and libkvazaar
HNM version 4X
HuffYUVXX
HuffYUV FFmpeg variantXX
IBM UltimotionXfourcc: ULTI
id Cinematic videoXUsed in Quake II.
id RoQ videoXXUsed in Quake III, Jedi Knight 2, other computer games.
IFF ILBMXIFF interleaved bitmap
IFF ByteRun1XIFF run length encoded bitmap
Infinity IMM4X
Intel H.263X
Intel Indeo 2X
Intel Indeo 3X
Intel Indeo 4X
Intel Indeo 5X
Interplay C93XUsed in the game Cyberia from Interplay.
Interplay MVE videoXUsed in Interplay .MVE files.
J2KXX
Karl Morton’s video codecXCodec used in Worms games.
Kega Game Video (KGV1)XKega emulator screen capture codec.
LagarithX
LCL (LossLess Codec Library) MSZHX
LCL (LossLess Codec Library) ZLIBEE
LOCOX
LucasArts SANM/SmushXUsed in LucasArts games / SMUSH animations.
lossless MJPEGXX
MagicYUV VideoXX
Mandsoft Screen Capture CodecX
Microsoft ATC ScreenXAlso known as Microsoft Screen 3.
Microsoft Expression Encoder ScreenXAlso known as Microsoft Titanium Screen 2.
Microsoft RLEX
Microsoft Screen 1XAlso known as Windows Media Video V7 Screen.
Microsoft Screen 2XAlso known as Windows Media Video V9 Screen.
Microsoft Video 1X
MimicXUsed in MSN Messenger Webcam streams.
Miro VideoXLXfourcc: VIXL
MJPEG (Motion JPEG)XX
Mobotix MxPEG videoX
Motion Pixels videoX
MPEG-1 videoXX
MPEG-2 videoXX
MPEG-4 part 2XXlibxvidcore can be used alternatively for encoding.
MPEG-4 part 2 Microsoft variant version 1X
MPEG-4 part 2 Microsoft variant version 2XX
MPEG-4 part 2 Microsoft variant version 3XX
Newtek SpeedHQX
Nintendo Gamecube THP videoX
NuppelVideo/RTjpegXVideo encoding used in NuppelVideo files.
On2 VP3Xstill experimental
On2 VP4Xfourcc: VP40
On2 VP5Xfourcc: VP50
On2 VP6Xfourcc: VP60,VP61,VP62
On2 VP7Xfourcc: VP70,VP71
VP8EXfourcc: VP80, encoding supported through external library libvpx
VP9EXencoding supported through external library libvpx
Pinnacle TARGA CineWave YUV16Xfourcc: Y216
ProresXfourcc: apch,apcn,apcs,apco
Q-team QPEGXfourccs: QPEG, Q1.0, Q1.1
QuickTime 8BPS videoX
QuickTime Animation (RLE) videoXXfourcc: ’rle ’
QuickTime Graphics (SMC)Xfourcc: ’smc ’
QuickTime video (RPZA)Xfourcc: rpza
R10K AJA Kona 10-bit RGB CodecXX
R210 Quicktime Uncompressed RGB 10-bitXX
Raw VideoXX
RealVideo 1.0XX
RealVideo 2.0XX
RealVideo 3.0Xstill far from ideal
RealVideo 4.0X
Renderware TXD (TeXture Dictionary)XTexture dictionaries used by the Renderware Engine.
RL2 videoXused in some games by Entertainment Software Partners
ScreenPressorX
ScreenpressoX
Screen Recorder Gold CodecX
Sierra VMD videoXUsed in Sierra VMD files.
Silicon Graphics Motion Video Compressor 1 (MVC1)X
Silicon Graphics Motion Video Compressor 2 (MVC2)X
Silicon Graphics RLE 8-bit videoX
Smacker videoXVideo encoding used in Smacker.
SMPTE VC-1X
SnowXXexperimental wavelet codec (fourcc: SNOW)
Sony PlayStation MDEC (Motion DECoder)X
Sorenson Vector Quantizer 1XXfourcc: SVQ1
Sorenson Vector Quantizer 3Xfourcc: SVQ3
Sunplus JPEG (SP5X)Xfourcc: SP5X
TechSmith Screen Capture CodecXfourcc: TSCC
TechSmith Screen Capture Codec 2Xfourcc: TSC2
TheoraEXencoding supported through external library libtheora
Tiertex Limited SEQ videoXCodec used in DOS CD-ROM FlashBack game.
Ut VideoXX
v210 QuickTime uncompressed 4:2:2 10-bitXX
v308 QuickTime uncompressed 4:4:4XX
v408 QuickTime uncompressed 4:4:4:4XX
v410 QuickTime uncompressed 4:4:4 10-bitXX
VBLE Lossless CodecX
VMware Screen Codec / VMware VideoXCodec used in videos captured by VMware.
Westwood Studios VQA (Vector Quantized Animation) videoX
Windows Media ImageX
Windows Media Video 7XX
Windows Media Video 8XX
Windows Media Video 9Xnot completely working
Wing Commander III / XanXUsed in Wing Commander III .MVE files.
Wing Commander IV / XanXUsed in Wing Commander IV.
Winnov WNV1X
WMV7XX
YAMAHA SMAFXX
Psygnosis YOP VideoX
yuv4XXlibquicktime uncompressed packed 4:2:0
ZeroCodec Lossless VideoX
ZLIBXXpart of LCL, encoder experimental
Zip Motion Blocks VideoXXEncoder works only in PAL8.
+ +

X means that the feature in that column (encoding / decoding) is supported. +

+

E means that support is provided through an external library. +

+ +

2.4 Audio Codecs

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameEncodingDecodingComments
8SVX exponentialX
8SVX fibonacciX
AACEXXencoding supported through internal encoder and external library libfdk-aac
AAC+EIXencoding supported through external library libfdk-aac
AC-3IXIX
ACELP.KELVINX
ADPCM 4X MovieX
APDCM Yamaha AICAX
ADPCM Argonaut GamesX
ADPCM CDROM XAX
ADPCM Creative TechnologyX16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
ADPCM Electronic ArtsXUsed in various EA titles.
ADPCM Electronic Arts Maxis CDROM XSXUsed in Sim City 3000.
ADPCM Electronic Arts R1X
ADPCM Electronic Arts R2X
ADPCM Electronic Arts R3X
ADPCM Electronic Arts XASX
ADPCM G.722XX
ADPCM G.726XX
ADPCM IMA AMVXUsed in AMV files
ADPCM IMA Cunning DevelopmentsX
ADPCM IMA Electronic Arts EACSX
ADPCM IMA Electronic Arts SEADX
ADPCM IMA FuncomX
ADPCM IMA High Voltage Software ALPX
ADPCM IMA QuickTimeXX
ADPCM IMA Simon & Schuster InteractiveXX
ADPCM IMA Ubisoft APMX
ADPCM IMA Loki SDL MJPEGX
ADPCM IMA WAVXX
ADPCM IMA WestwoodX
ADPCM ISS IMAXUsed in FunCom games.
ADPCM IMA DialogicX
ADPCM IMA Duck DK3XUsed in some Sega Saturn console games.
ADPCM IMA Duck DK4XUsed in some Sega Saturn console games.
ADPCM IMA RadicalX
ADPCM MicrosoftXX
ADPCM MS IMAXX
ADPCM Nintendo Gamecube AFCX
ADPCM Nintendo Gamecube DTKX
ADPCM Nintendo THPX
APDCM PlaystationX
ADPCM QT IMAXX
ADPCM SEGA CRI ADXXXUsed in Sega Dreamcast games.
ADPCM Shockwave FlashXX
ADPCM Sound Blaster Pro 2-bitX
ADPCM Sound Blaster Pro 2.6-bitX
ADPCM Sound Blaster Pro 4-bitX
ADPCM VIMAXUsed in LucasArts SMUSH animations.
ADPCM Westwood Studios IMAXUsed in Westwood Studios games like Command and Conquer.
ADPCM YamahaXX
ADPCM ZorkX
AMR-NBEXencoding supported through external library libopencore-amrnb
AMR-WBEXencoding supported through external library libvo-amrwbenc
Amazing Studio PAF AudioX
Apple lossless audioXXQuickTime fourcc ’alac’
aptXXXUsed in Bluetooth A2DP
aptX HDXXUsed in Bluetooth A2DP
ATRAC1X
ATRAC3X
ATRAC3+X
ATRAC9X
Bink AudioXUsed in Bink and Smacker files in many games.
CELTEdecoding supported through external library libcelt
codec2EEen/decoding supported through external library libcodec2
CRI HCAX
Delphine Software International CIN audioXCodec used in Delphine Software International games.
Digital Speech Standard - Standard Play mode (DSS SP)X
Discworld II BMV AudioX
COOKXAll versions except 5.1 are supported.
DCA (DTS Coherent Acoustics)XXsupported extensions: XCh, XXCH, X96, XBR, XLL, LBR (partially)
Dolby EX
DPCM GremlinX
DPCM id RoQXXUsed in Quake III, Jedi Knight 2 and other computer games.
DPCM InterplayXUsed in various Interplay computer games.
DPCM Squareroot-Delta-ExactXUsed in various games.
DPCM Sierra OnlineXUsed in Sierra Online game audio files.
DPCM SolX
DPCM XanXUsed in Origin’s Wing Commander IV AVI files.
DPCM Xilam DERFX
DSD (Direct Stream Digital), least significant bit firstX
DSD (Direct Stream Digital), most significant bit firstX
DSD (Direct Stream Digital), least significant bit first, planarX
DSD (Direct Stream Digital), most significant bit first, planarX
DSP Group TrueSpeechX
DST (Direct Stream Transfer)X
DV audioX
Enhanced AC-3XX
EVRC (Enhanced Variable Rate Codec)X
FLAC (Free Lossless Audio Codec)XIX
G.723.1XX
G.729X
GSMEXencoding supported through external library libgsm
GSM Microsoft variantEXencoding supported through external library libgsm
IAC (Indeo Audio Coder)X
iLBC (Internet Low Bitrate Codec)EEencoding and decoding supported through external library libilbc
IMC (Intel Music Coder)X
Interplay ACMX
MACE (Macintosh Audio Compression/Expansion) 3:1X
MACE (Macintosh Audio Compression/Expansion) 6:1X
MLP (Meridian Lossless Packing)XXUsed in DVD-Audio discs.
Monkey’s AudioX
MP1 (MPEG audio layer 1)IX
MP2 (MPEG audio layer 2)IXIXencoding supported also through external library TwoLAME
MP3 (MPEG audio layer 3)EIXencoding supported through external library LAME, ADU MP3 and MP3onMP4 also supported
MPEG-4 Audio Lossless Coding (ALS)X
Musepack SV7X
Musepack SV8X
Nellymoser AsaoXX
On2 AVC (Audio for Video Codec)X
OpusEXencoding supported through external library libopus
PCM A-lawXX
PCM mu-lawXX
PCM Archimedes VIDCXX
PCM signed 8-bit planarXX
PCM signed 16-bit big-endian planarXX
PCM signed 16-bit little-endian planarXX
PCM signed 24-bit little-endian planarXX
PCM signed 32-bit little-endian planarXX
PCM 32-bit floating point big-endianXX
PCM 32-bit floating point little-endianXX
PCM 64-bit floating point big-endianXX
PCM 64-bit floating point little-endianXX
PCM D-Cinema audio signed 24-bitXX
PCM signed 8-bitXX
PCM signed 16-bit big-endianXX
PCM signed 16-bit little-endianXX
PCM signed 24-bit big-endianXX
PCM signed 24-bit little-endianXX
PCM signed 32-bit big-endianXX
PCM signed 32-bit little-endianXX
PCM signed 16/20/24-bit big-endian in MPEG-TSX
PCM unsigned 8-bitXX
PCM unsigned 16-bit big-endianXX
PCM unsigned 16-bit little-endianXX
PCM unsigned 24-bit big-endianXX
PCM unsigned 24-bit little-endianXX
PCM unsigned 32-bit big-endianXX
PCM unsigned 32-bit little-endianXX
QCELP / PureVoiceX
QDesign Music Codec 1X
QDesign Music Codec 2XThere are still some distortions.
RealAudio 1.0 (14.4K)XXReal 14400 bit/s codec
RealAudio 2.0 (28.8K)XReal 28800 bit/s codec
RealAudio 3.0 (dnet)IXXReal low bitrate AC-3 codec
RealAudio LosslessX
RealAudio SIPR / ACELP.NETX
SBC (low-complexity subband codec)XXUsed in Bluetooth A2DP
ShortenX
Sierra VMD audioXUsed in Sierra VMD files.
Smacker audioX
SMPTE 302M AES3 audioXX
SonicXXexperimental codec
Sonic losslessXXexperimental codec
SpeexEEsupported through external library libspeex
TAK (Tom’s lossless Audio Kompressor)X
True Audio (TTA)XX
TrueHDXXUsed in HD-DVD and Blu-Ray discs.
TwinVQ (VQF flavor)X
VIMAXUsed in LucasArts SMUSH animations.
VorbisEXA native but very primitive encoder exists.
Voxware MetaSoundX
WavPackXX
Westwood Audio (SND1)X
Windows Media Audio 1XX
Windows Media Audio 2XX
Windows Media Audio LosslessX
Windows Media Audio ProX
Windows Media Audio VoiceX
Xbox Media Audio 1X
Xbox Media Audio 2X
+ +

X means that the feature in that column (encoding / decoding) is supported. +

+

E means that support is provided through an external library. +

+

I means that an integer-only version is available, too (ensures high +performance on systems without hardware floating point support). +

+ +

2.5 Subtitle Formats

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameMuxingDemuxingEncodingDecoding
3GPP Timed TextXX
AQTitleXX
DVBXXXX
DVB teletextXE
DVDXXXX
JACOsubXXX
MicroDVDXXX
MPL2XX
MPsub (MPlayer)XX
PGSX
PJS (Phoenix)XX
RealTextXX
SAMIXX
Spruce format (STL)XX
SSA/ASSXXXX
SubRip (SRT)XXXX
SubViewer v1XX
SubViewerXX
TED Talks captionsXX
VobSub (IDX+SUB)XX
VPlayerXX
WebVTTXXXX
XSUBXX
+ +

X means that the feature is supported. +

+

E means that support is provided through an external library. +

+ +

2.6 Network Protocols

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSupport
AMQPE
fileX
FTPX
GopherX
HLSX
HTTPX
HTTPSX
IcecastX
MMSHX
MMSTX
pipeX
Pro-MPEG FECX
RTMPX
RTMPEX
RTMPSX
RTMPTX
RTMPTEX
RTMPTSX
RTPX
SAMBAE
SCTPX
SFTPE
TCPX
TLSX
UDPX
ZMQE
+ +

X means that the protocol is supported. +

+

E means that support is provided through an external library. +

+ + +

2.7 Input/Output Devices

+ + + + + + + + + + + + + + + + + + + + + +
NameInputOutput
ALSAXX
BKTRX
cacaX
DV1394X
Lavfi virtual deviceX
Linux framebufferXX
JACKX
LIBCDIOX
LIBDC1394X
OpenALX
OpenGLX
OSSXX
PulseAudioXX
SDLX
Video4Linux2XX
VfW captureX
X11 grabbingX
Win32 grabbingX
+ +

X means that input/output is supported. +

+ +

2.8 Timecode

+ + + + + + + + + +
Codec/formatReadWrite
AVIXX
DVXX
GXFXX
MOVXX
MPEG1/2XX
MXFXX
+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/git-howto.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/git-howto.html new file mode 100644 index 0000000..59e74f9 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/git-howto.html @@ -0,0 +1,512 @@ + + + + + + + Using Git to develop FFmpeg + + + + + + +
+

+ Using Git to develop FFmpeg +

+
+
+ + + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Introduction

+ +

This document aims in giving some quick references on a set of useful Git +commands. You should always use the extensive and detailed documentation +provided directly by Git: +

+
+
git --help
+man git
+
+ +

shows you the available subcommands, +

+
+
git <command> --help
+man git-<command>
+
+ +

shows information about the subcommand <command>. +

+

Additional information could be found on the +Git Reference website. +

+

For more information about the Git project, visit the +Git website. +

+

Consult these resources whenever you have problems, they are quite exhaustive. +

+

What follows now is a basic introduction to Git and some FFmpeg-specific +guidelines to ease the contribution to the project. +

+ +

2 Basics Usage

+ + +

2.1 Get Git

+ +

You can get Git from http://git-scm.com/ +Most distribution and operating system provide a package for it. +

+ + +

2.2 Cloning the source tree

+ +
+
git clone git://source.ffmpeg.org/ffmpeg <target>
+
+ +

This will put the FFmpeg sources into the directory <target>. +

+
+
git clone git@source.ffmpeg.org:ffmpeg <target>
+
+ +

This will put the FFmpeg sources into the directory <target> and let +you push back your changes to the remote repository. +

+
+
git clone gil@ffmpeg.org:ffmpeg-web <target>
+
+ +

This will put the source of the FFmpeg website into the directory +<target> and let you push back your changes to the remote repository. +(Note that gil stands for GItoLite and is not a typo of git.) +

+

If you don’t have write-access to the ffmpeg-web repository, you can +create patches after making a read-only ffmpeg-web clone: +

+
+
git clone git://ffmpeg.org/ffmpeg-web <target>
+
+ +

Make sure that you do not have Windows line endings in your checkouts, +otherwise you may experience spurious compilation failures. One way to +achieve this is to run +

+
+
git config --global core.autocrlf false
+
+ + + +

2.3 Updating the source tree to the latest revision

+ +
+
git pull (--rebase)
+
+ +

pulls in the latest changes from the tracked branch. The tracked branch +can be remote. By default the master branch tracks the branch master in +the remote origin. +

+
+

--rebase (see below) is recommended. +

+ +

2.4 Rebasing your local branches

+ +
+
git pull --rebase
+
+ +

fetches the changes from the main repository and replays your local commits +over it. This is required to keep all your local changes at the top of +FFmpeg’s master tree. The master tree will reject pushes with merge commits. +

+ + +

2.5 Adding/removing files/directories

+ +
+
git add [-A] <filename/dirname>
+git rm [-r] <filename/dirname>
+
+ +

Git needs to get notified of all changes you make to your working +directory that makes files appear or disappear. +Line moves across files are automatically tracked. +

+ + +

2.6 Showing modifications

+ +
+
git diff <filename(s)>
+
+ +

will show all local modifications in your working directory as unified diff. +

+ + +

2.7 Inspecting the changelog

+ +
+
git log <filename(s)>
+
+ +

You may also use the graphical tools like gitview or gitk +or the web interface available at http://source.ffmpeg.org/. +

+ +

2.8 Checking source tree status

+ +
+
git status
+
+ +

detects all the changes you made and lists what actions will be taken in case +of a commit (additions, modifications, deletions, etc.). +

+ + +

2.9 Committing

+ +
+
git diff --check
+
+ +

to double check your changes before committing them to avoid trouble later +on. All experienced developers do this on each and every commit, no matter +how small. +

+

Every one of them has been saved from looking like a fool by this many times. +It’s very easy for stray debug output or cosmetic modifications to slip in, +please avoid problems through this extra level of scrutiny. +

+

For cosmetics-only commits you should get (almost) empty output from +

+
+
git diff -w -b <filename(s)>
+
+ +

Also check the output of +

+
+
git status
+
+ +

to make sure you don’t have untracked files or deletions. +

+
+
git add [-i|-p|-A] <filenames/dirnames>
+
+ +

Make sure you have told Git your name and email address +

+
+
git config --global user.name "My Name"
+git config --global user.email my@email.invalid
+
+ +

Use --global to set the global configuration for all your Git checkouts. +

+

Git will select the changes to the files for commit. Optionally you can use +the interactive or the patch mode to select hunk by hunk what should be +added to the commit. +

+ +
+
git commit
+
+ +

Git will commit the selected changes to your current local branch. +

+

You will be prompted for a log message in an editor, which is either +set in your personal configuration file through +

+
+
git config --global core.editor
+
+ +

or set by one of the following environment variables: +GIT_EDITOR, VISUAL or EDITOR. +

+

Log messages should be concise but descriptive. Explain why you made a change, +what you did will be obvious from the changes themselves most of the time. +Saying just "bug fix" or "10l" is bad. Remember that people of varying skill +levels look at and educate themselves while reading through your code. Don’t +include filenames in log messages, Git provides that information. +

+

Possibly make the commit message have a terse, descriptive first line, an +empty line and then a full description. The first line will be used to name +the patch by git format-patch. +

+ +

2.10 Preparing a patchset

+ +
+
git format-patch <commit> [-o directory]
+
+ +

will generate a set of patches for each commit between <commit> and +current HEAD. E.g. +

+
+
git format-patch origin/master
+
+ +

will generate patches for all commits on current branch which are not +present in upstream. +A useful shortcut is also +

+
+
git format-patch -n
+
+ +

which will generate patches from last n commits. +By default the patches are created in the current directory. +

+ +

2.11 Sending patches for review

+ +
+
git send-email <commit list|directory>
+
+ +

will send the patches created by git format-patch or directly +generates them. All the email fields can be configured in the global/local +configuration or overridden by command line. +Note that this tool must often be installed separately (e.g. git-email +package on Debian-based distros). +

+ + +

2.12 Renaming/moving/copying files or contents of files

+ +

Git automatically tracks such changes, making those normal commits. +

+
+
mv/cp path/file otherpath/otherfile
+git add [-A] .
+git commit
+
+ + + +

3 Git configuration

+ +

In order to simplify a few workflows, it is advisable to configure both +your personal Git installation and your local FFmpeg repository. +

+ +

3.1 Personal Git installation

+ +

Add the following to your ~/.gitconfig to help git send-email +and git format-patch detect renames: +

+
+
[diff]
+        renames = copy
+
+ + +

3.2 Repository configuration

+ +

In order to have git send-email automatically send patches +to the ffmpeg-devel mailing list, add the following stanza +to /path/to/ffmpeg/repository/.git/config: +

+
+
[sendemail]
+        to = ffmpeg-devel@ffmpeg.org
+
+ + +

4 FFmpeg specific

+ + +

4.1 Reverting broken commits

+ +
+
git reset <commit>
+
+ +

git reset will uncommit the changes till <commit> rewriting +the current branch history. +

+
+
git commit --amend
+
+ +

allows one to amend the last commit details quickly. +

+
+
git rebase -i origin/master
+
+ +

will replay local commits over the main repository allowing to edit, merge +or remove some of them in the process. +

+
+

git reset, git commit --amend and git rebase +rewrite history, so you should use them ONLY on your local or topic branches. +The main repository will reject those changes. +

+
+
git revert <commit>
+
+ +

git revert will generate a revert commit. This will not make the +faulty commit disappear from the history. +

+ +

4.2 Pushing changes to remote trees

+ +
+
git push origin master --dry-run
+
+ +

Will simulate a push of the local master branch to the default remote +(origin). And list which branches and ranges or commits would have been +pushed. +Git will prevent you from pushing changes if the local and remote trees are +out of sync. Refer to Updating the source tree to the latest revision. +

+
+
git remote add <name> <url>
+
+ +

Will add additional remote with a name reference, it is useful if you want +to push your local branch for review on a remote host. +

+
+
git push <remote> <refspec>
+
+ +

Will push the changes to the <remote> repository. +Omitting <refspec> makes git push update all the remote +branches matching the local ones. +

+ +

4.3 Finding a specific svn revision

+ +

Since version 1.7.1 Git supports ‘:/foo’ syntax for specifying commits +based on a regular expression. see man gitrevisions +

+
+
git show :/'as revision 23456'
+
+ +

will show the svn changeset ‘r23456’. With older Git versions searching in +the git log output is the easiest option (especially if a pager with +search capabilities is used). +

+

This commit can be checked out with +

+
+
git checkout -b svn_23456 :/'as revision 23456'
+
+ +

or for Git < 1.7.1 with +

+
+
git checkout -b svn_23456 $SHA1
+
+ +

where $SHA1 is the commit hash from the git log output. +

+ + +

5 Pre-push checklist

+ +

Once you have a set of commits that you feel are ready for pushing, +work through the following checklist to doublecheck everything is in +proper order. This list tries to be exhaustive. In case you are just +pushing a typo in a comment, some of the steps may be unnecessary. +Apply your common sense, but if in doubt, err on the side of caution. +

+

First, make sure that the commits and branches you are going to push +match what you want pushed and that nothing is missing, extraneous or +wrong. You can see what will be pushed by running the git push command +with --dry-run first. And then inspecting the commits listed with +git log -p 1234567..987654. The git status command +may help in finding local changes that have been forgotten to be added. +

+

Next let the code pass through a full run of our test suite. +

+
    +
  • make distclean +
  • /path/to/ffmpeg/configure +
  • make fate +
  • if fate fails due to missing samples run make fate-rsync and retry +
+ +

Make sure all your changes have been checked before pushing them, the +test suite only checks against regressions and that only to some extend. It does +obviously not check newly added features/code to be working unless you have +added a test for that (which is recommended). +

+

Also note that every single commit should pass the test suite, not just +the result of a series of patches. +

+

Once everything passed, push the changes to your public ffmpeg clone and post a +merge request to ffmpeg-devel. You can also push them directly but this is not +recommended. +

+ +

6 Server Issues

+ +

Contact the project admins at root@ffmpeg.org if you have technical +problems with the Git server. +

+

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavcodec.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavcodec.html new file mode 100644 index 0000000..0d69cba --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavcodec.html @@ -0,0 +1,77 @@ + + + + + + + Libavcodec Documentation + + + + + + +
+

+ Libavcodec Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

The libavcodec library provides a generic encoding/decoding framework +and contains multiple decoders and encoders for audio, video and +subtitle streams, and several bitstream filters. +

+

The shared architecture provides various services ranging from bit +stream I/O to DSP optimizations, and makes it suitable for +implementing robust and fast codecs as well as for experimentation. +

+ + +

2 See Also

+ +

ffmpeg, ffplay, ffprobe, +ffmpeg-codecs, bitstream-filters, +libavutil +

+ + +

3 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavdevice.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavdevice.html new file mode 100644 index 0000000..f7f23ed --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavdevice.html @@ -0,0 +1,74 @@ + + + + + + + Libavdevice Documentation + + + + + + +
+

+ Libavdevice Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

The libavdevice library provides a generic framework for grabbing from +and rendering to many common multimedia input/output devices, and +supports several input and output devices, including Video4Linux2, +VfW, DShow, and ALSA. +

+ + +

2 See Also

+ +

ffmpeg, ffplay, ffprobe, +ffmpeg-devices, +libavutil, libavcodec, libavformat +

+ + +

3 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavfilter.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavfilter.html new file mode 100644 index 0000000..374a85b --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavfilter.html @@ -0,0 +1,73 @@ + + + + + + + Libavfilter Documentation + + + + + + +
+

+ Libavfilter Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

The libavfilter library provides a generic audio/video filtering +framework containing several filters, sources and sinks. +

+ + +

2 See Also

+ +

ffmpeg, ffplay, ffprobe, +ffmpeg-filters, +libavutil, libswscale, libswresample, +libavcodec, libavformat, libavdevice +

+ + +

3 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavformat.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavformat.html new file mode 100644 index 0000000..c47fb8c --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavformat.html @@ -0,0 +1,77 @@ + + + + + + + Libavformat Documentation + + + + + + +
+

+ Libavformat Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

The libavformat library provides a generic framework for multiplexing +and demultiplexing (muxing and demuxing) audio, video and subtitle +streams. It encompasses multiple muxers and demuxers for multimedia +container formats. +

+

It also supports several input and output protocols to access a media +resource. +

+ + +

2 See Also

+ +

ffmpeg, ffplay, ffprobe, +ffmpeg-formats, ffmpeg-protocols, +libavutil, libavcodec +

+ + +

3 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavutil.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavutil.html new file mode 100644 index 0000000..3d6bc44 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libavutil.html @@ -0,0 +1,96 @@ + + + + + + + Libavutil Documentation + + + + + + +
+

+ Libavutil Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

The libavutil library is a utility library to aid portable +multimedia programming. It contains safe portable string functions, +random number generators, data structures, additional mathematics +functions, cryptography and multimedia related functionality (like +enumerations for pixel and sample formats). It is not a library for +code needed by both libavcodec and libavformat. +

+

The goals for this library is to be: +

+
+
Modular
+

It should have few interdependencies and the possibility of disabling individual +parts during ./configure. +

+
+
Small
+

Both sources and objects should be small. +

+
+
Efficient
+

It should have low CPU and memory usage. +

+
+
Useful
+

It should avoid useless features that almost no one needs. +

+
+ + + +

2 See Also

+ +

ffmpeg, ffplay, ffprobe, +ffmpeg-utils +

+ + +

3 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libswresample.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libswresample.html new file mode 100644 index 0000000..1b9d338 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libswresample.html @@ -0,0 +1,96 @@ + + + + + + + Libswresample Documentation + + + + + + +
+

+ Libswresample Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

The libswresample library performs highly optimized audio resampling, +rematrixing and sample format conversion operations. +

+

Specifically, this library performs the following conversions: +

+
    +
  • Resampling: is the process of changing the audio rate, for +example from a high sample rate of 44100Hz to 8000Hz. Audio +conversion from high to low sample rate is a lossy process. Several +resampling options and algorithms are available. + +
  • Format conversion: is the process of converting the type of +samples, for example from 16-bit signed samples to unsigned 8-bit or +float samples. It also handles packing conversion, when passing from +packed layout (all samples belonging to distinct channels interleaved +in the same buffer), to planar layout (all samples belonging to the +same channel stored in a dedicated buffer or "plane"). + +
  • Rematrixing: is the process of changing the channel layout, for +example from stereo to mono. When the input channels cannot be mapped +to the output streams, the process is lossy, since it involves +different gain factors and mixing. +
+ +

Various other audio conversions (e.g. stretching and padding) are +enabled through dedicated options. +

+ + +

2 See Also

+ +

ffmpeg, ffplay, ffprobe, +ffmpeg-resampler, +libavutil +

+ + +

3 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libswscale.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libswscale.html new file mode 100644 index 0000000..d62a896 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/libswscale.html @@ -0,0 +1,90 @@ + + + + + + + Libswscale Documentation + + + + + + +
+

+ Libswscale Documentation +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+ +

The libswscale library performs highly optimized image scaling and +colorspace and pixel format conversion operations. +

+

Specifically, this library performs the following conversions: +

+
    +
  • Rescaling: is the process of changing the video size. Several +rescaling options and algorithms are available. This is usually a +lossy process. + +
  • Pixel format conversion: is the process of converting the image +format and colorspace of the image, for example from planar YUV420P to +RGB24 packed. It also handles packing conversion, that is converts +from packed layout (all pixels belonging to distinct planes +interleaved in the same buffer), to planar layout (all samples +belonging to the same plane stored in a dedicated buffer or "plane"). + +

    This is usually a lossy process in case the source and destination +colorspaces differ. +

+ + + +

2 See Also

+ +

ffmpeg, ffplay, ffprobe, +ffmpeg-scaler, +libavutil +

+ + +

3 Authors

+ +

The FFmpeg developers. +

+

For details about the authorship, see the Git history of the project +(git://source.ffmpeg.org/ffmpeg), e.g. by typing the command +git log in the FFmpeg source directory, or browsing the +online repository at http://source.ffmpeg.org. +

+

Maintainers for the specific components are listed in the file +MAINTAINERS in the source code tree. +

+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/mailing-list-faq.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/mailing-list-faq.html new file mode 100644 index 0000000..718c131 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/mailing-list-faq.html @@ -0,0 +1,449 @@ + + + + + + + FFmpeg Mailing List FAQ + + + + + + +
+

+ FFmpeg Mailing List FAQ +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 General Questions

+ + +

1.1 What is a mailing list?

+ +

A mailing list is not much different than emailing someone, but the +main difference is that your message is received by everyone who +subscribes to the list. It is somewhat like a forum but in email form. +

+

See the ffmpeg-user archives +for examples. +

+ +

1.2 What type of questions can I ask?

+ +
    +
  • ffmpeg-user: +For questions involving unscripted usage or compilation of the FFmpeg +command-line tools (ffmpeg, ffprobe, ffplay). + +
  • libav-user: +For questions involving the FFmpeg libav* libraries (libavcodec, +libavformat, libavfilter, etc). + +
  • ffmpeg-devel: +For discussions involving the development of FFmpeg and for submitting +patches. User questions should be asked at ffmpeg-user or libav-user. +
+ +

To report a bug see https://ffmpeg.org/bugreports.html. +

+

We cannot provide help for scripts and/or third-party tools. +

+ +

1.3 How do I ask a question or send a message to a mailing list?

+ +

First you must subscribe. Then all you have to do is +send an email: +

+ + + +

2 Subscribing / Unsubscribing

+ + +

2.1 How do I subscribe?

+ +

Email ffmpeg-user-request@ffmpeg.org with the subject +subscribe. +

+

Or visit the ffmpeg-user mailing list info page +and refer to the Subscribing to ffmpeg-user section. +

+

The process is the same for the other mailing lists. +

+ +

2.2 How do I unsubscribe?

+ +

Email ffmpeg-user-request@ffmpeg.org with subject unsubscribe. +

+

Or visit the ffmpeg-user mailing list info page, +scroll to bottom of page, enter your email address in the box, and click +the Unsubscribe or edit options button. +

+

The process is the same for the other mailing lists. +

+

Please avoid asking a mailing list admin to unsubscribe you unless you +are absolutely unable to do so by yourself. See Who do I contact if I have a problem with the mailing list? +

+

Note that it is possible to temporarily halt message delivery (vacation mode). +See How do I disable mail delivery without unsubscribing? +

+ +

3 Moderation Queue

+ +

3.1 Why is my message awaiting moderator approval?

+ +

Some messages are automatically held in the moderation queue and +must be manually approved by a mailing list admin: +

+

These are: +

+
    +
  • Messages that exceed the message size limit. + +
  • Messages from users whose accounts have been set with the moderation flag +(very rarely occurs, but may if a user repeatedly ignores the rules +or is abusive towards others). +
+ + +

3.2 How long does it take for my message in the moderation queue to be approved?

+ +

The queue is not checked on a regular basis. You can ask on the +#ffmpeg-devel IRC channel on Freenode for someone to approve your message. +

+ +

3.3 How do I delete my message in the moderation queue?

+ +

You should have received an email with the subject Your message to <mailing list name> awaits moderator approval. +A link is in the message that will allow you to delete your message +unless a mailing list admin already approved or rejected it. +

+ +

4 Archives

+ + +

4.1 Where are the archives?

+ +

See the Archives section on the FFmpeg Contact +page for links to all FFmpeg mailing list archives. +

+

Note that the archives are split by month. Discussions that span +several months will be split into separate months in the archives. +

+ +

4.2 How do I reply to a message in the archives?

+ +

Click the email link at the top of the message just under the subject +title. The link will provide the proper headers to keep the message +within the thread. +

+

Note that you must be subscribed to send a message to the ffmpeg-user or +libav-user mailing lists. +

+ +

4.3 How do I search the archives?

+ +

Perform a site search using your favorite search engine. Example: +

+

site:lists.ffmpeg.org/pipermail/ffmpeg-user/ "search term" +

+ +

5 Other

+ + +

5.1 Is there an alternative to the mailing list?

+ +

You can ask for help in the official #ffmpeg IRC channel on Freenode. +

+

Some users prefer the third-party Nabble +interface which presents the mailing lists in a typical forum layout. +

+

There are also numerous third-party help sites such as +Super User and +r/ffmpeg on reddit. +

+ +

5.2 What is top-posting?

+ +

See https://en.wikipedia.org/wiki/Posting_style#Top-posting. +

+

Instead, use trimmed interleaved/inline replies (example). +

+ +

5.3 What is the message size limit?

+ +

The message size limit is 1000 kilobytes. Please provide links to larger files +instead of attaching them. +

+ +

5.4 Where can I upload sample files?

+ +

Anywhere that is not too annoying for us to use. +

+

Google Drive and Dropbox are acceptable if you need a file host, and +0x0.st is good for files under 256 MiB. +

+

Small, short samples are preferred if possible. +

+ +

5.5 Will I receive spam if I send and/or subscribe to a mailing list?

+ +

Highly unlikely. +

+
    +
  • The list of subscribed users is not public. + +
  • Email addresses in the archives are obfuscated. + +
  • Several unique test email accounts were utilized and none have yet +received any spam. +
+ +

However, you may see a spam in the mailing lists on rare occasions: +

+
    +
  • Spam in the moderation queue may be accidentally approved due to human +error. + +
  • There have been a few messages from subscribed users who had their own +email addresses hacked and spam messages from (or appearing to be from) +the hacked account were sent to their contacts (a mailing list being a +contact in these cases). + +
  • If you are subscribed to the bug tracker mailing list (ffmpeg-trac) you +may see the occasional spam as a false bug report, but we take measures +to try to prevent this. +
+ + +

5.6 How do I filter mailing list messages?

+ +

Use the List-Id. For example, the ffmpeg-user mailing list is +ffmpeg-user.ffmpeg.org. You can view the List-Id in the raw message +or headers. +

+

You can then filter the mailing list messages to their own folder. +

+ +

5.7 How do I disable mail delivery without unsubscribing?

+ +

Sometimes you may want to temporarily stop receiving all mailing list +messages. This "vacation mode" is simple to do: +

+
    +
  1. Go to the ffmpeg-user mailing list info page + +
  2. Enter your email address in the box at very bottom of the page and click the +Unsubscribe or edit options box. + +
  3. Enter your password and click the Log in button. + +
  4. Look for the Mail delivery option. Here you can disable/enable mail +delivery. If you check Set globally it will apply your choice to all +other FFmpeg mailing lists you are subscribed to. +
+ +

Alternatively, from your subscribed address, send a message to ffmpeg-user-request@ffmpeg.org +with the subject set delivery off. To re-enable mail delivery send a +message to ffmpeg-user-request@ffmpeg.org with the subject +set delivery on. +

+ +

5.8 Why is the mailing list munging my address?

+ +

This is due to subscribers that use an email service with a DMARC reject policy +which adds difficulties to mailing list operators. +

+

The mailing list must re-write (munge) the From: header for such users; +otherwise their email service will reject and bounce the message resulting in +automatic unsubscribing from the mailing list. +

+

When sending a message these users will see via <mailing list name> +added to their name and the From: address munged to the address of +the particular mailing list. +

+

If you want to avoid this then please use a different email service. +

+

Note that ffmpeg-devel does not apply any munging as it causes issues with +patch authorship. As a result users with an email service with a DMARC reject +policy may be automatically unsubscribed due to rejected and bounced messages. +

+ +

6 Rules and Etiquette

+ + +

6.1 What are the rules and the proper etiquette?

+ +

There may seem to be many things to remember, but we want to help and +following these guidelines will allow you to get answers more quickly +and help avoid getting ignored. +

+
    +
  • Always show your actual, unscripted ffmpeg command and the +complete, uncut console output from your command. + +
  • Use the most simple and minimal command that still shows the issue you +are encountering. + +
  • Provide all necessary information so others can attempt to duplicate +your issue. This includes the actual command, complete uncut console +output, and any inputs that are required to duplicate the issue. + +
  • Use the latest ffmpeg build you can get. See the FFmpeg Download +page for links to recent builds for Linux, macOS, and Windows. Or +compile from the current git master branch. + +
  • Avoid top-posting. +Also see What is top-posting? + +
  • Avoid hijacking threads. Thread hijacking is replying to a message and +changing the subject line to something unrelated to the original thread. +Most email clients will still show the renamed message under the +original thread. This can be confusing and these types of messages are +often ignored. + +
  • Do not send screenshots. Copy and paste console text instead of making +screenshots of the text. + +
  • Avoid sending email disclaimers and legalese if possible as this is a +public list. + +
  • Avoid using the -loglevel debug, -loglevel quiet, and +-hide_banner options unless requested to do so. + +
  • If you attach files avoid compressing small files. Uncompressed is +preferred. + +
  • Please do not send HTML-only messages. The mailing list will ignore the +HTML component of your message. Most mail clients will automatically +include a text component: this is what the mailing list will use. + +
  • Configuring your mail client to break lines after 70 or so characters is +recommended. + +
  • Avoid sending the same message to multiple mailing lists. + +
  • Please follow our Code of Conduct. +
+ + +

7 Help

+ + +

7.1 Why am I not receiving any messages?

+ +

Some email providers have blacklists or spam filters that block or mark +the mailing list messages as false positives. Unfortunately, the user is +often not aware of this and is often out of their control. +

+

When possible we attempt to notify the provider to be removed from the +blacklists or filters. +

+ +

7.2 Why are my sent messages not showing up?

+ +

Excluding messages that are held in the moderation queue +there are a few other reasons why your messages may fail to appear: +

+
    +
  • HTML-only messages are ignored by the mailing lists. Most mail clients +automatically include a text component alongside HTML email: this is what +the mailing list will use. If it does not then consider your client to be +broken, because sending a text component along with the HTML component to +form a multi-part message is recommended by email standards. + +
  • Check your spam folder. +
+ + +

7.3 Why do I keep getting unsubscribed from ffmpeg-devel?

+ +

Users with an email service that has a DMARC reject or quarantine policy may be +automatically unsubscribed from the ffmpeg-devel mailing list due to the mailing +list messages being continuously rejected and bounced back. +

+

Consider using a different email service. +

+ +

7.4 Who do I contact if I have a problem with the mailing list?

+ +

Send a message to ffmpeg-user-owner@ffmpeg.org. +

+ +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/nut.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/nut.html new file mode 100644 index 0000000..6372002 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/nut.html @@ -0,0 +1,212 @@ + + + + + + + NUT + + + + + + +
+

+ NUT +

+
+
+ + + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Description

+

NUT is a low overhead generic container format. It stores audio, video, +subtitle and user-defined streams in a simple, yet efficient, way. +

+

It was created by a group of FFmpeg and MPlayer developers in 2003 +and was finalized in 2008. +

+

The official nut specification is at svn://svn.mplayerhq.hu/nut +In case of any differences between this text and the official specification, +the official specification shall prevail. +

+ +

2 Modes

+

NUT has some variants signaled by using the flags field in its main header. +

+ + + +
BROADCASTExtend the syncpoint to report the sender wallclock
PIPEOmit completely the syncpoint
+ + +

2.1 BROADCAST

+ +

The BROADCAST variant provides a secondary time reference to facilitate +detecting endpoint latency and network delays. +It assumes all the endpoint clocks are synchronized. +To be used in real-time scenarios. +

+ +

2.2 PIPE

+ +

The PIPE variant assumes NUT is used as non-seekable intermediate container, +by not using syncpoint removes unneeded overhead and reduces the overall +memory usage. +

+ +

3 Container-specific codec tags

+ + +

3.1 Generic raw YUVA formats

+ +

Since many exotic planar YUVA pixel formats are not considered by +the AVI/QuickTime FourCC lists, the following scheme is adopted for +representing them. +

+

The first two bytes can contain the values: +Y1 = only Y +Y2 = Y+A +Y3 = YUV +Y4 = YUVA +

+

The third byte represents the width and height chroma subsampling +values for the UV planes, that is the amount to shift the luma +width/height right to find the chroma width/height. +

+

The fourth byte is the number of bits used (8, 16, ...). +

+

If the order of bytes is inverted, that means that each component has +to be read big-endian. +

+ +

3.2 Raw Audio

+ + + + + + +
ALAWA-LAW
ULAWMU-LAW
P<type><interleaving><bits>little-endian PCM
<bits><interleaving><type>Pbig-endian PCM
+ +

<type> is S for signed integer, U for unsigned integer, F for IEEE float +<interleaving> is D for default, P is for planar. +<bits> is 8/16/24/32 +

+
+
PFD[32]   would for example be signed 32 bit little-endian IEEE float
+
+ + +

3.3 Subtitles

+ + + + + + +
UTF8Raw UTF-8
SSA[0]SubStation Alpha
DVDSDVD subtitles
DVBSDVB subtitles
+ + +

3.4 Raw Data

+ + + +
UTF8Raw UTF-8
+ + +

3.5 Codecs

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
3IV1non-compliant MPEG-4 generated by old 3ivx
ASV1Asus Video
ASV2Asus Video 2
CVIDCinepak
CYUVCreative YUV
DIVXnon-compliant MPEG-4 generated by old DivX
DUCKTruemotion 1
FFV1FFmpeg video 1
FFVHFFmpeg Huffyuv
H261ITU H.261
H262ITU H.262
H263ITU H.263
H264ITU H.264
HFYUHuffyuv
I263Intel H.263
IV31Indeo 3.1
IV32Indeo 3.2
IV50Indeo 5.0
LJPGITU JPEG (lossless)
MJLSITU JPEG-LS
MJPGITU JPEG
MPG4MS MPEG-4v1 (not ISO MPEG-4)
MP42MS MPEG-4v2
MP43MS MPEG-4v3
MP4VISO MPEG-4 Part 2 Video (from old encoders)
mpg1ISO MPEG-1 Video
mpg2ISO MPEG-2 Video
MRLEMS RLE
MSVCMS Video 1
RT21Indeo 2.1
RV10RealVideo 1.0
RV20RealVideo 2.0
RV30RealVideo 3.0
RV40RealVideo 4.0
SNOWFFmpeg Snow
SVQ1Sorenson Video 1
SVQ3Sorenson Video 3
theoXiph Theora
TM20Truemotion 2.0
UMP4non-compliant MPEG-4 generated by UB Video MPEG-4
VCR1ATI VCR1
VP30VP 3.0
VP31VP 3.1
VP50VP 5.0
VP60VP 6.0
VP61VP 6.1
VP62VP 6.2
VP70VP 7.0
WMV1MS WMV7
WMV2MS WMV8
WMV3MS WMV9
WV1Fnon-compliant MPEG-4 generated by ?
WVC1VC-1
XVIDnon-compliant MPEG-4 generated by old Xvid
XVIXnon-compliant MPEG-4 generated by old Xvid with interlacing bug
+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/platform.html b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/platform.html new file mode 100644 index 0000000..378aadf --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/doc/platform.html @@ -0,0 +1,396 @@ + + + + + + + Platform Specific Information + + + + + + +
+

+ Platform Specific Information +

+
+
+ + + + + +

Table of Contents

+ +
+ + +
+ + + +

1 Unix-like

+ +

Some parts of FFmpeg cannot be built with version 2.15 of the GNU +assembler which is still provided by a few AMD64 distributions. To +make sure your compiler really uses the required version of gas +after a binutils upgrade, run: +

+
+
$(gcc -print-prog-name=as) --version
+
+ +

If not, then you should install a different compiler that has no +hard-coded path to gas. In the worst case pass --disable-asm +to configure. +

+ +

1.1 Advanced linking configuration

+ +

If you compiled FFmpeg libraries statically and you want to use them to +build your own shared library, you may need to force PIC support (with +--enable-pic during FFmpeg configure) and add the following option +to your project LDFLAGS: +

+
+
-Wl,-Bsymbolic
+
+ +

If your target platform requires position independent binaries, you should +pass the correct linking flag (e.g. -pie) to --extra-ldexeflags. +

+ +

1.2 BSD

+ +

BSD make will not build FFmpeg, you need to install and use GNU Make +(gmake). +

+ +

1.3 (Open)Solaris

+ +

GNU Make is required to build FFmpeg, so you have to invoke (gmake), +standard Solaris Make will not work. When building with a non-c99 front-end +(gcc, generic suncc) add either --extra-libs=/usr/lib/values-xpg6.o +or --extra-libs=/usr/lib/64/values-xpg6.o to the configure options +since the libc is not c99-compliant by default. The probes performed by +configure may raise an exception leading to the death of configure itself +due to a bug in the system shell. Simply invoke a different shell such as +bash directly to work around this: +

+
+
bash ./configure
+
+ + +

1.4 Darwin (Mac OS X, iPhone)

+ +

The toolchain provided with Xcode is sufficient to build the basic +unaccelerated code. +

+

Mac OS X on PowerPC or ARM (iPhone) requires a preprocessor from +https://github.com/FFmpeg/gas-preprocessor or +https://github.com/yuvi/gas-preprocessor(currently outdated) to build the optimized +assembly functions. Put the Perl script somewhere +in your PATH, FFmpeg’s configure will pick it up automatically. +

+

Mac OS X on amd64 and x86 requires nasm to build most of the +optimized assembly functions. Fink, +Gentoo Prefix, +Homebrew +or MacPorts can easily provide it. +

+ + +

2 DOS

+ +

Using a cross-compiler is preferred for various reasons. +http://www.delorie.com/howto/djgpp/linux-x-djgpp.html +

+ + +

3 OS/2

+ +

For information about compiling FFmpeg on OS/2 see +http://www.edm2.com/index.php/FFmpeg. +

+ + +

4 Windows

+ +

To get help and instructions for building FFmpeg under Windows, check out +the FFmpeg Windows Help Forum at http://ffmpeg.zeranoe.com/forum/. +

+ +

4.1 Native Windows compilation using MinGW or MinGW-w64

+ +

FFmpeg can be built to run natively on Windows using the MinGW-w64 +toolchain. Install the latest versions of MSYS2 and MinGW-w64 from +http://msys2.github.io/ and/or http://mingw-w64.sourceforge.net/. +You can find detailed installation instructions in the download section and +the FAQ. +

+

Notes: +

+
    +
  • Building for the MSYS environment is discouraged, MSYS2 provides a full +MinGW-w64 environment through mingw64_shell.bat or +mingw32_shell.bat that should be used instead of the environment +provided by msys2_shell.bat. + +
  • Building using MSYS2 can be sped up by disabling implicit rules in the +Makefile by calling make -r instead of plain make. This +speed up is close to non-existent for normal one-off builds and is only +noticeable when running make for a second time (for example during +make install). + +
  • In order to compile FFplay, you must have the MinGW development library +of SDL and pkg-config installed. + +
  • By using ./configure --enable-shared when configuring FFmpeg, +you can build the FFmpeg libraries (e.g. libavutil, libavcodec, +libavformat) as DLLs. + +
+ + +

4.1.1 Native Windows compilation using MSYS2

+ +

The MSYS2 MinGW-w64 environment provides ready to use toolchains and dependencies +through pacman. +

+

Make sure to use mingw64_shell.bat or mingw32_shell.bat to have +the correct MinGW-w64 environment. The default install provides shortcuts to +them under MinGW-w64 Win64 Shell and MinGW-w64 Win32 Shell. +

+
+
# normal msys2 packages
+pacman -S make pkgconf diffutils
+
+# mingw-w64 packages and toolchains
+pacman -S mingw-w64-x86_64-nasm mingw-w64-x86_64-gcc mingw-w64-x86_64-SDL2
+
+ +

To target 32 bits replace x86_64 with i686 in the command above. +

+ +

4.2 Microsoft Visual C++ or Intel C++ Compiler for Windows

+ +

FFmpeg can be built with MSVC 2013 or later. +

+

You will need the following prerequisites: +

+
    +
  • MSYS2 +
  • NASM +(Also available via MSYS2’s package manager.) +
+ +

To set up a proper environment in MSYS2, you need to run msys_shell.bat from +the Visual Studio or Intel Compiler command prompt. +

+

Place yasm.exe somewhere in your PATH. +

+

Next, make sure any other headers and libs you want to use, such as zlib, are +located in a spot that the compiler can see. Do so by modifying the LIB +and INCLUDE environment variables to include the Windows-style +paths to these directories. Alternatively, you can try to use the +--extra-cflags/--extra-ldflags configure options. +

+

Finally, run: +

+
+
For MSVC:
+./configure --toolchain=msvc
+
+For ICL:
+./configure --toolchain=icl
+
+make
+make install
+
+ +

If you wish to compile shared libraries, add --enable-shared to your +configure options. Note that due to the way MSVC and ICL handle DLL imports and +exports, you cannot compile static and shared libraries at the same time, and +enabling shared libraries will automatically disable the static ones. +

+

Notes: +

+
    +
  • If you wish to build with zlib support, you will have to grab a compatible +zlib binary from somewhere, with an MSVC import lib, or if you wish to link +statically, you can follow the instructions below to build a compatible +zlib.lib with MSVC. Regardless of which method you use, you must still +follow step 3, or compilation will fail. +
      +
    1. Grab the zlib sources. +
    2. Edit win32/Makefile.msc so that it uses -MT instead of -MD, since +this is how FFmpeg is built as well. +
    3. Edit zconf.h and remove its inclusion of unistd.h. This gets +erroneously included when building FFmpeg. +
    4. Run nmake -f win32/Makefile.msc. +
    5. Move zlib.lib, zconf.h, and zlib.h to somewhere MSVC +can see. +
    + +
  • FFmpeg has been tested with the following on i686 and x86_64: +
      +
    • Visual Studio 2013 Pro and Express +
    • Intel Composer XE 2013 +
    • Intel Composer XE 2013 SP1 +
    +

    Anything else is not officially supported. +

    +
+ + +

4.2.1 Linking to FFmpeg with Microsoft Visual C++

+ +

If you plan to link with MSVC-built static libraries, you will need +to make sure you have Runtime Library set to +Multi-threaded (/MT) in your project’s settings. +

+

You will need to define inline to something MSVC understands: +

+
#define inline __inline
+
+ +

Also note, that as stated in Microsoft Visual C++, you will need +an MSVC-compatible inttypes.h. +

+

If you plan on using import libraries created by dlltool, you must +set References to No (/OPT:NOREF) under the linker optimization +settings, otherwise the resulting binaries will fail during runtime. +This is not required when using import libraries generated by lib.exe. +This issue is reported upstream at +http://sourceware.org/bugzilla/show_bug.cgi?id=12633. +

+

To create import libraries that work with the /OPT:REF option +(which is enabled by default in Release mode), follow these steps: +

+
    +
  1. Open the Visual Studio Command Prompt. + +

    Alternatively, in a normal command line prompt, call vcvars32.bat +which sets up the environment variables for the Visual C++ tools +(the standard location for this file is something like +C:\Program Files (x86_\Microsoft Visual Studio 10.0\VC\bin\vcvars32.bat). +

    +
  2. Enter the bin directory where the created LIB and DLL files +are stored. + +
  3. Generate new import libraries with lib.exe: + +
    +
    lib /machine:i386 /def:..\lib\foo-version.def  /out:foo.lib
+
    + +

    Replace foo-version and foo with the respective library names. +

    +
+ + +

4.3 Cross compilation for Windows with Linux

+ +

You must use the MinGW cross compilation tools available at +http://www.mingw.org/. +

+

Then configure FFmpeg with the following options: +

+
./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
+
+

(you can change the cross-prefix according to the prefix chosen for the +MinGW tools). +

+

Then you can easily test FFmpeg with Wine. +

+ +

4.4 Compilation under Cygwin

+ +

Please use Cygwin 1.7.x as the obsolete 1.5.x Cygwin versions lack +llrint() in its C library. +

+

Install your Cygwin with all the "Base" packages, plus the +following "Devel" ones: +

+
binutils, gcc4-core, make, git, mingw-runtime, texinfo
+
+ +

In order to run FATE you will also need the following "Utils" packages: +

+
diffutils
+
+ +

If you want to build FFmpeg with additional libraries, download Cygwin +"Devel" packages for Ogg and Vorbis from any Cygwin packages repository: +

+
libogg-devel, libvorbis-devel
+
+ +

These library packages are only available from +Cygwin Ports: +

+
+
yasm, libSDL-devel, libgsm-devel, libmp3lame-devel,
+speex-devel, libtheora-devel, libxvidcore-devel
+
+ +

The recommendation for x264 is to build it from source, as it evolves too +quickly for Cygwin Ports to be up to date. +

+ +

4.5 Crosscompilation for Windows under Cygwin

+ +

With Cygwin you can create Windows binaries that do not need the cygwin1.dll. +

+

Just install your Cygwin as explained before, plus these additional +"Devel" packages: +

+
gcc-mingw-core, mingw-runtime, mingw-zlib
+
+ +

and add some special flags to your configure invocation. +

+

For a static build run +

+
./configure --target-os=mingw32 --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
+
+ +

and for a build with shared libraries +

+
./configure --target-os=mingw32 --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
+
+ + +

+ This document was generated using makeinfo. +

+
+ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/ac3_parser.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/ac3_parser.h new file mode 100644 index 0000000..ff8cc4c --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/ac3_parser.h @@ -0,0 +1,36 @@ +/* + * AC-3 parser prototypes + * Copyright (c) 2003 Fabrice Bellard + * Copyright (c) 2003 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_AC3_PARSER_H +#define AVCODEC_AC3_PARSER_H + +#include +#include + +/** + * Extract the bitstream ID and the frame size from AC-3 data. + */ +int av_ac3_parse_header(const uint8_t *buf, size_t size, + uint8_t *bitstream_id, uint16_t *frame_size); + + +#endif /* AVCODEC_AC3_PARSER_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/adts_parser.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/adts_parser.h new file mode 100644 index 0000000..f85becd --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/adts_parser.h @@ -0,0 +1,37 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_ADTS_PARSER_H +#define AVCODEC_ADTS_PARSER_H + +#include +#include + +#define AV_AAC_ADTS_HEADER_SIZE 7 + +/** + * Extract the number of samples and frames from AAC data. + * @param[in] buf pointer to AAC data buffer + * @param[out] samples Pointer to where number of samples is written + * @param[out] frames Pointer to where number of frames is written + * @return Returns 0 on success, error code on failure. + */ +int av_adts_header_parse(const uint8_t *buf, uint32_t *samples, + uint8_t *frames); + +#endif /* AVCODEC_ADTS_PARSER_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/avcodec.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/avcodec.h new file mode 100644 index 0000000..c91b2fd --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/avcodec.h @@ -0,0 +1,4142 @@ +/* + * copyright (c) 2001 Fabrice Bellard + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_AVCODEC_H +#define AVCODEC_AVCODEC_H + +/** + * @file + * @ingroup libavc + * Libavcodec external API header + */ + +#include +#include "libavutil/samplefmt.h" +#include "libavutil/attributes.h" +#include "libavutil/avutil.h" +#include "libavutil/buffer.h" +#include "libavutil/cpu.h" +#include "libavutil/channel_layout.h" +#include "libavutil/dict.h" +#include "libavutil/frame.h" +#include "libavutil/hwcontext.h" +#include "libavutil/log.h" +#include "libavutil/pixfmt.h" +#include "libavutil/rational.h" + +#include "bsf.h" +#include "codec.h" +#include "codec_desc.h" +#include "codec_par.h" +#include "codec_id.h" +#include "packet.h" +#include "version.h" + +/** + * @defgroup libavc libavcodec + * Encoding/Decoding Library + * + * @{ + * + * @defgroup lavc_decoding Decoding + * @{ + * @} + * + * @defgroup lavc_encoding Encoding + * @{ + * @} + * + * @defgroup lavc_codec Codecs + * @{ + * @defgroup lavc_codec_native Native Codecs + * @{ + * @} + * @defgroup lavc_codec_wrappers External library wrappers + * @{ + * @} + * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge + * @{ + * @} + * @} + * @defgroup lavc_internal Internal + * @{ + * @} + * @} + */ + +/** + * @ingroup libavc + * @defgroup lavc_encdec send/receive encoding and decoding API overview + * @{ + * + * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/ + * avcodec_receive_packet() functions provide an encode/decode API, which + * decouples input and output. + * + * The API is very similar for encoding/decoding and audio/video, and works as + * follows: + * - Set up and open the AVCodecContext as usual. + * - Send valid input: + * - For decoding, call avcodec_send_packet() to give the decoder raw + * compressed data in an AVPacket. + * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame + * containing uncompressed audio or video. + * + * In both cases, it is recommended that AVPackets and AVFrames are + * refcounted, or libavcodec might have to copy the input data. (libavformat + * always returns refcounted AVPackets, and av_frame_get_buffer() allocates + * refcounted AVFrames.) + * - Receive output in a loop. Periodically call one of the avcodec_receive_*() + * functions and process their output: + * - For decoding, call avcodec_receive_frame(). On success, it will return + * an AVFrame containing uncompressed audio or video data. + * - For encoding, call avcodec_receive_packet(). On success, it will return + * an AVPacket with a compressed frame. + * + * Repeat this call until it returns AVERROR(EAGAIN) or an error. The + * AVERROR(EAGAIN) return value means that new input data is required to + * return new output. In this case, continue with sending input. For each + * input frame/packet, the codec will typically return 1 output frame/packet, + * but it can also be 0 or more than 1. + * + * At the beginning of decoding or encoding, the codec might accept multiple + * input frames/packets without returning a frame, until its internal buffers + * are filled. This situation is handled transparently if you follow the steps + * outlined above. + * + * In theory, sending input can result in EAGAIN - this should happen only if + * not all output was received. You can use this to structure alternative decode + * or encode loops other than the one suggested above. For example, you could + * try sending new input on each iteration, and try to receive output if that + * returns EAGAIN. + * + * End of stream situations. These require "flushing" (aka draining) the codec, + * as the codec might buffer multiple frames or packets internally for + * performance or out of necessity (consider B-frames). + * This is handled as follows: + * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding) + * or avcodec_send_frame() (encoding) functions. This will enter draining + * mode. + * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet() + * (encoding) in a loop until AVERROR_EOF is returned. The functions will + * not return AVERROR(EAGAIN), unless you forgot to enter draining mode. + * - Before decoding can be resumed again, the codec has to be reset with + * avcodec_flush_buffers(). + * + * Using the API as outlined above is highly recommended. But it is also + * possible to call functions outside of this rigid schema. For example, you can + * call avcodec_send_packet() repeatedly without calling + * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed + * until the codec's internal buffer has been filled up (which is typically of + * size 1 per output frame, after initial input), and then reject input with + * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to + * read at least some output. + * + * Not all codecs will follow a rigid and predictable dataflow; the only + * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on + * one end implies that a receive/send call on the other end will succeed, or + * at least will not fail with AVERROR(EAGAIN). In general, no codec will + * permit unlimited buffering of input or output. + * + * This API replaces the following legacy functions: + * - avcodec_decode_video2() and avcodec_decode_audio4(): + * Use avcodec_send_packet() to feed input to the decoder, then use + * avcodec_receive_frame() to receive decoded frames after each packet. + * Unlike with the old video decoding API, multiple frames might result from + * a packet. For audio, splitting the input packet into frames by partially + * decoding packets becomes transparent to the API user. You never need to + * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then + * no data was read from the packet). + * Additionally, sending a flush/draining packet is required only once. + * - avcodec_encode_video2()/avcodec_encode_audio2(): + * Use avcodec_send_frame() to feed input to the encoder, then use + * avcodec_receive_packet() to receive encoded packets. + * Providing user-allocated buffers for avcodec_receive_packet() is not + * possible. + * - The new API does not handle subtitles yet. + * + * Mixing new and old function calls on the same AVCodecContext is not allowed, + * and will result in undefined behavior. + * + * Some codecs might require using the new API; using the old API will return + * an error when calling it. All codecs support the new API. + * + * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This + * would be an invalid state, which could put the codec user into an endless + * loop. The API has no concept of time either: it cannot happen that trying to + * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second + * later accepts the packet (with no other receive/flush API calls involved). + * The API is a strict state machine, and the passage of time is not supposed + * to influence it. Some timing-dependent behavior might still be deemed + * acceptable in certain cases. But it must never result in both send/receive + * returning EAGAIN at the same time at any point. It must also absolutely be + * avoided that the current state is "unstable" and can "flip-flop" between + * the send/receive APIs allowing progress. For example, it's not allowed that + * the codec randomly decides that it actually wants to consume a packet now + * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an + * avcodec_send_packet() call. + * @} + */ + +/** + * @defgroup lavc_core Core functions/structures. + * @ingroup libavc + * + * Basic definitions, functions for querying libavcodec capabilities, + * allocating core structures, etc. + * @{ + */ + +/** + * @ingroup lavc_decoding + * Required number of additionally allocated bytes at the end of the input bitstream for decoding. + * This is mainly needed because some optimized bitstream readers read + * 32 or 64 bit at once and could read over the end.
+ * Note: If the first 23 bits of the additional bytes are not 0, then damaged + * MPEG bitstreams could cause overread and segfault. + */ +#define AV_INPUT_BUFFER_PADDING_SIZE 64 + +/** + * @ingroup lavc_encoding + * minimum encoding buffer size + * Used to avoid some checks during header writing. + */ +#define AV_INPUT_BUFFER_MIN_SIZE 16384 + +/** + * @ingroup lavc_decoding + */ +enum AVDiscard{ + /* We leave some space between them for extensions (drop some + * keyframes for intra-only or drop just some bidir frames). */ + AVDISCARD_NONE =-16, ///< discard nothing + AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi + AVDISCARD_NONREF = 8, ///< discard all non reference + AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames + AVDISCARD_NONINTRA= 24, ///< discard all non intra frames + AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes + AVDISCARD_ALL = 48, ///< discard all +}; + +enum AVAudioServiceType { + AV_AUDIO_SERVICE_TYPE_MAIN = 0, + AV_AUDIO_SERVICE_TYPE_EFFECTS = 1, + AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2, + AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3, + AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4, + AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5, + AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6, + AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7, + AV_AUDIO_SERVICE_TYPE_KARAOKE = 8, + AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI +}; + +/** + * @ingroup lavc_encoding + */ +typedef struct RcOverride{ + int start_frame; + int end_frame; + int qscale; // If this is 0 then quality_factor will be used instead. + float quality_factor; +} RcOverride; + +/* encoding support + These flags can be passed in AVCodecContext.flags before initialization. + Note: Not everything is supported yet. +*/ + +/** + * Allow decoders to produce frames with data planes that are not aligned + * to CPU requirements (e.g. due to cropping). + */ +#define AV_CODEC_FLAG_UNALIGNED (1 << 0) +/** + * Use fixed qscale. + */ +#define AV_CODEC_FLAG_QSCALE (1 << 1) +/** + * 4 MV per MB allowed / advanced prediction for H.263. + */ +#define AV_CODEC_FLAG_4MV (1 << 2) +/** + * Output even those frames that might be corrupted. + */ +#define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3) +/** + * Use qpel MC. + */ +#define AV_CODEC_FLAG_QPEL (1 << 4) +/** + * Don't output frames whose parameters differ from first + * decoded frame in stream. + */ +#define AV_CODEC_FLAG_DROPCHANGED (1 << 5) +/** + * Use internal 2pass ratecontrol in first pass mode. + */ +#define AV_CODEC_FLAG_PASS1 (1 << 9) +/** + * Use internal 2pass ratecontrol in second pass mode. + */ +#define AV_CODEC_FLAG_PASS2 (1 << 10) +/** + * loop filter. + */ +#define AV_CODEC_FLAG_LOOP_FILTER (1 << 11) +/** + * Only decode/encode grayscale. + */ +#define AV_CODEC_FLAG_GRAY (1 << 13) +/** + * error[?] variables will be set during encoding. + */ +#define AV_CODEC_FLAG_PSNR (1 << 15) +/** + * Input bitstream might be truncated at a random location + * instead of only at frame boundaries. + */ +#define AV_CODEC_FLAG_TRUNCATED (1 << 16) +/** + * Use interlaced DCT. + */ +#define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18) +/** + * Force low delay. + */ +#define AV_CODEC_FLAG_LOW_DELAY (1 << 19) +/** + * Place global headers in extradata instead of every keyframe. + */ +#define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22) +/** + * Use only bitexact stuff (except (I)DCT). + */ +#define AV_CODEC_FLAG_BITEXACT (1 << 23) +/* Fx : Flag for H.263+ extra options */ +/** + * H.263 advanced intra coding / MPEG-4 AC prediction + */ +#define AV_CODEC_FLAG_AC_PRED (1 << 24) +/** + * interlaced motion estimation + */ +#define AV_CODEC_FLAG_INTERLACED_ME (1 << 29) +#define AV_CODEC_FLAG_CLOSED_GOP (1U << 31) + +/** + * Allow non spec compliant speedup tricks. + */ +#define AV_CODEC_FLAG2_FAST (1 << 0) +/** + * Skip bitstream encoding. + */ +#define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2) +/** + * Place global headers at every keyframe instead of in extradata. + */ +#define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3) + +/** + * timecode is in drop frame format. DEPRECATED!!!! + */ +#define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13) + +/** + * Input bitstream might be truncated at a packet boundaries + * instead of only at frame boundaries. + */ +#define AV_CODEC_FLAG2_CHUNKS (1 << 15) +/** + * Discard cropping information from SPS. + */ +#define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16) + +/** + * Show all frames before the first keyframe + */ +#define AV_CODEC_FLAG2_SHOW_ALL (1 << 22) +/** + * Export motion vectors through frame side data + */ +#define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28) +/** + * Do not skip samples and export skip information as frame side data + */ +#define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29) +/** + * Do not reset ASS ReadOrder field on flush (subtitles decoding) + */ +#define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30) + +/* Unsupported options : + * Syntax Arithmetic coding (SAC) + * Reference Picture Selection + * Independent Segment Decoding */ +/* /Fx */ +/* codec capabilities */ + +/* Exported side data. + These flags can be passed in AVCodecContext.export_side_data before initialization. +*/ +/** + * Export motion vectors through frame side data + */ +#define AV_CODEC_EXPORT_DATA_MVS (1 << 0) +/** + * Export encoder Producer Reference Time through packet side data + */ +#define AV_CODEC_EXPORT_DATA_PRFT (1 << 1) +/** + * Decoding only. + * Export the AVVideoEncParams structure through frame side data. + */ +#define AV_CODEC_EXPORT_DATA_VIDEO_ENC_PARAMS (1 << 2) + +/** + * Pan Scan area. + * This specifies the area which should be displayed. + * Note there may be multiple such areas for one frame. + */ +typedef struct AVPanScan { + /** + * id + * - encoding: Set by user. + * - decoding: Set by libavcodec. + */ + int id; + + /** + * width and height in 1/16 pel + * - encoding: Set by user. + * - decoding: Set by libavcodec. + */ + int width; + int height; + + /** + * position of the top left corner in 1/16 pel for up to 3 fields/frames + * - encoding: Set by user. + * - decoding: Set by libavcodec. + */ + int16_t position[3][2]; +} AVPanScan; + +/** + * This structure describes the bitrate properties of an encoded bitstream. It + * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD + * parameters for H.264/HEVC. + */ +typedef struct AVCPBProperties { + /** + * Maximum bitrate of the stream, in bits per second. + * Zero if unknown or unspecified. + */ +#if FF_API_UNSANITIZED_BITRATES + int max_bitrate; +#else + int64_t max_bitrate; +#endif + /** + * Minimum bitrate of the stream, in bits per second. + * Zero if unknown or unspecified. + */ +#if FF_API_UNSANITIZED_BITRATES + int min_bitrate; +#else + int64_t min_bitrate; +#endif + /** + * Average bitrate of the stream, in bits per second. + * Zero if unknown or unspecified. + */ +#if FF_API_UNSANITIZED_BITRATES + int avg_bitrate; +#else + int64_t avg_bitrate; +#endif + + /** + * The size of the buffer to which the ratecontrol is applied, in bits. + * Zero if unknown or unspecified. + */ + int buffer_size; + + /** + * The delay between the time the packet this structure is associated with + * is received and the time when it should be decoded, in periods of a 27MHz + * clock. + * + * UINT64_MAX when unknown or unspecified. + */ + uint64_t vbv_delay; +} AVCPBProperties; + +/** + * This structure supplies correlation between a packet timestamp and a wall clock + * production time. The definition follows the Producer Reference Time ('prft') + * as defined in ISO/IEC 14496-12 + */ +typedef struct AVProducerReferenceTime { + /** + * A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()). + */ + int64_t wallclock; + int flags; +} AVProducerReferenceTime; + +/** + * The decoder will keep a reference to the frame and may reuse it later. + */ +#define AV_GET_BUFFER_FLAG_REF (1 << 0) + +struct AVCodecInternal; + +/** + * main external API structure. + * New fields can be added to the end with minor version bumps. + * Removal, reordering and changes to existing fields require a major + * version bump. + * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user + * applications. + * The name string for AVOptions options matches the associated command line + * parameter name and can be found in libavcodec/options_table.h + * The AVOption/command line parameter names differ in some cases from the C + * structure field names for historic reasons or brevity. + * sizeof(AVCodecContext) must not be used outside libav*. + */ +typedef struct AVCodecContext { + /** + * information on struct for av_log + * - set by avcodec_alloc_context3 + */ + const AVClass *av_class; + int log_level_offset; + + enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */ + const struct AVCodec *codec; + enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */ + + /** + * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A'). + * This is used to work around some encoder bugs. + * A demuxer should set this to what is stored in the field used to identify the codec. + * If there are multiple such fields in a container then the demuxer should choose the one + * which maximizes the information about the used codec. + * If the codec tag field in a container is larger than 32 bits then the demuxer should + * remap the longer ID to 32 bits with a table or other structure. Alternatively a new + * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated + * first. + * - encoding: Set by user, if not then the default based on codec_id will be used. + * - decoding: Set by user, will be converted to uppercase by libavcodec during init. + */ + unsigned int codec_tag; + + void *priv_data; + + /** + * Private context used for internal data. + * + * Unlike priv_data, this is not codec-specific. It is used in general + * libavcodec functions. + */ + struct AVCodecInternal *internal; + + /** + * Private data of the user, can be used to carry app specific stuff. + * - encoding: Set by user. + * - decoding: Set by user. + */ + void *opaque; + + /** + * the average bitrate + * - encoding: Set by user; unused for constant quantizer encoding. + * - decoding: Set by user, may be overwritten by libavcodec + * if this info is available in the stream + */ + int64_t bit_rate; + + /** + * number of bits the bitstream is allowed to diverge from the reference. + * the reference can be CBR (for CBR pass1) or VBR (for pass2) + * - encoding: Set by user; unused for constant quantizer encoding. + * - decoding: unused + */ + int bit_rate_tolerance; + + /** + * Global quality for codecs which cannot change it per frame. + * This should be proportional to MPEG-1/2/4 qscale. + * - encoding: Set by user. + * - decoding: unused + */ + int global_quality; + + /** + * - encoding: Set by user. + * - decoding: unused + */ + int compression_level; +#define FF_COMPRESSION_DEFAULT -1 + + /** + * AV_CODEC_FLAG_*. + * - encoding: Set by user. + * - decoding: Set by user. + */ + int flags; + + /** + * AV_CODEC_FLAG2_* + * - encoding: Set by user. + * - decoding: Set by user. + */ + int flags2; + + /** + * some codecs need / can use extradata like Huffman tables. + * MJPEG: Huffman tables + * rv10: additional flags + * MPEG-4: global headers (they can be in the bitstream or here) + * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger + * than extradata_size to avoid problems if it is read with the bitstream reader. + * The bytewise contents of extradata must not depend on the architecture or CPU endianness. + * Must be allocated with the av_malloc() family of functions. + * - encoding: Set/allocated/freed by libavcodec. + * - decoding: Set/allocated/freed by user. + */ + uint8_t *extradata; + int extradata_size; + + /** + * This is the fundamental unit of time (in seconds) in terms + * of which frame timestamps are represented. For fixed-fps content, + * timebase should be 1/framerate and timestamp increments should be + * identically 1. + * This often, but not always is the inverse of the frame rate or field rate + * for video. 1/time_base is not the average frame rate if the frame rate is not + * constant. + * + * Like containers, elementary streams also can store timestamps, 1/time_base + * is the unit in which these timestamps are specified. + * As example of such codec time base see ISO/IEC 14496-2:2001(E) + * vop_time_increment_resolution and fixed_vop_rate + * (fixed_vop_rate == 0 implies that it is different from the framerate) + * + * - encoding: MUST be set by user. + * - decoding: the use of this field for decoding is deprecated. + * Use framerate instead. + */ + AVRational time_base; + + /** + * For some codecs, the time base is closer to the field rate than the frame rate. + * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration + * if no telecine is used ... + * + * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2. + */ + int ticks_per_frame; + + /** + * Codec delay. + * + * Encoding: Number of frames delay there will be from the encoder input to + * the decoder output. (we assume the decoder matches the spec) + * Decoding: Number of frames delay in addition to what a standard decoder + * as specified in the spec would produce. + * + * Video: + * Number of frames the decoded output will be delayed relative to the + * encoded input. + * + * Audio: + * For encoding, this field is unused (see initial_padding). + * + * For decoding, this is the number of samples the decoder needs to + * output before the decoder's output is valid. When seeking, you should + * start decoding this many samples prior to your desired seek point. + * + * - encoding: Set by libavcodec. + * - decoding: Set by libavcodec. + */ + int delay; + + + /* video only */ + /** + * picture width / height. + * + * @note Those fields may not match the values of the last + * AVFrame output by avcodec_decode_video2 due frame + * reordering. + * + * - encoding: MUST be set by user. + * - decoding: May be set by the user before opening the decoder if known e.g. + * from the container. Some decoders will require the dimensions + * to be set by the caller. During decoding, the decoder may + * overwrite those values as required while parsing the data. + */ + int width, height; + + /** + * Bitstream width / height, may be different from width/height e.g. when + * the decoded frame is cropped before being output or lowres is enabled. + * + * @note Those field may not match the value of the last + * AVFrame output by avcodec_receive_frame() due frame + * reordering. + * + * - encoding: unused + * - decoding: May be set by the user before opening the decoder if known + * e.g. from the container. During decoding, the decoder may + * overwrite those values as required while parsing the data. + */ + int coded_width, coded_height; + + /** + * the number of pictures in a group of pictures, or 0 for intra_only + * - encoding: Set by user. + * - decoding: unused + */ + int gop_size; + + /** + * Pixel format, see AV_PIX_FMT_xxx. + * May be set by the demuxer if known from headers. + * May be overridden by the decoder if it knows better. + * + * @note This field may not match the value of the last + * AVFrame output by avcodec_receive_frame() due frame + * reordering. + * + * - encoding: Set by user. + * - decoding: Set by user if known, overridden by libavcodec while + * parsing the data. + */ + enum AVPixelFormat pix_fmt; + + /** + * If non NULL, 'draw_horiz_band' is called by the libavcodec + * decoder to draw a horizontal band. It improves cache usage. Not + * all codecs can do that. You must check the codec capabilities + * beforehand. + * When multithreading is used, it may be called from multiple threads + * at the same time; threads might draw different parts of the same AVFrame, + * or multiple AVFrames, and there is no guarantee that slices will be drawn + * in order. + * The function is also used by hardware acceleration APIs. + * It is called at least once during frame decoding to pass + * the data needed for hardware render. + * In that mode instead of pixel data, AVFrame points to + * a structure specific to the acceleration API. The application + * reads the structure and can change some fields to indicate progress + * or mark state. + * - encoding: unused + * - decoding: Set by user. + * @param height the height of the slice + * @param y the y position of the slice + * @param type 1->top field, 2->bottom field, 3->frame + * @param offset offset into the AVFrame.data from which the slice should be read + */ + void (*draw_horiz_band)(struct AVCodecContext *s, + const AVFrame *src, int offset[AV_NUM_DATA_POINTERS], + int y, int type, int height); + + /** + * callback to negotiate the pixelFormat + * @param fmt is the list of formats which are supported by the codec, + * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality. + * The first is always the native one. + * @note The callback may be called again immediately if initialization for + * the selected (hardware-accelerated) pixel format failed. + * @warning Behavior is undefined if the callback returns a value not + * in the fmt list of formats. + * @return the chosen format + * - encoding: unused + * - decoding: Set by user, if not set the native format will be chosen. + */ + enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt); + + /** + * maximum number of B-frames between non-B-frames + * Note: The output will be delayed by max_b_frames+1 relative to the input. + * - encoding: Set by user. + * - decoding: unused + */ + int max_b_frames; + + /** + * qscale factor between IP and B-frames + * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset). + * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset). + * - encoding: Set by user. + * - decoding: unused + */ + float b_quant_factor; + +#if FF_API_PRIVATE_OPT + /** @deprecated use encoder private options instead */ + attribute_deprecated + int b_frame_strategy; +#endif + + /** + * qscale offset between IP and B-frames + * - encoding: Set by user. + * - decoding: unused + */ + float b_quant_offset; + + /** + * Size of the frame reordering buffer in the decoder. + * For MPEG-2 it is 1 IPB or 0 low delay IP. + * - encoding: Set by libavcodec. + * - decoding: Set by libavcodec. + */ + int has_b_frames; + +#if FF_API_PRIVATE_OPT + /** @deprecated use encoder private options instead */ + attribute_deprecated + int mpeg_quant; +#endif + + /** + * qscale factor between P- and I-frames + * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset). + * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset). + * - encoding: Set by user. + * - decoding: unused + */ + float i_quant_factor; + + /** + * qscale offset between P and I-frames + * - encoding: Set by user. + * - decoding: unused + */ + float i_quant_offset; + + /** + * luminance masking (0-> disabled) + * - encoding: Set by user. + * - decoding: unused + */ + float lumi_masking; + + /** + * temporary complexity masking (0-> disabled) + * - encoding: Set by user. + * - decoding: unused + */ + float temporal_cplx_masking; + + /** + * spatial complexity masking (0-> disabled) + * - encoding: Set by user. + * - decoding: unused + */ + float spatial_cplx_masking; + + /** + * p block masking (0-> disabled) + * - encoding: Set by user. + * - decoding: unused + */ + float p_masking; + + /** + * darkness masking (0-> disabled) + * - encoding: Set by user. + * - decoding: unused + */ + float dark_masking; + + /** + * slice count + * - encoding: Set by libavcodec. + * - decoding: Set by user (or 0). + */ + int slice_count; + +#if FF_API_PRIVATE_OPT + /** @deprecated use encoder private options instead */ + attribute_deprecated + int prediction_method; +#define FF_PRED_LEFT 0 +#define FF_PRED_PLANE 1 +#define FF_PRED_MEDIAN 2 +#endif + + /** + * slice offsets in the frame in bytes + * - encoding: Set/allocated by libavcodec. + * - decoding: Set/allocated by user (or NULL). + */ + int *slice_offset; + + /** + * sample aspect ratio (0 if unknown) + * That is the width of a pixel divided by the height of the pixel. + * Numerator and denominator must be relatively prime and smaller than 256 for some video standards. + * - encoding: Set by user. + * - decoding: Set by libavcodec. + */ + AVRational sample_aspect_ratio; + + /** + * motion estimation comparison function + * - encoding: Set by user. + * - decoding: unused + */ + int me_cmp; + /** + * subpixel motion estimation comparison function + * - encoding: Set by user. + * - decoding: unused + */ + int me_sub_cmp; + /** + * macroblock comparison function (not supported yet) + * - encoding: Set by user. + * - decoding: unused + */ + int mb_cmp; + /** + * interlaced DCT comparison function + * - encoding: Set by user. + * - decoding: unused + */ + int ildct_cmp; +#define FF_CMP_SAD 0 +#define FF_CMP_SSE 1 +#define FF_CMP_SATD 2 +#define FF_CMP_DCT 3 +#define FF_CMP_PSNR 4 +#define FF_CMP_BIT 5 +#define FF_CMP_RD 6 +#define FF_CMP_ZERO 7 +#define FF_CMP_VSAD 8 +#define FF_CMP_VSSE 9 +#define FF_CMP_NSSE 10 +#define FF_CMP_W53 11 +#define FF_CMP_W97 12 +#define FF_CMP_DCTMAX 13 +#define FF_CMP_DCT264 14 +#define FF_CMP_MEDIAN_SAD 15 +#define FF_CMP_CHROMA 256 + + /** + * ME diamond size & shape + * - encoding: Set by user. + * - decoding: unused + */ + int dia_size; + + /** + * amount of previous MV predictors (2a+1 x 2a+1 square) + * - encoding: Set by user. + * - decoding: unused + */ + int last_predictor_count; + +#if FF_API_PRIVATE_OPT + /** @deprecated use encoder private options instead */ + attribute_deprecated + int pre_me; +#endif + + /** + * motion estimation prepass comparison function + * - encoding: Set by user. + * - decoding: unused + */ + int me_pre_cmp; + + /** + * ME prepass diamond size & shape + * - encoding: Set by user. + * - decoding: unused + */ + int pre_dia_size; + + /** + * subpel ME quality + * - encoding: Set by user. + * - decoding: unused + */ + int me_subpel_quality; + + /** + * maximum motion estimation search range in subpel units + * If 0 then no limit. + * + * - encoding: Set by user. + * - decoding: unused + */ + int me_range; + + /** + * slice flags + * - encoding: unused + * - decoding: Set by user. + */ + int slice_flags; +#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display +#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics) +#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1) + + /** + * macroblock decision mode + * - encoding: Set by user. + * - decoding: unused + */ + int mb_decision; +#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp +#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits +#define FF_MB_DECISION_RD 2 ///< rate distortion + + /** + * custom intra quantization matrix + * Must be allocated with the av_malloc() family of functions, and will be freed in + * avcodec_free_context(). + * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL. + * - decoding: Set/allocated/freed by libavcodec. + */ + uint16_t *intra_matrix; + + /** + * custom inter quantization matrix + * Must be allocated with the av_malloc() family of functions, and will be freed in + * avcodec_free_context(). + * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL. + * - decoding: Set/allocated/freed by libavcodec. + */ + uint16_t *inter_matrix; + +#if FF_API_PRIVATE_OPT + /** @deprecated use encoder private options instead */ + attribute_deprecated + int scenechange_threshold; + + /** @deprecated use encoder private options instead */ + attribute_deprecated + int noise_reduction; +#endif + + /** + * precision of the intra DC coefficient - 8 + * - encoding: Set by user. + * - decoding: Set by libavcodec + */ + int intra_dc_precision; + + /** + * Number of macroblock rows at the top which are skipped. + * - encoding: unused + * - decoding: Set by user. + */ + int skip_top; + + /** + * Number of macroblock rows at the bottom which are skipped. + * - encoding: unused + * - decoding: Set by user. + */ + int skip_bottom; + + /** + * minimum MB Lagrange multiplier + * - encoding: Set by user. + * - decoding: unused + */ + int mb_lmin; + + /** + * maximum MB Lagrange multiplier + * - encoding: Set by user. + * - decoding: unused + */ + int mb_lmax; + +#if FF_API_PRIVATE_OPT + /** + * @deprecated use encoder private options instead + */ + attribute_deprecated + int me_penalty_compensation; +#endif + + /** + * - encoding: Set by user. + * - decoding: unused + */ + int bidir_refine; + +#if FF_API_PRIVATE_OPT + /** @deprecated use encoder private options instead */ + attribute_deprecated + int brd_scale; +#endif + + /** + * minimum GOP size + * - encoding: Set by user. + * - decoding: unused + */ + int keyint_min; + + /** + * number of reference frames + * - encoding: Set by user. + * - decoding: Set by lavc. + */ + int refs; + +#if FF_API_PRIVATE_OPT + /** @deprecated use encoder private options instead */ + attribute_deprecated + int chromaoffset; +#endif + + /** + * Note: Value depends upon the compare function used for fullpel ME. + * - encoding: Set by user. + * - decoding: unused + */ + int mv0_threshold; + +#if FF_API_PRIVATE_OPT + /** @deprecated use encoder private options instead */ + attribute_deprecated + int b_sensitivity; +#endif + + /** + * Chromaticity coordinates of the source primaries. + * - encoding: Set by user + * - decoding: Set by libavcodec + */ + enum AVColorPrimaries color_primaries; + + /** + * Color Transfer Characteristic. + * - encoding: Set by user + * - decoding: Set by libavcodec + */ + enum AVColorTransferCharacteristic color_trc; + + /** + * YUV colorspace type. + * - encoding: Set by user + * - decoding: Set by libavcodec + */ + enum AVColorSpace colorspace; + + /** + * MPEG vs JPEG YUV range. + * - encoding: Set by user + * - decoding: Set by libavcodec + */ + enum AVColorRange color_range; + + /** + * This defines the location of chroma samples. + * - encoding: Set by user + * - decoding: Set by libavcodec + */ + enum AVChromaLocation chroma_sample_location; + + /** + * Number of slices. + * Indicates number of picture subdivisions. Used for parallelized + * decoding. + * - encoding: Set by user + * - decoding: unused + */ + int slices; + + /** Field order + * - encoding: set by libavcodec + * - decoding: Set by user. + */ + enum AVFieldOrder field_order; + + /* audio only */ + int sample_rate; ///< samples per second + int channels; ///< number of audio channels + + /** + * audio sample format + * - encoding: Set by user. + * - decoding: Set by libavcodec. + */ + enum AVSampleFormat sample_fmt; ///< sample format + + /* The following data should not be initialized. */ + /** + * Number of samples per channel in an audio frame. + * + * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame + * except the last must contain exactly frame_size samples per channel. + * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the + * frame size is not restricted. + * - decoding: may be set by some decoders to indicate constant frame size + */ + int frame_size; + + /** + * Frame counter, set by libavcodec. + * + * - decoding: total number of frames returned from the decoder so far. + * - encoding: total number of frames passed to the encoder so far. + * + * @note the counter is not incremented if encoding/decoding resulted in + * an error. + */ + int frame_number; + + /** + * number of bytes per packet if constant and known or 0 + * Used by some WAV based audio codecs. + */ + int block_align; + + /** + * Audio cutoff bandwidth (0 means "automatic") + * - encoding: Set by user. + * - decoding: unused + */ + int cutoff; + + /** + * Audio channel layout. + * - encoding: set by user. + * - decoding: set by user, may be overwritten by libavcodec. + */ + uint64_t channel_layout; + + /** + * Request decoder to use this channel layout if it can (0 for default) + * - encoding: unused + * - decoding: Set by user. + */ + uint64_t request_channel_layout; + + /** + * Type of service that the audio stream conveys. + * - encoding: Set by user. + * - decoding: Set by libavcodec. + */ + enum AVAudioServiceType audio_service_type; + + /** + * desired sample format + * - encoding: Not used. + * - decoding: Set by user. + * Decoder will decode to this format if it can. + */ + enum AVSampleFormat request_sample_fmt; + + /** + * This callback is called at the beginning of each frame to get data + * buffer(s) for it. There may be one contiguous buffer for all the data or + * there may be a buffer per each data plane or anything in between. What + * this means is, you may set however many entries in buf[] you feel necessary. + * Each buffer must be reference-counted using the AVBuffer API (see description + * of buf[] below). + * + * The following fields will be set in the frame before this callback is + * called: + * - format + * - width, height (video only) + * - sample_rate, channel_layout, nb_samples (audio only) + * Their values may differ from the corresponding values in + * AVCodecContext. This callback must use the frame values, not the codec + * context values, to calculate the required buffer size. + * + * This callback must fill the following fields in the frame: + * - data[] + * - linesize[] + * - extended_data: + * * if the data is planar audio with more than 8 channels, then this + * callback must allocate and fill extended_data to contain all pointers + * to all data planes. data[] must hold as many pointers as it can. + * extended_data must be allocated with av_malloc() and will be freed in + * av_frame_unref(). + * * otherwise extended_data must point to data + * - buf[] must contain one or more pointers to AVBufferRef structures. Each of + * the frame's data and extended_data pointers must be contained in these. That + * is, one AVBufferRef for each allocated chunk of memory, not necessarily one + * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(), + * and av_buffer_ref(). + * - extended_buf and nb_extended_buf must be allocated with av_malloc() by + * this callback and filled with the extra buffers if there are more + * buffers than buf[] can hold. extended_buf will be freed in + * av_frame_unref(). + * + * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call + * avcodec_default_get_buffer2() instead of providing buffers allocated by + * some other means. + * + * Each data plane must be aligned to the maximum required by the target + * CPU. + * + * @see avcodec_default_get_buffer2() + * + * Video: + * + * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused + * (read and/or written to if it is writable) later by libavcodec. + * + * avcodec_align_dimensions2() should be used to find the required width and + * height, as they normally need to be rounded up to the next multiple of 16. + * + * Some decoders do not support linesizes changing between frames. + * + * If frame multithreading is used and thread_safe_callbacks is set, + * this callback may be called from a different thread, but not from more + * than one at once. Does not need to be reentrant. + * + * @see avcodec_align_dimensions2() + * + * Audio: + * + * Decoders request a buffer of a particular size by setting + * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may, + * however, utilize only part of the buffer by setting AVFrame.nb_samples + * to a smaller value in the output frame. + * + * As a convenience, av_samples_get_buffer_size() and + * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2() + * functions to find the required data size and to fill data pointers and + * linesize. In AVFrame.linesize, only linesize[0] may be set for audio + * since all planes must be the same size. + * + * @see av_samples_get_buffer_size(), av_samples_fill_arrays() + * + * - encoding: unused + * - decoding: Set by libavcodec, user can override. + */ + int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags); + + /** + * If non-zero, the decoded audio and video frames returned from + * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted + * and are valid indefinitely. The caller must free them with + * av_frame_unref() when they are not needed anymore. + * Otherwise, the decoded frames must not be freed by the caller and are + * only valid until the next decode call. + * + * This is always automatically enabled if avcodec_receive_frame() is used. + * + * - encoding: unused + * - decoding: set by the caller before avcodec_open2(). + */ + attribute_deprecated + int refcounted_frames; + + /* - encoding parameters */ + float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0) + float qblur; ///< amount of qscale smoothing over time (0.0-1.0) + + /** + * minimum quantizer + * - encoding: Set by user. + * - decoding: unused + */ + int qmin; + + /** + * maximum quantizer + * - encoding: Set by user. + * - decoding: unused + */ + int qmax; + + /** + * maximum quantizer difference between frames + * - encoding: Set by user. + * - decoding: unused + */ + int max_qdiff; + + /** + * decoder bitstream buffer size + * - encoding: Set by user. + * - decoding: unused + */ + int rc_buffer_size; + + /** + * ratecontrol override, see RcOverride + * - encoding: Allocated/set/freed by user. + * - decoding: unused + */ + int rc_override_count; + RcOverride *rc_override; + + /** + * maximum bitrate + * - encoding: Set by user. + * - decoding: Set by user, may be overwritten by libavcodec. + */ + int64_t rc_max_rate; + + /** + * minimum bitrate + * - encoding: Set by user. + * - decoding: unused + */ + int64_t rc_min_rate; + + /** + * Ratecontrol attempt to use, at maximum, of what can be used without an underflow. + * - encoding: Set by user. + * - decoding: unused. + */ + float rc_max_available_vbv_use; + + /** + * Ratecontrol attempt to use, at least, times the amount needed to prevent a vbv overflow. + * - encoding: Set by user. + * - decoding: unused. + */ + float rc_min_vbv_overflow_use; + + /** + * Number of bits which should be loaded into the rc buffer before decoding starts. + * - encoding: Set by user. + * - decoding: unused + */ + int rc_initial_buffer_occupancy; + +#if FF_API_CODER_TYPE +#define FF_CODER_TYPE_VLC 0 +#define FF_CODER_TYPE_AC 1 +#define FF_CODER_TYPE_RAW 2 +#define FF_CODER_TYPE_RLE 3 + /** + * @deprecated use encoder private options instead + */ + attribute_deprecated + int coder_type; +#endif /* FF_API_CODER_TYPE */ + +#if FF_API_PRIVATE_OPT + /** @deprecated use encoder private options instead */ + attribute_deprecated + int context_model; +#endif + +#if FF_API_PRIVATE_OPT + /** @deprecated use encoder private options instead */ + attribute_deprecated + int frame_skip_threshold; + + /** @deprecated use encoder private options instead */ + attribute_deprecated + int frame_skip_factor; + + /** @deprecated use encoder private options instead */ + attribute_deprecated + int frame_skip_exp; + + /** @deprecated use encoder private options instead */ + attribute_deprecated + int frame_skip_cmp; +#endif /* FF_API_PRIVATE_OPT */ + + /** + * trellis RD quantization + * - encoding: Set by user. + * - decoding: unused + */ + int trellis; + +#if FF_API_PRIVATE_OPT + /** @deprecated use encoder private options instead */ + attribute_deprecated + int min_prediction_order; + + /** @deprecated use encoder private options instead */ + attribute_deprecated + int max_prediction_order; + + /** @deprecated use encoder private options instead */ + attribute_deprecated + int64_t timecode_frame_start; +#endif + +#if FF_API_RTP_CALLBACK + /** + * @deprecated unused + */ + /* The RTP callback: This function is called */ + /* every time the encoder has a packet to send. */ + /* It depends on the encoder if the data starts */ + /* with a Start Code (it should). H.263 does. */ + /* mb_nb contains the number of macroblocks */ + /* encoded in the RTP payload. */ + attribute_deprecated + void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb); +#endif + +#if FF_API_PRIVATE_OPT + /** @deprecated use encoder private options instead */ + attribute_deprecated + int rtp_payload_size; /* The size of the RTP payload: the coder will */ + /* do its best to deliver a chunk with size */ + /* below rtp_payload_size, the chunk will start */ + /* with a start code on some codecs like H.263. */ + /* This doesn't take account of any particular */ + /* headers inside the transmitted RTP payload. */ +#endif + +#if FF_API_STAT_BITS + /* statistics, used for 2-pass encoding */ + attribute_deprecated + int mv_bits; + attribute_deprecated + int header_bits; + attribute_deprecated + int i_tex_bits; + attribute_deprecated + int p_tex_bits; + attribute_deprecated + int i_count; + attribute_deprecated + int p_count; + attribute_deprecated + int skip_count; + attribute_deprecated + int misc_bits; + + /** @deprecated this field is unused */ + attribute_deprecated + int frame_bits; +#endif + + /** + * pass1 encoding statistics output buffer + * - encoding: Set by libavcodec. + * - decoding: unused + */ + char *stats_out; + + /** + * pass2 encoding statistics input buffer + * Concatenated stuff from stats_out of pass1 should be placed here. + * - encoding: Allocated/set/freed by user. + * - decoding: unused + */ + char *stats_in; + + /** + * Work around bugs in encoders which sometimes cannot be detected automatically. + * - encoding: Set by user + * - decoding: Set by user + */ + int workaround_bugs; +#define FF_BUG_AUTODETECT 1 ///< autodetection +#define FF_BUG_XVID_ILACE 4 +#define FF_BUG_UMP4 8 +#define FF_BUG_NO_PADDING 16 +#define FF_BUG_AMV 32 +#define FF_BUG_QPEL_CHROMA 64 +#define FF_BUG_STD_QPEL 128 +#define FF_BUG_QPEL_CHROMA2 256 +#define FF_BUG_DIRECT_BLOCKSIZE 512 +#define FF_BUG_EDGE 1024 +#define FF_BUG_HPEL_CHROMA 2048 +#define FF_BUG_DC_CLIP 4096 +#define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders. +#define FF_BUG_TRUNCATED 16384 +#define FF_BUG_IEDGE 32768 + + /** + * strictly follow the standard (MPEG-4, ...). + * - encoding: Set by user. + * - decoding: Set by user. + * Setting this to STRICT or higher means the encoder and decoder will + * generally do stupid things, whereas setting it to unofficial or lower + * will mean the encoder might produce output that is not supported by all + * spec-compliant decoders. Decoders don't differentiate between normal, + * unofficial and experimental (that is, they always try to decode things + * when they can) unless they are explicitly asked to behave stupidly + * (=strictly conform to the specs) + */ + int strict_std_compliance; +#define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software. +#define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences. +#define FF_COMPLIANCE_NORMAL 0 +#define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions +#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things. + + /** + * error concealment flags + * - encoding: unused + * - decoding: Set by user. + */ + int error_concealment; +#define FF_EC_GUESS_MVS 1 +#define FF_EC_DEBLOCK 2 +#define FF_EC_FAVOR_INTER 256 + + /** + * debug + * - encoding: Set by user. + * - decoding: Set by user. + */ + int debug; +#define FF_DEBUG_PICT_INFO 1 +#define FF_DEBUG_RC 2 +#define FF_DEBUG_BITSTREAM 4 +#define FF_DEBUG_MB_TYPE 8 +#define FF_DEBUG_QP 16 +#if FF_API_DEBUG_MV +/** + * @deprecated this option does nothing + */ +#define FF_DEBUG_MV 32 +#endif +#define FF_DEBUG_DCT_COEFF 0x00000040 +#define FF_DEBUG_SKIP 0x00000080 +#define FF_DEBUG_STARTCODE 0x00000100 +#define FF_DEBUG_ER 0x00000400 +#define FF_DEBUG_MMCO 0x00000800 +#define FF_DEBUG_BUGS 0x00001000 +#if FF_API_DEBUG_MV +#define FF_DEBUG_VIS_QP 0x00002000 +#define FF_DEBUG_VIS_MB_TYPE 0x00004000 +#endif +#define FF_DEBUG_BUFFERS 0x00008000 +#define FF_DEBUG_THREADS 0x00010000 +#define FF_DEBUG_GREEN_MD 0x00800000 +#define FF_DEBUG_NOMC 0x01000000 + +#if FF_API_DEBUG_MV + /** + * debug + * - encoding: Set by user. + * - decoding: Set by user. + */ + int debug_mv; +#define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames +#define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames +#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames +#endif + + /** + * Error recognition; may misdetect some more or less valid parts as errors. + * - encoding: unused + * - decoding: Set by user. + */ + int err_recognition; + +/** + * Verify checksums embedded in the bitstream (could be of either encoded or + * decoded data, depending on the codec) and print an error message on mismatch. + * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the + * decoder returning an error. + */ +#define AV_EF_CRCCHECK (1<<0) +#define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations +#define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length +#define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection + +#define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue +#define AV_EF_CAREFUL (1<<16) ///< consider things that violate the spec, are fast to calculate and have not been seen in the wild as errors +#define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors +#define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error + + + /** + * opaque 64-bit number (generally a PTS) that will be reordered and + * output in AVFrame.reordered_opaque + * - encoding: Set by libavcodec to the reordered_opaque of the input + * frame corresponding to the last returned packet. Only + * supported by encoders with the + * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability. + * - decoding: Set by user. + */ + int64_t reordered_opaque; + + /** + * Hardware accelerator in use + * - encoding: unused. + * - decoding: Set by libavcodec + */ + const struct AVHWAccel *hwaccel; + + /** + * Hardware accelerator context. + * For some hardware accelerators, a global context needs to be + * provided by the user. In that case, this holds display-dependent + * data FFmpeg cannot instantiate itself. Please refer to the + * FFmpeg HW accelerator documentation to know how to fill this + * is. e.g. for VA API, this is a struct vaapi_context. + * - encoding: unused + * - decoding: Set by user + */ + void *hwaccel_context; + + /** + * error + * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR. + * - decoding: unused + */ + uint64_t error[AV_NUM_DATA_POINTERS]; + + /** + * DCT algorithm, see FF_DCT_* below + * - encoding: Set by user. + * - decoding: unused + */ + int dct_algo; +#define FF_DCT_AUTO 0 +#define FF_DCT_FASTINT 1 +#define FF_DCT_INT 2 +#define FF_DCT_MMX 3 +#define FF_DCT_ALTIVEC 5 +#define FF_DCT_FAAN 6 + + /** + * IDCT algorithm, see FF_IDCT_* below. + * - encoding: Set by user. + * - decoding: Set by user. + */ + int idct_algo; +#define FF_IDCT_AUTO 0 +#define FF_IDCT_INT 1 +#define FF_IDCT_SIMPLE 2 +#define FF_IDCT_SIMPLEMMX 3 +#define FF_IDCT_ARM 7 +#define FF_IDCT_ALTIVEC 8 +#define FF_IDCT_SIMPLEARM 10 +#define FF_IDCT_XVID 14 +#define FF_IDCT_SIMPLEARMV5TE 16 +#define FF_IDCT_SIMPLEARMV6 17 +#define FF_IDCT_FAAN 20 +#define FF_IDCT_SIMPLENEON 22 +#define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */ +#define FF_IDCT_SIMPLEAUTO 128 + + /** + * bits per sample/pixel from the demuxer (needed for huffyuv). + * - encoding: Set by libavcodec. + * - decoding: Set by user. + */ + int bits_per_coded_sample; + + /** + * Bits per sample/pixel of internal libavcodec pixel/sample format. + * - encoding: set by user. + * - decoding: set by libavcodec. + */ + int bits_per_raw_sample; + +#if FF_API_LOWRES + /** + * low resolution decoding, 1-> 1/2 size, 2->1/4 size + * - encoding: unused + * - decoding: Set by user. + */ + int lowres; +#endif + +#if FF_API_CODED_FRAME + /** + * the picture in the bitstream + * - encoding: Set by libavcodec. + * - decoding: unused + * + * @deprecated use the quality factor packet side data instead + */ + attribute_deprecated AVFrame *coded_frame; +#endif + + /** + * thread count + * is used to decide how many independent tasks should be passed to execute() + * - encoding: Set by user. + * - decoding: Set by user. + */ + int thread_count; + + /** + * Which multithreading methods to use. + * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread, + * so clients which cannot provide future frames should not use it. + * + * - encoding: Set by user, otherwise the default is used. + * - decoding: Set by user, otherwise the default is used. + */ + int thread_type; +#define FF_THREAD_FRAME 1 ///< Decode more than one frame at once +#define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once + + /** + * Which multithreading methods are in use by the codec. + * - encoding: Set by libavcodec. + * - decoding: Set by libavcodec. + */ + int active_thread_type; + + /** + * Set by the client if its custom get_buffer() callback can be called + * synchronously from another thread, which allows faster multithreaded decoding. + * draw_horiz_band() will be called from other threads regardless of this setting. + * Ignored if the default get_buffer() is used. + * - encoding: Set by user. + * - decoding: Set by user. + */ + int thread_safe_callbacks; + + /** + * The codec may call this to execute several independent things. + * It will return only after finishing all tasks. + * The user may replace this with some multithreaded implementation, + * the default implementation will execute the parts serially. + * @param count the number of things to execute + * - encoding: Set by libavcodec, user can override. + * - decoding: Set by libavcodec, user can override. + */ + int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size); + + /** + * The codec may call this to execute several independent things. + * It will return only after finishing all tasks. + * The user may replace this with some multithreaded implementation, + * the default implementation will execute the parts serially. + * Also see avcodec_thread_init and e.g. the --enable-pthread configure option. + * @param c context passed also to func + * @param count the number of things to execute + * @param arg2 argument passed unchanged to func + * @param ret return values of executed functions, must have space for "count" values. May be NULL. + * @param func function that will be called count times, with jobnr from 0 to count-1. + * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no + * two instances of func executing at the same time will have the same threadnr. + * @return always 0 currently, but code should handle a future improvement where when any call to func + * returns < 0 no further calls to func may be done and < 0 is returned. + * - encoding: Set by libavcodec, user can override. + * - decoding: Set by libavcodec, user can override. + */ + int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count); + + /** + * noise vs. sse weight for the nsse comparison function + * - encoding: Set by user. + * - decoding: unused + */ + int nsse_weight; + + /** + * profile + * - encoding: Set by user. + * - decoding: Set by libavcodec. + */ + int profile; +#define FF_PROFILE_UNKNOWN -99 +#define FF_PROFILE_RESERVED -100 + +#define FF_PROFILE_AAC_MAIN 0 +#define FF_PROFILE_AAC_LOW 1 +#define FF_PROFILE_AAC_SSR 2 +#define FF_PROFILE_AAC_LTP 3 +#define FF_PROFILE_AAC_HE 4 +#define FF_PROFILE_AAC_HE_V2 28 +#define FF_PROFILE_AAC_LD 22 +#define FF_PROFILE_AAC_ELD 38 +#define FF_PROFILE_MPEG2_AAC_LOW 128 +#define FF_PROFILE_MPEG2_AAC_HE 131 + +#define FF_PROFILE_DNXHD 0 +#define FF_PROFILE_DNXHR_LB 1 +#define FF_PROFILE_DNXHR_SQ 2 +#define FF_PROFILE_DNXHR_HQ 3 +#define FF_PROFILE_DNXHR_HQX 4 +#define FF_PROFILE_DNXHR_444 5 + +#define FF_PROFILE_DTS 20 +#define FF_PROFILE_DTS_ES 30 +#define FF_PROFILE_DTS_96_24 40 +#define FF_PROFILE_DTS_HD_HRA 50 +#define FF_PROFILE_DTS_HD_MA 60 +#define FF_PROFILE_DTS_EXPRESS 70 + +#define FF_PROFILE_MPEG2_422 0 +#define FF_PROFILE_MPEG2_HIGH 1 +#define FF_PROFILE_MPEG2_SS 2 +#define FF_PROFILE_MPEG2_SNR_SCALABLE 3 +#define FF_PROFILE_MPEG2_MAIN 4 +#define FF_PROFILE_MPEG2_SIMPLE 5 + +#define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag +#define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag + +#define FF_PROFILE_H264_BASELINE 66 +#define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED) +#define FF_PROFILE_H264_MAIN 77 +#define FF_PROFILE_H264_EXTENDED 88 +#define FF_PROFILE_H264_HIGH 100 +#define FF_PROFILE_H264_HIGH_10 110 +#define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA) +#define FF_PROFILE_H264_MULTIVIEW_HIGH 118 +#define FF_PROFILE_H264_HIGH_422 122 +#define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA) +#define FF_PROFILE_H264_STEREO_HIGH 128 +#define FF_PROFILE_H264_HIGH_444 144 +#define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244 +#define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA) +#define FF_PROFILE_H264_CAVLC_444 44 + +#define FF_PROFILE_VC1_SIMPLE 0 +#define FF_PROFILE_VC1_MAIN 1 +#define FF_PROFILE_VC1_COMPLEX 2 +#define FF_PROFILE_VC1_ADVANCED 3 + +#define FF_PROFILE_MPEG4_SIMPLE 0 +#define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1 +#define FF_PROFILE_MPEG4_CORE 2 +#define FF_PROFILE_MPEG4_MAIN 3 +#define FF_PROFILE_MPEG4_N_BIT 4 +#define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5 +#define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6 +#define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7 +#define FF_PROFILE_MPEG4_HYBRID 8 +#define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9 +#define FF_PROFILE_MPEG4_CORE_SCALABLE 10 +#define FF_PROFILE_MPEG4_ADVANCED_CODING 11 +#define FF_PROFILE_MPEG4_ADVANCED_CORE 12 +#define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13 +#define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14 +#define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15 + +#define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1 +#define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2 +#define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768 +#define FF_PROFILE_JPEG2000_DCINEMA_2K 3 +#define FF_PROFILE_JPEG2000_DCINEMA_4K 4 + +#define FF_PROFILE_VP9_0 0 +#define FF_PROFILE_VP9_1 1 +#define FF_PROFILE_VP9_2 2 +#define FF_PROFILE_VP9_3 3 + +#define FF_PROFILE_HEVC_MAIN 1 +#define FF_PROFILE_HEVC_MAIN_10 2 +#define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3 +#define FF_PROFILE_HEVC_REXT 4 + +#define FF_PROFILE_AV1_MAIN 0 +#define FF_PROFILE_AV1_HIGH 1 +#define FF_PROFILE_AV1_PROFESSIONAL 2 + +#define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0 +#define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1 +#define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2 +#define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3 +#define FF_PROFILE_MJPEG_JPEG_LS 0xf7 + +#define FF_PROFILE_SBC_MSBC 1 + +#define FF_PROFILE_PRORES_PROXY 0 +#define FF_PROFILE_PRORES_LT 1 +#define FF_PROFILE_PRORES_STANDARD 2 +#define FF_PROFILE_PRORES_HQ 3 +#define FF_PROFILE_PRORES_4444 4 +#define FF_PROFILE_PRORES_XQ 5 + +#define FF_PROFILE_ARIB_PROFILE_A 0 +#define FF_PROFILE_ARIB_PROFILE_C 1 + +#define FF_PROFILE_KLVA_SYNC 0 +#define FF_PROFILE_KLVA_ASYNC 1 + + /** + * level + * - encoding: Set by user. + * - decoding: Set by libavcodec. + */ + int level; +#define FF_LEVEL_UNKNOWN -99 + + /** + * Skip loop filtering for selected frames. + * - encoding: unused + * - decoding: Set by user. + */ + enum AVDiscard skip_loop_filter; + + /** + * Skip IDCT/dequantization for selected frames. + * - encoding: unused + * - decoding: Set by user. + */ + enum AVDiscard skip_idct; + + /** + * Skip decoding for selected frames. + * - encoding: unused + * - decoding: Set by user. + */ + enum AVDiscard skip_frame; + + /** + * Header containing style information for text subtitles. + * For SUBTITLE_ASS subtitle type, it should contain the whole ASS + * [Script Info] and [V4+ Styles] section, plus the [Events] line and + * the Format line following. It shouldn't include any Dialogue line. + * - encoding: Set/allocated/freed by user (before avcodec_open2()) + * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2()) + */ + uint8_t *subtitle_header; + int subtitle_header_size; + +#if FF_API_VBV_DELAY + /** + * VBV delay coded in the last frame (in periods of a 27 MHz clock). + * Used for compliant TS muxing. + * - encoding: Set by libavcodec. + * - decoding: unused. + * @deprecated this value is now exported as a part of + * AV_PKT_DATA_CPB_PROPERTIES packet side data + */ + attribute_deprecated + uint64_t vbv_delay; +#endif + +#if FF_API_SIDEDATA_ONLY_PKT + /** + * Encoding only and set by default. Allow encoders to output packets + * that do not contain any encoded data, only side data. + * + * Some encoders need to output such packets, e.g. to update some stream + * parameters at the end of encoding. + * + * @deprecated this field disables the default behaviour and + * it is kept only for compatibility. + */ + attribute_deprecated + int side_data_only_packets; +#endif + + /** + * Audio only. The number of "priming" samples (padding) inserted by the + * encoder at the beginning of the audio. I.e. this number of leading + * decoded samples must be discarded by the caller to get the original audio + * without leading padding. + * + * - decoding: unused + * - encoding: Set by libavcodec. The timestamps on the output packets are + * adjusted by the encoder so that they always refer to the + * first sample of the data actually contained in the packet, + * including any added padding. E.g. if the timebase is + * 1/samplerate and the timestamp of the first input sample is + * 0, the timestamp of the first output packet will be + * -initial_padding. + */ + int initial_padding; + + /** + * - decoding: For codecs that store a framerate value in the compressed + * bitstream, the decoder may export it here. { 0, 1} when + * unknown. + * - encoding: May be used to signal the framerate of CFR content to an + * encoder. + */ + AVRational framerate; + + /** + * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx. + * - encoding: unused. + * - decoding: Set by libavcodec before calling get_format() + */ + enum AVPixelFormat sw_pix_fmt; + + /** + * Timebase in which pkt_dts/pts and AVPacket.dts/pts are. + * - encoding unused. + * - decoding set by user. + */ + AVRational pkt_timebase; + + /** + * AVCodecDescriptor + * - encoding: unused. + * - decoding: set by libavcodec. + */ + const AVCodecDescriptor *codec_descriptor; + +#if !FF_API_LOWRES + /** + * low resolution decoding, 1-> 1/2 size, 2->1/4 size + * - encoding: unused + * - decoding: Set by user. + */ + int lowres; +#endif + + /** + * Current statistics for PTS correction. + * - decoding: maintained and used by libavcodec, not intended to be used by user apps + * - encoding: unused + */ + int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far + int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far + int64_t pts_correction_last_pts; /// PTS of the last frame + int64_t pts_correction_last_dts; /// DTS of the last frame + + /** + * Character encoding of the input subtitles file. + * - decoding: set by user + * - encoding: unused + */ + char *sub_charenc; + + /** + * Subtitles character encoding mode. Formats or codecs might be adjusting + * this setting (if they are doing the conversion themselves for instance). + * - decoding: set by libavcodec + * - encoding: unused + */ + int sub_charenc_mode; +#define FF_SUB_CHARENC_MODE_DO_NOTHING -1 ///< do nothing (demuxer outputs a stream supposed to be already in UTF-8, or the codec is bitmap for instance) +#define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself +#define FF_SUB_CHARENC_MODE_PRE_DECODER 1 ///< the AVPacket data needs to be recoded to UTF-8 before being fed to the decoder, requires iconv +#define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8 + + /** + * Skip processing alpha if supported by codec. + * Note that if the format uses pre-multiplied alpha (common with VP6, + * and recommended due to better video quality/compression) + * the image will look as if alpha-blended onto a black background. + * However for formats that do not use pre-multiplied alpha + * there might be serious artefacts (though e.g. libswscale currently + * assumes pre-multiplied alpha anyway). + * + * - decoding: set by user + * - encoding: unused + */ + int skip_alpha; + + /** + * Number of samples to skip after a discontinuity + * - decoding: unused + * - encoding: set by libavcodec + */ + int seek_preroll; + +#if !FF_API_DEBUG_MV + /** + * debug motion vectors + * - encoding: Set by user. + * - decoding: Set by user. + */ + int debug_mv; +#define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames +#define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames +#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames +#endif + + /** + * custom intra quantization matrix + * - encoding: Set by user, can be NULL. + * - decoding: unused. + */ + uint16_t *chroma_intra_matrix; + + /** + * dump format separator. + * can be ", " or "\n " or anything else + * - encoding: Set by user. + * - decoding: Set by user. + */ + uint8_t *dump_separator; + + /** + * ',' separated list of allowed decoders. + * If NULL then all are allowed + * - encoding: unused + * - decoding: set by user + */ + char *codec_whitelist; + + /** + * Properties of the stream that gets decoded + * - encoding: unused + * - decoding: set by libavcodec + */ + unsigned properties; +#define FF_CODEC_PROPERTY_LOSSLESS 0x00000001 +#define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002 + + /** + * Additional data associated with the entire coded stream. + * + * - decoding: unused + * - encoding: may be set by libavcodec after avcodec_open2(). + */ + AVPacketSideData *coded_side_data; + int nb_coded_side_data; + + /** + * A reference to the AVHWFramesContext describing the input (for encoding) + * or output (decoding) frames. The reference is set by the caller and + * afterwards owned (and freed) by libavcodec - it should never be read by + * the caller after being set. + * + * - decoding: This field should be set by the caller from the get_format() + * callback. The previous reference (if any) will always be + * unreffed by libavcodec before the get_format() call. + * + * If the default get_buffer2() is used with a hwaccel pixel + * format, then this AVHWFramesContext will be used for + * allocating the frame buffers. + * + * - encoding: For hardware encoders configured to use a hwaccel pixel + * format, this field should be set by the caller to a reference + * to the AVHWFramesContext describing input frames. + * AVHWFramesContext.format must be equal to + * AVCodecContext.pix_fmt. + * + * This field should be set before avcodec_open2() is called. + */ + AVBufferRef *hw_frames_ctx; + + /** + * Control the form of AVSubtitle.rects[N]->ass + * - decoding: set by user + * - encoding: unused + */ + int sub_text_format; +#define FF_SUB_TEXT_FMT_ASS 0 +#if FF_API_ASS_TIMING +#define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1 +#endif + + /** + * Audio only. The amount of padding (in samples) appended by the encoder to + * the end of the audio. I.e. this number of decoded samples must be + * discarded by the caller from the end of the stream to get the original + * audio without any trailing padding. + * + * - decoding: unused + * - encoding: unused + */ + int trailing_padding; + + /** + * The number of pixels per image to maximally accept. + * + * - decoding: set by user + * - encoding: set by user + */ + int64_t max_pixels; + + /** + * A reference to the AVHWDeviceContext describing the device which will + * be used by a hardware encoder/decoder. The reference is set by the + * caller and afterwards owned (and freed) by libavcodec. + * + * This should be used if either the codec device does not require + * hardware frames or any that are used are to be allocated internally by + * libavcodec. If the user wishes to supply any of the frames used as + * encoder input or decoder output then hw_frames_ctx should be used + * instead. When hw_frames_ctx is set in get_format() for a decoder, this + * field will be ignored while decoding the associated stream segment, but + * may again be used on a following one after another get_format() call. + * + * For both encoders and decoders this field should be set before + * avcodec_open2() is called and must not be written to thereafter. + * + * Note that some decoders may require this field to be set initially in + * order to support hw_frames_ctx at all - in that case, all frames + * contexts used must be created on the same device. + */ + AVBufferRef *hw_device_ctx; + + /** + * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated + * decoding (if active). + * - encoding: unused + * - decoding: Set by user (either before avcodec_open2(), or in the + * AVCodecContext.get_format callback) + */ + int hwaccel_flags; + + /** + * Video decoding only. Certain video codecs support cropping, meaning that + * only a sub-rectangle of the decoded frame is intended for display. This + * option controls how cropping is handled by libavcodec. + * + * When set to 1 (the default), libavcodec will apply cropping internally. + * I.e. it will modify the output frame width/height fields and offset the + * data pointers (only by as much as possible while preserving alignment, or + * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that + * the frames output by the decoder refer only to the cropped area. The + * crop_* fields of the output frames will be zero. + * + * When set to 0, the width/height fields of the output frames will be set + * to the coded dimensions and the crop_* fields will describe the cropping + * rectangle. Applying the cropping is left to the caller. + * + * @warning When hardware acceleration with opaque output frames is used, + * libavcodec is unable to apply cropping from the top/left border. + * + * @note when this option is set to zero, the width/height fields of the + * AVCodecContext and output AVFrames have different meanings. The codec + * context fields store display dimensions (with the coded dimensions in + * coded_width/height), while the frame fields store the coded dimensions + * (with the display dimensions being determined by the crop_* fields). + */ + int apply_cropping; + + /* + * Video decoding only. Sets the number of extra hardware frames which + * the decoder will allocate for use by the caller. This must be set + * before avcodec_open2() is called. + * + * Some hardware decoders require all frames that they will use for + * output to be defined in advance before decoding starts. For such + * decoders, the hardware frame pool must therefore be of a fixed size. + * The extra frames set here are on top of any number that the decoder + * needs internally in order to operate normally (for example, frames + * used as reference pictures). + */ + int extra_hw_frames; + + /** + * The percentage of damaged samples to discard a frame. + * + * - decoding: set by user + * - encoding: unused + */ + int discard_damaged_percentage; + + /** + * The number of samples per frame to maximally accept. + * + * - decoding: set by user + * - encoding: set by user + */ + int64_t max_samples; + + /** + * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of + * metadata exported in frame, packet, or coded stream side data by + * decoders and encoders. + * + * - decoding: set by user + * - encoding: set by user + */ + int export_side_data; +} AVCodecContext; + +#if FF_API_CODEC_GET_SET +/** + * Accessors for some AVCodecContext fields. These used to be provided for ABI + * compatibility, and do not need to be used anymore. + */ +attribute_deprecated +AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx); +attribute_deprecated +void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val); + +attribute_deprecated +const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx); +attribute_deprecated +void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc); + +attribute_deprecated +unsigned av_codec_get_codec_properties(const AVCodecContext *avctx); + +#if FF_API_LOWRES +attribute_deprecated +int av_codec_get_lowres(const AVCodecContext *avctx); +attribute_deprecated +void av_codec_set_lowres(AVCodecContext *avctx, int val); +#endif + +attribute_deprecated +int av_codec_get_seek_preroll(const AVCodecContext *avctx); +attribute_deprecated +void av_codec_set_seek_preroll(AVCodecContext *avctx, int val); + +attribute_deprecated +uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx); +attribute_deprecated +void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val); +#endif + +struct AVSubtitle; + +#if FF_API_CODEC_GET_SET +attribute_deprecated +int av_codec_get_max_lowres(const AVCodec *codec); +#endif + +struct MpegEncContext; + +/** + * @defgroup lavc_hwaccel AVHWAccel + * + * @note Nothing in this structure should be accessed by the user. At some + * point in future it will not be externally visible at all. + * + * @{ + */ +typedef struct AVHWAccel { + /** + * Name of the hardware accelerated codec. + * The name is globally unique among encoders and among decoders (but an + * encoder and a decoder can share the same name). + */ + const char *name; + + /** + * Type of codec implemented by the hardware accelerator. + * + * See AVMEDIA_TYPE_xxx + */ + enum AVMediaType type; + + /** + * Codec implemented by the hardware accelerator. + * + * See AV_CODEC_ID_xxx + */ + enum AVCodecID id; + + /** + * Supported pixel format. + * + * Only hardware accelerated formats are supported here. + */ + enum AVPixelFormat pix_fmt; + + /** + * Hardware accelerated codec capabilities. + * see AV_HWACCEL_CODEC_CAP_* + */ + int capabilities; + + /***************************************************************** + * No fields below this line are part of the public API. They + * may not be used outside of libavcodec and can be changed and + * removed at will. + * New public fields should be added right above. + ***************************************************************** + */ + + /** + * Allocate a custom buffer + */ + int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame); + + /** + * Called at the beginning of each frame or field picture. + * + * Meaningful frame information (codec specific) is guaranteed to + * be parsed at this point. This function is mandatory. + * + * Note that buf can be NULL along with buf_size set to 0. + * Otherwise, this means the whole frame is available at this point. + * + * @param avctx the codec context + * @param buf the frame data buffer base + * @param buf_size the size of the frame in bytes + * @return zero if successful, a negative value otherwise + */ + int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size); + + /** + * Callback for parameter data (SPS/PPS/VPS etc). + * + * Useful for hardware decoders which keep persistent state about the + * video parameters, and need to receive any changes to update that state. + * + * @param avctx the codec context + * @param type the nal unit type + * @param buf the nal unit data buffer + * @param buf_size the size of the nal unit in bytes + * @return zero if successful, a negative value otherwise + */ + int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size); + + /** + * Callback for each slice. + * + * Meaningful slice information (codec specific) is guaranteed to + * be parsed at this point. This function is mandatory. + * The only exception is XvMC, that works on MB level. + * + * @param avctx the codec context + * @param buf the slice data buffer base + * @param buf_size the size of the slice in bytes + * @return zero if successful, a negative value otherwise + */ + int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size); + + /** + * Called at the end of each frame or field picture. + * + * The whole picture is parsed at this point and can now be sent + * to the hardware accelerator. This function is mandatory. + * + * @param avctx the codec context + * @return zero if successful, a negative value otherwise + */ + int (*end_frame)(AVCodecContext *avctx); + + /** + * Size of per-frame hardware accelerator private data. + * + * Private data is allocated with av_mallocz() before + * AVCodecContext.get_buffer() and deallocated after + * AVCodecContext.release_buffer(). + */ + int frame_priv_data_size; + + /** + * Called for every Macroblock in a slice. + * + * XvMC uses it to replace the ff_mpv_reconstruct_mb(). + * Instead of decoding to raw picture, MB parameters are + * stored in an array provided by the video driver. + * + * @param s the mpeg context + */ + void (*decode_mb)(struct MpegEncContext *s); + + /** + * Initialize the hwaccel private data. + * + * This will be called from ff_get_format(), after hwaccel and + * hwaccel_context are set and the hwaccel private data in AVCodecInternal + * is allocated. + */ + int (*init)(AVCodecContext *avctx); + + /** + * Uninitialize the hwaccel private data. + * + * This will be called from get_format() or avcodec_close(), after hwaccel + * and hwaccel_context are already uninitialized. + */ + int (*uninit)(AVCodecContext *avctx); + + /** + * Size of the private data to allocate in + * AVCodecInternal.hwaccel_priv_data. + */ + int priv_data_size; + + /** + * Internal hwaccel capabilities. + */ + int caps_internal; + + /** + * Fill the given hw_frames context with current codec parameters. Called + * from get_format. Refer to avcodec_get_hw_frames_parameters() for + * details. + * + * This CAN be called before AVHWAccel.init is called, and you must assume + * that avctx->hwaccel_priv_data is invalid. + */ + int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx); +} AVHWAccel; + +/** + * HWAccel is experimental and is thus avoided in favor of non experimental + * codecs + */ +#define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200 + +/** + * Hardware acceleration should be used for decoding even if the codec level + * used is unknown or higher than the maximum supported level reported by the + * hardware driver. + * + * It's generally a good idea to pass this flag unless you have a specific + * reason not to, as hardware tends to under-report supported levels. + */ +#define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0) + +/** + * Hardware acceleration can output YUV pixel formats with a different chroma + * sampling than 4:2:0 and/or other than 8 bits per component. + */ +#define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1) + +/** + * Hardware acceleration should still be attempted for decoding when the + * codec profile does not match the reported capabilities of the hardware. + * + * For example, this can be used to try to decode baseline profile H.264 + * streams in hardware - it will often succeed, because many streams marked + * as baseline profile actually conform to constrained baseline profile. + * + * @warning If the stream is actually not supported then the behaviour is + * undefined, and may include returning entirely incorrect output + * while indicating success. + */ +#define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2) + +/** + * @} + */ + +#if FF_API_AVPICTURE +/** + * @defgroup lavc_picture AVPicture + * + * Functions for working with AVPicture + * @{ + */ + +/** + * Picture data structure. + * + * Up to four components can be stored into it, the last component is + * alpha. + * @deprecated use AVFrame or imgutils functions instead + */ +typedef struct AVPicture { + attribute_deprecated + uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes + attribute_deprecated + int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line +} AVPicture; + +/** + * @} + */ +#endif + +enum AVSubtitleType { + SUBTITLE_NONE, + + SUBTITLE_BITMAP, ///< A bitmap, pict will be set + + /** + * Plain text, the text field must be set by the decoder and is + * authoritative. ass and pict fields may contain approximations. + */ + SUBTITLE_TEXT, + + /** + * Formatted text, the ass field must be set by the decoder and is + * authoritative. pict and text fields may contain approximations. + */ + SUBTITLE_ASS, +}; + +#define AV_SUBTITLE_FLAG_FORCED 0x00000001 + +typedef struct AVSubtitleRect { + int x; ///< top left corner of pict, undefined when pict is not set + int y; ///< top left corner of pict, undefined when pict is not set + int w; ///< width of pict, undefined when pict is not set + int h; ///< height of pict, undefined when pict is not set + int nb_colors; ///< number of colors in pict, undefined when pict is not set + +#if FF_API_AVPICTURE + /** + * @deprecated unused + */ + attribute_deprecated + AVPicture pict; +#endif + /** + * data+linesize for the bitmap of this subtitle. + * Can be set for text/ass as well once they are rendered. + */ + uint8_t *data[4]; + int linesize[4]; + + enum AVSubtitleType type; + + char *text; ///< 0 terminated plain UTF-8 text + + /** + * 0 terminated ASS/SSA compatible event line. + * The presentation of this is unaffected by the other values in this + * struct. + */ + char *ass; + + int flags; +} AVSubtitleRect; + +typedef struct AVSubtitle { + uint16_t format; /* 0 = graphics */ + uint32_t start_display_time; /* relative to packet pts, in ms */ + uint32_t end_display_time; /* relative to packet pts, in ms */ + unsigned num_rects; + AVSubtitleRect **rects; + int64_t pts; ///< Same as packet pts, in AV_TIME_BASE +} AVSubtitle; + +#if FF_API_NEXT +/** + * If c is NULL, returns the first registered codec, + * if c is non-NULL, returns the next registered codec after c, + * or NULL if c is the last one. + */ +attribute_deprecated +AVCodec *av_codec_next(const AVCodec *c); +#endif + +/** + * Return the LIBAVCODEC_VERSION_INT constant. + */ +unsigned avcodec_version(void); + +/** + * Return the libavcodec build-time configuration. + */ +const char *avcodec_configuration(void); + +/** + * Return the libavcodec license. + */ +const char *avcodec_license(void); + +#if FF_API_NEXT +/** + * Register the codec codec and initialize libavcodec. + * + * @warning either this function or avcodec_register_all() must be called + * before any other libavcodec functions. + * + * @see avcodec_register_all() + */ +attribute_deprecated +void avcodec_register(AVCodec *codec); + +/** + * Register all the codecs, parsers and bitstream filters which were enabled at + * configuration time. If you do not call this function you can select exactly + * which formats you want to support, by using the individual registration + * functions. + * + * @see avcodec_register + * @see av_register_codec_parser + * @see av_register_bitstream_filter + */ +attribute_deprecated +void avcodec_register_all(void); +#endif + +/** + * Allocate an AVCodecContext and set its fields to default values. The + * resulting struct should be freed with avcodec_free_context(). + * + * @param codec if non-NULL, allocate private data and initialize defaults + * for the given codec. It is illegal to then call avcodec_open2() + * with a different codec. + * If NULL, then the codec-specific defaults won't be initialized, + * which may result in suboptimal default settings (this is + * important mainly for encoders, e.g. libx264). + * + * @return An AVCodecContext filled with default values or NULL on failure. + */ +AVCodecContext *avcodec_alloc_context3(const AVCodec *codec); + +/** + * Free the codec context and everything associated with it and write NULL to + * the provided pointer. + */ +void avcodec_free_context(AVCodecContext **avctx); + +#if FF_API_GET_CONTEXT_DEFAULTS +/** + * @deprecated This function should not be used, as closing and opening a codec + * context multiple time is not supported. A new codec context should be + * allocated for each new use. + */ +int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec); +#endif + +/** + * Get the AVClass for AVCodecContext. It can be used in combination with + * AV_OPT_SEARCH_FAKE_OBJ for examining options. + * + * @see av_opt_find(). + */ +const AVClass *avcodec_get_class(void); + +#if FF_API_COPY_CONTEXT +/** + * Get the AVClass for AVFrame. It can be used in combination with + * AV_OPT_SEARCH_FAKE_OBJ for examining options. + * + * @see av_opt_find(). + */ +const AVClass *avcodec_get_frame_class(void); + +/** + * Get the AVClass for AVSubtitleRect. It can be used in combination with + * AV_OPT_SEARCH_FAKE_OBJ for examining options. + * + * @see av_opt_find(). + */ +const AVClass *avcodec_get_subtitle_rect_class(void); + +/** + * Copy the settings of the source AVCodecContext into the destination + * AVCodecContext. The resulting destination codec context will be + * unopened, i.e. you are required to call avcodec_open2() before you + * can use this AVCodecContext to decode/encode video/audio data. + * + * @param dest target codec context, should be initialized with + * avcodec_alloc_context3(NULL), but otherwise uninitialized + * @param src source codec context + * @return AVERROR() on error (e.g. memory allocation error), 0 on success + * + * @deprecated The semantics of this function are ill-defined and it should not + * be used. If you need to transfer the stream parameters from one codec context + * to another, use an intermediate AVCodecParameters instance and the + * avcodec_parameters_from_context() / avcodec_parameters_to_context() + * functions. + */ +attribute_deprecated +int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src); +#endif + +/** + * Fill the parameters struct based on the values from the supplied codec + * context. Any allocated fields in par are freed and replaced with duplicates + * of the corresponding fields in codec. + * + * @return >= 0 on success, a negative AVERROR code on failure + */ +int avcodec_parameters_from_context(AVCodecParameters *par, + const AVCodecContext *codec); + +/** + * Fill the codec context based on the values from the supplied codec + * parameters. Any allocated fields in codec that have a corresponding field in + * par are freed and replaced with duplicates of the corresponding field in par. + * Fields in codec that do not have a counterpart in par are not touched. + * + * @return >= 0 on success, a negative AVERROR code on failure. + */ +int avcodec_parameters_to_context(AVCodecContext *codec, + const AVCodecParameters *par); + +/** + * Initialize the AVCodecContext to use the given AVCodec. Prior to using this + * function the context has to be allocated with avcodec_alloc_context3(). + * + * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(), + * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for + * retrieving a codec. + * + * @warning This function is not thread safe! + * + * @note Always call this function before using decoding routines (such as + * @ref avcodec_receive_frame()). + * + * @code + * avcodec_register_all(); + * av_dict_set(&opts, "b", "2.5M", 0); + * codec = avcodec_find_decoder(AV_CODEC_ID_H264); + * if (!codec) + * exit(1); + * + * context = avcodec_alloc_context3(codec); + * + * if (avcodec_open2(context, codec, opts) < 0) + * exit(1); + * @endcode + * + * @param avctx The context to initialize. + * @param codec The codec to open this context for. If a non-NULL codec has been + * previously passed to avcodec_alloc_context3() or + * for this context, then this parameter MUST be either NULL or + * equal to the previously passed codec. + * @param options A dictionary filled with AVCodecContext and codec-private options. + * On return this object will be filled with options that were not found. + * + * @return zero on success, a negative value on error + * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(), + * av_dict_set(), av_opt_find(). + */ +int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options); + +/** + * Close a given AVCodecContext and free all the data associated with it + * (but not the AVCodecContext itself). + * + * Calling this function on an AVCodecContext that hasn't been opened will free + * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL + * codec. Subsequent calls will do nothing. + * + * @note Do not use this function. Use avcodec_free_context() to destroy a + * codec context (either open or closed). Opening and closing a codec context + * multiple times is not supported anymore -- use multiple codec contexts + * instead. + */ +int avcodec_close(AVCodecContext *avctx); + +/** + * Free all allocated data in the given subtitle struct. + * + * @param sub AVSubtitle to free. + */ +void avsubtitle_free(AVSubtitle *sub); + +/** + * @} + */ + +/** + * @addtogroup lavc_decoding + * @{ + */ + +/** + * The default callback for AVCodecContext.get_buffer2(). It is made public so + * it can be called by custom get_buffer2() implementations for decoders without + * AV_CODEC_CAP_DR1 set. + */ +int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags); + +/** + * Modify width and height values so that they will result in a memory + * buffer that is acceptable for the codec if you do not use any horizontal + * padding. + * + * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened. + */ +void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height); + +/** + * Modify width and height values so that they will result in a memory + * buffer that is acceptable for the codec if you also ensure that all + * line sizes are a multiple of the respective linesize_align[i]. + * + * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened. + */ +void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height, + int linesize_align[AV_NUM_DATA_POINTERS]); + +/** + * Converts AVChromaLocation to swscale x/y chroma position. + * + * The positions represent the chroma (0,0) position in a coordinates system + * with luma (0,0) representing the origin and luma(1,1) representing 256,256 + * + * @param xpos horizontal chroma sample position + * @param ypos vertical chroma sample position + */ +int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos); + +/** + * Converts swscale x/y chroma position to AVChromaLocation. + * + * The positions represent the chroma (0,0) position in a coordinates system + * with luma (0,0) representing the origin and luma(1,1) representing 256,256 + * + * @param xpos horizontal chroma sample position + * @param ypos vertical chroma sample position + */ +enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos); + +/** + * Decode the audio frame of size avpkt->size from avpkt->data into frame. + * + * Some decoders may support multiple frames in a single AVPacket. Such + * decoders would then just decode the first frame and the return value would be + * less than the packet size. In this case, avcodec_decode_audio4 has to be + * called again with an AVPacket containing the remaining data in order to + * decode the second frame, etc... Even if no frames are returned, the packet + * needs to be fed to the decoder with remaining data until it is completely + * consumed or an error occurs. + * + * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input + * and output. This means that for some packets they will not immediately + * produce decoded output and need to be flushed at the end of decoding to get + * all the decoded data. Flushing is done by calling this function with packets + * with avpkt->data set to NULL and avpkt->size set to 0 until it stops + * returning samples. It is safe to flush even those decoders that are not + * marked with AV_CODEC_CAP_DELAY, then no samples will be returned. + * + * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE + * larger than the actual read bytes because some optimized bitstream + * readers read 32 or 64 bits at once and could read over the end. + * + * @note The AVCodecContext MUST have been opened with @ref avcodec_open2() + * before packets may be fed to the decoder. + * + * @param avctx the codec context + * @param[out] frame The AVFrame in which to store decoded audio samples. + * The decoder will allocate a buffer for the decoded frame by + * calling the AVCodecContext.get_buffer2() callback. + * When AVCodecContext.refcounted_frames is set to 1, the frame is + * reference counted and the returned reference belongs to the + * caller. The caller must release the frame using av_frame_unref() + * when the frame is no longer needed. The caller may safely write + * to the frame if av_frame_is_writable() returns 1. + * When AVCodecContext.refcounted_frames is set to 0, the returned + * reference belongs to the decoder and is valid only until the + * next call to this function or until closing or flushing the + * decoder. The caller may not write to it. + * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is + * non-zero. Note that this field being set to zero + * does not mean that an error has occurred. For + * decoders with AV_CODEC_CAP_DELAY set, no given decode + * call is guaranteed to produce a frame. + * @param[in] avpkt The input AVPacket containing the input buffer. + * At least avpkt->data and avpkt->size should be set. Some + * decoders might also require additional fields to be set. + * @return A negative error code is returned if an error occurred during + * decoding, otherwise the number of bytes consumed from the input + * AVPacket is returned. + * +* @deprecated Use avcodec_send_packet() and avcodec_receive_frame(). + */ +attribute_deprecated +int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame, + int *got_frame_ptr, const AVPacket *avpkt); + +/** + * Decode the video frame of size avpkt->size from avpkt->data into picture. + * Some decoders may support multiple frames in a single AVPacket, such + * decoders would then just decode the first frame. + * + * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than + * the actual read bytes because some optimized bitstream readers read 32 or 64 + * bits at once and could read over the end. + * + * @warning The end of the input buffer buf should be set to 0 to ensure that + * no overreading happens for damaged MPEG streams. + * + * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay + * between input and output, these need to be fed with avpkt->data=NULL, + * avpkt->size=0 at the end to return the remaining frames. + * + * @note The AVCodecContext MUST have been opened with @ref avcodec_open2() + * before packets may be fed to the decoder. + * + * @param avctx the codec context + * @param[out] picture The AVFrame in which the decoded video frame will be stored. + * Use av_frame_alloc() to get an AVFrame. The codec will + * allocate memory for the actual bitmap by calling the + * AVCodecContext.get_buffer2() callback. + * When AVCodecContext.refcounted_frames is set to 1, the frame is + * reference counted and the returned reference belongs to the + * caller. The caller must release the frame using av_frame_unref() + * when the frame is no longer needed. The caller may safely write + * to the frame if av_frame_is_writable() returns 1. + * When AVCodecContext.refcounted_frames is set to 0, the returned + * reference belongs to the decoder and is valid only until the + * next call to this function or until closing or flushing the + * decoder. The caller may not write to it. + * + * @param[in] avpkt The input AVPacket containing the input buffer. + * You can create such packet with av_init_packet() and by then setting + * data and size, some decoders might in addition need other fields like + * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least + * fields possible. + * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero. + * @return On error a negative value is returned, otherwise the number of bytes + * used or zero if no frame could be decompressed. + * + * @deprecated Use avcodec_send_packet() and avcodec_receive_frame(). + */ +attribute_deprecated +int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture, + int *got_picture_ptr, + const AVPacket *avpkt); + +/** + * Decode a subtitle message. + * Return a negative value on error, otherwise return the number of bytes used. + * If no subtitle could be decompressed, got_sub_ptr is zero. + * Otherwise, the subtitle is stored in *sub. + * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for + * simplicity, because the performance difference is expected to be negligible + * and reusing a get_buffer written for video codecs would probably perform badly + * due to a potentially very different allocation pattern. + * + * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input + * and output. This means that for some packets they will not immediately + * produce decoded output and need to be flushed at the end of decoding to get + * all the decoded data. Flushing is done by calling this function with packets + * with avpkt->data set to NULL and avpkt->size set to 0 until it stops + * returning subtitles. It is safe to flush even those decoders that are not + * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned. + * + * @note The AVCodecContext MUST have been opened with @ref avcodec_open2() + * before packets may be fed to the decoder. + * + * @param avctx the codec context + * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored, + * must be freed with avsubtitle_free if *got_sub_ptr is set. + * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero. + * @param[in] avpkt The input AVPacket containing the input buffer. + */ +int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub, + int *got_sub_ptr, + AVPacket *avpkt); + +/** + * Supply raw packet data as input to a decoder. + * + * Internally, this call will copy relevant AVCodecContext fields, which can + * influence decoding per-packet, and apply them when the packet is actually + * decoded. (For example AVCodecContext.skip_frame, which might direct the + * decoder to drop the frame contained by the packet sent with this function.) + * + * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE + * larger than the actual read bytes because some optimized bitstream + * readers read 32 or 64 bits at once and could read over the end. + * + * @warning Do not mix this API with the legacy API (like avcodec_decode_video2()) + * on the same AVCodecContext. It will return unexpected results now + * or in future libavcodec versions. + * + * @note The AVCodecContext MUST have been opened with @ref avcodec_open2() + * before packets may be fed to the decoder. + * + * @param avctx codec context + * @param[in] avpkt The input AVPacket. Usually, this will be a single video + * frame, or several complete audio frames. + * Ownership of the packet remains with the caller, and the + * decoder will not write to the packet. The decoder may create + * a reference to the packet data (or copy it if the packet is + * not reference-counted). + * Unlike with older APIs, the packet is always fully consumed, + * and if it contains multiple frames (e.g. some audio codecs), + * will require you to call avcodec_receive_frame() multiple + * times afterwards before you can send a new packet. + * It can be NULL (or an AVPacket with data set to NULL and + * size set to 0); in this case, it is considered a flush + * packet, which signals the end of the stream. Sending the + * first flush packet will return success. Subsequent ones are + * unnecessary and will return AVERROR_EOF. If the decoder + * still has frames buffered, it will return them after sending + * a flush packet. + * + * @return 0 on success, otherwise negative error code: + * AVERROR(EAGAIN): input is not accepted in the current state - user + * must read output with avcodec_receive_frame() (once + * all output is read, the packet should be resent, and + * the call will not fail with EAGAIN). + * AVERROR_EOF: the decoder has been flushed, and no new packets can + * be sent to it (also returned if more than 1 flush + * packet is sent) + * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush + * AVERROR(ENOMEM): failed to add packet to internal queue, or similar + * other errors: legitimate decoding errors + */ +int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt); + +/** + * Return decoded output data from a decoder. + * + * @param avctx codec context + * @param frame This will be set to a reference-counted video or audio + * frame (depending on the decoder type) allocated by the + * decoder. Note that the function will always call + * av_frame_unref(frame) before doing anything else. + * + * @return + * 0: success, a frame was returned + * AVERROR(EAGAIN): output is not available in this state - user must try + * to send new input + * AVERROR_EOF: the decoder has been fully flushed, and there will be + * no more output frames + * AVERROR(EINVAL): codec not opened, or it is an encoder + * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters + * with respect to first decoded frame. Applicable + * when flag AV_CODEC_FLAG_DROPCHANGED is set. + * other negative values: legitimate decoding errors + */ +int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame); + +/** + * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet() + * to retrieve buffered output packets. + * + * @param avctx codec context + * @param[in] frame AVFrame containing the raw audio or video frame to be encoded. + * Ownership of the frame remains with the caller, and the + * encoder will not write to the frame. The encoder may create + * a reference to the frame data (or copy it if the frame is + * not reference-counted). + * It can be NULL, in which case it is considered a flush + * packet. This signals the end of the stream. If the encoder + * still has packets buffered, it will return them after this + * call. Once flushing mode has been entered, additional flush + * packets are ignored, and sending frames will return + * AVERROR_EOF. + * + * For audio: + * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame + * can have any number of samples. + * If it is not set, frame->nb_samples must be equal to + * avctx->frame_size for all frames except the last. + * The final frame may be smaller than avctx->frame_size. + * @return 0 on success, otherwise negative error code: + * AVERROR(EAGAIN): input is not accepted in the current state - user + * must read output with avcodec_receive_packet() (once + * all output is read, the packet should be resent, and + * the call will not fail with EAGAIN). + * AVERROR_EOF: the encoder has been flushed, and no new frames can + * be sent to it + * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a + * decoder, or requires flush + * AVERROR(ENOMEM): failed to add packet to internal queue, or similar + * other errors: legitimate encoding errors + */ +int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame); + +/** + * Read encoded data from the encoder. + * + * @param avctx codec context + * @param avpkt This will be set to a reference-counted packet allocated by the + * encoder. Note that the function will always call + * av_packet_unref(avpkt) before doing anything else. + * @return 0 on success, otherwise negative error code: + * AVERROR(EAGAIN): output is not available in the current state - user + * must try to send input + * AVERROR_EOF: the encoder has been fully flushed, and there will be + * no more output packets + * AVERROR(EINVAL): codec not opened, or it is a decoder + * other errors: legitimate encoding errors + */ +int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt); + +/** + * Create and return a AVHWFramesContext with values adequate for hardware + * decoding. This is meant to get called from the get_format callback, and is + * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx. + * This API is for decoding with certain hardware acceleration modes/APIs only. + * + * The returned AVHWFramesContext is not initialized. The caller must do this + * with av_hwframe_ctx_init(). + * + * Calling this function is not a requirement, but makes it simpler to avoid + * codec or hardware API specific details when manually allocating frames. + * + * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx, + * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes + * it unnecessary to call this function or having to care about + * AVHWFramesContext initialization at all. + * + * There are a number of requirements for calling this function: + * + * - It must be called from get_format with the same avctx parameter that was + * passed to get_format. Calling it outside of get_format is not allowed, and + * can trigger undefined behavior. + * - The function is not always supported (see description of return values). + * Even if this function returns successfully, hwaccel initialization could + * fail later. (The degree to which implementations check whether the stream + * is actually supported varies. Some do this check only after the user's + * get_format callback returns.) + * - The hw_pix_fmt must be one of the choices suggested by get_format. If the + * user decides to use a AVHWFramesContext prepared with this API function, + * the user must return the same hw_pix_fmt from get_format. + * - The device_ref passed to this function must support the given hw_pix_fmt. + * - After calling this API function, it is the user's responsibility to + * initialize the AVHWFramesContext (returned by the out_frames_ref parameter), + * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done + * before returning from get_format (this is implied by the normal + * AVCodecContext.hw_frames_ctx API rules). + * - The AVHWFramesContext parameters may change every time time get_format is + * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So + * you are inherently required to go through this process again on every + * get_format call. + * - It is perfectly possible to call this function without actually using + * the resulting AVHWFramesContext. One use-case might be trying to reuse a + * previously initialized AVHWFramesContext, and calling this API function + * only to test whether the required frame parameters have changed. + * - Fields that use dynamically allocated values of any kind must not be set + * by the user unless setting them is explicitly allowed by the documentation. + * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque, + * the new free callback must call the potentially set previous free callback. + * This API call may set any dynamically allocated fields, including the free + * callback. + * + * The function will set at least the following fields on AVHWFramesContext + * (potentially more, depending on hwaccel API): + * + * - All fields set by av_hwframe_ctx_alloc(). + * - Set the format field to hw_pix_fmt. + * - Set the sw_format field to the most suited and most versatile format. (An + * implication is that this will prefer generic formats over opaque formats + * with arbitrary restrictions, if possible.) + * - Set the width/height fields to the coded frame size, rounded up to the + * API-specific minimum alignment. + * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size + * field to the number of maximum reference surfaces possible with the codec, + * plus 1 surface for the user to work (meaning the user can safely reference + * at most 1 decoded surface at a time), plus additional buffering introduced + * by frame threading. If the hwaccel does not require pre-allocation, the + * field is left to 0, and the decoder will allocate new surfaces on demand + * during decoding. + * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying + * hardware API. + * + * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but + * with basic frame parameters set. + * + * The function is stateless, and does not change the AVCodecContext or the + * device_ref AVHWDeviceContext. + * + * @param avctx The context which is currently calling get_format, and which + * implicitly contains all state needed for filling the returned + * AVHWFramesContext properly. + * @param device_ref A reference to the AVHWDeviceContext describing the device + * which will be used by the hardware decoder. + * @param hw_pix_fmt The hwaccel format you are going to return from get_format. + * @param out_frames_ref On success, set to a reference to an _uninitialized_ + * AVHWFramesContext, created from the given device_ref. + * Fields will be set to values required for decoding. + * Not changed if an error is returned. + * @return zero on success, a negative value on error. The following error codes + * have special semantics: + * AVERROR(ENOENT): the decoder does not support this functionality. Setup + * is always manual, or it is a decoder which does not + * support setting AVCodecContext.hw_frames_ctx at all, + * or it is a software format. + * AVERROR(EINVAL): it is known that hardware decoding is not supported for + * this configuration, or the device_ref is not supported + * for the hwaccel referenced by hw_pix_fmt. + */ +int avcodec_get_hw_frames_parameters(AVCodecContext *avctx, + AVBufferRef *device_ref, + enum AVPixelFormat hw_pix_fmt, + AVBufferRef **out_frames_ref); + + + +/** + * @defgroup lavc_parsing Frame parsing + * @{ + */ + +enum AVPictureStructure { + AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown + AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field + AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field + AV_PICTURE_STRUCTURE_FRAME, //< coded as frame +}; + +typedef struct AVCodecParserContext { + void *priv_data; + struct AVCodecParser *parser; + int64_t frame_offset; /* offset of the current frame */ + int64_t cur_offset; /* current offset + (incremented by each av_parser_parse()) */ + int64_t next_frame_offset; /* offset of the next frame */ + /* video info */ + int pict_type; /* XXX: Put it back in AVCodecContext. */ + /** + * This field is used for proper frame duration computation in lavf. + * It signals, how much longer the frame duration of the current frame + * is compared to normal frame duration. + * + * frame_duration = (1 + repeat_pict) * time_base + * + * It is used by codecs like H.264 to display telecined material. + */ + int repeat_pict; /* XXX: Put it back in AVCodecContext. */ + int64_t pts; /* pts of the current frame */ + int64_t dts; /* dts of the current frame */ + + /* private data */ + int64_t last_pts; + int64_t last_dts; + int fetch_timestamp; + +#define AV_PARSER_PTS_NB 4 + int cur_frame_start_index; + int64_t cur_frame_offset[AV_PARSER_PTS_NB]; + int64_t cur_frame_pts[AV_PARSER_PTS_NB]; + int64_t cur_frame_dts[AV_PARSER_PTS_NB]; + + int flags; +#define PARSER_FLAG_COMPLETE_FRAMES 0x0001 +#define PARSER_FLAG_ONCE 0x0002 +/// Set if the parser has a valid file offset +#define PARSER_FLAG_FETCHED_OFFSET 0x0004 +#define PARSER_FLAG_USE_CODEC_TS 0x1000 + + int64_t offset; ///< byte offset from starting packet start + int64_t cur_frame_end[AV_PARSER_PTS_NB]; + + /** + * Set by parser to 1 for key frames and 0 for non-key frames. + * It is initialized to -1, so if the parser doesn't set this flag, + * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames + * will be used. + */ + int key_frame; + +#if FF_API_CONVERGENCE_DURATION + /** + * @deprecated unused + */ + attribute_deprecated + int64_t convergence_duration; +#endif + + // Timestamp generation support: + /** + * Synchronization point for start of timestamp generation. + * + * Set to >0 for sync point, 0 for no sync point and <0 for undefined + * (default). + * + * For example, this corresponds to presence of H.264 buffering period + * SEI message. + */ + int dts_sync_point; + + /** + * Offset of the current timestamp against last timestamp sync point in + * units of AVCodecContext.time_base. + * + * Set to INT_MIN when dts_sync_point unused. Otherwise, it must + * contain a valid timestamp offset. + * + * Note that the timestamp of sync point has usually a nonzero + * dts_ref_dts_delta, which refers to the previous sync point. Offset of + * the next frame after timestamp sync point will be usually 1. + * + * For example, this corresponds to H.264 cpb_removal_delay. + */ + int dts_ref_dts_delta; + + /** + * Presentation delay of current frame in units of AVCodecContext.time_base. + * + * Set to INT_MIN when dts_sync_point unused. Otherwise, it must + * contain valid non-negative timestamp delta (presentation time of a frame + * must not lie in the past). + * + * This delay represents the difference between decoding and presentation + * time of the frame. + * + * For example, this corresponds to H.264 dpb_output_delay. + */ + int pts_dts_delta; + + /** + * Position of the packet in file. + * + * Analogous to cur_frame_pts/dts + */ + int64_t cur_frame_pos[AV_PARSER_PTS_NB]; + + /** + * Byte position of currently parsed frame in stream. + */ + int64_t pos; + + /** + * Previous frame byte position. + */ + int64_t last_pos; + + /** + * Duration of the current frame. + * For audio, this is in units of 1 / AVCodecContext.sample_rate. + * For all other types, this is in units of AVCodecContext.time_base. + */ + int duration; + + enum AVFieldOrder field_order; + + /** + * Indicate whether a picture is coded as a frame, top field or bottom field. + * + * For example, H.264 field_pic_flag equal to 0 corresponds to + * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag + * equal to 1 and bottom_field_flag equal to 0 corresponds to + * AV_PICTURE_STRUCTURE_TOP_FIELD. + */ + enum AVPictureStructure picture_structure; + + /** + * Picture number incremented in presentation or output order. + * This field may be reinitialized at the first picture of a new sequence. + * + * For example, this corresponds to H.264 PicOrderCnt. + */ + int output_picture_number; + + /** + * Dimensions of the decoded video intended for presentation. + */ + int width; + int height; + + /** + * Dimensions of the coded video. + */ + int coded_width; + int coded_height; + + /** + * The format of the coded data, corresponds to enum AVPixelFormat for video + * and for enum AVSampleFormat for audio. + * + * Note that a decoder can have considerable freedom in how exactly it + * decodes the data, so the format reported here might be different from the + * one returned by a decoder. + */ + int format; +} AVCodecParserContext; + +typedef struct AVCodecParser { + int codec_ids[5]; /* several codec IDs are permitted */ + int priv_data_size; + int (*parser_init)(AVCodecParserContext *s); + /* This callback never returns an error, a negative value means that + * the frame start was in a previous packet. */ + int (*parser_parse)(AVCodecParserContext *s, + AVCodecContext *avctx, + const uint8_t **poutbuf, int *poutbuf_size, + const uint8_t *buf, int buf_size); + void (*parser_close)(AVCodecParserContext *s); + int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size); + struct AVCodecParser *next; +} AVCodecParser; + +/** + * Iterate over all registered codec parsers. + * + * @param opaque a pointer where libavcodec will store the iteration state. Must + * point to NULL to start the iteration. + * + * @return the next registered codec parser or NULL when the iteration is + * finished + */ +const AVCodecParser *av_parser_iterate(void **opaque); + +attribute_deprecated +AVCodecParser *av_parser_next(const AVCodecParser *c); + +attribute_deprecated +void av_register_codec_parser(AVCodecParser *parser); +AVCodecParserContext *av_parser_init(int codec_id); + +/** + * Parse a packet. + * + * @param s parser context. + * @param avctx codec context. + * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished. + * @param poutbuf_size set to size of parsed buffer or zero if not yet finished. + * @param buf input buffer. + * @param buf_size buffer size in bytes without the padding. I.e. the full buffer + size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE. + To signal EOF, this should be 0 (so that the last frame + can be output). + * @param pts input presentation timestamp. + * @param dts input decoding timestamp. + * @param pos input byte position in stream. + * @return the number of bytes of the input bitstream used. + * + * Example: + * @code + * while(in_len){ + * len = av_parser_parse2(myparser, AVCodecContext, &data, &size, + * in_data, in_len, + * pts, dts, pos); + * in_data += len; + * in_len -= len; + * + * if(size) + * decode_frame(data, size); + * } + * @endcode + */ +int av_parser_parse2(AVCodecParserContext *s, + AVCodecContext *avctx, + uint8_t **poutbuf, int *poutbuf_size, + const uint8_t *buf, int buf_size, + int64_t pts, int64_t dts, + int64_t pos); + +/** + * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed + * @deprecated use AVBitStreamFilter + */ +int av_parser_change(AVCodecParserContext *s, + AVCodecContext *avctx, + uint8_t **poutbuf, int *poutbuf_size, + const uint8_t *buf, int buf_size, int keyframe); +void av_parser_close(AVCodecParserContext *s); + +/** + * @} + * @} + */ + +/** + * @addtogroup lavc_encoding + * @{ + */ + +/** + * Encode a frame of audio. + * + * Takes input samples from frame and writes the next output packet, if + * available, to avpkt. The output packet does not necessarily contain data for + * the most recent frame, as encoders can delay, split, and combine input frames + * internally as needed. + * + * @param avctx codec context + * @param avpkt output AVPacket. + * The user can supply an output buffer by setting + * avpkt->data and avpkt->size prior to calling the + * function, but if the size of the user-provided data is not + * large enough, encoding will fail. If avpkt->data and + * avpkt->size are set, avpkt->destruct must also be set. All + * other AVPacket fields will be reset by the encoder using + * av_init_packet(). If avpkt->data is NULL, the encoder will + * allocate it. The encoder will set avpkt->size to the size + * of the output packet. + * + * If this function fails or produces no output, avpkt will be + * freed using av_packet_unref(). + * @param[in] frame AVFrame containing the raw audio data to be encoded. + * May be NULL when flushing an encoder that has the + * AV_CODEC_CAP_DELAY capability set. + * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame + * can have any number of samples. + * If it is not set, frame->nb_samples must be equal to + * avctx->frame_size for all frames except the last. + * The final frame may be smaller than avctx->frame_size. + * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the + * output packet is non-empty, and to 0 if it is + * empty. If the function returns an error, the + * packet can be assumed to be invalid, and the + * value of got_packet_ptr is undefined and should + * not be used. + * @return 0 on success, negative error code on failure + * + * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead + */ +attribute_deprecated +int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt, + const AVFrame *frame, int *got_packet_ptr); + +/** + * Encode a frame of video. + * + * Takes input raw video data from frame and writes the next output packet, if + * available, to avpkt. The output packet does not necessarily contain data for + * the most recent frame, as encoders can delay and reorder input frames + * internally as needed. + * + * @param avctx codec context + * @param avpkt output AVPacket. + * The user can supply an output buffer by setting + * avpkt->data and avpkt->size prior to calling the + * function, but if the size of the user-provided data is not + * large enough, encoding will fail. All other AVPacket fields + * will be reset by the encoder using av_init_packet(). If + * avpkt->data is NULL, the encoder will allocate it. + * The encoder will set avpkt->size to the size of the + * output packet. The returned data (if any) belongs to the + * caller, he is responsible for freeing it. + * + * If this function fails or produces no output, avpkt will be + * freed using av_packet_unref(). + * @param[in] frame AVFrame containing the raw video data to be encoded. + * May be NULL when flushing an encoder that has the + * AV_CODEC_CAP_DELAY capability set. + * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the + * output packet is non-empty, and to 0 if it is + * empty. If the function returns an error, the + * packet can be assumed to be invalid, and the + * value of got_packet_ptr is undefined and should + * not be used. + * @return 0 on success, negative error code on failure + * + * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead + */ +attribute_deprecated +int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt, + const AVFrame *frame, int *got_packet_ptr); + +int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size, + const AVSubtitle *sub); + + +/** + * @} + */ + +#if FF_API_AVPICTURE +/** + * @addtogroup lavc_picture + * @{ + */ + +/** + * @deprecated unused + */ +attribute_deprecated +int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height); + +/** + * @deprecated unused + */ +attribute_deprecated +void avpicture_free(AVPicture *picture); + +/** + * @deprecated use av_image_fill_arrays() instead. + */ +attribute_deprecated +int avpicture_fill(AVPicture *picture, const uint8_t *ptr, + enum AVPixelFormat pix_fmt, int width, int height); + +/** + * @deprecated use av_image_copy_to_buffer() instead. + */ +attribute_deprecated +int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt, + int width, int height, + unsigned char *dest, int dest_size); + +/** + * @deprecated use av_image_get_buffer_size() instead. + */ +attribute_deprecated +int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height); + +/** + * @deprecated av_image_copy() instead. + */ +attribute_deprecated +void av_picture_copy(AVPicture *dst, const AVPicture *src, + enum AVPixelFormat pix_fmt, int width, int height); + +/** + * @deprecated unused + */ +attribute_deprecated +int av_picture_crop(AVPicture *dst, const AVPicture *src, + enum AVPixelFormat pix_fmt, int top_band, int left_band); + +/** + * @deprecated unused + */ +attribute_deprecated +int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt, + int padtop, int padbottom, int padleft, int padright, int *color); + +/** + * @} + */ +#endif + +/** + * @defgroup lavc_misc Utility functions + * @ingroup libavc + * + * Miscellaneous utility functions related to both encoding and decoding + * (or neither). + * @{ + */ + +/** + * @defgroup lavc_misc_pixfmt Pixel formats + * + * Functions for working with pixel formats. + * @{ + */ + +#if FF_API_GETCHROMA +/** + * @deprecated Use av_pix_fmt_get_chroma_sub_sample + */ + +attribute_deprecated +void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift); +#endif + +/** + * Return a value representing the fourCC code associated to the + * pixel format pix_fmt, or 0 if no associated fourCC code can be + * found. + */ +unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt); + +/** + * @deprecated see av_get_pix_fmt_loss() + */ +int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt, + int has_alpha); + +/** + * Find the best pixel format to convert to given a certain source pixel + * format. When converting from one pixel format to another, information loss + * may occur. For example, when converting from RGB24 to GRAY, the color + * information will be lost. Similarly, other losses occur when converting from + * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of + * the given pixel formats should be used to suffer the least amount of loss. + * The pixel formats from which it chooses one, are determined by the + * pix_fmt_list parameter. + * + * + * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from + * @param[in] src_pix_fmt source pixel format + * @param[in] has_alpha Whether the source pixel format alpha channel is used. + * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur. + * @return The best pixel format to convert to or -1 if none was found. + */ +enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list, + enum AVPixelFormat src_pix_fmt, + int has_alpha, int *loss_ptr); + +/** + * @deprecated see av_find_best_pix_fmt_of_2() + */ +enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2, + enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr); + +attribute_deprecated +enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2, + enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr); + +enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt); + +/** + * @} + */ + +#if FF_API_TAG_STRING +/** + * Put a string representing the codec tag codec_tag in buf. + * + * @param buf buffer to place codec tag in + * @param buf_size size in bytes of buf + * @param codec_tag codec tag to assign + * @return the length of the string that would have been generated if + * enough space had been available, excluding the trailing null + * + * @deprecated see av_fourcc_make_string() and av_fourcc2str(). + */ +attribute_deprecated +size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag); +#endif + +void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode); + +/** + * Return a name for the specified profile, if available. + * + * @param codec the codec that is searched for the given profile + * @param profile the profile value for which a name is requested + * @return A name for the profile if found, NULL otherwise. + */ +const char *av_get_profile_name(const AVCodec *codec, int profile); + +/** + * Return a name for the specified profile, if available. + * + * @param codec_id the ID of the codec to which the requested profile belongs + * @param profile the profile value for which a name is requested + * @return A name for the profile if found, NULL otherwise. + * + * @note unlike av_get_profile_name(), which searches a list of profiles + * supported by a specific decoder or encoder implementation, this + * function searches the list of profiles from the AVCodecDescriptor + */ +const char *avcodec_profile_name(enum AVCodecID codec_id, int profile); + +int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size); +int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count); +//FIXME func typedef + +/** + * Fill AVFrame audio data and linesize pointers. + * + * The buffer buf must be a preallocated buffer with a size big enough + * to contain the specified samples amount. The filled AVFrame data + * pointers will point to this buffer. + * + * AVFrame extended_data channel pointers are allocated if necessary for + * planar audio. + * + * @param frame the AVFrame + * frame->nb_samples must be set prior to calling the + * function. This function fills in frame->data, + * frame->extended_data, frame->linesize[0]. + * @param nb_channels channel count + * @param sample_fmt sample format + * @param buf buffer to use for frame data + * @param buf_size size of buffer + * @param align plane size sample alignment (0 = default) + * @return >=0 on success, negative error code on failure + * @todo return the size in bytes required to store the samples in + * case of success, at the next libavutil bump + */ +int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels, + enum AVSampleFormat sample_fmt, const uint8_t *buf, + int buf_size, int align); + +/** + * Reset the internal codec state / flush internal buffers. Should be called + * e.g. when seeking or when switching to a different stream. + * + * @note for decoders, when refcounted frames are not used + * (i.e. avctx->refcounted_frames is 0), this invalidates the frames previously + * returned from the decoder. When refcounted frames are used, the decoder just + * releases any references it might keep internally, but the caller's reference + * remains valid. + * + * @note for encoders, this function will only do something if the encoder + * declares support for AV_CODEC_CAP_ENCODER_FLUSH. When called, the encoder + * will drain any remaining packets, and can then be re-used for a different + * stream (as opposed to sending a null frame which will leave the encoder + * in a permanent EOF state after draining). This can be desirable if the + * cost of tearing down and replacing the encoder instance is high. + */ +void avcodec_flush_buffers(AVCodecContext *avctx); + +/** + * Return codec bits per sample. + * + * @param[in] codec_id the codec + * @return Number of bits per sample or zero if unknown for the given codec. + */ +int av_get_bits_per_sample(enum AVCodecID codec_id); + +/** + * Return the PCM codec associated with a sample format. + * @param be endianness, 0 for little, 1 for big, + * -1 (or anything else) for native + * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE + */ +enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be); + +/** + * Return codec bits per sample. + * Only return non-zero if the bits per sample is exactly correct, not an + * approximation. + * + * @param[in] codec_id the codec + * @return Number of bits per sample or zero if unknown for the given codec. + */ +int av_get_exact_bits_per_sample(enum AVCodecID codec_id); + +/** + * Return audio frame duration. + * + * @param avctx codec context + * @param frame_bytes size of the frame, or 0 if unknown + * @return frame duration, in samples, if known. 0 if not able to + * determine. + */ +int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes); + +/** + * This function is the same as av_get_audio_frame_duration(), except it works + * with AVCodecParameters instead of an AVCodecContext. + */ +int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes); + +#if FF_API_OLD_BSF +typedef struct AVBitStreamFilterContext { + void *priv_data; + const struct AVBitStreamFilter *filter; + AVCodecParserContext *parser; + struct AVBitStreamFilterContext *next; + /** + * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter(). + * Not for access by library users. + */ + char *args; +} AVBitStreamFilterContext; + +/** + * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext) + * is deprecated. Use the new bitstream filtering API (using AVBSFContext). + */ +attribute_deprecated +void av_register_bitstream_filter(AVBitStreamFilter *bsf); +/** + * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext) + * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init() + * from the new bitstream filtering API (using AVBSFContext). + */ +attribute_deprecated +AVBitStreamFilterContext *av_bitstream_filter_init(const char *name); +/** + * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext) + * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the + * new bitstream filtering API (using AVBSFContext). + */ +attribute_deprecated +int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc, + AVCodecContext *avctx, const char *args, + uint8_t **poutbuf, int *poutbuf_size, + const uint8_t *buf, int buf_size, int keyframe); +/** + * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext) + * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using + * AVBSFContext). + */ +attribute_deprecated +void av_bitstream_filter_close(AVBitStreamFilterContext *bsf); +/** + * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext) + * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using + * AVBSFContext). + */ +attribute_deprecated +const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f); +#endif + +#if FF_API_NEXT +attribute_deprecated +const AVBitStreamFilter *av_bsf_next(void **opaque); +#endif + +/* memory */ + +/** + * Same behaviour av_fast_malloc but the buffer has additional + * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0. + * + * In addition the whole buffer will initially and after resizes + * be 0-initialized so that no uninitialized data will ever appear. + */ +void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size); + +/** + * Same behaviour av_fast_padded_malloc except that buffer will always + * be 0-initialized after call. + */ +void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size); + +/** + * Encode extradata length to a buffer. Used by xiph codecs. + * + * @param s buffer to write to; must be at least (v/255+1) bytes long + * @param v size of extradata in bytes + * @return number of bytes written to the buffer. + */ +unsigned int av_xiphlacing(unsigned char *s, unsigned int v); + +#if FF_API_USER_VISIBLE_AVHWACCEL +/** + * Register the hardware accelerator hwaccel. + * + * @deprecated This function doesn't do anything. + */ +attribute_deprecated +void av_register_hwaccel(AVHWAccel *hwaccel); + +/** + * If hwaccel is NULL, returns the first registered hardware accelerator, + * if hwaccel is non-NULL, returns the next registered hardware accelerator + * after hwaccel, or NULL if hwaccel is the last one. + * + * @deprecated AVHWaccel structures contain no user-serviceable parts, so + * this function should not be used. + */ +attribute_deprecated +AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel); +#endif + +#if FF_API_LOCKMGR +/** + * Lock operation used by lockmgr + * + * @deprecated Deprecated together with av_lockmgr_register(). + */ +enum AVLockOp { + AV_LOCK_CREATE, ///< Create a mutex + AV_LOCK_OBTAIN, ///< Lock the mutex + AV_LOCK_RELEASE, ///< Unlock the mutex + AV_LOCK_DESTROY, ///< Free mutex resources +}; + +/** + * Register a user provided lock manager supporting the operations + * specified by AVLockOp. The "mutex" argument to the function points + * to a (void *) where the lockmgr should store/get a pointer to a user + * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the + * value left by the last call for all other ops. If the lock manager is + * unable to perform the op then it should leave the mutex in the same + * state as when it was called and return a non-zero value. However, + * when called with AV_LOCK_DESTROY the mutex will always be assumed to + * have been successfully destroyed. If av_lockmgr_register succeeds + * it will return a non-negative value, if it fails it will return a + * negative value and destroy all mutex and unregister all callbacks. + * av_lockmgr_register is not thread-safe, it must be called from a + * single thread before any calls which make use of locking are used. + * + * @param cb User defined callback. av_lockmgr_register invokes calls + * to this callback and the previously registered callback. + * The callback will be used to create more than one mutex + * each of which must be backed by its own underlying locking + * mechanism (i.e. do not use a single static object to + * implement your lock manager). If cb is set to NULL the + * lockmgr will be unregistered. + * + * @deprecated This function does nothing, and always returns 0. Be sure to + * build with thread support to get basic thread safety. + */ +attribute_deprecated +int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op)); +#endif + +/** + * @return a positive value if s is open (i.e. avcodec_open2() was called on it + * with no corresponding avcodec_close()), 0 otherwise. + */ +int avcodec_is_open(AVCodecContext *s); + +/** + * Allocate a CPB properties structure and initialize its fields to default + * values. + * + * @param size if non-NULL, the size of the allocated struct will be written + * here. This is useful for embedding it in side data. + * + * @return the newly allocated struct or NULL on failure + */ +AVCPBProperties *av_cpb_properties_alloc(size_t *size); + +/** + * @} + */ + +#endif /* AVCODEC_AVCODEC_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/avdct.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/avdct.h new file mode 100644 index 0000000..6411fab --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/avdct.h @@ -0,0 +1,88 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_AVDCT_H +#define AVCODEC_AVDCT_H + +#include "libavutil/opt.h" + +/** + * AVDCT context. + * @note function pointers can be NULL if the specific features have been + * disabled at build time. + */ +typedef struct AVDCT { + const AVClass *av_class; + + void (*idct)(int16_t *block /* align 16 */); + + /** + * IDCT input permutation. + * Several optimized IDCTs need a permutated input (relative to the + * normal order of the reference IDCT). + * This permutation must be performed before the idct_put/add. + * Note, normally this can be merged with the zigzag/alternate scan
+ * An example to avoid confusion: + * - (->decode coeffs -> zigzag reorder -> dequant -> reference IDCT -> ...) + * - (x -> reference DCT -> reference IDCT -> x) + * - (x -> reference DCT -> simple_mmx_perm = idct_permutation + * -> simple_idct_mmx -> x) + * - (-> decode coeffs -> zigzag reorder -> simple_mmx_perm -> dequant + * -> simple_idct_mmx -> ...) + */ + uint8_t idct_permutation[64]; + + void (*fdct)(int16_t *block /* align 16 */); + + + /** + * DCT algorithm. + * must use AVOptions to set this field. + */ + int dct_algo; + + /** + * IDCT algorithm. + * must use AVOptions to set this field. + */ + int idct_algo; + + void (*get_pixels)(int16_t *block /* align 16 */, + const uint8_t *pixels /* align 8 */, + ptrdiff_t line_size); + + int bits_per_sample; + + void (*get_pixels_unaligned)(int16_t *block /* align 16 */, + const uint8_t *pixels, + ptrdiff_t line_size); +} AVDCT; + +/** + * Allocates a AVDCT context. + * This needs to be initialized with avcodec_dct_init() after optionally + * configuring it with AVOptions. + * + * To free it use av_free() + */ +AVDCT *avcodec_dct_alloc(void); +int avcodec_dct_init(AVDCT *); + +const AVClass *avcodec_dct_get_class(void); + +#endif /* AVCODEC_AVDCT_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/avfft.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/avfft.h new file mode 100644 index 0000000..0c0f9b8 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/avfft.h @@ -0,0 +1,118 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_AVFFT_H +#define AVCODEC_AVFFT_H + +/** + * @file + * @ingroup lavc_fft + * FFT functions + */ + +/** + * @defgroup lavc_fft FFT functions + * @ingroup lavc_misc + * + * @{ + */ + +typedef float FFTSample; + +typedef struct FFTComplex { + FFTSample re, im; +} FFTComplex; + +typedef struct FFTContext FFTContext; + +/** + * Set up a complex FFT. + * @param nbits log2 of the length of the input array + * @param inverse if 0 perform the forward transform, if 1 perform the inverse + */ +FFTContext *av_fft_init(int nbits, int inverse); + +/** + * Do the permutation needed BEFORE calling ff_fft_calc(). + */ +void av_fft_permute(FFTContext *s, FFTComplex *z); + +/** + * Do a complex FFT with the parameters defined in av_fft_init(). The + * input data must be permuted before. No 1.0/sqrt(n) normalization is done. + */ +void av_fft_calc(FFTContext *s, FFTComplex *z); + +void av_fft_end(FFTContext *s); + +FFTContext *av_mdct_init(int nbits, int inverse, double scale); +void av_imdct_calc(FFTContext *s, FFTSample *output, const FFTSample *input); +void av_imdct_half(FFTContext *s, FFTSample *output, const FFTSample *input); +void av_mdct_calc(FFTContext *s, FFTSample *output, const FFTSample *input); +void av_mdct_end(FFTContext *s); + +/* Real Discrete Fourier Transform */ + +enum RDFTransformType { + DFT_R2C, + IDFT_C2R, + IDFT_R2C, + DFT_C2R, +}; + +typedef struct RDFTContext RDFTContext; + +/** + * Set up a real FFT. + * @param nbits log2 of the length of the input array + * @param trans the type of transform + */ +RDFTContext *av_rdft_init(int nbits, enum RDFTransformType trans); +void av_rdft_calc(RDFTContext *s, FFTSample *data); +void av_rdft_end(RDFTContext *s); + +/* Discrete Cosine Transform */ + +typedef struct DCTContext DCTContext; + +enum DCTTransformType { + DCT_II = 0, + DCT_III, + DCT_I, + DST_I, +}; + +/** + * Set up DCT. + * + * @param nbits size of the input array: + * (1 << nbits) for DCT-II, DCT-III and DST-I + * (1 << nbits) + 1 for DCT-I + * @param type the type of transform + * + * @note the first element of the input of DST-I is ignored + */ +DCTContext *av_dct_init(int nbits, enum DCTTransformType type); +void av_dct_calc(DCTContext *s, FFTSample *data); +void av_dct_end (DCTContext *s); + +/** + * @} + */ + +#endif /* AVCODEC_AVFFT_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/bsf.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/bsf.h new file mode 100644 index 0000000..7ed5167 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/bsf.h @@ -0,0 +1,325 @@ +/* + * Bitstream filters public API + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_BSF_H +#define AVCODEC_BSF_H + +#include "libavutil/dict.h" +#include "libavutil/log.h" +#include "libavutil/rational.h" + +#include "codec_id.h" +#include "codec_par.h" +#include "packet.h" + +/** + * @addtogroup lavc_core + * @{ + */ + +typedef struct AVBSFInternal AVBSFInternal; + +/** + * The bitstream filter state. + * + * This struct must be allocated with av_bsf_alloc() and freed with + * av_bsf_free(). + * + * The fields in the struct will only be changed (by the caller or by the + * filter) as described in their documentation, and are to be considered + * immutable otherwise. + */ +typedef struct AVBSFContext { + /** + * A class for logging and AVOptions + */ + const AVClass *av_class; + + /** + * The bitstream filter this context is an instance of. + */ + const struct AVBitStreamFilter *filter; + + /** + * Opaque libavcodec internal data. Must not be touched by the caller in any + * way. + */ + AVBSFInternal *internal; + + /** + * Opaque filter-specific private data. If filter->priv_class is non-NULL, + * this is an AVOptions-enabled struct. + */ + void *priv_data; + + /** + * Parameters of the input stream. This field is allocated in + * av_bsf_alloc(), it needs to be filled by the caller before + * av_bsf_init(). + */ + AVCodecParameters *par_in; + + /** + * Parameters of the output stream. This field is allocated in + * av_bsf_alloc(), it is set by the filter in av_bsf_init(). + */ + AVCodecParameters *par_out; + + /** + * The timebase used for the timestamps of the input packets. Set by the + * caller before av_bsf_init(). + */ + AVRational time_base_in; + + /** + * The timebase used for the timestamps of the output packets. Set by the + * filter in av_bsf_init(). + */ + AVRational time_base_out; +} AVBSFContext; + +typedef struct AVBitStreamFilter { + const char *name; + + /** + * A list of codec ids supported by the filter, terminated by + * AV_CODEC_ID_NONE. + * May be NULL, in that case the bitstream filter works with any codec id. + */ + const enum AVCodecID *codec_ids; + + /** + * A class for the private data, used to declare bitstream filter private + * AVOptions. This field is NULL for bitstream filters that do not declare + * any options. + * + * If this field is non-NULL, the first member of the filter private data + * must be a pointer to AVClass, which will be set by libavcodec generic + * code to this class. + */ + const AVClass *priv_class; + + /***************************************************************** + * No fields below this line are part of the public API. They + * may not be used outside of libavcodec and can be changed and + * removed at will. + * New public fields should be added right above. + ***************************************************************** + */ + + int priv_data_size; + int (*init)(AVBSFContext *ctx); + int (*filter)(AVBSFContext *ctx, AVPacket *pkt); + void (*close)(AVBSFContext *ctx); + void (*flush)(AVBSFContext *ctx); +} AVBitStreamFilter; + +/** + * @return a bitstream filter with the specified name or NULL if no such + * bitstream filter exists. + */ +const AVBitStreamFilter *av_bsf_get_by_name(const char *name); + +/** + * Iterate over all registered bitstream filters. + * + * @param opaque a pointer where libavcodec will store the iteration state. Must + * point to NULL to start the iteration. + * + * @return the next registered bitstream filter or NULL when the iteration is + * finished + */ +const AVBitStreamFilter *av_bsf_iterate(void **opaque); + +/** + * Allocate a context for a given bitstream filter. The caller must fill in the + * context parameters as described in the documentation and then call + * av_bsf_init() before sending any data to the filter. + * + * @param filter the filter for which to allocate an instance. + * @param ctx a pointer into which the pointer to the newly-allocated context + * will be written. It must be freed with av_bsf_free() after the + * filtering is done. + * + * @return 0 on success, a negative AVERROR code on failure + */ +int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx); + +/** + * Prepare the filter for use, after all the parameters and options have been + * set. + */ +int av_bsf_init(AVBSFContext *ctx); + +/** + * Submit a packet for filtering. + * + * After sending each packet, the filter must be completely drained by calling + * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or + * AVERROR_EOF. + * + * @param pkt the packet to filter. The bitstream filter will take ownership of + * the packet and reset the contents of pkt. pkt is not touched if an error occurs. + * If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero), + * it signals the end of the stream (i.e. no more non-empty packets will be sent; + * sending more empty packets does nothing) and will cause the filter to output + * any packets it may have buffered internally. + * + * @return 0 on success. AVERROR(EAGAIN) if packets need to be retrieved from the + * filter (using av_bsf_receive_packet()) before new input can be consumed. Another + * negative AVERROR value if an error occurs. + */ +int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt); + +/** + * Retrieve a filtered packet. + * + * @param[out] pkt this struct will be filled with the contents of the filtered + * packet. It is owned by the caller and must be freed using + * av_packet_unref() when it is no longer needed. + * This parameter should be "clean" (i.e. freshly allocated + * with av_packet_alloc() or unreffed with av_packet_unref()) + * when this function is called. If this function returns + * successfully, the contents of pkt will be completely + * overwritten by the returned data. On failure, pkt is not + * touched. + * + * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the + * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there + * will be no further output from the filter. Another negative AVERROR value if + * an error occurs. + * + * @note one input packet may result in several output packets, so after sending + * a packet with av_bsf_send_packet(), this function needs to be called + * repeatedly until it stops returning 0. It is also possible for a filter to + * output fewer packets than were sent to it, so this function may return + * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call. + */ +int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt); + +/** + * Reset the internal bitstream filter state / flush internal buffers. + */ +void av_bsf_flush(AVBSFContext *ctx); + +/** + * Free a bitstream filter context and everything associated with it; write NULL + * into the supplied pointer. + */ +void av_bsf_free(AVBSFContext **ctx); + +/** + * Get the AVClass for AVBSFContext. It can be used in combination with + * AV_OPT_SEARCH_FAKE_OBJ for examining options. + * + * @see av_opt_find(). + */ +const AVClass *av_bsf_get_class(void); + +/** + * Structure for chain/list of bitstream filters. + * Empty list can be allocated by av_bsf_list_alloc(). + */ +typedef struct AVBSFList AVBSFList; + +/** + * Allocate empty list of bitstream filters. + * The list must be later freed by av_bsf_list_free() + * or finalized by av_bsf_list_finalize(). + * + * @return Pointer to @ref AVBSFList on success, NULL in case of failure + */ +AVBSFList *av_bsf_list_alloc(void); + +/** + * Free list of bitstream filters. + * + * @param lst Pointer to pointer returned by av_bsf_list_alloc() + */ +void av_bsf_list_free(AVBSFList **lst); + +/** + * Append bitstream filter to the list of bitstream filters. + * + * @param lst List to append to + * @param bsf Filter context to be appended + * + * @return >=0 on success, negative AVERROR in case of failure + */ +int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf); + +/** + * Construct new bitstream filter context given it's name and options + * and append it to the list of bitstream filters. + * + * @param lst List to append to + * @param bsf_name Name of the bitstream filter + * @param options Options for the bitstream filter, can be set to NULL + * + * @return >=0 on success, negative AVERROR in case of failure + */ +int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options); +/** + * Finalize list of bitstream filters. + * + * This function will transform @ref AVBSFList to single @ref AVBSFContext, + * so the whole chain of bitstream filters can be treated as single filter + * freshly allocated by av_bsf_alloc(). + * If the call is successful, @ref AVBSFList structure is freed and lst + * will be set to NULL. In case of failure, caller is responsible for + * freeing the structure by av_bsf_list_free() + * + * @param lst Filter list structure to be transformed + * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure + * representing the chain of bitstream filters + * + * @return >=0 on success, negative AVERROR in case of failure + */ +int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf); + +/** + * Parse string describing list of bitstream filters and create single + * @ref AVBSFContext describing the whole chain of bitstream filters. + * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly + * allocated by av_bsf_alloc(). + * + * @param str String describing chain of bitstream filters in format + * `bsf1[=opt1=val1:opt2=val2][,bsf2]` + * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure + * representing the chain of bitstream filters + * + * @return >=0 on success, negative AVERROR in case of failure + */ +int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf); + +/** + * Get null/pass-through bitstream filter. + * + * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter + * + * @return + */ +int av_bsf_get_null_filter(AVBSFContext **bsf); + +/** + * @} + */ + +#endif // AVCODEC_BSF_H diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/codec.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/codec.h new file mode 100644 index 0000000..1fda619 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/codec.h @@ -0,0 +1,462 @@ +/* + * AVCodec public API + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_CODEC_H +#define AVCODEC_CODEC_H + +#include + +#include "libavutil/avutil.h" +#include "libavutil/hwcontext.h" +#include "libavutil/log.h" +#include "libavutil/pixfmt.h" +#include "libavutil/rational.h" +#include "libavutil/samplefmt.h" + +#include "libavcodec/codec_id.h" +#include "libavcodec/version.h" + +/** + * @addtogroup lavc_core + * @{ + */ + +/** + * Decoder can use draw_horiz_band callback. + */ +#define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0) +/** + * Codec uses get_buffer() for allocating buffers and supports custom allocators. + * If not set, it might not use get_buffer() at all or use operations that + * assume the buffer was allocated by avcodec_default_get_buffer. + */ +#define AV_CODEC_CAP_DR1 (1 << 1) +#define AV_CODEC_CAP_TRUNCATED (1 << 3) +/** + * Encoder or decoder requires flushing with NULL input at the end in order to + * give the complete and correct output. + * + * NOTE: If this flag is not set, the codec is guaranteed to never be fed with + * with NULL data. The user can still send NULL data to the public encode + * or decode function, but libavcodec will not pass it along to the codec + * unless this flag is set. + * + * Decoders: + * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL, + * avpkt->size=0 at the end to get the delayed data until the decoder no longer + * returns frames. + * + * Encoders: + * The encoder needs to be fed with NULL data at the end of encoding until the + * encoder no longer returns data. + * + * NOTE: For encoders implementing the AVCodec.encode2() function, setting this + * flag also means that the encoder must set the pts and duration for + * each output packet. If this flag is not set, the pts and duration will + * be determined by libavcodec from the input frame. + */ +#define AV_CODEC_CAP_DELAY (1 << 5) +/** + * Codec can be fed a final frame with a smaller size. + * This can be used to prevent truncation of the last audio samples. + */ +#define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6) + +/** + * Codec can output multiple frames per AVPacket + * Normally demuxers return one frame at a time, demuxers which do not do + * are connected to a parser to split what they return into proper frames. + * This flag is reserved to the very rare category of codecs which have a + * bitstream that cannot be split into frames without timeconsuming + * operations like full decoding. Demuxers carrying such bitstreams thus + * may return multiple frames in a packet. This has many disadvantages like + * prohibiting stream copy in many cases thus it should only be considered + * as a last resort. + */ +#define AV_CODEC_CAP_SUBFRAMES (1 << 8) +/** + * Codec is experimental and is thus avoided in favor of non experimental + * encoders + */ +#define AV_CODEC_CAP_EXPERIMENTAL (1 << 9) +/** + * Codec should fill in channel configuration and samplerate instead of container + */ +#define AV_CODEC_CAP_CHANNEL_CONF (1 << 10) +/** + * Codec supports frame-level multithreading. + */ +#define AV_CODEC_CAP_FRAME_THREADS (1 << 12) +/** + * Codec supports slice-based (or partition-based) multithreading. + */ +#define AV_CODEC_CAP_SLICE_THREADS (1 << 13) +/** + * Codec supports changed parameters at any point. + */ +#define AV_CODEC_CAP_PARAM_CHANGE (1 << 14) +/** + * Codec supports avctx->thread_count == 0 (auto). + */ +#define AV_CODEC_CAP_AUTO_THREADS (1 << 15) +/** + * Audio encoder supports receiving a different number of samples in each call. + */ +#define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16) +/** + * Decoder is not a preferred choice for probing. + * This indicates that the decoder is not a good choice for probing. + * It could for example be an expensive to spin up hardware decoder, + * or it could simply not provide a lot of useful information about + * the stream. + * A decoder marked with this flag should only be used as last resort + * choice for probing. + */ +#define AV_CODEC_CAP_AVOID_PROBING (1 << 17) + +#if FF_API_UNUSED_CODEC_CAPS +/** + * Deprecated and unused. Use AVCodecDescriptor.props instead + */ +#define AV_CODEC_CAP_INTRA_ONLY 0x40000000 +/** + * Deprecated and unused. Use AVCodecDescriptor.props instead + */ +#define AV_CODEC_CAP_LOSSLESS 0x80000000 +#endif + +/** + * Codec is backed by a hardware implementation. Typically used to + * identify a non-hwaccel hardware decoder. For information about hwaccels, use + * avcodec_get_hw_config() instead. + */ +#define AV_CODEC_CAP_HARDWARE (1 << 18) + +/** + * Codec is potentially backed by a hardware implementation, but not + * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the + * implementation provides some sort of internal fallback. + */ +#define AV_CODEC_CAP_HYBRID (1 << 19) + +/** + * This codec takes the reordered_opaque field from input AVFrames + * and returns it in the corresponding field in AVCodecContext after + * encoding. + */ +#define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20) + +/** + * This encoder can be flushed using avcodec_flush_buffers(). If this flag is + * not set, the encoder must be closed and reopened to ensure that no frames + * remain pending. + */ +#define AV_CODEC_CAP_ENCODER_FLUSH (1 << 21) + +/** + * AVProfile. + */ +typedef struct AVProfile { + int profile; + const char *name; ///< short name for the profile +} AVProfile; + +typedef struct AVCodecDefault AVCodecDefault; + +struct AVCodecContext; +struct AVSubtitle; +struct AVPacket; + +/** + * AVCodec. + */ +typedef struct AVCodec { + /** + * Name of the codec implementation. + * The name is globally unique among encoders and among decoders (but an + * encoder and a decoder can share the same name). + * This is the primary way to find a codec from the user perspective. + */ + const char *name; + /** + * Descriptive name for the codec, meant to be more human readable than name. + * You should use the NULL_IF_CONFIG_SMALL() macro to define it. + */ + const char *long_name; + enum AVMediaType type; + enum AVCodecID id; + /** + * Codec capabilities. + * see AV_CODEC_CAP_* + */ + int capabilities; + const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0} + const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1 + const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0 + const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1 + const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0 + uint8_t max_lowres; ///< maximum value for lowres supported by the decoder + const AVClass *priv_class; ///< AVClass for the private context + const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN} + + /** + * Group name of the codec implementation. + * This is a short symbolic name of the wrapper backing this codec. A + * wrapper uses some kind of external implementation for the codec, such + * as an external library, or a codec implementation provided by the OS or + * the hardware. + * If this field is NULL, this is a builtin, libavcodec native codec. + * If non-NULL, this will be the suffix in AVCodec.name in most cases + * (usually AVCodec.name will be of the form "_"). + */ + const char *wrapper_name; + + /***************************************************************** + * No fields below this line are part of the public API. They + * may not be used outside of libavcodec and can be changed and + * removed at will. + * New public fields should be added right above. + ***************************************************************** + */ + int priv_data_size; + struct AVCodec *next; + /** + * @name Frame-level threading support functions + * @{ + */ + /** + * Copy necessary context variables from a previous thread context to the current one. + * If not defined, the next thread will start automatically; otherwise, the codec + * must call ff_thread_finish_setup(). + * + * dst and src will (rarely) point to the same context, in which case memcpy should be skipped. + */ + int (*update_thread_context)(struct AVCodecContext *dst, const struct AVCodecContext *src); + /** @} */ + + /** + * Private codec-specific defaults. + */ + const AVCodecDefault *defaults; + + /** + * Initialize codec static data, called from avcodec_register(). + * + * This is not intended for time consuming operations as it is + * run for every codec regardless of that codec being used. + */ + void (*init_static_data)(struct AVCodec *codec); + + int (*init)(struct AVCodecContext *); + int (*encode_sub)(struct AVCodecContext *, uint8_t *buf, int buf_size, + const struct AVSubtitle *sub); + /** + * Encode data to an AVPacket. + * + * @param avctx codec context + * @param avpkt output AVPacket (may contain a user-provided buffer) + * @param[in] frame AVFrame containing the raw data to be encoded + * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a + * non-empty packet was returned in avpkt. + * @return 0 on success, negative error code on failure + */ + int (*encode2)(struct AVCodecContext *avctx, struct AVPacket *avpkt, + const struct AVFrame *frame, int *got_packet_ptr); + int (*decode)(struct AVCodecContext *, void *outdata, int *outdata_size, struct AVPacket *avpkt); + int (*close)(struct AVCodecContext *); + /** + * Encode API with decoupled packet/frame dataflow. The API is the + * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except + * that: + * - never called if the codec is closed or the wrong type, + * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent, + * - only one drain frame is ever passed down, + */ + int (*send_frame)(struct AVCodecContext *avctx, const struct AVFrame *frame); + int (*receive_packet)(struct AVCodecContext *avctx, struct AVPacket *avpkt); + + /** + * Decode API with decoupled packet/frame dataflow. This function is called + * to get one output frame. It should call ff_decode_get_packet() to obtain + * input data. + */ + int (*receive_frame)(struct AVCodecContext *avctx, struct AVFrame *frame); + /** + * Flush buffers. + * Will be called when seeking + */ + void (*flush)(struct AVCodecContext *); + /** + * Internal codec capabilities. + * See FF_CODEC_CAP_* in internal.h + */ + int caps_internal; + + /** + * Decoding only, a comma-separated list of bitstream filters to apply to + * packets before decoding. + */ + const char *bsfs; + + /** + * Array of pointers to hardware configurations supported by the codec, + * or NULL if no hardware supported. The array is terminated by a NULL + * pointer. + * + * The user can only access this field via avcodec_get_hw_config(). + */ + const struct AVCodecHWConfigInternal **hw_configs; + + /** + * List of supported codec_tags, terminated by FF_CODEC_TAGS_END. + */ + const uint32_t *codec_tags; +} AVCodec; + +/** + * Iterate over all registered codecs. + * + * @param opaque a pointer where libavcodec will store the iteration state. Must + * point to NULL to start the iteration. + * + * @return the next registered codec or NULL when the iteration is + * finished + */ +const AVCodec *av_codec_iterate(void **opaque); + +/** + * Find a registered decoder with a matching codec ID. + * + * @param id AVCodecID of the requested decoder + * @return A decoder if one was found, NULL otherwise. + */ +AVCodec *avcodec_find_decoder(enum AVCodecID id); + +/** + * Find a registered decoder with the specified name. + * + * @param name name of the requested decoder + * @return A decoder if one was found, NULL otherwise. + */ +AVCodec *avcodec_find_decoder_by_name(const char *name); + +/** + * Find a registered encoder with a matching codec ID. + * + * @param id AVCodecID of the requested encoder + * @return An encoder if one was found, NULL otherwise. + */ +AVCodec *avcodec_find_encoder(enum AVCodecID id); + +/** + * Find a registered encoder with the specified name. + * + * @param name name of the requested encoder + * @return An encoder if one was found, NULL otherwise. + */ +AVCodec *avcodec_find_encoder_by_name(const char *name); +/** + * @return a non-zero number if codec is an encoder, zero otherwise + */ +int av_codec_is_encoder(const AVCodec *codec); + +/** + * @return a non-zero number if codec is a decoder, zero otherwise + */ +int av_codec_is_decoder(const AVCodec *codec); + +enum { + /** + * The codec supports this format via the hw_device_ctx interface. + * + * When selecting this format, AVCodecContext.hw_device_ctx should + * have been set to a device of the specified type before calling + * avcodec_open2(). + */ + AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01, + /** + * The codec supports this format via the hw_frames_ctx interface. + * + * When selecting this format for a decoder, + * AVCodecContext.hw_frames_ctx should be set to a suitable frames + * context inside the get_format() callback. The frames context + * must have been created on a device of the specified type. + * + * When selecting this format for an encoder, + * AVCodecContext.hw_frames_ctx should be set to the context which + * will be used for the input frames before calling avcodec_open2(). + */ + AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02, + /** + * The codec supports this format by some internal method. + * + * This format can be selected without any additional configuration - + * no device or frames context is required. + */ + AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04, + /** + * The codec supports this format by some ad-hoc method. + * + * Additional settings and/or function calls are required. See the + * codec-specific documentation for details. (Methods requiring + * this sort of configuration are deprecated and others should be + * used in preference.) + */ + AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08, +}; + +typedef struct AVCodecHWConfig { + /** + * For decoders, a hardware pixel format which that decoder may be + * able to decode to if suitable hardware is available. + * + * For encoders, a pixel format which the encoder may be able to + * accept. If set to AV_PIX_FMT_NONE, this applies to all pixel + * formats supported by the codec. + */ + enum AVPixelFormat pix_fmt; + /** + * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible + * setup methods which can be used with this configuration. + */ + int methods; + /** + * The device type associated with the configuration. + * + * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and + * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused. + */ + enum AVHWDeviceType device_type; +} AVCodecHWConfig; + +/** + * Retrieve supported hardware configurations for a codec. + * + * Values of index from zero to some maximum return the indexed configuration + * descriptor; all other values return NULL. If the codec does not support + * any hardware configurations then it will always return NULL. + */ +const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index); + +/** + * @} + */ + +#endif /* AVCODEC_CODEC_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/codec_desc.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/codec_desc.h new file mode 100644 index 0000000..126b52d --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/codec_desc.h @@ -0,0 +1,128 @@ +/* + * Codec descriptors public API + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_CODEC_DESC_H +#define AVCODEC_CODEC_DESC_H + +#include "libavutil/avutil.h" + +#include "codec_id.h" + +/** + * @addtogroup lavc_core + * @{ + */ + +/** + * This struct describes the properties of a single codec described by an + * AVCodecID. + * @see avcodec_descriptor_get() + */ +typedef struct AVCodecDescriptor { + enum AVCodecID id; + enum AVMediaType type; + /** + * Name of the codec described by this descriptor. It is non-empty and + * unique for each codec descriptor. It should contain alphanumeric + * characters and '_' only. + */ + const char *name; + /** + * A more descriptive name for this codec. May be NULL. + */ + const char *long_name; + /** + * Codec properties, a combination of AV_CODEC_PROP_* flags. + */ + int props; + /** + * MIME type(s) associated with the codec. + * May be NULL; if not, a NULL-terminated array of MIME types. + * The first item is always non-NULL and is the preferred MIME type. + */ + const char *const *mime_types; + /** + * If non-NULL, an array of profiles recognized for this codec. + * Terminated with FF_PROFILE_UNKNOWN. + */ + const struct AVProfile *profiles; +} AVCodecDescriptor; + +/** + * Codec uses only intra compression. + * Video and audio codecs only. + */ +#define AV_CODEC_PROP_INTRA_ONLY (1 << 0) +/** + * Codec supports lossy compression. Audio and video codecs only. + * @note a codec may support both lossy and lossless + * compression modes + */ +#define AV_CODEC_PROP_LOSSY (1 << 1) +/** + * Codec supports lossless compression. Audio and video codecs only. + */ +#define AV_CODEC_PROP_LOSSLESS (1 << 2) +/** + * Codec supports frame reordering. That is, the coded order (the order in which + * the encoded packets are output by the encoders / stored / input to the + * decoders) may be different from the presentation order of the corresponding + * frames. + * + * For codecs that do not have this property set, PTS and DTS should always be + * equal. + */ +#define AV_CODEC_PROP_REORDER (1 << 3) +/** + * Subtitle codec is bitmap based + * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field. + */ +#define AV_CODEC_PROP_BITMAP_SUB (1 << 16) +/** + * Subtitle codec is text based. + * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field. + */ +#define AV_CODEC_PROP_TEXT_SUB (1 << 17) + +/** + * @return descriptor for given codec ID or NULL if no descriptor exists. + */ +const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id); + +/** + * Iterate over all codec descriptors known to libavcodec. + * + * @param prev previous descriptor. NULL to get the first descriptor. + * + * @return next descriptor or NULL after the last descriptor + */ +const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev); + +/** + * @return codec descriptor with the given name or NULL if no such descriptor + * exists. + */ +const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name); + +/** + * @} + */ + +#endif // AVCODEC_CODEC_DESC_H diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/codec_id.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/codec_id.h new file mode 100644 index 0000000..d885962 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/codec_id.h @@ -0,0 +1,577 @@ +/* + * Codec IDs + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_CODEC_ID_H +#define AVCODEC_CODEC_ID_H + +#include "libavutil/avutil.h" + +/** + * @addtogroup lavc_core + * @{ + */ + +/** + * Identify the syntax and semantics of the bitstream. + * The principle is roughly: + * Two decoders with the same ID can decode the same streams. + * Two encoders with the same ID can encode compatible streams. + * There may be slight deviations from the principle due to implementation + * details. + * + * If you add a codec ID to this list, add it so that + * 1. no value of an existing codec ID changes (that would break ABI), + * 2. it is as close as possible to similar codecs + * + * After adding new codec IDs, do not forget to add an entry to the codec + * descriptor list and bump libavcodec minor version. + */ +enum AVCodecID { + AV_CODEC_ID_NONE, + + /* video codecs */ + AV_CODEC_ID_MPEG1VIDEO, + AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding + AV_CODEC_ID_H261, + AV_CODEC_ID_H263, + AV_CODEC_ID_RV10, + AV_CODEC_ID_RV20, + AV_CODEC_ID_MJPEG, + AV_CODEC_ID_MJPEGB, + AV_CODEC_ID_LJPEG, + AV_CODEC_ID_SP5X, + AV_CODEC_ID_JPEGLS, + AV_CODEC_ID_MPEG4, + AV_CODEC_ID_RAWVIDEO, + AV_CODEC_ID_MSMPEG4V1, + AV_CODEC_ID_MSMPEG4V2, + AV_CODEC_ID_MSMPEG4V3, + AV_CODEC_ID_WMV1, + AV_CODEC_ID_WMV2, + AV_CODEC_ID_H263P, + AV_CODEC_ID_H263I, + AV_CODEC_ID_FLV1, + AV_CODEC_ID_SVQ1, + AV_CODEC_ID_SVQ3, + AV_CODEC_ID_DVVIDEO, + AV_CODEC_ID_HUFFYUV, + AV_CODEC_ID_CYUV, + AV_CODEC_ID_H264, + AV_CODEC_ID_INDEO3, + AV_CODEC_ID_VP3, + AV_CODEC_ID_THEORA, + AV_CODEC_ID_ASV1, + AV_CODEC_ID_ASV2, + AV_CODEC_ID_FFV1, + AV_CODEC_ID_4XM, + AV_CODEC_ID_VCR1, + AV_CODEC_ID_CLJR, + AV_CODEC_ID_MDEC, + AV_CODEC_ID_ROQ, + AV_CODEC_ID_INTERPLAY_VIDEO, + AV_CODEC_ID_XAN_WC3, + AV_CODEC_ID_XAN_WC4, + AV_CODEC_ID_RPZA, + AV_CODEC_ID_CINEPAK, + AV_CODEC_ID_WS_VQA, + AV_CODEC_ID_MSRLE, + AV_CODEC_ID_MSVIDEO1, + AV_CODEC_ID_IDCIN, + AV_CODEC_ID_8BPS, + AV_CODEC_ID_SMC, + AV_CODEC_ID_FLIC, + AV_CODEC_ID_TRUEMOTION1, + AV_CODEC_ID_VMDVIDEO, + AV_CODEC_ID_MSZH, + AV_CODEC_ID_ZLIB, + AV_CODEC_ID_QTRLE, + AV_CODEC_ID_TSCC, + AV_CODEC_ID_ULTI, + AV_CODEC_ID_QDRAW, + AV_CODEC_ID_VIXL, + AV_CODEC_ID_QPEG, + AV_CODEC_ID_PNG, + AV_CODEC_ID_PPM, + AV_CODEC_ID_PBM, + AV_CODEC_ID_PGM, + AV_CODEC_ID_PGMYUV, + AV_CODEC_ID_PAM, + AV_CODEC_ID_FFVHUFF, + AV_CODEC_ID_RV30, + AV_CODEC_ID_RV40, + AV_CODEC_ID_VC1, + AV_CODEC_ID_WMV3, + AV_CODEC_ID_LOCO, + AV_CODEC_ID_WNV1, + AV_CODEC_ID_AASC, + AV_CODEC_ID_INDEO2, + AV_CODEC_ID_FRAPS, + AV_CODEC_ID_TRUEMOTION2, + AV_CODEC_ID_BMP, + AV_CODEC_ID_CSCD, + AV_CODEC_ID_MMVIDEO, + AV_CODEC_ID_ZMBV, + AV_CODEC_ID_AVS, + AV_CODEC_ID_SMACKVIDEO, + AV_CODEC_ID_NUV, + AV_CODEC_ID_KMVC, + AV_CODEC_ID_FLASHSV, + AV_CODEC_ID_CAVS, + AV_CODEC_ID_JPEG2000, + AV_CODEC_ID_VMNC, + AV_CODEC_ID_VP5, + AV_CODEC_ID_VP6, + AV_CODEC_ID_VP6F, + AV_CODEC_ID_TARGA, + AV_CODEC_ID_DSICINVIDEO, + AV_CODEC_ID_TIERTEXSEQVIDEO, + AV_CODEC_ID_TIFF, + AV_CODEC_ID_GIF, + AV_CODEC_ID_DXA, + AV_CODEC_ID_DNXHD, + AV_CODEC_ID_THP, + AV_CODEC_ID_SGI, + AV_CODEC_ID_C93, + AV_CODEC_ID_BETHSOFTVID, + AV_CODEC_ID_PTX, + AV_CODEC_ID_TXD, + AV_CODEC_ID_VP6A, + AV_CODEC_ID_AMV, + AV_CODEC_ID_VB, + AV_CODEC_ID_PCX, + AV_CODEC_ID_SUNRAST, + AV_CODEC_ID_INDEO4, + AV_CODEC_ID_INDEO5, + AV_CODEC_ID_MIMIC, + AV_CODEC_ID_RL2, + AV_CODEC_ID_ESCAPE124, + AV_CODEC_ID_DIRAC, + AV_CODEC_ID_BFI, + AV_CODEC_ID_CMV, + AV_CODEC_ID_MOTIONPIXELS, + AV_CODEC_ID_TGV, + AV_CODEC_ID_TGQ, + AV_CODEC_ID_TQI, + AV_CODEC_ID_AURA, + AV_CODEC_ID_AURA2, + AV_CODEC_ID_V210X, + AV_CODEC_ID_TMV, + AV_CODEC_ID_V210, + AV_CODEC_ID_DPX, + AV_CODEC_ID_MAD, + AV_CODEC_ID_FRWU, + AV_CODEC_ID_FLASHSV2, + AV_CODEC_ID_CDGRAPHICS, + AV_CODEC_ID_R210, + AV_CODEC_ID_ANM, + AV_CODEC_ID_BINKVIDEO, + AV_CODEC_ID_IFF_ILBM, +#define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM + AV_CODEC_ID_KGV1, + AV_CODEC_ID_YOP, + AV_CODEC_ID_VP8, + AV_CODEC_ID_PICTOR, + AV_CODEC_ID_ANSI, + AV_CODEC_ID_A64_MULTI, + AV_CODEC_ID_A64_MULTI5, + AV_CODEC_ID_R10K, + AV_CODEC_ID_MXPEG, + AV_CODEC_ID_LAGARITH, + AV_CODEC_ID_PRORES, + AV_CODEC_ID_JV, + AV_CODEC_ID_DFA, + AV_CODEC_ID_WMV3IMAGE, + AV_CODEC_ID_VC1IMAGE, + AV_CODEC_ID_UTVIDEO, + AV_CODEC_ID_BMV_VIDEO, + AV_CODEC_ID_VBLE, + AV_CODEC_ID_DXTORY, + AV_CODEC_ID_V410, + AV_CODEC_ID_XWD, + AV_CODEC_ID_CDXL, + AV_CODEC_ID_XBM, + AV_CODEC_ID_ZEROCODEC, + AV_CODEC_ID_MSS1, + AV_CODEC_ID_MSA1, + AV_CODEC_ID_TSCC2, + AV_CODEC_ID_MTS2, + AV_CODEC_ID_CLLC, + AV_CODEC_ID_MSS2, + AV_CODEC_ID_VP9, + AV_CODEC_ID_AIC, + AV_CODEC_ID_ESCAPE130, + AV_CODEC_ID_G2M, + AV_CODEC_ID_WEBP, + AV_CODEC_ID_HNM4_VIDEO, + AV_CODEC_ID_HEVC, +#define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC + AV_CODEC_ID_FIC, + AV_CODEC_ID_ALIAS_PIX, + AV_CODEC_ID_BRENDER_PIX, + AV_CODEC_ID_PAF_VIDEO, + AV_CODEC_ID_EXR, + AV_CODEC_ID_VP7, + AV_CODEC_ID_SANM, + AV_CODEC_ID_SGIRLE, + AV_CODEC_ID_MVC1, + AV_CODEC_ID_MVC2, + AV_CODEC_ID_HQX, + AV_CODEC_ID_TDSC, + AV_CODEC_ID_HQ_HQA, + AV_CODEC_ID_HAP, + AV_CODEC_ID_DDS, + AV_CODEC_ID_DXV, + AV_CODEC_ID_SCREENPRESSO, + AV_CODEC_ID_RSCC, + AV_CODEC_ID_AVS2, + + AV_CODEC_ID_Y41P = 0x8000, + AV_CODEC_ID_AVRP, + AV_CODEC_ID_012V, + AV_CODEC_ID_AVUI, + AV_CODEC_ID_AYUV, + AV_CODEC_ID_TARGA_Y216, + AV_CODEC_ID_V308, + AV_CODEC_ID_V408, + AV_CODEC_ID_YUV4, + AV_CODEC_ID_AVRN, + AV_CODEC_ID_CPIA, + AV_CODEC_ID_XFACE, + AV_CODEC_ID_SNOW, + AV_CODEC_ID_SMVJPEG, + AV_CODEC_ID_APNG, + AV_CODEC_ID_DAALA, + AV_CODEC_ID_CFHD, + AV_CODEC_ID_TRUEMOTION2RT, + AV_CODEC_ID_M101, + AV_CODEC_ID_MAGICYUV, + AV_CODEC_ID_SHEERVIDEO, + AV_CODEC_ID_YLC, + AV_CODEC_ID_PSD, + AV_CODEC_ID_PIXLET, + AV_CODEC_ID_SPEEDHQ, + AV_CODEC_ID_FMVC, + AV_CODEC_ID_SCPR, + AV_CODEC_ID_CLEARVIDEO, + AV_CODEC_ID_XPM, + AV_CODEC_ID_AV1, + AV_CODEC_ID_BITPACKED, + AV_CODEC_ID_MSCC, + AV_CODEC_ID_SRGC, + AV_CODEC_ID_SVG, + AV_CODEC_ID_GDV, + AV_CODEC_ID_FITS, + AV_CODEC_ID_IMM4, + AV_CODEC_ID_PROSUMER, + AV_CODEC_ID_MWSC, + AV_CODEC_ID_WCMV, + AV_CODEC_ID_RASC, + AV_CODEC_ID_HYMT, + AV_CODEC_ID_ARBC, + AV_CODEC_ID_AGM, + AV_CODEC_ID_LSCR, + AV_CODEC_ID_VP4, + AV_CODEC_ID_IMM5, + AV_CODEC_ID_MVDV, + AV_CODEC_ID_MVHA, + AV_CODEC_ID_CDTOONS, + AV_CODEC_ID_MV30, + AV_CODEC_ID_NOTCHLC, + AV_CODEC_ID_PFM, + + /* various PCM "codecs" */ + AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs + AV_CODEC_ID_PCM_S16LE = 0x10000, + AV_CODEC_ID_PCM_S16BE, + AV_CODEC_ID_PCM_U16LE, + AV_CODEC_ID_PCM_U16BE, + AV_CODEC_ID_PCM_S8, + AV_CODEC_ID_PCM_U8, + AV_CODEC_ID_PCM_MULAW, + AV_CODEC_ID_PCM_ALAW, + AV_CODEC_ID_PCM_S32LE, + AV_CODEC_ID_PCM_S32BE, + AV_CODEC_ID_PCM_U32LE, + AV_CODEC_ID_PCM_U32BE, + AV_CODEC_ID_PCM_S24LE, + AV_CODEC_ID_PCM_S24BE, + AV_CODEC_ID_PCM_U24LE, + AV_CODEC_ID_PCM_U24BE, + AV_CODEC_ID_PCM_S24DAUD, + AV_CODEC_ID_PCM_ZORK, + AV_CODEC_ID_PCM_S16LE_PLANAR, + AV_CODEC_ID_PCM_DVD, + AV_CODEC_ID_PCM_F32BE, + AV_CODEC_ID_PCM_F32LE, + AV_CODEC_ID_PCM_F64BE, + AV_CODEC_ID_PCM_F64LE, + AV_CODEC_ID_PCM_BLURAY, + AV_CODEC_ID_PCM_LXF, + AV_CODEC_ID_S302M, + AV_CODEC_ID_PCM_S8_PLANAR, + AV_CODEC_ID_PCM_S24LE_PLANAR, + AV_CODEC_ID_PCM_S32LE_PLANAR, + AV_CODEC_ID_PCM_S16BE_PLANAR, + + AV_CODEC_ID_PCM_S64LE = 0x10800, + AV_CODEC_ID_PCM_S64BE, + AV_CODEC_ID_PCM_F16LE, + AV_CODEC_ID_PCM_F24LE, + AV_CODEC_ID_PCM_VIDC, + + /* various ADPCM codecs */ + AV_CODEC_ID_ADPCM_IMA_QT = 0x11000, + AV_CODEC_ID_ADPCM_IMA_WAV, + AV_CODEC_ID_ADPCM_IMA_DK3, + AV_CODEC_ID_ADPCM_IMA_DK4, + AV_CODEC_ID_ADPCM_IMA_WS, + AV_CODEC_ID_ADPCM_IMA_SMJPEG, + AV_CODEC_ID_ADPCM_MS, + AV_CODEC_ID_ADPCM_4XM, + AV_CODEC_ID_ADPCM_XA, + AV_CODEC_ID_ADPCM_ADX, + AV_CODEC_ID_ADPCM_EA, + AV_CODEC_ID_ADPCM_G726, + AV_CODEC_ID_ADPCM_CT, + AV_CODEC_ID_ADPCM_SWF, + AV_CODEC_ID_ADPCM_YAMAHA, + AV_CODEC_ID_ADPCM_SBPRO_4, + AV_CODEC_ID_ADPCM_SBPRO_3, + AV_CODEC_ID_ADPCM_SBPRO_2, + AV_CODEC_ID_ADPCM_THP, + AV_CODEC_ID_ADPCM_IMA_AMV, + AV_CODEC_ID_ADPCM_EA_R1, + AV_CODEC_ID_ADPCM_EA_R3, + AV_CODEC_ID_ADPCM_EA_R2, + AV_CODEC_ID_ADPCM_IMA_EA_SEAD, + AV_CODEC_ID_ADPCM_IMA_EA_EACS, + AV_CODEC_ID_ADPCM_EA_XAS, + AV_CODEC_ID_ADPCM_EA_MAXIS_XA, + AV_CODEC_ID_ADPCM_IMA_ISS, + AV_CODEC_ID_ADPCM_G722, + AV_CODEC_ID_ADPCM_IMA_APC, + AV_CODEC_ID_ADPCM_VIMA, + + AV_CODEC_ID_ADPCM_AFC = 0x11800, + AV_CODEC_ID_ADPCM_IMA_OKI, + AV_CODEC_ID_ADPCM_DTK, + AV_CODEC_ID_ADPCM_IMA_RAD, + AV_CODEC_ID_ADPCM_G726LE, + AV_CODEC_ID_ADPCM_THP_LE, + AV_CODEC_ID_ADPCM_PSX, + AV_CODEC_ID_ADPCM_AICA, + AV_CODEC_ID_ADPCM_IMA_DAT4, + AV_CODEC_ID_ADPCM_MTAF, + AV_CODEC_ID_ADPCM_AGM, + AV_CODEC_ID_ADPCM_ARGO, + AV_CODEC_ID_ADPCM_IMA_SSI, + AV_CODEC_ID_ADPCM_ZORK, + AV_CODEC_ID_ADPCM_IMA_APM, + AV_CODEC_ID_ADPCM_IMA_ALP, + AV_CODEC_ID_ADPCM_IMA_MTF, + AV_CODEC_ID_ADPCM_IMA_CUNNING, + + /* AMR */ + AV_CODEC_ID_AMR_NB = 0x12000, + AV_CODEC_ID_AMR_WB, + + /* RealAudio codecs*/ + AV_CODEC_ID_RA_144 = 0x13000, + AV_CODEC_ID_RA_288, + + /* various DPCM codecs */ + AV_CODEC_ID_ROQ_DPCM = 0x14000, + AV_CODEC_ID_INTERPLAY_DPCM, + AV_CODEC_ID_XAN_DPCM, + AV_CODEC_ID_SOL_DPCM, + + AV_CODEC_ID_SDX2_DPCM = 0x14800, + AV_CODEC_ID_GREMLIN_DPCM, + AV_CODEC_ID_DERF_DPCM, + + /* audio codecs */ + AV_CODEC_ID_MP2 = 0x15000, + AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3 + AV_CODEC_ID_AAC, + AV_CODEC_ID_AC3, + AV_CODEC_ID_DTS, + AV_CODEC_ID_VORBIS, + AV_CODEC_ID_DVAUDIO, + AV_CODEC_ID_WMAV1, + AV_CODEC_ID_WMAV2, + AV_CODEC_ID_MACE3, + AV_CODEC_ID_MACE6, + AV_CODEC_ID_VMDAUDIO, + AV_CODEC_ID_FLAC, + AV_CODEC_ID_MP3ADU, + AV_CODEC_ID_MP3ON4, + AV_CODEC_ID_SHORTEN, + AV_CODEC_ID_ALAC, + AV_CODEC_ID_WESTWOOD_SND1, + AV_CODEC_ID_GSM, ///< as in Berlin toast format + AV_CODEC_ID_QDM2, + AV_CODEC_ID_COOK, + AV_CODEC_ID_TRUESPEECH, + AV_CODEC_ID_TTA, + AV_CODEC_ID_SMACKAUDIO, + AV_CODEC_ID_QCELP, + AV_CODEC_ID_WAVPACK, + AV_CODEC_ID_DSICINAUDIO, + AV_CODEC_ID_IMC, + AV_CODEC_ID_MUSEPACK7, + AV_CODEC_ID_MLP, + AV_CODEC_ID_GSM_MS, /* as found in WAV */ + AV_CODEC_ID_ATRAC3, + AV_CODEC_ID_APE, + AV_CODEC_ID_NELLYMOSER, + AV_CODEC_ID_MUSEPACK8, + AV_CODEC_ID_SPEEX, + AV_CODEC_ID_WMAVOICE, + AV_CODEC_ID_WMAPRO, + AV_CODEC_ID_WMALOSSLESS, + AV_CODEC_ID_ATRAC3P, + AV_CODEC_ID_EAC3, + AV_CODEC_ID_SIPR, + AV_CODEC_ID_MP1, + AV_CODEC_ID_TWINVQ, + AV_CODEC_ID_TRUEHD, + AV_CODEC_ID_MP4ALS, + AV_CODEC_ID_ATRAC1, + AV_CODEC_ID_BINKAUDIO_RDFT, + AV_CODEC_ID_BINKAUDIO_DCT, + AV_CODEC_ID_AAC_LATM, + AV_CODEC_ID_QDMC, + AV_CODEC_ID_CELT, + AV_CODEC_ID_G723_1, + AV_CODEC_ID_G729, + AV_CODEC_ID_8SVX_EXP, + AV_CODEC_ID_8SVX_FIB, + AV_CODEC_ID_BMV_AUDIO, + AV_CODEC_ID_RALF, + AV_CODEC_ID_IAC, + AV_CODEC_ID_ILBC, + AV_CODEC_ID_OPUS, + AV_CODEC_ID_COMFORT_NOISE, + AV_CODEC_ID_TAK, + AV_CODEC_ID_METASOUND, + AV_CODEC_ID_PAF_AUDIO, + AV_CODEC_ID_ON2AVC, + AV_CODEC_ID_DSS_SP, + AV_CODEC_ID_CODEC2, + + AV_CODEC_ID_FFWAVESYNTH = 0x15800, + AV_CODEC_ID_SONIC, + AV_CODEC_ID_SONIC_LS, + AV_CODEC_ID_EVRC, + AV_CODEC_ID_SMV, + AV_CODEC_ID_DSD_LSBF, + AV_CODEC_ID_DSD_MSBF, + AV_CODEC_ID_DSD_LSBF_PLANAR, + AV_CODEC_ID_DSD_MSBF_PLANAR, + AV_CODEC_ID_4GV, + AV_CODEC_ID_INTERPLAY_ACM, + AV_CODEC_ID_XMA1, + AV_CODEC_ID_XMA2, + AV_CODEC_ID_DST, + AV_CODEC_ID_ATRAC3AL, + AV_CODEC_ID_ATRAC3PAL, + AV_CODEC_ID_DOLBY_E, + AV_CODEC_ID_APTX, + AV_CODEC_ID_APTX_HD, + AV_CODEC_ID_SBC, + AV_CODEC_ID_ATRAC9, + AV_CODEC_ID_HCOM, + AV_CODEC_ID_ACELP_KELVIN, + AV_CODEC_ID_MPEGH_3D_AUDIO, + AV_CODEC_ID_SIREN, + AV_CODEC_ID_HCA, + + /* subtitle codecs */ + AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs. + AV_CODEC_ID_DVD_SUBTITLE = 0x17000, + AV_CODEC_ID_DVB_SUBTITLE, + AV_CODEC_ID_TEXT, ///< raw UTF-8 text + AV_CODEC_ID_XSUB, + AV_CODEC_ID_SSA, + AV_CODEC_ID_MOV_TEXT, + AV_CODEC_ID_HDMV_PGS_SUBTITLE, + AV_CODEC_ID_DVB_TELETEXT, + AV_CODEC_ID_SRT, + + AV_CODEC_ID_MICRODVD = 0x17800, + AV_CODEC_ID_EIA_608, + AV_CODEC_ID_JACOSUB, + AV_CODEC_ID_SAMI, + AV_CODEC_ID_REALTEXT, + AV_CODEC_ID_STL, + AV_CODEC_ID_SUBVIEWER1, + AV_CODEC_ID_SUBVIEWER, + AV_CODEC_ID_SUBRIP, + AV_CODEC_ID_WEBVTT, + AV_CODEC_ID_MPL2, + AV_CODEC_ID_VPLAYER, + AV_CODEC_ID_PJS, + AV_CODEC_ID_ASS, + AV_CODEC_ID_HDMV_TEXT_SUBTITLE, + AV_CODEC_ID_TTML, + AV_CODEC_ID_ARIB_CAPTION, + + /* other specific kind of codecs (generally used for attachments) */ + AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs. + AV_CODEC_ID_TTF = 0x18000, + + AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream. + AV_CODEC_ID_EPG, + AV_CODEC_ID_BINTEXT = 0x18800, + AV_CODEC_ID_XBIN, + AV_CODEC_ID_IDF, + AV_CODEC_ID_OTF, + AV_CODEC_ID_SMPTE_KLV, + AV_CODEC_ID_DVD_NAV, + AV_CODEC_ID_TIMED_ID3, + AV_CODEC_ID_BIN_DATA, + + + AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it + + AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS + * stream (only used by libavformat) */ + AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems + * stream (only used by libavformat) */ + AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information. + AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket +}; + +/** + * Get the type of the given codec. + */ +enum AVMediaType avcodec_get_type(enum AVCodecID codec_id); + +/** + * Get the name of a codec. + * @return a static string identifying the codec; never NULL + */ +const char *avcodec_get_name(enum AVCodecID id); + +/** + * @} + */ + +#endif // AVCODEC_CODEC_ID_H diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/codec_par.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/codec_par.h new file mode 100644 index 0000000..948758e --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/codec_par.h @@ -0,0 +1,229 @@ +/* + * Codec parameters public API + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_CODEC_PAR_H +#define AVCODEC_CODEC_PAR_H + +#include + +#include "libavutil/avutil.h" +#include "libavutil/rational.h" +#include "libavutil/pixfmt.h" + +#include "codec_id.h" + +/** + * @addtogroup lavc_core + */ + +enum AVFieldOrder { + AV_FIELD_UNKNOWN, + AV_FIELD_PROGRESSIVE, + AV_FIELD_TT, //< Top coded_first, top displayed first + AV_FIELD_BB, //< Bottom coded first, bottom displayed first + AV_FIELD_TB, //< Top coded first, bottom displayed first + AV_FIELD_BT, //< Bottom coded first, top displayed first +}; + +/** + * This struct describes the properties of an encoded stream. + * + * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must + * be allocated with avcodec_parameters_alloc() and freed with + * avcodec_parameters_free(). + */ +typedef struct AVCodecParameters { + /** + * General type of the encoded data. + */ + enum AVMediaType codec_type; + /** + * Specific type of the encoded data (the codec used). + */ + enum AVCodecID codec_id; + /** + * Additional information about the codec (corresponds to the AVI FOURCC). + */ + uint32_t codec_tag; + + /** + * Extra binary data needed for initializing the decoder, codec-dependent. + * + * Must be allocated with av_malloc() and will be freed by + * avcodec_parameters_free(). The allocated size of extradata must be at + * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding + * bytes zeroed. + */ + uint8_t *extradata; + /** + * Size of the extradata content in bytes. + */ + int extradata_size; + + /** + * - video: the pixel format, the value corresponds to enum AVPixelFormat. + * - audio: the sample format, the value corresponds to enum AVSampleFormat. + */ + int format; + + /** + * The average bitrate of the encoded data (in bits per second). + */ + int64_t bit_rate; + + /** + * The number of bits per sample in the codedwords. + * + * This is basically the bitrate per sample. It is mandatory for a bunch of + * formats to actually decode them. It's the number of bits for one sample in + * the actual coded bitstream. + * + * This could be for example 4 for ADPCM + * For PCM formats this matches bits_per_raw_sample + * Can be 0 + */ + int bits_per_coded_sample; + + /** + * This is the number of valid bits in each output sample. If the + * sample format has more bits, the least significant bits are additional + * padding bits, which are always 0. Use right shifts to reduce the sample + * to its actual size. For example, audio formats with 24 bit samples will + * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32. + * To get the original sample use "(int32_t)sample >> 8"." + * + * For ADPCM this might be 12 or 16 or similar + * Can be 0 + */ + int bits_per_raw_sample; + + /** + * Codec-specific bitstream restrictions that the stream conforms to. + */ + int profile; + int level; + + /** + * Video only. The dimensions of the video frame in pixels. + */ + int width; + int height; + + /** + * Video only. The aspect ratio (width / height) which a single pixel + * should have when displayed. + * + * When the aspect ratio is unknown / undefined, the numerator should be + * set to 0 (the denominator may have any value). + */ + AVRational sample_aspect_ratio; + + /** + * Video only. The order of the fields in interlaced video. + */ + enum AVFieldOrder field_order; + + /** + * Video only. Additional colorspace characteristics. + */ + enum AVColorRange color_range; + enum AVColorPrimaries color_primaries; + enum AVColorTransferCharacteristic color_trc; + enum AVColorSpace color_space; + enum AVChromaLocation chroma_location; + + /** + * Video only. Number of delayed frames. + */ + int video_delay; + + /** + * Audio only. The channel layout bitmask. May be 0 if the channel layout is + * unknown or unspecified, otherwise the number of bits set must be equal to + * the channels field. + */ + uint64_t channel_layout; + /** + * Audio only. The number of audio channels. + */ + int channels; + /** + * Audio only. The number of audio samples per second. + */ + int sample_rate; + /** + * Audio only. The number of bytes per coded audio frame, required by some + * formats. + * + * Corresponds to nBlockAlign in WAVEFORMATEX. + */ + int block_align; + /** + * Audio only. Audio frame size, if known. Required by some formats to be static. + */ + int frame_size; + + /** + * Audio only. The amount of padding (in samples) inserted by the encoder at + * the beginning of the audio. I.e. this number of leading decoded samples + * must be discarded by the caller to get the original audio without leading + * padding. + */ + int initial_padding; + /** + * Audio only. The amount of padding (in samples) appended by the encoder to + * the end of the audio. I.e. this number of decoded samples must be + * discarded by the caller from the end of the stream to get the original + * audio without any trailing padding. + */ + int trailing_padding; + /** + * Audio only. Number of samples to skip after a discontinuity. + */ + int seek_preroll; +} AVCodecParameters; + +/** + * Allocate a new AVCodecParameters and set its fields to default values + * (unknown/invalid/0). The returned struct must be freed with + * avcodec_parameters_free(). + */ +AVCodecParameters *avcodec_parameters_alloc(void); + +/** + * Free an AVCodecParameters instance and everything associated with it and + * write NULL to the supplied pointer. + */ +void avcodec_parameters_free(AVCodecParameters **par); + +/** + * Copy the contents of src to dst. Any allocated fields in dst are freed and + * replaced with newly allocated duplicates of the corresponding fields in src. + * + * @return >= 0 on success, a negative AVERROR code on failure. + */ +int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src); + + +/** + * @} + */ + +#endif // AVCODEC_CODEC_PAR_H diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/d3d11va.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/d3d11va.h new file mode 100644 index 0000000..6816b6c --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/d3d11va.h @@ -0,0 +1,112 @@ +/* + * Direct3D11 HW acceleration + * + * copyright (c) 2009 Laurent Aimar + * copyright (c) 2015 Steve Lhomme + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_D3D11VA_H +#define AVCODEC_D3D11VA_H + +/** + * @file + * @ingroup lavc_codec_hwaccel_d3d11va + * Public libavcodec D3D11VA header. + */ + +#if !defined(_WIN32_WINNT) || _WIN32_WINNT < 0x0602 +#undef _WIN32_WINNT +#define _WIN32_WINNT 0x0602 +#endif + +#include +#include + +/** + * @defgroup lavc_codec_hwaccel_d3d11va Direct3D11 + * @ingroup lavc_codec_hwaccel + * + * @{ + */ + +#define FF_DXVA2_WORKAROUND_SCALING_LIST_ZIGZAG 1 ///< Work around for Direct3D11 and old UVD/UVD+ ATI video cards +#define FF_DXVA2_WORKAROUND_INTEL_CLEARVIDEO 2 ///< Work around for Direct3D11 and old Intel GPUs with ClearVideo interface + +/** + * This structure is used to provides the necessary configurations and data + * to the Direct3D11 FFmpeg HWAccel implementation. + * + * The application must make it available as AVCodecContext.hwaccel_context. + * + * Use av_d3d11va_alloc_context() exclusively to allocate an AVD3D11VAContext. + */ +typedef struct AVD3D11VAContext { + /** + * D3D11 decoder object + */ + ID3D11VideoDecoder *decoder; + + /** + * D3D11 VideoContext + */ + ID3D11VideoContext *video_context; + + /** + * D3D11 configuration used to create the decoder + */ + D3D11_VIDEO_DECODER_CONFIG *cfg; + + /** + * The number of surface in the surface array + */ + unsigned surface_count; + + /** + * The array of Direct3D surfaces used to create the decoder + */ + ID3D11VideoDecoderOutputView **surface; + + /** + * A bit field configuring the workarounds needed for using the decoder + */ + uint64_t workaround; + + /** + * Private to the FFmpeg AVHWAccel implementation + */ + unsigned report_id; + + /** + * Mutex to access video_context + */ + HANDLE context_mutex; +} AVD3D11VAContext; + +/** + * Allocate an AVD3D11VAContext. + * + * @return Newly-allocated AVD3D11VAContext or NULL on failure. + */ +AVD3D11VAContext *av_d3d11va_alloc_context(void); + +/** + * @} + */ + +#endif /* AVCODEC_D3D11VA_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/dirac.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/dirac.h new file mode 100644 index 0000000..e6d9d34 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/dirac.h @@ -0,0 +1,131 @@ +/* + * Copyright (C) 2007 Marco Gerards + * Copyright (C) 2009 David Conrad + * Copyright (C) 2011 Jordi Ortiz + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_DIRAC_H +#define AVCODEC_DIRAC_H + +/** + * @file + * Interface to Dirac Decoder/Encoder + * @author Marco Gerards + * @author David Conrad + * @author Jordi Ortiz + */ + +#include "avcodec.h" + +/** + * The spec limits the number of wavelet decompositions to 4 for both + * level 1 (VC-2) and 128 (long-gop default). + * 5 decompositions is the maximum before >16-bit buffers are needed. + * Schroedinger allows this for DD 9,7 and 13,7 wavelets only, limiting + * the others to 4 decompositions (or 3 for the fidelity filter). + * + * We use this instead of MAX_DECOMPOSITIONS to save some memory. + */ +#define MAX_DWT_LEVELS 5 + +/** + * Parse code values: + * + * Dirac Specification -> + * 9.6.1 Table 9.1 + * + * VC-2 Specification -> + * 10.4.1 Table 10.1 + */ + +enum DiracParseCodes { + DIRAC_PCODE_SEQ_HEADER = 0x00, + DIRAC_PCODE_END_SEQ = 0x10, + DIRAC_PCODE_AUX = 0x20, + DIRAC_PCODE_PAD = 0x30, + DIRAC_PCODE_PICTURE_CODED = 0x08, + DIRAC_PCODE_PICTURE_RAW = 0x48, + DIRAC_PCODE_PICTURE_LOW_DEL = 0xC8, + DIRAC_PCODE_PICTURE_HQ = 0xE8, + DIRAC_PCODE_INTER_NOREF_CO1 = 0x0A, + DIRAC_PCODE_INTER_NOREF_CO2 = 0x09, + DIRAC_PCODE_INTER_REF_CO1 = 0x0D, + DIRAC_PCODE_INTER_REF_CO2 = 0x0E, + DIRAC_PCODE_INTRA_REF_CO = 0x0C, + DIRAC_PCODE_INTRA_REF_RAW = 0x4C, + DIRAC_PCODE_INTRA_REF_PICT = 0xCC, + DIRAC_PCODE_MAGIC = 0x42424344, +}; + +typedef struct DiracVersionInfo { + int major; + int minor; +} DiracVersionInfo; + +typedef struct AVDiracSeqHeader { + unsigned width; + unsigned height; + uint8_t chroma_format; ///< 0: 444 1: 422 2: 420 + + uint8_t interlaced; + uint8_t top_field_first; + + uint8_t frame_rate_index; ///< index into dirac_frame_rate[] + uint8_t aspect_ratio_index; ///< index into dirac_aspect_ratio[] + + uint16_t clean_width; + uint16_t clean_height; + uint16_t clean_left_offset; + uint16_t clean_right_offset; + + uint8_t pixel_range_index; ///< index into dirac_pixel_range_presets[] + uint8_t color_spec_index; ///< index into dirac_color_spec_presets[] + + int profile; + int level; + + AVRational framerate; + AVRational sample_aspect_ratio; + + enum AVPixelFormat pix_fmt; + enum AVColorRange color_range; + enum AVColorPrimaries color_primaries; + enum AVColorTransferCharacteristic color_trc; + enum AVColorSpace colorspace; + + DiracVersionInfo version; + int bit_depth; +} AVDiracSeqHeader; + +/** + * Parse a Dirac sequence header. + * + * @param dsh this function will allocate and fill an AVDiracSeqHeader struct + * and write it into this pointer. The caller must free it with + * av_free(). + * @param buf the data buffer + * @param buf_size the size of the data buffer in bytes + * @param log_ctx if non-NULL, this function will log errors here + * @return 0 on success, a negative AVERROR code on failure + */ +int av_dirac_parse_sequence_header(AVDiracSeqHeader **dsh, + const uint8_t *buf, size_t buf_size, + void *log_ctx); + +#endif /* AVCODEC_DIRAC_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/dv_profile.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/dv_profile.h new file mode 100644 index 0000000..9380a66 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/dv_profile.h @@ -0,0 +1,83 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_DV_PROFILE_H +#define AVCODEC_DV_PROFILE_H + +#include + +#include "libavutil/pixfmt.h" +#include "libavutil/rational.h" +#include "avcodec.h" + +/* minimum number of bytes to read from a DV stream in order to + * determine the profile */ +#define DV_PROFILE_BYTES (6 * 80) /* 6 DIF blocks */ + + +/* + * AVDVProfile is used to express the differences between various + * DV flavors. For now it's primarily used for differentiating + * 525/60 and 625/50, but the plans are to use it for various + * DV specs as well (e.g. SMPTE314M vs. IEC 61834). + */ +typedef struct AVDVProfile { + int dsf; /* value of the dsf in the DV header */ + int video_stype; /* stype for VAUX source pack */ + int frame_size; /* total size of one frame in bytes */ + int difseg_size; /* number of DIF segments per DIF channel */ + int n_difchan; /* number of DIF channels per frame */ + AVRational time_base; /* 1/framerate */ + int ltc_divisor; /* FPS from the LTS standpoint */ + int height; /* picture height in pixels */ + int width; /* picture width in pixels */ + AVRational sar[2]; /* sample aspect ratios for 4:3 and 16:9 */ + enum AVPixelFormat pix_fmt; /* picture pixel format */ + int bpm; /* blocks per macroblock */ + const uint8_t *block_sizes; /* AC block sizes, in bits */ + int audio_stride; /* size of audio_shuffle table */ + int audio_min_samples[3]; /* min amount of audio samples */ + /* for 48kHz, 44.1kHz and 32kHz */ + int audio_samples_dist[5]; /* how many samples are supposed to be */ + /* in each frame in a 5 frames window */ + const uint8_t (*audio_shuffle)[9]; /* PCM shuffling table */ +} AVDVProfile; + +/** + * Get a DV profile for the provided compressed frame. + * + * @param sys the profile used for the previous frame, may be NULL + * @param frame the compressed data buffer + * @param buf_size size of the buffer in bytes + * @return the DV profile for the supplied data or NULL on failure + */ +const AVDVProfile *av_dv_frame_profile(const AVDVProfile *sys, + const uint8_t *frame, unsigned buf_size); + +/** + * Get a DV profile for the provided stream parameters. + */ +const AVDVProfile *av_dv_codec_profile(int width, int height, enum AVPixelFormat pix_fmt); + +/** + * Get a DV profile for the provided stream parameters. + * The frame rate is used as a best-effort parameter. + */ +const AVDVProfile *av_dv_codec_profile2(int width, int height, enum AVPixelFormat pix_fmt, AVRational frame_rate); + +#endif /* AVCODEC_DV_PROFILE_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/dxva2.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/dxva2.h new file mode 100644 index 0000000..22c9399 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/dxva2.h @@ -0,0 +1,93 @@ +/* + * DXVA2 HW acceleration + * + * copyright (c) 2009 Laurent Aimar + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_DXVA2_H +#define AVCODEC_DXVA2_H + +/** + * @file + * @ingroup lavc_codec_hwaccel_dxva2 + * Public libavcodec DXVA2 header. + */ + +#if !defined(_WIN32_WINNT) || _WIN32_WINNT < 0x0602 +#undef _WIN32_WINNT +#define _WIN32_WINNT 0x0602 +#endif + +#include +#include +#include + +/** + * @defgroup lavc_codec_hwaccel_dxva2 DXVA2 + * @ingroup lavc_codec_hwaccel + * + * @{ + */ + +#define FF_DXVA2_WORKAROUND_SCALING_LIST_ZIGZAG 1 ///< Work around for DXVA2 and old UVD/UVD+ ATI video cards +#define FF_DXVA2_WORKAROUND_INTEL_CLEARVIDEO 2 ///< Work around for DXVA2 and old Intel GPUs with ClearVideo interface + +/** + * This structure is used to provides the necessary configurations and data + * to the DXVA2 FFmpeg HWAccel implementation. + * + * The application must make it available as AVCodecContext.hwaccel_context. + */ +struct dxva_context { + /** + * DXVA2 decoder object + */ + IDirectXVideoDecoder *decoder; + + /** + * DXVA2 configuration used to create the decoder + */ + const DXVA2_ConfigPictureDecode *cfg; + + /** + * The number of surface in the surface array + */ + unsigned surface_count; + + /** + * The array of Direct3D surfaces used to create the decoder + */ + LPDIRECT3DSURFACE9 *surface; + + /** + * A bit field configuring the workarounds needed for using the decoder + */ + uint64_t workaround; + + /** + * Private to the FFmpeg AVHWAccel implementation + */ + unsigned report_id; +}; + +/** + * @} + */ + +#endif /* AVCODEC_DXVA2_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/jni.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/jni.h new file mode 100644 index 0000000..dd99e92 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/jni.h @@ -0,0 +1,46 @@ +/* + * JNI public API functions + * + * Copyright (c) 2015-2016 Matthieu Bouron + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_JNI_H +#define AVCODEC_JNI_H + +/* + * Manually set a Java virtual machine which will be used to retrieve the JNI + * environment. Once a Java VM is set it cannot be changed afterwards, meaning + * you can call multiple times av_jni_set_java_vm with the same Java VM pointer + * however it will error out if you try to set a different Java VM. + * + * @param vm Java virtual machine + * @param log_ctx context used for logging, can be NULL + * @return 0 on success, < 0 otherwise + */ +int av_jni_set_java_vm(void *vm, void *log_ctx); + +/* + * Get the Java virtual machine which has been set with av_jni_set_java_vm. + * + * @param vm Java virtual machine + * @return a pointer to the Java virtual machine + */ +void *av_jni_get_java_vm(void *log_ctx); + +#endif /* AVCODEC_JNI_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/mediacodec.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/mediacodec.h new file mode 100644 index 0000000..4c8545d --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/mediacodec.h @@ -0,0 +1,101 @@ +/* + * Android MediaCodec public API + * + * Copyright (c) 2016 Matthieu Bouron + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_MEDIACODEC_H +#define AVCODEC_MEDIACODEC_H + +#include "libavcodec/avcodec.h" + +/** + * This structure holds a reference to a android/view/Surface object that will + * be used as output by the decoder. + * + */ +typedef struct AVMediaCodecContext { + + /** + * android/view/Surface object reference. + */ + void *surface; + +} AVMediaCodecContext; + +/** + * Allocate and initialize a MediaCodec context. + * + * When decoding with MediaCodec is finished, the caller must free the + * MediaCodec context with av_mediacodec_default_free. + * + * @return a pointer to a newly allocated AVMediaCodecContext on success, NULL otherwise + */ +AVMediaCodecContext *av_mediacodec_alloc_context(void); + +/** + * Convenience function that sets up the MediaCodec context. + * + * @param avctx codec context + * @param ctx MediaCodec context to initialize + * @param surface reference to an android/view/Surface + * @return 0 on success, < 0 otherwise + */ +int av_mediacodec_default_init(AVCodecContext *avctx, AVMediaCodecContext *ctx, void *surface); + +/** + * This function must be called to free the MediaCodec context initialized with + * av_mediacodec_default_init(). + * + * @param avctx codec context + */ +void av_mediacodec_default_free(AVCodecContext *avctx); + +/** + * Opaque structure representing a MediaCodec buffer to render. + */ +typedef struct MediaCodecBuffer AVMediaCodecBuffer; + +/** + * Release a MediaCodec buffer and render it to the surface that is associated + * with the decoder. This function should only be called once on a given + * buffer, once released the underlying buffer returns to the codec, thus + * subsequent calls to this function will have no effect. + * + * @param buffer the buffer to render + * @param render 1 to release and render the buffer to the surface or 0 to + * discard the buffer + * @return 0 on success, < 0 otherwise + */ +int av_mediacodec_release_buffer(AVMediaCodecBuffer *buffer, int render); + +/** + * Release a MediaCodec buffer and render it at the given time to the surface + * that is associated with the decoder. The timestamp must be within one second + * of the current java/lang/System#nanoTime() (which is implemented using + * CLOCK_MONOTONIC on Android). See the Android MediaCodec documentation + * of android/media/MediaCodec#releaseOutputBuffer(int,long) for more details. + * + * @param buffer the buffer to render + * @param time timestamp in nanoseconds of when to render the buffer + * @return 0 on success, < 0 otherwise + */ +int av_mediacodec_render_buffer_at_time(AVMediaCodecBuffer *buffer, int64_t time); + +#endif /* AVCODEC_MEDIACODEC_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/packet.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/packet.h new file mode 100644 index 0000000..41485f4 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/packet.h @@ -0,0 +1,722 @@ +/* + * AVPacket public API + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_PACKET_H +#define AVCODEC_PACKET_H + +#include +#include + +#include "libavutil/attributes.h" +#include "libavutil/buffer.h" +#include "libavutil/dict.h" +#include "libavutil/rational.h" + +#include "libavcodec/version.h" + +/** + * @defgroup lavc_packet AVPacket + * + * Types and functions for working with AVPacket. + * @{ + */ +enum AVPacketSideDataType { + /** + * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE + * bytes worth of palette. This side data signals that a new palette is + * present. + */ + AV_PKT_DATA_PALETTE, + + /** + * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format + * that the extradata buffer was changed and the receiving side should + * act upon it appropriately. The new extradata is embedded in the side + * data buffer and should be immediately used for processing the current + * frame or packet. + */ + AV_PKT_DATA_NEW_EXTRADATA, + + /** + * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows: + * @code + * u32le param_flags + * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT) + * s32le channel_count + * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT) + * u64le channel_layout + * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE) + * s32le sample_rate + * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS) + * s32le width + * s32le height + * @endcode + */ + AV_PKT_DATA_PARAM_CHANGE, + + /** + * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of + * structures with info about macroblocks relevant to splitting the + * packet into smaller packets on macroblock edges (e.g. as for RFC 2190). + * That is, it does not necessarily contain info about all macroblocks, + * as long as the distance between macroblocks in the info is smaller + * than the target payload size. + * Each MB info structure is 12 bytes, and is laid out as follows: + * @code + * u32le bit offset from the start of the packet + * u8 current quantizer at the start of the macroblock + * u8 GOB number + * u16le macroblock address within the GOB + * u8 horizontal MV predictor + * u8 vertical MV predictor + * u8 horizontal MV predictor for block number 3 + * u8 vertical MV predictor for block number 3 + * @endcode + */ + AV_PKT_DATA_H263_MB_INFO, + + /** + * This side data should be associated with an audio stream and contains + * ReplayGain information in form of the AVReplayGain struct. + */ + AV_PKT_DATA_REPLAYGAIN, + + /** + * This side data contains a 3x3 transformation matrix describing an affine + * transformation that needs to be applied to the decoded video frames for + * correct presentation. + * + * See libavutil/display.h for a detailed description of the data. + */ + AV_PKT_DATA_DISPLAYMATRIX, + + /** + * This side data should be associated with a video stream and contains + * Stereoscopic 3D information in form of the AVStereo3D struct. + */ + AV_PKT_DATA_STEREO3D, + + /** + * This side data should be associated with an audio stream and corresponds + * to enum AVAudioServiceType. + */ + AV_PKT_DATA_AUDIO_SERVICE_TYPE, + + /** + * This side data contains quality related information from the encoder. + * @code + * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad). + * u8 picture type + * u8 error count + * u16 reserved + * u64le[error count] sum of squared differences between encoder in and output + * @endcode + */ + AV_PKT_DATA_QUALITY_STATS, + + /** + * This side data contains an integer value representing the stream index + * of a "fallback" track. A fallback track indicates an alternate + * track to use when the current track can not be decoded for some reason. + * e.g. no decoder available for codec. + */ + AV_PKT_DATA_FALLBACK_TRACK, + + /** + * This side data corresponds to the AVCPBProperties struct. + */ + AV_PKT_DATA_CPB_PROPERTIES, + + /** + * Recommmends skipping the specified number of samples + * @code + * u32le number of samples to skip from start of this packet + * u32le number of samples to skip from end of this packet + * u8 reason for start skip + * u8 reason for end skip (0=padding silence, 1=convergence) + * @endcode + */ + AV_PKT_DATA_SKIP_SAMPLES, + + /** + * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that + * the packet may contain "dual mono" audio specific to Japanese DTV + * and if it is true, recommends only the selected channel to be used. + * @code + * u8 selected channels (0=mail/left, 1=sub/right, 2=both) + * @endcode + */ + AV_PKT_DATA_JP_DUALMONO, + + /** + * A list of zero terminated key/value strings. There is no end marker for + * the list, so it is required to rely on the side data size to stop. + */ + AV_PKT_DATA_STRINGS_METADATA, + + /** + * Subtitle event position + * @code + * u32le x1 + * u32le y1 + * u32le x2 + * u32le y2 + * @endcode + */ + AV_PKT_DATA_SUBTITLE_POSITION, + + /** + * Data found in BlockAdditional element of matroska container. There is + * no end marker for the data, so it is required to rely on the side data + * size to recognize the end. 8 byte id (as found in BlockAddId) followed + * by data. + */ + AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL, + + /** + * The optional first identifier line of a WebVTT cue. + */ + AV_PKT_DATA_WEBVTT_IDENTIFIER, + + /** + * The optional settings (rendering instructions) that immediately + * follow the timestamp specifier of a WebVTT cue. + */ + AV_PKT_DATA_WEBVTT_SETTINGS, + + /** + * A list of zero terminated key/value strings. There is no end marker for + * the list, so it is required to rely on the side data size to stop. This + * side data includes updated metadata which appeared in the stream. + */ + AV_PKT_DATA_METADATA_UPDATE, + + /** + * MPEGTS stream ID as uint8_t, this is required to pass the stream ID + * information from the demuxer to the corresponding muxer. + */ + AV_PKT_DATA_MPEGTS_STREAM_ID, + + /** + * Mastering display metadata (based on SMPTE-2086:2014). This metadata + * should be associated with a video stream and contains data in the form + * of the AVMasteringDisplayMetadata struct. + */ + AV_PKT_DATA_MASTERING_DISPLAY_METADATA, + + /** + * This side data should be associated with a video stream and corresponds + * to the AVSphericalMapping structure. + */ + AV_PKT_DATA_SPHERICAL, + + /** + * Content light level (based on CTA-861.3). This metadata should be + * associated with a video stream and contains data in the form of the + * AVContentLightMetadata struct. + */ + AV_PKT_DATA_CONTENT_LIGHT_LEVEL, + + /** + * ATSC A53 Part 4 Closed Captions. This metadata should be associated with + * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data. + * The number of bytes of CC data is AVPacketSideData.size. + */ + AV_PKT_DATA_A53_CC, + + /** + * This side data is encryption initialization data. + * The format is not part of ABI, use av_encryption_init_info_* methods to + * access. + */ + AV_PKT_DATA_ENCRYPTION_INIT_INFO, + + /** + * This side data contains encryption info for how to decrypt the packet. + * The format is not part of ABI, use av_encryption_info_* methods to access. + */ + AV_PKT_DATA_ENCRYPTION_INFO, + + /** + * Active Format Description data consisting of a single byte as specified + * in ETSI TS 101 154 using AVActiveFormatDescription enum. + */ + AV_PKT_DATA_AFD, + + /** + * Producer Reference Time data corresponding to the AVProducerReferenceTime struct, + * usually exported by some encoders (on demand through the prft flag set in the + * AVCodecContext export_side_data field). + */ + AV_PKT_DATA_PRFT, + + /** + * ICC profile data consisting of an opaque octet buffer following the + * format described by ISO 15076-1. + */ + AV_PKT_DATA_ICC_PROFILE, + + /** + * DOVI configuration + * ref: + * dolby-vision-bitstreams-within-the-iso-base-media-file-format-v2.1.2, section 2.2 + * dolby-vision-bitstreams-in-mpeg-2-transport-stream-multiplex-v1.2, section 3.3 + * Tags are stored in struct AVDOVIDecoderConfigurationRecord. + */ + AV_PKT_DATA_DOVI_CONF, + + /** + * The number of side data types. + * This is not part of the public API/ABI in the sense that it may + * change when new side data types are added. + * This must stay the last enum value. + * If its value becomes huge, some code using it + * needs to be updated as it assumes it to be smaller than other limits. + */ + AV_PKT_DATA_NB +}; + +#define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED + +typedef struct AVPacketSideData { + uint8_t *data; + int size; + enum AVPacketSideDataType type; +} AVPacketSideData; + +/** + * This structure stores compressed data. It is typically exported by demuxers + * and then passed as input to decoders, or received as output from encoders and + * then passed to muxers. + * + * For video, it should typically contain one compressed frame. For audio it may + * contain several compressed frames. Encoders are allowed to output empty + * packets, with no compressed data, containing only side data + * (e.g. to update some stream parameters at the end of encoding). + * + * AVPacket is one of the few structs in FFmpeg, whose size is a part of public + * ABI. Thus it may be allocated on stack and no new fields can be added to it + * without libavcodec and libavformat major bump. + * + * The semantics of data ownership depends on the buf field. + * If it is set, the packet data is dynamically allocated and is + * valid indefinitely until a call to av_packet_unref() reduces the + * reference count to 0. + * + * If the buf field is not set av_packet_ref() would make a copy instead + * of increasing the reference count. + * + * The side data is always allocated with av_malloc(), copied by + * av_packet_ref() and freed by av_packet_unref(). + * + * @see av_packet_ref + * @see av_packet_unref + */ +typedef struct AVPacket { + /** + * A reference to the reference-counted buffer where the packet data is + * stored. + * May be NULL, then the packet data is not reference-counted. + */ + AVBufferRef *buf; + /** + * Presentation timestamp in AVStream->time_base units; the time at which + * the decompressed packet will be presented to the user. + * Can be AV_NOPTS_VALUE if it is not stored in the file. + * pts MUST be larger or equal to dts as presentation cannot happen before + * decompression, unless one wants to view hex dumps. Some formats misuse + * the terms dts and pts/cts to mean something different. Such timestamps + * must be converted to true pts/dts before they are stored in AVPacket. + */ + int64_t pts; + /** + * Decompression timestamp in AVStream->time_base units; the time at which + * the packet is decompressed. + * Can be AV_NOPTS_VALUE if it is not stored in the file. + */ + int64_t dts; + uint8_t *data; + int size; + int stream_index; + /** + * A combination of AV_PKT_FLAG values + */ + int flags; + /** + * Additional packet data that can be provided by the container. + * Packet can contain several types of side information. + */ + AVPacketSideData *side_data; + int side_data_elems; + + /** + * Duration of this packet in AVStream->time_base units, 0 if unknown. + * Equals next_pts - this_pts in presentation order. + */ + int64_t duration; + + int64_t pos; ///< byte position in stream, -1 if unknown + +#if FF_API_CONVERGENCE_DURATION + /** + * @deprecated Same as the duration field, but as int64_t. This was required + * for Matroska subtitles, whose duration values could overflow when the + * duration field was still an int. + */ + attribute_deprecated + int64_t convergence_duration; +#endif +} AVPacket; + +#define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe +#define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted +/** + * Flag is used to discard packets which are required to maintain valid + * decoder state but are not required for output and should be dropped + * after decoding. + **/ +#define AV_PKT_FLAG_DISCARD 0x0004 +/** + * The packet comes from a trusted source. + * + * Otherwise-unsafe constructs such as arbitrary pointers to data + * outside the packet may be followed. + */ +#define AV_PKT_FLAG_TRUSTED 0x0008 +/** + * Flag is used to indicate packets that contain frames that can + * be discarded by the decoder. I.e. Non-reference frames. + */ +#define AV_PKT_FLAG_DISPOSABLE 0x0010 + +enum AVSideDataParamChangeFlags { + AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001, + AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002, + AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004, + AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008, +}; + +/** + * Allocate an AVPacket and set its fields to default values. The resulting + * struct must be freed using av_packet_free(). + * + * @return An AVPacket filled with default values or NULL on failure. + * + * @note this only allocates the AVPacket itself, not the data buffers. Those + * must be allocated through other means such as av_new_packet. + * + * @see av_new_packet + */ +AVPacket *av_packet_alloc(void); + +/** + * Create a new packet that references the same data as src. + * + * This is a shortcut for av_packet_alloc()+av_packet_ref(). + * + * @return newly created AVPacket on success, NULL on error. + * + * @see av_packet_alloc + * @see av_packet_ref + */ +AVPacket *av_packet_clone(const AVPacket *src); + +/** + * Free the packet, if the packet is reference counted, it will be + * unreferenced first. + * + * @param pkt packet to be freed. The pointer will be set to NULL. + * @note passing NULL is a no-op. + */ +void av_packet_free(AVPacket **pkt); + +/** + * Initialize optional fields of a packet with default values. + * + * Note, this does not touch the data and size members, which have to be + * initialized separately. + * + * @param pkt packet + */ +void av_init_packet(AVPacket *pkt); + +/** + * Allocate the payload of a packet and initialize its fields with + * default values. + * + * @param pkt packet + * @param size wanted payload size + * @return 0 if OK, AVERROR_xxx otherwise + */ +int av_new_packet(AVPacket *pkt, int size); + +/** + * Reduce packet size, correctly zeroing padding + * + * @param pkt packet + * @param size new size + */ +void av_shrink_packet(AVPacket *pkt, int size); + +/** + * Increase packet size, correctly zeroing padding + * + * @param pkt packet + * @param grow_by number of bytes by which to increase the size of the packet + */ +int av_grow_packet(AVPacket *pkt, int grow_by); + +/** + * Initialize a reference-counted packet from av_malloc()ed data. + * + * @param pkt packet to be initialized. This function will set the data, size, + * and buf fields, all others are left untouched. + * @param data Data allocated by av_malloc() to be used as packet data. If this + * function returns successfully, the data is owned by the underlying AVBuffer. + * The caller may not access the data through other means. + * @param size size of data in bytes, without the padding. I.e. the full buffer + * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE. + * + * @return 0 on success, a negative AVERROR on error + */ +int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size); + +#if FF_API_AVPACKET_OLD_API +/** + * @warning This is a hack - the packet memory allocation stuff is broken. The + * packet is allocated if it was not really allocated. + * + * @deprecated Use av_packet_ref or av_packet_make_refcounted + */ +attribute_deprecated +int av_dup_packet(AVPacket *pkt); +/** + * Copy packet, including contents + * + * @return 0 on success, negative AVERROR on fail + * + * @deprecated Use av_packet_ref + */ +attribute_deprecated +int av_copy_packet(AVPacket *dst, const AVPacket *src); + +/** + * Copy packet side data + * + * @return 0 on success, negative AVERROR on fail + * + * @deprecated Use av_packet_copy_props + */ +attribute_deprecated +int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src); + +/** + * Free a packet. + * + * @deprecated Use av_packet_unref + * + * @param pkt packet to free + */ +attribute_deprecated +void av_free_packet(AVPacket *pkt); +#endif +/** + * Allocate new information of a packet. + * + * @param pkt packet + * @param type side information type + * @param size side information size + * @return pointer to fresh allocated data or NULL otherwise + */ +uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type, + int size); + +/** + * Wrap an existing array as a packet side data. + * + * @param pkt packet + * @param type side information type + * @param data the side data array. It must be allocated with the av_malloc() + * family of functions. The ownership of the data is transferred to + * pkt. + * @param size side information size + * @return a non-negative number on success, a negative AVERROR code on + * failure. On failure, the packet is unchanged and the data remains + * owned by the caller. + */ +int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type, + uint8_t *data, size_t size); + +/** + * Shrink the already allocated side data buffer + * + * @param pkt packet + * @param type side information type + * @param size new side information size + * @return 0 on success, < 0 on failure + */ +int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type, + int size); + +/** + * Get side information from packet. + * + * @param pkt packet + * @param type desired side information type + * @param size pointer for side information size to store (optional) + * @return pointer to data if present or NULL otherwise + */ +uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type, + int *size); + +#if FF_API_MERGE_SD_API +attribute_deprecated +int av_packet_merge_side_data(AVPacket *pkt); + +attribute_deprecated +int av_packet_split_side_data(AVPacket *pkt); +#endif + +const char *av_packet_side_data_name(enum AVPacketSideDataType type); + +/** + * Pack a dictionary for use in side_data. + * + * @param dict The dictionary to pack. + * @param size pointer to store the size of the returned data + * @return pointer to data if successful, NULL otherwise + */ +uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size); +/** + * Unpack a dictionary from side_data. + * + * @param data data from side_data + * @param size size of the data + * @param dict the metadata storage dictionary + * @return 0 on success, < 0 on failure + */ +int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict); + + +/** + * Convenience function to free all the side data stored. + * All the other fields stay untouched. + * + * @param pkt packet + */ +void av_packet_free_side_data(AVPacket *pkt); + +/** + * Setup a new reference to the data described by a given packet + * + * If src is reference-counted, setup dst as a new reference to the + * buffer in src. Otherwise allocate a new buffer in dst and copy the + * data from src into it. + * + * All the other fields are copied from src. + * + * @see av_packet_unref + * + * @param dst Destination packet. Will be completely overwritten. + * @param src Source packet + * + * @return 0 on success, a negative AVERROR on error. On error, dst + * will be blank (as if returned by av_packet_alloc()). + */ +int av_packet_ref(AVPacket *dst, const AVPacket *src); + +/** + * Wipe the packet. + * + * Unreference the buffer referenced by the packet and reset the + * remaining packet fields to their default values. + * + * @param pkt The packet to be unreferenced. + */ +void av_packet_unref(AVPacket *pkt); + +/** + * Move every field in src to dst and reset src. + * + * @see av_packet_unref + * + * @param src Source packet, will be reset + * @param dst Destination packet + */ +void av_packet_move_ref(AVPacket *dst, AVPacket *src); + +/** + * Copy only "properties" fields from src to dst. + * + * Properties for the purpose of this function are all the fields + * beside those related to the packet data (buf, data, size) + * + * @param dst Destination packet + * @param src Source packet + * + * @return 0 on success AVERROR on failure. + */ +int av_packet_copy_props(AVPacket *dst, const AVPacket *src); + +/** + * Ensure the data described by a given packet is reference counted. + * + * @note This function does not ensure that the reference will be writable. + * Use av_packet_make_writable instead for that purpose. + * + * @see av_packet_ref + * @see av_packet_make_writable + * + * @param pkt packet whose data should be made reference counted. + * + * @return 0 on success, a negative AVERROR on error. On failure, the + * packet is unchanged. + */ +int av_packet_make_refcounted(AVPacket *pkt); + +/** + * Create a writable reference for the data described by a given packet, + * avoiding data copy if possible. + * + * @param pkt Packet whose data should be made writable. + * + * @return 0 on success, a negative AVERROR on failure. On failure, the + * packet is unchanged. + */ +int av_packet_make_writable(AVPacket *pkt); + +/** + * Convert valid timing fields (timestamps / durations) in a packet from one + * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be + * ignored. + * + * @param pkt packet on which the conversion will be performed + * @param tb_src source timebase, in which the timing fields in pkt are + * expressed + * @param tb_dst destination timebase, to which the timing fields will be + * converted + */ +void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst); + +/** + * @} + */ + +#endif // AVCODEC_PACKET_H diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/qsv.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/qsv.h new file mode 100644 index 0000000..b77158e --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/qsv.h @@ -0,0 +1,107 @@ +/* + * Intel MediaSDK QSV public API + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_QSV_H +#define AVCODEC_QSV_H + +#include + +#include "libavutil/buffer.h" + +/** + * This struct is used for communicating QSV parameters between libavcodec and + * the caller. It is managed by the caller and must be assigned to + * AVCodecContext.hwaccel_context. + * - decoding: hwaccel_context must be set on return from the get_format() + * callback + * - encoding: hwaccel_context must be set before avcodec_open2() + */ +typedef struct AVQSVContext { + /** + * If non-NULL, the session to use for encoding or decoding. + * Otherwise, libavcodec will try to create an internal session. + */ + mfxSession session; + + /** + * The IO pattern to use. + */ + int iopattern; + + /** + * Extra buffers to pass to encoder or decoder initialization. + */ + mfxExtBuffer **ext_buffers; + int nb_ext_buffers; + + /** + * Encoding only. If this field is set to non-zero by the caller, libavcodec + * will create an mfxExtOpaqueSurfaceAlloc extended buffer and pass it to + * the encoder initialization. This only makes sense if iopattern is also + * set to MFX_IOPATTERN_IN_OPAQUE_MEMORY. + * + * The number of allocated opaque surfaces will be the sum of the number + * required by the encoder and the user-provided value nb_opaque_surfaces. + * The array of the opaque surfaces will be exported to the caller through + * the opaque_surfaces field. + */ + int opaque_alloc; + + /** + * Encoding only, and only if opaque_alloc is set to non-zero. Before + * calling avcodec_open2(), the caller should set this field to the number + * of extra opaque surfaces to allocate beyond what is required by the + * encoder. + * + * On return from avcodec_open2(), this field will be set by libavcodec to + * the total number of allocated opaque surfaces. + */ + int nb_opaque_surfaces; + + /** + * Encoding only, and only if opaque_alloc is set to non-zero. On return + * from avcodec_open2(), this field will be used by libavcodec to export the + * array of the allocated opaque surfaces to the caller, so they can be + * passed to other parts of the pipeline. + * + * The buffer reference exported here is owned and managed by libavcodec, + * the callers should make their own reference with av_buffer_ref() and free + * it with av_buffer_unref() when it is no longer needed. + * + * The buffer data is an nb_opaque_surfaces-sized array of mfxFrameSurface1. + */ + AVBufferRef *opaque_surfaces; + + /** + * Encoding only, and only if opaque_alloc is set to non-zero. On return + * from avcodec_open2(), this field will be set to the surface type used in + * the opaque allocation request. + */ + int opaque_alloc_type; +} AVQSVContext; + +/** + * Allocate a new context. + * + * It must be freed by the caller with av_free(). + */ +AVQSVContext *av_qsv_alloc_context(void); + +#endif /* AVCODEC_QSV_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/vaapi.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/vaapi.h new file mode 100644 index 0000000..2cf7da5 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/vaapi.h @@ -0,0 +1,86 @@ +/* + * Video Acceleration API (shared data between FFmpeg and the video player) + * HW decode acceleration for MPEG-2, MPEG-4, H.264 and VC-1 + * + * Copyright (C) 2008-2009 Splitted-Desktop Systems + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_VAAPI_H +#define AVCODEC_VAAPI_H + +/** + * @file + * @ingroup lavc_codec_hwaccel_vaapi + * Public libavcodec VA API header. + */ + +#include +#include "libavutil/attributes.h" +#include "version.h" + +#if FF_API_STRUCT_VAAPI_CONTEXT + +/** + * @defgroup lavc_codec_hwaccel_vaapi VA API Decoding + * @ingroup lavc_codec_hwaccel + * @{ + */ + +/** + * This structure is used to share data between the FFmpeg library and + * the client video application. + * This shall be zero-allocated and available as + * AVCodecContext.hwaccel_context. All user members can be set once + * during initialization or through each AVCodecContext.get_buffer() + * function call. In any case, they must be valid prior to calling + * decoding functions. + * + * Deprecated: use AVCodecContext.hw_frames_ctx instead. + */ +struct attribute_deprecated vaapi_context { + /** + * Window system dependent data + * + * - encoding: unused + * - decoding: Set by user + */ + void *display; + + /** + * Configuration ID + * + * - encoding: unused + * - decoding: Set by user + */ + uint32_t config_id; + + /** + * Context ID (video decode pipeline) + * + * - encoding: unused + * - decoding: Set by user + */ + uint32_t context_id; +}; + +/* @} */ + +#endif /* FF_API_STRUCT_VAAPI_CONTEXT */ + +#endif /* AVCODEC_VAAPI_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/vdpau.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/vdpau.h new file mode 100644 index 0000000..4d99943 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/vdpau.h @@ -0,0 +1,176 @@ +/* + * The Video Decode and Presentation API for UNIX (VDPAU) is used for + * hardware-accelerated decoding of MPEG-1/2, H.264 and VC-1. + * + * Copyright (C) 2008 NVIDIA + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_VDPAU_H +#define AVCODEC_VDPAU_H + +/** + * @file + * @ingroup lavc_codec_hwaccel_vdpau + * Public libavcodec VDPAU header. + */ + + +/** + * @defgroup lavc_codec_hwaccel_vdpau VDPAU Decoder and Renderer + * @ingroup lavc_codec_hwaccel + * + * VDPAU hardware acceleration has two modules + * - VDPAU decoding + * - VDPAU presentation + * + * The VDPAU decoding module parses all headers using FFmpeg + * parsing mechanisms and uses VDPAU for the actual decoding. + * + * As per the current implementation, the actual decoding + * and rendering (API calls) are done as part of the VDPAU + * presentation (vo_vdpau.c) module. + * + * @{ + */ + +#include + +#include "libavutil/avconfig.h" +#include "libavutil/attributes.h" + +#include "avcodec.h" +#include "version.h" + +struct AVCodecContext; +struct AVFrame; + +typedef int (*AVVDPAU_Render2)(struct AVCodecContext *, struct AVFrame *, + const VdpPictureInfo *, uint32_t, + const VdpBitstreamBuffer *); + +/** + * This structure is used to share data between the libavcodec library and + * the client video application. + * The user shall allocate the structure via the av_alloc_vdpau_hwaccel + * function and make it available as + * AVCodecContext.hwaccel_context. Members can be set by the user once + * during initialization or through each AVCodecContext.get_buffer() + * function call. In any case, they must be valid prior to calling + * decoding functions. + * + * The size of this structure is not a part of the public ABI and must not + * be used outside of libavcodec. Use av_vdpau_alloc_context() to allocate an + * AVVDPAUContext. + */ +typedef struct AVVDPAUContext { + /** + * VDPAU decoder handle + * + * Set by user. + */ + VdpDecoder decoder; + + /** + * VDPAU decoder render callback + * + * Set by the user. + */ + VdpDecoderRender *render; + + AVVDPAU_Render2 render2; +} AVVDPAUContext; + +/** + * @brief allocation function for AVVDPAUContext + * + * Allows extending the struct without breaking API/ABI + */ +AVVDPAUContext *av_alloc_vdpaucontext(void); + +AVVDPAU_Render2 av_vdpau_hwaccel_get_render2(const AVVDPAUContext *); +void av_vdpau_hwaccel_set_render2(AVVDPAUContext *, AVVDPAU_Render2); + +/** + * Associate a VDPAU device with a codec context for hardware acceleration. + * This function is meant to be called from the get_format() codec callback, + * or earlier. It can also be called after avcodec_flush_buffers() to change + * the underlying VDPAU device mid-stream (e.g. to recover from non-transparent + * display preemption). + * + * @note get_format() must return AV_PIX_FMT_VDPAU if this function completes + * successfully. + * + * @param avctx decoding context whose get_format() callback is invoked + * @param device VDPAU device handle to use for hardware acceleration + * @param get_proc_address VDPAU device driver + * @param flags zero of more OR'd AV_HWACCEL_FLAG_* flags + * + * @return 0 on success, an AVERROR code on failure. + */ +int av_vdpau_bind_context(AVCodecContext *avctx, VdpDevice device, + VdpGetProcAddress *get_proc_address, unsigned flags); + +/** + * Gets the parameters to create an adequate VDPAU video surface for the codec + * context using VDPAU hardware decoding acceleration. + * + * @note Behavior is undefined if the context was not successfully bound to a + * VDPAU device using av_vdpau_bind_context(). + * + * @param avctx the codec context being used for decoding the stream + * @param type storage space for the VDPAU video surface chroma type + * (or NULL to ignore) + * @param width storage space for the VDPAU video surface pixel width + * (or NULL to ignore) + * @param height storage space for the VDPAU video surface pixel height + * (or NULL to ignore) + * + * @return 0 on success, a negative AVERROR code on failure. + */ +int av_vdpau_get_surface_parameters(AVCodecContext *avctx, VdpChromaType *type, + uint32_t *width, uint32_t *height); + +/** + * Allocate an AVVDPAUContext. + * + * @return Newly-allocated AVVDPAUContext or NULL on failure. + */ +AVVDPAUContext *av_vdpau_alloc_context(void); + +#if FF_API_VDPAU_PROFILE +/** + * Get a decoder profile that should be used for initializing a VDPAU decoder. + * Should be called from the AVCodecContext.get_format() callback. + * + * @deprecated Use av_vdpau_bind_context() instead. + * + * @param avctx the codec context being used for decoding the stream + * @param profile a pointer into which the result will be written on success. + * The contents of profile are undefined if this function returns + * an error. + * + * @return 0 on success (non-negative), a negative AVERROR on failure. + */ +attribute_deprecated +int av_vdpau_get_profile(AVCodecContext *avctx, VdpDecoderProfile *profile); +#endif + +/* @}*/ + +#endif /* AVCODEC_VDPAU_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/version.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/version.h new file mode 100644 index 0000000..85fbe24 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/version.h @@ -0,0 +1,149 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_VERSION_H +#define AVCODEC_VERSION_H + +/** + * @file + * @ingroup libavc + * Libavcodec version macros. + */ + +#include "libavutil/version.h" + +#define LIBAVCODEC_VERSION_MAJOR 58 +#define LIBAVCODEC_VERSION_MINOR 91 +#define LIBAVCODEC_VERSION_MICRO 100 + +#define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \ + LIBAVCODEC_VERSION_MINOR, \ + LIBAVCODEC_VERSION_MICRO) +#define LIBAVCODEC_VERSION AV_VERSION(LIBAVCODEC_VERSION_MAJOR, \ + LIBAVCODEC_VERSION_MINOR, \ + LIBAVCODEC_VERSION_MICRO) +#define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT + +#define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION) + +/** + * FF_API_* defines may be placed below to indicate public API that will be + * dropped at a future version bump. The defines themselves are not part of + * the public API and may change, break or disappear at any time. + * + * @note, when bumping the major version it is recommended to manually + * disable each FF_API_* in its own commit instead of disabling them all + * at once through the bump. This improves the git bisect-ability of the change. + */ + +#ifndef FF_API_LOWRES +#define FF_API_LOWRES (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_DEBUG_MV +#define FF_API_DEBUG_MV (LIBAVCODEC_VERSION_MAJOR < 58) +#endif +#ifndef FF_API_AVCTX_TIMEBASE +#define FF_API_AVCTX_TIMEBASE (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_CODED_FRAME +#define FF_API_CODED_FRAME (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_SIDEDATA_ONLY_PKT +#define FF_API_SIDEDATA_ONLY_PKT (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_VDPAU_PROFILE +#define FF_API_VDPAU_PROFILE (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_CONVERGENCE_DURATION +#define FF_API_CONVERGENCE_DURATION (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_AVPICTURE +#define FF_API_AVPICTURE (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_AVPACKET_OLD_API +#define FF_API_AVPACKET_OLD_API (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_RTP_CALLBACK +#define FF_API_RTP_CALLBACK (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_VBV_DELAY +#define FF_API_VBV_DELAY (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_CODER_TYPE +#define FF_API_CODER_TYPE (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_STAT_BITS +#define FF_API_STAT_BITS (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_PRIVATE_OPT +#define FF_API_PRIVATE_OPT (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_ASS_TIMING +#define FF_API_ASS_TIMING (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_OLD_BSF +#define FF_API_OLD_BSF (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_COPY_CONTEXT +#define FF_API_COPY_CONTEXT (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_GET_CONTEXT_DEFAULTS +#define FF_API_GET_CONTEXT_DEFAULTS (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_NVENC_OLD_NAME +#define FF_API_NVENC_OLD_NAME (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_STRUCT_VAAPI_CONTEXT +#define FF_API_STRUCT_VAAPI_CONTEXT (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_MERGE_SD_API +#define FF_API_MERGE_SD_API (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_TAG_STRING +#define FF_API_TAG_STRING (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_GETCHROMA +#define FF_API_GETCHROMA (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_CODEC_GET_SET +#define FF_API_CODEC_GET_SET (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_USER_VISIBLE_AVHWACCEL +#define FF_API_USER_VISIBLE_AVHWACCEL (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_LOCKMGR +#define FF_API_LOCKMGR (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_NEXT +#define FF_API_NEXT (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_UNSANITIZED_BITRATES +#define FF_API_UNSANITIZED_BITRATES (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_OPENH264_SLICE_MODE +#define FF_API_OPENH264_SLICE_MODE (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_OPENH264_CABAC +#define FF_API_OPENH264_CABAC (LIBAVCODEC_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_UNUSED_CODEC_CAPS +#define FF_API_UNUSED_CODEC_CAPS (LIBAVCODEC_VERSION_MAJOR < 59) +#endif + + +#endif /* AVCODEC_VERSION_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/videotoolbox.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/videotoolbox.h new file mode 100644 index 0000000..af2db0d --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/videotoolbox.h @@ -0,0 +1,127 @@ +/* + * Videotoolbox hardware acceleration + * + * copyright (c) 2012 Sebastien Zwickert + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_VIDEOTOOLBOX_H +#define AVCODEC_VIDEOTOOLBOX_H + +/** + * @file + * @ingroup lavc_codec_hwaccel_videotoolbox + * Public libavcodec Videotoolbox header. + */ + +#include + +#define Picture QuickdrawPicture +#include +#undef Picture + +#include "libavcodec/avcodec.h" + +/** + * This struct holds all the information that needs to be passed + * between the caller and libavcodec for initializing Videotoolbox decoding. + * Its size is not a part of the public ABI, it must be allocated with + * av_videotoolbox_alloc_context() and freed with av_free(). + */ +typedef struct AVVideotoolboxContext { + /** + * Videotoolbox decompression session object. + * Created and freed the caller. + */ + VTDecompressionSessionRef session; + + /** + * The output callback that must be passed to the session. + * Set by av_videottoolbox_default_init() + */ + VTDecompressionOutputCallback output_callback; + + /** + * CVPixelBuffer Format Type that Videotoolbox will use for decoded frames. + * set by the caller. If this is set to 0, then no specific format is + * requested from the decoder, and its native format is output. + */ + OSType cv_pix_fmt_type; + + /** + * CoreMedia Format Description that Videotoolbox will use to create the decompression session. + * Set by the caller. + */ + CMVideoFormatDescriptionRef cm_fmt_desc; + + /** + * CoreMedia codec type that Videotoolbox will use to create the decompression session. + * Set by the caller. + */ + int cm_codec_type; +} AVVideotoolboxContext; + +/** + * Allocate and initialize a Videotoolbox context. + * + * This function should be called from the get_format() callback when the caller + * selects the AV_PIX_FMT_VIDETOOLBOX format. The caller must then create + * the decoder object (using the output callback provided by libavcodec) that + * will be used for Videotoolbox-accelerated decoding. + * + * When decoding with Videotoolbox is finished, the caller must destroy the decoder + * object and free the Videotoolbox context using av_free(). + * + * @return the newly allocated context or NULL on failure + */ +AVVideotoolboxContext *av_videotoolbox_alloc_context(void); + +/** + * This is a convenience function that creates and sets up the Videotoolbox context using + * an internal implementation. + * + * @param avctx the corresponding codec context + * + * @return >= 0 on success, a negative AVERROR code on failure + */ +int av_videotoolbox_default_init(AVCodecContext *avctx); + +/** + * This is a convenience function that creates and sets up the Videotoolbox context using + * an internal implementation. + * + * @param avctx the corresponding codec context + * @param vtctx the Videotoolbox context to use + * + * @return >= 0 on success, a negative AVERROR code on failure + */ +int av_videotoolbox_default_init2(AVCodecContext *avctx, AVVideotoolboxContext *vtctx); + +/** + * This function must be called to free the Videotoolbox context initialized with + * av_videotoolbox_default_init(). + * + * @param avctx the corresponding codec context + */ +void av_videotoolbox_default_free(AVCodecContext *avctx); + +/** + * @} + */ + +#endif /* AVCODEC_VIDEOTOOLBOX_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/vorbis_parser.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/vorbis_parser.h new file mode 100644 index 0000000..789932a --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/vorbis_parser.h @@ -0,0 +1,74 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * A public API for Vorbis parsing + * + * Determines the duration for each packet. + */ + +#ifndef AVCODEC_VORBIS_PARSER_H +#define AVCODEC_VORBIS_PARSER_H + +#include + +typedef struct AVVorbisParseContext AVVorbisParseContext; + +/** + * Allocate and initialize the Vorbis parser using headers in the extradata. + */ +AVVorbisParseContext *av_vorbis_parse_init(const uint8_t *extradata, + int extradata_size); + +/** + * Free the parser and everything associated with it. + */ +void av_vorbis_parse_free(AVVorbisParseContext **s); + +#define VORBIS_FLAG_HEADER 0x00000001 +#define VORBIS_FLAG_COMMENT 0x00000002 +#define VORBIS_FLAG_SETUP 0x00000004 + +/** + * Get the duration for a Vorbis packet. + * + * If @p flags is @c NULL, + * special frames are considered invalid. + * + * @param s Vorbis parser context + * @param buf buffer containing a Vorbis frame + * @param buf_size size of the buffer + * @param flags flags for special frames + */ +int av_vorbis_parse_frame_flags(AVVorbisParseContext *s, const uint8_t *buf, + int buf_size, int *flags); + +/** + * Get the duration for a Vorbis packet. + * + * @param s Vorbis parser context + * @param buf buffer containing a Vorbis frame + * @param buf_size size of the buffer + */ +int av_vorbis_parse_frame(AVVorbisParseContext *s, const uint8_t *buf, + int buf_size); + +void av_vorbis_parse_reset(AVVorbisParseContext *s); + +#endif /* AVCODEC_VORBIS_PARSER_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/xvmc.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/xvmc.h new file mode 100644 index 0000000..465ee78 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavcodec/xvmc.h @@ -0,0 +1,170 @@ +/* + * Copyright (C) 2003 Ivan Kalvachev + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVCODEC_XVMC_H +#define AVCODEC_XVMC_H + +/** + * @file + * @ingroup lavc_codec_hwaccel_xvmc + * Public libavcodec XvMC header. + */ + +#include + +#include "libavutil/attributes.h" +#include "version.h" +#include "avcodec.h" + +/** + * @defgroup lavc_codec_hwaccel_xvmc XvMC + * @ingroup lavc_codec_hwaccel + * + * @{ + */ + +#define AV_XVMC_ID 0x1DC711C0 /**< special value to ensure that regular pixel routines haven't corrupted the struct + the number is 1337 speak for the letters IDCT MCo (motion compensation) */ + +struct attribute_deprecated xvmc_pix_fmt { + /** The field contains the special constant value AV_XVMC_ID. + It is used as a test that the application correctly uses the API, + and that there is no corruption caused by pixel routines. + - application - set during initialization + - libavcodec - unchanged + */ + int xvmc_id; + + /** Pointer to the block array allocated by XvMCCreateBlocks(). + The array has to be freed by XvMCDestroyBlocks(). + Each group of 64 values represents one data block of differential + pixel information (in MoCo mode) or coefficients for IDCT. + - application - set the pointer during initialization + - libavcodec - fills coefficients/pixel data into the array + */ + short* data_blocks; + + /** Pointer to the macroblock description array allocated by + XvMCCreateMacroBlocks() and freed by XvMCDestroyMacroBlocks(). + - application - set the pointer during initialization + - libavcodec - fills description data into the array + */ + XvMCMacroBlock* mv_blocks; + + /** Number of macroblock descriptions that can be stored in the mv_blocks + array. + - application - set during initialization + - libavcodec - unchanged + */ + int allocated_mv_blocks; + + /** Number of blocks that can be stored at once in the data_blocks array. + - application - set during initialization + - libavcodec - unchanged + */ + int allocated_data_blocks; + + /** Indicate that the hardware would interpret data_blocks as IDCT + coefficients and perform IDCT on them. + - application - set during initialization + - libavcodec - unchanged + */ + int idct; + + /** In MoCo mode it indicates that intra macroblocks are assumed to be in + unsigned format; same as the XVMC_INTRA_UNSIGNED flag. + - application - set during initialization + - libavcodec - unchanged + */ + int unsigned_intra; + + /** Pointer to the surface allocated by XvMCCreateSurface(). + It has to be freed by XvMCDestroySurface() on application exit. + It identifies the frame and its state on the video hardware. + - application - set during initialization + - libavcodec - unchanged + */ + XvMCSurface* p_surface; + +/** Set by the decoder before calling ff_draw_horiz_band(), + needed by the XvMCRenderSurface function. */ +//@{ + /** Pointer to the surface used as past reference + - application - unchanged + - libavcodec - set + */ + XvMCSurface* p_past_surface; + + /** Pointer to the surface used as future reference + - application - unchanged + - libavcodec - set + */ + XvMCSurface* p_future_surface; + + /** top/bottom field or frame + - application - unchanged + - libavcodec - set + */ + unsigned int picture_structure; + + /** XVMC_SECOND_FIELD - 1st or 2nd field in the sequence + - application - unchanged + - libavcodec - set + */ + unsigned int flags; +//}@ + + /** Number of macroblock descriptions in the mv_blocks array + that have already been passed to the hardware. + - application - zeroes it on get_buffer(). + A successful ff_draw_horiz_band() may increment it + with filled_mb_block_num or zero both. + - libavcodec - unchanged + */ + int start_mv_blocks_num; + + /** Number of new macroblock descriptions in the mv_blocks array (after + start_mv_blocks_num) that are filled by libavcodec and have to be + passed to the hardware. + - application - zeroes it on get_buffer() or after successful + ff_draw_horiz_band(). + - libavcodec - increment with one of each stored MB + */ + int filled_mv_blocks_num; + + /** Number of the next free data block; one data block consists of + 64 short values in the data_blocks array. + All blocks before this one have already been claimed by placing their + position into the corresponding block description structure field, + that are part of the mv_blocks array. + - application - zeroes it on get_buffer(). + A successful ff_draw_horiz_band() may zero it together + with start_mb_blocks_num. + - libavcodec - each decoded macroblock increases it by the number + of coded blocks it contains. + */ + int next_free_data_block_num; +}; + +/** + * @} + */ + +#endif /* AVCODEC_XVMC_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavdevice/avdevice.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavdevice/avdevice.h new file mode 100644 index 0000000..ee94624 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavdevice/avdevice.h @@ -0,0 +1,514 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVDEVICE_AVDEVICE_H +#define AVDEVICE_AVDEVICE_H + +#include "version.h" + +/** + * @file + * @ingroup lavd + * Main libavdevice API header + */ + +/** + * @defgroup lavd libavdevice + * Special devices muxing/demuxing library. + * + * Libavdevice is a complementary library to @ref libavf "libavformat". It + * provides various "special" platform-specific muxers and demuxers, e.g. for + * grabbing devices, audio capture and playback etc. As a consequence, the + * (de)muxers in libavdevice are of the AVFMT_NOFILE type (they use their own + * I/O functions). The filename passed to avformat_open_input() often does not + * refer to an actually existing file, but has some special device-specific + * meaning - e.g. for xcbgrab it is the display name. + * + * To use libavdevice, simply call avdevice_register_all() to register all + * compiled muxers and demuxers. They all use standard libavformat API. + * + * @{ + */ + +#include "libavutil/log.h" +#include "libavutil/opt.h" +#include "libavutil/dict.h" +#include "libavformat/avformat.h" + +/** + * Return the LIBAVDEVICE_VERSION_INT constant. + */ +unsigned avdevice_version(void); + +/** + * Return the libavdevice build-time configuration. + */ +const char *avdevice_configuration(void); + +/** + * Return the libavdevice license. + */ +const char *avdevice_license(void); + +/** + * Initialize libavdevice and register all the input and output devices. + */ +void avdevice_register_all(void); + +/** + * Audio input devices iterator. + * + * If d is NULL, returns the first registered input audio/video device, + * if d is non-NULL, returns the next registered input audio/video device after d + * or NULL if d is the last one. + */ +AVInputFormat *av_input_audio_device_next(AVInputFormat *d); + +/** + * Video input devices iterator. + * + * If d is NULL, returns the first registered input audio/video device, + * if d is non-NULL, returns the next registered input audio/video device after d + * or NULL if d is the last one. + */ +AVInputFormat *av_input_video_device_next(AVInputFormat *d); + +/** + * Audio output devices iterator. + * + * If d is NULL, returns the first registered output audio/video device, + * if d is non-NULL, returns the next registered output audio/video device after d + * or NULL if d is the last one. + */ +AVOutputFormat *av_output_audio_device_next(AVOutputFormat *d); + +/** + * Video output devices iterator. + * + * If d is NULL, returns the first registered output audio/video device, + * if d is non-NULL, returns the next registered output audio/video device after d + * or NULL if d is the last one. + */ +AVOutputFormat *av_output_video_device_next(AVOutputFormat *d); + +typedef struct AVDeviceRect { + int x; /**< x coordinate of top left corner */ + int y; /**< y coordinate of top left corner */ + int width; /**< width */ + int height; /**< height */ +} AVDeviceRect; + +/** + * Message types used by avdevice_app_to_dev_control_message(). + */ +enum AVAppToDevMessageType { + /** + * Dummy message. + */ + AV_APP_TO_DEV_NONE = MKBETAG('N','O','N','E'), + + /** + * Window size change message. + * + * Message is sent to the device every time the application changes the size + * of the window device renders to. + * Message should also be sent right after window is created. + * + * data: AVDeviceRect: new window size. + */ + AV_APP_TO_DEV_WINDOW_SIZE = MKBETAG('G','E','O','M'), + + /** + * Repaint request message. + * + * Message is sent to the device when window has to be repainted. + * + * data: AVDeviceRect: area required to be repainted. + * NULL: whole area is required to be repainted. + */ + AV_APP_TO_DEV_WINDOW_REPAINT = MKBETAG('R','E','P','A'), + + /** + * Request pause/play. + * + * Application requests pause/unpause playback. + * Mostly usable with devices that have internal buffer. + * By default devices are not paused. + * + * data: NULL + */ + AV_APP_TO_DEV_PAUSE = MKBETAG('P', 'A', 'U', ' '), + AV_APP_TO_DEV_PLAY = MKBETAG('P', 'L', 'A', 'Y'), + AV_APP_TO_DEV_TOGGLE_PAUSE = MKBETAG('P', 'A', 'U', 'T'), + + /** + * Volume control message. + * + * Set volume level. It may be device-dependent if volume + * is changed per stream or system wide. Per stream volume + * change is expected when possible. + * + * data: double: new volume with range of 0.0 - 1.0. + */ + AV_APP_TO_DEV_SET_VOLUME = MKBETAG('S', 'V', 'O', 'L'), + + /** + * Mute control messages. + * + * Change mute state. It may be device-dependent if mute status + * is changed per stream or system wide. Per stream mute status + * change is expected when possible. + * + * data: NULL. + */ + AV_APP_TO_DEV_MUTE = MKBETAG(' ', 'M', 'U', 'T'), + AV_APP_TO_DEV_UNMUTE = MKBETAG('U', 'M', 'U', 'T'), + AV_APP_TO_DEV_TOGGLE_MUTE = MKBETAG('T', 'M', 'U', 'T'), + + /** + * Get volume/mute messages. + * + * Force the device to send AV_DEV_TO_APP_VOLUME_LEVEL_CHANGED or + * AV_DEV_TO_APP_MUTE_STATE_CHANGED command respectively. + * + * data: NULL. + */ + AV_APP_TO_DEV_GET_VOLUME = MKBETAG('G', 'V', 'O', 'L'), + AV_APP_TO_DEV_GET_MUTE = MKBETAG('G', 'M', 'U', 'T'), +}; + +/** + * Message types used by avdevice_dev_to_app_control_message(). + */ +enum AVDevToAppMessageType { + /** + * Dummy message. + */ + AV_DEV_TO_APP_NONE = MKBETAG('N','O','N','E'), + + /** + * Create window buffer message. + * + * Device requests to create a window buffer. Exact meaning is device- + * and application-dependent. Message is sent before rendering first + * frame and all one-shot initializations should be done here. + * Application is allowed to ignore preferred window buffer size. + * + * @note: Application is obligated to inform about window buffer size + * with AV_APP_TO_DEV_WINDOW_SIZE message. + * + * data: AVDeviceRect: preferred size of the window buffer. + * NULL: no preferred size of the window buffer. + */ + AV_DEV_TO_APP_CREATE_WINDOW_BUFFER = MKBETAG('B','C','R','E'), + + /** + * Prepare window buffer message. + * + * Device requests to prepare a window buffer for rendering. + * Exact meaning is device- and application-dependent. + * Message is sent before rendering of each frame. + * + * data: NULL. + */ + AV_DEV_TO_APP_PREPARE_WINDOW_BUFFER = MKBETAG('B','P','R','E'), + + /** + * Display window buffer message. + * + * Device requests to display a window buffer. + * Message is sent when new frame is ready to be displayed. + * Usually buffers need to be swapped in handler of this message. + * + * data: NULL. + */ + AV_DEV_TO_APP_DISPLAY_WINDOW_BUFFER = MKBETAG('B','D','I','S'), + + /** + * Destroy window buffer message. + * + * Device requests to destroy a window buffer. + * Message is sent when device is about to be destroyed and window + * buffer is not required anymore. + * + * data: NULL. + */ + AV_DEV_TO_APP_DESTROY_WINDOW_BUFFER = MKBETAG('B','D','E','S'), + + /** + * Buffer fullness status messages. + * + * Device signals buffer overflow/underflow. + * + * data: NULL. + */ + AV_DEV_TO_APP_BUFFER_OVERFLOW = MKBETAG('B','O','F','L'), + AV_DEV_TO_APP_BUFFER_UNDERFLOW = MKBETAG('B','U','F','L'), + + /** + * Buffer readable/writable. + * + * Device informs that buffer is readable/writable. + * When possible, device informs how many bytes can be read/write. + * + * @warning Device may not inform when number of bytes than can be read/write changes. + * + * data: int64_t: amount of bytes available to read/write. + * NULL: amount of bytes available to read/write is not known. + */ + AV_DEV_TO_APP_BUFFER_READABLE = MKBETAG('B','R','D',' '), + AV_DEV_TO_APP_BUFFER_WRITABLE = MKBETAG('B','W','R',' '), + + /** + * Mute state change message. + * + * Device informs that mute state has changed. + * + * data: int: 0 for not muted state, non-zero for muted state. + */ + AV_DEV_TO_APP_MUTE_STATE_CHANGED = MKBETAG('C','M','U','T'), + + /** + * Volume level change message. + * + * Device informs that volume level has changed. + * + * data: double: new volume with range of 0.0 - 1.0. + */ + AV_DEV_TO_APP_VOLUME_LEVEL_CHANGED = MKBETAG('C','V','O','L'), +}; + +/** + * Send control message from application to device. + * + * @param s device context. + * @param type message type. + * @param data message data. Exact type depends on message type. + * @param data_size size of message data. + * @return >= 0 on success, negative on error. + * AVERROR(ENOSYS) when device doesn't implement handler of the message. + */ +int avdevice_app_to_dev_control_message(struct AVFormatContext *s, + enum AVAppToDevMessageType type, + void *data, size_t data_size); + +/** + * Send control message from device to application. + * + * @param s device context. + * @param type message type. + * @param data message data. Can be NULL. + * @param data_size size of message data. + * @return >= 0 on success, negative on error. + * AVERROR(ENOSYS) when application doesn't implement handler of the message. + */ +int avdevice_dev_to_app_control_message(struct AVFormatContext *s, + enum AVDevToAppMessageType type, + void *data, size_t data_size); + +/** + * Following API allows user to probe device capabilities (supported codecs, + * pixel formats, sample formats, resolutions, channel counts, etc). + * It is build on top op AVOption API. + * Queried capabilities make it possible to set up converters of video or audio + * parameters that fit to the device. + * + * List of capabilities that can be queried: + * - Capabilities valid for both audio and video devices: + * - codec: supported audio/video codecs. + * type: AV_OPT_TYPE_INT (AVCodecID value) + * - Capabilities valid for audio devices: + * - sample_format: supported sample formats. + * type: AV_OPT_TYPE_INT (AVSampleFormat value) + * - sample_rate: supported sample rates. + * type: AV_OPT_TYPE_INT + * - channels: supported number of channels. + * type: AV_OPT_TYPE_INT + * - channel_layout: supported channel layouts. + * type: AV_OPT_TYPE_INT64 + * - Capabilities valid for video devices: + * - pixel_format: supported pixel formats. + * type: AV_OPT_TYPE_INT (AVPixelFormat value) + * - window_size: supported window sizes (describes size of the window size presented to the user). + * type: AV_OPT_TYPE_IMAGE_SIZE + * - frame_size: supported frame sizes (describes size of provided video frames). + * type: AV_OPT_TYPE_IMAGE_SIZE + * - fps: supported fps values + * type: AV_OPT_TYPE_RATIONAL + * + * Value of the capability may be set by user using av_opt_set() function + * and AVDeviceCapabilitiesQuery object. Following queries will + * limit results to the values matching already set capabilities. + * For example, setting a codec may impact number of formats or fps values + * returned during next query. Setting invalid value may limit results to zero. + * + * Example of the usage basing on opengl output device: + * + * @code + * AVFormatContext *oc = NULL; + * AVDeviceCapabilitiesQuery *caps = NULL; + * AVOptionRanges *ranges; + * int ret; + * + * if ((ret = avformat_alloc_output_context2(&oc, NULL, "opengl", NULL)) < 0) + * goto fail; + * if (avdevice_capabilities_create(&caps, oc, NULL) < 0) + * goto fail; + * + * //query codecs + * if (av_opt_query_ranges(&ranges, caps, "codec", AV_OPT_MULTI_COMPONENT_RANGE)) < 0) + * goto fail; + * //pick codec here and set it + * av_opt_set(caps, "codec", AV_CODEC_ID_RAWVIDEO, 0); + * + * //query format + * if (av_opt_query_ranges(&ranges, caps, "pixel_format", AV_OPT_MULTI_COMPONENT_RANGE)) < 0) + * goto fail; + * //pick format here and set it + * av_opt_set(caps, "pixel_format", AV_PIX_FMT_YUV420P, 0); + * + * //query and set more capabilities + * + * fail: + * //clean up code + * avdevice_capabilities_free(&query, oc); + * avformat_free_context(oc); + * @endcode + */ + +/** + * Structure describes device capabilities. + * + * It is used by devices in conjunction with av_device_capabilities AVOption table + * to implement capabilities probing API based on AVOption API. Should not be used directly. + */ +typedef struct AVDeviceCapabilitiesQuery { + const AVClass *av_class; + AVFormatContext *device_context; + enum AVCodecID codec; + enum AVSampleFormat sample_format; + enum AVPixelFormat pixel_format; + int sample_rate; + int channels; + int64_t channel_layout; + int window_width; + int window_height; + int frame_width; + int frame_height; + AVRational fps; +} AVDeviceCapabilitiesQuery; + +/** + * AVOption table used by devices to implement device capabilities API. Should not be used by a user. + */ +extern const AVOption av_device_capabilities[]; + +/** + * Initialize capabilities probing API based on AVOption API. + * + * avdevice_capabilities_free() must be called when query capabilities API is + * not used anymore. + * + * @param[out] caps Device capabilities data. Pointer to a NULL pointer must be passed. + * @param s Context of the device. + * @param device_options An AVDictionary filled with device-private options. + * On return this parameter will be destroyed and replaced with a dict + * containing options that were not found. May be NULL. + * The same options must be passed later to avformat_write_header() for output + * devices or avformat_open_input() for input devices, or at any other place + * that affects device-private options. + * + * @return >= 0 on success, negative otherwise. + */ +int avdevice_capabilities_create(AVDeviceCapabilitiesQuery **caps, AVFormatContext *s, + AVDictionary **device_options); + +/** + * Free resources created by avdevice_capabilities_create() + * + * @param caps Device capabilities data to be freed. + * @param s Context of the device. + */ +void avdevice_capabilities_free(AVDeviceCapabilitiesQuery **caps, AVFormatContext *s); + +/** + * Structure describes basic parameters of the device. + */ +typedef struct AVDeviceInfo { + char *device_name; /**< device name, format depends on device */ + char *device_description; /**< human friendly name */ +} AVDeviceInfo; + +/** + * List of devices. + */ +typedef struct AVDeviceInfoList { + AVDeviceInfo **devices; /**< list of autodetected devices */ + int nb_devices; /**< number of autodetected devices */ + int default_device; /**< index of default device or -1 if no default */ +} AVDeviceInfoList; + +/** + * List devices. + * + * Returns available device names and their parameters. + * + * @note: Some devices may accept system-dependent device names that cannot be + * autodetected. The list returned by this function cannot be assumed to + * be always completed. + * + * @param s device context. + * @param[out] device_list list of autodetected devices. + * @return count of autodetected devices, negative on error. + */ +int avdevice_list_devices(struct AVFormatContext *s, AVDeviceInfoList **device_list); + +/** + * Convenient function to free result of avdevice_list_devices(). + * + * @param devices device list to be freed. + */ +void avdevice_free_list_devices(AVDeviceInfoList **device_list); + +/** + * List devices. + * + * Returns available device names and their parameters. + * These are convinient wrappers for avdevice_list_devices(). + * Device context is allocated and deallocated internally. + * + * @param device device format. May be NULL if device name is set. + * @param device_name device name. May be NULL if device format is set. + * @param device_options An AVDictionary filled with device-private options. May be NULL. + * The same options must be passed later to avformat_write_header() for output + * devices or avformat_open_input() for input devices, or at any other place + * that affects device-private options. + * @param[out] device_list list of autodetected devices + * @return count of autodetected devices, negative on error. + * @note device argument takes precedence over device_name when both are set. + */ +int avdevice_list_input_sources(struct AVInputFormat *device, const char *device_name, + AVDictionary *device_options, AVDeviceInfoList **device_list); +int avdevice_list_output_sinks(struct AVOutputFormat *device, const char *device_name, + AVDictionary *device_options, AVDeviceInfoList **device_list); + +/** + * @} + */ + +#endif /* AVDEVICE_AVDEVICE_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavdevice/version.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavdevice/version.h new file mode 100644 index 0000000..9ee3d3d --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavdevice/version.h @@ -0,0 +1,50 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVDEVICE_VERSION_H +#define AVDEVICE_VERSION_H + +/** + * @file + * @ingroup lavd + * Libavdevice version macros + */ + +#include "libavutil/version.h" + +#define LIBAVDEVICE_VERSION_MAJOR 58 +#define LIBAVDEVICE_VERSION_MINOR 10 +#define LIBAVDEVICE_VERSION_MICRO 100 + +#define LIBAVDEVICE_VERSION_INT AV_VERSION_INT(LIBAVDEVICE_VERSION_MAJOR, \ + LIBAVDEVICE_VERSION_MINOR, \ + LIBAVDEVICE_VERSION_MICRO) +#define LIBAVDEVICE_VERSION AV_VERSION(LIBAVDEVICE_VERSION_MAJOR, \ + LIBAVDEVICE_VERSION_MINOR, \ + LIBAVDEVICE_VERSION_MICRO) +#define LIBAVDEVICE_BUILD LIBAVDEVICE_VERSION_INT + +#define LIBAVDEVICE_IDENT "Lavd" AV_STRINGIFY(LIBAVDEVICE_VERSION) + +/** + * FF_API_* defines may be placed below to indicate public API that will be + * dropped at a future version bump. The defines themselves are not part of + * the public API and may change, break or disappear at any time. + */ + +#endif /* AVDEVICE_VERSION_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavfilter/avfilter.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavfilter/avfilter.h new file mode 100644 index 0000000..49b4f7a --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavfilter/avfilter.h @@ -0,0 +1,1168 @@ +/* + * filter layer + * Copyright (c) 2007 Bobby Bingham + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVFILTER_AVFILTER_H +#define AVFILTER_AVFILTER_H + +/** + * @file + * @ingroup lavfi + * Main libavfilter public API header + */ + +/** + * @defgroup lavfi libavfilter + * Graph-based frame editing library. + * + * @{ + */ + +#include + +#include "libavutil/attributes.h" +#include "libavutil/avutil.h" +#include "libavutil/buffer.h" +#include "libavutil/dict.h" +#include "libavutil/frame.h" +#include "libavutil/log.h" +#include "libavutil/samplefmt.h" +#include "libavutil/pixfmt.h" +#include "libavutil/rational.h" + +#include "libavfilter/version.h" + +/** + * Return the LIBAVFILTER_VERSION_INT constant. + */ +unsigned avfilter_version(void); + +/** + * Return the libavfilter build-time configuration. + */ +const char *avfilter_configuration(void); + +/** + * Return the libavfilter license. + */ +const char *avfilter_license(void); + +typedef struct AVFilterContext AVFilterContext; +typedef struct AVFilterLink AVFilterLink; +typedef struct AVFilterPad AVFilterPad; +typedef struct AVFilterFormats AVFilterFormats; + +/** + * Get the number of elements in a NULL-terminated array of AVFilterPads (e.g. + * AVFilter.inputs/outputs). + */ +int avfilter_pad_count(const AVFilterPad *pads); + +/** + * Get the name of an AVFilterPad. + * + * @param pads an array of AVFilterPads + * @param pad_idx index of the pad in the array; it is the caller's + * responsibility to ensure the index is valid + * + * @return name of the pad_idx'th pad in pads + */ +const char *avfilter_pad_get_name(const AVFilterPad *pads, int pad_idx); + +/** + * Get the type of an AVFilterPad. + * + * @param pads an array of AVFilterPads + * @param pad_idx index of the pad in the array; it is the caller's + * responsibility to ensure the index is valid + * + * @return type of the pad_idx'th pad in pads + */ +enum AVMediaType avfilter_pad_get_type(const AVFilterPad *pads, int pad_idx); + +/** + * The number of the filter inputs is not determined just by AVFilter.inputs. + * The filter might add additional inputs during initialization depending on the + * options supplied to it. + */ +#define AVFILTER_FLAG_DYNAMIC_INPUTS (1 << 0) +/** + * The number of the filter outputs is not determined just by AVFilter.outputs. + * The filter might add additional outputs during initialization depending on + * the options supplied to it. + */ +#define AVFILTER_FLAG_DYNAMIC_OUTPUTS (1 << 1) +/** + * The filter supports multithreading by splitting frames into multiple parts + * and processing them concurrently. + */ +#define AVFILTER_FLAG_SLICE_THREADS (1 << 2) +/** + * Some filters support a generic "enable" expression option that can be used + * to enable or disable a filter in the timeline. Filters supporting this + * option have this flag set. When the enable expression is false, the default + * no-op filter_frame() function is called in place of the filter_frame() + * callback defined on each input pad, thus the frame is passed unchanged to + * the next filters. + */ +#define AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC (1 << 16) +/** + * Same as AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC, except that the filter will + * have its filter_frame() callback(s) called as usual even when the enable + * expression is false. The filter will disable filtering within the + * filter_frame() callback(s) itself, for example executing code depending on + * the AVFilterContext->is_disabled value. + */ +#define AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL (1 << 17) +/** + * Handy mask to test whether the filter supports or no the timeline feature + * (internally or generically). + */ +#define AVFILTER_FLAG_SUPPORT_TIMELINE (AVFILTER_FLAG_SUPPORT_TIMELINE_GENERIC | AVFILTER_FLAG_SUPPORT_TIMELINE_INTERNAL) + +/** + * Filter definition. This defines the pads a filter contains, and all the + * callback functions used to interact with the filter. + */ +typedef struct AVFilter { + /** + * Filter name. Must be non-NULL and unique among filters. + */ + const char *name; + + /** + * A description of the filter. May be NULL. + * + * You should use the NULL_IF_CONFIG_SMALL() macro to define it. + */ + const char *description; + + /** + * List of inputs, terminated by a zeroed element. + * + * NULL if there are no (static) inputs. Instances of filters with + * AVFILTER_FLAG_DYNAMIC_INPUTS set may have more inputs than present in + * this list. + */ + const AVFilterPad *inputs; + /** + * List of outputs, terminated by a zeroed element. + * + * NULL if there are no (static) outputs. Instances of filters with + * AVFILTER_FLAG_DYNAMIC_OUTPUTS set may have more outputs than present in + * this list. + */ + const AVFilterPad *outputs; + + /** + * A class for the private data, used to declare filter private AVOptions. + * This field is NULL for filters that do not declare any options. + * + * If this field is non-NULL, the first member of the filter private data + * must be a pointer to AVClass, which will be set by libavfilter generic + * code to this class. + */ + const AVClass *priv_class; + + /** + * A combination of AVFILTER_FLAG_* + */ + int flags; + + /***************************************************************** + * All fields below this line are not part of the public API. They + * may not be used outside of libavfilter and can be changed and + * removed at will. + * New public fields should be added right above. + ***************************************************************** + */ + + /** + * Filter pre-initialization function + * + * This callback will be called immediately after the filter context is + * allocated, to allow allocating and initing sub-objects. + * + * If this callback is not NULL, the uninit callback will be called on + * allocation failure. + * + * @return 0 on success, + * AVERROR code on failure (but the code will be + * dropped and treated as ENOMEM by the calling code) + */ + int (*preinit)(AVFilterContext *ctx); + + /** + * Filter initialization function. + * + * This callback will be called only once during the filter lifetime, after + * all the options have been set, but before links between filters are + * established and format negotiation is done. + * + * Basic filter initialization should be done here. Filters with dynamic + * inputs and/or outputs should create those inputs/outputs here based on + * provided options. No more changes to this filter's inputs/outputs can be + * done after this callback. + * + * This callback must not assume that the filter links exist or frame + * parameters are known. + * + * @ref AVFilter.uninit "uninit" is guaranteed to be called even if + * initialization fails, so this callback does not have to clean up on + * failure. + * + * @return 0 on success, a negative AVERROR on failure + */ + int (*init)(AVFilterContext *ctx); + + /** + * Should be set instead of @ref AVFilter.init "init" by the filters that + * want to pass a dictionary of AVOptions to nested contexts that are + * allocated during init. + * + * On return, the options dict should be freed and replaced with one that + * contains all the options which could not be processed by this filter (or + * with NULL if all the options were processed). + * + * Otherwise the semantics is the same as for @ref AVFilter.init "init". + */ + int (*init_dict)(AVFilterContext *ctx, AVDictionary **options); + + /** + * Filter uninitialization function. + * + * Called only once right before the filter is freed. Should deallocate any + * memory held by the filter, release any buffer references, etc. It does + * not need to deallocate the AVFilterContext.priv memory itself. + * + * This callback may be called even if @ref AVFilter.init "init" was not + * called or failed, so it must be prepared to handle such a situation. + */ + void (*uninit)(AVFilterContext *ctx); + + /** + * Query formats supported by the filter on its inputs and outputs. + * + * This callback is called after the filter is initialized (so the inputs + * and outputs are fixed), shortly before the format negotiation. This + * callback may be called more than once. + * + * This callback must set AVFilterLink.out_formats on every input link and + * AVFilterLink.in_formats on every output link to a list of pixel/sample + * formats that the filter supports on that link. For audio links, this + * filter must also set @ref AVFilterLink.in_samplerates "in_samplerates" / + * @ref AVFilterLink.out_samplerates "out_samplerates" and + * @ref AVFilterLink.in_channel_layouts "in_channel_layouts" / + * @ref AVFilterLink.out_channel_layouts "out_channel_layouts" analogously. + * + * This callback may be NULL for filters with one input, in which case + * libavfilter assumes that it supports all input formats and preserves + * them on output. + * + * @return zero on success, a negative value corresponding to an + * AVERROR code otherwise + */ + int (*query_formats)(AVFilterContext *); + + int priv_size; ///< size of private data to allocate for the filter + + int flags_internal; ///< Additional flags for avfilter internal use only. + + /** + * Used by the filter registration system. Must not be touched by any other + * code. + */ + struct AVFilter *next; + + /** + * Make the filter instance process a command. + * + * @param cmd the command to process, for handling simplicity all commands must be alphanumeric only + * @param arg the argument for the command + * @param res a buffer with size res_size where the filter(s) can return a response. This must not change when the command is not supported. + * @param flags if AVFILTER_CMD_FLAG_FAST is set and the command would be + * time consuming then a filter should treat it like an unsupported command + * + * @returns >=0 on success otherwise an error code. + * AVERROR(ENOSYS) on unsupported commands + */ + int (*process_command)(AVFilterContext *, const char *cmd, const char *arg, char *res, int res_len, int flags); + + /** + * Filter initialization function, alternative to the init() + * callback. Args contains the user-supplied parameters, opaque is + * used for providing binary data. + */ + int (*init_opaque)(AVFilterContext *ctx, void *opaque); + + /** + * Filter activation function. + * + * Called when any processing is needed from the filter, instead of any + * filter_frame and request_frame on pads. + * + * The function must examine inlinks and outlinks and perform a single + * step of processing. If there is nothing to do, the function must do + * nothing and not return an error. If more steps are or may be + * possible, it must use ff_filter_set_ready() to schedule another + * activation. + */ + int (*activate)(AVFilterContext *ctx); +} AVFilter; + +/** + * Process multiple parts of the frame concurrently. + */ +#define AVFILTER_THREAD_SLICE (1 << 0) + +typedef struct AVFilterInternal AVFilterInternal; + +/** An instance of a filter */ +struct AVFilterContext { + const AVClass *av_class; ///< needed for av_log() and filters common options + + const AVFilter *filter; ///< the AVFilter of which this is an instance + + char *name; ///< name of this filter instance + + AVFilterPad *input_pads; ///< array of input pads + AVFilterLink **inputs; ///< array of pointers to input links + unsigned nb_inputs; ///< number of input pads + + AVFilterPad *output_pads; ///< array of output pads + AVFilterLink **outputs; ///< array of pointers to output links + unsigned nb_outputs; ///< number of output pads + + void *priv; ///< private data for use by the filter + + struct AVFilterGraph *graph; ///< filtergraph this filter belongs to + + /** + * Type of multithreading being allowed/used. A combination of + * AVFILTER_THREAD_* flags. + * + * May be set by the caller before initializing the filter to forbid some + * or all kinds of multithreading for this filter. The default is allowing + * everything. + * + * When the filter is initialized, this field is combined using bit AND with + * AVFilterGraph.thread_type to get the final mask used for determining + * allowed threading types. I.e. a threading type needs to be set in both + * to be allowed. + * + * After the filter is initialized, libavfilter sets this field to the + * threading type that is actually used (0 for no multithreading). + */ + int thread_type; + + /** + * An opaque struct for libavfilter internal use. + */ + AVFilterInternal *internal; + + struct AVFilterCommand *command_queue; + + char *enable_str; ///< enable expression string + void *enable; ///< parsed expression (AVExpr*) + double *var_values; ///< variable values for the enable expression + int is_disabled; ///< the enabled state from the last expression evaluation + + /** + * For filters which will create hardware frames, sets the device the + * filter should create them in. All other filters will ignore this field: + * in particular, a filter which consumes or processes hardware frames will + * instead use the hw_frames_ctx field in AVFilterLink to carry the + * hardware context information. + */ + AVBufferRef *hw_device_ctx; + + /** + * Max number of threads allowed in this filter instance. + * If <= 0, its value is ignored. + * Overrides global number of threads set per filter graph. + */ + int nb_threads; + + /** + * Ready status of the filter. + * A non-0 value means that the filter needs activating; + * a higher value suggests a more urgent activation. + */ + unsigned ready; + + /** + * Sets the number of extra hardware frames which the filter will + * allocate on its output links for use in following filters or by + * the caller. + * + * Some hardware filters require all frames that they will use for + * output to be defined in advance before filtering starts. For such + * filters, any hardware frame pools used for output must therefore be + * of fixed size. The extra frames set here are on top of any number + * that the filter needs internally in order to operate normally. + * + * This field must be set before the graph containing this filter is + * configured. + */ + int extra_hw_frames; +}; + +/** + * A link between two filters. This contains pointers to the source and + * destination filters between which this link exists, and the indexes of + * the pads involved. In addition, this link also contains the parameters + * which have been negotiated and agreed upon between the filter, such as + * image dimensions, format, etc. + * + * Applications must not normally access the link structure directly. + * Use the buffersrc and buffersink API instead. + * In the future, access to the header may be reserved for filters + * implementation. + */ +struct AVFilterLink { + AVFilterContext *src; ///< source filter + AVFilterPad *srcpad; ///< output pad on the source filter + + AVFilterContext *dst; ///< dest filter + AVFilterPad *dstpad; ///< input pad on the dest filter + + enum AVMediaType type; ///< filter media type + + /* These parameters apply only to video */ + int w; ///< agreed upon image width + int h; ///< agreed upon image height + AVRational sample_aspect_ratio; ///< agreed upon sample aspect ratio + /* These parameters apply only to audio */ + uint64_t channel_layout; ///< channel layout of current buffer (see libavutil/channel_layout.h) + int sample_rate; ///< samples per second + + int format; ///< agreed upon media format + + /** + * Define the time base used by the PTS of the frames/samples + * which will pass through this link. + * During the configuration stage, each filter is supposed to + * change only the output timebase, while the timebase of the + * input link is assumed to be an unchangeable property. + */ + AVRational time_base; + + /***************************************************************** + * All fields below this line are not part of the public API. They + * may not be used outside of libavfilter and can be changed and + * removed at will. + * New public fields should be added right above. + ***************************************************************** + */ + /** + * Lists of formats and channel layouts supported by the input and output + * filters respectively. These lists are used for negotiating the format + * to actually be used, which will be loaded into the format and + * channel_layout members, above, when chosen. + * + */ + AVFilterFormats *in_formats; + AVFilterFormats *out_formats; + + /** + * Lists of channel layouts and sample rates used for automatic + * negotiation. + */ + AVFilterFormats *in_samplerates; + AVFilterFormats *out_samplerates; + struct AVFilterChannelLayouts *in_channel_layouts; + struct AVFilterChannelLayouts *out_channel_layouts; + + /** + * Audio only, the destination filter sets this to a non-zero value to + * request that buffers with the given number of samples should be sent to + * it. AVFilterPad.needs_fifo must also be set on the corresponding input + * pad. + * Last buffer before EOF will be padded with silence. + */ + int request_samples; + + /** stage of the initialization of the link properties (dimensions, etc) */ + enum { + AVLINK_UNINIT = 0, ///< not started + AVLINK_STARTINIT, ///< started, but incomplete + AVLINK_INIT ///< complete + } init_state; + + /** + * Graph the filter belongs to. + */ + struct AVFilterGraph *graph; + + /** + * Current timestamp of the link, as defined by the most recent + * frame(s), in link time_base units. + */ + int64_t current_pts; + + /** + * Current timestamp of the link, as defined by the most recent + * frame(s), in AV_TIME_BASE units. + */ + int64_t current_pts_us; + + /** + * Index in the age array. + */ + int age_index; + + /** + * Frame rate of the stream on the link, or 1/0 if unknown or variable; + * if left to 0/0, will be automatically copied from the first input + * of the source filter if it exists. + * + * Sources should set it to the best estimation of the real frame rate. + * If the source frame rate is unknown or variable, set this to 1/0. + * Filters should update it if necessary depending on their function. + * Sinks can use it to set a default output frame rate. + * It is similar to the r_frame_rate field in AVStream. + */ + AVRational frame_rate; + + /** + * Buffer partially filled with samples to achieve a fixed/minimum size. + */ + AVFrame *partial_buf; + + /** + * Size of the partial buffer to allocate. + * Must be between min_samples and max_samples. + */ + int partial_buf_size; + + /** + * Minimum number of samples to filter at once. If filter_frame() is + * called with fewer samples, it will accumulate them in partial_buf. + * This field and the related ones must not be changed after filtering + * has started. + * If 0, all related fields are ignored. + */ + int min_samples; + + /** + * Maximum number of samples to filter at once. If filter_frame() is + * called with more samples, it will split them. + */ + int max_samples; + + /** + * Number of channels. + */ + int channels; + + /** + * Link processing flags. + */ + unsigned flags; + + /** + * Number of past frames sent through the link. + */ + int64_t frame_count_in, frame_count_out; + + /** + * A pointer to a FFFramePool struct. + */ + void *frame_pool; + + /** + * True if a frame is currently wanted on the output of this filter. + * Set when ff_request_frame() is called by the output, + * cleared when a frame is filtered. + */ + int frame_wanted_out; + + /** + * For hwaccel pixel formats, this should be a reference to the + * AVHWFramesContext describing the frames. + */ + AVBufferRef *hw_frames_ctx; + +#ifndef FF_INTERNAL_FIELDS + + /** + * Internal structure members. + * The fields below this limit are internal for libavfilter's use + * and must in no way be accessed by applications. + */ + char reserved[0xF000]; + +#else /* FF_INTERNAL_FIELDS */ + + /** + * Queue of frames waiting to be filtered. + */ + FFFrameQueue fifo; + + /** + * If set, the source filter can not generate a frame as is. + * The goal is to avoid repeatedly calling the request_frame() method on + * the same link. + */ + int frame_blocked_in; + + /** + * Link input status. + * If not zero, all attempts of filter_frame will fail with the + * corresponding code. + */ + int status_in; + + /** + * Timestamp of the input status change. + */ + int64_t status_in_pts; + + /** + * Link output status. + * If not zero, all attempts of request_frame will fail with the + * corresponding code. + */ + int status_out; + +#endif /* FF_INTERNAL_FIELDS */ + +}; + +/** + * Link two filters together. + * + * @param src the source filter + * @param srcpad index of the output pad on the source filter + * @param dst the destination filter + * @param dstpad index of the input pad on the destination filter + * @return zero on success + */ +int avfilter_link(AVFilterContext *src, unsigned srcpad, + AVFilterContext *dst, unsigned dstpad); + +/** + * Free the link in *link, and set its pointer to NULL. + */ +void avfilter_link_free(AVFilterLink **link); + +#if FF_API_FILTER_GET_SET +/** + * Get the number of channels of a link. + * @deprecated Use av_buffersink_get_channels() + */ +attribute_deprecated +int avfilter_link_get_channels(AVFilterLink *link); +#endif + +/** + * Set the closed field of a link. + * @deprecated applications are not supposed to mess with links, they should + * close the sinks. + */ +attribute_deprecated +void avfilter_link_set_closed(AVFilterLink *link, int closed); + +/** + * Negotiate the media format, dimensions, etc of all inputs to a filter. + * + * @param filter the filter to negotiate the properties for its inputs + * @return zero on successful negotiation + */ +int avfilter_config_links(AVFilterContext *filter); + +#define AVFILTER_CMD_FLAG_ONE 1 ///< Stop once a filter understood the command (for target=all for example), fast filters are favored automatically +#define AVFILTER_CMD_FLAG_FAST 2 ///< Only execute command when its fast (like a video out that supports contrast adjustment in hw) + +/** + * Make the filter instance process a command. + * It is recommended to use avfilter_graph_send_command(). + */ +int avfilter_process_command(AVFilterContext *filter, const char *cmd, const char *arg, char *res, int res_len, int flags); + +/** + * Iterate over all registered filters. + * + * @param opaque a pointer where libavfilter will store the iteration state. Must + * point to NULL to start the iteration. + * + * @return the next registered filter or NULL when the iteration is + * finished + */ +const AVFilter *av_filter_iterate(void **opaque); + +#if FF_API_NEXT +/** Initialize the filter system. Register all builtin filters. */ +attribute_deprecated +void avfilter_register_all(void); + +/** + * Register a filter. This is only needed if you plan to use + * avfilter_get_by_name later to lookup the AVFilter structure by name. A + * filter can still by instantiated with avfilter_graph_alloc_filter even if it + * is not registered. + * + * @param filter the filter to register + * @return 0 if the registration was successful, a negative value + * otherwise + */ +attribute_deprecated +int avfilter_register(AVFilter *filter); + +/** + * Iterate over all registered filters. + * @return If prev is non-NULL, next registered filter after prev or NULL if + * prev is the last filter. If prev is NULL, return the first registered filter. + */ +attribute_deprecated +const AVFilter *avfilter_next(const AVFilter *prev); +#endif + +/** + * Get a filter definition matching the given name. + * + * @param name the filter name to find + * @return the filter definition, if any matching one is registered. + * NULL if none found. + */ +const AVFilter *avfilter_get_by_name(const char *name); + + +/** + * Initialize a filter with the supplied parameters. + * + * @param ctx uninitialized filter context to initialize + * @param args Options to initialize the filter with. This must be a + * ':'-separated list of options in the 'key=value' form. + * May be NULL if the options have been set directly using the + * AVOptions API or there are no options that need to be set. + * @return 0 on success, a negative AVERROR on failure + */ +int avfilter_init_str(AVFilterContext *ctx, const char *args); + +/** + * Initialize a filter with the supplied dictionary of options. + * + * @param ctx uninitialized filter context to initialize + * @param options An AVDictionary filled with options for this filter. On + * return this parameter will be destroyed and replaced with + * a dict containing options that were not found. This dictionary + * must be freed by the caller. + * May be NULL, then this function is equivalent to + * avfilter_init_str() with the second parameter set to NULL. + * @return 0 on success, a negative AVERROR on failure + * + * @note This function and avfilter_init_str() do essentially the same thing, + * the difference is in manner in which the options are passed. It is up to the + * calling code to choose whichever is more preferable. The two functions also + * behave differently when some of the provided options are not declared as + * supported by the filter. In such a case, avfilter_init_str() will fail, but + * this function will leave those extra options in the options AVDictionary and + * continue as usual. + */ +int avfilter_init_dict(AVFilterContext *ctx, AVDictionary **options); + +/** + * Free a filter context. This will also remove the filter from its + * filtergraph's list of filters. + * + * @param filter the filter to free + */ +void avfilter_free(AVFilterContext *filter); + +/** + * Insert a filter in the middle of an existing link. + * + * @param link the link into which the filter should be inserted + * @param filt the filter to be inserted + * @param filt_srcpad_idx the input pad on the filter to connect + * @param filt_dstpad_idx the output pad on the filter to connect + * @return zero on success + */ +int avfilter_insert_filter(AVFilterLink *link, AVFilterContext *filt, + unsigned filt_srcpad_idx, unsigned filt_dstpad_idx); + +/** + * @return AVClass for AVFilterContext. + * + * @see av_opt_find(). + */ +const AVClass *avfilter_get_class(void); + +typedef struct AVFilterGraphInternal AVFilterGraphInternal; + +/** + * A function pointer passed to the @ref AVFilterGraph.execute callback to be + * executed multiple times, possibly in parallel. + * + * @param ctx the filter context the job belongs to + * @param arg an opaque parameter passed through from @ref + * AVFilterGraph.execute + * @param jobnr the index of the job being executed + * @param nb_jobs the total number of jobs + * + * @return 0 on success, a negative AVERROR on error + */ +typedef int (avfilter_action_func)(AVFilterContext *ctx, void *arg, int jobnr, int nb_jobs); + +/** + * A function executing multiple jobs, possibly in parallel. + * + * @param ctx the filter context to which the jobs belong + * @param func the function to be called multiple times + * @param arg the argument to be passed to func + * @param ret a nb_jobs-sized array to be filled with return values from each + * invocation of func + * @param nb_jobs the number of jobs to execute + * + * @return 0 on success, a negative AVERROR on error + */ +typedef int (avfilter_execute_func)(AVFilterContext *ctx, avfilter_action_func *func, + void *arg, int *ret, int nb_jobs); + +typedef struct AVFilterGraph { + const AVClass *av_class; + AVFilterContext **filters; + unsigned nb_filters; + + char *scale_sws_opts; ///< sws options to use for the auto-inserted scale filters +#if FF_API_LAVR_OPTS + attribute_deprecated char *resample_lavr_opts; ///< libavresample options to use for the auto-inserted resample filters +#endif + + /** + * Type of multithreading allowed for filters in this graph. A combination + * of AVFILTER_THREAD_* flags. + * + * May be set by the caller at any point, the setting will apply to all + * filters initialized after that. The default is allowing everything. + * + * When a filter in this graph is initialized, this field is combined using + * bit AND with AVFilterContext.thread_type to get the final mask used for + * determining allowed threading types. I.e. a threading type needs to be + * set in both to be allowed. + */ + int thread_type; + + /** + * Maximum number of threads used by filters in this graph. May be set by + * the caller before adding any filters to the filtergraph. Zero (the + * default) means that the number of threads is determined automatically. + */ + int nb_threads; + + /** + * Opaque object for libavfilter internal use. + */ + AVFilterGraphInternal *internal; + + /** + * Opaque user data. May be set by the caller to an arbitrary value, e.g. to + * be used from callbacks like @ref AVFilterGraph.execute. + * Libavfilter will not touch this field in any way. + */ + void *opaque; + + /** + * This callback may be set by the caller immediately after allocating the + * graph and before adding any filters to it, to provide a custom + * multithreading implementation. + * + * If set, filters with slice threading capability will call this callback + * to execute multiple jobs in parallel. + * + * If this field is left unset, libavfilter will use its internal + * implementation, which may or may not be multithreaded depending on the + * platform and build options. + */ + avfilter_execute_func *execute; + + char *aresample_swr_opts; ///< swr options to use for the auto-inserted aresample filters, Access ONLY through AVOptions + + /** + * Private fields + * + * The following fields are for internal use only. + * Their type, offset, number and semantic can change without notice. + */ + + AVFilterLink **sink_links; + int sink_links_count; + + unsigned disable_auto_convert; +} AVFilterGraph; + +/** + * Allocate a filter graph. + * + * @return the allocated filter graph on success or NULL. + */ +AVFilterGraph *avfilter_graph_alloc(void); + +/** + * Create a new filter instance in a filter graph. + * + * @param graph graph in which the new filter will be used + * @param filter the filter to create an instance of + * @param name Name to give to the new instance (will be copied to + * AVFilterContext.name). This may be used by the caller to identify + * different filters, libavfilter itself assigns no semantics to + * this parameter. May be NULL. + * + * @return the context of the newly created filter instance (note that it is + * also retrievable directly through AVFilterGraph.filters or with + * avfilter_graph_get_filter()) on success or NULL on failure. + */ +AVFilterContext *avfilter_graph_alloc_filter(AVFilterGraph *graph, + const AVFilter *filter, + const char *name); + +/** + * Get a filter instance identified by instance name from graph. + * + * @param graph filter graph to search through. + * @param name filter instance name (should be unique in the graph). + * @return the pointer to the found filter instance or NULL if it + * cannot be found. + */ +AVFilterContext *avfilter_graph_get_filter(AVFilterGraph *graph, const char *name); + +/** + * Create and add a filter instance into an existing graph. + * The filter instance is created from the filter filt and inited + * with the parameter args. opaque is currently ignored. + * + * In case of success put in *filt_ctx the pointer to the created + * filter instance, otherwise set *filt_ctx to NULL. + * + * @param name the instance name to give to the created filter instance + * @param graph_ctx the filter graph + * @return a negative AVERROR error code in case of failure, a non + * negative value otherwise + */ +int avfilter_graph_create_filter(AVFilterContext **filt_ctx, const AVFilter *filt, + const char *name, const char *args, void *opaque, + AVFilterGraph *graph_ctx); + +/** + * Enable or disable automatic format conversion inside the graph. + * + * Note that format conversion can still happen inside explicitly inserted + * scale and aresample filters. + * + * @param flags any of the AVFILTER_AUTO_CONVERT_* constants + */ +void avfilter_graph_set_auto_convert(AVFilterGraph *graph, unsigned flags); + +enum { + AVFILTER_AUTO_CONVERT_ALL = 0, /**< all automatic conversions enabled */ + AVFILTER_AUTO_CONVERT_NONE = -1, /**< all automatic conversions disabled */ +}; + +/** + * Check validity and configure all the links and formats in the graph. + * + * @param graphctx the filter graph + * @param log_ctx context used for logging + * @return >= 0 in case of success, a negative AVERROR code otherwise + */ +int avfilter_graph_config(AVFilterGraph *graphctx, void *log_ctx); + +/** + * Free a graph, destroy its links, and set *graph to NULL. + * If *graph is NULL, do nothing. + */ +void avfilter_graph_free(AVFilterGraph **graph); + +/** + * A linked-list of the inputs/outputs of the filter chain. + * + * This is mainly useful for avfilter_graph_parse() / avfilter_graph_parse2(), + * where it is used to communicate open (unlinked) inputs and outputs from and + * to the caller. + * This struct specifies, per each not connected pad contained in the graph, the + * filter context and the pad index required for establishing a link. + */ +typedef struct AVFilterInOut { + /** unique name for this input/output in the list */ + char *name; + + /** filter context associated to this input/output */ + AVFilterContext *filter_ctx; + + /** index of the filt_ctx pad to use for linking */ + int pad_idx; + + /** next input/input in the list, NULL if this is the last */ + struct AVFilterInOut *next; +} AVFilterInOut; + +/** + * Allocate a single AVFilterInOut entry. + * Must be freed with avfilter_inout_free(). + * @return allocated AVFilterInOut on success, NULL on failure. + */ +AVFilterInOut *avfilter_inout_alloc(void); + +/** + * Free the supplied list of AVFilterInOut and set *inout to NULL. + * If *inout is NULL, do nothing. + */ +void avfilter_inout_free(AVFilterInOut **inout); + +/** + * Add a graph described by a string to a graph. + * + * @note The caller must provide the lists of inputs and outputs, + * which therefore must be known before calling the function. + * + * @note The inputs parameter describes inputs of the already existing + * part of the graph; i.e. from the point of view of the newly created + * part, they are outputs. Similarly the outputs parameter describes + * outputs of the already existing filters, which are provided as + * inputs to the parsed filters. + * + * @param graph the filter graph where to link the parsed graph context + * @param filters string to be parsed + * @param inputs linked list to the inputs of the graph + * @param outputs linked list to the outputs of the graph + * @return zero on success, a negative AVERROR code on error + */ +int avfilter_graph_parse(AVFilterGraph *graph, const char *filters, + AVFilterInOut *inputs, AVFilterInOut *outputs, + void *log_ctx); + +/** + * Add a graph described by a string to a graph. + * + * In the graph filters description, if the input label of the first + * filter is not specified, "in" is assumed; if the output label of + * the last filter is not specified, "out" is assumed. + * + * @param graph the filter graph where to link the parsed graph context + * @param filters string to be parsed + * @param inputs pointer to a linked list to the inputs of the graph, may be NULL. + * If non-NULL, *inputs is updated to contain the list of open inputs + * after the parsing, should be freed with avfilter_inout_free(). + * @param outputs pointer to a linked list to the outputs of the graph, may be NULL. + * If non-NULL, *outputs is updated to contain the list of open outputs + * after the parsing, should be freed with avfilter_inout_free(). + * @return non negative on success, a negative AVERROR code on error + */ +int avfilter_graph_parse_ptr(AVFilterGraph *graph, const char *filters, + AVFilterInOut **inputs, AVFilterInOut **outputs, + void *log_ctx); + +/** + * Add a graph described by a string to a graph. + * + * @param[in] graph the filter graph where to link the parsed graph context + * @param[in] filters string to be parsed + * @param[out] inputs a linked list of all free (unlinked) inputs of the + * parsed graph will be returned here. It is to be freed + * by the caller using avfilter_inout_free(). + * @param[out] outputs a linked list of all free (unlinked) outputs of the + * parsed graph will be returned here. It is to be freed by the + * caller using avfilter_inout_free(). + * @return zero on success, a negative AVERROR code on error + * + * @note This function returns the inputs and outputs that are left + * unlinked after parsing the graph and the caller then deals with + * them. + * @note This function makes no reference whatsoever to already + * existing parts of the graph and the inputs parameter will on return + * contain inputs of the newly parsed part of the graph. Analogously + * the outputs parameter will contain outputs of the newly created + * filters. + */ +int avfilter_graph_parse2(AVFilterGraph *graph, const char *filters, + AVFilterInOut **inputs, + AVFilterInOut **outputs); + +/** + * Send a command to one or more filter instances. + * + * @param graph the filter graph + * @param target the filter(s) to which the command should be sent + * "all" sends to all filters + * otherwise it can be a filter or filter instance name + * which will send the command to all matching filters. + * @param cmd the command to send, for handling simplicity all commands must be alphanumeric only + * @param arg the argument for the command + * @param res a buffer with size res_size where the filter(s) can return a response. + * + * @returns >=0 on success otherwise an error code. + * AVERROR(ENOSYS) on unsupported commands + */ +int avfilter_graph_send_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, char *res, int res_len, int flags); + +/** + * Queue a command for one or more filter instances. + * + * @param graph the filter graph + * @param target the filter(s) to which the command should be sent + * "all" sends to all filters + * otherwise it can be a filter or filter instance name + * which will send the command to all matching filters. + * @param cmd the command to sent, for handling simplicity all commands must be alphanumeric only + * @param arg the argument for the command + * @param ts time at which the command should be sent to the filter + * + * @note As this executes commands after this function returns, no return code + * from the filter is provided, also AVFILTER_CMD_FLAG_ONE is not supported. + */ +int avfilter_graph_queue_command(AVFilterGraph *graph, const char *target, const char *cmd, const char *arg, int flags, double ts); + + +/** + * Dump a graph into a human-readable string representation. + * + * @param graph the graph to dump + * @param options formatting options; currently ignored + * @return a string, or NULL in case of memory allocation failure; + * the string must be freed using av_free + */ +char *avfilter_graph_dump(AVFilterGraph *graph, const char *options); + +/** + * Request a frame on the oldest sink link. + * + * If the request returns AVERROR_EOF, try the next. + * + * Note that this function is not meant to be the sole scheduling mechanism + * of a filtergraph, only a convenience function to help drain a filtergraph + * in a balanced way under normal circumstances. + * + * Also note that AVERROR_EOF does not mean that frames did not arrive on + * some of the sinks during the process. + * When there are multiple sink links, in case the requested link + * returns an EOF, this may cause a filter to flush pending frames + * which are sent to another sink link, although unrequested. + * + * @return the return value of ff_request_frame(), + * or AVERROR_EOF if all links returned AVERROR_EOF + */ +int avfilter_graph_request_oldest(AVFilterGraph *graph); + +/** + * @} + */ + +#endif /* AVFILTER_AVFILTER_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavfilter/buffersink.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavfilter/buffersink.h new file mode 100644 index 0000000..2ec821c --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavfilter/buffersink.h @@ -0,0 +1,169 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVFILTER_BUFFERSINK_H +#define AVFILTER_BUFFERSINK_H + +/** + * @file + * @ingroup lavfi_buffersink + * memory buffer sink API for audio and video + */ + +#include "avfilter.h" + +/** + * @defgroup lavfi_buffersink Buffer sink API + * @ingroup lavfi + * @{ + */ + +/** + * Get a frame with filtered data from sink and put it in frame. + * + * @param ctx pointer to a buffersink or abuffersink filter context. + * @param frame pointer to an allocated frame that will be filled with data. + * The data must be freed using av_frame_unref() / av_frame_free() + * @param flags a combination of AV_BUFFERSINK_FLAG_* flags + * + * @return >= 0 in for success, a negative AVERROR code for failure. + */ +int av_buffersink_get_frame_flags(AVFilterContext *ctx, AVFrame *frame, int flags); + +/** + * Tell av_buffersink_get_buffer_ref() to read video/samples buffer + * reference, but not remove it from the buffer. This is useful if you + * need only to read a video/samples buffer, without to fetch it. + */ +#define AV_BUFFERSINK_FLAG_PEEK 1 + +/** + * Tell av_buffersink_get_buffer_ref() not to request a frame from its input. + * If a frame is already buffered, it is read (and removed from the buffer), + * but if no frame is present, return AVERROR(EAGAIN). + */ +#define AV_BUFFERSINK_FLAG_NO_REQUEST 2 + +#if FF_API_NEXT +/** + * Struct to use for initializing a buffersink context. + */ +typedef struct AVBufferSinkParams { + const enum AVPixelFormat *pixel_fmts; ///< list of allowed pixel formats, terminated by AV_PIX_FMT_NONE +} AVBufferSinkParams; + +/** + * Create an AVBufferSinkParams structure. + * + * Must be freed with av_free(). + */ +attribute_deprecated +AVBufferSinkParams *av_buffersink_params_alloc(void); + +/** + * Struct to use for initializing an abuffersink context. + */ +typedef struct AVABufferSinkParams { + const enum AVSampleFormat *sample_fmts; ///< list of allowed sample formats, terminated by AV_SAMPLE_FMT_NONE + const int64_t *channel_layouts; ///< list of allowed channel layouts, terminated by -1 + const int *channel_counts; ///< list of allowed channel counts, terminated by -1 + int all_channel_counts; ///< if not 0, accept any channel count or layout + int *sample_rates; ///< list of allowed sample rates, terminated by -1 +} AVABufferSinkParams; + +/** + * Create an AVABufferSinkParams structure. + * + * Must be freed with av_free(). + */ +attribute_deprecated +AVABufferSinkParams *av_abuffersink_params_alloc(void); +#endif + +/** + * Set the frame size for an audio buffer sink. + * + * All calls to av_buffersink_get_buffer_ref will return a buffer with + * exactly the specified number of samples, or AVERROR(EAGAIN) if there is + * not enough. The last buffer at EOF will be padded with 0. + */ +void av_buffersink_set_frame_size(AVFilterContext *ctx, unsigned frame_size); + +/** + * @defgroup lavfi_buffersink_accessors Buffer sink accessors + * Get the properties of the stream + * @{ + */ + +enum AVMediaType av_buffersink_get_type (const AVFilterContext *ctx); +AVRational av_buffersink_get_time_base (const AVFilterContext *ctx); +int av_buffersink_get_format (const AVFilterContext *ctx); + +AVRational av_buffersink_get_frame_rate (const AVFilterContext *ctx); +int av_buffersink_get_w (const AVFilterContext *ctx); +int av_buffersink_get_h (const AVFilterContext *ctx); +AVRational av_buffersink_get_sample_aspect_ratio (const AVFilterContext *ctx); + +int av_buffersink_get_channels (const AVFilterContext *ctx); +uint64_t av_buffersink_get_channel_layout (const AVFilterContext *ctx); +int av_buffersink_get_sample_rate (const AVFilterContext *ctx); + +AVBufferRef * av_buffersink_get_hw_frames_ctx (const AVFilterContext *ctx); + +/** @} */ + +/** + * Get a frame with filtered data from sink and put it in frame. + * + * @param ctx pointer to a context of a buffersink or abuffersink AVFilter. + * @param frame pointer to an allocated frame that will be filled with data. + * The data must be freed using av_frame_unref() / av_frame_free() + * + * @return + * - >= 0 if a frame was successfully returned. + * - AVERROR(EAGAIN) if no frames are available at this point; more + * input frames must be added to the filtergraph to get more output. + * - AVERROR_EOF if there will be no more output frames on this sink. + * - A different negative AVERROR code in other failure cases. + */ +int av_buffersink_get_frame(AVFilterContext *ctx, AVFrame *frame); + +/** + * Same as av_buffersink_get_frame(), but with the ability to specify the number + * of samples read. This function is less efficient than + * av_buffersink_get_frame(), because it copies the data around. + * + * @param ctx pointer to a context of the abuffersink AVFilter. + * @param frame pointer to an allocated frame that will be filled with data. + * The data must be freed using av_frame_unref() / av_frame_free() + * frame will contain exactly nb_samples audio samples, except at + * the end of stream, when it can contain less than nb_samples. + * + * @return The return codes have the same meaning as for + * av_buffersink_get_frame(). + * + * @warning do not mix this function with av_buffersink_get_frame(). Use only one or + * the other with a single sink, not both. + */ +int av_buffersink_get_samples(AVFilterContext *ctx, AVFrame *frame, int nb_samples); + +/** + * @} + */ + +#endif /* AVFILTER_BUFFERSINK_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavfilter/buffersrc.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavfilter/buffersrc.h new file mode 100644 index 0000000..08fbd18 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavfilter/buffersrc.h @@ -0,0 +1,209 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVFILTER_BUFFERSRC_H +#define AVFILTER_BUFFERSRC_H + +/** + * @file + * @ingroup lavfi_buffersrc + * Memory buffer source API. + */ + +#include "avfilter.h" + +/** + * @defgroup lavfi_buffersrc Buffer source API + * @ingroup lavfi + * @{ + */ + +enum { + + /** + * Do not check for format changes. + */ + AV_BUFFERSRC_FLAG_NO_CHECK_FORMAT = 1, + + /** + * Immediately push the frame to the output. + */ + AV_BUFFERSRC_FLAG_PUSH = 4, + + /** + * Keep a reference to the frame. + * If the frame if reference-counted, create a new reference; otherwise + * copy the frame data. + */ + AV_BUFFERSRC_FLAG_KEEP_REF = 8, + +}; + +/** + * Get the number of failed requests. + * + * A failed request is when the request_frame method is called while no + * frame is present in the buffer. + * The number is reset when a frame is added. + */ +unsigned av_buffersrc_get_nb_failed_requests(AVFilterContext *buffer_src); + +/** + * This structure contains the parameters describing the frames that will be + * passed to this filter. + * + * It should be allocated with av_buffersrc_parameters_alloc() and freed with + * av_free(). All the allocated fields in it remain owned by the caller. + */ +typedef struct AVBufferSrcParameters { + /** + * video: the pixel format, value corresponds to enum AVPixelFormat + * audio: the sample format, value corresponds to enum AVSampleFormat + */ + int format; + /** + * The timebase to be used for the timestamps on the input frames. + */ + AVRational time_base; + + /** + * Video only, the display dimensions of the input frames. + */ + int width, height; + + /** + * Video only, the sample (pixel) aspect ratio. + */ + AVRational sample_aspect_ratio; + + /** + * Video only, the frame rate of the input video. This field must only be + * set to a non-zero value if input stream has a known constant framerate + * and should be left at its initial value if the framerate is variable or + * unknown. + */ + AVRational frame_rate; + + /** + * Video with a hwaccel pixel format only. This should be a reference to an + * AVHWFramesContext instance describing the input frames. + */ + AVBufferRef *hw_frames_ctx; + + /** + * Audio only, the audio sampling rate in samples per second. + */ + int sample_rate; + + /** + * Audio only, the audio channel layout + */ + uint64_t channel_layout; +} AVBufferSrcParameters; + +/** + * Allocate a new AVBufferSrcParameters instance. It should be freed by the + * caller with av_free(). + */ +AVBufferSrcParameters *av_buffersrc_parameters_alloc(void); + +/** + * Initialize the buffersrc or abuffersrc filter with the provided parameters. + * This function may be called multiple times, the later calls override the + * previous ones. Some of the parameters may also be set through AVOptions, then + * whatever method is used last takes precedence. + * + * @param ctx an instance of the buffersrc or abuffersrc filter + * @param param the stream parameters. The frames later passed to this filter + * must conform to those parameters. All the allocated fields in + * param remain owned by the caller, libavfilter will make internal + * copies or references when necessary. + * @return 0 on success, a negative AVERROR code on failure. + */ +int av_buffersrc_parameters_set(AVFilterContext *ctx, AVBufferSrcParameters *param); + +/** + * Add a frame to the buffer source. + * + * @param ctx an instance of the buffersrc filter + * @param frame frame to be added. If the frame is reference counted, this + * function will make a new reference to it. Otherwise the frame data will be + * copied. + * + * @return 0 on success, a negative AVERROR on error + * + * This function is equivalent to av_buffersrc_add_frame_flags() with the + * AV_BUFFERSRC_FLAG_KEEP_REF flag. + */ +av_warn_unused_result +int av_buffersrc_write_frame(AVFilterContext *ctx, const AVFrame *frame); + +/** + * Add a frame to the buffer source. + * + * @param ctx an instance of the buffersrc filter + * @param frame frame to be added. If the frame is reference counted, this + * function will take ownership of the reference(s) and reset the frame. + * Otherwise the frame data will be copied. If this function returns an error, + * the input frame is not touched. + * + * @return 0 on success, a negative AVERROR on error. + * + * @note the difference between this function and av_buffersrc_write_frame() is + * that av_buffersrc_write_frame() creates a new reference to the input frame, + * while this function takes ownership of the reference passed to it. + * + * This function is equivalent to av_buffersrc_add_frame_flags() without the + * AV_BUFFERSRC_FLAG_KEEP_REF flag. + */ +av_warn_unused_result +int av_buffersrc_add_frame(AVFilterContext *ctx, AVFrame *frame); + +/** + * Add a frame to the buffer source. + * + * By default, if the frame is reference-counted, this function will take + * ownership of the reference(s) and reset the frame. This can be controlled + * using the flags. + * + * If this function returns an error, the input frame is not touched. + * + * @param buffer_src pointer to a buffer source context + * @param frame a frame, or NULL to mark EOF + * @param flags a combination of AV_BUFFERSRC_FLAG_* + * @return >= 0 in case of success, a negative AVERROR code + * in case of failure + */ +av_warn_unused_result +int av_buffersrc_add_frame_flags(AVFilterContext *buffer_src, + AVFrame *frame, int flags); + +/** + * Close the buffer source after EOF. + * + * This is similar to passing NULL to av_buffersrc_add_frame_flags() + * except it takes the timestamp of the EOF, i.e. the timestamp of the end + * of the last frame. + */ +int av_buffersrc_close(AVFilterContext *ctx, int64_t pts, unsigned flags); + +/** + * @} + */ + +#endif /* AVFILTER_BUFFERSRC_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavfilter/version.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavfilter/version.h new file mode 100644 index 0000000..96b14d6 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavfilter/version.h @@ -0,0 +1,69 @@ +/* + * Version macros. + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVFILTER_VERSION_H +#define AVFILTER_VERSION_H + +/** + * @file + * @ingroup lavfi + * Libavfilter version macros + */ + +#include "libavutil/version.h" + +#define LIBAVFILTER_VERSION_MAJOR 7 +#define LIBAVFILTER_VERSION_MINOR 85 +#define LIBAVFILTER_VERSION_MICRO 100 + + +#define LIBAVFILTER_VERSION_INT AV_VERSION_INT(LIBAVFILTER_VERSION_MAJOR, \ + LIBAVFILTER_VERSION_MINOR, \ + LIBAVFILTER_VERSION_MICRO) +#define LIBAVFILTER_VERSION AV_VERSION(LIBAVFILTER_VERSION_MAJOR, \ + LIBAVFILTER_VERSION_MINOR, \ + LIBAVFILTER_VERSION_MICRO) +#define LIBAVFILTER_BUILD LIBAVFILTER_VERSION_INT + +#define LIBAVFILTER_IDENT "Lavfi" AV_STRINGIFY(LIBAVFILTER_VERSION) + +/** + * FF_API_* defines may be placed below to indicate public API that will be + * dropped at a future version bump. The defines themselves are not part of + * the public API and may change, break or disappear at any time. + */ + +#ifndef FF_API_OLD_FILTER_OPTS_ERROR +#define FF_API_OLD_FILTER_OPTS_ERROR (LIBAVFILTER_VERSION_MAJOR < 8) +#endif +#ifndef FF_API_LAVR_OPTS +#define FF_API_LAVR_OPTS (LIBAVFILTER_VERSION_MAJOR < 8) +#endif +#ifndef FF_API_FILTER_GET_SET +#define FF_API_FILTER_GET_SET (LIBAVFILTER_VERSION_MAJOR < 8) +#endif +#ifndef FF_API_SWS_PARAM_OPTION +#define FF_API_SWS_PARAM_OPTION (LIBAVFILTER_VERSION_MAJOR < 8) +#endif +#ifndef FF_API_NEXT +#define FF_API_NEXT (LIBAVFILTER_VERSION_MAJOR < 8) +#endif + +#endif /* AVFILTER_VERSION_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavformat/avformat.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavformat/avformat.h new file mode 100644 index 0000000..21c282a --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavformat/avformat.h @@ -0,0 +1,3093 @@ +/* + * copyright (c) 2001 Fabrice Bellard + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVFORMAT_AVFORMAT_H +#define AVFORMAT_AVFORMAT_H + +/** + * @file + * @ingroup libavf + * Main libavformat public API header + */ + +/** + * @defgroup libavf libavformat + * I/O and Muxing/Demuxing Library + * + * Libavformat (lavf) is a library for dealing with various media container + * formats. Its main two purposes are demuxing - i.e. splitting a media file + * into component streams, and the reverse process of muxing - writing supplied + * data in a specified container format. It also has an @ref lavf_io + * "I/O module" which supports a number of protocols for accessing the data (e.g. + * file, tcp, http and others). + * Unless you are absolutely sure you won't use libavformat's network + * capabilities, you should also call avformat_network_init(). + * + * A supported input format is described by an AVInputFormat struct, conversely + * an output format is described by AVOutputFormat. You can iterate over all + * input/output formats using the av_demuxer_iterate / av_muxer_iterate() functions. + * The protocols layer is not part of the public API, so you can only get the names + * of supported protocols with the avio_enum_protocols() function. + * + * Main lavf structure used for both muxing and demuxing is AVFormatContext, + * which exports all information about the file being read or written. As with + * most Libavformat structures, its size is not part of public ABI, so it cannot be + * allocated on stack or directly with av_malloc(). To create an + * AVFormatContext, use avformat_alloc_context() (some functions, like + * avformat_open_input() might do that for you). + * + * Most importantly an AVFormatContext contains: + * @li the @ref AVFormatContext.iformat "input" or @ref AVFormatContext.oformat + * "output" format. It is either autodetected or set by user for input; + * always set by user for output. + * @li an @ref AVFormatContext.streams "array" of AVStreams, which describe all + * elementary streams stored in the file. AVStreams are typically referred to + * using their index in this array. + * @li an @ref AVFormatContext.pb "I/O context". It is either opened by lavf or + * set by user for input, always set by user for output (unless you are dealing + * with an AVFMT_NOFILE format). + * + * @section lavf_options Passing options to (de)muxers + * It is possible to configure lavf muxers and demuxers using the @ref avoptions + * mechanism. Generic (format-independent) libavformat options are provided by + * AVFormatContext, they can be examined from a user program by calling + * av_opt_next() / av_opt_find() on an allocated AVFormatContext (or its AVClass + * from avformat_get_class()). Private (format-specific) options are provided by + * AVFormatContext.priv_data if and only if AVInputFormat.priv_class / + * AVOutputFormat.priv_class of the corresponding format struct is non-NULL. + * Further options may be provided by the @ref AVFormatContext.pb "I/O context", + * if its AVClass is non-NULL, and the protocols layer. See the discussion on + * nesting in @ref avoptions documentation to learn how to access those. + * + * @section urls + * URL strings in libavformat are made of a scheme/protocol, a ':', and a + * scheme specific string. URLs without a scheme and ':' used for local files + * are supported but deprecated. "file:" should be used for local files. + * + * It is important that the scheme string is not taken from untrusted + * sources without checks. + * + * Note that some schemes/protocols are quite powerful, allowing access to + * both local and remote files, parts of them, concatenations of them, local + * audio and video devices and so on. + * + * @{ + * + * @defgroup lavf_decoding Demuxing + * @{ + * Demuxers read a media file and split it into chunks of data (@em packets). A + * @ref AVPacket "packet" contains one or more encoded frames which belongs to a + * single elementary stream. In the lavf API this process is represented by the + * avformat_open_input() function for opening a file, av_read_frame() for + * reading a single packet and finally avformat_close_input(), which does the + * cleanup. + * + * @section lavf_decoding_open Opening a media file + * The minimum information required to open a file is its URL, which + * is passed to avformat_open_input(), as in the following code: + * @code + * const char *url = "file:in.mp3"; + * AVFormatContext *s = NULL; + * int ret = avformat_open_input(&s, url, NULL, NULL); + * if (ret < 0) + * abort(); + * @endcode + * The above code attempts to allocate an AVFormatContext, open the + * specified file (autodetecting the format) and read the header, exporting the + * information stored there into s. Some formats do not have a header or do not + * store enough information there, so it is recommended that you call the + * avformat_find_stream_info() function which tries to read and decode a few + * frames to find missing information. + * + * In some cases you might want to preallocate an AVFormatContext yourself with + * avformat_alloc_context() and do some tweaking on it before passing it to + * avformat_open_input(). One such case is when you want to use custom functions + * for reading input data instead of lavf internal I/O layer. + * To do that, create your own AVIOContext with avio_alloc_context(), passing + * your reading callbacks to it. Then set the @em pb field of your + * AVFormatContext to newly created AVIOContext. + * + * Since the format of the opened file is in general not known until after + * avformat_open_input() has returned, it is not possible to set demuxer private + * options on a preallocated context. Instead, the options should be passed to + * avformat_open_input() wrapped in an AVDictionary: + * @code + * AVDictionary *options = NULL; + * av_dict_set(&options, "video_size", "640x480", 0); + * av_dict_set(&options, "pixel_format", "rgb24", 0); + * + * if (avformat_open_input(&s, url, NULL, &options) < 0) + * abort(); + * av_dict_free(&options); + * @endcode + * This code passes the private options 'video_size' and 'pixel_format' to the + * demuxer. They would be necessary for e.g. the rawvideo demuxer, since it + * cannot know how to interpret raw video data otherwise. If the format turns + * out to be something different than raw video, those options will not be + * recognized by the demuxer and therefore will not be applied. Such unrecognized + * options are then returned in the options dictionary (recognized options are + * consumed). The calling program can handle such unrecognized options as it + * wishes, e.g. + * @code + * AVDictionaryEntry *e; + * if (e = av_dict_get(options, "", NULL, AV_DICT_IGNORE_SUFFIX)) { + * fprintf(stderr, "Option %s not recognized by the demuxer.\n", e->key); + * abort(); + * } + * @endcode + * + * After you have finished reading the file, you must close it with + * avformat_close_input(). It will free everything associated with the file. + * + * @section lavf_decoding_read Reading from an opened file + * Reading data from an opened AVFormatContext is done by repeatedly calling + * av_read_frame() on it. Each call, if successful, will return an AVPacket + * containing encoded data for one AVStream, identified by + * AVPacket.stream_index. This packet may be passed straight into the libavcodec + * decoding functions avcodec_send_packet() or avcodec_decode_subtitle2() if the + * caller wishes to decode the data. + * + * AVPacket.pts, AVPacket.dts and AVPacket.duration timing information will be + * set if known. They may also be unset (i.e. AV_NOPTS_VALUE for + * pts/dts, 0 for duration) if the stream does not provide them. The timing + * information will be in AVStream.time_base units, i.e. it has to be + * multiplied by the timebase to convert them to seconds. + * + * A packet returned by av_read_frame() is always reference-counted, + * i.e. AVPacket.buf is set and the user may keep it indefinitely. + * The packet must be freed with av_packet_unref() when it is no + * longer needed. + * + * @section lavf_decoding_seek Seeking + * @} + * + * @defgroup lavf_encoding Muxing + * @{ + * Muxers take encoded data in the form of @ref AVPacket "AVPackets" and write + * it into files or other output bytestreams in the specified container format. + * + * The main API functions for muxing are avformat_write_header() for writing the + * file header, av_write_frame() / av_interleaved_write_frame() for writing the + * packets and av_write_trailer() for finalizing the file. + * + * At the beginning of the muxing process, the caller must first call + * avformat_alloc_context() to create a muxing context. The caller then sets up + * the muxer by filling the various fields in this context: + * + * - The @ref AVFormatContext.oformat "oformat" field must be set to select the + * muxer that will be used. + * - Unless the format is of the AVFMT_NOFILE type, the @ref AVFormatContext.pb + * "pb" field must be set to an opened IO context, either returned from + * avio_open2() or a custom one. + * - Unless the format is of the AVFMT_NOSTREAMS type, at least one stream must + * be created with the avformat_new_stream() function. The caller should fill + * the @ref AVStream.codecpar "stream codec parameters" information, such as the + * codec @ref AVCodecParameters.codec_type "type", @ref AVCodecParameters.codec_id + * "id" and other parameters (e.g. width / height, the pixel or sample format, + * etc.) as known. The @ref AVStream.time_base "stream timebase" should + * be set to the timebase that the caller desires to use for this stream (note + * that the timebase actually used by the muxer can be different, as will be + * described later). + * - It is advised to manually initialize only the relevant fields in + * AVCodecParameters, rather than using @ref avcodec_parameters_copy() during + * remuxing: there is no guarantee that the codec context values remain valid + * for both input and output format contexts. + * - The caller may fill in additional information, such as @ref + * AVFormatContext.metadata "global" or @ref AVStream.metadata "per-stream" + * metadata, @ref AVFormatContext.chapters "chapters", @ref + * AVFormatContext.programs "programs", etc. as described in the + * AVFormatContext documentation. Whether such information will actually be + * stored in the output depends on what the container format and the muxer + * support. + * + * When the muxing context is fully set up, the caller must call + * avformat_write_header() to initialize the muxer internals and write the file + * header. Whether anything actually is written to the IO context at this step + * depends on the muxer, but this function must always be called. Any muxer + * private options must be passed in the options parameter to this function. + * + * The data is then sent to the muxer by repeatedly calling av_write_frame() or + * av_interleaved_write_frame() (consult those functions' documentation for + * discussion on the difference between them; only one of them may be used with + * a single muxing context, they should not be mixed). Do note that the timing + * information on the packets sent to the muxer must be in the corresponding + * AVStream's timebase. That timebase is set by the muxer (in the + * avformat_write_header() step) and may be different from the timebase + * requested by the caller. + * + * Once all the data has been written, the caller must call av_write_trailer() + * to flush any buffered packets and finalize the output file, then close the IO + * context (if any) and finally free the muxing context with + * avformat_free_context(). + * @} + * + * @defgroup lavf_io I/O Read/Write + * @{ + * @section lavf_io_dirlist Directory listing + * The directory listing API makes it possible to list files on remote servers. + * + * Some of possible use cases: + * - an "open file" dialog to choose files from a remote location, + * - a recursive media finder providing a player with an ability to play all + * files from a given directory. + * + * @subsection lavf_io_dirlist_open Opening a directory + * At first, a directory needs to be opened by calling avio_open_dir() + * supplied with a URL and, optionally, ::AVDictionary containing + * protocol-specific parameters. The function returns zero or positive + * integer and allocates AVIODirContext on success. + * + * @code + * AVIODirContext *ctx = NULL; + * if (avio_open_dir(&ctx, "smb://example.com/some_dir", NULL) < 0) { + * fprintf(stderr, "Cannot open directory.\n"); + * abort(); + * } + * @endcode + * + * This code tries to open a sample directory using smb protocol without + * any additional parameters. + * + * @subsection lavf_io_dirlist_read Reading entries + * Each directory's entry (i.e. file, another directory, anything else + * within ::AVIODirEntryType) is represented by AVIODirEntry. + * Reading consecutive entries from an opened AVIODirContext is done by + * repeatedly calling avio_read_dir() on it. Each call returns zero or + * positive integer if successful. Reading can be stopped right after the + * NULL entry has been read -- it means there are no entries left to be + * read. The following code reads all entries from a directory associated + * with ctx and prints their names to standard output. + * @code + * AVIODirEntry *entry = NULL; + * for (;;) { + * if (avio_read_dir(ctx, &entry) < 0) { + * fprintf(stderr, "Cannot list directory.\n"); + * abort(); + * } + * if (!entry) + * break; + * printf("%s\n", entry->name); + * avio_free_directory_entry(&entry); + * } + * @endcode + * @} + * + * @defgroup lavf_codec Demuxers + * @{ + * @defgroup lavf_codec_native Native Demuxers + * @{ + * @} + * @defgroup lavf_codec_wrappers External library wrappers + * @{ + * @} + * @} + * @defgroup lavf_protos I/O Protocols + * @{ + * @} + * @defgroup lavf_internal Internal + * @{ + * @} + * @} + */ + +#include +#include /* FILE */ +#include "libavcodec/avcodec.h" +#include "libavutil/dict.h" +#include "libavutil/log.h" + +#include "avio.h" +#include "libavformat/version.h" + +struct AVFormatContext; + +struct AVDeviceInfoList; +struct AVDeviceCapabilitiesQuery; + +/** + * @defgroup metadata_api Public Metadata API + * @{ + * @ingroup libavf + * The metadata API allows libavformat to export metadata tags to a client + * application when demuxing. Conversely it allows a client application to + * set metadata when muxing. + * + * Metadata is exported or set as pairs of key/value strings in the 'metadata' + * fields of the AVFormatContext, AVStream, AVChapter and AVProgram structs + * using the @ref lavu_dict "AVDictionary" API. Like all strings in FFmpeg, + * metadata is assumed to be UTF-8 encoded Unicode. Note that metadata + * exported by demuxers isn't checked to be valid UTF-8 in most cases. + * + * Important concepts to keep in mind: + * - Keys are unique; there can never be 2 tags with the same key. This is + * also meant semantically, i.e., a demuxer should not knowingly produce + * several keys that are literally different but semantically identical. + * E.g., key=Author5, key=Author6. In this example, all authors must be + * placed in the same tag. + * - Metadata is flat, not hierarchical; there are no subtags. If you + * want to store, e.g., the email address of the child of producer Alice + * and actor Bob, that could have key=alice_and_bobs_childs_email_address. + * - Several modifiers can be applied to the tag name. This is done by + * appending a dash character ('-') and the modifier name in the order + * they appear in the list below -- e.g. foo-eng-sort, not foo-sort-eng. + * - language -- a tag whose value is localized for a particular language + * is appended with the ISO 639-2/B 3-letter language code. + * For example: Author-ger=Michael, Author-eng=Mike + * The original/default language is in the unqualified "Author" tag. + * A demuxer should set a default if it sets any translated tag. + * - sorting -- a modified version of a tag that should be used for + * sorting will have '-sort' appended. E.g. artist="The Beatles", + * artist-sort="Beatles, The". + * - Some protocols and demuxers support metadata updates. After a successful + * call to av_read_packet(), AVFormatContext.event_flags or AVStream.event_flags + * will be updated to indicate if metadata changed. In order to detect metadata + * changes on a stream, you need to loop through all streams in the AVFormatContext + * and check their individual event_flags. + * + * - Demuxers attempt to export metadata in a generic format, however tags + * with no generic equivalents are left as they are stored in the container. + * Follows a list of generic tag names: + * + @verbatim + album -- name of the set this work belongs to + album_artist -- main creator of the set/album, if different from artist. + e.g. "Various Artists" for compilation albums. + artist -- main creator of the work + comment -- any additional description of the file. + composer -- who composed the work, if different from artist. + copyright -- name of copyright holder. + creation_time-- date when the file was created, preferably in ISO 8601. + date -- date when the work was created, preferably in ISO 8601. + disc -- number of a subset, e.g. disc in a multi-disc collection. + encoder -- name/settings of the software/hardware that produced the file. + encoded_by -- person/group who created the file. + filename -- original name of the file. + genre -- . + language -- main language in which the work is performed, preferably + in ISO 639-2 format. Multiple languages can be specified by + separating them with commas. + performer -- artist who performed the work, if different from artist. + E.g for "Also sprach Zarathustra", artist would be "Richard + Strauss" and performer "London Philharmonic Orchestra". + publisher -- name of the label/publisher. + service_name -- name of the service in broadcasting (channel name). + service_provider -- name of the service provider in broadcasting. + title -- name of the work. + track -- number of this work in the set, can be in form current/total. + variant_bitrate -- the total bitrate of the bitrate variant that the current stream is part of + @endverbatim + * + * Look in the examples section for an application example how to use the Metadata API. + * + * @} + */ + +/* packet functions */ + + +/** + * Allocate and read the payload of a packet and initialize its + * fields with default values. + * + * @param s associated IO context + * @param pkt packet + * @param size desired payload size + * @return >0 (read size) if OK, AVERROR_xxx otherwise + */ +int av_get_packet(AVIOContext *s, AVPacket *pkt, int size); + + +/** + * Read data and append it to the current content of the AVPacket. + * If pkt->size is 0 this is identical to av_get_packet. + * Note that this uses av_grow_packet and thus involves a realloc + * which is inefficient. Thus this function should only be used + * when there is no reasonable way to know (an upper bound of) + * the final size. + * + * @param s associated IO context + * @param pkt packet + * @param size amount of data to read + * @return >0 (read size) if OK, AVERROR_xxx otherwise, previous data + * will not be lost even if an error occurs. + */ +int av_append_packet(AVIOContext *s, AVPacket *pkt, int size); + +/*************************************************/ +/* input/output formats */ + +struct AVCodecTag; + +/** + * This structure contains the data a format has to probe a file. + */ +typedef struct AVProbeData { + const char *filename; + unsigned char *buf; /**< Buffer must have AVPROBE_PADDING_SIZE of extra allocated bytes filled with zero. */ + int buf_size; /**< Size of buf except extra allocated bytes */ + const char *mime_type; /**< mime_type, when known. */ +} AVProbeData; + +#define AVPROBE_SCORE_RETRY (AVPROBE_SCORE_MAX/4) +#define AVPROBE_SCORE_STREAM_RETRY (AVPROBE_SCORE_MAX/4-1) + +#define AVPROBE_SCORE_EXTENSION 50 ///< score for file extension +#define AVPROBE_SCORE_MIME 75 ///< score for file mime type +#define AVPROBE_SCORE_MAX 100 ///< maximum score + +#define AVPROBE_PADDING_SIZE 32 ///< extra allocated bytes at the end of the probe buffer + +/// Demuxer will use avio_open, no opened file should be provided by the caller. +#define AVFMT_NOFILE 0x0001 +#define AVFMT_NEEDNUMBER 0x0002 /**< Needs '%d' in filename. */ +#define AVFMT_SHOW_IDS 0x0008 /**< Show format stream IDs numbers. */ +#define AVFMT_GLOBALHEADER 0x0040 /**< Format wants global header. */ +#define AVFMT_NOTIMESTAMPS 0x0080 /**< Format does not need / have any timestamps. */ +#define AVFMT_GENERIC_INDEX 0x0100 /**< Use generic index building code. */ +#define AVFMT_TS_DISCONT 0x0200 /**< Format allows timestamp discontinuities. Note, muxers always require valid (monotone) timestamps */ +#define AVFMT_VARIABLE_FPS 0x0400 /**< Format allows variable fps. */ +#define AVFMT_NODIMENSIONS 0x0800 /**< Format does not need width/height */ +#define AVFMT_NOSTREAMS 0x1000 /**< Format does not require any streams */ +#define AVFMT_NOBINSEARCH 0x2000 /**< Format does not allow to fall back on binary search via read_timestamp */ +#define AVFMT_NOGENSEARCH 0x4000 /**< Format does not allow to fall back on generic search */ +#define AVFMT_NO_BYTE_SEEK 0x8000 /**< Format does not allow seeking by bytes */ +#define AVFMT_ALLOW_FLUSH 0x10000 /**< Format allows flushing. If not set, the muxer will not receive a NULL packet in the write_packet function. */ +#define AVFMT_TS_NONSTRICT 0x20000 /**< Format does not require strictly + increasing timestamps, but they must + still be monotonic */ +#define AVFMT_TS_NEGATIVE 0x40000 /**< Format allows muxing negative + timestamps. If not set the timestamp + will be shifted in av_write_frame and + av_interleaved_write_frame so they + start from 0. + The user or muxer can override this through + AVFormatContext.avoid_negative_ts + */ + +#define AVFMT_SEEK_TO_PTS 0x4000000 /**< Seeking is based on PTS */ + +/** + * @addtogroup lavf_encoding + * @{ + */ +typedef struct AVOutputFormat { + const char *name; + /** + * Descriptive name for the format, meant to be more human-readable + * than name. You should use the NULL_IF_CONFIG_SMALL() macro + * to define it. + */ + const char *long_name; + const char *mime_type; + const char *extensions; /**< comma-separated filename extensions */ + /* output support */ + enum AVCodecID audio_codec; /**< default audio codec */ + enum AVCodecID video_codec; /**< default video codec */ + enum AVCodecID subtitle_codec; /**< default subtitle codec */ + /** + * can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, + * AVFMT_GLOBALHEADER, AVFMT_NOTIMESTAMPS, AVFMT_VARIABLE_FPS, + * AVFMT_NODIMENSIONS, AVFMT_NOSTREAMS, AVFMT_ALLOW_FLUSH, + * AVFMT_TS_NONSTRICT, AVFMT_TS_NEGATIVE + */ + int flags; + + /** + * List of supported codec_id-codec_tag pairs, ordered by "better + * choice first". The arrays are all terminated by AV_CODEC_ID_NONE. + */ + const struct AVCodecTag * const *codec_tag; + + + const AVClass *priv_class; ///< AVClass for the private context + + /***************************************************************** + * No fields below this line are part of the public API. They + * may not be used outside of libavformat and can be changed and + * removed at will. + * New public fields should be added right above. + ***************************************************************** + */ + /** + * The ff_const59 define is not part of the public API and will + * be removed without further warning. + */ +#if FF_API_AVIOFORMAT +#define ff_const59 +#else +#define ff_const59 const +#endif + ff_const59 struct AVOutputFormat *next; + /** + * size of private data so that it can be allocated in the wrapper + */ + int priv_data_size; + + int (*write_header)(struct AVFormatContext *); + /** + * Write a packet. If AVFMT_ALLOW_FLUSH is set in flags, + * pkt can be NULL in order to flush data buffered in the muxer. + * When flushing, return 0 if there still is more data to flush, + * or 1 if everything was flushed and there is no more buffered + * data. + */ + int (*write_packet)(struct AVFormatContext *, AVPacket *pkt); + int (*write_trailer)(struct AVFormatContext *); + /** + * A format-specific function for interleavement. + * If unset, packets will be interleaved by dts. + */ + int (*interleave_packet)(struct AVFormatContext *, AVPacket *out, + AVPacket *in, int flush); + /** + * Test if the given codec can be stored in this container. + * + * @return 1 if the codec is supported, 0 if it is not. + * A negative number if unknown. + * MKTAG('A', 'P', 'I', 'C') if the codec is only supported as AV_DISPOSITION_ATTACHED_PIC + */ + int (*query_codec)(enum AVCodecID id, int std_compliance); + + void (*get_output_timestamp)(struct AVFormatContext *s, int stream, + int64_t *dts, int64_t *wall); + /** + * Allows sending messages from application to device. + */ + int (*control_message)(struct AVFormatContext *s, int type, + void *data, size_t data_size); + + /** + * Write an uncoded AVFrame. + * + * See av_write_uncoded_frame() for details. + * + * The library will free *frame afterwards, but the muxer can prevent it + * by setting the pointer to NULL. + */ + int (*write_uncoded_frame)(struct AVFormatContext *, int stream_index, + AVFrame **frame, unsigned flags); + /** + * Returns device list with it properties. + * @see avdevice_list_devices() for more details. + */ + int (*get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list); + /** + * Initialize device capabilities submodule. + * @see avdevice_capabilities_create() for more details. + */ + int (*create_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps); + /** + * Free device capabilities submodule. + * @see avdevice_capabilities_free() for more details. + */ + int (*free_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps); + enum AVCodecID data_codec; /**< default data codec */ + /** + * Initialize format. May allocate data here, and set any AVFormatContext or + * AVStream parameters that need to be set before packets are sent. + * This method must not write output. + * + * Return 0 if streams were fully configured, 1 if not, negative AVERROR on failure + * + * Any allocations made here must be freed in deinit(). + */ + int (*init)(struct AVFormatContext *); + /** + * Deinitialize format. If present, this is called whenever the muxer is being + * destroyed, regardless of whether or not the header has been written. + * + * If a trailer is being written, this is called after write_trailer(). + * + * This is called if init() fails as well. + */ + void (*deinit)(struct AVFormatContext *); + /** + * Set up any necessary bitstream filtering and extract any extra data needed + * for the global header. + * Return 0 if more packets from this stream must be checked; 1 if not. + */ + int (*check_bitstream)(struct AVFormatContext *, const AVPacket *pkt); +} AVOutputFormat; +/** + * @} + */ + +/** + * @addtogroup lavf_decoding + * @{ + */ +typedef struct AVInputFormat { + /** + * A comma separated list of short names for the format. New names + * may be appended with a minor bump. + */ + const char *name; + + /** + * Descriptive name for the format, meant to be more human-readable + * than name. You should use the NULL_IF_CONFIG_SMALL() macro + * to define it. + */ + const char *long_name; + + /** + * Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS, + * AVFMT_NOTIMESTAMPS, AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH, + * AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK, AVFMT_SEEK_TO_PTS. + */ + int flags; + + /** + * If extensions are defined, then no probe is done. You should + * usually not use extension format guessing because it is not + * reliable enough + */ + const char *extensions; + + const struct AVCodecTag * const *codec_tag; + + const AVClass *priv_class; ///< AVClass for the private context + + /** + * Comma-separated list of mime types. + * It is used check for matching mime types while probing. + * @see av_probe_input_format2 + */ + const char *mime_type; + + /***************************************************************** + * No fields below this line are part of the public API. They + * may not be used outside of libavformat and can be changed and + * removed at will. + * New public fields should be added right above. + ***************************************************************** + */ + ff_const59 struct AVInputFormat *next; + + /** + * Raw demuxers store their codec ID here. + */ + int raw_codec_id; + + /** + * Size of private data so that it can be allocated in the wrapper. + */ + int priv_data_size; + + /** + * Tell if a given file has a chance of being parsed as this format. + * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes + * big so you do not have to check for that unless you need more. + */ + int (*read_probe)(const AVProbeData *); + + /** + * Read the format header and initialize the AVFormatContext + * structure. Return 0 if OK. 'avformat_new_stream' should be + * called to create new streams. + */ + int (*read_header)(struct AVFormatContext *); + + /** + * Read one packet and put it in 'pkt'. pts and flags are also + * set. 'avformat_new_stream' can be called only if the flag + * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a + * background thread). + * @return 0 on success, < 0 on error. + * Upon returning an error, pkt must be unreferenced by the caller. + */ + int (*read_packet)(struct AVFormatContext *, AVPacket *pkt); + + /** + * Close the stream. The AVFormatContext and AVStreams are not + * freed by this function + */ + int (*read_close)(struct AVFormatContext *); + + /** + * Seek to a given timestamp relative to the frames in + * stream component stream_index. + * @param stream_index Must not be -1. + * @param flags Selects which direction should be preferred if no exact + * match is available. + * @return >= 0 on success (but not necessarily the new offset) + */ + int (*read_seek)(struct AVFormatContext *, + int stream_index, int64_t timestamp, int flags); + + /** + * Get the next timestamp in stream[stream_index].time_base units. + * @return the timestamp or AV_NOPTS_VALUE if an error occurred + */ + int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index, + int64_t *pos, int64_t pos_limit); + + /** + * Start/resume playing - only meaningful if using a network-based format + * (RTSP). + */ + int (*read_play)(struct AVFormatContext *); + + /** + * Pause playing - only meaningful if using a network-based format + * (RTSP). + */ + int (*read_pause)(struct AVFormatContext *); + + /** + * Seek to timestamp ts. + * Seeking will be done so that the point from which all active streams + * can be presented successfully will be closest to ts and within min/max_ts. + * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL. + */ + int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags); + + /** + * Returns device list with it properties. + * @see avdevice_list_devices() for more details. + */ + int (*get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list); + + /** + * Initialize device capabilities submodule. + * @see avdevice_capabilities_create() for more details. + */ + int (*create_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps); + + /** + * Free device capabilities submodule. + * @see avdevice_capabilities_free() for more details. + */ + int (*free_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps); +} AVInputFormat; +/** + * @} + */ + +enum AVStreamParseType { + AVSTREAM_PARSE_NONE, + AVSTREAM_PARSE_FULL, /**< full parsing and repack */ + AVSTREAM_PARSE_HEADERS, /**< Only parse headers, do not repack. */ + AVSTREAM_PARSE_TIMESTAMPS, /**< full parsing and interpolation of timestamps for frames not starting on a packet boundary */ + AVSTREAM_PARSE_FULL_ONCE, /**< full parsing and repack of the first frame only, only implemented for H.264 currently */ + AVSTREAM_PARSE_FULL_RAW, /**< full parsing and repack with timestamp and position generation by parser for raw + this assumes that each packet in the file contains no demuxer level headers and + just codec level data, otherwise position generation would fail */ +}; + +typedef struct AVIndexEntry { + int64_t pos; + int64_t timestamp; /**< + * Timestamp in AVStream.time_base units, preferably the time from which on correctly decoded frames are available + * when seeking to this entry. That means preferable PTS on keyframe based formats. + * But demuxers can choose to store a different timestamp, if it is more convenient for the implementation or nothing better + * is known + */ +#define AVINDEX_KEYFRAME 0x0001 +#define AVINDEX_DISCARD_FRAME 0x0002 /** + * Flag is used to indicate which frame should be discarded after decoding. + */ + int flags:2; + int size:30; //Yeah, trying to keep the size of this small to reduce memory requirements (it is 24 vs. 32 bytes due to possible 8-byte alignment). + int min_distance; /**< Minimum distance between this and the previous keyframe, used to avoid unneeded searching. */ +} AVIndexEntry; + +#define AV_DISPOSITION_DEFAULT 0x0001 +#define AV_DISPOSITION_DUB 0x0002 +#define AV_DISPOSITION_ORIGINAL 0x0004 +#define AV_DISPOSITION_COMMENT 0x0008 +#define AV_DISPOSITION_LYRICS 0x0010 +#define AV_DISPOSITION_KARAOKE 0x0020 + +/** + * Track should be used during playback by default. + * Useful for subtitle track that should be displayed + * even when user did not explicitly ask for subtitles. + */ +#define AV_DISPOSITION_FORCED 0x0040 +#define AV_DISPOSITION_HEARING_IMPAIRED 0x0080 /**< stream for hearing impaired audiences */ +#define AV_DISPOSITION_VISUAL_IMPAIRED 0x0100 /**< stream for visual impaired audiences */ +#define AV_DISPOSITION_CLEAN_EFFECTS 0x0200 /**< stream without voice */ +/** + * The stream is stored in the file as an attached picture/"cover art" (e.g. + * APIC frame in ID3v2). The first (usually only) packet associated with it + * will be returned among the first few packets read from the file unless + * seeking takes place. It can also be accessed at any time in + * AVStream.attached_pic. + */ +#define AV_DISPOSITION_ATTACHED_PIC 0x0400 +/** + * The stream is sparse, and contains thumbnail images, often corresponding + * to chapter markers. Only ever used with AV_DISPOSITION_ATTACHED_PIC. + */ +#define AV_DISPOSITION_TIMED_THUMBNAILS 0x0800 + +typedef struct AVStreamInternal AVStreamInternal; + +/** + * To specify text track kind (different from subtitles default). + */ +#define AV_DISPOSITION_CAPTIONS 0x10000 +#define AV_DISPOSITION_DESCRIPTIONS 0x20000 +#define AV_DISPOSITION_METADATA 0x40000 +#define AV_DISPOSITION_DEPENDENT 0x80000 ///< dependent audio stream (mix_type=0 in mpegts) +#define AV_DISPOSITION_STILL_IMAGE 0x100000 ///< still images in video stream (still_picture_flag=1 in mpegts) + +/** + * Options for behavior on timestamp wrap detection. + */ +#define AV_PTS_WRAP_IGNORE 0 ///< ignore the wrap +#define AV_PTS_WRAP_ADD_OFFSET 1 ///< add the format specific offset on wrap detection +#define AV_PTS_WRAP_SUB_OFFSET -1 ///< subtract the format specific offset on wrap detection + +/** + * Stream structure. + * New fields can be added to the end with minor version bumps. + * Removal, reordering and changes to existing fields require a major + * version bump. + * sizeof(AVStream) must not be used outside libav*. + */ +typedef struct AVStream { + int index; /**< stream index in AVFormatContext */ + /** + * Format-specific stream ID. + * decoding: set by libavformat + * encoding: set by the user, replaced by libavformat if left unset + */ + int id; +#if FF_API_LAVF_AVCTX + /** + * @deprecated use the codecpar struct instead + */ + attribute_deprecated + AVCodecContext *codec; +#endif + void *priv_data; + + /** + * This is the fundamental unit of time (in seconds) in terms + * of which frame timestamps are represented. + * + * decoding: set by libavformat + * encoding: May be set by the caller before avformat_write_header() to + * provide a hint to the muxer about the desired timebase. In + * avformat_write_header(), the muxer will overwrite this field + * with the timebase that will actually be used for the timestamps + * written into the file (which may or may not be related to the + * user-provided one, depending on the format). + */ + AVRational time_base; + + /** + * Decoding: pts of the first frame of the stream in presentation order, in stream time base. + * Only set this if you are absolutely 100% sure that the value you set + * it to really is the pts of the first frame. + * This may be undefined (AV_NOPTS_VALUE). + * @note The ASF header does NOT contain a correct start_time the ASF + * demuxer must NOT set this. + */ + int64_t start_time; + + /** + * Decoding: duration of the stream, in stream time base. + * If a source file does not specify a duration, but does specify + * a bitrate, this value will be estimated from bitrate and file size. + * + * Encoding: May be set by the caller before avformat_write_header() to + * provide a hint to the muxer about the estimated duration. + */ + int64_t duration; + + int64_t nb_frames; ///< number of frames in this stream if known or 0 + + int disposition; /**< AV_DISPOSITION_* bit field */ + + enum AVDiscard discard; ///< Selects which packets can be discarded at will and do not need to be demuxed. + + /** + * sample aspect ratio (0 if unknown) + * - encoding: Set by user. + * - decoding: Set by libavformat. + */ + AVRational sample_aspect_ratio; + + AVDictionary *metadata; + + /** + * Average framerate + * + * - demuxing: May be set by libavformat when creating the stream or in + * avformat_find_stream_info(). + * - muxing: May be set by the caller before avformat_write_header(). + */ + AVRational avg_frame_rate; + + /** + * For streams with AV_DISPOSITION_ATTACHED_PIC disposition, this packet + * will contain the attached picture. + * + * decoding: set by libavformat, must not be modified by the caller. + * encoding: unused + */ + AVPacket attached_pic; + + /** + * An array of side data that applies to the whole stream (i.e. the + * container does not allow it to change between packets). + * + * There may be no overlap between the side data in this array and side data + * in the packets. I.e. a given side data is either exported by the muxer + * (demuxing) / set by the caller (muxing) in this array, then it never + * appears in the packets, or the side data is exported / sent through + * the packets (always in the first packet where the value becomes known or + * changes), then it does not appear in this array. + * + * - demuxing: Set by libavformat when the stream is created. + * - muxing: May be set by the caller before avformat_write_header(). + * + * Freed by libavformat in avformat_free_context(). + * + * @see av_format_inject_global_side_data() + */ + AVPacketSideData *side_data; + /** + * The number of elements in the AVStream.side_data array. + */ + int nb_side_data; + + /** + * Flags for the user to detect events happening on the stream. Flags must + * be cleared by the user once the event has been handled. + * A combination of AVSTREAM_EVENT_FLAG_*. + */ + int event_flags; +#define AVSTREAM_EVENT_FLAG_METADATA_UPDATED 0x0001 ///< The call resulted in updated metadata. + + /** + * Real base framerate of the stream. + * This is the lowest framerate with which all timestamps can be + * represented accurately (it is the least common multiple of all + * framerates in the stream). Note, this value is just a guess! + * For example, if the time base is 1/90000 and all frames have either + * approximately 3600 or 1800 timer ticks, then r_frame_rate will be 50/1. + */ + AVRational r_frame_rate; + +#if FF_API_LAVF_FFSERVER + /** + * String containing pairs of key and values describing recommended encoder configuration. + * Pairs are separated by ','. + * Keys are separated from values by '='. + * + * @deprecated unused + */ + attribute_deprecated + char *recommended_encoder_configuration; +#endif + + /** + * Codec parameters associated with this stream. Allocated and freed by + * libavformat in avformat_new_stream() and avformat_free_context() + * respectively. + * + * - demuxing: filled by libavformat on stream creation or in + * avformat_find_stream_info() + * - muxing: filled by the caller before avformat_write_header() + */ + AVCodecParameters *codecpar; + + /***************************************************************** + * All fields below this line are not part of the public API. They + * may not be used outside of libavformat and can be changed and + * removed at will. + * Internal note: be aware that physically removing these fields + * will break ABI. Replace removed fields with dummy fields, and + * add new fields to AVStreamInternal. + ***************************************************************** + */ + +#define MAX_STD_TIMEBASES (30*12+30+3+6) + /** + * Stream information used internally by avformat_find_stream_info() + */ + struct { + int64_t last_dts; + int64_t duration_gcd; + int duration_count; + int64_t rfps_duration_sum; + double (*duration_error)[2][MAX_STD_TIMEBASES]; + int64_t codec_info_duration; + int64_t codec_info_duration_fields; + int frame_delay_evidence; + + /** + * 0 -> decoder has not been searched for yet. + * >0 -> decoder found + * <0 -> decoder with codec_id == -found_decoder has not been found + */ + int found_decoder; + + int64_t last_duration; + + /** + * Those are used for average framerate estimation. + */ + int64_t fps_first_dts; + int fps_first_dts_idx; + int64_t fps_last_dts; + int fps_last_dts_idx; + + } *info; + + int pts_wrap_bits; /**< number of bits in pts (used for wrapping control) */ + + // Timestamp generation support: + /** + * Timestamp corresponding to the last dts sync point. + * + * Initialized when AVCodecParserContext.dts_sync_point >= 0 and + * a DTS is received from the underlying container. Otherwise set to + * AV_NOPTS_VALUE by default. + */ + int64_t first_dts; + int64_t cur_dts; + int64_t last_IP_pts; + int last_IP_duration; + + /** + * Number of packets to buffer for codec probing + */ + int probe_packets; + + /** + * Number of frames that have been demuxed during avformat_find_stream_info() + */ + int codec_info_nb_frames; + + /* av_read_frame() support */ + enum AVStreamParseType need_parsing; + struct AVCodecParserContext *parser; + + /** + * last packet in packet_buffer for this stream when muxing. + */ + struct AVPacketList *last_in_packet_buffer; + AVProbeData probe_data; +#define MAX_REORDER_DELAY 16 + int64_t pts_buffer[MAX_REORDER_DELAY+1]; + + AVIndexEntry *index_entries; /**< Only used if the format does not + support seeking natively. */ + int nb_index_entries; + unsigned int index_entries_allocated_size; + + /** + * Stream Identifier + * This is the MPEG-TS stream identifier +1 + * 0 means unknown + */ + int stream_identifier; + + /** + * Details of the MPEG-TS program which created this stream. + */ + int program_num; + int pmt_version; + int pmt_stream_idx; + + int64_t interleaver_chunk_size; + int64_t interleaver_chunk_duration; + + /** + * stream probing state + * -1 -> probing finished + * 0 -> no probing requested + * rest -> perform probing with request_probe being the minimum score to accept. + */ + int request_probe; + /** + * Indicates that everything up to the next keyframe + * should be discarded. + */ + int skip_to_keyframe; + + /** + * Number of samples to skip at the start of the frame decoded from the next packet. + */ + int skip_samples; + + /** + * If not 0, the number of samples that should be skipped from the start of + * the stream (the samples are removed from packets with pts==0, which also + * assumes negative timestamps do not happen). + * Intended for use with formats such as mp3 with ad-hoc gapless audio + * support. + */ + int64_t start_skip_samples; + + /** + * If not 0, the first audio sample that should be discarded from the stream. + * This is broken by design (needs global sample count), but can't be + * avoided for broken by design formats such as mp3 with ad-hoc gapless + * audio support. + */ + int64_t first_discard_sample; + + /** + * The sample after last sample that is intended to be discarded after + * first_discard_sample. Works on frame boundaries only. Used to prevent + * early EOF if the gapless info is broken (considered concatenated mp3s). + */ + int64_t last_discard_sample; + + /** + * Number of internally decoded frames, used internally in libavformat, do not access + * its lifetime differs from info which is why it is not in that structure. + */ + int nb_decoded_frames; + + /** + * Timestamp offset added to timestamps before muxing + */ + int64_t mux_ts_offset; + + /** + * Internal data to check for wrapping of the time stamp + */ + int64_t pts_wrap_reference; + + /** + * Options for behavior, when a wrap is detected. + * + * Defined by AV_PTS_WRAP_ values. + * + * If correction is enabled, there are two possibilities: + * If the first time stamp is near the wrap point, the wrap offset + * will be subtracted, which will create negative time stamps. + * Otherwise the offset will be added. + */ + int pts_wrap_behavior; + + /** + * Internal data to prevent doing update_initial_durations() twice + */ + int update_initial_durations_done; + + /** + * Internal data to generate dts from pts + */ + int64_t pts_reorder_error[MAX_REORDER_DELAY+1]; + uint8_t pts_reorder_error_count[MAX_REORDER_DELAY+1]; + + /** + * Internal data to analyze DTS and detect faulty mpeg streams + */ + int64_t last_dts_for_order_check; + uint8_t dts_ordered; + uint8_t dts_misordered; + + /** + * Internal data to inject global side data + */ + int inject_global_side_data; + + /** + * display aspect ratio (0 if unknown) + * - encoding: unused + * - decoding: Set by libavformat to calculate sample_aspect_ratio internally + */ + AVRational display_aspect_ratio; + + /** + * An opaque field for libavformat internal usage. + * Must not be accessed in any way by callers. + */ + AVStreamInternal *internal; +} AVStream; + +#if FF_API_FORMAT_GET_SET +/** + * Accessors for some AVStream fields. These used to be provided for ABI + * compatibility, and do not need to be used anymore. + */ +attribute_deprecated +AVRational av_stream_get_r_frame_rate(const AVStream *s); +attribute_deprecated +void av_stream_set_r_frame_rate(AVStream *s, AVRational r); +#if FF_API_LAVF_FFSERVER +attribute_deprecated +char* av_stream_get_recommended_encoder_configuration(const AVStream *s); +attribute_deprecated +void av_stream_set_recommended_encoder_configuration(AVStream *s, char *configuration); +#endif +#endif + +struct AVCodecParserContext *av_stream_get_parser(const AVStream *s); + +/** + * Returns the pts of the last muxed packet + its duration + * + * the retuned value is undefined when used with a demuxer. + */ +int64_t av_stream_get_end_pts(const AVStream *st); + +#define AV_PROGRAM_RUNNING 1 + +/** + * New fields can be added to the end with minor version bumps. + * Removal, reordering and changes to existing fields require a major + * version bump. + * sizeof(AVProgram) must not be used outside libav*. + */ +typedef struct AVProgram { + int id; + int flags; + enum AVDiscard discard; ///< selects which program to discard and which to feed to the caller + unsigned int *stream_index; + unsigned int nb_stream_indexes; + AVDictionary *metadata; + + int program_num; + int pmt_pid; + int pcr_pid; + int pmt_version; + + /***************************************************************** + * All fields below this line are not part of the public API. They + * may not be used outside of libavformat and can be changed and + * removed at will. + * New public fields should be added right above. + ***************************************************************** + */ + int64_t start_time; + int64_t end_time; + + int64_t pts_wrap_reference; ///< reference dts for wrap detection + int pts_wrap_behavior; ///< behavior on wrap detection +} AVProgram; + +#define AVFMTCTX_NOHEADER 0x0001 /**< signal that no header is present + (streams are added dynamically) */ +#define AVFMTCTX_UNSEEKABLE 0x0002 /**< signal that the stream is definitely + not seekable, and attempts to call the + seek function will fail. For some + network protocols (e.g. HLS), this can + change dynamically at runtime. */ + +typedef struct AVChapter { + int id; ///< unique ID to identify the chapter + AVRational time_base; ///< time base in which the start/end timestamps are specified + int64_t start, end; ///< chapter start/end time in time_base units + AVDictionary *metadata; +} AVChapter; + + +/** + * Callback used by devices to communicate with application. + */ +typedef int (*av_format_control_message)(struct AVFormatContext *s, int type, + void *data, size_t data_size); + +typedef int (*AVOpenCallback)(struct AVFormatContext *s, AVIOContext **pb, const char *url, int flags, + const AVIOInterruptCB *int_cb, AVDictionary **options); + +/** + * The duration of a video can be estimated through various ways, and this enum can be used + * to know how the duration was estimated. + */ +enum AVDurationEstimationMethod { + AVFMT_DURATION_FROM_PTS, ///< Duration accurately estimated from PTSes + AVFMT_DURATION_FROM_STREAM, ///< Duration estimated from a stream with a known duration + AVFMT_DURATION_FROM_BITRATE ///< Duration estimated from bitrate (less accurate) +}; + +typedef struct AVFormatInternal AVFormatInternal; + +/** + * Format I/O context. + * New fields can be added to the end with minor version bumps. + * Removal, reordering and changes to existing fields require a major + * version bump. + * sizeof(AVFormatContext) must not be used outside libav*, use + * avformat_alloc_context() to create an AVFormatContext. + * + * Fields can be accessed through AVOptions (av_opt*), + * the name string used matches the associated command line parameter name and + * can be found in libavformat/options_table.h. + * The AVOption/command line parameter names differ in some cases from the C + * structure field names for historic reasons or brevity. + */ +typedef struct AVFormatContext { + /** + * A class for logging and @ref avoptions. Set by avformat_alloc_context(). + * Exports (de)muxer private options if they exist. + */ + const AVClass *av_class; + + /** + * The input container format. + * + * Demuxing only, set by avformat_open_input(). + */ + ff_const59 struct AVInputFormat *iformat; + + /** + * The output container format. + * + * Muxing only, must be set by the caller before avformat_write_header(). + */ + ff_const59 struct AVOutputFormat *oformat; + + /** + * Format private data. This is an AVOptions-enabled struct + * if and only if iformat/oformat.priv_class is not NULL. + * + * - muxing: set by avformat_write_header() + * - demuxing: set by avformat_open_input() + */ + void *priv_data; + + /** + * I/O context. + * + * - demuxing: either set by the user before avformat_open_input() (then + * the user must close it manually) or set by avformat_open_input(). + * - muxing: set by the user before avformat_write_header(). The caller must + * take care of closing / freeing the IO context. + * + * Do NOT set this field if AVFMT_NOFILE flag is set in + * iformat/oformat.flags. In such a case, the (de)muxer will handle + * I/O in some other way and this field will be NULL. + */ + AVIOContext *pb; + + /* stream info */ + /** + * Flags signalling stream properties. A combination of AVFMTCTX_*. + * Set by libavformat. + */ + int ctx_flags; + + /** + * Number of elements in AVFormatContext.streams. + * + * Set by avformat_new_stream(), must not be modified by any other code. + */ + unsigned int nb_streams; + /** + * A list of all streams in the file. New streams are created with + * avformat_new_stream(). + * + * - demuxing: streams are created by libavformat in avformat_open_input(). + * If AVFMTCTX_NOHEADER is set in ctx_flags, then new streams may also + * appear in av_read_frame(). + * - muxing: streams are created by the user before avformat_write_header(). + * + * Freed by libavformat in avformat_free_context(). + */ + AVStream **streams; + +#if FF_API_FORMAT_FILENAME + /** + * input or output filename + * + * - demuxing: set by avformat_open_input() + * - muxing: may be set by the caller before avformat_write_header() + * + * @deprecated Use url instead. + */ + attribute_deprecated + char filename[1024]; +#endif + + /** + * input or output URL. Unlike the old filename field, this field has no + * length restriction. + * + * - demuxing: set by avformat_open_input(), initialized to an empty + * string if url parameter was NULL in avformat_open_input(). + * - muxing: may be set by the caller before calling avformat_write_header() + * (or avformat_init_output() if that is called first) to a string + * which is freeable by av_free(). Set to an empty string if it + * was NULL in avformat_init_output(). + * + * Freed by libavformat in avformat_free_context(). + */ + char *url; + + /** + * Position of the first frame of the component, in + * AV_TIME_BASE fractional seconds. NEVER set this value directly: + * It is deduced from the AVStream values. + * + * Demuxing only, set by libavformat. + */ + int64_t start_time; + + /** + * Duration of the stream, in AV_TIME_BASE fractional + * seconds. Only set this value if you know none of the individual stream + * durations and also do not set any of them. This is deduced from the + * AVStream values if not set. + * + * Demuxing only, set by libavformat. + */ + int64_t duration; + + /** + * Total stream bitrate in bit/s, 0 if not + * available. Never set it directly if the file_size and the + * duration are known as FFmpeg can compute it automatically. + */ + int64_t bit_rate; + + unsigned int packet_size; + int max_delay; + + /** + * Flags modifying the (de)muxer behaviour. A combination of AVFMT_FLAG_*. + * Set by the user before avformat_open_input() / avformat_write_header(). + */ + int flags; +#define AVFMT_FLAG_GENPTS 0x0001 ///< Generate missing pts even if it requires parsing future frames. +#define AVFMT_FLAG_IGNIDX 0x0002 ///< Ignore index. +#define AVFMT_FLAG_NONBLOCK 0x0004 ///< Do not block when reading packets from input. +#define AVFMT_FLAG_IGNDTS 0x0008 ///< Ignore DTS on frames that contain both DTS & PTS +#define AVFMT_FLAG_NOFILLIN 0x0010 ///< Do not infer any values from other values, just return what is stored in the container +#define AVFMT_FLAG_NOPARSE 0x0020 ///< Do not use AVParsers, you also must set AVFMT_FLAG_NOFILLIN as the fillin code works on frames and no parsing -> no frames. Also seeking to frames can not work if parsing to find frame boundaries has been disabled +#define AVFMT_FLAG_NOBUFFER 0x0040 ///< Do not buffer frames when possible +#define AVFMT_FLAG_CUSTOM_IO 0x0080 ///< The caller has supplied a custom AVIOContext, don't avio_close() it. +#define AVFMT_FLAG_DISCARD_CORRUPT 0x0100 ///< Discard frames marked corrupted +#define AVFMT_FLAG_FLUSH_PACKETS 0x0200 ///< Flush the AVIOContext every packet. +/** + * When muxing, try to avoid writing any random/volatile data to the output. + * This includes any random IDs, real-time timestamps/dates, muxer version, etc. + * + * This flag is mainly intended for testing. + */ +#define AVFMT_FLAG_BITEXACT 0x0400 +#if FF_API_LAVF_MP4A_LATM +#define AVFMT_FLAG_MP4A_LATM 0x8000 ///< Deprecated, does nothing. +#endif +#define AVFMT_FLAG_SORT_DTS 0x10000 ///< try to interleave outputted packets by dts (using this flag can slow demuxing down) +#define AVFMT_FLAG_PRIV_OPT 0x20000 ///< Enable use of private options by delaying codec open (this could be made default once all code is converted) +#if FF_API_LAVF_KEEPSIDE_FLAG +#define AVFMT_FLAG_KEEP_SIDE_DATA 0x40000 ///< Deprecated, does nothing. +#endif +#define AVFMT_FLAG_FAST_SEEK 0x80000 ///< Enable fast, but inaccurate seeks for some formats +#define AVFMT_FLAG_SHORTEST 0x100000 ///< Stop muxing when the shortest stream stops. +#define AVFMT_FLAG_AUTO_BSF 0x200000 ///< Add bitstream filters as requested by the muxer + + /** + * Maximum size of the data read from input for determining + * the input container format. + * Demuxing only, set by the caller before avformat_open_input(). + */ + int64_t probesize; + + /** + * Maximum duration (in AV_TIME_BASE units) of the data read + * from input in avformat_find_stream_info(). + * Demuxing only, set by the caller before avformat_find_stream_info(). + * Can be set to 0 to let avformat choose using a heuristic. + */ + int64_t max_analyze_duration; + + const uint8_t *key; + int keylen; + + unsigned int nb_programs; + AVProgram **programs; + + /** + * Forced video codec_id. + * Demuxing: Set by user. + */ + enum AVCodecID video_codec_id; + + /** + * Forced audio codec_id. + * Demuxing: Set by user. + */ + enum AVCodecID audio_codec_id; + + /** + * Forced subtitle codec_id. + * Demuxing: Set by user. + */ + enum AVCodecID subtitle_codec_id; + + /** + * Maximum amount of memory in bytes to use for the index of each stream. + * If the index exceeds this size, entries will be discarded as + * needed to maintain a smaller size. This can lead to slower or less + * accurate seeking (depends on demuxer). + * Demuxers for which a full in-memory index is mandatory will ignore + * this. + * - muxing: unused + * - demuxing: set by user + */ + unsigned int max_index_size; + + /** + * Maximum amount of memory in bytes to use for buffering frames + * obtained from realtime capture devices. + */ + unsigned int max_picture_buffer; + + /** + * Number of chapters in AVChapter array. + * When muxing, chapters are normally written in the file header, + * so nb_chapters should normally be initialized before write_header + * is called. Some muxers (e.g. mov and mkv) can also write chapters + * in the trailer. To write chapters in the trailer, nb_chapters + * must be zero when write_header is called and non-zero when + * write_trailer is called. + * - muxing: set by user + * - demuxing: set by libavformat + */ + unsigned int nb_chapters; + AVChapter **chapters; + + /** + * Metadata that applies to the whole file. + * + * - demuxing: set by libavformat in avformat_open_input() + * - muxing: may be set by the caller before avformat_write_header() + * + * Freed by libavformat in avformat_free_context(). + */ + AVDictionary *metadata; + + /** + * Start time of the stream in real world time, in microseconds + * since the Unix epoch (00:00 1st January 1970). That is, pts=0 in the + * stream was captured at this real world time. + * - muxing: Set by the caller before avformat_write_header(). If set to + * either 0 or AV_NOPTS_VALUE, then the current wall-time will + * be used. + * - demuxing: Set by libavformat. AV_NOPTS_VALUE if unknown. Note that + * the value may become known after some number of frames + * have been received. + */ + int64_t start_time_realtime; + + /** + * The number of frames used for determining the framerate in + * avformat_find_stream_info(). + * Demuxing only, set by the caller before avformat_find_stream_info(). + */ + int fps_probe_size; + + /** + * Error recognition; higher values will detect more errors but may + * misdetect some more or less valid parts as errors. + * Demuxing only, set by the caller before avformat_open_input(). + */ + int error_recognition; + + /** + * Custom interrupt callbacks for the I/O layer. + * + * demuxing: set by the user before avformat_open_input(). + * muxing: set by the user before avformat_write_header() + * (mainly useful for AVFMT_NOFILE formats). The callback + * should also be passed to avio_open2() if it's used to + * open the file. + */ + AVIOInterruptCB interrupt_callback; + + /** + * Flags to enable debugging. + */ + int debug; +#define FF_FDEBUG_TS 0x0001 + + /** + * Maximum buffering duration for interleaving. + * + * To ensure all the streams are interleaved correctly, + * av_interleaved_write_frame() will wait until it has at least one packet + * for each stream before actually writing any packets to the output file. + * When some streams are "sparse" (i.e. there are large gaps between + * successive packets), this can result in excessive buffering. + * + * This field specifies the maximum difference between the timestamps of the + * first and the last packet in the muxing queue, above which libavformat + * will output a packet regardless of whether it has queued a packet for all + * the streams. + * + * Muxing only, set by the caller before avformat_write_header(). + */ + int64_t max_interleave_delta; + + /** + * Allow non-standard and experimental extension + * @see AVCodecContext.strict_std_compliance + */ + int strict_std_compliance; + + /** + * Flags for the user to detect events happening on the file. Flags must + * be cleared by the user once the event has been handled. + * A combination of AVFMT_EVENT_FLAG_*. + */ + int event_flags; +#define AVFMT_EVENT_FLAG_METADATA_UPDATED 0x0001 ///< The call resulted in updated metadata. + + /** + * Maximum number of packets to read while waiting for the first timestamp. + * Decoding only. + */ + int max_ts_probe; + + /** + * Avoid negative timestamps during muxing. + * Any value of the AVFMT_AVOID_NEG_TS_* constants. + * Note, this only works when using av_interleaved_write_frame. (interleave_packet_per_dts is in use) + * - muxing: Set by user + * - demuxing: unused + */ + int avoid_negative_ts; +#define AVFMT_AVOID_NEG_TS_AUTO -1 ///< Enabled when required by target format +#define AVFMT_AVOID_NEG_TS_MAKE_NON_NEGATIVE 1 ///< Shift timestamps so they are non negative +#define AVFMT_AVOID_NEG_TS_MAKE_ZERO 2 ///< Shift timestamps so that they start at 0 + + /** + * Transport stream id. + * This will be moved into demuxer private options. Thus no API/ABI compatibility + */ + int ts_id; + + /** + * Audio preload in microseconds. + * Note, not all formats support this and unpredictable things may happen if it is used when not supported. + * - encoding: Set by user + * - decoding: unused + */ + int audio_preload; + + /** + * Max chunk time in microseconds. + * Note, not all formats support this and unpredictable things may happen if it is used when not supported. + * - encoding: Set by user + * - decoding: unused + */ + int max_chunk_duration; + + /** + * Max chunk size in bytes + * Note, not all formats support this and unpredictable things may happen if it is used when not supported. + * - encoding: Set by user + * - decoding: unused + */ + int max_chunk_size; + + /** + * forces the use of wallclock timestamps as pts/dts of packets + * This has undefined results in the presence of B frames. + * - encoding: unused + * - decoding: Set by user + */ + int use_wallclock_as_timestamps; + + /** + * avio flags, used to force AVIO_FLAG_DIRECT. + * - encoding: unused + * - decoding: Set by user + */ + int avio_flags; + + /** + * The duration field can be estimated through various ways, and this field can be used + * to know how the duration was estimated. + * - encoding: unused + * - decoding: Read by user + */ + enum AVDurationEstimationMethod duration_estimation_method; + + /** + * Skip initial bytes when opening stream + * - encoding: unused + * - decoding: Set by user + */ + int64_t skip_initial_bytes; + + /** + * Correct single timestamp overflows + * - encoding: unused + * - decoding: Set by user + */ + unsigned int correct_ts_overflow; + + /** + * Force seeking to any (also non key) frames. + * - encoding: unused + * - decoding: Set by user + */ + int seek2any; + + /** + * Flush the I/O context after each packet. + * - encoding: Set by user + * - decoding: unused + */ + int flush_packets; + + /** + * format probing score. + * The maximal score is AVPROBE_SCORE_MAX, its set when the demuxer probes + * the format. + * - encoding: unused + * - decoding: set by avformat, read by user + */ + int probe_score; + + /** + * number of bytes to read maximally to identify format. + * - encoding: unused + * - decoding: set by user + */ + int format_probesize; + + /** + * ',' separated list of allowed decoders. + * If NULL then all are allowed + * - encoding: unused + * - decoding: set by user + */ + char *codec_whitelist; + + /** + * ',' separated list of allowed demuxers. + * If NULL then all are allowed + * - encoding: unused + * - decoding: set by user + */ + char *format_whitelist; + + /** + * An opaque field for libavformat internal usage. + * Must not be accessed in any way by callers. + */ + AVFormatInternal *internal; + + /** + * IO repositioned flag. + * This is set by avformat when the underlaying IO context read pointer + * is repositioned, for example when doing byte based seeking. + * Demuxers can use the flag to detect such changes. + */ + int io_repositioned; + + /** + * Forced video codec. + * This allows forcing a specific decoder, even when there are multiple with + * the same codec_id. + * Demuxing: Set by user + */ + AVCodec *video_codec; + + /** + * Forced audio codec. + * This allows forcing a specific decoder, even when there are multiple with + * the same codec_id. + * Demuxing: Set by user + */ + AVCodec *audio_codec; + + /** + * Forced subtitle codec. + * This allows forcing a specific decoder, even when there are multiple with + * the same codec_id. + * Demuxing: Set by user + */ + AVCodec *subtitle_codec; + + /** + * Forced data codec. + * This allows forcing a specific decoder, even when there are multiple with + * the same codec_id. + * Demuxing: Set by user + */ + AVCodec *data_codec; + + /** + * Number of bytes to be written as padding in a metadata header. + * Demuxing: Unused. + * Muxing: Set by user via av_format_set_metadata_header_padding. + */ + int metadata_header_padding; + + /** + * User data. + * This is a place for some private data of the user. + */ + void *opaque; + + /** + * Callback used by devices to communicate with application. + */ + av_format_control_message control_message_cb; + + /** + * Output timestamp offset, in microseconds. + * Muxing: set by user + */ + int64_t output_ts_offset; + + /** + * dump format separator. + * can be ", " or "\n " or anything else + * - muxing: Set by user. + * - demuxing: Set by user. + */ + uint8_t *dump_separator; + + /** + * Forced Data codec_id. + * Demuxing: Set by user. + */ + enum AVCodecID data_codec_id; + +#if FF_API_OLD_OPEN_CALLBACKS + /** + * Called to open further IO contexts when needed for demuxing. + * + * This can be set by the user application to perform security checks on + * the URLs before opening them. + * The function should behave like avio_open2(), AVFormatContext is provided + * as contextual information and to reach AVFormatContext.opaque. + * + * If NULL then some simple checks are used together with avio_open2(). + * + * Must not be accessed directly from outside avformat. + * @See av_format_set_open_cb() + * + * Demuxing: Set by user. + * + * @deprecated Use io_open and io_close. + */ + attribute_deprecated + int (*open_cb)(struct AVFormatContext *s, AVIOContext **p, const char *url, int flags, const AVIOInterruptCB *int_cb, AVDictionary **options); +#endif + + /** + * ',' separated list of allowed protocols. + * - encoding: unused + * - decoding: set by user + */ + char *protocol_whitelist; + + /** + * A callback for opening new IO streams. + * + * Whenever a muxer or a demuxer needs to open an IO stream (typically from + * avformat_open_input() for demuxers, but for certain formats can happen at + * other times as well), it will call this callback to obtain an IO context. + * + * @param s the format context + * @param pb on success, the newly opened IO context should be returned here + * @param url the url to open + * @param flags a combination of AVIO_FLAG_* + * @param options a dictionary of additional options, with the same + * semantics as in avio_open2() + * @return 0 on success, a negative AVERROR code on failure + * + * @note Certain muxers and demuxers do nesting, i.e. they open one or more + * additional internal format contexts. Thus the AVFormatContext pointer + * passed to this callback may be different from the one facing the caller. + * It will, however, have the same 'opaque' field. + */ + int (*io_open)(struct AVFormatContext *s, AVIOContext **pb, const char *url, + int flags, AVDictionary **options); + + /** + * A callback for closing the streams opened with AVFormatContext.io_open(). + */ + void (*io_close)(struct AVFormatContext *s, AVIOContext *pb); + + /** + * ',' separated list of disallowed protocols. + * - encoding: unused + * - decoding: set by user + */ + char *protocol_blacklist; + + /** + * The maximum number of streams. + * - encoding: unused + * - decoding: set by user + */ + int max_streams; + + /** + * Skip duration calcuation in estimate_timings_from_pts. + * - encoding: unused + * - decoding: set by user + */ + int skip_estimate_duration_from_pts; + + /** + * Maximum number of packets that can be probed + * - encoding: unused + * - decoding: set by user + */ + int max_probe_packets; +} AVFormatContext; + +#if FF_API_FORMAT_GET_SET +/** + * Accessors for some AVFormatContext fields. These used to be provided for ABI + * compatibility, and do not need to be used anymore. + */ +attribute_deprecated +int av_format_get_probe_score(const AVFormatContext *s); +attribute_deprecated +AVCodec * av_format_get_video_codec(const AVFormatContext *s); +attribute_deprecated +void av_format_set_video_codec(AVFormatContext *s, AVCodec *c); +attribute_deprecated +AVCodec * av_format_get_audio_codec(const AVFormatContext *s); +attribute_deprecated +void av_format_set_audio_codec(AVFormatContext *s, AVCodec *c); +attribute_deprecated +AVCodec * av_format_get_subtitle_codec(const AVFormatContext *s); +attribute_deprecated +void av_format_set_subtitle_codec(AVFormatContext *s, AVCodec *c); +attribute_deprecated +AVCodec * av_format_get_data_codec(const AVFormatContext *s); +attribute_deprecated +void av_format_set_data_codec(AVFormatContext *s, AVCodec *c); +attribute_deprecated +int av_format_get_metadata_header_padding(const AVFormatContext *s); +attribute_deprecated +void av_format_set_metadata_header_padding(AVFormatContext *s, int c); +attribute_deprecated +void * av_format_get_opaque(const AVFormatContext *s); +attribute_deprecated +void av_format_set_opaque(AVFormatContext *s, void *opaque); +attribute_deprecated +av_format_control_message av_format_get_control_message_cb(const AVFormatContext *s); +attribute_deprecated +void av_format_set_control_message_cb(AVFormatContext *s, av_format_control_message callback); +#if FF_API_OLD_OPEN_CALLBACKS +attribute_deprecated AVOpenCallback av_format_get_open_cb(const AVFormatContext *s); +attribute_deprecated void av_format_set_open_cb(AVFormatContext *s, AVOpenCallback callback); +#endif +#endif + +/** + * This function will cause global side data to be injected in the next packet + * of each stream as well as after any subsequent seek. + */ +void av_format_inject_global_side_data(AVFormatContext *s); + +/** + * Returns the method used to set ctx->duration. + * + * @return AVFMT_DURATION_FROM_PTS, AVFMT_DURATION_FROM_STREAM, or AVFMT_DURATION_FROM_BITRATE. + */ +enum AVDurationEstimationMethod av_fmt_ctx_get_duration_estimation_method(const AVFormatContext* ctx); + +typedef struct AVPacketList { + AVPacket pkt; + struct AVPacketList *next; +} AVPacketList; + + +/** + * @defgroup lavf_core Core functions + * @ingroup libavf + * + * Functions for querying libavformat capabilities, allocating core structures, + * etc. + * @{ + */ + +/** + * Return the LIBAVFORMAT_VERSION_INT constant. + */ +unsigned avformat_version(void); + +/** + * Return the libavformat build-time configuration. + */ +const char *avformat_configuration(void); + +/** + * Return the libavformat license. + */ +const char *avformat_license(void); + +#if FF_API_NEXT +/** + * Initialize libavformat and register all the muxers, demuxers and + * protocols. If you do not call this function, then you can select + * exactly which formats you want to support. + * + * @see av_register_input_format() + * @see av_register_output_format() + */ +attribute_deprecated +void av_register_all(void); + +attribute_deprecated +void av_register_input_format(AVInputFormat *format); +attribute_deprecated +void av_register_output_format(AVOutputFormat *format); +#endif + +/** + * Do global initialization of network libraries. This is optional, + * and not recommended anymore. + * + * This functions only exists to work around thread-safety issues + * with older GnuTLS or OpenSSL libraries. If libavformat is linked + * to newer versions of those libraries, or if you do not use them, + * calling this function is unnecessary. Otherwise, you need to call + * this function before any other threads using them are started. + * + * This function will be deprecated once support for older GnuTLS and + * OpenSSL libraries is removed, and this function has no purpose + * anymore. + */ +int avformat_network_init(void); + +/** + * Undo the initialization done by avformat_network_init. Call it only + * once for each time you called avformat_network_init. + */ +int avformat_network_deinit(void); + +#if FF_API_NEXT +/** + * If f is NULL, returns the first registered input format, + * if f is non-NULL, returns the next registered input format after f + * or NULL if f is the last one. + */ +attribute_deprecated +AVInputFormat *av_iformat_next(const AVInputFormat *f); + +/** + * If f is NULL, returns the first registered output format, + * if f is non-NULL, returns the next registered output format after f + * or NULL if f is the last one. + */ +attribute_deprecated +AVOutputFormat *av_oformat_next(const AVOutputFormat *f); +#endif + +/** + * Iterate over all registered muxers. + * + * @param opaque a pointer where libavformat will store the iteration state. Must + * point to NULL to start the iteration. + * + * @return the next registered muxer or NULL when the iteration is + * finished + */ +const AVOutputFormat *av_muxer_iterate(void **opaque); + +/** + * Iterate over all registered demuxers. + * + * @param opaque a pointer where libavformat will store the iteration state. Must + * point to NULL to start the iteration. + * + * @return the next registered demuxer or NULL when the iteration is + * finished + */ +const AVInputFormat *av_demuxer_iterate(void **opaque); + +/** + * Allocate an AVFormatContext. + * avformat_free_context() can be used to free the context and everything + * allocated by the framework within it. + */ +AVFormatContext *avformat_alloc_context(void); + +/** + * Free an AVFormatContext and all its streams. + * @param s context to free + */ +void avformat_free_context(AVFormatContext *s); + +/** + * Get the AVClass for AVFormatContext. It can be used in combination with + * AV_OPT_SEARCH_FAKE_OBJ for examining options. + * + * @see av_opt_find(). + */ +const AVClass *avformat_get_class(void); + +/** + * Add a new stream to a media file. + * + * When demuxing, it is called by the demuxer in read_header(). If the + * flag AVFMTCTX_NOHEADER is set in s.ctx_flags, then it may also + * be called in read_packet(). + * + * When muxing, should be called by the user before avformat_write_header(). + * + * User is required to call avcodec_close() and avformat_free_context() to + * clean up the allocation by avformat_new_stream(). + * + * @param s media file handle + * @param c If non-NULL, the AVCodecContext corresponding to the new stream + * will be initialized to use this codec. This is needed for e.g. codec-specific + * defaults to be set, so codec should be provided if it is known. + * + * @return newly created stream or NULL on error. + */ +AVStream *avformat_new_stream(AVFormatContext *s, const AVCodec *c); + +/** + * Wrap an existing array as stream side data. + * + * @param st stream + * @param type side information type + * @param data the side data array. It must be allocated with the av_malloc() + * family of functions. The ownership of the data is transferred to + * st. + * @param size side information size + * @return zero on success, a negative AVERROR code on failure. On failure, + * the stream is unchanged and the data remains owned by the caller. + */ +int av_stream_add_side_data(AVStream *st, enum AVPacketSideDataType type, + uint8_t *data, size_t size); + +/** + * Allocate new information from stream. + * + * @param stream stream + * @param type desired side information type + * @param size side information size + * @return pointer to fresh allocated data or NULL otherwise + */ +uint8_t *av_stream_new_side_data(AVStream *stream, + enum AVPacketSideDataType type, int size); +/** + * Get side information from stream. + * + * @param stream stream + * @param type desired side information type + * @param size pointer for side information size to store (optional) + * @return pointer to data if present or NULL otherwise + */ +uint8_t *av_stream_get_side_data(const AVStream *stream, + enum AVPacketSideDataType type, int *size); + +AVProgram *av_new_program(AVFormatContext *s, int id); + +/** + * @} + */ + + +/** + * Allocate an AVFormatContext for an output format. + * avformat_free_context() can be used to free the context and + * everything allocated by the framework within it. + * + * @param *ctx is set to the created format context, or to NULL in + * case of failure + * @param oformat format to use for allocating the context, if NULL + * format_name and filename are used instead + * @param format_name the name of output format to use for allocating the + * context, if NULL filename is used instead + * @param filename the name of the filename to use for allocating the + * context, may be NULL + * @return >= 0 in case of success, a negative AVERROR code in case of + * failure + */ +int avformat_alloc_output_context2(AVFormatContext **ctx, ff_const59 AVOutputFormat *oformat, + const char *format_name, const char *filename); + +/** + * @addtogroup lavf_decoding + * @{ + */ + +/** + * Find AVInputFormat based on the short name of the input format. + */ +ff_const59 AVInputFormat *av_find_input_format(const char *short_name); + +/** + * Guess the file format. + * + * @param pd data to be probed + * @param is_opened Whether the file is already opened; determines whether + * demuxers with or without AVFMT_NOFILE are probed. + */ +ff_const59 AVInputFormat *av_probe_input_format(ff_const59 AVProbeData *pd, int is_opened); + +/** + * Guess the file format. + * + * @param pd data to be probed + * @param is_opened Whether the file is already opened; determines whether + * demuxers with or without AVFMT_NOFILE are probed. + * @param score_max A probe score larger that this is required to accept a + * detection, the variable is set to the actual detection + * score afterwards. + * If the score is <= AVPROBE_SCORE_MAX / 4 it is recommended + * to retry with a larger probe buffer. + */ +ff_const59 AVInputFormat *av_probe_input_format2(ff_const59 AVProbeData *pd, int is_opened, int *score_max); + +/** + * Guess the file format. + * + * @param is_opened Whether the file is already opened; determines whether + * demuxers with or without AVFMT_NOFILE are probed. + * @param score_ret The score of the best detection. + */ +ff_const59 AVInputFormat *av_probe_input_format3(ff_const59 AVProbeData *pd, int is_opened, int *score_ret); + +/** + * Probe a bytestream to determine the input format. Each time a probe returns + * with a score that is too low, the probe buffer size is increased and another + * attempt is made. When the maximum probe size is reached, the input format + * with the highest score is returned. + * + * @param pb the bytestream to probe + * @param fmt the input format is put here + * @param url the url of the stream + * @param logctx the log context + * @param offset the offset within the bytestream to probe from + * @param max_probe_size the maximum probe buffer size (zero for default) + * @return the score in case of success, a negative value corresponding to an + * the maximal score is AVPROBE_SCORE_MAX + * AVERROR code otherwise + */ +int av_probe_input_buffer2(AVIOContext *pb, ff_const59 AVInputFormat **fmt, + const char *url, void *logctx, + unsigned int offset, unsigned int max_probe_size); + +/** + * Like av_probe_input_buffer2() but returns 0 on success + */ +int av_probe_input_buffer(AVIOContext *pb, ff_const59 AVInputFormat **fmt, + const char *url, void *logctx, + unsigned int offset, unsigned int max_probe_size); + +/** + * Open an input stream and read the header. The codecs are not opened. + * The stream must be closed with avformat_close_input(). + * + * @param ps Pointer to user-supplied AVFormatContext (allocated by avformat_alloc_context). + * May be a pointer to NULL, in which case an AVFormatContext is allocated by this + * function and written into ps. + * Note that a user-supplied AVFormatContext will be freed on failure. + * @param url URL of the stream to open. + * @param fmt If non-NULL, this parameter forces a specific input format. + * Otherwise the format is autodetected. + * @param options A dictionary filled with AVFormatContext and demuxer-private options. + * On return this parameter will be destroyed and replaced with a dict containing + * options that were not found. May be NULL. + * + * @return 0 on success, a negative AVERROR on failure. + * + * @note If you want to use custom IO, preallocate the format context and set its pb field. + */ +int avformat_open_input(AVFormatContext **ps, const char *url, ff_const59 AVInputFormat *fmt, AVDictionary **options); + +attribute_deprecated +int av_demuxer_open(AVFormatContext *ic); + +/** + * Read packets of a media file to get stream information. This + * is useful for file formats with no headers such as MPEG. This + * function also computes the real framerate in case of MPEG-2 repeat + * frame mode. + * The logical file position is not changed by this function; + * examined packets may be buffered for later processing. + * + * @param ic media file handle + * @param options If non-NULL, an ic.nb_streams long array of pointers to + * dictionaries, where i-th member contains options for + * codec corresponding to i-th stream. + * On return each dictionary will be filled with options that were not found. + * @return >=0 if OK, AVERROR_xxx on error + * + * @note this function isn't guaranteed to open all the codecs, so + * options being non-empty at return is a perfectly normal behavior. + * + * @todo Let the user decide somehow what information is needed so that + * we do not waste time getting stuff the user does not need. + */ +int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options); + +/** + * Find the programs which belong to a given stream. + * + * @param ic media file handle + * @param last the last found program, the search will start after this + * program, or from the beginning if it is NULL + * @param s stream index + * @return the next program which belongs to s, NULL if no program is found or + * the last program is not among the programs of ic. + */ +AVProgram *av_find_program_from_stream(AVFormatContext *ic, AVProgram *last, int s); + +void av_program_add_stream_index(AVFormatContext *ac, int progid, unsigned int idx); + +/** + * Find the "best" stream in the file. + * The best stream is determined according to various heuristics as the most + * likely to be what the user expects. + * If the decoder parameter is non-NULL, av_find_best_stream will find the + * default decoder for the stream's codec; streams for which no decoder can + * be found are ignored. + * + * @param ic media file handle + * @param type stream type: video, audio, subtitles, etc. + * @param wanted_stream_nb user-requested stream number, + * or -1 for automatic selection + * @param related_stream try to find a stream related (eg. in the same + * program) to this one, or -1 if none + * @param decoder_ret if non-NULL, returns the decoder for the + * selected stream + * @param flags flags; none are currently defined + * @return the non-negative stream number in case of success, + * AVERROR_STREAM_NOT_FOUND if no stream with the requested type + * could be found, + * AVERROR_DECODER_NOT_FOUND if streams were found but no decoder + * @note If av_find_best_stream returns successfully and decoder_ret is not + * NULL, then *decoder_ret is guaranteed to be set to a valid AVCodec. + */ +int av_find_best_stream(AVFormatContext *ic, + enum AVMediaType type, + int wanted_stream_nb, + int related_stream, + AVCodec **decoder_ret, + int flags); + +/** + * Return the next frame of a stream. + * This function returns what is stored in the file, and does not validate + * that what is there are valid frames for the decoder. It will split what is + * stored in the file into frames and return one for each call. It will not + * omit invalid data between valid frames so as to give the decoder the maximum + * information possible for decoding. + * + * On success, the returned packet is reference-counted (pkt->buf is set) and + * valid indefinitely. The packet must be freed with av_packet_unref() when + * it is no longer needed. For video, the packet contains exactly one frame. + * For audio, it contains an integer number of frames if each frame has + * a known fixed size (e.g. PCM or ADPCM data). If the audio frames have + * a variable size (e.g. MPEG audio), then it contains one frame. + * + * pkt->pts, pkt->dts and pkt->duration are always set to correct + * values in AVStream.time_base units (and guessed if the format cannot + * provide them). pkt->pts can be AV_NOPTS_VALUE if the video format + * has B-frames, so it is better to rely on pkt->dts if you do not + * decompress the payload. + * + * @return 0 if OK, < 0 on error or end of file. On error, pkt will be blank + * (as if it came from av_packet_alloc()). + * + * @note pkt will be initialized, so it may be uninitialized, but it must not + * contain data that needs to be freed. + */ +int av_read_frame(AVFormatContext *s, AVPacket *pkt); + +/** + * Seek to the keyframe at timestamp. + * 'timestamp' in 'stream_index'. + * + * @param s media file handle + * @param stream_index If stream_index is (-1), a default + * stream is selected, and timestamp is automatically converted + * from AV_TIME_BASE units to the stream specific time_base. + * @param timestamp Timestamp in AVStream.time_base units + * or, if no stream is specified, in AV_TIME_BASE units. + * @param flags flags which select direction and seeking mode + * @return >= 0 on success + */ +int av_seek_frame(AVFormatContext *s, int stream_index, int64_t timestamp, + int flags); + +/** + * Seek to timestamp ts. + * Seeking will be done so that the point from which all active streams + * can be presented successfully will be closest to ts and within min/max_ts. + * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL. + * + * If flags contain AVSEEK_FLAG_BYTE, then all timestamps are in bytes and + * are the file position (this may not be supported by all demuxers). + * If flags contain AVSEEK_FLAG_FRAME, then all timestamps are in frames + * in the stream with stream_index (this may not be supported by all demuxers). + * Otherwise all timestamps are in units of the stream selected by stream_index + * or if stream_index is -1, in AV_TIME_BASE units. + * If flags contain AVSEEK_FLAG_ANY, then non-keyframes are treated as + * keyframes (this may not be supported by all demuxers). + * If flags contain AVSEEK_FLAG_BACKWARD, it is ignored. + * + * @param s media file handle + * @param stream_index index of the stream which is used as time base reference + * @param min_ts smallest acceptable timestamp + * @param ts target timestamp + * @param max_ts largest acceptable timestamp + * @param flags flags + * @return >=0 on success, error code otherwise + * + * @note This is part of the new seek API which is still under construction. + */ +int avformat_seek_file(AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags); + +/** + * Discard all internally buffered data. This can be useful when dealing with + * discontinuities in the byte stream. Generally works only with formats that + * can resync. This includes headerless formats like MPEG-TS/TS but should also + * work with NUT, Ogg and in a limited way AVI for example. + * + * The set of streams, the detected duration, stream parameters and codecs do + * not change when calling this function. If you want a complete reset, it's + * better to open a new AVFormatContext. + * + * This does not flush the AVIOContext (s->pb). If necessary, call + * avio_flush(s->pb) before calling this function. + * + * @param s media file handle + * @return >=0 on success, error code otherwise + */ +int avformat_flush(AVFormatContext *s); + +/** + * Start playing a network-based stream (e.g. RTSP stream) at the + * current position. + */ +int av_read_play(AVFormatContext *s); + +/** + * Pause a network-based stream (e.g. RTSP stream). + * + * Use av_read_play() to resume it. + */ +int av_read_pause(AVFormatContext *s); + +/** + * Close an opened input AVFormatContext. Free it and all its contents + * and set *s to NULL. + */ +void avformat_close_input(AVFormatContext **s); +/** + * @} + */ + +#define AVSEEK_FLAG_BACKWARD 1 ///< seek backward +#define AVSEEK_FLAG_BYTE 2 ///< seeking based on position in bytes +#define AVSEEK_FLAG_ANY 4 ///< seek to any frame, even non-keyframes +#define AVSEEK_FLAG_FRAME 8 ///< seeking based on frame number + +/** + * @addtogroup lavf_encoding + * @{ + */ + +#define AVSTREAM_INIT_IN_WRITE_HEADER 0 ///< stream parameters initialized in avformat_write_header +#define AVSTREAM_INIT_IN_INIT_OUTPUT 1 ///< stream parameters initialized in avformat_init_output + +/** + * Allocate the stream private data and write the stream header to + * an output media file. + * + * @param s Media file handle, must be allocated with avformat_alloc_context(). + * Its oformat field must be set to the desired output format; + * Its pb field must be set to an already opened AVIOContext. + * @param options An AVDictionary filled with AVFormatContext and muxer-private options. + * On return this parameter will be destroyed and replaced with a dict containing + * options that were not found. May be NULL. + * + * @return AVSTREAM_INIT_IN_WRITE_HEADER on success if the codec had not already been fully initialized in avformat_init, + * AVSTREAM_INIT_IN_INIT_OUTPUT on success if the codec had already been fully initialized in avformat_init, + * negative AVERROR on failure. + * + * @see av_opt_find, av_dict_set, avio_open, av_oformat_next, avformat_init_output. + */ +av_warn_unused_result +int avformat_write_header(AVFormatContext *s, AVDictionary **options); + +/** + * Allocate the stream private data and initialize the codec, but do not write the header. + * May optionally be used before avformat_write_header to initialize stream parameters + * before actually writing the header. + * If using this function, do not pass the same options to avformat_write_header. + * + * @param s Media file handle, must be allocated with avformat_alloc_context(). + * Its oformat field must be set to the desired output format; + * Its pb field must be set to an already opened AVIOContext. + * @param options An AVDictionary filled with AVFormatContext and muxer-private options. + * On return this parameter will be destroyed and replaced with a dict containing + * options that were not found. May be NULL. + * + * @return AVSTREAM_INIT_IN_WRITE_HEADER on success if the codec requires avformat_write_header to fully initialize, + * AVSTREAM_INIT_IN_INIT_OUTPUT on success if the codec has been fully initialized, + * negative AVERROR on failure. + * + * @see av_opt_find, av_dict_set, avio_open, av_oformat_next, avformat_write_header. + */ +av_warn_unused_result +int avformat_init_output(AVFormatContext *s, AVDictionary **options); + +/** + * Write a packet to an output media file. + * + * This function passes the packet directly to the muxer, without any buffering + * or reordering. The caller is responsible for correctly interleaving the + * packets if the format requires it. Callers that want libavformat to handle + * the interleaving should call av_interleaved_write_frame() instead of this + * function. + * + * @param s media file handle + * @param pkt The packet containing the data to be written. Note that unlike + * av_interleaved_write_frame(), this function does not take + * ownership of the packet passed to it (though some muxers may make + * an internal reference to the input packet). + *
+ * This parameter can be NULL (at any time, not just at the end), in + * order to immediately flush data buffered within the muxer, for + * muxers that buffer up data internally before writing it to the + * output. + *
+ * Packet's @ref AVPacket.stream_index "stream_index" field must be + * set to the index of the corresponding stream in @ref + * AVFormatContext.streams "s->streams". + *
+ * The timestamps (@ref AVPacket.pts "pts", @ref AVPacket.dts "dts") + * must be set to correct values in the stream's timebase (unless the + * output format is flagged with the AVFMT_NOTIMESTAMPS flag, then + * they can be set to AV_NOPTS_VALUE). + * The dts for subsequent packets passed to this function must be strictly + * increasing when compared in their respective timebases (unless the + * output format is flagged with the AVFMT_TS_NONSTRICT, then they + * merely have to be nondecreasing). @ref AVPacket.duration + * "duration") should also be set if known. + * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush + * + * @see av_interleaved_write_frame() + */ +int av_write_frame(AVFormatContext *s, AVPacket *pkt); + +/** + * Write a packet to an output media file ensuring correct interleaving. + * + * This function will buffer the packets internally as needed to make sure the + * packets in the output file are properly interleaved in the order of + * increasing dts. Callers doing their own interleaving should call + * av_write_frame() instead of this function. + * + * Using this function instead of av_write_frame() can give muxers advance + * knowledge of future packets, improving e.g. the behaviour of the mp4 + * muxer for VFR content in fragmenting mode. + * + * @param s media file handle + * @param pkt The packet containing the data to be written. + *
+ * If the packet is reference-counted, this function will take + * ownership of this reference and unreference it later when it sees + * fit. + * The caller must not access the data through this reference after + * this function returns. If the packet is not reference-counted, + * libavformat will make a copy. + *
+ * This parameter can be NULL (at any time, not just at the end), to + * flush the interleaving queues. + *
+ * Packet's @ref AVPacket.stream_index "stream_index" field must be + * set to the index of the corresponding stream in @ref + * AVFormatContext.streams "s->streams". + *
+ * The timestamps (@ref AVPacket.pts "pts", @ref AVPacket.dts "dts") + * must be set to correct values in the stream's timebase (unless the + * output format is flagged with the AVFMT_NOTIMESTAMPS flag, then + * they can be set to AV_NOPTS_VALUE). + * The dts for subsequent packets in one stream must be strictly + * increasing (unless the output format is flagged with the + * AVFMT_TS_NONSTRICT, then they merely have to be nondecreasing). + * @ref AVPacket.duration "duration") should also be set if known. + * + * @return 0 on success, a negative AVERROR on error. Libavformat will always + * take care of freeing the packet, even if this function fails. + * + * @see av_write_frame(), AVFormatContext.max_interleave_delta + */ +int av_interleaved_write_frame(AVFormatContext *s, AVPacket *pkt); + +/** + * Write an uncoded frame to an output media file. + * + * The frame must be correctly interleaved according to the container + * specification; if not, av_interleaved_write_uncoded_frame() must be used. + * + * See av_interleaved_write_uncoded_frame() for details. + */ +int av_write_uncoded_frame(AVFormatContext *s, int stream_index, + AVFrame *frame); + +/** + * Write an uncoded frame to an output media file. + * + * If the muxer supports it, this function makes it possible to write an AVFrame + * structure directly, without encoding it into a packet. + * It is mostly useful for devices and similar special muxers that use raw + * video or PCM data and will not serialize it into a byte stream. + * + * To test whether it is possible to use it with a given muxer and stream, + * use av_write_uncoded_frame_query(). + * + * The caller gives up ownership of the frame and must not access it + * afterwards. + * + * @return >=0 for success, a negative code on error + */ +int av_interleaved_write_uncoded_frame(AVFormatContext *s, int stream_index, + AVFrame *frame); + +/** + * Test whether a muxer supports uncoded frame. + * + * @return >=0 if an uncoded frame can be written to that muxer and stream, + * <0 if not + */ +int av_write_uncoded_frame_query(AVFormatContext *s, int stream_index); + +/** + * Write the stream trailer to an output media file and free the + * file private data. + * + * May only be called after a successful call to avformat_write_header. + * + * @param s media file handle + * @return 0 if OK, AVERROR_xxx on error + */ +int av_write_trailer(AVFormatContext *s); + +/** + * Return the output format in the list of registered output formats + * which best matches the provided parameters, or return NULL if + * there is no match. + * + * @param short_name if non-NULL checks if short_name matches with the + * names of the registered formats + * @param filename if non-NULL checks if filename terminates with the + * extensions of the registered formats + * @param mime_type if non-NULL checks if mime_type matches with the + * MIME type of the registered formats + */ +ff_const59 AVOutputFormat *av_guess_format(const char *short_name, + const char *filename, + const char *mime_type); + +/** + * Guess the codec ID based upon muxer and filename. + */ +enum AVCodecID av_guess_codec(ff_const59 AVOutputFormat *fmt, const char *short_name, + const char *filename, const char *mime_type, + enum AVMediaType type); + +/** + * Get timing information for the data currently output. + * The exact meaning of "currently output" depends on the format. + * It is mostly relevant for devices that have an internal buffer and/or + * work in real time. + * @param s media file handle + * @param stream stream in the media file + * @param[out] dts DTS of the last packet output for the stream, in stream + * time_base units + * @param[out] wall absolute time when that packet whas output, + * in microsecond + * @return 0 if OK, AVERROR(ENOSYS) if the format does not support it + * Note: some formats or devices may not allow to measure dts and wall + * atomically. + */ +int av_get_output_timestamp(struct AVFormatContext *s, int stream, + int64_t *dts, int64_t *wall); + + +/** + * @} + */ + + +/** + * @defgroup lavf_misc Utility functions + * @ingroup libavf + * @{ + * + * Miscellaneous utility functions related to both muxing and demuxing + * (or neither). + */ + +/** + * Send a nice hexadecimal dump of a buffer to the specified file stream. + * + * @param f The file stream pointer where the dump should be sent to. + * @param buf buffer + * @param size buffer size + * + * @see av_hex_dump_log, av_pkt_dump2, av_pkt_dump_log2 + */ +void av_hex_dump(FILE *f, const uint8_t *buf, int size); + +/** + * Send a nice hexadecimal dump of a buffer to the log. + * + * @param avcl A pointer to an arbitrary struct of which the first field is a + * pointer to an AVClass struct. + * @param level The importance level of the message, lower values signifying + * higher importance. + * @param buf buffer + * @param size buffer size + * + * @see av_hex_dump, av_pkt_dump2, av_pkt_dump_log2 + */ +void av_hex_dump_log(void *avcl, int level, const uint8_t *buf, int size); + +/** + * Send a nice dump of a packet to the specified file stream. + * + * @param f The file stream pointer where the dump should be sent to. + * @param pkt packet to dump + * @param dump_payload True if the payload must be displayed, too. + * @param st AVStream that the packet belongs to + */ +void av_pkt_dump2(FILE *f, const AVPacket *pkt, int dump_payload, const AVStream *st); + + +/** + * Send a nice dump of a packet to the log. + * + * @param avcl A pointer to an arbitrary struct of which the first field is a + * pointer to an AVClass struct. + * @param level The importance level of the message, lower values signifying + * higher importance. + * @param pkt packet to dump + * @param dump_payload True if the payload must be displayed, too. + * @param st AVStream that the packet belongs to + */ +void av_pkt_dump_log2(void *avcl, int level, const AVPacket *pkt, int dump_payload, + const AVStream *st); + +/** + * Get the AVCodecID for the given codec tag tag. + * If no codec id is found returns AV_CODEC_ID_NONE. + * + * @param tags list of supported codec_id-codec_tag pairs, as stored + * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag + * @param tag codec tag to match to a codec ID + */ +enum AVCodecID av_codec_get_id(const struct AVCodecTag * const *tags, unsigned int tag); + +/** + * Get the codec tag for the given codec id id. + * If no codec tag is found returns 0. + * + * @param tags list of supported codec_id-codec_tag pairs, as stored + * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag + * @param id codec ID to match to a codec tag + */ +unsigned int av_codec_get_tag(const struct AVCodecTag * const *tags, enum AVCodecID id); + +/** + * Get the codec tag for the given codec id. + * + * @param tags list of supported codec_id - codec_tag pairs, as stored + * in AVInputFormat.codec_tag and AVOutputFormat.codec_tag + * @param id codec id that should be searched for in the list + * @param tag A pointer to the found tag + * @return 0 if id was not found in tags, > 0 if it was found + */ +int av_codec_get_tag2(const struct AVCodecTag * const *tags, enum AVCodecID id, + unsigned int *tag); + +int av_find_default_stream_index(AVFormatContext *s); + +/** + * Get the index for a specific timestamp. + * + * @param st stream that the timestamp belongs to + * @param timestamp timestamp to retrieve the index for + * @param flags if AVSEEK_FLAG_BACKWARD then the returned index will correspond + * to the timestamp which is <= the requested one, if backward + * is 0, then it will be >= + * if AVSEEK_FLAG_ANY seek to any frame, only keyframes otherwise + * @return < 0 if no such timestamp could be found + */ +int av_index_search_timestamp(AVStream *st, int64_t timestamp, int flags); + +/** + * Add an index entry into a sorted list. Update the entry if the list + * already contains it. + * + * @param timestamp timestamp in the time base of the given stream + */ +int av_add_index_entry(AVStream *st, int64_t pos, int64_t timestamp, + int size, int distance, int flags); + + +/** + * Split a URL string into components. + * + * The pointers to buffers for storing individual components may be null, + * in order to ignore that component. Buffers for components not found are + * set to empty strings. If the port is not found, it is set to a negative + * value. + * + * @param proto the buffer for the protocol + * @param proto_size the size of the proto buffer + * @param authorization the buffer for the authorization + * @param authorization_size the size of the authorization buffer + * @param hostname the buffer for the host name + * @param hostname_size the size of the hostname buffer + * @param port_ptr a pointer to store the port number in + * @param path the buffer for the path + * @param path_size the size of the path buffer + * @param url the URL to split + */ +void av_url_split(char *proto, int proto_size, + char *authorization, int authorization_size, + char *hostname, int hostname_size, + int *port_ptr, + char *path, int path_size, + const char *url); + + +/** + * Print detailed information about the input or output format, such as + * duration, bitrate, streams, container, programs, metadata, side data, + * codec and time base. + * + * @param ic the context to analyze + * @param index index of the stream to dump information about + * @param url the URL to print, such as source or destination file + * @param is_output Select whether the specified context is an input(0) or output(1) + */ +void av_dump_format(AVFormatContext *ic, + int index, + const char *url, + int is_output); + + +#define AV_FRAME_FILENAME_FLAGS_MULTIPLE 1 ///< Allow multiple %d + +/** + * Return in 'buf' the path with '%d' replaced by a number. + * + * Also handles the '%0nd' format where 'n' is the total number + * of digits and '%%'. + * + * @param buf destination buffer + * @param buf_size destination buffer size + * @param path numbered sequence string + * @param number frame number + * @param flags AV_FRAME_FILENAME_FLAGS_* + * @return 0 if OK, -1 on format error + */ +int av_get_frame_filename2(char *buf, int buf_size, + const char *path, int number, int flags); + +int av_get_frame_filename(char *buf, int buf_size, + const char *path, int number); + +/** + * Check whether filename actually is a numbered sequence generator. + * + * @param filename possible numbered sequence string + * @return 1 if a valid numbered sequence string, 0 otherwise + */ +int av_filename_number_test(const char *filename); + +/** + * Generate an SDP for an RTP session. + * + * Note, this overwrites the id values of AVStreams in the muxer contexts + * for getting unique dynamic payload types. + * + * @param ac array of AVFormatContexts describing the RTP streams. If the + * array is composed by only one context, such context can contain + * multiple AVStreams (one AVStream per RTP stream). Otherwise, + * all the contexts in the array (an AVCodecContext per RTP stream) + * must contain only one AVStream. + * @param n_files number of AVCodecContexts contained in ac + * @param buf buffer where the SDP will be stored (must be allocated by + * the caller) + * @param size the size of the buffer + * @return 0 if OK, AVERROR_xxx on error + */ +int av_sdp_create(AVFormatContext *ac[], int n_files, char *buf, int size); + +/** + * Return a positive value if the given filename has one of the given + * extensions, 0 otherwise. + * + * @param filename file name to check against the given extensions + * @param extensions a comma-separated list of filename extensions + */ +int av_match_ext(const char *filename, const char *extensions); + +/** + * Test if the given container can store a codec. + * + * @param ofmt container to check for compatibility + * @param codec_id codec to potentially store in container + * @param std_compliance standards compliance level, one of FF_COMPLIANCE_* + * + * @return 1 if codec with ID codec_id can be stored in ofmt, 0 if it cannot. + * A negative number if this information is not available. + */ +int avformat_query_codec(const AVOutputFormat *ofmt, enum AVCodecID codec_id, + int std_compliance); + +/** + * @defgroup riff_fourcc RIFF FourCCs + * @{ + * Get the tables mapping RIFF FourCCs to libavcodec AVCodecIDs. The tables are + * meant to be passed to av_codec_get_id()/av_codec_get_tag() as in the + * following code: + * @code + * uint32_t tag = MKTAG('H', '2', '6', '4'); + * const struct AVCodecTag *table[] = { avformat_get_riff_video_tags(), 0 }; + * enum AVCodecID id = av_codec_get_id(table, tag); + * @endcode + */ +/** + * @return the table mapping RIFF FourCCs for video to libavcodec AVCodecID. + */ +const struct AVCodecTag *avformat_get_riff_video_tags(void); +/** + * @return the table mapping RIFF FourCCs for audio to AVCodecID. + */ +const struct AVCodecTag *avformat_get_riff_audio_tags(void); +/** + * @return the table mapping MOV FourCCs for video to libavcodec AVCodecID. + */ +const struct AVCodecTag *avformat_get_mov_video_tags(void); +/** + * @return the table mapping MOV FourCCs for audio to AVCodecID. + */ +const struct AVCodecTag *avformat_get_mov_audio_tags(void); + +/** + * @} + */ + +/** + * Guess the sample aspect ratio of a frame, based on both the stream and the + * frame aspect ratio. + * + * Since the frame aspect ratio is set by the codec but the stream aspect ratio + * is set by the demuxer, these two may not be equal. This function tries to + * return the value that you should use if you would like to display the frame. + * + * Basic logic is to use the stream aspect ratio if it is set to something sane + * otherwise use the frame aspect ratio. This way a container setting, which is + * usually easy to modify can override the coded value in the frames. + * + * @param format the format context which the stream is part of + * @param stream the stream which the frame is part of + * @param frame the frame with the aspect ratio to be determined + * @return the guessed (valid) sample_aspect_ratio, 0/1 if no idea + */ +AVRational av_guess_sample_aspect_ratio(AVFormatContext *format, AVStream *stream, AVFrame *frame); + +/** + * Guess the frame rate, based on both the container and codec information. + * + * @param ctx the format context which the stream is part of + * @param stream the stream which the frame is part of + * @param frame the frame for which the frame rate should be determined, may be NULL + * @return the guessed (valid) frame rate, 0/1 if no idea + */ +AVRational av_guess_frame_rate(AVFormatContext *ctx, AVStream *stream, AVFrame *frame); + +/** + * Check if the stream st contained in s is matched by the stream specifier + * spec. + * + * See the "stream specifiers" chapter in the documentation for the syntax + * of spec. + * + * @return >0 if st is matched by spec; + * 0 if st is not matched by spec; + * AVERROR code if spec is invalid + * + * @note A stream specifier can match several streams in the format. + */ +int avformat_match_stream_specifier(AVFormatContext *s, AVStream *st, + const char *spec); + +int avformat_queue_attached_pictures(AVFormatContext *s); + +#if FF_API_OLD_BSF +/** + * Apply a list of bitstream filters to a packet. + * + * @param codec AVCodecContext, usually from an AVStream + * @param pkt the packet to apply filters to. If, on success, the returned + * packet has size == 0 and side_data_elems == 0, it indicates that + * the packet should be dropped + * @param bsfc a NULL-terminated list of filters to apply + * @return >=0 on success; + * AVERROR code on failure + */ +attribute_deprecated +int av_apply_bitstream_filters(AVCodecContext *codec, AVPacket *pkt, + AVBitStreamFilterContext *bsfc); +#endif + +enum AVTimebaseSource { + AVFMT_TBCF_AUTO = -1, + AVFMT_TBCF_DECODER, + AVFMT_TBCF_DEMUXER, +#if FF_API_R_FRAME_RATE + AVFMT_TBCF_R_FRAMERATE, +#endif +}; + +/** + * Transfer internal timing information from one stream to another. + * + * This function is useful when doing stream copy. + * + * @param ofmt target output format for ost + * @param ost output stream which needs timings copy and adjustments + * @param ist reference input stream to copy timings from + * @param copy_tb define from where the stream codec timebase needs to be imported + */ +int avformat_transfer_internal_stream_timing_info(const AVOutputFormat *ofmt, + AVStream *ost, const AVStream *ist, + enum AVTimebaseSource copy_tb); + +/** + * Get the internal codec timebase from a stream. + * + * @param st input stream to extract the timebase from + */ +AVRational av_stream_get_codec_timebase(const AVStream *st); + +/** + * @} + */ + +#endif /* AVFORMAT_AVFORMAT_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavformat/avio.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavformat/avio.h new file mode 100644 index 0000000..d022820 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavformat/avio.h @@ -0,0 +1,888 @@ +/* + * copyright (c) 2001 Fabrice Bellard + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ +#ifndef AVFORMAT_AVIO_H +#define AVFORMAT_AVIO_H + +/** + * @file + * @ingroup lavf_io + * Buffered I/O operations + */ + +#include + +#include "libavutil/common.h" +#include "libavutil/dict.h" +#include "libavutil/log.h" + +#include "libavformat/version.h" + +/** + * Seeking works like for a local file. + */ +#define AVIO_SEEKABLE_NORMAL (1 << 0) + +/** + * Seeking by timestamp with avio_seek_time() is possible. + */ +#define AVIO_SEEKABLE_TIME (1 << 1) + +/** + * Callback for checking whether to abort blocking functions. + * AVERROR_EXIT is returned in this case by the interrupted + * function. During blocking operations, callback is called with + * opaque as parameter. If the callback returns 1, the + * blocking operation will be aborted. + * + * No members can be added to this struct without a major bump, if + * new elements have been added after this struct in AVFormatContext + * or AVIOContext. + */ +typedef struct AVIOInterruptCB { + int (*callback)(void*); + void *opaque; +} AVIOInterruptCB; + +/** + * Directory entry types. + */ +enum AVIODirEntryType { + AVIO_ENTRY_UNKNOWN, + AVIO_ENTRY_BLOCK_DEVICE, + AVIO_ENTRY_CHARACTER_DEVICE, + AVIO_ENTRY_DIRECTORY, + AVIO_ENTRY_NAMED_PIPE, + AVIO_ENTRY_SYMBOLIC_LINK, + AVIO_ENTRY_SOCKET, + AVIO_ENTRY_FILE, + AVIO_ENTRY_SERVER, + AVIO_ENTRY_SHARE, + AVIO_ENTRY_WORKGROUP, +}; + +/** + * Describes single entry of the directory. + * + * Only name and type fields are guaranteed be set. + * Rest of fields are protocol or/and platform dependent and might be unknown. + */ +typedef struct AVIODirEntry { + char *name; /**< Filename */ + int type; /**< Type of the entry */ + int utf8; /**< Set to 1 when name is encoded with UTF-8, 0 otherwise. + Name can be encoded with UTF-8 even though 0 is set. */ + int64_t size; /**< File size in bytes, -1 if unknown. */ + int64_t modification_timestamp; /**< Time of last modification in microseconds since unix + epoch, -1 if unknown. */ + int64_t access_timestamp; /**< Time of last access in microseconds since unix epoch, + -1 if unknown. */ + int64_t status_change_timestamp; /**< Time of last status change in microseconds since unix + epoch, -1 if unknown. */ + int64_t user_id; /**< User ID of owner, -1 if unknown. */ + int64_t group_id; /**< Group ID of owner, -1 if unknown. */ + int64_t filemode; /**< Unix file mode, -1 if unknown. */ +} AVIODirEntry; + +typedef struct AVIODirContext { + struct URLContext *url_context; +} AVIODirContext; + +/** + * Different data types that can be returned via the AVIO + * write_data_type callback. + */ +enum AVIODataMarkerType { + /** + * Header data; this needs to be present for the stream to be decodeable. + */ + AVIO_DATA_MARKER_HEADER, + /** + * A point in the output bytestream where a decoder can start decoding + * (i.e. a keyframe). A demuxer/decoder given the data flagged with + * AVIO_DATA_MARKER_HEADER, followed by any AVIO_DATA_MARKER_SYNC_POINT, + * should give decodeable results. + */ + AVIO_DATA_MARKER_SYNC_POINT, + /** + * A point in the output bytestream where a demuxer can start parsing + * (for non self synchronizing bytestream formats). That is, any + * non-keyframe packet start point. + */ + AVIO_DATA_MARKER_BOUNDARY_POINT, + /** + * This is any, unlabelled data. It can either be a muxer not marking + * any positions at all, it can be an actual boundary/sync point + * that the muxer chooses not to mark, or a later part of a packet/fragment + * that is cut into multiple write callbacks due to limited IO buffer size. + */ + AVIO_DATA_MARKER_UNKNOWN, + /** + * Trailer data, which doesn't contain actual content, but only for + * finalizing the output file. + */ + AVIO_DATA_MARKER_TRAILER, + /** + * A point in the output bytestream where the underlying AVIOContext might + * flush the buffer depending on latency or buffering requirements. Typically + * means the end of a packet. + */ + AVIO_DATA_MARKER_FLUSH_POINT, +}; + +/** + * Bytestream IO Context. + * New fields can be added to the end with minor version bumps. + * Removal, reordering and changes to existing fields require a major + * version bump. + * sizeof(AVIOContext) must not be used outside libav*. + * + * @note None of the function pointers in AVIOContext should be called + * directly, they should only be set by the client application + * when implementing custom I/O. Normally these are set to the + * function pointers specified in avio_alloc_context() + */ +typedef struct AVIOContext { + /** + * A class for private options. + * + * If this AVIOContext is created by avio_open2(), av_class is set and + * passes the options down to protocols. + * + * If this AVIOContext is manually allocated, then av_class may be set by + * the caller. + * + * warning -- this field can be NULL, be sure to not pass this AVIOContext + * to any av_opt_* functions in that case. + */ + const AVClass *av_class; + + /* + * The following shows the relationship between buffer, buf_ptr, + * buf_ptr_max, buf_end, buf_size, and pos, when reading and when writing + * (since AVIOContext is used for both): + * + ********************************************************************************** + * READING + ********************************************************************************** + * + * | buffer_size | + * |---------------------------------------| + * | | + * + * buffer buf_ptr buf_end + * +---------------+-----------------------+ + * |/ / / / / / / /|/ / / / / / /| | + * read buffer: |/ / consumed / | to be read /| | + * |/ / / / / / / /|/ / / / / / /| | + * +---------------+-----------------------+ + * + * pos + * +-------------------------------------------+-----------------+ + * input file: | | | + * +-------------------------------------------+-----------------+ + * + * + ********************************************************************************** + * WRITING + ********************************************************************************** + * + * | buffer_size | + * |--------------------------------------| + * | | + * + * buf_ptr_max + * buffer (buf_ptr) buf_end + * +-----------------------+--------------+ + * |/ / / / / / / / / / / /| | + * write buffer: | / / to be flushed / / | | + * |/ / / / / / / / / / / /| | + * +-----------------------+--------------+ + * buf_ptr can be in this + * due to a backward seek + * + * pos + * +-------------+----------------------------------------------+ + * output file: | | | + * +-------------+----------------------------------------------+ + * + */ + unsigned char *buffer; /**< Start of the buffer. */ + int buffer_size; /**< Maximum buffer size */ + unsigned char *buf_ptr; /**< Current position in the buffer */ + unsigned char *buf_end; /**< End of the data, may be less than + buffer+buffer_size if the read function returned + less data than requested, e.g. for streams where + no more data has been received yet. */ + void *opaque; /**< A private pointer, passed to the read/write/seek/... + functions. */ + int (*read_packet)(void *opaque, uint8_t *buf, int buf_size); + int (*write_packet)(void *opaque, uint8_t *buf, int buf_size); + int64_t (*seek)(void *opaque, int64_t offset, int whence); + int64_t pos; /**< position in the file of the current buffer */ + int eof_reached; /**< true if was unable to read due to error or eof */ + int write_flag; /**< true if open for writing */ + int max_packet_size; + unsigned long checksum; + unsigned char *checksum_ptr; + unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size); + int error; /**< contains the error code or 0 if no error happened */ + /** + * Pause or resume playback for network streaming protocols - e.g. MMS. + */ + int (*read_pause)(void *opaque, int pause); + /** + * Seek to a given timestamp in stream with the specified stream_index. + * Needed for some network streaming protocols which don't support seeking + * to byte position. + */ + int64_t (*read_seek)(void *opaque, int stream_index, + int64_t timestamp, int flags); + /** + * A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable. + */ + int seekable; + + /** + * max filesize, used to limit allocations + * This field is internal to libavformat and access from outside is not allowed. + */ + int64_t maxsize; + + /** + * avio_read and avio_write should if possible be satisfied directly + * instead of going through a buffer, and avio_seek will always + * call the underlying seek function directly. + */ + int direct; + + /** + * Bytes read statistic + * This field is internal to libavformat and access from outside is not allowed. + */ + int64_t bytes_read; + + /** + * seek statistic + * This field is internal to libavformat and access from outside is not allowed. + */ + int seek_count; + + /** + * writeout statistic + * This field is internal to libavformat and access from outside is not allowed. + */ + int writeout_count; + + /** + * Original buffer size + * used internally after probing and ensure seekback to reset the buffer size + * This field is internal to libavformat and access from outside is not allowed. + */ + int orig_buffer_size; + + /** + * Threshold to favor readahead over seek. + * This is current internal only, do not use from outside. + */ + int short_seek_threshold; + + /** + * ',' separated list of allowed protocols. + */ + const char *protocol_whitelist; + + /** + * ',' separated list of disallowed protocols. + */ + const char *protocol_blacklist; + + /** + * A callback that is used instead of write_packet. + */ + int (*write_data_type)(void *opaque, uint8_t *buf, int buf_size, + enum AVIODataMarkerType type, int64_t time); + /** + * If set, don't call write_data_type separately for AVIO_DATA_MARKER_BOUNDARY_POINT, + * but ignore them and treat them as AVIO_DATA_MARKER_UNKNOWN (to avoid needlessly + * small chunks of data returned from the callback). + */ + int ignore_boundary_point; + + /** + * Internal, not meant to be used from outside of AVIOContext. + */ + enum AVIODataMarkerType current_type; + int64_t last_time; + + /** + * A callback that is used instead of short_seek_threshold. + * This is current internal only, do not use from outside. + */ + int (*short_seek_get)(void *opaque); + + int64_t written; + + /** + * Maximum reached position before a backward seek in the write buffer, + * used keeping track of already written data for a later flush. + */ + unsigned char *buf_ptr_max; + + /** + * Try to buffer at least this amount of data before flushing it + */ + int min_packet_size; +} AVIOContext; + +/** + * Return the name of the protocol that will handle the passed URL. + * + * NULL is returned if no protocol could be found for the given URL. + * + * @return Name of the protocol or NULL. + */ +const char *avio_find_protocol_name(const char *url); + +/** + * Return AVIO_FLAG_* access flags corresponding to the access permissions + * of the resource in url, or a negative value corresponding to an + * AVERROR code in case of failure. The returned access flags are + * masked by the value in flags. + * + * @note This function is intrinsically unsafe, in the sense that the + * checked resource may change its existence or permission status from + * one call to another. Thus you should not trust the returned value, + * unless you are sure that no other processes are accessing the + * checked resource. + */ +int avio_check(const char *url, int flags); + +/** + * Move or rename a resource. + * + * @note url_src and url_dst should share the same protocol and authority. + * + * @param url_src url to resource to be moved + * @param url_dst new url to resource if the operation succeeded + * @return >=0 on success or negative on error. + */ +int avpriv_io_move(const char *url_src, const char *url_dst); + +/** + * Delete a resource. + * + * @param url resource to be deleted. + * @return >=0 on success or negative on error. + */ +int avpriv_io_delete(const char *url); + +/** + * Open directory for reading. + * + * @param s directory read context. Pointer to a NULL pointer must be passed. + * @param url directory to be listed. + * @param options A dictionary filled with protocol-private options. On return + * this parameter will be destroyed and replaced with a dictionary + * containing options that were not found. May be NULL. + * @return >=0 on success or negative on error. + */ +int avio_open_dir(AVIODirContext **s, const char *url, AVDictionary **options); + +/** + * Get next directory entry. + * + * Returned entry must be freed with avio_free_directory_entry(). In particular + * it may outlive AVIODirContext. + * + * @param s directory read context. + * @param[out] next next entry or NULL when no more entries. + * @return >=0 on success or negative on error. End of list is not considered an + * error. + */ +int avio_read_dir(AVIODirContext *s, AVIODirEntry **next); + +/** + * Close directory. + * + * @note Entries created using avio_read_dir() are not deleted and must be + * freeded with avio_free_directory_entry(). + * + * @param s directory read context. + * @return >=0 on success or negative on error. + */ +int avio_close_dir(AVIODirContext **s); + +/** + * Free entry allocated by avio_read_dir(). + * + * @param entry entry to be freed. + */ +void avio_free_directory_entry(AVIODirEntry **entry); + +/** + * Allocate and initialize an AVIOContext for buffered I/O. It must be later + * freed with avio_context_free(). + * + * @param buffer Memory block for input/output operations via AVIOContext. + * The buffer must be allocated with av_malloc() and friends. + * It may be freed and replaced with a new buffer by libavformat. + * AVIOContext.buffer holds the buffer currently in use, + * which must be later freed with av_free(). + * @param buffer_size The buffer size is very important for performance. + * For protocols with fixed blocksize it should be set to this blocksize. + * For others a typical size is a cache page, e.g. 4kb. + * @param write_flag Set to 1 if the buffer should be writable, 0 otherwise. + * @param opaque An opaque pointer to user-specific data. + * @param read_packet A function for refilling the buffer, may be NULL. + * For stream protocols, must never return 0 but rather + * a proper AVERROR code. + * @param write_packet A function for writing the buffer contents, may be NULL. + * The function may not change the input buffers content. + * @param seek A function for seeking to specified byte position, may be NULL. + * + * @return Allocated AVIOContext or NULL on failure. + */ +AVIOContext *avio_alloc_context( + unsigned char *buffer, + int buffer_size, + int write_flag, + void *opaque, + int (*read_packet)(void *opaque, uint8_t *buf, int buf_size), + int (*write_packet)(void *opaque, uint8_t *buf, int buf_size), + int64_t (*seek)(void *opaque, int64_t offset, int whence)); + +/** + * Free the supplied IO context and everything associated with it. + * + * @param s Double pointer to the IO context. This function will write NULL + * into s. + */ +void avio_context_free(AVIOContext **s); + +void avio_w8(AVIOContext *s, int b); +void avio_write(AVIOContext *s, const unsigned char *buf, int size); +void avio_wl64(AVIOContext *s, uint64_t val); +void avio_wb64(AVIOContext *s, uint64_t val); +void avio_wl32(AVIOContext *s, unsigned int val); +void avio_wb32(AVIOContext *s, unsigned int val); +void avio_wl24(AVIOContext *s, unsigned int val); +void avio_wb24(AVIOContext *s, unsigned int val); +void avio_wl16(AVIOContext *s, unsigned int val); +void avio_wb16(AVIOContext *s, unsigned int val); + +/** + * Write a NULL-terminated string. + * @return number of bytes written. + */ +int avio_put_str(AVIOContext *s, const char *str); + +/** + * Convert an UTF-8 string to UTF-16LE and write it. + * @param s the AVIOContext + * @param str NULL-terminated UTF-8 string + * + * @return number of bytes written. + */ +int avio_put_str16le(AVIOContext *s, const char *str); + +/** + * Convert an UTF-8 string to UTF-16BE and write it. + * @param s the AVIOContext + * @param str NULL-terminated UTF-8 string + * + * @return number of bytes written. + */ +int avio_put_str16be(AVIOContext *s, const char *str); + +/** + * Mark the written bytestream as a specific type. + * + * Zero-length ranges are omitted from the output. + * + * @param time the stream time the current bytestream pos corresponds to + * (in AV_TIME_BASE units), or AV_NOPTS_VALUE if unknown or not + * applicable + * @param type the kind of data written starting at the current pos + */ +void avio_write_marker(AVIOContext *s, int64_t time, enum AVIODataMarkerType type); + +/** + * ORing this as the "whence" parameter to a seek function causes it to + * return the filesize without seeking anywhere. Supporting this is optional. + * If it is not supported then the seek function will return <0. + */ +#define AVSEEK_SIZE 0x10000 + +/** + * Passing this flag as the "whence" parameter to a seek function causes it to + * seek by any means (like reopening and linear reading) or other normally unreasonable + * means that can be extremely slow. + * This may be ignored by the seek code. + */ +#define AVSEEK_FORCE 0x20000 + +/** + * fseek() equivalent for AVIOContext. + * @return new position or AVERROR. + */ +int64_t avio_seek(AVIOContext *s, int64_t offset, int whence); + +/** + * Skip given number of bytes forward + * @return new position or AVERROR. + */ +int64_t avio_skip(AVIOContext *s, int64_t offset); + +/** + * ftell() equivalent for AVIOContext. + * @return position or AVERROR. + */ +static av_always_inline int64_t avio_tell(AVIOContext *s) +{ + return avio_seek(s, 0, SEEK_CUR); +} + +/** + * Get the filesize. + * @return filesize or AVERROR + */ +int64_t avio_size(AVIOContext *s); + +/** + * Similar to feof() but also returns nonzero on read errors. + * @return non zero if and only if at end of file or a read error happened when reading. + */ +int avio_feof(AVIOContext *s); + +/** + * Writes a formatted string to the context. + * @return number of bytes written, < 0 on error. + */ +int avio_printf(AVIOContext *s, const char *fmt, ...) av_printf_format(2, 3); + +/** + * Write a NULL terminated array of strings to the context. + * Usually you don't need to use this function directly but its macro wrapper, + * avio_print. + */ +void avio_print_string_array(AVIOContext *s, const char *strings[]); + +/** + * Write strings (const char *) to the context. + * This is a convenience macro around avio_print_string_array and it + * automatically creates the string array from the variable argument list. + * For simple string concatenations this function is more performant than using + * avio_printf since it does not need a temporary buffer. + */ +#define avio_print(s, ...) \ + avio_print_string_array(s, (const char*[]){__VA_ARGS__, NULL}) + +/** + * Force flushing of buffered data. + * + * For write streams, force the buffered data to be immediately written to the output, + * without to wait to fill the internal buffer. + * + * For read streams, discard all currently buffered data, and advance the + * reported file position to that of the underlying stream. This does not + * read new data, and does not perform any seeks. + */ +void avio_flush(AVIOContext *s); + +/** + * Read size bytes from AVIOContext into buf. + * @return number of bytes read or AVERROR + */ +int avio_read(AVIOContext *s, unsigned char *buf, int size); + +/** + * Read size bytes from AVIOContext into buf. Unlike avio_read(), this is allowed + * to read fewer bytes than requested. The missing bytes can be read in the next + * call. This always tries to read at least 1 byte. + * Useful to reduce latency in certain cases. + * @return number of bytes read or AVERROR + */ +int avio_read_partial(AVIOContext *s, unsigned char *buf, int size); + +/** + * @name Functions for reading from AVIOContext + * @{ + * + * @note return 0 if EOF, so you cannot use it if EOF handling is + * necessary + */ +int avio_r8 (AVIOContext *s); +unsigned int avio_rl16(AVIOContext *s); +unsigned int avio_rl24(AVIOContext *s); +unsigned int avio_rl32(AVIOContext *s); +uint64_t avio_rl64(AVIOContext *s); +unsigned int avio_rb16(AVIOContext *s); +unsigned int avio_rb24(AVIOContext *s); +unsigned int avio_rb32(AVIOContext *s); +uint64_t avio_rb64(AVIOContext *s); +/** + * @} + */ + +/** + * Read a string from pb into buf. The reading will terminate when either + * a NULL character was encountered, maxlen bytes have been read, or nothing + * more can be read from pb. The result is guaranteed to be NULL-terminated, it + * will be truncated if buf is too small. + * Note that the string is not interpreted or validated in any way, it + * might get truncated in the middle of a sequence for multi-byte encodings. + * + * @return number of bytes read (is always <= maxlen). + * If reading ends on EOF or error, the return value will be one more than + * bytes actually read. + */ +int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen); + +/** + * Read a UTF-16 string from pb and convert it to UTF-8. + * The reading will terminate when either a null or invalid character was + * encountered or maxlen bytes have been read. + * @return number of bytes read (is always <= maxlen) + */ +int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen); +int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen); + + +/** + * @name URL open modes + * The flags argument to avio_open must be one of the following + * constants, optionally ORed with other flags. + * @{ + */ +#define AVIO_FLAG_READ 1 /**< read-only */ +#define AVIO_FLAG_WRITE 2 /**< write-only */ +#define AVIO_FLAG_READ_WRITE (AVIO_FLAG_READ|AVIO_FLAG_WRITE) /**< read-write pseudo flag */ +/** + * @} + */ + +/** + * Use non-blocking mode. + * If this flag is set, operations on the context will return + * AVERROR(EAGAIN) if they can not be performed immediately. + * If this flag is not set, operations on the context will never return + * AVERROR(EAGAIN). + * Note that this flag does not affect the opening/connecting of the + * context. Connecting a protocol will always block if necessary (e.g. on + * network protocols) but never hang (e.g. on busy devices). + * Warning: non-blocking protocols is work-in-progress; this flag may be + * silently ignored. + */ +#define AVIO_FLAG_NONBLOCK 8 + +/** + * Use direct mode. + * avio_read and avio_write should if possible be satisfied directly + * instead of going through a buffer, and avio_seek will always + * call the underlying seek function directly. + */ +#define AVIO_FLAG_DIRECT 0x8000 + +/** + * Create and initialize a AVIOContext for accessing the + * resource indicated by url. + * @note When the resource indicated by url has been opened in + * read+write mode, the AVIOContext can be used only for writing. + * + * @param s Used to return the pointer to the created AVIOContext. + * In case of failure the pointed to value is set to NULL. + * @param url resource to access + * @param flags flags which control how the resource indicated by url + * is to be opened + * @return >= 0 in case of success, a negative value corresponding to an + * AVERROR code in case of failure + */ +int avio_open(AVIOContext **s, const char *url, int flags); + +/** + * Create and initialize a AVIOContext for accessing the + * resource indicated by url. + * @note When the resource indicated by url has been opened in + * read+write mode, the AVIOContext can be used only for writing. + * + * @param s Used to return the pointer to the created AVIOContext. + * In case of failure the pointed to value is set to NULL. + * @param url resource to access + * @param flags flags which control how the resource indicated by url + * is to be opened + * @param int_cb an interrupt callback to be used at the protocols level + * @param options A dictionary filled with protocol-private options. On return + * this parameter will be destroyed and replaced with a dict containing options + * that were not found. May be NULL. + * @return >= 0 in case of success, a negative value corresponding to an + * AVERROR code in case of failure + */ +int avio_open2(AVIOContext **s, const char *url, int flags, + const AVIOInterruptCB *int_cb, AVDictionary **options); + +/** + * Close the resource accessed by the AVIOContext s and free it. + * This function can only be used if s was opened by avio_open(). + * + * The internal buffer is automatically flushed before closing the + * resource. + * + * @return 0 on success, an AVERROR < 0 on error. + * @see avio_closep + */ +int avio_close(AVIOContext *s); + +/** + * Close the resource accessed by the AVIOContext *s, free it + * and set the pointer pointing to it to NULL. + * This function can only be used if s was opened by avio_open(). + * + * The internal buffer is automatically flushed before closing the + * resource. + * + * @return 0 on success, an AVERROR < 0 on error. + * @see avio_close + */ +int avio_closep(AVIOContext **s); + + +/** + * Open a write only memory stream. + * + * @param s new IO context + * @return zero if no error. + */ +int avio_open_dyn_buf(AVIOContext **s); + +/** + * Return the written size and a pointer to the buffer. + * The AVIOContext stream is left intact. + * The buffer must NOT be freed. + * No padding is added to the buffer. + * + * @param s IO context + * @param pbuffer pointer to a byte buffer + * @return the length of the byte buffer + */ +int avio_get_dyn_buf(AVIOContext *s, uint8_t **pbuffer); + +/** + * Return the written size and a pointer to the buffer. The buffer + * must be freed with av_free(). + * Padding of AV_INPUT_BUFFER_PADDING_SIZE is added to the buffer. + * + * @param s IO context + * @param pbuffer pointer to a byte buffer + * @return the length of the byte buffer + */ +int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer); + +/** + * Iterate through names of available protocols. + * + * @param opaque A private pointer representing current protocol. + * It must be a pointer to NULL on first iteration and will + * be updated by successive calls to avio_enum_protocols. + * @param output If set to 1, iterate over output protocols, + * otherwise over input protocols. + * + * @return A static string containing the name of current protocol or NULL + */ +const char *avio_enum_protocols(void **opaque, int output); + +/** + * Get AVClass by names of available protocols. + * + * @return A AVClass of input protocol name or NULL + */ +const AVClass *avio_protocol_get_class(const char *name); + +/** + * Pause and resume playing - only meaningful if using a network streaming + * protocol (e.g. MMS). + * + * @param h IO context from which to call the read_pause function pointer + * @param pause 1 for pause, 0 for resume + */ +int avio_pause(AVIOContext *h, int pause); + +/** + * Seek to a given timestamp relative to some component stream. + * Only meaningful if using a network streaming protocol (e.g. MMS.). + * + * @param h IO context from which to call the seek function pointers + * @param stream_index The stream index that the timestamp is relative to. + * If stream_index is (-1) the timestamp should be in AV_TIME_BASE + * units from the beginning of the presentation. + * If a stream_index >= 0 is used and the protocol does not support + * seeking based on component streams, the call will fail. + * @param timestamp timestamp in AVStream.time_base units + * or if there is no stream specified then in AV_TIME_BASE units. + * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE + * and AVSEEK_FLAG_ANY. The protocol may silently ignore + * AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will + * fail if used and not supported. + * @return >= 0 on success + * @see AVInputFormat::read_seek + */ +int64_t avio_seek_time(AVIOContext *h, int stream_index, + int64_t timestamp, int flags); + +/* Avoid a warning. The header can not be included because it breaks c++. */ +struct AVBPrint; + +/** + * Read contents of h into print buffer, up to max_size bytes, or up to EOF. + * + * @return 0 for success (max_size bytes read or EOF reached), negative error + * code otherwise + */ +int avio_read_to_bprint(AVIOContext *h, struct AVBPrint *pb, size_t max_size); + +/** + * Accept and allocate a client context on a server context. + * @param s the server context + * @param c the client context, must be unallocated + * @return >= 0 on success or a negative value corresponding + * to an AVERROR on failure + */ +int avio_accept(AVIOContext *s, AVIOContext **c); + +/** + * Perform one step of the protocol handshake to accept a new client. + * This function must be called on a client returned by avio_accept() before + * using it as a read/write context. + * It is separate from avio_accept() because it may block. + * A step of the handshake is defined by places where the application may + * decide to change the proceedings. + * For example, on a protocol with a request header and a reply header, each + * one can constitute a step because the application may use the parameters + * from the request to change parameters in the reply; or each individual + * chunk of the request can constitute a step. + * If the handshake is already finished, avio_handshake() does nothing and + * returns 0 immediately. + * + * @param c the client context to perform the handshake on + * @return 0 on a complete and successful handshake + * > 0 if the handshake progressed, but is not complete + * < 0 for an AVERROR code + */ +int avio_handshake(AVIOContext *c); +#endif /* AVFORMAT_AVIO_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavformat/version.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavformat/version.h new file mode 100644 index 0000000..13c8a61 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavformat/version.h @@ -0,0 +1,114 @@ +/* + * Version macros. + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVFORMAT_VERSION_H +#define AVFORMAT_VERSION_H + +/** + * @file + * @ingroup libavf + * Libavformat version macros + */ + +#include "libavutil/version.h" + +// Major bumping may affect Ticket5467, 5421, 5451(compatibility with Chromium) +// Also please add any ticket numbers that you believe might be affected here +#define LIBAVFORMAT_VERSION_MAJOR 58 +#define LIBAVFORMAT_VERSION_MINOR 45 +#define LIBAVFORMAT_VERSION_MICRO 100 + +#define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \ + LIBAVFORMAT_VERSION_MINOR, \ + LIBAVFORMAT_VERSION_MICRO) +#define LIBAVFORMAT_VERSION AV_VERSION(LIBAVFORMAT_VERSION_MAJOR, \ + LIBAVFORMAT_VERSION_MINOR, \ + LIBAVFORMAT_VERSION_MICRO) +#define LIBAVFORMAT_BUILD LIBAVFORMAT_VERSION_INT + +#define LIBAVFORMAT_IDENT "Lavf" AV_STRINGIFY(LIBAVFORMAT_VERSION) + +/** + * FF_API_* defines may be placed below to indicate public API that will be + * dropped at a future version bump. The defines themselves are not part of + * the public API and may change, break or disappear at any time. + * + * @note, when bumping the major version it is recommended to manually + * disable each FF_API_* in its own commit instead of disabling them all + * at once through the bump. This improves the git bisect-ability of the change. + * + */ +#ifndef FF_API_COMPUTE_PKT_FIELDS2 +#define FF_API_COMPUTE_PKT_FIELDS2 (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_OLD_OPEN_CALLBACKS +#define FF_API_OLD_OPEN_CALLBACKS (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_LAVF_AVCTX +#define FF_API_LAVF_AVCTX (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_HTTP_USER_AGENT +#define FF_API_HTTP_USER_AGENT (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_HLS_WRAP +#define FF_API_HLS_WRAP (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_HLS_USE_LOCALTIME +#define FF_API_HLS_USE_LOCALTIME (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_LAVF_KEEPSIDE_FLAG +#define FF_API_LAVF_KEEPSIDE_FLAG (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_OLD_ROTATE_API +#define FF_API_OLD_ROTATE_API (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_FORMAT_GET_SET +#define FF_API_FORMAT_GET_SET (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_OLD_AVIO_EOF_0 +#define FF_API_OLD_AVIO_EOF_0 (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_LAVF_FFSERVER +#define FF_API_LAVF_FFSERVER (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_FORMAT_FILENAME +#define FF_API_FORMAT_FILENAME (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_OLD_RTSP_OPTIONS +#define FF_API_OLD_RTSP_OPTIONS (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_NEXT +#define FF_API_NEXT (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_DASH_MIN_SEG_DURATION +#define FF_API_DASH_MIN_SEG_DURATION (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_LAVF_MP4A_LATM +#define FF_API_LAVF_MP4A_LATM (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif +#ifndef FF_API_AVIOFORMAT +#define FF_API_AVIOFORMAT (LIBAVFORMAT_VERSION_MAJOR < 59) +#endif + + +#ifndef FF_API_R_FRAME_RATE +#define FF_API_R_FRAME_RATE 1 +#endif +#endif /* AVFORMAT_VERSION_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/adler32.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/adler32.h new file mode 100644 index 0000000..a1f035b --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/adler32.h @@ -0,0 +1,60 @@ +/* + * copyright (c) 2006 Mans Rullgard + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @ingroup lavu_adler32 + * Public header for Adler-32 hash function implementation. + */ + +#ifndef AVUTIL_ADLER32_H +#define AVUTIL_ADLER32_H + +#include +#include "attributes.h" + +/** + * @defgroup lavu_adler32 Adler-32 + * @ingroup lavu_hash + * Adler-32 hash function implementation. + * + * @{ + */ + +/** + * Calculate the Adler32 checksum of a buffer. + * + * Passing the return value to a subsequent av_adler32_update() call + * allows the checksum of multiple buffers to be calculated as though + * they were concatenated. + * + * @param adler initial checksum value + * @param buf pointer to input buffer + * @param len size of input buffer + * @return updated checksum + */ +unsigned long av_adler32_update(unsigned long adler, const uint8_t *buf, + unsigned int len) av_pure; + +/** + * @} + */ + +#endif /* AVUTIL_ADLER32_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/aes.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/aes.h new file mode 100644 index 0000000..09efbda --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/aes.h @@ -0,0 +1,65 @@ +/* + * copyright (c) 2007 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_AES_H +#define AVUTIL_AES_H + +#include + +#include "attributes.h" +#include "version.h" + +/** + * @defgroup lavu_aes AES + * @ingroup lavu_crypto + * @{ + */ + +extern const int av_aes_size; + +struct AVAES; + +/** + * Allocate an AVAES context. + */ +struct AVAES *av_aes_alloc(void); + +/** + * Initialize an AVAES context. + * @param key_bits 128, 192 or 256 + * @param decrypt 0 for encryption, 1 for decryption + */ +int av_aes_init(struct AVAES *a, const uint8_t *key, int key_bits, int decrypt); + +/** + * Encrypt or decrypt a buffer using a previously initialized context. + * @param count number of 16 byte blocks + * @param dst destination array, can be equal to src + * @param src source array, can be equal to dst + * @param iv initialization vector for CBC mode, if NULL then ECB will be used + * @param decrypt 0 for encryption, 1 for decryption + */ +void av_aes_crypt(struct AVAES *a, uint8_t *dst, const uint8_t *src, int count, uint8_t *iv, int decrypt); + +/** + * @} + */ + +#endif /* AVUTIL_AES_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/aes_ctr.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/aes_ctr.h new file mode 100644 index 0000000..e4aae12 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/aes_ctr.h @@ -0,0 +1,88 @@ +/* + * AES-CTR cipher + * Copyright (c) 2015 Eran Kornblau + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_AES_CTR_H +#define AVUTIL_AES_CTR_H + +#include + +#include "attributes.h" +#include "version.h" + +#define AES_CTR_KEY_SIZE (16) +#define AES_CTR_IV_SIZE (8) + +struct AVAESCTR; + +/** + * Allocate an AVAESCTR context. + */ +struct AVAESCTR *av_aes_ctr_alloc(void); + +/** + * Initialize an AVAESCTR context. + * @param key encryption key, must have a length of AES_CTR_KEY_SIZE + */ +int av_aes_ctr_init(struct AVAESCTR *a, const uint8_t *key); + +/** + * Release an AVAESCTR context. + */ +void av_aes_ctr_free(struct AVAESCTR *a); + +/** + * Process a buffer using a previously initialized context. + * @param dst destination array, can be equal to src + * @param src source array, can be equal to dst + * @param size the size of src and dst + */ +void av_aes_ctr_crypt(struct AVAESCTR *a, uint8_t *dst, const uint8_t *src, int size); + +/** + * Get the current iv + */ +const uint8_t* av_aes_ctr_get_iv(struct AVAESCTR *a); + +/** + * Generate a random iv + */ +void av_aes_ctr_set_random_iv(struct AVAESCTR *a); + +/** + * Forcefully change the 8-byte iv + */ +void av_aes_ctr_set_iv(struct AVAESCTR *a, const uint8_t* iv); + +/** + * Forcefully change the "full" 16-byte iv, including the counter + */ +void av_aes_ctr_set_full_iv(struct AVAESCTR *a, const uint8_t* iv); + +/** + * Increment the top 64 bit of the iv (performed after each frame) + */ +void av_aes_ctr_increment_iv(struct AVAESCTR *a); + +/** + * @} + */ + +#endif /* AVUTIL_AES_CTR_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/attributes.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/attributes.h new file mode 100644 index 0000000..5cb9fe3 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/attributes.h @@ -0,0 +1,173 @@ +/* + * copyright (c) 2006 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * Macro definitions for various function/variable attributes + */ + +#ifndef AVUTIL_ATTRIBUTES_H +#define AVUTIL_ATTRIBUTES_H + +#ifdef __GNUC__ +# define AV_GCC_VERSION_AT_LEAST(x,y) (__GNUC__ > (x) || __GNUC__ == (x) && __GNUC_MINOR__ >= (y)) +# define AV_GCC_VERSION_AT_MOST(x,y) (__GNUC__ < (x) || __GNUC__ == (x) && __GNUC_MINOR__ <= (y)) +#else +# define AV_GCC_VERSION_AT_LEAST(x,y) 0 +# define AV_GCC_VERSION_AT_MOST(x,y) 0 +#endif + +#ifdef __has_builtin +# define AV_HAS_BUILTIN(x) __has_builtin(x) +#else +# define AV_HAS_BUILTIN(x) 0 +#endif + +#ifndef av_always_inline +#if AV_GCC_VERSION_AT_LEAST(3,1) +# define av_always_inline __attribute__((always_inline)) inline +#elif defined(_MSC_VER) +# define av_always_inline __forceinline +#else +# define av_always_inline inline +#endif +#endif + +#ifndef av_extern_inline +#if defined(__ICL) && __ICL >= 1210 || defined(__GNUC_STDC_INLINE__) +# define av_extern_inline extern inline +#else +# define av_extern_inline inline +#endif +#endif + +#if AV_GCC_VERSION_AT_LEAST(3,4) +# define av_warn_unused_result __attribute__((warn_unused_result)) +#else +# define av_warn_unused_result +#endif + +#if AV_GCC_VERSION_AT_LEAST(3,1) +# define av_noinline __attribute__((noinline)) +#elif defined(_MSC_VER) +# define av_noinline __declspec(noinline) +#else +# define av_noinline +#endif + +#if AV_GCC_VERSION_AT_LEAST(3,1) || defined(__clang__) +# define av_pure __attribute__((pure)) +#else +# define av_pure +#endif + +#if AV_GCC_VERSION_AT_LEAST(2,6) || defined(__clang__) +# define av_const __attribute__((const)) +#else +# define av_const +#endif + +#if AV_GCC_VERSION_AT_LEAST(4,3) || defined(__clang__) +# define av_cold __attribute__((cold)) +#else +# define av_cold +#endif + +#if AV_GCC_VERSION_AT_LEAST(4,1) && !defined(__llvm__) +# define av_flatten __attribute__((flatten)) +#else +# define av_flatten +#endif + +#if AV_GCC_VERSION_AT_LEAST(3,1) +# define attribute_deprecated __attribute__((deprecated)) +#elif defined(_MSC_VER) +# define attribute_deprecated __declspec(deprecated) +#else +# define attribute_deprecated +#endif + +/** + * Disable warnings about deprecated features + * This is useful for sections of code kept for backward compatibility and + * scheduled for removal. + */ +#ifndef AV_NOWARN_DEPRECATED +#if AV_GCC_VERSION_AT_LEAST(4,6) +# define AV_NOWARN_DEPRECATED(code) \ + _Pragma("GCC diagnostic push") \ + _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") \ + code \ + _Pragma("GCC diagnostic pop") +#elif defined(_MSC_VER) +# define AV_NOWARN_DEPRECATED(code) \ + __pragma(warning(push)) \ + __pragma(warning(disable : 4996)) \ + code; \ + __pragma(warning(pop)) +#else +# define AV_NOWARN_DEPRECATED(code) code +#endif +#endif + +#if defined(__GNUC__) || defined(__clang__) +# define av_unused __attribute__((unused)) +#else +# define av_unused +#endif + +/** + * Mark a variable as used and prevent the compiler from optimizing it + * away. This is useful for variables accessed only from inline + * assembler without the compiler being aware. + */ +#if AV_GCC_VERSION_AT_LEAST(3,1) || defined(__clang__) +# define av_used __attribute__((used)) +#else +# define av_used +#endif + +#if AV_GCC_VERSION_AT_LEAST(3,3) || defined(__clang__) +# define av_alias __attribute__((may_alias)) +#else +# define av_alias +#endif + +#if (defined(__GNUC__) || defined(__clang__)) && !defined(__INTEL_COMPILER) +# define av_uninit(x) x=x +#else +# define av_uninit(x) x +#endif + +#if defined(__GNUC__) || defined(__clang__) +# define av_builtin_constant_p __builtin_constant_p +# define av_printf_format(fmtpos, attrpos) __attribute__((__format__(__printf__, fmtpos, attrpos))) +#else +# define av_builtin_constant_p(x) 0 +# define av_printf_format(fmtpos, attrpos) +#endif + +#if AV_GCC_VERSION_AT_LEAST(2,5) || defined(__clang__) +# define av_noreturn __attribute__((noreturn)) +#else +# define av_noreturn +#endif + +#endif /* AVUTIL_ATTRIBUTES_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/audio_fifo.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/audio_fifo.h new file mode 100644 index 0000000..d8a9194 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/audio_fifo.h @@ -0,0 +1,187 @@ +/* + * Audio FIFO + * Copyright (c) 2012 Justin Ruggles + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * Audio FIFO Buffer + */ + +#ifndef AVUTIL_AUDIO_FIFO_H +#define AVUTIL_AUDIO_FIFO_H + +#include "avutil.h" +#include "fifo.h" +#include "samplefmt.h" + +/** + * @addtogroup lavu_audio + * @{ + * + * @defgroup lavu_audiofifo Audio FIFO Buffer + * @{ + */ + +/** + * Context for an Audio FIFO Buffer. + * + * - Operates at the sample level rather than the byte level. + * - Supports multiple channels with either planar or packed sample format. + * - Automatic reallocation when writing to a full buffer. + */ +typedef struct AVAudioFifo AVAudioFifo; + +/** + * Free an AVAudioFifo. + * + * @param af AVAudioFifo to free + */ +void av_audio_fifo_free(AVAudioFifo *af); + +/** + * Allocate an AVAudioFifo. + * + * @param sample_fmt sample format + * @param channels number of channels + * @param nb_samples initial allocation size, in samples + * @return newly allocated AVAudioFifo, or NULL on error + */ +AVAudioFifo *av_audio_fifo_alloc(enum AVSampleFormat sample_fmt, int channels, + int nb_samples); + +/** + * Reallocate an AVAudioFifo. + * + * @param af AVAudioFifo to reallocate + * @param nb_samples new allocation size, in samples + * @return 0 if OK, or negative AVERROR code on failure + */ +av_warn_unused_result +int av_audio_fifo_realloc(AVAudioFifo *af, int nb_samples); + +/** + * Write data to an AVAudioFifo. + * + * The AVAudioFifo will be reallocated automatically if the available space + * is less than nb_samples. + * + * @see enum AVSampleFormat + * The documentation for AVSampleFormat describes the data layout. + * + * @param af AVAudioFifo to write to + * @param data audio data plane pointers + * @param nb_samples number of samples to write + * @return number of samples actually written, or negative AVERROR + * code on failure. If successful, the number of samples + * actually written will always be nb_samples. + */ +int av_audio_fifo_write(AVAudioFifo *af, void **data, int nb_samples); + +/** + * Peek data from an AVAudioFifo. + * + * @see enum AVSampleFormat + * The documentation for AVSampleFormat describes the data layout. + * + * @param af AVAudioFifo to read from + * @param data audio data plane pointers + * @param nb_samples number of samples to peek + * @return number of samples actually peek, or negative AVERROR code + * on failure. The number of samples actually peek will not + * be greater than nb_samples, and will only be less than + * nb_samples if av_audio_fifo_size is less than nb_samples. + */ +int av_audio_fifo_peek(AVAudioFifo *af, void **data, int nb_samples); + +/** + * Peek data from an AVAudioFifo. + * + * @see enum AVSampleFormat + * The documentation for AVSampleFormat describes the data layout. + * + * @param af AVAudioFifo to read from + * @param data audio data plane pointers + * @param nb_samples number of samples to peek + * @param offset offset from current read position + * @return number of samples actually peek, or negative AVERROR code + * on failure. The number of samples actually peek will not + * be greater than nb_samples, and will only be less than + * nb_samples if av_audio_fifo_size is less than nb_samples. + */ +int av_audio_fifo_peek_at(AVAudioFifo *af, void **data, int nb_samples, int offset); + +/** + * Read data from an AVAudioFifo. + * + * @see enum AVSampleFormat + * The documentation for AVSampleFormat describes the data layout. + * + * @param af AVAudioFifo to read from + * @param data audio data plane pointers + * @param nb_samples number of samples to read + * @return number of samples actually read, or negative AVERROR code + * on failure. The number of samples actually read will not + * be greater than nb_samples, and will only be less than + * nb_samples if av_audio_fifo_size is less than nb_samples. + */ +int av_audio_fifo_read(AVAudioFifo *af, void **data, int nb_samples); + +/** + * Drain data from an AVAudioFifo. + * + * Removes the data without reading it. + * + * @param af AVAudioFifo to drain + * @param nb_samples number of samples to drain + * @return 0 if OK, or negative AVERROR code on failure + */ +int av_audio_fifo_drain(AVAudioFifo *af, int nb_samples); + +/** + * Reset the AVAudioFifo buffer. + * + * This empties all data in the buffer. + * + * @param af AVAudioFifo to reset + */ +void av_audio_fifo_reset(AVAudioFifo *af); + +/** + * Get the current number of samples in the AVAudioFifo available for reading. + * + * @param af the AVAudioFifo to query + * @return number of samples available for reading + */ +int av_audio_fifo_size(AVAudioFifo *af); + +/** + * Get the current number of samples in the AVAudioFifo available for writing. + * + * @param af the AVAudioFifo to query + * @return number of samples available for writing + */ +int av_audio_fifo_space(AVAudioFifo *af); + +/** + * @} + * @} + */ + +#endif /* AVUTIL_AUDIO_FIFO_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/avassert.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/avassert.h new file mode 100644 index 0000000..9abeade --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/avassert.h @@ -0,0 +1,75 @@ +/* + * copyright (c) 2010 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * simple assert() macros that are a bit more flexible than ISO C assert(). + * @author Michael Niedermayer + */ + +#ifndef AVUTIL_AVASSERT_H +#define AVUTIL_AVASSERT_H + +#include +#include "avutil.h" +#include "log.h" + +/** + * assert() equivalent, that is always enabled. + */ +#define av_assert0(cond) do { \ + if (!(cond)) { \ + av_log(NULL, AV_LOG_PANIC, "Assertion %s failed at %s:%d\n", \ + AV_STRINGIFY(cond), __FILE__, __LINE__); \ + abort(); \ + } \ +} while (0) + + +/** + * assert() equivalent, that does not lie in speed critical code. + * These asserts() thus can be enabled without fearing speed loss. + */ +#if defined(ASSERT_LEVEL) && ASSERT_LEVEL > 0 +#define av_assert1(cond) av_assert0(cond) +#else +#define av_assert1(cond) ((void)0) +#endif + + +/** + * assert() equivalent, that does lie in speed critical code. + */ +#if defined(ASSERT_LEVEL) && ASSERT_LEVEL > 1 +#define av_assert2(cond) av_assert0(cond) +#define av_assert2_fpu() av_assert0_fpu() +#else +#define av_assert2(cond) ((void)0) +#define av_assert2_fpu() ((void)0) +#endif + +/** + * Assert that floating point operations can be executed. + * + * This will av_assert0() that the cpu is not in MMX state on X86 + */ +void av_assert0_fpu(void); + +#endif /* AVUTIL_AVASSERT_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/avconfig.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/avconfig.h new file mode 100644 index 0000000..c289fbb --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/avconfig.h @@ -0,0 +1,6 @@ +/* Generated by ffmpeg configure */ +#ifndef AVUTIL_AVCONFIG_H +#define AVUTIL_AVCONFIG_H +#define AV_HAVE_BIGENDIAN 0 +#define AV_HAVE_FAST_UNALIGNED 1 +#endif /* AVUTIL_AVCONFIG_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/avstring.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/avstring.h new file mode 100644 index 0000000..274335c --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/avstring.h @@ -0,0 +1,418 @@ +/* + * Copyright (c) 2007 Mans Rullgard + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_AVSTRING_H +#define AVUTIL_AVSTRING_H + +#include +#include +#include "attributes.h" + +/** + * @addtogroup lavu_string + * @{ + */ + +/** + * Return non-zero if pfx is a prefix of str. If it is, *ptr is set to + * the address of the first character in str after the prefix. + * + * @param str input string + * @param pfx prefix to test + * @param ptr updated if the prefix is matched inside str + * @return non-zero if the prefix matches, zero otherwise + */ +int av_strstart(const char *str, const char *pfx, const char **ptr); + +/** + * Return non-zero if pfx is a prefix of str independent of case. If + * it is, *ptr is set to the address of the first character in str + * after the prefix. + * + * @param str input string + * @param pfx prefix to test + * @param ptr updated if the prefix is matched inside str + * @return non-zero if the prefix matches, zero otherwise + */ +int av_stristart(const char *str, const char *pfx, const char **ptr); + +/** + * Locate the first case-independent occurrence in the string haystack + * of the string needle. A zero-length string needle is considered to + * match at the start of haystack. + * + * This function is a case-insensitive version of the standard strstr(). + * + * @param haystack string to search in + * @param needle string to search for + * @return pointer to the located match within haystack + * or a null pointer if no match + */ +char *av_stristr(const char *haystack, const char *needle); + +/** + * Locate the first occurrence of the string needle in the string haystack + * where not more than hay_length characters are searched. A zero-length + * string needle is considered to match at the start of haystack. + * + * This function is a length-limited version of the standard strstr(). + * + * @param haystack string to search in + * @param needle string to search for + * @param hay_length length of string to search in + * @return pointer to the located match within haystack + * or a null pointer if no match + */ +char *av_strnstr(const char *haystack, const char *needle, size_t hay_length); + +/** + * Copy the string src to dst, but no more than size - 1 bytes, and + * null-terminate dst. + * + * This function is the same as BSD strlcpy(). + * + * @param dst destination buffer + * @param src source string + * @param size size of destination buffer + * @return the length of src + * + * @warning since the return value is the length of src, src absolutely + * _must_ be a properly 0-terminated string, otherwise this will read beyond + * the end of the buffer and possibly crash. + */ +size_t av_strlcpy(char *dst, const char *src, size_t size); + +/** + * Append the string src to the string dst, but to a total length of + * no more than size - 1 bytes, and null-terminate dst. + * + * This function is similar to BSD strlcat(), but differs when + * size <= strlen(dst). + * + * @param dst destination buffer + * @param src source string + * @param size size of destination buffer + * @return the total length of src and dst + * + * @warning since the return value use the length of src and dst, these + * absolutely _must_ be a properly 0-terminated strings, otherwise this + * will read beyond the end of the buffer and possibly crash. + */ +size_t av_strlcat(char *dst, const char *src, size_t size); + +/** + * Append output to a string, according to a format. Never write out of + * the destination buffer, and always put a terminating 0 within + * the buffer. + * @param dst destination buffer (string to which the output is + * appended) + * @param size total size of the destination buffer + * @param fmt printf-compatible format string, specifying how the + * following parameters are used + * @return the length of the string that would have been generated + * if enough space had been available + */ +size_t av_strlcatf(char *dst, size_t size, const char *fmt, ...) av_printf_format(3, 4); + +/** + * Get the count of continuous non zero chars starting from the beginning. + * + * @param len maximum number of characters to check in the string, that + * is the maximum value which is returned by the function + */ +static inline size_t av_strnlen(const char *s, size_t len) +{ + size_t i; + for (i = 0; i < len && s[i]; i++) + ; + return i; +} + +/** + * Print arguments following specified format into a large enough auto + * allocated buffer. It is similar to GNU asprintf(). + * @param fmt printf-compatible format string, specifying how the + * following parameters are used. + * @return the allocated string + * @note You have to free the string yourself with av_free(). + */ +char *av_asprintf(const char *fmt, ...) av_printf_format(1, 2); + +/** + * Convert a number to an av_malloced string. + */ +char *av_d2str(double d); + +/** + * Unescape the given string until a non escaped terminating char, + * and return the token corresponding to the unescaped string. + * + * The normal \ and ' escaping is supported. Leading and trailing + * whitespaces are removed, unless they are escaped with '\' or are + * enclosed between ''. + * + * @param buf the buffer to parse, buf will be updated to point to the + * terminating char + * @param term a 0-terminated list of terminating chars + * @return the malloced unescaped string, which must be av_freed by + * the user, NULL in case of allocation failure + */ +char *av_get_token(const char **buf, const char *term); + +/** + * Split the string into several tokens which can be accessed by + * successive calls to av_strtok(). + * + * A token is defined as a sequence of characters not belonging to the + * set specified in delim. + * + * On the first call to av_strtok(), s should point to the string to + * parse, and the value of saveptr is ignored. In subsequent calls, s + * should be NULL, and saveptr should be unchanged since the previous + * call. + * + * This function is similar to strtok_r() defined in POSIX.1. + * + * @param s the string to parse, may be NULL + * @param delim 0-terminated list of token delimiters, must be non-NULL + * @param saveptr user-provided pointer which points to stored + * information necessary for av_strtok() to continue scanning the same + * string. saveptr is updated to point to the next character after the + * first delimiter found, or to NULL if the string was terminated + * @return the found token, or NULL when no token is found + */ +char *av_strtok(char *s, const char *delim, char **saveptr); + +/** + * Locale-independent conversion of ASCII isdigit. + */ +static inline av_const int av_isdigit(int c) +{ + return c >= '0' && c <= '9'; +} + +/** + * Locale-independent conversion of ASCII isgraph. + */ +static inline av_const int av_isgraph(int c) +{ + return c > 32 && c < 127; +} + +/** + * Locale-independent conversion of ASCII isspace. + */ +static inline av_const int av_isspace(int c) +{ + return c == ' ' || c == '\f' || c == '\n' || c == '\r' || c == '\t' || + c == '\v'; +} + +/** + * Locale-independent conversion of ASCII characters to uppercase. + */ +static inline av_const int av_toupper(int c) +{ + if (c >= 'a' && c <= 'z') + c ^= 0x20; + return c; +} + +/** + * Locale-independent conversion of ASCII characters to lowercase. + */ +static inline av_const int av_tolower(int c) +{ + if (c >= 'A' && c <= 'Z') + c ^= 0x20; + return c; +} + +/** + * Locale-independent conversion of ASCII isxdigit. + */ +static inline av_const int av_isxdigit(int c) +{ + c = av_tolower(c); + return av_isdigit(c) || (c >= 'a' && c <= 'f'); +} + +/** + * Locale-independent case-insensitive compare. + * @note This means only ASCII-range characters are case-insensitive + */ +int av_strcasecmp(const char *a, const char *b); + +/** + * Locale-independent case-insensitive compare. + * @note This means only ASCII-range characters are case-insensitive + */ +int av_strncasecmp(const char *a, const char *b, size_t n); + +/** + * Locale-independent strings replace. + * @note This means only ASCII-range characters are replace + */ +char *av_strireplace(const char *str, const char *from, const char *to); + +/** + * Thread safe basename. + * @param path the string to parse, on DOS both \ and / are considered separators. + * @return pointer to the basename substring. + * If path does not contain a slash, the function returns a copy of path. + * If path is a NULL pointer or points to an empty string, a pointer + * to a string "." is returned. + */ +const char *av_basename(const char *path); + +/** + * Thread safe dirname. + * @param path the string to parse, on DOS both \ and / are considered separators. + * @return A pointer to a string that's the parent directory of path. + * If path is a NULL pointer or points to an empty string, a pointer + * to a string "." is returned. + * @note the function may modify the contents of the path, so copies should be passed. + */ +const char *av_dirname(char *path); + +/** + * Match instances of a name in a comma-separated list of names. + * List entries are checked from the start to the end of the names list, + * the first match ends further processing. If an entry prefixed with '-' + * matches, then 0 is returned. The "ALL" list entry is considered to + * match all names. + * + * @param name Name to look for. + * @param names List of names. + * @return 1 on match, 0 otherwise. + */ +int av_match_name(const char *name, const char *names); + +/** + * Append path component to the existing path. + * Path separator '/' is placed between when needed. + * Resulting string have to be freed with av_free(). + * @param path base path + * @param component component to be appended + * @return new path or NULL on error. + */ +char *av_append_path_component(const char *path, const char *component); + +enum AVEscapeMode { + AV_ESCAPE_MODE_AUTO, ///< Use auto-selected escaping mode. + AV_ESCAPE_MODE_BACKSLASH, ///< Use backslash escaping. + AV_ESCAPE_MODE_QUOTE, ///< Use single-quote escaping. +}; + +/** + * Consider spaces special and escape them even in the middle of the + * string. + * + * This is equivalent to adding the whitespace characters to the special + * characters lists, except it is guaranteed to use the exact same list + * of whitespace characters as the rest of libavutil. + */ +#define AV_ESCAPE_FLAG_WHITESPACE (1 << 0) + +/** + * Escape only specified special characters. + * Without this flag, escape also any characters that may be considered + * special by av_get_token(), such as the single quote. + */ +#define AV_ESCAPE_FLAG_STRICT (1 << 1) + +/** + * Escape string in src, and put the escaped string in an allocated + * string in *dst, which must be freed with av_free(). + * + * @param dst pointer where an allocated string is put + * @param src string to escape, must be non-NULL + * @param special_chars string containing the special characters which + * need to be escaped, can be NULL + * @param mode escape mode to employ, see AV_ESCAPE_MODE_* macros. + * Any unknown value for mode will be considered equivalent to + * AV_ESCAPE_MODE_BACKSLASH, but this behaviour can change without + * notice. + * @param flags flags which control how to escape, see AV_ESCAPE_FLAG_ macros + * @return the length of the allocated string, or a negative error code in case of error + * @see av_bprint_escape() + */ +av_warn_unused_result +int av_escape(char **dst, const char *src, const char *special_chars, + enum AVEscapeMode mode, int flags); + +#define AV_UTF8_FLAG_ACCEPT_INVALID_BIG_CODES 1 ///< accept codepoints over 0x10FFFF +#define AV_UTF8_FLAG_ACCEPT_NON_CHARACTERS 2 ///< accept non-characters - 0xFFFE and 0xFFFF +#define AV_UTF8_FLAG_ACCEPT_SURROGATES 4 ///< accept UTF-16 surrogates codes +#define AV_UTF8_FLAG_EXCLUDE_XML_INVALID_CONTROL_CODES 8 ///< exclude control codes not accepted by XML + +#define AV_UTF8_FLAG_ACCEPT_ALL \ + AV_UTF8_FLAG_ACCEPT_INVALID_BIG_CODES|AV_UTF8_FLAG_ACCEPT_NON_CHARACTERS|AV_UTF8_FLAG_ACCEPT_SURROGATES + +/** + * Read and decode a single UTF-8 code point (character) from the + * buffer in *buf, and update *buf to point to the next byte to + * decode. + * + * In case of an invalid byte sequence, the pointer will be updated to + * the next byte after the invalid sequence and the function will + * return an error code. + * + * Depending on the specified flags, the function will also fail in + * case the decoded code point does not belong to a valid range. + * + * @note For speed-relevant code a carefully implemented use of + * GET_UTF8() may be preferred. + * + * @param codep pointer used to return the parsed code in case of success. + * The value in *codep is set even in case the range check fails. + * @param bufp pointer to the address the first byte of the sequence + * to decode, updated by the function to point to the + * byte next after the decoded sequence + * @param buf_end pointer to the end of the buffer, points to the next + * byte past the last in the buffer. This is used to + * avoid buffer overreads (in case of an unfinished + * UTF-8 sequence towards the end of the buffer). + * @param flags a collection of AV_UTF8_FLAG_* flags + * @return >= 0 in case a sequence was successfully read, a negative + * value in case of invalid sequence + */ +av_warn_unused_result +int av_utf8_decode(int32_t *codep, const uint8_t **bufp, const uint8_t *buf_end, + unsigned int flags); + +/** + * Check if a name is in a list. + * @returns 0 if not found, or the 1 based index where it has been found in the + * list. + */ +int av_match_list(const char *name, const char *list, char separator); + +/** + * See libc sscanf manual for more information. + * Locale-independent sscanf implementation. + */ +int av_sscanf(const char *string, const char *format, ...); + +/** + * @} + */ + +#endif /* AVUTIL_AVSTRING_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/avutil.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/avutil.h new file mode 100644 index 0000000..4d63315 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/avutil.h @@ -0,0 +1,365 @@ +/* + * copyright (c) 2006 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_AVUTIL_H +#define AVUTIL_AVUTIL_H + +/** + * @file + * @ingroup lavu + * Convenience header that includes @ref lavu "libavutil"'s core. + */ + +/** + * @mainpage + * + * @section ffmpeg_intro Introduction + * + * This document describes the usage of the different libraries + * provided by FFmpeg. + * + * @li @ref libavc "libavcodec" encoding/decoding library + * @li @ref lavfi "libavfilter" graph-based frame editing library + * @li @ref libavf "libavformat" I/O and muxing/demuxing library + * @li @ref lavd "libavdevice" special devices muxing/demuxing library + * @li @ref lavu "libavutil" common utility library + * @li @ref lswr "libswresample" audio resampling, format conversion and mixing + * @li @ref lpp "libpostproc" post processing library + * @li @ref libsws "libswscale" color conversion and scaling library + * + * @section ffmpeg_versioning Versioning and compatibility + * + * Each of the FFmpeg libraries contains a version.h header, which defines a + * major, minor and micro version number with the + * LIBRARYNAME_VERSION_{MAJOR,MINOR,MICRO} macros. The major version + * number is incremented with backward incompatible changes - e.g. removing + * parts of the public API, reordering public struct members, etc. The minor + * version number is incremented for backward compatible API changes or major + * new features - e.g. adding a new public function or a new decoder. The micro + * version number is incremented for smaller changes that a calling program + * might still want to check for - e.g. changing behavior in a previously + * unspecified situation. + * + * FFmpeg guarantees backward API and ABI compatibility for each library as long + * as its major version number is unchanged. This means that no public symbols + * will be removed or renamed. Types and names of the public struct members and + * values of public macros and enums will remain the same (unless they were + * explicitly declared as not part of the public API). Documented behavior will + * not change. + * + * In other words, any correct program that works with a given FFmpeg snapshot + * should work just as well without any changes with any later snapshot with the + * same major versions. This applies to both rebuilding the program against new + * FFmpeg versions or to replacing the dynamic FFmpeg libraries that a program + * links against. + * + * However, new public symbols may be added and new members may be appended to + * public structs whose size is not part of public ABI (most public structs in + * FFmpeg). New macros and enum values may be added. Behavior in undocumented + * situations may change slightly (and be documented). All those are accompanied + * by an entry in doc/APIchanges and incrementing either the minor or micro + * version number. + */ + +/** + * @defgroup lavu libavutil + * Common code shared across all FFmpeg libraries. + * + * @note + * libavutil is designed to be modular. In most cases, in order to use the + * functions provided by one component of libavutil you must explicitly include + * the specific header containing that feature. If you are only using + * media-related components, you could simply include libavutil/avutil.h, which + * brings in most of the "core" components. + * + * @{ + * + * @defgroup lavu_crypto Crypto and Hashing + * + * @{ + * @} + * + * @defgroup lavu_math Mathematics + * @{ + * + * @} + * + * @defgroup lavu_string String Manipulation + * + * @{ + * + * @} + * + * @defgroup lavu_mem Memory Management + * + * @{ + * + * @} + * + * @defgroup lavu_data Data Structures + * @{ + * + * @} + * + * @defgroup lavu_video Video related + * + * @{ + * + * @} + * + * @defgroup lavu_audio Audio related + * + * @{ + * + * @} + * + * @defgroup lavu_error Error Codes + * + * @{ + * + * @} + * + * @defgroup lavu_log Logging Facility + * + * @{ + * + * @} + * + * @defgroup lavu_misc Other + * + * @{ + * + * @defgroup preproc_misc Preprocessor String Macros + * + * @{ + * + * @} + * + * @defgroup version_utils Library Version Macros + * + * @{ + * + * @} + */ + + +/** + * @addtogroup lavu_ver + * @{ + */ + +/** + * Return the LIBAVUTIL_VERSION_INT constant. + */ +unsigned avutil_version(void); + +/** + * Return an informative version string. This usually is the actual release + * version number or a git commit description. This string has no fixed format + * and can change any time. It should never be parsed by code. + */ +const char *av_version_info(void); + +/** + * Return the libavutil build-time configuration. + */ +const char *avutil_configuration(void); + +/** + * Return the libavutil license. + */ +const char *avutil_license(void); + +/** + * @} + */ + +/** + * @addtogroup lavu_media Media Type + * @brief Media Type + */ + +enum AVMediaType { + AVMEDIA_TYPE_UNKNOWN = -1, ///< Usually treated as AVMEDIA_TYPE_DATA + AVMEDIA_TYPE_VIDEO, + AVMEDIA_TYPE_AUDIO, + AVMEDIA_TYPE_DATA, ///< Opaque data information usually continuous + AVMEDIA_TYPE_SUBTITLE, + AVMEDIA_TYPE_ATTACHMENT, ///< Opaque data information usually sparse + AVMEDIA_TYPE_NB +}; + +/** + * Return a string describing the media_type enum, NULL if media_type + * is unknown. + */ +const char *av_get_media_type_string(enum AVMediaType media_type); + +/** + * @defgroup lavu_const Constants + * @{ + * + * @defgroup lavu_enc Encoding specific + * + * @note those definition should move to avcodec + * @{ + */ + +#define FF_LAMBDA_SHIFT 7 +#define FF_LAMBDA_SCALE (1< + +/** + * @defgroup lavu_base64 Base64 + * @ingroup lavu_crypto + * @{ + */ + +/** + * Decode a base64-encoded string. + * + * @param out buffer for decoded data + * @param in null-terminated input string + * @param out_size size in bytes of the out buffer, must be at + * least 3/4 of the length of in, that is AV_BASE64_DECODE_SIZE(strlen(in)) + * @return number of bytes written, or a negative value in case of + * invalid input + */ +int av_base64_decode(uint8_t *out, const char *in, int out_size); + +/** + * Calculate the output size in bytes needed to decode a base64 string + * with length x to a data buffer. + */ +#define AV_BASE64_DECODE_SIZE(x) ((x) * 3LL / 4) + +/** + * Encode data to base64 and null-terminate. + * + * @param out buffer for encoded data + * @param out_size size in bytes of the out buffer (including the + * null terminator), must be at least AV_BASE64_SIZE(in_size) + * @param in input buffer containing the data to encode + * @param in_size size in bytes of the in buffer + * @return out or NULL in case of error + */ +char *av_base64_encode(char *out, int out_size, const uint8_t *in, int in_size); + +/** + * Calculate the output size needed to base64-encode x bytes to a + * null-terminated string. + */ +#define AV_BASE64_SIZE(x) (((x)+2) / 3 * 4 + 1) + + /** + * @} + */ + +#endif /* AVUTIL_BASE64_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/blowfish.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/blowfish.h new file mode 100644 index 0000000..9e289a4 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/blowfish.h @@ -0,0 +1,82 @@ +/* + * Blowfish algorithm + * Copyright (c) 2012 Samuel Pitoiset + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_BLOWFISH_H +#define AVUTIL_BLOWFISH_H + +#include + +/** + * @defgroup lavu_blowfish Blowfish + * @ingroup lavu_crypto + * @{ + */ + +#define AV_BF_ROUNDS 16 + +typedef struct AVBlowfish { + uint32_t p[AV_BF_ROUNDS + 2]; + uint32_t s[4][256]; +} AVBlowfish; + +/** + * Allocate an AVBlowfish context. + */ +AVBlowfish *av_blowfish_alloc(void); + +/** + * Initialize an AVBlowfish context. + * + * @param ctx an AVBlowfish context + * @param key a key + * @param key_len length of the key + */ +void av_blowfish_init(struct AVBlowfish *ctx, const uint8_t *key, int key_len); + +/** + * Encrypt or decrypt a buffer using a previously initialized context. + * + * @param ctx an AVBlowfish context + * @param xl left four bytes halves of input to be encrypted + * @param xr right four bytes halves of input to be encrypted + * @param decrypt 0 for encryption, 1 for decryption + */ +void av_blowfish_crypt_ecb(struct AVBlowfish *ctx, uint32_t *xl, uint32_t *xr, + int decrypt); + +/** + * Encrypt or decrypt a buffer using a previously initialized context. + * + * @param ctx an AVBlowfish context + * @param dst destination array, can be equal to src + * @param src source array, can be equal to dst + * @param count number of 8 byte blocks + * @param iv initialization vector for CBC mode, if NULL ECB will be used + * @param decrypt 0 for encryption, 1 for decryption + */ +void av_blowfish_crypt(struct AVBlowfish *ctx, uint8_t *dst, const uint8_t *src, + int count, uint8_t *iv, int decrypt); + +/** + * @} + */ + +#endif /* AVUTIL_BLOWFISH_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/bprint.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/bprint.h new file mode 100644 index 0000000..c09b1ac --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/bprint.h @@ -0,0 +1,219 @@ +/* + * Copyright (c) 2012 Nicolas George + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_BPRINT_H +#define AVUTIL_BPRINT_H + +#include + +#include "attributes.h" +#include "avstring.h" + +/** + * Define a structure with extra padding to a fixed size + * This helps ensuring binary compatibility with future versions. + */ + +#define FF_PAD_STRUCTURE(name, size, ...) \ +struct ff_pad_helper_##name { __VA_ARGS__ }; \ +typedef struct name { \ + __VA_ARGS__ \ + char reserved_padding[size - sizeof(struct ff_pad_helper_##name)]; \ +} name; + +/** + * Buffer to print data progressively + * + * The string buffer grows as necessary and is always 0-terminated. + * The content of the string is never accessed, and thus is + * encoding-agnostic and can even hold binary data. + * + * Small buffers are kept in the structure itself, and thus require no + * memory allocation at all (unless the contents of the buffer is needed + * after the structure goes out of scope). This is almost as lightweight as + * declaring a local "char buf[512]". + * + * The length of the string can go beyond the allocated size: the buffer is + * then truncated, but the functions still keep account of the actual total + * length. + * + * In other words, buf->len can be greater than buf->size and records the + * total length of what would have been to the buffer if there had been + * enough memory. + * + * Append operations do not need to be tested for failure: if a memory + * allocation fails, data stop being appended to the buffer, but the length + * is still updated. This situation can be tested with + * av_bprint_is_complete(). + * + * The size_max field determines several possible behaviours: + * + * size_max = -1 (= UINT_MAX) or any large value will let the buffer be + * reallocated as necessary, with an amortized linear cost. + * + * size_max = 0 prevents writing anything to the buffer: only the total + * length is computed. The write operations can then possibly be repeated in + * a buffer with exactly the necessary size + * (using size_init = size_max = len + 1). + * + * size_max = 1 is automatically replaced by the exact size available in the + * structure itself, thus ensuring no dynamic memory allocation. The + * internal buffer is large enough to hold a reasonable paragraph of text, + * such as the current paragraph. + */ + +FF_PAD_STRUCTURE(AVBPrint, 1024, + char *str; /**< string so far */ + unsigned len; /**< length so far */ + unsigned size; /**< allocated memory */ + unsigned size_max; /**< maximum allocated memory */ + char reserved_internal_buffer[1]; +) + +/** + * Convenience macros for special values for av_bprint_init() size_max + * parameter. + */ +#define AV_BPRINT_SIZE_UNLIMITED ((unsigned)-1) +#define AV_BPRINT_SIZE_AUTOMATIC 1 +#define AV_BPRINT_SIZE_COUNT_ONLY 0 + +/** + * Init a print buffer. + * + * @param buf buffer to init + * @param size_init initial size (including the final 0) + * @param size_max maximum size; + * 0 means do not write anything, just count the length; + * 1 is replaced by the maximum value for automatic storage; + * any large value means that the internal buffer will be + * reallocated as needed up to that limit; -1 is converted to + * UINT_MAX, the largest limit possible. + * Check also AV_BPRINT_SIZE_* macros. + */ +void av_bprint_init(AVBPrint *buf, unsigned size_init, unsigned size_max); + +/** + * Init a print buffer using a pre-existing buffer. + * + * The buffer will not be reallocated. + * + * @param buf buffer structure to init + * @param buffer byte buffer to use for the string data + * @param size size of buffer + */ +void av_bprint_init_for_buffer(AVBPrint *buf, char *buffer, unsigned size); + +/** + * Append a formatted string to a print buffer. + */ +void av_bprintf(AVBPrint *buf, const char *fmt, ...) av_printf_format(2, 3); + +/** + * Append a formatted string to a print buffer. + */ +void av_vbprintf(AVBPrint *buf, const char *fmt, va_list vl_arg); + +/** + * Append char c n times to a print buffer. + */ +void av_bprint_chars(AVBPrint *buf, char c, unsigned n); + +/** + * Append data to a print buffer. + * + * param buf bprint buffer to use + * param data pointer to data + * param size size of data + */ +void av_bprint_append_data(AVBPrint *buf, const char *data, unsigned size); + +struct tm; +/** + * Append a formatted date and time to a print buffer. + * + * param buf bprint buffer to use + * param fmt date and time format string, see strftime() + * param tm broken-down time structure to translate + * + * @note due to poor design of the standard strftime function, it may + * produce poor results if the format string expands to a very long text and + * the bprint buffer is near the limit stated by the size_max option. + */ +void av_bprint_strftime(AVBPrint *buf, const char *fmt, const struct tm *tm); + +/** + * Allocate bytes in the buffer for external use. + * + * @param[in] buf buffer structure + * @param[in] size required size + * @param[out] mem pointer to the memory area + * @param[out] actual_size size of the memory area after allocation; + * can be larger or smaller than size + */ +void av_bprint_get_buffer(AVBPrint *buf, unsigned size, + unsigned char **mem, unsigned *actual_size); + +/** + * Reset the string to "" but keep internal allocated data. + */ +void av_bprint_clear(AVBPrint *buf); + +/** + * Test if the print buffer is complete (not truncated). + * + * It may have been truncated due to a memory allocation failure + * or the size_max limit (compare size and size_max if necessary). + */ +static inline int av_bprint_is_complete(const AVBPrint *buf) +{ + return buf->len < buf->size; +} + +/** + * Finalize a print buffer. + * + * The print buffer can no longer be used afterwards, + * but the len and size fields are still valid. + * + * @arg[out] ret_str if not NULL, used to return a permanent copy of the + * buffer contents, or NULL if memory allocation fails; + * if NULL, the buffer is discarded and freed + * @return 0 for success or error code (probably AVERROR(ENOMEM)) + */ +int av_bprint_finalize(AVBPrint *buf, char **ret_str); + +/** + * Escape the content in src and append it to dstbuf. + * + * @param dstbuf already inited destination bprint buffer + * @param src string containing the text to escape + * @param special_chars string containing the special characters which + * need to be escaped, can be NULL + * @param mode escape mode to employ, see AV_ESCAPE_MODE_* macros. + * Any unknown value for mode will be considered equivalent to + * AV_ESCAPE_MODE_BACKSLASH, but this behaviour can change without + * notice. + * @param flags flags which control how to escape, see AV_ESCAPE_FLAG_* macros + */ +void av_bprint_escape(AVBPrint *dstbuf, const char *src, const char *special_chars, + enum AVEscapeMode mode, int flags); + +#endif /* AVUTIL_BPRINT_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/bswap.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/bswap.h new file mode 100644 index 0000000..91cb795 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/bswap.h @@ -0,0 +1,109 @@ +/* + * copyright (c) 2006 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * byte swapping routines + */ + +#ifndef AVUTIL_BSWAP_H +#define AVUTIL_BSWAP_H + +#include +#include "libavutil/avconfig.h" +#include "attributes.h" + +#ifdef HAVE_AV_CONFIG_H + +#include "config.h" + +#if ARCH_AARCH64 +# include "aarch64/bswap.h" +#elif ARCH_ARM +# include "arm/bswap.h" +#elif ARCH_AVR32 +# include "avr32/bswap.h" +#elif ARCH_SH4 +# include "sh4/bswap.h" +#elif ARCH_X86 +# include "x86/bswap.h" +#endif + +#endif /* HAVE_AV_CONFIG_H */ + +#define AV_BSWAP16C(x) (((x) << 8 & 0xff00) | ((x) >> 8 & 0x00ff)) +#define AV_BSWAP32C(x) (AV_BSWAP16C(x) << 16 | AV_BSWAP16C((x) >> 16)) +#define AV_BSWAP64C(x) (AV_BSWAP32C(x) << 32 | AV_BSWAP32C((x) >> 32)) + +#define AV_BSWAPC(s, x) AV_BSWAP##s##C(x) + +#ifndef av_bswap16 +static av_always_inline av_const uint16_t av_bswap16(uint16_t x) +{ + x= (x>>8) | (x<<8); + return x; +} +#endif + +#ifndef av_bswap32 +static av_always_inline av_const uint32_t av_bswap32(uint32_t x) +{ + return AV_BSWAP32C(x); +} +#endif + +#ifndef av_bswap64 +static inline uint64_t av_const av_bswap64(uint64_t x) +{ + return (uint64_t)av_bswap32(x) << 32 | av_bswap32(x >> 32); +} +#endif + +// be2ne ... big-endian to native-endian +// le2ne ... little-endian to native-endian + +#if AV_HAVE_BIGENDIAN +#define av_be2ne16(x) (x) +#define av_be2ne32(x) (x) +#define av_be2ne64(x) (x) +#define av_le2ne16(x) av_bswap16(x) +#define av_le2ne32(x) av_bswap32(x) +#define av_le2ne64(x) av_bswap64(x) +#define AV_BE2NEC(s, x) (x) +#define AV_LE2NEC(s, x) AV_BSWAPC(s, x) +#else +#define av_be2ne16(x) av_bswap16(x) +#define av_be2ne32(x) av_bswap32(x) +#define av_be2ne64(x) av_bswap64(x) +#define av_le2ne16(x) (x) +#define av_le2ne32(x) (x) +#define av_le2ne64(x) (x) +#define AV_BE2NEC(s, x) AV_BSWAPC(s, x) +#define AV_LE2NEC(s, x) (x) +#endif + +#define AV_BE2NE16C(x) AV_BE2NEC(16, x) +#define AV_BE2NE32C(x) AV_BE2NEC(32, x) +#define AV_BE2NE64C(x) AV_BE2NEC(64, x) +#define AV_LE2NE16C(x) AV_LE2NEC(16, x) +#define AV_LE2NE32C(x) AV_LE2NEC(32, x) +#define AV_LE2NE64C(x) AV_LE2NEC(64, x) + +#endif /* AVUTIL_BSWAP_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/buffer.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/buffer.h new file mode 100644 index 0000000..c0f3f6c --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/buffer.h @@ -0,0 +1,305 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @ingroup lavu_buffer + * refcounted data buffer API + */ + +#ifndef AVUTIL_BUFFER_H +#define AVUTIL_BUFFER_H + +#include + +/** + * @defgroup lavu_buffer AVBuffer + * @ingroup lavu_data + * + * @{ + * AVBuffer is an API for reference-counted data buffers. + * + * There are two core objects in this API -- AVBuffer and AVBufferRef. AVBuffer + * represents the data buffer itself; it is opaque and not meant to be accessed + * by the caller directly, but only through AVBufferRef. However, the caller may + * e.g. compare two AVBuffer pointers to check whether two different references + * are describing the same data buffer. AVBufferRef represents a single + * reference to an AVBuffer and it is the object that may be manipulated by the + * caller directly. + * + * There are two functions provided for creating a new AVBuffer with a single + * reference -- av_buffer_alloc() to just allocate a new buffer, and + * av_buffer_create() to wrap an existing array in an AVBuffer. From an existing + * reference, additional references may be created with av_buffer_ref(). + * Use av_buffer_unref() to free a reference (this will automatically free the + * data once all the references are freed). + * + * The convention throughout this API and the rest of FFmpeg is such that the + * buffer is considered writable if there exists only one reference to it (and + * it has not been marked as read-only). The av_buffer_is_writable() function is + * provided to check whether this is true and av_buffer_make_writable() will + * automatically create a new writable buffer when necessary. + * Of course nothing prevents the calling code from violating this convention, + * however that is safe only when all the existing references are under its + * control. + * + * @note Referencing and unreferencing the buffers is thread-safe and thus + * may be done from multiple threads simultaneously without any need for + * additional locking. + * + * @note Two different references to the same buffer can point to different + * parts of the buffer (i.e. their AVBufferRef.data will not be equal). + */ + +/** + * A reference counted buffer type. It is opaque and is meant to be used through + * references (AVBufferRef). + */ +typedef struct AVBuffer AVBuffer; + +/** + * A reference to a data buffer. + * + * The size of this struct is not a part of the public ABI and it is not meant + * to be allocated directly. + */ +typedef struct AVBufferRef { + AVBuffer *buffer; + + /** + * The data buffer. It is considered writable if and only if + * this is the only reference to the buffer, in which case + * av_buffer_is_writable() returns 1. + */ + uint8_t *data; + /** + * Size of data in bytes. + */ + int size; +} AVBufferRef; + +/** + * Allocate an AVBuffer of the given size using av_malloc(). + * + * @return an AVBufferRef of given size or NULL when out of memory + */ +AVBufferRef *av_buffer_alloc(int size); + +/** + * Same as av_buffer_alloc(), except the returned buffer will be initialized + * to zero. + */ +AVBufferRef *av_buffer_allocz(int size); + +/** + * Always treat the buffer as read-only, even when it has only one + * reference. + */ +#define AV_BUFFER_FLAG_READONLY (1 << 0) + +/** + * Create an AVBuffer from an existing array. + * + * If this function is successful, data is owned by the AVBuffer. The caller may + * only access data through the returned AVBufferRef and references derived from + * it. + * If this function fails, data is left untouched. + * @param data data array + * @param size size of data in bytes + * @param free a callback for freeing this buffer's data + * @param opaque parameter to be got for processing or passed to free + * @param flags a combination of AV_BUFFER_FLAG_* + * + * @return an AVBufferRef referring to data on success, NULL on failure. + */ +AVBufferRef *av_buffer_create(uint8_t *data, int size, + void (*free)(void *opaque, uint8_t *data), + void *opaque, int flags); + +/** + * Default free callback, which calls av_free() on the buffer data. + * This function is meant to be passed to av_buffer_create(), not called + * directly. + */ +void av_buffer_default_free(void *opaque, uint8_t *data); + +/** + * Create a new reference to an AVBuffer. + * + * @return a new AVBufferRef referring to the same AVBuffer as buf or NULL on + * failure. + */ +AVBufferRef *av_buffer_ref(AVBufferRef *buf); + +/** + * Free a given reference and automatically free the buffer if there are no more + * references to it. + * + * @param buf the reference to be freed. The pointer is set to NULL on return. + */ +void av_buffer_unref(AVBufferRef **buf); + +/** + * @return 1 if the caller may write to the data referred to by buf (which is + * true if and only if buf is the only reference to the underlying AVBuffer). + * Return 0 otherwise. + * A positive answer is valid until av_buffer_ref() is called on buf. + */ +int av_buffer_is_writable(const AVBufferRef *buf); + +/** + * @return the opaque parameter set by av_buffer_create. + */ +void *av_buffer_get_opaque(const AVBufferRef *buf); + +int av_buffer_get_ref_count(const AVBufferRef *buf); + +/** + * Create a writable reference from a given buffer reference, avoiding data copy + * if possible. + * + * @param buf buffer reference to make writable. On success, buf is either left + * untouched, or it is unreferenced and a new writable AVBufferRef is + * written in its place. On failure, buf is left untouched. + * @return 0 on success, a negative AVERROR on failure. + */ +int av_buffer_make_writable(AVBufferRef **buf); + +/** + * Reallocate a given buffer. + * + * @param buf a buffer reference to reallocate. On success, buf will be + * unreferenced and a new reference with the required size will be + * written in its place. On failure buf will be left untouched. *buf + * may be NULL, then a new buffer is allocated. + * @param size required new buffer size. + * @return 0 on success, a negative AVERROR on failure. + * + * @note the buffer is actually reallocated with av_realloc() only if it was + * initially allocated through av_buffer_realloc(NULL) and there is only one + * reference to it (i.e. the one passed to this function). In all other cases + * a new buffer is allocated and the data is copied. + */ +int av_buffer_realloc(AVBufferRef **buf, int size); + +/** + * @} + */ + +/** + * @defgroup lavu_bufferpool AVBufferPool + * @ingroup lavu_data + * + * @{ + * AVBufferPool is an API for a lock-free thread-safe pool of AVBuffers. + * + * Frequently allocating and freeing large buffers may be slow. AVBufferPool is + * meant to solve this in cases when the caller needs a set of buffers of the + * same size (the most obvious use case being buffers for raw video or audio + * frames). + * + * At the beginning, the user must call av_buffer_pool_init() to create the + * buffer pool. Then whenever a buffer is needed, call av_buffer_pool_get() to + * get a reference to a new buffer, similar to av_buffer_alloc(). This new + * reference works in all aspects the same way as the one created by + * av_buffer_alloc(). However, when the last reference to this buffer is + * unreferenced, it is returned to the pool instead of being freed and will be + * reused for subsequent av_buffer_pool_get() calls. + * + * When the caller is done with the pool and no longer needs to allocate any new + * buffers, av_buffer_pool_uninit() must be called to mark the pool as freeable. + * Once all the buffers are released, it will automatically be freed. + * + * Allocating and releasing buffers with this API is thread-safe as long as + * either the default alloc callback is used, or the user-supplied one is + * thread-safe. + */ + +/** + * The buffer pool. This structure is opaque and not meant to be accessed + * directly. It is allocated with av_buffer_pool_init() and freed with + * av_buffer_pool_uninit(). + */ +typedef struct AVBufferPool AVBufferPool; + +/** + * Allocate and initialize a buffer pool. + * + * @param size size of each buffer in this pool + * @param alloc a function that will be used to allocate new buffers when the + * pool is empty. May be NULL, then the default allocator will be used + * (av_buffer_alloc()). + * @return newly created buffer pool on success, NULL on error. + */ +AVBufferPool *av_buffer_pool_init(int size, AVBufferRef* (*alloc)(int size)); + +/** + * Allocate and initialize a buffer pool with a more complex allocator. + * + * @param size size of each buffer in this pool + * @param opaque arbitrary user data used by the allocator + * @param alloc a function that will be used to allocate new buffers when the + * pool is empty. May be NULL, then the default allocator will be + * used (av_buffer_alloc()). + * @param pool_free a function that will be called immediately before the pool + * is freed. I.e. after av_buffer_pool_uninit() is called + * by the caller and all the frames are returned to the pool + * and freed. It is intended to uninitialize the user opaque + * data. May be NULL. + * @return newly created buffer pool on success, NULL on error. + */ +AVBufferPool *av_buffer_pool_init2(int size, void *opaque, + AVBufferRef* (*alloc)(void *opaque, int size), + void (*pool_free)(void *opaque)); + +/** + * Mark the pool as being available for freeing. It will actually be freed only + * once all the allocated buffers associated with the pool are released. Thus it + * is safe to call this function while some of the allocated buffers are still + * in use. + * + * @param pool pointer to the pool to be freed. It will be set to NULL. + */ +void av_buffer_pool_uninit(AVBufferPool **pool); + +/** + * Allocate a new AVBuffer, reusing an old buffer from the pool when available. + * This function may be called simultaneously from multiple threads. + * + * @return a reference to the new buffer on success, NULL on error. + */ +AVBufferRef *av_buffer_pool_get(AVBufferPool *pool); + +/** + * Query the original opaque parameter of an allocated buffer in the pool. + * + * @param ref a buffer reference to a buffer returned by av_buffer_pool_get. + * @return the opaque parameter set by the buffer allocator function of the + * buffer pool. + * + * @note the opaque parameter of ref is used by the buffer pool implementation, + * therefore you have to use this function to access the original opaque + * parameter of an allocated buffer. + */ +void *av_buffer_pool_buffer_get_opaque(AVBufferRef *ref); + +/** + * @} + */ + +#endif /* AVUTIL_BUFFER_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/camellia.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/camellia.h new file mode 100644 index 0000000..e674c9b --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/camellia.h @@ -0,0 +1,70 @@ +/* + * An implementation of the CAMELLIA algorithm as mentioned in RFC3713 + * Copyright (c) 2014 Supraja Meedinti + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_CAMELLIA_H +#define AVUTIL_CAMELLIA_H + +#include + + +/** + * @file + * @brief Public header for libavutil CAMELLIA algorithm + * @defgroup lavu_camellia CAMELLIA + * @ingroup lavu_crypto + * @{ + */ + +extern const int av_camellia_size; + +struct AVCAMELLIA; + +/** + * Allocate an AVCAMELLIA context + * To free the struct: av_free(ptr) + */ +struct AVCAMELLIA *av_camellia_alloc(void); + +/** + * Initialize an AVCAMELLIA context. + * + * @param ctx an AVCAMELLIA context + * @param key a key of 16, 24, 32 bytes used for encryption/decryption + * @param key_bits number of keybits: possible are 128, 192, 256 + */ +int av_camellia_init(struct AVCAMELLIA *ctx, const uint8_t *key, int key_bits); + +/** + * Encrypt or decrypt a buffer using a previously initialized context + * + * @param ctx an AVCAMELLIA context + * @param dst destination array, can be equal to src + * @param src source array, can be equal to dst + * @param count number of 16 byte blocks + * @paran iv initialization vector for CBC mode, NULL for ECB mode + * @param decrypt 0 for encryption, 1 for decryption + */ +void av_camellia_crypt(struct AVCAMELLIA *ctx, uint8_t *dst, const uint8_t *src, int count, uint8_t* iv, int decrypt); + +/** + * @} + */ +#endif /* AVUTIL_CAMELLIA_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/cast5.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/cast5.h new file mode 100644 index 0000000..ad5b347 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/cast5.h @@ -0,0 +1,80 @@ +/* + * An implementation of the CAST128 algorithm as mentioned in RFC2144 + * Copyright (c) 2014 Supraja Meedinti + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_CAST5_H +#define AVUTIL_CAST5_H + +#include + + +/** + * @file + * @brief Public header for libavutil CAST5 algorithm + * @defgroup lavu_cast5 CAST5 + * @ingroup lavu_crypto + * @{ + */ + +extern const int av_cast5_size; + +struct AVCAST5; + +/** + * Allocate an AVCAST5 context + * To free the struct: av_free(ptr) + */ +struct AVCAST5 *av_cast5_alloc(void); +/** + * Initialize an AVCAST5 context. + * + * @param ctx an AVCAST5 context + * @param key a key of 5,6,...16 bytes used for encryption/decryption + * @param key_bits number of keybits: possible are 40,48,...,128 + * @return 0 on success, less than 0 on failure + */ +int av_cast5_init(struct AVCAST5 *ctx, const uint8_t *key, int key_bits); + +/** + * Encrypt or decrypt a buffer using a previously initialized context, ECB mode only + * + * @param ctx an AVCAST5 context + * @param dst destination array, can be equal to src + * @param src source array, can be equal to dst + * @param count number of 8 byte blocks + * @param decrypt 0 for encryption, 1 for decryption + */ +void av_cast5_crypt(struct AVCAST5 *ctx, uint8_t *dst, const uint8_t *src, int count, int decrypt); + +/** + * Encrypt or decrypt a buffer using a previously initialized context + * + * @param ctx an AVCAST5 context + * @param dst destination array, can be equal to src + * @param src source array, can be equal to dst + * @param count number of 8 byte blocks + * @param iv initialization vector for CBC mode, NULL for ECB mode + * @param decrypt 0 for encryption, 1 for decryption + */ +void av_cast5_crypt2(struct AVCAST5 *ctx, uint8_t *dst, const uint8_t *src, int count, uint8_t *iv, int decrypt); +/** + * @} + */ +#endif /* AVUTIL_CAST5_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/channel_layout.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/channel_layout.h new file mode 100644 index 0000000..50bb8f0 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/channel_layout.h @@ -0,0 +1,232 @@ +/* + * Copyright (c) 2006 Michael Niedermayer + * Copyright (c) 2008 Peter Ross + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_CHANNEL_LAYOUT_H +#define AVUTIL_CHANNEL_LAYOUT_H + +#include + +/** + * @file + * audio channel layout utility functions + */ + +/** + * @addtogroup lavu_audio + * @{ + */ + +/** + * @defgroup channel_masks Audio channel masks + * + * A channel layout is a 64-bits integer with a bit set for every channel. + * The number of bits set must be equal to the number of channels. + * The value 0 means that the channel layout is not known. + * @note this data structure is not powerful enough to handle channels + * combinations that have the same channel multiple times, such as + * dual-mono. + * + * @{ + */ +#define AV_CH_FRONT_LEFT 0x00000001 +#define AV_CH_FRONT_RIGHT 0x00000002 +#define AV_CH_FRONT_CENTER 0x00000004 +#define AV_CH_LOW_FREQUENCY 0x00000008 +#define AV_CH_BACK_LEFT 0x00000010 +#define AV_CH_BACK_RIGHT 0x00000020 +#define AV_CH_FRONT_LEFT_OF_CENTER 0x00000040 +#define AV_CH_FRONT_RIGHT_OF_CENTER 0x00000080 +#define AV_CH_BACK_CENTER 0x00000100 +#define AV_CH_SIDE_LEFT 0x00000200 +#define AV_CH_SIDE_RIGHT 0x00000400 +#define AV_CH_TOP_CENTER 0x00000800 +#define AV_CH_TOP_FRONT_LEFT 0x00001000 +#define AV_CH_TOP_FRONT_CENTER 0x00002000 +#define AV_CH_TOP_FRONT_RIGHT 0x00004000 +#define AV_CH_TOP_BACK_LEFT 0x00008000 +#define AV_CH_TOP_BACK_CENTER 0x00010000 +#define AV_CH_TOP_BACK_RIGHT 0x00020000 +#define AV_CH_STEREO_LEFT 0x20000000 ///< Stereo downmix. +#define AV_CH_STEREO_RIGHT 0x40000000 ///< See AV_CH_STEREO_LEFT. +#define AV_CH_WIDE_LEFT 0x0000000080000000ULL +#define AV_CH_WIDE_RIGHT 0x0000000100000000ULL +#define AV_CH_SURROUND_DIRECT_LEFT 0x0000000200000000ULL +#define AV_CH_SURROUND_DIRECT_RIGHT 0x0000000400000000ULL +#define AV_CH_LOW_FREQUENCY_2 0x0000000800000000ULL + +/** Channel mask value used for AVCodecContext.request_channel_layout + to indicate that the user requests the channel order of the decoder output + to be the native codec channel order. */ +#define AV_CH_LAYOUT_NATIVE 0x8000000000000000ULL + +/** + * @} + * @defgroup channel_mask_c Audio channel layouts + * @{ + * */ +#define AV_CH_LAYOUT_MONO (AV_CH_FRONT_CENTER) +#define AV_CH_LAYOUT_STEREO (AV_CH_FRONT_LEFT|AV_CH_FRONT_RIGHT) +#define AV_CH_LAYOUT_2POINT1 (AV_CH_LAYOUT_STEREO|AV_CH_LOW_FREQUENCY) +#define AV_CH_LAYOUT_2_1 (AV_CH_LAYOUT_STEREO|AV_CH_BACK_CENTER) +#define AV_CH_LAYOUT_SURROUND (AV_CH_LAYOUT_STEREO|AV_CH_FRONT_CENTER) +#define AV_CH_LAYOUT_3POINT1 (AV_CH_LAYOUT_SURROUND|AV_CH_LOW_FREQUENCY) +#define AV_CH_LAYOUT_4POINT0 (AV_CH_LAYOUT_SURROUND|AV_CH_BACK_CENTER) +#define AV_CH_LAYOUT_4POINT1 (AV_CH_LAYOUT_4POINT0|AV_CH_LOW_FREQUENCY) +#define AV_CH_LAYOUT_2_2 (AV_CH_LAYOUT_STEREO|AV_CH_SIDE_LEFT|AV_CH_SIDE_RIGHT) +#define AV_CH_LAYOUT_QUAD (AV_CH_LAYOUT_STEREO|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT) +#define AV_CH_LAYOUT_5POINT0 (AV_CH_LAYOUT_SURROUND|AV_CH_SIDE_LEFT|AV_CH_SIDE_RIGHT) +#define AV_CH_LAYOUT_5POINT1 (AV_CH_LAYOUT_5POINT0|AV_CH_LOW_FREQUENCY) +#define AV_CH_LAYOUT_5POINT0_BACK (AV_CH_LAYOUT_SURROUND|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT) +#define AV_CH_LAYOUT_5POINT1_BACK (AV_CH_LAYOUT_5POINT0_BACK|AV_CH_LOW_FREQUENCY) +#define AV_CH_LAYOUT_6POINT0 (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_CENTER) +#define AV_CH_LAYOUT_6POINT0_FRONT (AV_CH_LAYOUT_2_2|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER) +#define AV_CH_LAYOUT_HEXAGONAL (AV_CH_LAYOUT_5POINT0_BACK|AV_CH_BACK_CENTER) +#define AV_CH_LAYOUT_6POINT1 (AV_CH_LAYOUT_5POINT1|AV_CH_BACK_CENTER) +#define AV_CH_LAYOUT_6POINT1_BACK (AV_CH_LAYOUT_5POINT1_BACK|AV_CH_BACK_CENTER) +#define AV_CH_LAYOUT_6POINT1_FRONT (AV_CH_LAYOUT_6POINT0_FRONT|AV_CH_LOW_FREQUENCY) +#define AV_CH_LAYOUT_7POINT0 (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT) +#define AV_CH_LAYOUT_7POINT0_FRONT (AV_CH_LAYOUT_5POINT0|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER) +#define AV_CH_LAYOUT_7POINT1 (AV_CH_LAYOUT_5POINT1|AV_CH_BACK_LEFT|AV_CH_BACK_RIGHT) +#define AV_CH_LAYOUT_7POINT1_WIDE (AV_CH_LAYOUT_5POINT1|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER) +#define AV_CH_LAYOUT_7POINT1_WIDE_BACK (AV_CH_LAYOUT_5POINT1_BACK|AV_CH_FRONT_LEFT_OF_CENTER|AV_CH_FRONT_RIGHT_OF_CENTER) +#define AV_CH_LAYOUT_OCTAGONAL (AV_CH_LAYOUT_5POINT0|AV_CH_BACK_LEFT|AV_CH_BACK_CENTER|AV_CH_BACK_RIGHT) +#define AV_CH_LAYOUT_HEXADECAGONAL (AV_CH_LAYOUT_OCTAGONAL|AV_CH_WIDE_LEFT|AV_CH_WIDE_RIGHT|AV_CH_TOP_BACK_LEFT|AV_CH_TOP_BACK_RIGHT|AV_CH_TOP_BACK_CENTER|AV_CH_TOP_FRONT_CENTER|AV_CH_TOP_FRONT_LEFT|AV_CH_TOP_FRONT_RIGHT) +#define AV_CH_LAYOUT_STEREO_DOWNMIX (AV_CH_STEREO_LEFT|AV_CH_STEREO_RIGHT) + +enum AVMatrixEncoding { + AV_MATRIX_ENCODING_NONE, + AV_MATRIX_ENCODING_DOLBY, + AV_MATRIX_ENCODING_DPLII, + AV_MATRIX_ENCODING_DPLIIX, + AV_MATRIX_ENCODING_DPLIIZ, + AV_MATRIX_ENCODING_DOLBYEX, + AV_MATRIX_ENCODING_DOLBYHEADPHONE, + AV_MATRIX_ENCODING_NB +}; + +/** + * Return a channel layout id that matches name, or 0 if no match is found. + * + * name can be one or several of the following notations, + * separated by '+' or '|': + * - the name of an usual channel layout (mono, stereo, 4.0, quad, 5.0, + * 5.0(side), 5.1, 5.1(side), 7.1, 7.1(wide), downmix); + * - the name of a single channel (FL, FR, FC, LFE, BL, BR, FLC, FRC, BC, + * SL, SR, TC, TFL, TFC, TFR, TBL, TBC, TBR, DL, DR); + * - a number of channels, in decimal, followed by 'c', yielding + * the default channel layout for that number of channels (@see + * av_get_default_channel_layout); + * - a channel layout mask, in hexadecimal starting with "0x" (see the + * AV_CH_* macros). + * + * Example: "stereo+FC" = "2c+FC" = "2c+1c" = "0x7" + */ +uint64_t av_get_channel_layout(const char *name); + +/** + * Return a channel layout and the number of channels based on the specified name. + * + * This function is similar to (@see av_get_channel_layout), but can also parse + * unknown channel layout specifications. + * + * @param[in] name channel layout specification string + * @param[out] channel_layout parsed channel layout (0 if unknown) + * @param[out] nb_channels number of channels + * + * @return 0 on success, AVERROR(EINVAL) if the parsing fails. + */ +int av_get_extended_channel_layout(const char *name, uint64_t* channel_layout, int* nb_channels); + +/** + * Return a description of a channel layout. + * If nb_channels is <= 0, it is guessed from the channel_layout. + * + * @param buf put here the string containing the channel layout + * @param buf_size size in bytes of the buffer + */ +void av_get_channel_layout_string(char *buf, int buf_size, int nb_channels, uint64_t channel_layout); + +struct AVBPrint; +/** + * Append a description of a channel layout to a bprint buffer. + */ +void av_bprint_channel_layout(struct AVBPrint *bp, int nb_channels, uint64_t channel_layout); + +/** + * Return the number of channels in the channel layout. + */ +int av_get_channel_layout_nb_channels(uint64_t channel_layout); + +/** + * Return default channel layout for a given number of channels. + */ +int64_t av_get_default_channel_layout(int nb_channels); + +/** + * Get the index of a channel in channel_layout. + * + * @param channel a channel layout describing exactly one channel which must be + * present in channel_layout. + * + * @return index of channel in channel_layout on success, a negative AVERROR + * on error. + */ +int av_get_channel_layout_channel_index(uint64_t channel_layout, + uint64_t channel); + +/** + * Get the channel with the given index in channel_layout. + */ +uint64_t av_channel_layout_extract_channel(uint64_t channel_layout, int index); + +/** + * Get the name of a given channel. + * + * @return channel name on success, NULL on error. + */ +const char *av_get_channel_name(uint64_t channel); + +/** + * Get the description of a given channel. + * + * @param channel a channel layout with a single channel + * @return channel description on success, NULL on error + */ +const char *av_get_channel_description(uint64_t channel); + +/** + * Get the value and name of a standard channel layout. + * + * @param[in] index index in an internal list, starting at 0 + * @param[out] layout channel layout mask + * @param[out] name name of the layout + * @return 0 if the layout exists, + * <0 if index is beyond the limits + */ +int av_get_standard_channel_layout(unsigned index, uint64_t *layout, + const char **name); + +/** + * @} + * @} + */ + +#endif /* AVUTIL_CHANNEL_LAYOUT_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/common.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/common.h new file mode 100644 index 0000000..92b721a --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/common.h @@ -0,0 +1,608 @@ +/* + * copyright (c) 2006 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * common internal and external API header + */ + +#ifndef AVUTIL_COMMON_H +#define AVUTIL_COMMON_H + +#if defined(__cplusplus) && !defined(__STDC_CONSTANT_MACROS) && !defined(UINT64_C) +#error missing -D__STDC_CONSTANT_MACROS / #define __STDC_CONSTANT_MACROS +#endif + +#include +#include +#include +#include +#include +#include +#include +#include + +#include "attributes.h" +#include "macros.h" +#include "version.h" +#include "libavutil/avconfig.h" + +#if AV_HAVE_BIGENDIAN +# define AV_NE(be, le) (be) +#else +# define AV_NE(be, le) (le) +#endif + +//rounded division & shift +#define RSHIFT(a,b) ((a) > 0 ? ((a) + ((1<<(b))>>1))>>(b) : ((a) + ((1<<(b))>>1)-1)>>(b)) +/* assume b>0 */ +#define ROUNDED_DIV(a,b) (((a)>=0 ? (a) + ((b)>>1) : (a) - ((b)>>1))/(b)) +/* Fast a/(1<=0 and b>=0 */ +#define AV_CEIL_RSHIFT(a,b) (!av_builtin_constant_p(b) ? -((-(a)) >> (b)) \ + : ((a) + (1<<(b)) - 1) >> (b)) +/* Backwards compat. */ +#define FF_CEIL_RSHIFT AV_CEIL_RSHIFT + +#define FFUDIV(a,b) (((a)>0 ?(a):(a)-(b)+1) / (b)) +#define FFUMOD(a,b) ((a)-(b)*FFUDIV(a,b)) + +/** + * Absolute value, Note, INT_MIN / INT64_MIN result in undefined behavior as they + * are not representable as absolute values of their type. This is the same + * as with *abs() + * @see FFNABS() + */ +#define FFABS(a) ((a) >= 0 ? (a) : (-(a))) +#define FFSIGN(a) ((a) > 0 ? 1 : -1) + +/** + * Negative Absolute value. + * this works for all integers of all types. + * As with many macros, this evaluates its argument twice, it thus must not have + * a sideeffect, that is FFNABS(x++) has undefined behavior. + */ +#define FFNABS(a) ((a) <= 0 ? (a) : (-(a))) + +/** + * Comparator. + * For two numerical expressions x and y, gives 1 if x > y, -1 if x < y, and 0 + * if x == y. This is useful for instance in a qsort comparator callback. + * Furthermore, compilers are able to optimize this to branchless code, and + * there is no risk of overflow with signed types. + * As with many macros, this evaluates its argument multiple times, it thus + * must not have a side-effect. + */ +#define FFDIFFSIGN(x,y) (((x)>(y)) - ((x)<(y))) + +#define FFMAX(a,b) ((a) > (b) ? (a) : (b)) +#define FFMAX3(a,b,c) FFMAX(FFMAX(a,b),c) +#define FFMIN(a,b) ((a) > (b) ? (b) : (a)) +#define FFMIN3(a,b,c) FFMIN(FFMIN(a,b),c) + +#define FFSWAP(type,a,b) do{type SWAP_tmp= b; b= a; a= SWAP_tmp;}while(0) +#define FF_ARRAY_ELEMS(a) (sizeof(a) / sizeof((a)[0])) + +/* misc math functions */ + +#ifdef HAVE_AV_CONFIG_H +# include "config.h" +# include "intmath.h" +#endif + +/* Pull in unguarded fallback defines at the end of this file. */ +#include "common.h" + +#ifndef av_log2 +av_const int av_log2(unsigned v); +#endif + +#ifndef av_log2_16bit +av_const int av_log2_16bit(unsigned v); +#endif + +/** + * Clip a signed integer value into the amin-amax range. + * @param a value to clip + * @param amin minimum value of the clip range + * @param amax maximum value of the clip range + * @return clipped value + */ +static av_always_inline av_const int av_clip_c(int a, int amin, int amax) +{ +#if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2 + if (amin > amax) abort(); +#endif + if (a < amin) return amin; + else if (a > amax) return amax; + else return a; +} + +/** + * Clip a signed 64bit integer value into the amin-amax range. + * @param a value to clip + * @param amin minimum value of the clip range + * @param amax maximum value of the clip range + * @return clipped value + */ +static av_always_inline av_const int64_t av_clip64_c(int64_t a, int64_t amin, int64_t amax) +{ +#if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2 + if (amin > amax) abort(); +#endif + if (a < amin) return amin; + else if (a > amax) return amax; + else return a; +} + +/** + * Clip a signed integer value into the 0-255 range. + * @param a value to clip + * @return clipped value + */ +static av_always_inline av_const uint8_t av_clip_uint8_c(int a) +{ + if (a&(~0xFF)) return (~a)>>31; + else return a; +} + +/** + * Clip a signed integer value into the -128,127 range. + * @param a value to clip + * @return clipped value + */ +static av_always_inline av_const int8_t av_clip_int8_c(int a) +{ + if ((a+0x80U) & ~0xFF) return (a>>31) ^ 0x7F; + else return a; +} + +/** + * Clip a signed integer value into the 0-65535 range. + * @param a value to clip + * @return clipped value + */ +static av_always_inline av_const uint16_t av_clip_uint16_c(int a) +{ + if (a&(~0xFFFF)) return (~a)>>31; + else return a; +} + +/** + * Clip a signed integer value into the -32768,32767 range. + * @param a value to clip + * @return clipped value + */ +static av_always_inline av_const int16_t av_clip_int16_c(int a) +{ + if ((a+0x8000U) & ~0xFFFF) return (a>>31) ^ 0x7FFF; + else return a; +} + +/** + * Clip a signed 64-bit integer value into the -2147483648,2147483647 range. + * @param a value to clip + * @return clipped value + */ +static av_always_inline av_const int32_t av_clipl_int32_c(int64_t a) +{ + if ((a+0x80000000u) & ~UINT64_C(0xFFFFFFFF)) return (int32_t)((a>>63) ^ 0x7FFFFFFF); + else return (int32_t)a; +} + +/** + * Clip a signed integer into the -(2^p),(2^p-1) range. + * @param a value to clip + * @param p bit position to clip at + * @return clipped value + */ +static av_always_inline av_const int av_clip_intp2_c(int a, int p) +{ + if (((unsigned)a + (1 << p)) & ~((2 << p) - 1)) + return (a >> 31) ^ ((1 << p) - 1); + else + return a; +} + +/** + * Clip a signed integer to an unsigned power of two range. + * @param a value to clip + * @param p bit position to clip at + * @return clipped value + */ +static av_always_inline av_const unsigned av_clip_uintp2_c(int a, int p) +{ + if (a & ~((1<> 31 & ((1<= 0 && a >= INT64_MAX - b) + return INT64_MAX; + if (b <= 0 && a <= INT64_MIN - b) + return INT64_MIN; + return a + b; +#endif +} + +/** + * Subtract two signed 64-bit values with saturation. + * + * @param a one value + * @param b another value + * @return difference with signed saturation + */ +static av_always_inline int64_t av_sat_sub64_c(int64_t a, int64_t b) { +#if (!defined(__INTEL_COMPILER) && AV_GCC_VERSION_AT_LEAST(5,1)) || AV_HAS_BUILTIN(__builtin_sub_overflow) + int64_t tmp; + return !__builtin_sub_overflow(a, b, &tmp) ? tmp : (tmp < 0 ? INT64_MAX : INT64_MIN); +#else + if (b <= 0 && a >= INT64_MAX + b) + return INT64_MAX; + if (b >= 0 && a <= INT64_MIN + b) + return INT64_MIN; + return a - b; +#endif +} + +/** + * Clip a float value into the amin-amax range. + * @param a value to clip + * @param amin minimum value of the clip range + * @param amax maximum value of the clip range + * @return clipped value + */ +static av_always_inline av_const float av_clipf_c(float a, float amin, float amax) +{ +#if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2 + if (amin > amax) abort(); +#endif + if (a < amin) return amin; + else if (a > amax) return amax; + else return a; +} + +/** + * Clip a double value into the amin-amax range. + * @param a value to clip + * @param amin minimum value of the clip range + * @param amax maximum value of the clip range + * @return clipped value + */ +static av_always_inline av_const double av_clipd_c(double a, double amin, double amax) +{ +#if defined(HAVE_AV_CONFIG_H) && defined(ASSERT_LEVEL) && ASSERT_LEVEL >= 2 + if (amin > amax) abort(); +#endif + if (a < amin) return amin; + else if (a > amax) return amax; + else return a; +} + +/** Compute ceil(log2(x)). + * @param x value used to compute ceil(log2(x)) + * @return computed ceiling of log2(x) + */ +static av_always_inline av_const int av_ceil_log2_c(int x) +{ + return av_log2((x - 1U) << 1); +} + +/** + * Count number of bits set to one in x + * @param x value to count bits of + * @return the number of bits set to one in x + */ +static av_always_inline av_const int av_popcount_c(uint32_t x) +{ + x -= (x >> 1) & 0x55555555; + x = (x & 0x33333333) + ((x >> 2) & 0x33333333); + x = (x + (x >> 4)) & 0x0F0F0F0F; + x += x >> 8; + return (x + (x >> 16)) & 0x3F; +} + +/** + * Count number of bits set to one in x + * @param x value to count bits of + * @return the number of bits set to one in x + */ +static av_always_inline av_const int av_popcount64_c(uint64_t x) +{ + return av_popcount((uint32_t)x) + av_popcount((uint32_t)(x >> 32)); +} + +static av_always_inline av_const int av_parity_c(uint32_t v) +{ + return av_popcount(v) & 1; +} + +#define MKTAG(a,b,c,d) ((a) | ((b) << 8) | ((c) << 16) | ((unsigned)(d) << 24)) +#define MKBETAG(a,b,c,d) ((d) | ((c) << 8) | ((b) << 16) | ((unsigned)(a) << 24)) + +/** + * Convert a UTF-8 character (up to 4 bytes) to its 32-bit UCS-4 encoded form. + * + * @param val Output value, must be an lvalue of type uint32_t. + * @param GET_BYTE Expression reading one byte from the input. + * Evaluated up to 7 times (4 for the currently + * assigned Unicode range). With a memory buffer + * input, this could be *ptr++, or if you want to make sure + * that *ptr stops at the end of a NULL terminated string then + * *ptr ? *ptr++ : 0 + * @param ERROR Expression to be evaluated on invalid input, + * typically a goto statement. + * + * @warning ERROR should not contain a loop control statement which + * could interact with the internal while loop, and should force an + * exit from the macro code (e.g. through a goto or a return) in order + * to prevent undefined results. + */ +#define GET_UTF8(val, GET_BYTE, ERROR)\ + val= (GET_BYTE);\ + {\ + uint32_t top = (val & 128) >> 1;\ + if ((val & 0xc0) == 0x80 || val >= 0xFE)\ + {ERROR}\ + while (val & top) {\ + unsigned int tmp = (GET_BYTE) - 128;\ + if(tmp>>6)\ + {ERROR}\ + val= (val<<6) + tmp;\ + top <<= 5;\ + }\ + val &= (top << 1) - 1;\ + } + +/** + * Convert a UTF-16 character (2 or 4 bytes) to its 32-bit UCS-4 encoded form. + * + * @param val Output value, must be an lvalue of type uint32_t. + * @param GET_16BIT Expression returning two bytes of UTF-16 data converted + * to native byte order. Evaluated one or two times. + * @param ERROR Expression to be evaluated on invalid input, + * typically a goto statement. + */ +#define GET_UTF16(val, GET_16BIT, ERROR)\ + val = (GET_16BIT);\ + {\ + unsigned int hi = val - 0xD800;\ + if (hi < 0x800) {\ + val = (GET_16BIT) - 0xDC00;\ + if (val > 0x3FFU || hi > 0x3FFU)\ + {ERROR}\ + val += (hi<<10) + 0x10000;\ + }\ + }\ + +/** + * @def PUT_UTF8(val, tmp, PUT_BYTE) + * Convert a 32-bit Unicode character to its UTF-8 encoded form (up to 4 bytes long). + * @param val is an input-only argument and should be of type uint32_t. It holds + * a UCS-4 encoded Unicode character that is to be converted to UTF-8. If + * val is given as a function it is executed only once. + * @param tmp is a temporary variable and should be of type uint8_t. It + * represents an intermediate value during conversion that is to be + * output by PUT_BYTE. + * @param PUT_BYTE writes the converted UTF-8 bytes to any proper destination. + * It could be a function or a statement, and uses tmp as the input byte. + * For example, PUT_BYTE could be "*output++ = tmp;" PUT_BYTE will be + * executed up to 4 times for values in the valid UTF-8 range and up to + * 7 times in the general case, depending on the length of the converted + * Unicode character. + */ +#define PUT_UTF8(val, tmp, PUT_BYTE)\ + {\ + int bytes, shift;\ + uint32_t in = val;\ + if (in < 0x80) {\ + tmp = in;\ + PUT_BYTE\ + } else {\ + bytes = (av_log2(in) + 4) / 5;\ + shift = (bytes - 1) * 6;\ + tmp = (256 - (256 >> bytes)) | (in >> shift);\ + PUT_BYTE\ + while (shift >= 6) {\ + shift -= 6;\ + tmp = 0x80 | ((in >> shift) & 0x3f);\ + PUT_BYTE\ + }\ + }\ + } + +/** + * @def PUT_UTF16(val, tmp, PUT_16BIT) + * Convert a 32-bit Unicode character to its UTF-16 encoded form (2 or 4 bytes). + * @param val is an input-only argument and should be of type uint32_t. It holds + * a UCS-4 encoded Unicode character that is to be converted to UTF-16. If + * val is given as a function it is executed only once. + * @param tmp is a temporary variable and should be of type uint16_t. It + * represents an intermediate value during conversion that is to be + * output by PUT_16BIT. + * @param PUT_16BIT writes the converted UTF-16 data to any proper destination + * in desired endianness. It could be a function or a statement, and uses tmp + * as the input byte. For example, PUT_BYTE could be "*output++ = tmp;" + * PUT_BYTE will be executed 1 or 2 times depending on input character. + */ +#define PUT_UTF16(val, tmp, PUT_16BIT)\ + {\ + uint32_t in = val;\ + if (in < 0x10000) {\ + tmp = in;\ + PUT_16BIT\ + } else {\ + tmp = 0xD800 | ((in - 0x10000) >> 10);\ + PUT_16BIT\ + tmp = 0xDC00 | ((in - 0x10000) & 0x3FF);\ + PUT_16BIT\ + }\ + }\ + + + +#include "mem.h" + +#ifdef HAVE_AV_CONFIG_H +# include "internal.h" +#endif /* HAVE_AV_CONFIG_H */ + +#endif /* AVUTIL_COMMON_H */ + +/* + * The following definitions are outside the multiple inclusion guard + * to ensure they are immediately available in intmath.h. + */ + +#ifndef av_ceil_log2 +# define av_ceil_log2 av_ceil_log2_c +#endif +#ifndef av_clip +# define av_clip av_clip_c +#endif +#ifndef av_clip64 +# define av_clip64 av_clip64_c +#endif +#ifndef av_clip_uint8 +# define av_clip_uint8 av_clip_uint8_c +#endif +#ifndef av_clip_int8 +# define av_clip_int8 av_clip_int8_c +#endif +#ifndef av_clip_uint16 +# define av_clip_uint16 av_clip_uint16_c +#endif +#ifndef av_clip_int16 +# define av_clip_int16 av_clip_int16_c +#endif +#ifndef av_clipl_int32 +# define av_clipl_int32 av_clipl_int32_c +#endif +#ifndef av_clip_intp2 +# define av_clip_intp2 av_clip_intp2_c +#endif +#ifndef av_clip_uintp2 +# define av_clip_uintp2 av_clip_uintp2_c +#endif +#ifndef av_mod_uintp2 +# define av_mod_uintp2 av_mod_uintp2_c +#endif +#ifndef av_sat_add32 +# define av_sat_add32 av_sat_add32_c +#endif +#ifndef av_sat_dadd32 +# define av_sat_dadd32 av_sat_dadd32_c +#endif +#ifndef av_sat_sub32 +# define av_sat_sub32 av_sat_sub32_c +#endif +#ifndef av_sat_dsub32 +# define av_sat_dsub32 av_sat_dsub32_c +#endif +#ifndef av_sat_add64 +# define av_sat_add64 av_sat_add64_c +#endif +#ifndef av_sat_sub64 +# define av_sat_sub64 av_sat_sub64_c +#endif +#ifndef av_clipf +# define av_clipf av_clipf_c +#endif +#ifndef av_clipd +# define av_clipd av_clipd_c +#endif +#ifndef av_popcount +# define av_popcount av_popcount_c +#endif +#ifndef av_popcount64 +# define av_popcount64 av_popcount64_c +#endif +#ifndef av_parity +# define av_parity av_parity_c +#endif diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/cpu.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/cpu.h new file mode 100644 index 0000000..8bb9eb6 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/cpu.h @@ -0,0 +1,130 @@ +/* + * Copyright (c) 2000, 2001, 2002 Fabrice Bellard + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_CPU_H +#define AVUTIL_CPU_H + +#include + +#include "attributes.h" + +#define AV_CPU_FLAG_FORCE 0x80000000 /* force usage of selected flags (OR) */ + + /* lower 16 bits - CPU features */ +#define AV_CPU_FLAG_MMX 0x0001 ///< standard MMX +#define AV_CPU_FLAG_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext +#define AV_CPU_FLAG_MMX2 0x0002 ///< SSE integer functions or AMD MMX ext +#define AV_CPU_FLAG_3DNOW 0x0004 ///< AMD 3DNOW +#define AV_CPU_FLAG_SSE 0x0008 ///< SSE functions +#define AV_CPU_FLAG_SSE2 0x0010 ///< PIV SSE2 functions +#define AV_CPU_FLAG_SSE2SLOW 0x40000000 ///< SSE2 supported, but usually not faster + ///< than regular MMX/SSE (e.g. Core1) +#define AV_CPU_FLAG_3DNOWEXT 0x0020 ///< AMD 3DNowExt +#define AV_CPU_FLAG_SSE3 0x0040 ///< Prescott SSE3 functions +#define AV_CPU_FLAG_SSE3SLOW 0x20000000 ///< SSE3 supported, but usually not faster + ///< than regular MMX/SSE (e.g. Core1) +#define AV_CPU_FLAG_SSSE3 0x0080 ///< Conroe SSSE3 functions +#define AV_CPU_FLAG_SSSE3SLOW 0x4000000 ///< SSSE3 supported, but usually not faster +#define AV_CPU_FLAG_ATOM 0x10000000 ///< Atom processor, some SSSE3 instructions are slower +#define AV_CPU_FLAG_SSE4 0x0100 ///< Penryn SSE4.1 functions +#define AV_CPU_FLAG_SSE42 0x0200 ///< Nehalem SSE4.2 functions +#define AV_CPU_FLAG_AESNI 0x80000 ///< Advanced Encryption Standard functions +#define AV_CPU_FLAG_AVX 0x4000 ///< AVX functions: requires OS support even if YMM registers aren't used +#define AV_CPU_FLAG_AVXSLOW 0x8000000 ///< AVX supported, but slow when using YMM registers (e.g. Bulldozer) +#define AV_CPU_FLAG_XOP 0x0400 ///< Bulldozer XOP functions +#define AV_CPU_FLAG_FMA4 0x0800 ///< Bulldozer FMA4 functions +#define AV_CPU_FLAG_CMOV 0x1000 ///< supports cmov instruction +#define AV_CPU_FLAG_AVX2 0x8000 ///< AVX2 functions: requires OS support even if YMM registers aren't used +#define AV_CPU_FLAG_FMA3 0x10000 ///< Haswell FMA3 functions +#define AV_CPU_FLAG_BMI1 0x20000 ///< Bit Manipulation Instruction Set 1 +#define AV_CPU_FLAG_BMI2 0x40000 ///< Bit Manipulation Instruction Set 2 +#define AV_CPU_FLAG_AVX512 0x100000 ///< AVX-512 functions: requires OS support even if YMM/ZMM registers aren't used + +#define AV_CPU_FLAG_ALTIVEC 0x0001 ///< standard +#define AV_CPU_FLAG_VSX 0x0002 ///< ISA 2.06 +#define AV_CPU_FLAG_POWER8 0x0004 ///< ISA 2.07 + +#define AV_CPU_FLAG_ARMV5TE (1 << 0) +#define AV_CPU_FLAG_ARMV6 (1 << 1) +#define AV_CPU_FLAG_ARMV6T2 (1 << 2) +#define AV_CPU_FLAG_VFP (1 << 3) +#define AV_CPU_FLAG_VFPV3 (1 << 4) +#define AV_CPU_FLAG_NEON (1 << 5) +#define AV_CPU_FLAG_ARMV8 (1 << 6) +#define AV_CPU_FLAG_VFP_VM (1 << 7) ///< VFPv2 vector mode, deprecated in ARMv7-A and unavailable in various CPUs implementations +#define AV_CPU_FLAG_SETEND (1 <<16) + +/** + * Return the flags which specify extensions supported by the CPU. + * The returned value is affected by av_force_cpu_flags() if that was used + * before. So av_get_cpu_flags() can easily be used in an application to + * detect the enabled cpu flags. + */ +int av_get_cpu_flags(void); + +/** + * Disables cpu detection and forces the specified flags. + * -1 is a special case that disables forcing of specific flags. + */ +void av_force_cpu_flags(int flags); + +/** + * Set a mask on flags returned by av_get_cpu_flags(). + * This function is mainly useful for testing. + * Please use av_force_cpu_flags() and av_get_cpu_flags() instead which are more flexible + */ +attribute_deprecated void av_set_cpu_flags_mask(int mask); + +/** + * Parse CPU flags from a string. + * + * The returned flags contain the specified flags as well as related unspecified flags. + * + * This function exists only for compatibility with libav. + * Please use av_parse_cpu_caps() when possible. + * @return a combination of AV_CPU_* flags, negative on error. + */ +attribute_deprecated +int av_parse_cpu_flags(const char *s); + +/** + * Parse CPU caps from a string and update the given AV_CPU_* flags based on that. + * + * @return negative on error. + */ +int av_parse_cpu_caps(unsigned *flags, const char *s); + +/** + * @return the number of logical CPU cores present. + */ +int av_cpu_count(void); + +/** + * Get the maximum data alignment that may be required by FFmpeg. + * + * Note that this is affected by the build configuration and the CPU flags mask, + * so e.g. if the CPU supports AVX, but libavutil has been built with + * --disable-avx or the AV_CPU_FLAG_AVX flag has been disabled through + * av_set_cpu_flags_mask(), then this function will behave as if AVX is not + * present. + */ +size_t av_cpu_max_align(void); + +#endif /* AVUTIL_CPU_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/crc.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/crc.h new file mode 100644 index 0000000..47e22b4 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/crc.h @@ -0,0 +1,100 @@ +/* + * copyright (c) 2006 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @ingroup lavu_crc32 + * Public header for CRC hash function implementation. + */ + +#ifndef AVUTIL_CRC_H +#define AVUTIL_CRC_H + +#include +#include +#include "attributes.h" +#include "version.h" + +/** + * @defgroup lavu_crc32 CRC + * @ingroup lavu_hash + * CRC (Cyclic Redundancy Check) hash function implementation. + * + * This module supports numerous CRC polynomials, in addition to the most + * widely used CRC-32-IEEE. See @ref AVCRCId for a list of available + * polynomials. + * + * @{ + */ + +typedef uint32_t AVCRC; + +typedef enum { + AV_CRC_8_ATM, + AV_CRC_16_ANSI, + AV_CRC_16_CCITT, + AV_CRC_32_IEEE, + AV_CRC_32_IEEE_LE, /*< reversed bitorder version of AV_CRC_32_IEEE */ + AV_CRC_16_ANSI_LE, /*< reversed bitorder version of AV_CRC_16_ANSI */ + AV_CRC_24_IEEE, + AV_CRC_8_EBU, + AV_CRC_MAX, /*< Not part of public API! Do not use outside libavutil. */ +}AVCRCId; + +/** + * Initialize a CRC table. + * @param ctx must be an array of size sizeof(AVCRC)*257 or sizeof(AVCRC)*1024 + * @param le If 1, the lowest bit represents the coefficient for the highest + * exponent of the corresponding polynomial (both for poly and + * actual CRC). + * If 0, you must swap the CRC parameter and the result of av_crc + * if you need the standard representation (can be simplified in + * most cases to e.g. bswap16): + * av_bswap32(crc << (32-bits)) + * @param bits number of bits for the CRC + * @param poly generator polynomial without the x**bits coefficient, in the + * representation as specified by le + * @param ctx_size size of ctx in bytes + * @return <0 on failure + */ +int av_crc_init(AVCRC *ctx, int le, int bits, uint32_t poly, int ctx_size); + +/** + * Get an initialized standard CRC table. + * @param crc_id ID of a standard CRC + * @return a pointer to the CRC table or NULL on failure + */ +const AVCRC *av_crc_get_table(AVCRCId crc_id); + +/** + * Calculate the CRC of a block. + * @param crc CRC of previous blocks if any or initial value for CRC + * @return CRC updated with the data from the given block + * + * @see av_crc_init() "le" parameter + */ +uint32_t av_crc(const AVCRC *ctx, uint32_t crc, + const uint8_t *buffer, size_t length) av_pure; + +/** + * @} + */ + +#endif /* AVUTIL_CRC_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/des.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/des.h new file mode 100644 index 0000000..4cf11f5 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/des.h @@ -0,0 +1,77 @@ +/* + * DES encryption/decryption + * Copyright (c) 2007 Reimar Doeffinger + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_DES_H +#define AVUTIL_DES_H + +#include + +/** + * @defgroup lavu_des DES + * @ingroup lavu_crypto + * @{ + */ + +typedef struct AVDES { + uint64_t round_keys[3][16]; + int triple_des; +} AVDES; + +/** + * Allocate an AVDES context. + */ +AVDES *av_des_alloc(void); + +/** + * @brief Initializes an AVDES context. + * + * @param key_bits must be 64 or 192 + * @param decrypt 0 for encryption/CBC-MAC, 1 for decryption + * @return zero on success, negative value otherwise + */ +int av_des_init(struct AVDES *d, const uint8_t *key, int key_bits, int decrypt); + +/** + * @brief Encrypts / decrypts using the DES algorithm. + * + * @param count number of 8 byte blocks + * @param dst destination array, can be equal to src, must be 8-byte aligned + * @param src source array, can be equal to dst, must be 8-byte aligned, may be NULL + * @param iv initialization vector for CBC mode, if NULL then ECB will be used, + * must be 8-byte aligned + * @param decrypt 0 for encryption, 1 for decryption + */ +void av_des_crypt(struct AVDES *d, uint8_t *dst, const uint8_t *src, int count, uint8_t *iv, int decrypt); + +/** + * @brief Calculates CBC-MAC using the DES algorithm. + * + * @param count number of 8 byte blocks + * @param dst destination array, can be equal to src, must be 8-byte aligned + * @param src source array, can be equal to dst, must be 8-byte aligned, may be NULL + */ +void av_des_mac(struct AVDES *d, uint8_t *dst, const uint8_t *src, int count); + +/** + * @} + */ + +#endif /* AVUTIL_DES_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/dict.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/dict.h new file mode 100644 index 0000000..118f1f0 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/dict.h @@ -0,0 +1,200 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * Public dictionary API. + * @deprecated + * AVDictionary is provided for compatibility with libav. It is both in + * implementation as well as API inefficient. It does not scale and is + * extremely slow with large dictionaries. + * It is recommended that new code uses our tree container from tree.c/h + * where applicable, which uses AVL trees to achieve O(log n) performance. + */ + +#ifndef AVUTIL_DICT_H +#define AVUTIL_DICT_H + +#include + +#include "version.h" + +/** + * @addtogroup lavu_dict AVDictionary + * @ingroup lavu_data + * + * @brief Simple key:value store + * + * @{ + * Dictionaries are used for storing key:value pairs. To create + * an AVDictionary, simply pass an address of a NULL pointer to + * av_dict_set(). NULL can be used as an empty dictionary wherever + * a pointer to an AVDictionary is required. + * Use av_dict_get() to retrieve an entry or iterate over all + * entries and finally av_dict_free() to free the dictionary + * and all its contents. + * + @code + AVDictionary *d = NULL; // "create" an empty dictionary + AVDictionaryEntry *t = NULL; + + av_dict_set(&d, "foo", "bar", 0); // add an entry + + char *k = av_strdup("key"); // if your strings are already allocated, + char *v = av_strdup("value"); // you can avoid copying them like this + av_dict_set(&d, k, v, AV_DICT_DONT_STRDUP_KEY | AV_DICT_DONT_STRDUP_VAL); + + while (t = av_dict_get(d, "", t, AV_DICT_IGNORE_SUFFIX)) { + <....> // iterate over all entries in d + } + av_dict_free(&d); + @endcode + */ + +#define AV_DICT_MATCH_CASE 1 /**< Only get an entry with exact-case key match. Only relevant in av_dict_get(). */ +#define AV_DICT_IGNORE_SUFFIX 2 /**< Return first entry in a dictionary whose first part corresponds to the search key, + ignoring the suffix of the found key string. Only relevant in av_dict_get(). */ +#define AV_DICT_DONT_STRDUP_KEY 4 /**< Take ownership of a key that's been + allocated with av_malloc() or another memory allocation function. */ +#define AV_DICT_DONT_STRDUP_VAL 8 /**< Take ownership of a value that's been + allocated with av_malloc() or another memory allocation function. */ +#define AV_DICT_DONT_OVERWRITE 16 ///< Don't overwrite existing entries. +#define AV_DICT_APPEND 32 /**< If the entry already exists, append to it. Note that no + delimiter is added, the strings are simply concatenated. */ +#define AV_DICT_MULTIKEY 64 /**< Allow to store several equal keys in the dictionary */ + +typedef struct AVDictionaryEntry { + char *key; + char *value; +} AVDictionaryEntry; + +typedef struct AVDictionary AVDictionary; + +/** + * Get a dictionary entry with matching key. + * + * The returned entry key or value must not be changed, or it will + * cause undefined behavior. + * + * To iterate through all the dictionary entries, you can set the matching key + * to the null string "" and set the AV_DICT_IGNORE_SUFFIX flag. + * + * @param prev Set to the previous matching element to find the next. + * If set to NULL the first matching element is returned. + * @param key matching key + * @param flags a collection of AV_DICT_* flags controlling how the entry is retrieved + * @return found entry or NULL in case no matching entry was found in the dictionary + */ +AVDictionaryEntry *av_dict_get(const AVDictionary *m, const char *key, + const AVDictionaryEntry *prev, int flags); + +/** + * Get number of entries in dictionary. + * + * @param m dictionary + * @return number of entries in dictionary + */ +int av_dict_count(const AVDictionary *m); + +/** + * Set the given entry in *pm, overwriting an existing entry. + * + * Note: If AV_DICT_DONT_STRDUP_KEY or AV_DICT_DONT_STRDUP_VAL is set, + * these arguments will be freed on error. + * + * Warning: Adding a new entry to a dictionary invalidates all existing entries + * previously returned with av_dict_get. + * + * @param pm pointer to a pointer to a dictionary struct. If *pm is NULL + * a dictionary struct is allocated and put in *pm. + * @param key entry key to add to *pm (will either be av_strduped or added as a new key depending on flags) + * @param value entry value to add to *pm (will be av_strduped or added as a new key depending on flags). + * Passing a NULL value will cause an existing entry to be deleted. + * @return >= 0 on success otherwise an error code <0 + */ +int av_dict_set(AVDictionary **pm, const char *key, const char *value, int flags); + +/** + * Convenience wrapper for av_dict_set that converts the value to a string + * and stores it. + * + * Note: If AV_DICT_DONT_STRDUP_KEY is set, key will be freed on error. + */ +int av_dict_set_int(AVDictionary **pm, const char *key, int64_t value, int flags); + +/** + * Parse the key/value pairs list and add the parsed entries to a dictionary. + * + * In case of failure, all the successfully set entries are stored in + * *pm. You may need to manually free the created dictionary. + * + * @param key_val_sep a 0-terminated list of characters used to separate + * key from value + * @param pairs_sep a 0-terminated list of characters used to separate + * two pairs from each other + * @param flags flags to use when adding to dictionary. + * AV_DICT_DONT_STRDUP_KEY and AV_DICT_DONT_STRDUP_VAL + * are ignored since the key/value tokens will always + * be duplicated. + * @return 0 on success, negative AVERROR code on failure + */ +int av_dict_parse_string(AVDictionary **pm, const char *str, + const char *key_val_sep, const char *pairs_sep, + int flags); + +/** + * Copy entries from one AVDictionary struct into another. + * @param dst pointer to a pointer to a AVDictionary struct. If *dst is NULL, + * this function will allocate a struct for you and put it in *dst + * @param src pointer to source AVDictionary struct + * @param flags flags to use when setting entries in *dst + * @note metadata is read using the AV_DICT_IGNORE_SUFFIX flag + * @return 0 on success, negative AVERROR code on failure. If dst was allocated + * by this function, callers should free the associated memory. + */ +int av_dict_copy(AVDictionary **dst, const AVDictionary *src, int flags); + +/** + * Free all the memory allocated for an AVDictionary struct + * and all keys and values. + */ +void av_dict_free(AVDictionary **m); + +/** + * Get dictionary entries as a string. + * + * Create a string containing dictionary's entries. + * Such string may be passed back to av_dict_parse_string(). + * @note String is escaped with backslashes ('\'). + * + * @param[in] m dictionary + * @param[out] buffer Pointer to buffer that will be allocated with string containg entries. + * Buffer must be freed by the caller when is no longer needed. + * @param[in] key_val_sep character used to separate key from value + * @param[in] pairs_sep character used to separate two pairs from each other + * @return >= 0 on success, negative on error + * @warning Separators cannot be neither '\\' nor '\0'. They also cannot be the same. + */ +int av_dict_get_string(const AVDictionary *m, char **buffer, + const char key_val_sep, const char pairs_sep); + +/** + * @} + */ + +#endif /* AVUTIL_DICT_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/display.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/display.h new file mode 100644 index 0000000..515adad --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/display.h @@ -0,0 +1,114 @@ +/* + * Copyright (c) 2014 Vittorio Giovara + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * Display matrix + */ + +#ifndef AVUTIL_DISPLAY_H +#define AVUTIL_DISPLAY_H + +#include +#include "common.h" + +/** + * @addtogroup lavu_video + * @{ + * + * @defgroup lavu_video_display Display transformation matrix functions + * @{ + */ + +/** + * @addtogroup lavu_video_display + * The display transformation matrix specifies an affine transformation that + * should be applied to video frames for correct presentation. It is compatible + * with the matrices stored in the ISO/IEC 14496-12 container format. + * + * The data is a 3x3 matrix represented as a 9-element array: + * + * @code{.unparsed} + * | a b u | + * (a, b, u, c, d, v, x, y, w) -> | c d v | + * | x y w | + * @endcode + * + * All numbers are stored in native endianness, as 16.16 fixed-point values, + * except for u, v and w, which are stored as 2.30 fixed-point values. + * + * The transformation maps a point (p, q) in the source (pre-transformation) + * frame to the point (p', q') in the destination (post-transformation) frame as + * follows: + * + * @code{.unparsed} + * | a b u | + * (p, q, 1) . | c d v | = z * (p', q', 1) + * | x y w | + * @endcode + * + * The transformation can also be more explicitly written in components as + * follows: + * + * @code{.unparsed} + * p' = (a * p + c * q + x) / z; + * q' = (b * p + d * q + y) / z; + * z = u * p + v * q + w + * @endcode + */ + +/** + * Extract the rotation component of the transformation matrix. + * + * @param matrix the transformation matrix + * @return the angle (in degrees) by which the transformation rotates the frame + * counterclockwise. The angle will be in range [-180.0, 180.0], + * or NaN if the matrix is singular. + * + * @note floating point numbers are inherently inexact, so callers are + * recommended to round the return value to nearest integer before use. + */ +double av_display_rotation_get(const int32_t matrix[9]); + +/** + * Initialize a transformation matrix describing a pure counterclockwise + * rotation by the specified angle (in degrees). + * + * @param matrix an allocated transformation matrix (will be fully overwritten + * by this function) + * @param angle rotation angle in degrees. + */ +void av_display_rotation_set(int32_t matrix[9], double angle); + +/** + * Flip the input matrix horizontally and/or vertically. + * + * @param matrix an allocated transformation matrix + * @param hflip whether the matrix should be flipped horizontally + * @param vflip whether the matrix should be flipped vertically + */ +void av_display_matrix_flip(int32_t matrix[9], int hflip, int vflip); + +/** + * @} + * @} + */ + +#endif /* AVUTIL_DISPLAY_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/dovi_meta.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/dovi_meta.h new file mode 100644 index 0000000..299911d --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/dovi_meta.h @@ -0,0 +1,70 @@ +/* + * Copyright (c) 2020 Vacing Fang + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * DOVI configuration + */ + + +#ifndef AVUTIL_DOVI_META_H +#define AVUTIL_DOVI_META_H + +#include +#include + +/* + * DOVI configuration + * ref: dolby-vision-bitstreams-within-the-iso-base-media-file-format-v2.1.2 + dolby-vision-bitstreams-in-mpeg-2-transport-stream-multiplex-v1.2 + * @code + * uint8_t dv_version_major, the major version number that the stream complies with + * uint8_t dv_version_minor, the minor version number that the stream complies with + * uint8_t dv_profile, the Dolby Vision profile + * uint8_t dv_level, the Dolby Vision level + * uint8_t rpu_present_flag + * uint8_t el_present_flag + * uint8_t bl_present_flag + * uint8_t dv_bl_signal_compatibility_id + * @endcode + * + * @note The struct must be allocated with av_dovi_alloc() and + * its size is not a part of the public ABI. + */ +typedef struct AVDOVIDecoderConfigurationRecord { + uint8_t dv_version_major; + uint8_t dv_version_minor; + uint8_t dv_profile; + uint8_t dv_level; + uint8_t rpu_present_flag; + uint8_t el_present_flag; + uint8_t bl_present_flag; + uint8_t dv_bl_signal_compatibility_id; +} AVDOVIDecoderConfigurationRecord; + +/** + * Allocate a AVDOVIDecoderConfigurationRecord structure and initialize its + * fields to default values. + * + * @return the newly allocated struct or NULL on failure + */ +AVDOVIDecoderConfigurationRecord *av_dovi_alloc(size_t *size); + +#endif /* AVUTIL_DOVI_META_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/downmix_info.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/downmix_info.h new file mode 100644 index 0000000..221cf5b --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/downmix_info.h @@ -0,0 +1,115 @@ +/* + * Copyright (c) 2014 Tim Walker + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_DOWNMIX_INFO_H +#define AVUTIL_DOWNMIX_INFO_H + +#include "frame.h" + +/** + * @file + * audio downmix medatata + */ + +/** + * @addtogroup lavu_audio + * @{ + */ + +/** + * @defgroup downmix_info Audio downmix metadata + * @{ + */ + +/** + * Possible downmix types. + */ +enum AVDownmixType { + AV_DOWNMIX_TYPE_UNKNOWN, /**< Not indicated. */ + AV_DOWNMIX_TYPE_LORO, /**< Lo/Ro 2-channel downmix (Stereo). */ + AV_DOWNMIX_TYPE_LTRT, /**< Lt/Rt 2-channel downmix, Dolby Surround compatible. */ + AV_DOWNMIX_TYPE_DPLII, /**< Lt/Rt 2-channel downmix, Dolby Pro Logic II compatible. */ + AV_DOWNMIX_TYPE_NB /**< Number of downmix types. Not part of ABI. */ +}; + +/** + * This structure describes optional metadata relevant to a downmix procedure. + * + * All fields are set by the decoder to the value indicated in the audio + * bitstream (if present), or to a "sane" default otherwise. + */ +typedef struct AVDownmixInfo { + /** + * Type of downmix preferred by the mastering engineer. + */ + enum AVDownmixType preferred_downmix_type; + + /** + * Absolute scale factor representing the nominal level of the center + * channel during a regular downmix. + */ + double center_mix_level; + + /** + * Absolute scale factor representing the nominal level of the center + * channel during an Lt/Rt compatible downmix. + */ + double center_mix_level_ltrt; + + /** + * Absolute scale factor representing the nominal level of the surround + * channels during a regular downmix. + */ + double surround_mix_level; + + /** + * Absolute scale factor representing the nominal level of the surround + * channels during an Lt/Rt compatible downmix. + */ + double surround_mix_level_ltrt; + + /** + * Absolute scale factor representing the level at which the LFE data is + * mixed into L/R channels during downmixing. + */ + double lfe_mix_level; +} AVDownmixInfo; + +/** + * Get a frame's AV_FRAME_DATA_DOWNMIX_INFO side data for editing. + * + * If the side data is absent, it is created and added to the frame. + * + * @param frame the frame for which the side data is to be obtained or created + * + * @return the AVDownmixInfo structure to be edited by the caller, or NULL if + * the structure cannot be allocated. + */ +AVDownmixInfo *av_downmix_info_update_side_data(AVFrame *frame); + +/** + * @} + */ + +/** + * @} + */ + +#endif /* AVUTIL_DOWNMIX_INFO_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/encryption_info.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/encryption_info.h new file mode 100644 index 0000000..8fe7ebf --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/encryption_info.h @@ -0,0 +1,205 @@ +/** + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_ENCRYPTION_INFO_H +#define AVUTIL_ENCRYPTION_INFO_H + +#include +#include + +typedef struct AVSubsampleEncryptionInfo { + /** The number of bytes that are clear. */ + unsigned int bytes_of_clear_data; + + /** + * The number of bytes that are protected. If using pattern encryption, + * the pattern applies to only the protected bytes; if not using pattern + * encryption, all these bytes are encrypted. + */ + unsigned int bytes_of_protected_data; +} AVSubsampleEncryptionInfo; + +/** + * This describes encryption info for a packet. This contains frame-specific + * info for how to decrypt the packet before passing it to the decoder. + * + * The size of this struct is not part of the public ABI. + */ +typedef struct AVEncryptionInfo { + /** The fourcc encryption scheme, in big-endian byte order. */ + uint32_t scheme; + + /** + * Only used for pattern encryption. This is the number of 16-byte blocks + * that are encrypted. + */ + uint32_t crypt_byte_block; + + /** + * Only used for pattern encryption. This is the number of 16-byte blocks + * that are clear. + */ + uint32_t skip_byte_block; + + /** + * The ID of the key used to encrypt the packet. This should always be + * 16 bytes long, but may be changed in the future. + */ + uint8_t *key_id; + uint32_t key_id_size; + + /** + * The initialization vector. This may have been zero-filled to be the + * correct block size. This should always be 16 bytes long, but may be + * changed in the future. + */ + uint8_t *iv; + uint32_t iv_size; + + /** + * An array of subsample encryption info specifying how parts of the sample + * are encrypted. If there are no subsamples, then the whole sample is + * encrypted. + */ + AVSubsampleEncryptionInfo *subsamples; + uint32_t subsample_count; +} AVEncryptionInfo; + +/** + * This describes info used to initialize an encryption key system. + * + * The size of this struct is not part of the public ABI. + */ +typedef struct AVEncryptionInitInfo { + /** + * A unique identifier for the key system this is for, can be NULL if it + * is not known. This should always be 16 bytes, but may change in the + * future. + */ + uint8_t* system_id; + uint32_t system_id_size; + + /** + * An array of key IDs this initialization data is for. All IDs are the + * same length. Can be NULL if there are no known key IDs. + */ + uint8_t** key_ids; + /** The number of key IDs. */ + uint32_t num_key_ids; + /** + * The number of bytes in each key ID. This should always be 16, but may + * change in the future. + */ + uint32_t key_id_size; + + /** + * Key-system specific initialization data. This data is copied directly + * from the file and the format depends on the specific key system. This + * can be NULL if there is no initialization data; in that case, there + * will be at least one key ID. + */ + uint8_t* data; + uint32_t data_size; + + /** + * An optional pointer to the next initialization info in the list. + */ + struct AVEncryptionInitInfo *next; +} AVEncryptionInitInfo; + +/** + * Allocates an AVEncryptionInfo structure and sub-pointers to hold the given + * number of subsamples. This will allocate pointers for the key ID, IV, + * and subsample entries, set the size members, and zero-initialize the rest. + * + * @param subsample_count The number of subsamples. + * @param key_id_size The number of bytes in the key ID, should be 16. + * @param iv_size The number of bytes in the IV, should be 16. + * + * @return The new AVEncryptionInfo structure, or NULL on error. + */ +AVEncryptionInfo *av_encryption_info_alloc(uint32_t subsample_count, uint32_t key_id_size, uint32_t iv_size); + +/** + * Allocates an AVEncryptionInfo structure with a copy of the given data. + * @return The new AVEncryptionInfo structure, or NULL on error. + */ +AVEncryptionInfo *av_encryption_info_clone(const AVEncryptionInfo *info); + +/** + * Frees the given encryption info object. This MUST NOT be used to free the + * side-data data pointer, that should use normal side-data methods. + */ +void av_encryption_info_free(AVEncryptionInfo *info); + +/** + * Creates a copy of the AVEncryptionInfo that is contained in the given side + * data. The resulting object should be passed to av_encryption_info_free() + * when done. + * + * @return The new AVEncryptionInfo structure, or NULL on error. + */ +AVEncryptionInfo *av_encryption_info_get_side_data(const uint8_t *side_data, size_t side_data_size); + +/** + * Allocates and initializes side data that holds a copy of the given encryption + * info. The resulting pointer should be either freed using av_free or given + * to av_packet_add_side_data(). + * + * @return The new side-data pointer, or NULL. + */ +uint8_t *av_encryption_info_add_side_data( + const AVEncryptionInfo *info, size_t *side_data_size); + + +/** + * Allocates an AVEncryptionInitInfo structure and sub-pointers to hold the + * given sizes. This will allocate pointers and set all the fields. + * + * @return The new AVEncryptionInitInfo structure, or NULL on error. + */ +AVEncryptionInitInfo *av_encryption_init_info_alloc( + uint32_t system_id_size, uint32_t num_key_ids, uint32_t key_id_size, uint32_t data_size); + +/** + * Frees the given encryption init info object. This MUST NOT be used to free + * the side-data data pointer, that should use normal side-data methods. + */ +void av_encryption_init_info_free(AVEncryptionInitInfo* info); + +/** + * Creates a copy of the AVEncryptionInitInfo that is contained in the given + * side data. The resulting object should be passed to + * av_encryption_init_info_free() when done. + * + * @return The new AVEncryptionInitInfo structure, or NULL on error. + */ +AVEncryptionInitInfo *av_encryption_init_info_get_side_data( + const uint8_t* side_data, size_t side_data_size); + +/** + * Allocates and initializes side data that holds a copy of the given encryption + * init info. The resulting pointer should be either freed using av_free or + * given to av_packet_add_side_data(). + * + * @return The new side-data pointer, or NULL. + */ +uint8_t *av_encryption_init_info_add_side_data( + const AVEncryptionInitInfo *info, size_t *side_data_size); + +#endif /* AVUTIL_ENCRYPTION_INFO_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/error.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/error.h new file mode 100644 index 0000000..71df4da --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/error.h @@ -0,0 +1,126 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * error code definitions + */ + +#ifndef AVUTIL_ERROR_H +#define AVUTIL_ERROR_H + +#include +#include + +/** + * @addtogroup lavu_error + * + * @{ + */ + + +/* error handling */ +#if EDOM > 0 +#define AVERROR(e) (-(e)) ///< Returns a negative error code from a POSIX error code, to return from library functions. +#define AVUNERROR(e) (-(e)) ///< Returns a POSIX error code from a library function error return value. +#else +/* Some platforms have E* and errno already negated. */ +#define AVERROR(e) (e) +#define AVUNERROR(e) (e) +#endif + +#define FFERRTAG(a, b, c, d) (-(int)MKTAG(a, b, c, d)) + +#define AVERROR_BSF_NOT_FOUND FFERRTAG(0xF8,'B','S','F') ///< Bitstream filter not found +#define AVERROR_BUG FFERRTAG( 'B','U','G','!') ///< Internal bug, also see AVERROR_BUG2 +#define AVERROR_BUFFER_TOO_SMALL FFERRTAG( 'B','U','F','S') ///< Buffer too small +#define AVERROR_DECODER_NOT_FOUND FFERRTAG(0xF8,'D','E','C') ///< Decoder not found +#define AVERROR_DEMUXER_NOT_FOUND FFERRTAG(0xF8,'D','E','M') ///< Demuxer not found +#define AVERROR_ENCODER_NOT_FOUND FFERRTAG(0xF8,'E','N','C') ///< Encoder not found +#define AVERROR_EOF FFERRTAG( 'E','O','F',' ') ///< End of file +#define AVERROR_EXIT FFERRTAG( 'E','X','I','T') ///< Immediate exit was requested; the called function should not be restarted +#define AVERROR_EXTERNAL FFERRTAG( 'E','X','T',' ') ///< Generic error in an external library +#define AVERROR_FILTER_NOT_FOUND FFERRTAG(0xF8,'F','I','L') ///< Filter not found +#define AVERROR_INVALIDDATA FFERRTAG( 'I','N','D','A') ///< Invalid data found when processing input +#define AVERROR_MUXER_NOT_FOUND FFERRTAG(0xF8,'M','U','X') ///< Muxer not found +#define AVERROR_OPTION_NOT_FOUND FFERRTAG(0xF8,'O','P','T') ///< Option not found +#define AVERROR_PATCHWELCOME FFERRTAG( 'P','A','W','E') ///< Not yet implemented in FFmpeg, patches welcome +#define AVERROR_PROTOCOL_NOT_FOUND FFERRTAG(0xF8,'P','R','O') ///< Protocol not found + +#define AVERROR_STREAM_NOT_FOUND FFERRTAG(0xF8,'S','T','R') ///< Stream not found +/** + * This is semantically identical to AVERROR_BUG + * it has been introduced in Libav after our AVERROR_BUG and with a modified value. + */ +#define AVERROR_BUG2 FFERRTAG( 'B','U','G',' ') +#define AVERROR_UNKNOWN FFERRTAG( 'U','N','K','N') ///< Unknown error, typically from an external library +#define AVERROR_EXPERIMENTAL (-0x2bb2afa8) ///< Requested feature is flagged experimental. Set strict_std_compliance if you really want to use it. +#define AVERROR_INPUT_CHANGED (-0x636e6701) ///< Input changed between calls. Reconfiguration is required. (can be OR-ed with AVERROR_OUTPUT_CHANGED) +#define AVERROR_OUTPUT_CHANGED (-0x636e6702) ///< Output changed between calls. Reconfiguration is required. (can be OR-ed with AVERROR_INPUT_CHANGED) +/* HTTP & RTSP errors */ +#define AVERROR_HTTP_BAD_REQUEST FFERRTAG(0xF8,'4','0','0') +#define AVERROR_HTTP_UNAUTHORIZED FFERRTAG(0xF8,'4','0','1') +#define AVERROR_HTTP_FORBIDDEN FFERRTAG(0xF8,'4','0','3') +#define AVERROR_HTTP_NOT_FOUND FFERRTAG(0xF8,'4','0','4') +#define AVERROR_HTTP_OTHER_4XX FFERRTAG(0xF8,'4','X','X') +#define AVERROR_HTTP_SERVER_ERROR FFERRTAG(0xF8,'5','X','X') + +#define AV_ERROR_MAX_STRING_SIZE 64 + +/** + * Put a description of the AVERROR code errnum in errbuf. + * In case of failure the global variable errno is set to indicate the + * error. Even in case of failure av_strerror() will print a generic + * error message indicating the errnum provided to errbuf. + * + * @param errnum error code to describe + * @param errbuf buffer to which description is written + * @param errbuf_size the size in bytes of errbuf + * @return 0 on success, a negative value if a description for errnum + * cannot be found + */ +int av_strerror(int errnum, char *errbuf, size_t errbuf_size); + +/** + * Fill the provided buffer with a string containing an error string + * corresponding to the AVERROR code errnum. + * + * @param errbuf a buffer + * @param errbuf_size size in bytes of errbuf + * @param errnum error code to describe + * @return the buffer in input, filled with the error description + * @see av_strerror() + */ +static inline char *av_make_error_string(char *errbuf, size_t errbuf_size, int errnum) +{ + av_strerror(errnum, errbuf, errbuf_size); + return errbuf; +} + +/** + * Convenience macro, the return value should be used only directly in + * function arguments but never stand-alone. + */ +#define av_err2str(errnum) \ + av_make_error_string((char[AV_ERROR_MAX_STRING_SIZE]){0}, AV_ERROR_MAX_STRING_SIZE, errnum) + +/** + * @} + */ + +#endif /* AVUTIL_ERROR_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/eval.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/eval.h new file mode 100644 index 0000000..068c62c --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/eval.h @@ -0,0 +1,137 @@ +/* + * Copyright (c) 2002 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * simple arithmetic expression evaluator + */ + +#ifndef AVUTIL_EVAL_H +#define AVUTIL_EVAL_H + +#include "avutil.h" + +typedef struct AVExpr AVExpr; + +/** + * Parse and evaluate an expression. + * Note, this is significantly slower than av_expr_eval(). + * + * @param res a pointer to a double where is put the result value of + * the expression, or NAN in case of error + * @param s expression as a zero terminated string, for example "1+2^3+5*5+sin(2/3)" + * @param const_names NULL terminated array of zero terminated strings of constant identifiers, for example {"PI", "E", 0} + * @param const_values a zero terminated array of values for the identifiers from const_names + * @param func1_names NULL terminated array of zero terminated strings of funcs1 identifiers + * @param funcs1 NULL terminated array of function pointers for functions which take 1 argument + * @param func2_names NULL terminated array of zero terminated strings of funcs2 identifiers + * @param funcs2 NULL terminated array of function pointers for functions which take 2 arguments + * @param opaque a pointer which will be passed to all functions from funcs1 and funcs2 + * @param log_ctx parent logging context + * @return >= 0 in case of success, a negative value corresponding to an + * AVERROR code otherwise + */ +int av_expr_parse_and_eval(double *res, const char *s, + const char * const *const_names, const double *const_values, + const char * const *func1_names, double (* const *funcs1)(void *, double), + const char * const *func2_names, double (* const *funcs2)(void *, double, double), + void *opaque, int log_offset, void *log_ctx); + +/** + * Parse an expression. + * + * @param expr a pointer where is put an AVExpr containing the parsed + * value in case of successful parsing, or NULL otherwise. + * The pointed to AVExpr must be freed with av_expr_free() by the user + * when it is not needed anymore. + * @param s expression as a zero terminated string, for example "1+2^3+5*5+sin(2/3)" + * @param const_names NULL terminated array of zero terminated strings of constant identifiers, for example {"PI", "E", 0} + * @param func1_names NULL terminated array of zero terminated strings of funcs1 identifiers + * @param funcs1 NULL terminated array of function pointers for functions which take 1 argument + * @param func2_names NULL terminated array of zero terminated strings of funcs2 identifiers + * @param funcs2 NULL terminated array of function pointers for functions which take 2 arguments + * @param log_ctx parent logging context + * @return >= 0 in case of success, a negative value corresponding to an + * AVERROR code otherwise + */ +int av_expr_parse(AVExpr **expr, const char *s, + const char * const *const_names, + const char * const *func1_names, double (* const *funcs1)(void *, double), + const char * const *func2_names, double (* const *funcs2)(void *, double, double), + int log_offset, void *log_ctx); + +/** + * Evaluate a previously parsed expression. + * + * @param const_values a zero terminated array of values for the identifiers from av_expr_parse() const_names + * @param opaque a pointer which will be passed to all functions from funcs1 and funcs2 + * @return the value of the expression + */ +double av_expr_eval(AVExpr *e, const double *const_values, void *opaque); + +/** + * Track the presence of variables and their number of occurrences in a parsed expression + * + * @param counter a zero-initialized array where the count of each variable will be stored + * @param size size of array + * @return 0 on success, a negative value indicates that no expression or array was passed + * or size was zero + */ +int av_expr_count_vars(AVExpr *e, unsigned *counter, int size); + +/** + * Track the presence of user provided functions and their number of occurrences + * in a parsed expression. + * + * @param counter a zero-initialized array where the count of each function will be stored + * if you passed 5 functions with 2 arguments to av_expr_parse() + * then for arg=2 this will use upto 5 entries. + * @param size size of array + * @param arg number of arguments the counted functions have + * @return 0 on success, a negative value indicates that no expression or array was passed + * or size was zero + */ +int av_expr_count_func(AVExpr *e, unsigned *counter, int size, int arg); + +/** + * Free a parsed expression previously created with av_expr_parse(). + */ +void av_expr_free(AVExpr *e); + +/** + * Parse the string in numstr and return its value as a double. If + * the string is empty, contains only whitespaces, or does not contain + * an initial substring that has the expected syntax for a + * floating-point number, no conversion is performed. In this case, + * returns a value of zero and the value returned in tail is the value + * of numstr. + * + * @param numstr a string representing a number, may contain one of + * the International System number postfixes, for example 'K', 'M', + * 'G'. If 'i' is appended after the postfix, powers of 2 are used + * instead of powers of 10. The 'B' postfix multiplies the value by + * 8, and can be appended after another postfix or used alone. This + * allows using for example 'KB', 'MiB', 'G' and 'B' as postfix. + * @param tail if non-NULL puts here the pointer to the char next + * after the last parsed character + */ +double av_strtod(const char *numstr, char **tail); + +#endif /* AVUTIL_EVAL_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/ffversion.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/ffversion.h new file mode 100644 index 0000000..a218de1 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/ffversion.h @@ -0,0 +1,5 @@ +/* Automatically generated by version.sh, do not manually edit! */ +#ifndef AVUTIL_FFVERSION_H +#define AVUTIL_FFVERSION_H +#define FFMPEG_VERSION "n4.3.2" +#endif /* AVUTIL_FFVERSION_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/fifo.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/fifo.h new file mode 100644 index 0000000..dc7bc6f --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/fifo.h @@ -0,0 +1,179 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * a very simple circular buffer FIFO implementation + */ + +#ifndef AVUTIL_FIFO_H +#define AVUTIL_FIFO_H + +#include +#include "avutil.h" +#include "attributes.h" + +typedef struct AVFifoBuffer { + uint8_t *buffer; + uint8_t *rptr, *wptr, *end; + uint32_t rndx, wndx; +} AVFifoBuffer; + +/** + * Initialize an AVFifoBuffer. + * @param size of FIFO + * @return AVFifoBuffer or NULL in case of memory allocation failure + */ +AVFifoBuffer *av_fifo_alloc(unsigned int size); + +/** + * Initialize an AVFifoBuffer. + * @param nmemb number of elements + * @param size size of the single element + * @return AVFifoBuffer or NULL in case of memory allocation failure + */ +AVFifoBuffer *av_fifo_alloc_array(size_t nmemb, size_t size); + +/** + * Free an AVFifoBuffer. + * @param f AVFifoBuffer to free + */ +void av_fifo_free(AVFifoBuffer *f); + +/** + * Free an AVFifoBuffer and reset pointer to NULL. + * @param f AVFifoBuffer to free + */ +void av_fifo_freep(AVFifoBuffer **f); + +/** + * Reset the AVFifoBuffer to the state right after av_fifo_alloc, in particular it is emptied. + * @param f AVFifoBuffer to reset + */ +void av_fifo_reset(AVFifoBuffer *f); + +/** + * Return the amount of data in bytes in the AVFifoBuffer, that is the + * amount of data you can read from it. + * @param f AVFifoBuffer to read from + * @return size + */ +int av_fifo_size(const AVFifoBuffer *f); + +/** + * Return the amount of space in bytes in the AVFifoBuffer, that is the + * amount of data you can write into it. + * @param f AVFifoBuffer to write into + * @return size + */ +int av_fifo_space(const AVFifoBuffer *f); + +/** + * Feed data at specific position from an AVFifoBuffer to a user-supplied callback. + * Similar as av_fifo_gereric_read but without discarding data. + * @param f AVFifoBuffer to read from + * @param offset offset from current read position + * @param buf_size number of bytes to read + * @param func generic read function + * @param dest data destination + */ +int av_fifo_generic_peek_at(AVFifoBuffer *f, void *dest, int offset, int buf_size, void (*func)(void*, void*, int)); + +/** + * Feed data from an AVFifoBuffer to a user-supplied callback. + * Similar as av_fifo_gereric_read but without discarding data. + * @param f AVFifoBuffer to read from + * @param buf_size number of bytes to read + * @param func generic read function + * @param dest data destination + */ +int av_fifo_generic_peek(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int)); + +/** + * Feed data from an AVFifoBuffer to a user-supplied callback. + * @param f AVFifoBuffer to read from + * @param buf_size number of bytes to read + * @param func generic read function + * @param dest data destination + */ +int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void (*func)(void*, void*, int)); + +/** + * Feed data from a user-supplied callback to an AVFifoBuffer. + * @param f AVFifoBuffer to write to + * @param src data source; non-const since it may be used as a + * modifiable context by the function defined in func + * @param size number of bytes to write + * @param func generic write function; the first parameter is src, + * the second is dest_buf, the third is dest_buf_size. + * func must return the number of bytes written to dest_buf, or <= 0 to + * indicate no more data available to write. + * If func is NULL, src is interpreted as a simple byte array for source data. + * @return the number of bytes written to the FIFO + */ +int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int (*func)(void*, void*, int)); + +/** + * Resize an AVFifoBuffer. + * In case of reallocation failure, the old FIFO is kept unchanged. + * + * @param f AVFifoBuffer to resize + * @param size new AVFifoBuffer size in bytes + * @return <0 for failure, >=0 otherwise + */ +int av_fifo_realloc2(AVFifoBuffer *f, unsigned int size); + +/** + * Enlarge an AVFifoBuffer. + * In case of reallocation failure, the old FIFO is kept unchanged. + * The new fifo size may be larger than the requested size. + * + * @param f AVFifoBuffer to resize + * @param additional_space the amount of space in bytes to allocate in addition to av_fifo_size() + * @return <0 for failure, >=0 otherwise + */ +int av_fifo_grow(AVFifoBuffer *f, unsigned int additional_space); + +/** + * Read and discard the specified amount of data from an AVFifoBuffer. + * @param f AVFifoBuffer to read from + * @param size amount of data to read in bytes + */ +void av_fifo_drain(AVFifoBuffer *f, int size); + +/** + * Return a pointer to the data stored in a FIFO buffer at a certain offset. + * The FIFO buffer is not modified. + * + * @param f AVFifoBuffer to peek at, f must be non-NULL + * @param offs an offset in bytes, its absolute value must be less + * than the used buffer size or the returned pointer will + * point outside to the buffer data. + * The used buffer size can be checked with av_fifo_size(). + */ +static inline uint8_t *av_fifo_peek2(const AVFifoBuffer *f, int offs) +{ + uint8_t *ptr = f->rptr + offs; + if (ptr >= f->end) + ptr = f->buffer + (ptr - f->end); + else if (ptr < f->buffer) + ptr = f->end - (f->buffer - ptr); + return ptr; +} + +#endif /* AVUTIL_FIFO_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/file.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/file.h new file mode 100644 index 0000000..3ef4a60 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/file.h @@ -0,0 +1,71 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_FILE_H +#define AVUTIL_FILE_H + +#include + +#include "avutil.h" + +/** + * @file + * Misc file utilities. + */ + +/** + * Read the file with name filename, and put its content in a newly + * allocated buffer or map it with mmap() when available. + * In case of success set *bufptr to the read or mmapped buffer, and + * *size to the size in bytes of the buffer in *bufptr. + * Unlike mmap this function succeeds with zero sized files, in this + * case *bufptr will be set to NULL and *size will be set to 0. + * The returned buffer must be released with av_file_unmap(). + * + * @param log_offset loglevel offset used for logging + * @param log_ctx context used for logging + * @return a non negative number in case of success, a negative value + * corresponding to an AVERROR error code in case of failure + */ +av_warn_unused_result +int av_file_map(const char *filename, uint8_t **bufptr, size_t *size, + int log_offset, void *log_ctx); + +/** + * Unmap or free the buffer bufptr created by av_file_map(). + * + * @param size size in bytes of bufptr, must be the same as returned + * by av_file_map() + */ +void av_file_unmap(uint8_t *bufptr, size_t size); + +/** + * Wrapper to work around the lack of mkstemp() on mingw. + * Also, tries to create file in /tmp first, if possible. + * *prefix can be a character constant; *filename will be allocated internally. + * @return file descriptor of opened file (or negative value corresponding to an + * AVERROR code on error) + * and opened file name in **filename. + * @note On very old libcs it is necessary to set a secure umask before + * calling this, av_tempfile() can't call umask itself as it is used in + * libraries and could interfere with the calling application. + * @deprecated as fd numbers cannot be passed saftely between libs on some platforms + */ +int av_tempfile(const char *prefix, char **filename, int log_offset, void *log_ctx); + +#endif /* AVUTIL_FILE_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/frame.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/frame.h new file mode 100644 index 0000000..fc67db0 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/frame.h @@ -0,0 +1,975 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @ingroup lavu_frame + * reference-counted frame API + */ + +#ifndef AVUTIL_FRAME_H +#define AVUTIL_FRAME_H + +#include +#include + +#include "avutil.h" +#include "buffer.h" +#include "dict.h" +#include "rational.h" +#include "samplefmt.h" +#include "pixfmt.h" +#include "version.h" + + +/** + * @defgroup lavu_frame AVFrame + * @ingroup lavu_data + * + * @{ + * AVFrame is an abstraction for reference-counted raw multimedia data. + */ + +enum AVFrameSideDataType { + /** + * The data is the AVPanScan struct defined in libavcodec. + */ + AV_FRAME_DATA_PANSCAN, + /** + * ATSC A53 Part 4 Closed Captions. + * A53 CC bitstream is stored as uint8_t in AVFrameSideData.data. + * The number of bytes of CC data is AVFrameSideData.size. + */ + AV_FRAME_DATA_A53_CC, + /** + * Stereoscopic 3d metadata. + * The data is the AVStereo3D struct defined in libavutil/stereo3d.h. + */ + AV_FRAME_DATA_STEREO3D, + /** + * The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h. + */ + AV_FRAME_DATA_MATRIXENCODING, + /** + * Metadata relevant to a downmix procedure. + * The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h. + */ + AV_FRAME_DATA_DOWNMIX_INFO, + /** + * ReplayGain information in the form of the AVReplayGain struct. + */ + AV_FRAME_DATA_REPLAYGAIN, + /** + * This side data contains a 3x3 transformation matrix describing an affine + * transformation that needs to be applied to the frame for correct + * presentation. + * + * See libavutil/display.h for a detailed description of the data. + */ + AV_FRAME_DATA_DISPLAYMATRIX, + /** + * Active Format Description data consisting of a single byte as specified + * in ETSI TS 101 154 using AVActiveFormatDescription enum. + */ + AV_FRAME_DATA_AFD, + /** + * Motion vectors exported by some codecs (on demand through the export_mvs + * flag set in the libavcodec AVCodecContext flags2 option). + * The data is the AVMotionVector struct defined in + * libavutil/motion_vector.h. + */ + AV_FRAME_DATA_MOTION_VECTORS, + /** + * Recommmends skipping the specified number of samples. This is exported + * only if the "skip_manual" AVOption is set in libavcodec. + * This has the same format as AV_PKT_DATA_SKIP_SAMPLES. + * @code + * u32le number of samples to skip from start of this packet + * u32le number of samples to skip from end of this packet + * u8 reason for start skip + * u8 reason for end skip (0=padding silence, 1=convergence) + * @endcode + */ + AV_FRAME_DATA_SKIP_SAMPLES, + /** + * This side data must be associated with an audio frame and corresponds to + * enum AVAudioServiceType defined in avcodec.h. + */ + AV_FRAME_DATA_AUDIO_SERVICE_TYPE, + /** + * Mastering display metadata associated with a video frame. The payload is + * an AVMasteringDisplayMetadata type and contains information about the + * mastering display color volume. + */ + AV_FRAME_DATA_MASTERING_DISPLAY_METADATA, + /** + * The GOP timecode in 25 bit timecode format. Data format is 64-bit integer. + * This is set on the first frame of a GOP that has a temporal reference of 0. + */ + AV_FRAME_DATA_GOP_TIMECODE, + + /** + * The data represents the AVSphericalMapping structure defined in + * libavutil/spherical.h. + */ + AV_FRAME_DATA_SPHERICAL, + + /** + * Content light level (based on CTA-861.3). This payload contains data in + * the form of the AVContentLightMetadata struct. + */ + AV_FRAME_DATA_CONTENT_LIGHT_LEVEL, + + /** + * The data contains an ICC profile as an opaque octet buffer following the + * format described by ISO 15076-1 with an optional name defined in the + * metadata key entry "name". + */ + AV_FRAME_DATA_ICC_PROFILE, + +#if FF_API_FRAME_QP + /** + * Implementation-specific description of the format of AV_FRAME_QP_TABLE_DATA. + * The contents of this side data are undocumented and internal; use + * av_frame_set_qp_table() and av_frame_get_qp_table() to access this in a + * meaningful way instead. + */ + AV_FRAME_DATA_QP_TABLE_PROPERTIES, + + /** + * Raw QP table data. Its format is described by + * AV_FRAME_DATA_QP_TABLE_PROPERTIES. Use av_frame_set_qp_table() and + * av_frame_get_qp_table() to access this instead. + */ + AV_FRAME_DATA_QP_TABLE_DATA, +#endif + + /** + * Timecode which conforms to SMPTE ST 12-1. The data is an array of 4 uint32_t + * where the first uint32_t describes how many (1-3) of the other timecodes are used. + * The timecode format is described in the av_timecode_get_smpte_from_framenum() + * function in libavutil/timecode.c. + */ + AV_FRAME_DATA_S12M_TIMECODE, + + /** + * HDR dynamic metadata associated with a video frame. The payload is + * an AVDynamicHDRPlus type and contains information for color + * volume transform - application 4 of SMPTE 2094-40:2016 standard. + */ + AV_FRAME_DATA_DYNAMIC_HDR_PLUS, + + /** + * Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of + * array element is implied by AVFrameSideData.size / AVRegionOfInterest.self_size. + */ + AV_FRAME_DATA_REGIONS_OF_INTEREST, + + /** + * Encoding parameters for a video frame, as described by AVVideoEncParams. + */ + AV_FRAME_DATA_VIDEO_ENC_PARAMS, +}; + +enum AVActiveFormatDescription { + AV_AFD_SAME = 8, + AV_AFD_4_3 = 9, + AV_AFD_16_9 = 10, + AV_AFD_14_9 = 11, + AV_AFD_4_3_SP_14_9 = 13, + AV_AFD_16_9_SP_14_9 = 14, + AV_AFD_SP_4_3 = 15, +}; + + +/** + * Structure to hold side data for an AVFrame. + * + * sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added + * to the end with a minor bump. + */ +typedef struct AVFrameSideData { + enum AVFrameSideDataType type; + uint8_t *data; + int size; + AVDictionary *metadata; + AVBufferRef *buf; +} AVFrameSideData; + +/** + * Structure describing a single Region Of Interest. + * + * When multiple regions are defined in a single side-data block, they + * should be ordered from most to least important - some encoders are only + * capable of supporting a limited number of distinct regions, so will have + * to truncate the list. + * + * When overlapping regions are defined, the first region containing a given + * area of the frame applies. + */ +typedef struct AVRegionOfInterest { + /** + * Must be set to the size of this data structure (that is, + * sizeof(AVRegionOfInterest)). + */ + uint32_t self_size; + /** + * Distance in pixels from the top edge of the frame to the top and + * bottom edges and from the left edge of the frame to the left and + * right edges of the rectangle defining this region of interest. + * + * The constraints on a region are encoder dependent, so the region + * actually affected may be slightly larger for alignment or other + * reasons. + */ + int top; + int bottom; + int left; + int right; + /** + * Quantisation offset. + * + * Must be in the range -1 to +1. A value of zero indicates no quality + * change. A negative value asks for better quality (less quantisation), + * while a positive value asks for worse quality (greater quantisation). + * + * The range is calibrated so that the extreme values indicate the + * largest possible offset - if the rest of the frame is encoded with the + * worst possible quality, an offset of -1 indicates that this region + * should be encoded with the best possible quality anyway. Intermediate + * values are then interpolated in some codec-dependent way. + * + * For example, in 10-bit H.264 the quantisation parameter varies between + * -12 and 51. A typical qoffset value of -1/10 therefore indicates that + * this region should be encoded with a QP around one-tenth of the full + * range better than the rest of the frame. So, if most of the frame + * were to be encoded with a QP of around 30, this region would get a QP + * of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3). + * An extreme value of -1 would indicate that this region should be + * encoded with the best possible quality regardless of the treatment of + * the rest of the frame - that is, should be encoded at a QP of -12. + */ + AVRational qoffset; +} AVRegionOfInterest; + +/** + * This structure describes decoded (raw) audio or video data. + * + * AVFrame must be allocated using av_frame_alloc(). Note that this only + * allocates the AVFrame itself, the buffers for the data must be managed + * through other means (see below). + * AVFrame must be freed with av_frame_free(). + * + * AVFrame is typically allocated once and then reused multiple times to hold + * different data (e.g. a single AVFrame to hold frames received from a + * decoder). In such a case, av_frame_unref() will free any references held by + * the frame and reset it to its original clean state before it + * is reused again. + * + * The data described by an AVFrame is usually reference counted through the + * AVBuffer API. The underlying buffer references are stored in AVFrame.buf / + * AVFrame.extended_buf. An AVFrame is considered to be reference counted if at + * least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case, + * every single data plane must be contained in one of the buffers in + * AVFrame.buf or AVFrame.extended_buf. + * There may be a single buffer for all the data, or one separate buffer for + * each plane, or anything in between. + * + * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added + * to the end with a minor bump. + * + * Fields can be accessed through AVOptions, the name string used, matches the + * C structure field name for fields accessible through AVOptions. The AVClass + * for AVFrame can be obtained from avcodec_get_frame_class() + */ +typedef struct AVFrame { +#define AV_NUM_DATA_POINTERS 8 + /** + * pointer to the picture/channel planes. + * This might be different from the first allocated byte + * + * Some decoders access areas outside 0,0 - width,height, please + * see avcodec_align_dimensions2(). Some filters and swscale can read + * up to 16 bytes beyond the planes, if these filters are to be used, + * then 16 extra bytes must be allocated. + * + * NOTE: Except for hwaccel formats, pointers not needed by the format + * MUST be set to NULL. + */ + uint8_t *data[AV_NUM_DATA_POINTERS]; + + /** + * For video, size in bytes of each picture line. + * For audio, size in bytes of each plane. + * + * For audio, only linesize[0] may be set. For planar audio, each channel + * plane must be the same size. + * + * For video the linesizes should be multiples of the CPUs alignment + * preference, this is 16 or 32 for modern desktop CPUs. + * Some code requires such alignment other code can be slower without + * correct alignment, for yet other it makes no difference. + * + * @note The linesize may be larger than the size of usable data -- there + * may be extra padding present for performance reasons. + */ + int linesize[AV_NUM_DATA_POINTERS]; + + /** + * pointers to the data planes/channels. + * + * For video, this should simply point to data[]. + * + * For planar audio, each channel has a separate data pointer, and + * linesize[0] contains the size of each channel buffer. + * For packed audio, there is just one data pointer, and linesize[0] + * contains the total size of the buffer for all channels. + * + * Note: Both data and extended_data should always be set in a valid frame, + * but for planar audio with more channels that can fit in data, + * extended_data must be used in order to access all channels. + */ + uint8_t **extended_data; + + /** + * @name Video dimensions + * Video frames only. The coded dimensions (in pixels) of the video frame, + * i.e. the size of the rectangle that contains some well-defined values. + * + * @note The part of the frame intended for display/presentation is further + * restricted by the @ref cropping "Cropping rectangle". + * @{ + */ + int width, height; + /** + * @} + */ + + /** + * number of audio samples (per channel) described by this frame + */ + int nb_samples; + + /** + * format of the frame, -1 if unknown or unset + * Values correspond to enum AVPixelFormat for video frames, + * enum AVSampleFormat for audio) + */ + int format; + + /** + * 1 -> keyframe, 0-> not + */ + int key_frame; + + /** + * Picture type of the frame. + */ + enum AVPictureType pict_type; + + /** + * Sample aspect ratio for the video frame, 0/1 if unknown/unspecified. + */ + AVRational sample_aspect_ratio; + + /** + * Presentation timestamp in time_base units (time when frame should be shown to user). + */ + int64_t pts; + +#if FF_API_PKT_PTS + /** + * PTS copied from the AVPacket that was decoded to produce this frame. + * @deprecated use the pts field instead + */ + attribute_deprecated + int64_t pkt_pts; +#endif + + /** + * DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used) + * This is also the Presentation time of this AVFrame calculated from + * only AVPacket.dts values without pts values. + */ + int64_t pkt_dts; + + /** + * picture number in bitstream order + */ + int coded_picture_number; + /** + * picture number in display order + */ + int display_picture_number; + + /** + * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) + */ + int quality; + + /** + * for some private data of the user + */ + void *opaque; + +#if FF_API_ERROR_FRAME + /** + * @deprecated unused + */ + attribute_deprecated + uint64_t error[AV_NUM_DATA_POINTERS]; +#endif + + /** + * When decoding, this signals how much the picture must be delayed. + * extra_delay = repeat_pict / (2*fps) + */ + int repeat_pict; + + /** + * The content of the picture is interlaced. + */ + int interlaced_frame; + + /** + * If the content is interlaced, is top field displayed first. + */ + int top_field_first; + + /** + * Tell user application that palette has changed from previous frame. + */ + int palette_has_changed; + + /** + * reordered opaque 64 bits (generally an integer or a double precision float + * PTS but can be anything). + * The user sets AVCodecContext.reordered_opaque to represent the input at + * that time, + * the decoder reorders values as needed and sets AVFrame.reordered_opaque + * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque + */ + int64_t reordered_opaque; + + /** + * Sample rate of the audio data. + */ + int sample_rate; + + /** + * Channel layout of the audio data. + */ + uint64_t channel_layout; + + /** + * AVBuffer references backing the data for this frame. If all elements of + * this array are NULL, then this frame is not reference counted. This array + * must be filled contiguously -- if buf[i] is non-NULL then buf[j] must + * also be non-NULL for all j < i. + * + * There may be at most one AVBuffer per data plane, so for video this array + * always contains all the references. For planar audio with more than + * AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in + * this array. Then the extra AVBufferRef pointers are stored in the + * extended_buf array. + */ + AVBufferRef *buf[AV_NUM_DATA_POINTERS]; + + /** + * For planar audio which requires more than AV_NUM_DATA_POINTERS + * AVBufferRef pointers, this array will hold all the references which + * cannot fit into AVFrame.buf. + * + * Note that this is different from AVFrame.extended_data, which always + * contains all the pointers. This array only contains the extra pointers, + * which cannot fit into AVFrame.buf. + * + * This array is always allocated using av_malloc() by whoever constructs + * the frame. It is freed in av_frame_unref(). + */ + AVBufferRef **extended_buf; + /** + * Number of elements in extended_buf. + */ + int nb_extended_buf; + + AVFrameSideData **side_data; + int nb_side_data; + +/** + * @defgroup lavu_frame_flags AV_FRAME_FLAGS + * @ingroup lavu_frame + * Flags describing additional frame properties. + * + * @{ + */ + +/** + * The frame data may be corrupted, e.g. due to decoding errors. + */ +#define AV_FRAME_FLAG_CORRUPT (1 << 0) +/** + * A flag to mark the frames which need to be decoded, but shouldn't be output. + */ +#define AV_FRAME_FLAG_DISCARD (1 << 2) +/** + * @} + */ + + /** + * Frame flags, a combination of @ref lavu_frame_flags + */ + int flags; + + /** + * MPEG vs JPEG YUV range. + * - encoding: Set by user + * - decoding: Set by libavcodec + */ + enum AVColorRange color_range; + + enum AVColorPrimaries color_primaries; + + enum AVColorTransferCharacteristic color_trc; + + /** + * YUV colorspace type. + * - encoding: Set by user + * - decoding: Set by libavcodec + */ + enum AVColorSpace colorspace; + + enum AVChromaLocation chroma_location; + + /** + * frame timestamp estimated using various heuristics, in stream time base + * - encoding: unused + * - decoding: set by libavcodec, read by user. + */ + int64_t best_effort_timestamp; + + /** + * reordered pos from the last AVPacket that has been input into the decoder + * - encoding: unused + * - decoding: Read by user. + */ + int64_t pkt_pos; + + /** + * duration of the corresponding packet, expressed in + * AVStream->time_base units, 0 if unknown. + * - encoding: unused + * - decoding: Read by user. + */ + int64_t pkt_duration; + + /** + * metadata. + * - encoding: Set by user. + * - decoding: Set by libavcodec. + */ + AVDictionary *metadata; + + /** + * decode error flags of the frame, set to a combination of + * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there + * were errors during the decoding. + * - encoding: unused + * - decoding: set by libavcodec, read by user. + */ + int decode_error_flags; +#define FF_DECODE_ERROR_INVALID_BITSTREAM 1 +#define FF_DECODE_ERROR_MISSING_REFERENCE 2 +#define FF_DECODE_ERROR_CONCEALMENT_ACTIVE 4 +#define FF_DECODE_ERROR_DECODE_SLICES 8 + + /** + * number of audio channels, only used for audio. + * - encoding: unused + * - decoding: Read by user. + */ + int channels; + + /** + * size of the corresponding packet containing the compressed + * frame. + * It is set to a negative value if unknown. + * - encoding: unused + * - decoding: set by libavcodec, read by user. + */ + int pkt_size; + +#if FF_API_FRAME_QP + /** + * QP table + */ + attribute_deprecated + int8_t *qscale_table; + /** + * QP store stride + */ + attribute_deprecated + int qstride; + + attribute_deprecated + int qscale_type; + + attribute_deprecated + AVBufferRef *qp_table_buf; +#endif + /** + * For hwaccel-format frames, this should be a reference to the + * AVHWFramesContext describing the frame. + */ + AVBufferRef *hw_frames_ctx; + + /** + * AVBufferRef for free use by the API user. FFmpeg will never check the + * contents of the buffer ref. FFmpeg calls av_buffer_unref() on it when + * the frame is unreferenced. av_frame_copy_props() calls create a new + * reference with av_buffer_ref() for the target frame's opaque_ref field. + * + * This is unrelated to the opaque field, although it serves a similar + * purpose. + */ + AVBufferRef *opaque_ref; + + /** + * @anchor cropping + * @name Cropping + * Video frames only. The number of pixels to discard from the the + * top/bottom/left/right border of the frame to obtain the sub-rectangle of + * the frame intended for presentation. + * @{ + */ + size_t crop_top; + size_t crop_bottom; + size_t crop_left; + size_t crop_right; + /** + * @} + */ + + /** + * AVBufferRef for internal use by a single libav* library. + * Must not be used to transfer data between libraries. + * Has to be NULL when ownership of the frame leaves the respective library. + * + * Code outside the FFmpeg libs should never check or change the contents of the buffer ref. + * + * FFmpeg calls av_buffer_unref() on it when the frame is unreferenced. + * av_frame_copy_props() calls create a new reference with av_buffer_ref() + * for the target frame's private_ref field. + */ + AVBufferRef *private_ref; +} AVFrame; + +#if FF_API_FRAME_GET_SET +/** + * Accessors for some AVFrame fields. These used to be provided for ABI + * compatibility, and do not need to be used anymore. + */ +attribute_deprecated +int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame); +attribute_deprecated +void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val); +attribute_deprecated +int64_t av_frame_get_pkt_duration (const AVFrame *frame); +attribute_deprecated +void av_frame_set_pkt_duration (AVFrame *frame, int64_t val); +attribute_deprecated +int64_t av_frame_get_pkt_pos (const AVFrame *frame); +attribute_deprecated +void av_frame_set_pkt_pos (AVFrame *frame, int64_t val); +attribute_deprecated +int64_t av_frame_get_channel_layout (const AVFrame *frame); +attribute_deprecated +void av_frame_set_channel_layout (AVFrame *frame, int64_t val); +attribute_deprecated +int av_frame_get_channels (const AVFrame *frame); +attribute_deprecated +void av_frame_set_channels (AVFrame *frame, int val); +attribute_deprecated +int av_frame_get_sample_rate (const AVFrame *frame); +attribute_deprecated +void av_frame_set_sample_rate (AVFrame *frame, int val); +attribute_deprecated +AVDictionary *av_frame_get_metadata (const AVFrame *frame); +attribute_deprecated +void av_frame_set_metadata (AVFrame *frame, AVDictionary *val); +attribute_deprecated +int av_frame_get_decode_error_flags (const AVFrame *frame); +attribute_deprecated +void av_frame_set_decode_error_flags (AVFrame *frame, int val); +attribute_deprecated +int av_frame_get_pkt_size(const AVFrame *frame); +attribute_deprecated +void av_frame_set_pkt_size(AVFrame *frame, int val); +#if FF_API_FRAME_QP +attribute_deprecated +int8_t *av_frame_get_qp_table(AVFrame *f, int *stride, int *type); +attribute_deprecated +int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type); +#endif +attribute_deprecated +enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame); +attribute_deprecated +void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val); +attribute_deprecated +enum AVColorRange av_frame_get_color_range(const AVFrame *frame); +attribute_deprecated +void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val); +#endif + +/** + * Get the name of a colorspace. + * @return a static string identifying the colorspace; can be NULL. + */ +const char *av_get_colorspace_name(enum AVColorSpace val); + +/** + * Allocate an AVFrame and set its fields to default values. The resulting + * struct must be freed using av_frame_free(). + * + * @return An AVFrame filled with default values or NULL on failure. + * + * @note this only allocates the AVFrame itself, not the data buffers. Those + * must be allocated through other means, e.g. with av_frame_get_buffer() or + * manually. + */ +AVFrame *av_frame_alloc(void); + +/** + * Free the frame and any dynamically allocated objects in it, + * e.g. extended_data. If the frame is reference counted, it will be + * unreferenced first. + * + * @param frame frame to be freed. The pointer will be set to NULL. + */ +void av_frame_free(AVFrame **frame); + +/** + * Set up a new reference to the data described by the source frame. + * + * Copy frame properties from src to dst and create a new reference for each + * AVBufferRef from src. + * + * If src is not reference counted, new buffers are allocated and the data is + * copied. + * + * @warning: dst MUST have been either unreferenced with av_frame_unref(dst), + * or newly allocated with av_frame_alloc() before calling this + * function, or undefined behavior will occur. + * + * @return 0 on success, a negative AVERROR on error + */ +int av_frame_ref(AVFrame *dst, const AVFrame *src); + +/** + * Create a new frame that references the same data as src. + * + * This is a shortcut for av_frame_alloc()+av_frame_ref(). + * + * @return newly created AVFrame on success, NULL on error. + */ +AVFrame *av_frame_clone(const AVFrame *src); + +/** + * Unreference all the buffers referenced by frame and reset the frame fields. + */ +void av_frame_unref(AVFrame *frame); + +/** + * Move everything contained in src to dst and reset src. + * + * @warning: dst is not unreferenced, but directly overwritten without reading + * or deallocating its contents. Call av_frame_unref(dst) manually + * before calling this function to ensure that no memory is leaked. + */ +void av_frame_move_ref(AVFrame *dst, AVFrame *src); + +/** + * Allocate new buffer(s) for audio or video data. + * + * The following fields must be set on frame before calling this function: + * - format (pixel format for video, sample format for audio) + * - width and height for video + * - nb_samples and channel_layout for audio + * + * This function will fill AVFrame.data and AVFrame.buf arrays and, if + * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf. + * For planar formats, one buffer will be allocated for each plane. + * + * @warning: if frame already has been allocated, calling this function will + * leak memory. In addition, undefined behavior can occur in certain + * cases. + * + * @param frame frame in which to store the new buffers. + * @param align Required buffer size alignment. If equal to 0, alignment will be + * chosen automatically for the current CPU. It is highly + * recommended to pass 0 here unless you know what you are doing. + * + * @return 0 on success, a negative AVERROR on error. + */ +int av_frame_get_buffer(AVFrame *frame, int align); + +/** + * Check if the frame data is writable. + * + * @return A positive value if the frame data is writable (which is true if and + * only if each of the underlying buffers has only one reference, namely the one + * stored in this frame). Return 0 otherwise. + * + * If 1 is returned the answer is valid until av_buffer_ref() is called on any + * of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly). + * + * @see av_frame_make_writable(), av_buffer_is_writable() + */ +int av_frame_is_writable(AVFrame *frame); + +/** + * Ensure that the frame data is writable, avoiding data copy if possible. + * + * Do nothing if the frame is writable, allocate new buffers and copy the data + * if it is not. + * + * @return 0 on success, a negative AVERROR on error. + * + * @see av_frame_is_writable(), av_buffer_is_writable(), + * av_buffer_make_writable() + */ +int av_frame_make_writable(AVFrame *frame); + +/** + * Copy the frame data from src to dst. + * + * This function does not allocate anything, dst must be already initialized and + * allocated with the same parameters as src. + * + * This function only copies the frame data (i.e. the contents of the data / + * extended data arrays), not any other properties. + * + * @return >= 0 on success, a negative AVERROR on error. + */ +int av_frame_copy(AVFrame *dst, const AVFrame *src); + +/** + * Copy only "metadata" fields from src to dst. + * + * Metadata for the purpose of this function are those fields that do not affect + * the data layout in the buffers. E.g. pts, sample rate (for audio) or sample + * aspect ratio (for video), but not width/height or channel layout. + * Side data is also copied. + */ +int av_frame_copy_props(AVFrame *dst, const AVFrame *src); + +/** + * Get the buffer reference a given data plane is stored in. + * + * @param plane index of the data plane of interest in frame->extended_data. + * + * @return the buffer reference that contains the plane or NULL if the input + * frame is not valid. + */ +AVBufferRef *av_frame_get_plane_buffer(AVFrame *frame, int plane); + +/** + * Add a new side data to a frame. + * + * @param frame a frame to which the side data should be added + * @param type type of the added side data + * @param size size of the side data + * + * @return newly added side data on success, NULL on error + */ +AVFrameSideData *av_frame_new_side_data(AVFrame *frame, + enum AVFrameSideDataType type, + int size); + +/** + * Add a new side data to a frame from an existing AVBufferRef + * + * @param frame a frame to which the side data should be added + * @param type the type of the added side data + * @param buf an AVBufferRef to add as side data. The ownership of + * the reference is transferred to the frame. + * + * @return newly added side data on success, NULL on error. On failure + * the frame is unchanged and the AVBufferRef remains owned by + * the caller. + */ +AVFrameSideData *av_frame_new_side_data_from_buf(AVFrame *frame, + enum AVFrameSideDataType type, + AVBufferRef *buf); + +/** + * @return a pointer to the side data of a given type on success, NULL if there + * is no side data with such type in this frame. + */ +AVFrameSideData *av_frame_get_side_data(const AVFrame *frame, + enum AVFrameSideDataType type); + +/** + * Remove and free all side data instances of the given type. + */ +void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type); + + +/** + * Flags for frame cropping. + */ +enum { + /** + * Apply the maximum possible cropping, even if it requires setting the + * AVFrame.data[] entries to unaligned pointers. Passing unaligned data + * to FFmpeg API is generally not allowed, and causes undefined behavior + * (such as crashes). You can pass unaligned data only to FFmpeg APIs that + * are explicitly documented to accept it. Use this flag only if you + * absolutely know what you are doing. + */ + AV_FRAME_CROP_UNALIGNED = 1 << 0, +}; + +/** + * Crop the given video AVFrame according to its crop_left/crop_top/crop_right/ + * crop_bottom fields. If cropping is successful, the function will adjust the + * data pointers and the width/height fields, and set the crop fields to 0. + * + * In all cases, the cropping boundaries will be rounded to the inherent + * alignment of the pixel format. In some cases, such as for opaque hwaccel + * formats, the left/top cropping is ignored. The crop fields are set to 0 even + * if the cropping was rounded or ignored. + * + * @param frame the frame which should be cropped + * @param flags Some combination of AV_FRAME_CROP_* flags, or 0. + * + * @return >= 0 on success, a negative AVERROR on error. If the cropping fields + * were invalid, AVERROR(ERANGE) is returned, and nothing is changed. + */ +int av_frame_apply_cropping(AVFrame *frame, int flags); + +/** + * @return a string identifying the side data type + */ +const char *av_frame_side_data_name(enum AVFrameSideDataType type); + +/** + * @} + */ + +#endif /* AVUTIL_FRAME_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hash.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hash.h new file mode 100644 index 0000000..7693e6b --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hash.h @@ -0,0 +1,269 @@ +/* + * Copyright (C) 2013 Reimar Döffinger + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @ingroup lavu_hash_generic + * Generic hashing API + */ + +#ifndef AVUTIL_HASH_H +#define AVUTIL_HASH_H + +#include + +#include "version.h" + +/** + * @defgroup lavu_hash Hash Functions + * @ingroup lavu_crypto + * Hash functions useful in multimedia. + * + * Hash functions are widely used in multimedia, from error checking and + * concealment to internal regression testing. libavutil has efficient + * implementations of a variety of hash functions that may be useful for + * FFmpeg and other multimedia applications. + * + * @{ + * + * @defgroup lavu_hash_generic Generic Hashing API + * An abstraction layer for all hash functions supported by libavutil. + * + * If your application needs to support a wide range of different hash + * functions, then the Generic Hashing API is for you. It provides a generic, + * reusable API for @ref lavu_hash "all hash functions" implemented in libavutil. + * If you just need to use one particular hash function, use the @ref lavu_hash + * "individual hash" directly. + * + * @section Sample Code + * + * A basic template for using the Generic Hashing API follows: + * + * @code + * struct AVHashContext *ctx = NULL; + * const char *hash_name = NULL; + * uint8_t *output_buf = NULL; + * + * // Select from a string returned by av_hash_names() + * hash_name = ...; + * + * // Allocate a hash context + * ret = av_hash_alloc(&ctx, hash_name); + * if (ret < 0) + * return ret; + * + * // Initialize the hash context + * av_hash_init(ctx); + * + * // Update the hash context with data + * while (data_left) { + * av_hash_update(ctx, data, size); + * } + * + * // Now we have no more data, so it is time to finalize the hash and get the + * // output. But we need to first allocate an output buffer. Note that you can + * // use any memory allocation function, including malloc(), not just + * // av_malloc(). + * output_buf = av_malloc(av_hash_get_size(ctx)); + * if (!output_buf) + * return AVERROR(ENOMEM); + * + * // Finalize the hash context. + * // You can use any of the av_hash_final*() functions provided, for other + * // output formats. If you do so, be sure to adjust the memory allocation + * // above. See the function documentation below for the exact amount of extra + * // memory needed. + * av_hash_final(ctx, output_buffer); + * + * // Free the context + * av_hash_freep(&ctx); + * @endcode + * + * @section Hash Function-Specific Information + * If the CRC32 hash is selected, the #AV_CRC_32_IEEE polynomial will be + * used. + * + * If the Murmur3 hash is selected, the default seed will be used. See @ref + * lavu_murmur3_seedinfo "Murmur3" for more information. + * + * @{ + */ + +/** + * @example ffhash.c + * This example is a simple command line application that takes one or more + * arguments. It demonstrates a typical use of the hashing API with allocation, + * initialization, updating, and finalizing. + */ + +struct AVHashContext; + +/** + * Allocate a hash context for the algorithm specified by name. + * + * @return >= 0 for success, a negative error code for failure + * + * @note The context is not initialized after a call to this function; you must + * call av_hash_init() to do so. + */ +int av_hash_alloc(struct AVHashContext **ctx, const char *name); + +/** + * Get the names of available hash algorithms. + * + * This function can be used to enumerate the algorithms. + * + * @param[in] i Index of the hash algorithm, starting from 0 + * @return Pointer to a static string or `NULL` if `i` is out of range + */ +const char *av_hash_names(int i); + +/** + * Get the name of the algorithm corresponding to the given hash context. + */ +const char *av_hash_get_name(const struct AVHashContext *ctx); + +/** + * Maximum value that av_hash_get_size() will currently return. + * + * You can use this if you absolutely want or need to use static allocation for + * the output buffer and are fine with not supporting hashes newly added to + * libavutil without recompilation. + * + * @warning + * Adding new hashes with larger sizes, and increasing the macro while doing + * so, will not be considered an ABI change. To prevent your code from + * overflowing a buffer, either dynamically allocate the output buffer with + * av_hash_get_size(), or limit your use of the Hashing API to hashes that are + * already in FFmpeg during the time of compilation. + */ +#define AV_HASH_MAX_SIZE 64 + +/** + * Get the size of the resulting hash value in bytes. + * + * The maximum value this function will currently return is available as macro + * #AV_HASH_MAX_SIZE. + * + * @param[in] ctx Hash context + * @return Size of the hash value in bytes + */ +int av_hash_get_size(const struct AVHashContext *ctx); + +/** + * Initialize or reset a hash context. + * + * @param[in,out] ctx Hash context + */ +void av_hash_init(struct AVHashContext *ctx); + +/** + * Update a hash context with additional data. + * + * @param[in,out] ctx Hash context + * @param[in] src Data to be added to the hash context + * @param[in] len Size of the additional data + */ +#if FF_API_CRYPTO_SIZE_T +void av_hash_update(struct AVHashContext *ctx, const uint8_t *src, int len); +#else +void av_hash_update(struct AVHashContext *ctx, const uint8_t *src, size_t len); +#endif + +/** + * Finalize a hash context and compute the actual hash value. + * + * The minimum size of `dst` buffer is given by av_hash_get_size() or + * #AV_HASH_MAX_SIZE. The use of the latter macro is discouraged. + * + * It is not safe to update or finalize a hash context again, if it has already + * been finalized. + * + * @param[in,out] ctx Hash context + * @param[out] dst Where the final hash value will be stored + * + * @see av_hash_final_bin() provides an alternative API + */ +void av_hash_final(struct AVHashContext *ctx, uint8_t *dst); + +/** + * Finalize a hash context and store the actual hash value in a buffer. + * + * It is not safe to update or finalize a hash context again, if it has already + * been finalized. + * + * If `size` is smaller than the hash size (given by av_hash_get_size()), the + * hash is truncated; if size is larger, the buffer is padded with 0. + * + * @param[in,out] ctx Hash context + * @param[out] dst Where the final hash value will be stored + * @param[in] size Number of bytes to write to `dst` + */ +void av_hash_final_bin(struct AVHashContext *ctx, uint8_t *dst, int size); + +/** + * Finalize a hash context and store the hexadecimal representation of the + * actual hash value as a string. + * + * It is not safe to update or finalize a hash context again, if it has already + * been finalized. + * + * The string is always 0-terminated. + * + * If `size` is smaller than `2 * hash_size + 1`, where `hash_size` is the + * value returned by av_hash_get_size(), the string will be truncated. + * + * @param[in,out] ctx Hash context + * @param[out] dst Where the string will be stored + * @param[in] size Maximum number of bytes to write to `dst` + */ +void av_hash_final_hex(struct AVHashContext *ctx, uint8_t *dst, int size); + +/** + * Finalize a hash context and store the Base64 representation of the + * actual hash value as a string. + * + * It is not safe to update or finalize a hash context again, if it has already + * been finalized. + * + * The string is always 0-terminated. + * + * If `size` is smaller than AV_BASE64_SIZE(hash_size), where `hash_size` is + * the value returned by av_hash_get_size(), the string will be truncated. + * + * @param[in,out] ctx Hash context + * @param[out] dst Where the final hash value will be stored + * @param[in] size Maximum number of bytes to write to `dst` + */ +void av_hash_final_b64(struct AVHashContext *ctx, uint8_t *dst, int size); + +/** + * Free hash context and set hash context pointer to `NULL`. + * + * @param[in,out] ctx Pointer to hash context + */ +void av_hash_freep(struct AVHashContext **ctx); + +/** + * @} + * @} + */ + +#endif /* AVUTIL_HASH_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hdr_dynamic_metadata.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hdr_dynamic_metadata.h new file mode 100644 index 0000000..2d72de5 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hdr_dynamic_metadata.h @@ -0,0 +1,343 @@ +/* + * Copyright (c) 2018 Mohammad Izadi + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_HDR_DYNAMIC_METADATA_H +#define AVUTIL_HDR_DYNAMIC_METADATA_H + +#include "frame.h" +#include "rational.h" + +/** + * Option for overlapping elliptical pixel selectors in an image. + */ +enum AVHDRPlusOverlapProcessOption { + AV_HDR_PLUS_OVERLAP_PROCESS_WEIGHTED_AVERAGING = 0, + AV_HDR_PLUS_OVERLAP_PROCESS_LAYERING = 1, +}; + +/** + * Represents the percentile at a specific percentage in + * a distribution. + */ +typedef struct AVHDRPlusPercentile { + /** + * The percentage value corresponding to a specific percentile linearized + * RGB value in the processing window in the scene. The value shall be in + * the range of 0 to100, inclusive. + */ + uint8_t percentage; + + /** + * The linearized maxRGB value at a specific percentile in the processing + * window in the scene. The value shall be in the range of 0 to 1, inclusive + * and in multiples of 0.00001. + */ + AVRational percentile; +} AVHDRPlusPercentile; + +/** + * Color transform parameters at a processing window in a dynamic metadata for + * SMPTE 2094-40. + */ +typedef struct AVHDRPlusColorTransformParams { + /** + * The relative x coordinate of the top left pixel of the processing + * window. The value shall be in the range of 0 and 1, inclusive and + * in multiples of 1/(width of Picture - 1). The value 1 corresponds + * to the absolute coordinate of width of Picture - 1. The value for + * first processing window shall be 0. + */ + AVRational window_upper_left_corner_x; + + /** + * The relative y coordinate of the top left pixel of the processing + * window. The value shall be in the range of 0 and 1, inclusive and + * in multiples of 1/(height of Picture - 1). The value 1 corresponds + * to the absolute coordinate of height of Picture - 1. The value for + * first processing window shall be 0. + */ + AVRational window_upper_left_corner_y; + + /** + * The relative x coordinate of the bottom right pixel of the processing + * window. The value shall be in the range of 0 and 1, inclusive and + * in multiples of 1/(width of Picture - 1). The value 1 corresponds + * to the absolute coordinate of width of Picture - 1. The value for + * first processing window shall be 1. + */ + AVRational window_lower_right_corner_x; + + /** + * The relative y coordinate of the bottom right pixel of the processing + * window. The value shall be in the range of 0 and 1, inclusive and + * in multiples of 1/(height of Picture - 1). The value 1 corresponds + * to the absolute coordinate of height of Picture - 1. The value for + * first processing window shall be 1. + */ + AVRational window_lower_right_corner_y; + + /** + * The x coordinate of the center position of the concentric internal and + * external ellipses of the elliptical pixel selector in the processing + * window. The value shall be in the range of 0 to (width of Picture - 1), + * inclusive and in multiples of 1 pixel. + */ + uint16_t center_of_ellipse_x; + + /** + * The y coordinate of the center position of the concentric internal and + * external ellipses of the elliptical pixel selector in the processing + * window. The value shall be in the range of 0 to (height of Picture - 1), + * inclusive and in multiples of 1 pixel. + */ + uint16_t center_of_ellipse_y; + + /** + * The clockwise rotation angle in degree of arc with respect to the + * positive direction of the x-axis of the concentric internal and external + * ellipses of the elliptical pixel selector in the processing window. The + * value shall be in the range of 0 to 180, inclusive and in multiples of 1. + */ + uint8_t rotation_angle; + + /** + * The semi-major axis value of the internal ellipse of the elliptical pixel + * selector in amount of pixels in the processing window. The value shall be + * in the range of 1 to 65535, inclusive and in multiples of 1 pixel. + */ + uint16_t semimajor_axis_internal_ellipse; + + /** + * The semi-major axis value of the external ellipse of the elliptical pixel + * selector in amount of pixels in the processing window. The value + * shall not be less than semimajor_axis_internal_ellipse of the current + * processing window. The value shall be in the range of 1 to 65535, + * inclusive and in multiples of 1 pixel. + */ + uint16_t semimajor_axis_external_ellipse; + + /** + * The semi-minor axis value of the external ellipse of the elliptical pixel + * selector in amount of pixels in the processing window. The value shall be + * in the range of 1 to 65535, inclusive and in multiples of 1 pixel. + */ + uint16_t semiminor_axis_external_ellipse; + + /** + * Overlap process option indicates one of the two methods of combining + * rendered pixels in the processing window in an image with at least one + * elliptical pixel selector. For overlapping elliptical pixel selectors + * in an image, overlap_process_option shall have the same value. + */ + enum AVHDRPlusOverlapProcessOption overlap_process_option; + + /** + * The maximum of the color components of linearized RGB values in the + * processing window in the scene. The values should be in the range of 0 to + * 1, inclusive and in multiples of 0.00001. maxscl[ 0 ], maxscl[ 1 ], and + * maxscl[ 2 ] are corresponding to R, G, B color components respectively. + */ + AVRational maxscl[3]; + + /** + * The average of linearized maxRGB values in the processing window in the + * scene. The value should be in the range of 0 to 1, inclusive and in + * multiples of 0.00001. + */ + AVRational average_maxrgb; + + /** + * The number of linearized maxRGB values at given percentiles in the + * processing window in the scene. The maximum value shall be 15. + */ + uint8_t num_distribution_maxrgb_percentiles; + + /** + * The linearized maxRGB values at given percentiles in the + * processing window in the scene. + */ + AVHDRPlusPercentile distribution_maxrgb[15]; + + /** + * The fraction of selected pixels in the image that contains the brightest + * pixel in the scene. The value shall be in the range of 0 to 1, inclusive + * and in multiples of 0.001. + */ + AVRational fraction_bright_pixels; + + /** + * This flag indicates that the metadata for the tone mapping function in + * the processing window is present (for value of 1). + */ + uint8_t tone_mapping_flag; + + /** + * The x coordinate of the separation point between the linear part and the + * curved part of the tone mapping function. The value shall be in the range + * of 0 to 1, excluding 0 and in multiples of 1/4095. + */ + AVRational knee_point_x; + + /** + * The y coordinate of the separation point between the linear part and the + * curved part of the tone mapping function. The value shall be in the range + * of 0 to 1, excluding 0 and in multiples of 1/4095. + */ + AVRational knee_point_y; + + /** + * The number of the intermediate anchor parameters of the tone mapping + * function in the processing window. The maximum value shall be 15. + */ + uint8_t num_bezier_curve_anchors; + + /** + * The intermediate anchor parameters of the tone mapping function in the + * processing window in the scene. The values should be in the range of 0 + * to 1, inclusive and in multiples of 1/1023. + */ + AVRational bezier_curve_anchors[15]; + + /** + * This flag shall be equal to 0 in bitstreams conforming to this version of + * this Specification. Other values are reserved for future use. + */ + uint8_t color_saturation_mapping_flag; + + /** + * The color saturation gain in the processing window in the scene. The + * value shall be in the range of 0 to 63/8, inclusive and in multiples of + * 1/8. The default value shall be 1. + */ + AVRational color_saturation_weight; +} AVHDRPlusColorTransformParams; + +/** + * This struct represents dynamic metadata for color volume transform - + * application 4 of SMPTE 2094-40:2016 standard. + * + * To be used as payload of a AVFrameSideData or AVPacketSideData with the + * appropriate type. + * + * @note The struct should be allocated with + * av_dynamic_hdr_plus_alloc() and its size is not a part of + * the public ABI. + */ +typedef struct AVDynamicHDRPlus { + /** + * Country code by Rec. ITU-T T.35 Annex A. The value shall be 0xB5. + */ + uint8_t itu_t_t35_country_code; + + /** + * Application version in the application defining document in ST-2094 + * suite. The value shall be set to 0. + */ + uint8_t application_version; + + /** + * The number of processing windows. The value shall be in the range + * of 1 to 3, inclusive. + */ + uint8_t num_windows; + + /** + * The color transform parameters for every processing window. + */ + AVHDRPlusColorTransformParams params[3]; + + /** + * The nominal maximum display luminance of the targeted system display, + * in units of 0.0001 candelas per square metre. The value shall be in + * the range of 0 to 10000, inclusive. + */ + AVRational targeted_system_display_maximum_luminance; + + /** + * This flag shall be equal to 0 in bit streams conforming to this version + * of this Specification. The value 1 is reserved for future use. + */ + uint8_t targeted_system_display_actual_peak_luminance_flag; + + /** + * The number of rows in the targeted system_display_actual_peak_luminance + * array. The value shall be in the range of 2 to 25, inclusive. + */ + uint8_t num_rows_targeted_system_display_actual_peak_luminance; + + /** + * The number of columns in the + * targeted_system_display_actual_peak_luminance array. The value shall be + * in the range of 2 to 25, inclusive. + */ + uint8_t num_cols_targeted_system_display_actual_peak_luminance; + + /** + * The normalized actual peak luminance of the targeted system display. The + * values should be in the range of 0 to 1, inclusive and in multiples of + * 1/15. + */ + AVRational targeted_system_display_actual_peak_luminance[25][25]; + + /** + * This flag shall be equal to 0 in bitstreams conforming to this version of + * this Specification. The value 1 is reserved for future use. + */ + uint8_t mastering_display_actual_peak_luminance_flag; + + /** + * The number of rows in the mastering_display_actual_peak_luminance array. + * The value shall be in the range of 2 to 25, inclusive. + */ + uint8_t num_rows_mastering_display_actual_peak_luminance; + + /** + * The number of columns in the mastering_display_actual_peak_luminance + * array. The value shall be in the range of 2 to 25, inclusive. + */ + uint8_t num_cols_mastering_display_actual_peak_luminance; + + /** + * The normalized actual peak luminance of the mastering display used for + * mastering the image essence. The values should be in the range of 0 to 1, + * inclusive and in multiples of 1/15. + */ + AVRational mastering_display_actual_peak_luminance[25][25]; +} AVDynamicHDRPlus; + +/** + * Allocate an AVDynamicHDRPlus structure and set its fields to + * default values. The resulting struct can be freed using av_freep(). + * + * @return An AVDynamicHDRPlus filled with default values or NULL + * on failure. + */ +AVDynamicHDRPlus *av_dynamic_hdr_plus_alloc(size_t *size); + +/** + * Allocate a complete AVDynamicHDRPlus and add it to the frame. + * @param frame The frame which side data is added to. + * + * @return The AVDynamicHDRPlus structure to be filled by caller or NULL + * on failure. + */ +AVDynamicHDRPlus *av_dynamic_hdr_plus_create_side_data(AVFrame *frame); + +#endif /* AVUTIL_HDR_DYNAMIC_METADATA_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hmac.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hmac.h new file mode 100644 index 0000000..412e950 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hmac.h @@ -0,0 +1,100 @@ +/* + * Copyright (C) 2012 Martin Storsjo + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_HMAC_H +#define AVUTIL_HMAC_H + +#include + +#include "version.h" +/** + * @defgroup lavu_hmac HMAC + * @ingroup lavu_crypto + * @{ + */ + +enum AVHMACType { + AV_HMAC_MD5, + AV_HMAC_SHA1, + AV_HMAC_SHA224, + AV_HMAC_SHA256, + AV_HMAC_SHA384, + AV_HMAC_SHA512, +}; + +typedef struct AVHMAC AVHMAC; + +/** + * Allocate an AVHMAC context. + * @param type The hash function used for the HMAC. + */ +AVHMAC *av_hmac_alloc(enum AVHMACType type); + +/** + * Free an AVHMAC context. + * @param ctx The context to free, may be NULL + */ +void av_hmac_free(AVHMAC *ctx); + +/** + * Initialize an AVHMAC context with an authentication key. + * @param ctx The HMAC context + * @param key The authentication key + * @param keylen The length of the key, in bytes + */ +void av_hmac_init(AVHMAC *ctx, const uint8_t *key, unsigned int keylen); + +/** + * Hash data with the HMAC. + * @param ctx The HMAC context + * @param data The data to hash + * @param len The length of the data, in bytes + */ +void av_hmac_update(AVHMAC *ctx, const uint8_t *data, unsigned int len); + +/** + * Finish hashing and output the HMAC digest. + * @param ctx The HMAC context + * @param out The output buffer to write the digest into + * @param outlen The length of the out buffer, in bytes + * @return The number of bytes written to out, or a negative error code. + */ +int av_hmac_final(AVHMAC *ctx, uint8_t *out, unsigned int outlen); + +/** + * Hash an array of data with a key. + * @param ctx The HMAC context + * @param data The data to hash + * @param len The length of the data, in bytes + * @param key The authentication key + * @param keylen The length of the key, in bytes + * @param out The output buffer to write the digest into + * @param outlen The length of the out buffer, in bytes + * @return The number of bytes written to out, or a negative error code. + */ +int av_hmac_calc(AVHMAC *ctx, const uint8_t *data, unsigned int len, + const uint8_t *key, unsigned int keylen, + uint8_t *out, unsigned int outlen); + +/** + * @} + */ + +#endif /* AVUTIL_HMAC_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext.h new file mode 100644 index 0000000..04d19d8 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext.h @@ -0,0 +1,605 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_HWCONTEXT_H +#define AVUTIL_HWCONTEXT_H + +#include "buffer.h" +#include "frame.h" +#include "log.h" +#include "pixfmt.h" + +enum AVHWDeviceType { + AV_HWDEVICE_TYPE_NONE, + AV_HWDEVICE_TYPE_VDPAU, + AV_HWDEVICE_TYPE_CUDA, + AV_HWDEVICE_TYPE_VAAPI, + AV_HWDEVICE_TYPE_DXVA2, + AV_HWDEVICE_TYPE_QSV, + AV_HWDEVICE_TYPE_VIDEOTOOLBOX, + AV_HWDEVICE_TYPE_D3D11VA, + AV_HWDEVICE_TYPE_DRM, + AV_HWDEVICE_TYPE_OPENCL, + AV_HWDEVICE_TYPE_MEDIACODEC, + AV_HWDEVICE_TYPE_VULKAN, +}; + +typedef struct AVHWDeviceInternal AVHWDeviceInternal; + +/** + * This struct aggregates all the (hardware/vendor-specific) "high-level" state, + * i.e. state that is not tied to a concrete processing configuration. + * E.g., in an API that supports hardware-accelerated encoding and decoding, + * this struct will (if possible) wrap the state that is common to both encoding + * and decoding and from which specific instances of encoders or decoders can be + * derived. + * + * This struct is reference-counted with the AVBuffer mechanism. The + * av_hwdevice_ctx_alloc() constructor yields a reference, whose data field + * points to the actual AVHWDeviceContext. Further objects derived from + * AVHWDeviceContext (such as AVHWFramesContext, describing a frame pool with + * specific properties) will hold an internal reference to it. After all the + * references are released, the AVHWDeviceContext itself will be freed, + * optionally invoking a user-specified callback for uninitializing the hardware + * state. + */ +typedef struct AVHWDeviceContext { + /** + * A class for logging. Set by av_hwdevice_ctx_alloc(). + */ + const AVClass *av_class; + + /** + * Private data used internally by libavutil. Must not be accessed in any + * way by the caller. + */ + AVHWDeviceInternal *internal; + + /** + * This field identifies the underlying API used for hardware access. + * + * This field is set when this struct is allocated and never changed + * afterwards. + */ + enum AVHWDeviceType type; + + /** + * The format-specific data, allocated and freed by libavutil along with + * this context. + * + * Should be cast by the user to the format-specific context defined in the + * corresponding header (hwcontext_*.h) and filled as described in the + * documentation before calling av_hwdevice_ctx_init(). + * + * After calling av_hwdevice_ctx_init() this struct should not be modified + * by the caller. + */ + void *hwctx; + + /** + * This field may be set by the caller before calling av_hwdevice_ctx_init(). + * + * If non-NULL, this callback will be called when the last reference to + * this context is unreferenced, immediately before it is freed. + * + * @note when other objects (e.g an AVHWFramesContext) are derived from this + * struct, this callback will be invoked after all such child objects + * are fully uninitialized and their respective destructors invoked. + */ + void (*free)(struct AVHWDeviceContext *ctx); + + /** + * Arbitrary user data, to be used e.g. by the free() callback. + */ + void *user_opaque; +} AVHWDeviceContext; + +typedef struct AVHWFramesInternal AVHWFramesInternal; + +/** + * This struct describes a set or pool of "hardware" frames (i.e. those with + * data not located in normal system memory). All the frames in the pool are + * assumed to be allocated in the same way and interchangeable. + * + * This struct is reference-counted with the AVBuffer mechanism and tied to a + * given AVHWDeviceContext instance. The av_hwframe_ctx_alloc() constructor + * yields a reference, whose data field points to the actual AVHWFramesContext + * struct. + */ +typedef struct AVHWFramesContext { + /** + * A class for logging. + */ + const AVClass *av_class; + + /** + * Private data used internally by libavutil. Must not be accessed in any + * way by the caller. + */ + AVHWFramesInternal *internal; + + /** + * A reference to the parent AVHWDeviceContext. This reference is owned and + * managed by the enclosing AVHWFramesContext, but the caller may derive + * additional references from it. + */ + AVBufferRef *device_ref; + + /** + * The parent AVHWDeviceContext. This is simply a pointer to + * device_ref->data provided for convenience. + * + * Set by libavutil in av_hwframe_ctx_init(). + */ + AVHWDeviceContext *device_ctx; + + /** + * The format-specific data, allocated and freed automatically along with + * this context. + * + * Should be cast by the user to the format-specific context defined in the + * corresponding header (hwframe_*.h) and filled as described in the + * documentation before calling av_hwframe_ctx_init(). + * + * After any frames using this context are created, the contents of this + * struct should not be modified by the caller. + */ + void *hwctx; + + /** + * This field may be set by the caller before calling av_hwframe_ctx_init(). + * + * If non-NULL, this callback will be called when the last reference to + * this context is unreferenced, immediately before it is freed. + */ + void (*free)(struct AVHWFramesContext *ctx); + + /** + * Arbitrary user data, to be used e.g. by the free() callback. + */ + void *user_opaque; + + /** + * A pool from which the frames are allocated by av_hwframe_get_buffer(). + * This field may be set by the caller before calling av_hwframe_ctx_init(). + * The buffers returned by calling av_buffer_pool_get() on this pool must + * have the properties described in the documentation in the corresponding hw + * type's header (hwcontext_*.h). The pool will be freed strictly before + * this struct's free() callback is invoked. + * + * This field may be NULL, then libavutil will attempt to allocate a pool + * internally. Note that certain device types enforce pools allocated at + * fixed size (frame count), which cannot be extended dynamically. In such a + * case, initial_pool_size must be set appropriately. + */ + AVBufferPool *pool; + + /** + * Initial size of the frame pool. If a device type does not support + * dynamically resizing the pool, then this is also the maximum pool size. + * + * May be set by the caller before calling av_hwframe_ctx_init(). Must be + * set if pool is NULL and the device type does not support dynamic pools. + */ + int initial_pool_size; + + /** + * The pixel format identifying the underlying HW surface type. + * + * Must be a hwaccel format, i.e. the corresponding descriptor must have the + * AV_PIX_FMT_FLAG_HWACCEL flag set. + * + * Must be set by the user before calling av_hwframe_ctx_init(). + */ + enum AVPixelFormat format; + + /** + * The pixel format identifying the actual data layout of the hardware + * frames. + * + * Must be set by the caller before calling av_hwframe_ctx_init(). + * + * @note when the underlying API does not provide the exact data layout, but + * only the colorspace/bit depth, this field should be set to the fully + * planar version of that format (e.g. for 8-bit 420 YUV it should be + * AV_PIX_FMT_YUV420P, not AV_PIX_FMT_NV12 or anything else). + */ + enum AVPixelFormat sw_format; + + /** + * The allocated dimensions of the frames in this pool. + * + * Must be set by the user before calling av_hwframe_ctx_init(). + */ + int width, height; +} AVHWFramesContext; + +/** + * Look up an AVHWDeviceType by name. + * + * @param name String name of the device type (case-insensitive). + * @return The type from enum AVHWDeviceType, or AV_HWDEVICE_TYPE_NONE if + * not found. + */ +enum AVHWDeviceType av_hwdevice_find_type_by_name(const char *name); + +/** Get the string name of an AVHWDeviceType. + * + * @param type Type from enum AVHWDeviceType. + * @return Pointer to a static string containing the name, or NULL if the type + * is not valid. + */ +const char *av_hwdevice_get_type_name(enum AVHWDeviceType type); + +/** + * Iterate over supported device types. + * + * @param type AV_HWDEVICE_TYPE_NONE initially, then the previous type + * returned by this function in subsequent iterations. + * @return The next usable device type from enum AVHWDeviceType, or + * AV_HWDEVICE_TYPE_NONE if there are no more. + */ +enum AVHWDeviceType av_hwdevice_iterate_types(enum AVHWDeviceType prev); + +/** + * Allocate an AVHWDeviceContext for a given hardware type. + * + * @param type the type of the hardware device to allocate. + * @return a reference to the newly created AVHWDeviceContext on success or NULL + * on failure. + */ +AVBufferRef *av_hwdevice_ctx_alloc(enum AVHWDeviceType type); + +/** + * Finalize the device context before use. This function must be called after + * the context is filled with all the required information and before it is + * used in any way. + * + * @param ref a reference to the AVHWDeviceContext + * @return 0 on success, a negative AVERROR code on failure + */ +int av_hwdevice_ctx_init(AVBufferRef *ref); + +/** + * Open a device of the specified type and create an AVHWDeviceContext for it. + * + * This is a convenience function intended to cover the simple cases. Callers + * who need to fine-tune device creation/management should open the device + * manually and then wrap it in an AVHWDeviceContext using + * av_hwdevice_ctx_alloc()/av_hwdevice_ctx_init(). + * + * The returned context is already initialized and ready for use, the caller + * should not call av_hwdevice_ctx_init() on it. The user_opaque/free fields of + * the created AVHWDeviceContext are set by this function and should not be + * touched by the caller. + * + * @param device_ctx On success, a reference to the newly-created device context + * will be written here. The reference is owned by the caller + * and must be released with av_buffer_unref() when no longer + * needed. On failure, NULL will be written to this pointer. + * @param type The type of the device to create. + * @param device A type-specific string identifying the device to open. + * @param opts A dictionary of additional (type-specific) options to use in + * opening the device. The dictionary remains owned by the caller. + * @param flags currently unused + * + * @return 0 on success, a negative AVERROR code on failure. + */ +int av_hwdevice_ctx_create(AVBufferRef **device_ctx, enum AVHWDeviceType type, + const char *device, AVDictionary *opts, int flags); + +/** + * Create a new device of the specified type from an existing device. + * + * If the source device is a device of the target type or was originally + * derived from such a device (possibly through one or more intermediate + * devices of other types), then this will return a reference to the + * existing device of the same type as is requested. + * + * Otherwise, it will attempt to derive a new device from the given source + * device. If direct derivation to the new type is not implemented, it will + * attempt the same derivation from each ancestor of the source device in + * turn looking for an implemented derivation method. + * + * @param dst_ctx On success, a reference to the newly-created + * AVHWDeviceContext. + * @param type The type of the new device to create. + * @param src_ctx A reference to an existing AVHWDeviceContext which will be + * used to create the new device. + * @param flags Currently unused; should be set to zero. + * @return Zero on success, a negative AVERROR code on failure. + */ +int av_hwdevice_ctx_create_derived(AVBufferRef **dst_ctx, + enum AVHWDeviceType type, + AVBufferRef *src_ctx, int flags); + +/** + * Create a new device of the specified type from an existing device. + * + * This function performs the same action as av_hwdevice_ctx_create_derived, + * however, it is able to set options for the new device to be derived. + * + * @param dst_ctx On success, a reference to the newly-created + * AVHWDeviceContext. + * @param type The type of the new device to create. + * @param src_ctx A reference to an existing AVHWDeviceContext which will be + * used to create the new device. + * @param options Options for the new device to create, same format as in + * av_hwdevice_ctx_create. + * @param flags Currently unused; should be set to zero. + * @return Zero on success, a negative AVERROR code on failure. + */ +int av_hwdevice_ctx_create_derived_opts(AVBufferRef **dst_ctx, + enum AVHWDeviceType type, + AVBufferRef *src_ctx, + AVDictionary *options, int flags); + +/** + * Allocate an AVHWFramesContext tied to a given device context. + * + * @param device_ctx a reference to a AVHWDeviceContext. This function will make + * a new reference for internal use, the one passed to the + * function remains owned by the caller. + * @return a reference to the newly created AVHWFramesContext on success or NULL + * on failure. + */ +AVBufferRef *av_hwframe_ctx_alloc(AVBufferRef *device_ctx); + +/** + * Finalize the context before use. This function must be called after the + * context is filled with all the required information and before it is attached + * to any frames. + * + * @param ref a reference to the AVHWFramesContext + * @return 0 on success, a negative AVERROR code on failure + */ +int av_hwframe_ctx_init(AVBufferRef *ref); + +/** + * Allocate a new frame attached to the given AVHWFramesContext. + * + * @param hwframe_ctx a reference to an AVHWFramesContext + * @param frame an empty (freshly allocated or unreffed) frame to be filled with + * newly allocated buffers. + * @param flags currently unused, should be set to zero + * @return 0 on success, a negative AVERROR code on failure + */ +int av_hwframe_get_buffer(AVBufferRef *hwframe_ctx, AVFrame *frame, int flags); + +/** + * Copy data to or from a hw surface. At least one of dst/src must have an + * AVHWFramesContext attached. + * + * If src has an AVHWFramesContext attached, then the format of dst (if set) + * must use one of the formats returned by av_hwframe_transfer_get_formats(src, + * AV_HWFRAME_TRANSFER_DIRECTION_FROM). + * If dst has an AVHWFramesContext attached, then the format of src must use one + * of the formats returned by av_hwframe_transfer_get_formats(dst, + * AV_HWFRAME_TRANSFER_DIRECTION_TO) + * + * dst may be "clean" (i.e. with data/buf pointers unset), in which case the + * data buffers will be allocated by this function using av_frame_get_buffer(). + * If dst->format is set, then this format will be used, otherwise (when + * dst->format is AV_PIX_FMT_NONE) the first acceptable format will be chosen. + * + * The two frames must have matching allocated dimensions (i.e. equal to + * AVHWFramesContext.width/height), since not all device types support + * transferring a sub-rectangle of the whole surface. The display dimensions + * (i.e. AVFrame.width/height) may be smaller than the allocated dimensions, but + * also have to be equal for both frames. When the display dimensions are + * smaller than the allocated dimensions, the content of the padding in the + * destination frame is unspecified. + * + * @param dst the destination frame. dst is not touched on failure. + * @param src the source frame. + * @param flags currently unused, should be set to zero + * @return 0 on success, a negative AVERROR error code on failure. + */ +int av_hwframe_transfer_data(AVFrame *dst, const AVFrame *src, int flags); + +enum AVHWFrameTransferDirection { + /** + * Transfer the data from the queried hw frame. + */ + AV_HWFRAME_TRANSFER_DIRECTION_FROM, + + /** + * Transfer the data to the queried hw frame. + */ + AV_HWFRAME_TRANSFER_DIRECTION_TO, +}; + +/** + * Get a list of possible source or target formats usable in + * av_hwframe_transfer_data(). + * + * @param hwframe_ctx the frame context to obtain the information for + * @param dir the direction of the transfer + * @param formats the pointer to the output format list will be written here. + * The list is terminated with AV_PIX_FMT_NONE and must be freed + * by the caller when no longer needed using av_free(). + * If this function returns successfully, the format list will + * have at least one item (not counting the terminator). + * On failure, the contents of this pointer are unspecified. + * @param flags currently unused, should be set to zero + * @return 0 on success, a negative AVERROR code on failure. + */ +int av_hwframe_transfer_get_formats(AVBufferRef *hwframe_ctx, + enum AVHWFrameTransferDirection dir, + enum AVPixelFormat **formats, int flags); + + +/** + * This struct describes the constraints on hardware frames attached to + * a given device with a hardware-specific configuration. This is returned + * by av_hwdevice_get_hwframe_constraints() and must be freed by + * av_hwframe_constraints_free() after use. + */ +typedef struct AVHWFramesConstraints { + /** + * A list of possible values for format in the hw_frames_ctx, + * terminated by AV_PIX_FMT_NONE. This member will always be filled. + */ + enum AVPixelFormat *valid_hw_formats; + + /** + * A list of possible values for sw_format in the hw_frames_ctx, + * terminated by AV_PIX_FMT_NONE. Can be NULL if this information is + * not known. + */ + enum AVPixelFormat *valid_sw_formats; + + /** + * The minimum size of frames in this hw_frames_ctx. + * (Zero if not known.) + */ + int min_width; + int min_height; + + /** + * The maximum size of frames in this hw_frames_ctx. + * (INT_MAX if not known / no limit.) + */ + int max_width; + int max_height; +} AVHWFramesConstraints; + +/** + * Allocate a HW-specific configuration structure for a given HW device. + * After use, the user must free all members as required by the specific + * hardware structure being used, then free the structure itself with + * av_free(). + * + * @param device_ctx a reference to the associated AVHWDeviceContext. + * @return The newly created HW-specific configuration structure on + * success or NULL on failure. + */ +void *av_hwdevice_hwconfig_alloc(AVBufferRef *device_ctx); + +/** + * Get the constraints on HW frames given a device and the HW-specific + * configuration to be used with that device. If no HW-specific + * configuration is provided, returns the maximum possible capabilities + * of the device. + * + * @param ref a reference to the associated AVHWDeviceContext. + * @param hwconfig a filled HW-specific configuration structure, or NULL + * to return the maximum possible capabilities of the device. + * @return AVHWFramesConstraints structure describing the constraints + * on the device, or NULL if not available. + */ +AVHWFramesConstraints *av_hwdevice_get_hwframe_constraints(AVBufferRef *ref, + const void *hwconfig); + +/** + * Free an AVHWFrameConstraints structure. + * + * @param constraints The (filled or unfilled) AVHWFrameConstraints structure. + */ +void av_hwframe_constraints_free(AVHWFramesConstraints **constraints); + + +/** + * Flags to apply to frame mappings. + */ +enum { + /** + * The mapping must be readable. + */ + AV_HWFRAME_MAP_READ = 1 << 0, + /** + * The mapping must be writeable. + */ + AV_HWFRAME_MAP_WRITE = 1 << 1, + /** + * The mapped frame will be overwritten completely in subsequent + * operations, so the current frame data need not be loaded. Any values + * which are not overwritten are unspecified. + */ + AV_HWFRAME_MAP_OVERWRITE = 1 << 2, + /** + * The mapping must be direct. That is, there must not be any copying in + * the map or unmap steps. Note that performance of direct mappings may + * be much lower than normal memory. + */ + AV_HWFRAME_MAP_DIRECT = 1 << 3, +}; + +/** + * Map a hardware frame. + * + * This has a number of different possible effects, depending on the format + * and origin of the src and dst frames. On input, src should be a usable + * frame with valid buffers and dst should be blank (typically as just created + * by av_frame_alloc()). src should have an associated hwframe context, and + * dst may optionally have a format and associated hwframe context. + * + * If src was created by mapping a frame from the hwframe context of dst, + * then this function undoes the mapping - dst is replaced by a reference to + * the frame that src was originally mapped from. + * + * If both src and dst have an associated hwframe context, then this function + * attempts to map the src frame from its hardware context to that of dst and + * then fill dst with appropriate data to be usable there. This will only be + * possible if the hwframe contexts and associated devices are compatible - + * given compatible devices, av_hwframe_ctx_create_derived() can be used to + * create a hwframe context for dst in which mapping should be possible. + * + * If src has a hwframe context but dst does not, then the src frame is + * mapped to normal memory and should thereafter be usable as a normal frame. + * If the format is set on dst, then the mapping will attempt to create dst + * with that format and fail if it is not possible. If format is unset (is + * AV_PIX_FMT_NONE) then dst will be mapped with whatever the most appropriate + * format to use is (probably the sw_format of the src hwframe context). + * + * A return value of AVERROR(ENOSYS) indicates that the mapping is not + * possible with the given arguments and hwframe setup, while other return + * values indicate that it failed somehow. + * + * @param dst Destination frame, to contain the mapping. + * @param src Source frame, to be mapped. + * @param flags Some combination of AV_HWFRAME_MAP_* flags. + * @return Zero on success, negative AVERROR code on failure. + */ +int av_hwframe_map(AVFrame *dst, const AVFrame *src, int flags); + + +/** + * Create and initialise an AVHWFramesContext as a mapping of another existing + * AVHWFramesContext on a different device. + * + * av_hwframe_ctx_init() should not be called after this. + * + * @param derived_frame_ctx On success, a reference to the newly created + * AVHWFramesContext. + * @param derived_device_ctx A reference to the device to create the new + * AVHWFramesContext on. + * @param source_frame_ctx A reference to an existing AVHWFramesContext + * which will be mapped to the derived context. + * @param flags Some combination of AV_HWFRAME_MAP_* flags, defining the + * mapping parameters to apply to frames which are allocated + * in the derived device. + * @return Zero on success, negative AVERROR code on failure. + */ +int av_hwframe_ctx_create_derived(AVBufferRef **derived_frame_ctx, + enum AVPixelFormat format, + AVBufferRef *derived_device_ctx, + AVBufferRef *source_frame_ctx, + int flags); + +#endif /* AVUTIL_HWCONTEXT_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_cuda.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_cuda.h new file mode 100644 index 0000000..cefbe0c --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_cuda.h @@ -0,0 +1,69 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + + +#ifndef AVUTIL_HWCONTEXT_CUDA_H +#define AVUTIL_HWCONTEXT_CUDA_H + +#ifndef CUDA_VERSION +#include +#endif + +#include "pixfmt.h" + +/** + * @file + * An API-specific header for AV_HWDEVICE_TYPE_CUDA. + * + * This API supports dynamic frame pools. AVHWFramesContext.pool must return + * AVBufferRefs whose data pointer is a CUdeviceptr. + */ + +typedef struct AVCUDADeviceContextInternal AVCUDADeviceContextInternal; + +/** + * This struct is allocated as AVHWDeviceContext.hwctx + */ +typedef struct AVCUDADeviceContext { + CUcontext cuda_ctx; + CUstream stream; + AVCUDADeviceContextInternal *internal; +} AVCUDADeviceContext; + +/** + * AVHWFramesContext.hwctx is currently not used + */ + +/** + * @defgroup hwcontext_cuda Device context creation flags + * + * Flags for av_hwdevice_ctx_create. + * + * @{ + */ + +/** + * Use primary device context instead of creating a new one. + */ +#define AV_CUDA_USE_PRIMARY_CONTEXT (1 << 0) + +/** + * @} + */ + +#endif /* AVUTIL_HWCONTEXT_CUDA_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_d3d11va.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_d3d11va.h new file mode 100644 index 0000000..9f91e9b --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_d3d11va.h @@ -0,0 +1,169 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_HWCONTEXT_D3D11VA_H +#define AVUTIL_HWCONTEXT_D3D11VA_H + +/** + * @file + * An API-specific header for AV_HWDEVICE_TYPE_D3D11VA. + * + * The default pool implementation will be fixed-size if initial_pool_size is + * set (and allocate elements from an array texture). Otherwise it will allocate + * individual textures. Be aware that decoding requires a single array texture. + * + * Using sw_format==AV_PIX_FMT_YUV420P has special semantics, and maps to + * DXGI_FORMAT_420_OPAQUE. av_hwframe_transfer_data() is not supported for + * this format. Refer to MSDN for details. + * + * av_hwdevice_ctx_create() for this device type supports a key named "debug" + * for the AVDictionary entry. If this is set to any value, the device creation + * code will try to load various supported D3D debugging layers. + */ + +#include +#include + +/** + * This struct is allocated as AVHWDeviceContext.hwctx + */ +typedef struct AVD3D11VADeviceContext { + /** + * Device used for texture creation and access. This can also be used to + * set the libavcodec decoding device. + * + * Must be set by the user. This is the only mandatory field - the other + * device context fields are set from this and are available for convenience. + * + * Deallocating the AVHWDeviceContext will always release this interface, + * and it does not matter whether it was user-allocated. + */ + ID3D11Device *device; + + /** + * If unset, this will be set from the device field on init. + * + * Deallocating the AVHWDeviceContext will always release this interface, + * and it does not matter whether it was user-allocated. + */ + ID3D11DeviceContext *device_context; + + /** + * If unset, this will be set from the device field on init. + * + * Deallocating the AVHWDeviceContext will always release this interface, + * and it does not matter whether it was user-allocated. + */ + ID3D11VideoDevice *video_device; + + /** + * If unset, this will be set from the device_context field on init. + * + * Deallocating the AVHWDeviceContext will always release this interface, + * and it does not matter whether it was user-allocated. + */ + ID3D11VideoContext *video_context; + + /** + * Callbacks for locking. They protect accesses to device_context and + * video_context calls. They also protect access to the internal staging + * texture (for av_hwframe_transfer_data() calls). They do NOT protect + * access to hwcontext or decoder state in general. + * + * If unset on init, the hwcontext implementation will set them to use an + * internal mutex. + * + * The underlying lock must be recursive. lock_ctx is for free use by the + * locking implementation. + */ + void (*lock)(void *lock_ctx); + void (*unlock)(void *lock_ctx); + void *lock_ctx; +} AVD3D11VADeviceContext; + +/** + * D3D11 frame descriptor for pool allocation. + * + * In user-allocated pools, AVHWFramesContext.pool must return AVBufferRefs + * with the data pointer pointing at an object of this type describing the + * planes of the frame. + * + * This has no use outside of custom allocation, and AVFrame AVBufferRef do not + * necessarily point to an instance of this struct. + */ +typedef struct AVD3D11FrameDescriptor { + /** + * The texture in which the frame is located. The reference count is + * managed by the AVBufferRef, and destroying the reference will release + * the interface. + * + * Normally stored in AVFrame.data[0]. + */ + ID3D11Texture2D *texture; + + /** + * The index into the array texture element representing the frame, or 0 + * if the texture is not an array texture. + * + * Normally stored in AVFrame.data[1] (cast from intptr_t). + */ + intptr_t index; +} AVD3D11FrameDescriptor; + +/** + * This struct is allocated as AVHWFramesContext.hwctx + */ +typedef struct AVD3D11VAFramesContext { + /** + * The canonical texture used for pool allocation. If this is set to NULL + * on init, the hwframes implementation will allocate and set an array + * texture if initial_pool_size > 0. + * + * The only situation when the API user should set this is: + * - the user wants to do manual pool allocation (setting + * AVHWFramesContext.pool), instead of letting AVHWFramesContext + * allocate the pool + * - of an array texture + * - and wants it to use it for decoding + * - this has to be done before calling av_hwframe_ctx_init() + * + * Deallocating the AVHWFramesContext will always release this interface, + * and it does not matter whether it was user-allocated. + * + * This is in particular used by the libavcodec D3D11VA hwaccel, which + * requires a single array texture. It will create ID3D11VideoDecoderOutputView + * objects for each array texture element on decoder initialization. + */ + ID3D11Texture2D *texture; + + /** + * D3D11_TEXTURE2D_DESC.BindFlags used for texture creation. The user must + * at least set D3D11_BIND_DECODER if the frames context is to be used for + * video decoding. + * This field is ignored/invalid if a user-allocated texture is provided. + */ + UINT BindFlags; + + /** + * D3D11_TEXTURE2D_DESC.MiscFlags used for texture creation. + * This field is ignored/invalid if a user-allocated texture is provided. + */ + UINT MiscFlags; +} AVD3D11VAFramesContext; + +#endif /* AVUTIL_HWCONTEXT_D3D11VA_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_drm.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_drm.h new file mode 100644 index 0000000..42709f2 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_drm.h @@ -0,0 +1,169 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_HWCONTEXT_DRM_H +#define AVUTIL_HWCONTEXT_DRM_H + +#include +#include + +/** + * @file + * API-specific header for AV_HWDEVICE_TYPE_DRM. + * + * Internal frame allocation is not currently supported - all frames + * must be allocated by the user. Thus AVHWFramesContext is always + * NULL, though this may change if support for frame allocation is + * added in future. + */ + +enum { + /** + * The maximum number of layers/planes in a DRM frame. + */ + AV_DRM_MAX_PLANES = 4 +}; + +/** + * DRM object descriptor. + * + * Describes a single DRM object, addressing it as a PRIME file + * descriptor. + */ +typedef struct AVDRMObjectDescriptor { + /** + * DRM PRIME fd for the object. + */ + int fd; + /** + * Total size of the object. + * + * (This includes any parts not which do not contain image data.) + */ + size_t size; + /** + * Format modifier applied to the object (DRM_FORMAT_MOD_*). + * + * If the format modifier is unknown then this should be set to + * DRM_FORMAT_MOD_INVALID. + */ + uint64_t format_modifier; +} AVDRMObjectDescriptor; + +/** + * DRM plane descriptor. + * + * Describes a single plane of a layer, which is contained within + * a single object. + */ +typedef struct AVDRMPlaneDescriptor { + /** + * Index of the object containing this plane in the objects + * array of the enclosing frame descriptor. + */ + int object_index; + /** + * Offset within that object of this plane. + */ + ptrdiff_t offset; + /** + * Pitch (linesize) of this plane. + */ + ptrdiff_t pitch; +} AVDRMPlaneDescriptor; + +/** + * DRM layer descriptor. + * + * Describes a single layer within a frame. This has the structure + * defined by its format, and will contain one or more planes. + */ +typedef struct AVDRMLayerDescriptor { + /** + * Format of the layer (DRM_FORMAT_*). + */ + uint32_t format; + /** + * Number of planes in the layer. + * + * This must match the number of planes required by format. + */ + int nb_planes; + /** + * Array of planes in this layer. + */ + AVDRMPlaneDescriptor planes[AV_DRM_MAX_PLANES]; +} AVDRMLayerDescriptor; + +/** + * DRM frame descriptor. + * + * This is used as the data pointer for AV_PIX_FMT_DRM_PRIME frames. + * It is also used by user-allocated frame pools - allocating in + * AVHWFramesContext.pool must return AVBufferRefs which contain + * an object of this type. + * + * The fields of this structure should be set such it can be + * imported directly by EGL using the EGL_EXT_image_dma_buf_import + * and EGL_EXT_image_dma_buf_import_modifiers extensions. + * (Note that the exact layout of a particular format may vary between + * platforms - we only specify that the same platform should be able + * to import it.) + * + * The total number of planes must not exceed AV_DRM_MAX_PLANES, and + * the order of the planes by increasing layer index followed by + * increasing plane index must be the same as the order which would + * be used for the data pointers in the equivalent software format. + */ +typedef struct AVDRMFrameDescriptor { + /** + * Number of DRM objects making up this frame. + */ + int nb_objects; + /** + * Array of objects making up the frame. + */ + AVDRMObjectDescriptor objects[AV_DRM_MAX_PLANES]; + /** + * Number of layers in the frame. + */ + int nb_layers; + /** + * Array of layers in the frame. + */ + AVDRMLayerDescriptor layers[AV_DRM_MAX_PLANES]; +} AVDRMFrameDescriptor; + +/** + * DRM device. + * + * Allocated as AVHWDeviceContext.hwctx. + */ +typedef struct AVDRMDeviceContext { + /** + * File descriptor of DRM device. + * + * This is used as the device to create frames on, and may also be + * used in some derivation and mapping operations. + * + * If no device is required, set to -1. + */ + int fd; +} AVDRMDeviceContext; + +#endif /* AVUTIL_HWCONTEXT_DRM_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_dxva2.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_dxva2.h new file mode 100644 index 0000000..e1b79bc --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_dxva2.h @@ -0,0 +1,75 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + + +#ifndef AVUTIL_HWCONTEXT_DXVA2_H +#define AVUTIL_HWCONTEXT_DXVA2_H + +/** + * @file + * An API-specific header for AV_HWDEVICE_TYPE_DXVA2. + * + * Only fixed-size pools are supported. + * + * For user-allocated pools, AVHWFramesContext.pool must return AVBufferRefs + * with the data pointer set to a pointer to IDirect3DSurface9. + */ + +#include +#include + +/** + * This struct is allocated as AVHWDeviceContext.hwctx + */ +typedef struct AVDXVA2DeviceContext { + IDirect3DDeviceManager9 *devmgr; +} AVDXVA2DeviceContext; + +/** + * This struct is allocated as AVHWFramesContext.hwctx + */ +typedef struct AVDXVA2FramesContext { + /** + * The surface type (e.g. DXVA2_VideoProcessorRenderTarget or + * DXVA2_VideoDecoderRenderTarget). Must be set by the caller. + */ + DWORD surface_type; + + /** + * The surface pool. When an external pool is not provided by the caller, + * this will be managed (allocated and filled on init, freed on uninit) by + * libavutil. + */ + IDirect3DSurface9 **surfaces; + int nb_surfaces; + + /** + * Certain drivers require the decoder to be destroyed before the surfaces. + * To allow internally managed pools to work properly in such cases, this + * field is provided. + * + * If it is non-NULL, libavutil will call IDirectXVideoDecoder_Release() on + * it just before the internal surface pool is freed. + * + * This is for convenience only. Some code uses other methods to manage the + * decoder reference. + */ + IDirectXVideoDecoder *decoder_to_release; +} AVDXVA2FramesContext; + +#endif /* AVUTIL_HWCONTEXT_DXVA2_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_mediacodec.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_mediacodec.h new file mode 100644 index 0000000..101a980 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_mediacodec.h @@ -0,0 +1,36 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_HWCONTEXT_MEDIACODEC_H +#define AVUTIL_HWCONTEXT_MEDIACODEC_H + +/** + * MediaCodec details. + * + * Allocated as AVHWDeviceContext.hwctx + */ +typedef struct AVMediaCodecDeviceContext { + /** + * android/view/Surface handle, to be filled by the user. + * + * This is the default surface used by decoders on this device. + */ + void *surface; +} AVMediaCodecDeviceContext; + +#endif /* AVUTIL_HWCONTEXT_MEDIACODEC_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_opencl.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_opencl.h new file mode 100644 index 0000000..ef54486 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_opencl.h @@ -0,0 +1,100 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_HWCONTEXT_OPENCL_H +#define AVUTIL_HWCONTEXT_OPENCL_H + +#ifdef __APPLE__ +#include +#else +#include +#endif + +#include "frame.h" + +/** + * @file + * API-specific header for AV_HWDEVICE_TYPE_OPENCL. + * + * Pools allocated internally are always dynamic, and are primarily intended + * to be used in OpenCL-only cases. If interoperation is required, it is + * typically required to allocate frames in the other API and then map the + * frames context to OpenCL with av_hwframe_ctx_create_derived(). + */ + +/** + * OpenCL frame descriptor for pool allocation. + * + * In user-allocated pools, AVHWFramesContext.pool must return AVBufferRefs + * with the data pointer pointing at an object of this type describing the + * planes of the frame. + */ +typedef struct AVOpenCLFrameDescriptor { + /** + * Number of planes in the frame. + */ + int nb_planes; + /** + * OpenCL image2d objects for each plane of the frame. + */ + cl_mem planes[AV_NUM_DATA_POINTERS]; +} AVOpenCLFrameDescriptor; + +/** + * OpenCL device details. + * + * Allocated as AVHWDeviceContext.hwctx + */ +typedef struct AVOpenCLDeviceContext { + /** + * The primary device ID of the device. If multiple OpenCL devices + * are associated with the context then this is the one which will + * be used for all operations internal to FFmpeg. + */ + cl_device_id device_id; + /** + * The OpenCL context which will contain all operations and frames on + * this device. + */ + cl_context context; + /** + * The default command queue for this device, which will be used by all + * frames contexts which do not have their own command queue. If not + * intialised by the user, a default queue will be created on the + * primary device. + */ + cl_command_queue command_queue; +} AVOpenCLDeviceContext; + +/** + * OpenCL-specific data associated with a frame pool. + * + * Allocated as AVHWFramesContext.hwctx. + */ +typedef struct AVOpenCLFramesContext { + /** + * The command queue used for internal asynchronous operations on this + * device (av_hwframe_transfer_data(), av_hwframe_map()). + * + * If this is not set, the command queue from the associated device is + * used instead. + */ + cl_command_queue command_queue; +} AVOpenCLFramesContext; + +#endif /* AVUTIL_HWCONTEXT_OPENCL_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_qsv.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_qsv.h new file mode 100644 index 0000000..b98d611 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_qsv.h @@ -0,0 +1,53 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_HWCONTEXT_QSV_H +#define AVUTIL_HWCONTEXT_QSV_H + +#include + +/** + * @file + * An API-specific header for AV_HWDEVICE_TYPE_QSV. + * + * This API does not support dynamic frame pools. AVHWFramesContext.pool must + * contain AVBufferRefs whose data pointer points to an mfxFrameSurface1 struct. + */ + +/** + * This struct is allocated as AVHWDeviceContext.hwctx + */ +typedef struct AVQSVDeviceContext { + mfxSession session; +} AVQSVDeviceContext; + +/** + * This struct is allocated as AVHWFramesContext.hwctx + */ +typedef struct AVQSVFramesContext { + mfxFrameSurface1 *surfaces; + int nb_surfaces; + + /** + * A combination of MFX_MEMTYPE_* describing the frame pool. + */ + int frame_type; +} AVQSVFramesContext; + +#endif /* AVUTIL_HWCONTEXT_QSV_H */ + diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_vaapi.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_vaapi.h new file mode 100644 index 0000000..0b2e071 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_vaapi.h @@ -0,0 +1,117 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_HWCONTEXT_VAAPI_H +#define AVUTIL_HWCONTEXT_VAAPI_H + +#include + +/** + * @file + * API-specific header for AV_HWDEVICE_TYPE_VAAPI. + * + * Dynamic frame pools are supported, but note that any pool used as a render + * target is required to be of fixed size in order to be be usable as an + * argument to vaCreateContext(). + * + * For user-allocated pools, AVHWFramesContext.pool must return AVBufferRefs + * with the data pointer set to a VASurfaceID. + */ + +enum { + /** + * The quirks field has been set by the user and should not be detected + * automatically by av_hwdevice_ctx_init(). + */ + AV_VAAPI_DRIVER_QUIRK_USER_SET = (1 << 0), + /** + * The driver does not destroy parameter buffers when they are used by + * vaRenderPicture(). Additional code will be required to destroy them + * separately afterwards. + */ + AV_VAAPI_DRIVER_QUIRK_RENDER_PARAM_BUFFERS = (1 << 1), + + /** + * The driver does not support the VASurfaceAttribMemoryType attribute, + * so the surface allocation code will not try to use it. + */ + AV_VAAPI_DRIVER_QUIRK_ATTRIB_MEMTYPE = (1 << 2), + + /** + * The driver does not support surface attributes at all. + * The surface allocation code will never pass them to surface allocation, + * and the results of the vaQuerySurfaceAttributes() call will be faked. + */ + AV_VAAPI_DRIVER_QUIRK_SURFACE_ATTRIBUTES = (1 << 3), +}; + +/** + * VAAPI connection details. + * + * Allocated as AVHWDeviceContext.hwctx + */ +typedef struct AVVAAPIDeviceContext { + /** + * The VADisplay handle, to be filled by the user. + */ + VADisplay display; + /** + * Driver quirks to apply - this is filled by av_hwdevice_ctx_init(), + * with reference to a table of known drivers, unless the + * AV_VAAPI_DRIVER_QUIRK_USER_SET bit is already present. The user + * may need to refer to this field when performing any later + * operations using VAAPI with the same VADisplay. + */ + unsigned int driver_quirks; +} AVVAAPIDeviceContext; + +/** + * VAAPI-specific data associated with a frame pool. + * + * Allocated as AVHWFramesContext.hwctx. + */ +typedef struct AVVAAPIFramesContext { + /** + * Set by the user to apply surface attributes to all surfaces in + * the frame pool. If null, default settings are used. + */ + VASurfaceAttrib *attributes; + int nb_attributes; + /** + * The surfaces IDs of all surfaces in the pool after creation. + * Only valid if AVHWFramesContext.initial_pool_size was positive. + * These are intended to be used as the render_targets arguments to + * vaCreateContext(). + */ + VASurfaceID *surface_ids; + int nb_surfaces; +} AVVAAPIFramesContext; + +/** + * VAAPI hardware pipeline configuration details. + * + * Allocated with av_hwdevice_hwconfig_alloc(). + */ +typedef struct AVVAAPIHWConfig { + /** + * ID of a VAAPI pipeline configuration. + */ + VAConfigID config_id; +} AVVAAPIHWConfig; + +#endif /* AVUTIL_HWCONTEXT_VAAPI_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_vdpau.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_vdpau.h new file mode 100644 index 0000000..1b7ea1e --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_vdpau.h @@ -0,0 +1,44 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_HWCONTEXT_VDPAU_H +#define AVUTIL_HWCONTEXT_VDPAU_H + +#include + +/** + * @file + * An API-specific header for AV_HWDEVICE_TYPE_VDPAU. + * + * This API supports dynamic frame pools. AVHWFramesContext.pool must return + * AVBufferRefs whose data pointer is a VdpVideoSurface. + */ + +/** + * This struct is allocated as AVHWDeviceContext.hwctx + */ +typedef struct AVVDPAUDeviceContext { + VdpDevice device; + VdpGetProcAddress *get_proc_address; +} AVVDPAUDeviceContext; + +/** + * AVHWFramesContext.hwctx is currently not used + */ + +#endif /* AVUTIL_HWCONTEXT_VDPAU_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_videotoolbox.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_videotoolbox.h new file mode 100644 index 0000000..5074d79 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_videotoolbox.h @@ -0,0 +1,60 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_HWCONTEXT_VIDEOTOOLBOX_H +#define AVUTIL_HWCONTEXT_VIDEOTOOLBOX_H + +#include + +#include + +#include "pixfmt.h" + +/** + * @file + * An API-specific header for AV_HWDEVICE_TYPE_VIDEOTOOLBOX. + * + * This API currently does not support frame allocation, as the raw VideoToolbox + * API does allocation, and FFmpeg itself never has the need to allocate frames. + * + * If the API user sets a custom pool, AVHWFramesContext.pool must return + * AVBufferRefs whose data pointer is a CVImageBufferRef or CVPixelBufferRef. + * + * Currently AVHWDeviceContext.hwctx and AVHWFramesContext.hwctx are always + * NULL. + */ + +/** + * Convert a VideoToolbox (actually CoreVideo) format to AVPixelFormat. + * Returns AV_PIX_FMT_NONE if no known equivalent was found. + */ +enum AVPixelFormat av_map_videotoolbox_format_to_pixfmt(uint32_t cv_fmt); + +/** + * Convert an AVPixelFormat to a VideoToolbox (actually CoreVideo) format. + * Returns 0 if no known equivalent was found. + */ +uint32_t av_map_videotoolbox_format_from_pixfmt(enum AVPixelFormat pix_fmt); + +/** + * Same as av_map_videotoolbox_format_from_pixfmt function, but can map and + * return full range pixel formats via a flag. + */ +uint32_t av_map_videotoolbox_format_from_pixfmt2(enum AVPixelFormat pix_fmt, bool full_range); + +#endif /* AVUTIL_HWCONTEXT_VIDEOTOOLBOX_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_vulkan.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_vulkan.h new file mode 100644 index 0000000..5cbeb8e --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/hwcontext_vulkan.h @@ -0,0 +1,204 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_HWCONTEXT_VULKAN_H +#define AVUTIL_HWCONTEXT_VULKAN_H + +#include + +#include "pixfmt.h" +#include "frame.h" + +/** + * @file + * API-specific header for AV_HWDEVICE_TYPE_VULKAN. + * + * For user-allocated pools, AVHWFramesContext.pool must return AVBufferRefs + * with the data pointer set to an AVVkFrame. + */ + +/** + * Main Vulkan context, allocated as AVHWDeviceContext.hwctx. + * All of these can be set before init to change what the context uses + */ +typedef struct AVVulkanDeviceContext { + /** + * Custom memory allocator, else NULL + */ + const VkAllocationCallbacks *alloc; + /** + * Vulkan instance. Must be at least version 1.1. + */ + VkInstance inst; + /** + * Physical device + */ + VkPhysicalDevice phys_dev; + /** + * Active device + */ + VkDevice act_dev; + /** + * Queue family index for graphics + * @note av_hwdevice_create() will set all 3 queue indices if unset + * If there is no dedicated queue for compute or transfer operations, + * they will be set to the graphics queue index which can handle both. + * nb_graphics_queues indicates how many queues were enabled for the + * graphics queue (must be at least 1) + */ + int queue_family_index; + int nb_graphics_queues; + /** + * Queue family index to use for transfer operations, and the amount of queues + * enabled. In case there is no dedicated transfer queue, nb_tx_queues + * must be 0 and queue_family_tx_index must be the same as either the graphics + * queue or the compute queue, if available. + */ + int queue_family_tx_index; + int nb_tx_queues; + /** + * Queue family index for compute ops, and the amount of queues enabled. + * In case there are no dedicated compute queues, nb_comp_queues must be + * 0 and its queue family index must be set to the graphics queue. + */ + int queue_family_comp_index; + int nb_comp_queues; + /** + * Enabled instance extensions. + * If supplying your own device context, set this to an array of strings, with + * each entry containing the specified Vulkan extension string to enable. + * Duplicates are possible and accepted. + * If no extensions are enabled, set these fields to NULL, and 0 respectively. + */ + const char * const *enabled_inst_extensions; + int nb_enabled_inst_extensions; + /** + * Enabled device extensions. By default, VK_KHR_external_memory_fd, + * VK_EXT_external_memory_dma_buf, VK_EXT_image_drm_format_modifier, + * VK_KHR_external_semaphore_fd and VK_EXT_external_memory_host are enabled if found. + * If supplying your own device context, these fields takes the same format as + * the above fields, with the same conditions that duplicates are possible + * and accepted, and that NULL and 0 respectively means no extensions are enabled. + */ + const char * const *enabled_dev_extensions; + int nb_enabled_dev_extensions; + /** + * This structure should be set to the set of features that present and enabled + * during device creation. When a device is created by FFmpeg, it will default to + * enabling all that are present of the shaderImageGatherExtended, + * fragmentStoresAndAtomics, shaderInt64 and vertexPipelineStoresAndAtomics features. + */ + VkPhysicalDeviceFeatures2 device_features; +} AVVulkanDeviceContext; + +/** + * Allocated as AVHWFramesContext.hwctx, used to set pool-specific options + */ +typedef struct AVVulkanFramesContext { + /** + * Controls the tiling of allocated frames. + */ + VkImageTiling tiling; + /** + * Defines extra usage of output frames. If left as 0, the following bits + * are set: TRANSFER_SRC, TRANSFER_DST. SAMPLED and STORAGE. + */ + VkImageUsageFlagBits usage; + /** + * Extension data for image creation. + */ + void *create_pnext; + /** + * Extension data for memory allocation. Must have as many entries as + * the number of planes of the sw_format. + * This will be chained to VkExportMemoryAllocateInfo, which is used + * to make all pool images exportable to other APIs if the necessary + * extensions are present in enabled_dev_extensions. + */ + void *alloc_pnext[AV_NUM_DATA_POINTERS]; +} AVVulkanFramesContext; + +/* + * Frame structure, the VkFormat of the image will always match + * the pool's sw_format. + * All frames, imported or allocated, will be created with the + * VK_IMAGE_CREATE_ALIAS_BIT flag set, so the memory may be aliased if needed. + * + * If all three queue family indices in the device context are the same, + * images will be created with the EXCLUSIVE sharing mode. Otherwise, all images + * will be created using the CONCURRENT sharing mode. + * + * @note the size of this structure is not part of the ABI, to allocate + * you must use @av_vk_frame_alloc(). + */ +typedef struct AVVkFrame { + /** + * Vulkan images to which the memory is bound to. + */ + VkImage img[AV_NUM_DATA_POINTERS]; + + /** + * The same tiling must be used for all images in the frame. + */ + VkImageTiling tiling; + + /** + * Memory backing the images. Could be less than the amount of images + * if importing from a DRM or VAAPI frame. + */ + VkDeviceMemory mem[AV_NUM_DATA_POINTERS]; + size_t size[AV_NUM_DATA_POINTERS]; + + /** + * OR'd flags for all memory allocated + */ + VkMemoryPropertyFlagBits flags; + + /** + * Updated after every barrier + */ + VkAccessFlagBits access[AV_NUM_DATA_POINTERS]; + VkImageLayout layout[AV_NUM_DATA_POINTERS]; + + /** + * Synchronization semaphores. Must not be freed manually. Must be waited on + * and signalled at every queue submission. + * Could be less than the amount of images: either one per VkDeviceMemory + * or one for the entire frame. All others will be set to VK_NULL_HANDLE. + */ + VkSemaphore sem[AV_NUM_DATA_POINTERS]; + + /** + * Internal data. + */ + struct AVVkFrameInternal *internal; +} AVVkFrame; + +/** + * Allocates a single AVVkFrame and initializes everything as 0. + * @note Must be freed via av_free() + */ +AVVkFrame *av_vk_frame_alloc(void); + +/** + * Returns the format of each image up to the number of planes for a given sw_format. + * Returns NULL on unsupported formats. + */ +const VkFormat *av_vkfmt_from_pixfmt(enum AVPixelFormat p); + +#endif /* AVUTIL_HWCONTEXT_VULKAN_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/imgutils.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/imgutils.h new file mode 100644 index 0000000..5b790ec --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/imgutils.h @@ -0,0 +1,277 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_IMGUTILS_H +#define AVUTIL_IMGUTILS_H + +/** + * @file + * misc image utilities + * + * @addtogroup lavu_picture + * @{ + */ + +#include "avutil.h" +#include "pixdesc.h" +#include "rational.h" + +/** + * Compute the max pixel step for each plane of an image with a + * format described by pixdesc. + * + * The pixel step is the distance in bytes between the first byte of + * the group of bytes which describe a pixel component and the first + * byte of the successive group in the same plane for the same + * component. + * + * @param max_pixsteps an array which is filled with the max pixel step + * for each plane. Since a plane may contain different pixel + * components, the computed max_pixsteps[plane] is relative to the + * component in the plane with the max pixel step. + * @param max_pixstep_comps an array which is filled with the component + * for each plane which has the max pixel step. May be NULL. + */ +void av_image_fill_max_pixsteps(int max_pixsteps[4], int max_pixstep_comps[4], + const AVPixFmtDescriptor *pixdesc); + +/** + * Compute the size of an image line with format pix_fmt and width + * width for the plane plane. + * + * @return the computed size in bytes + */ +int av_image_get_linesize(enum AVPixelFormat pix_fmt, int width, int plane); + +/** + * Fill plane linesizes for an image with pixel format pix_fmt and + * width width. + * + * @param linesizes array to be filled with the linesize for each plane + * @return >= 0 in case of success, a negative error code otherwise + */ +int av_image_fill_linesizes(int linesizes[4], enum AVPixelFormat pix_fmt, int width); + +/** + * Fill plane data pointers for an image with pixel format pix_fmt and + * height height. + * + * @param data pointers array to be filled with the pointer for each image plane + * @param ptr the pointer to a buffer which will contain the image + * @param linesizes the array containing the linesize for each + * plane, should be filled by av_image_fill_linesizes() + * @return the size in bytes required for the image buffer, a negative + * error code in case of failure + */ +int av_image_fill_pointers(uint8_t *data[4], enum AVPixelFormat pix_fmt, int height, + uint8_t *ptr, const int linesizes[4]); + +/** + * Allocate an image with size w and h and pixel format pix_fmt, and + * fill pointers and linesizes accordingly. + * The allocated image buffer has to be freed by using + * av_freep(&pointers[0]). + * + * @param align the value to use for buffer size alignment + * @return the size in bytes required for the image buffer, a negative + * error code in case of failure + */ +int av_image_alloc(uint8_t *pointers[4], int linesizes[4], + int w, int h, enum AVPixelFormat pix_fmt, int align); + +/** + * Copy image plane from src to dst. + * That is, copy "height" number of lines of "bytewidth" bytes each. + * The first byte of each successive line is separated by *_linesize + * bytes. + * + * bytewidth must be contained by both absolute values of dst_linesize + * and src_linesize, otherwise the function behavior is undefined. + * + * @param dst_linesize linesize for the image plane in dst + * @param src_linesize linesize for the image plane in src + */ +void av_image_copy_plane(uint8_t *dst, int dst_linesize, + const uint8_t *src, int src_linesize, + int bytewidth, int height); + +/** + * Copy image in src_data to dst_data. + * + * @param dst_linesizes linesizes for the image in dst_data + * @param src_linesizes linesizes for the image in src_data + */ +void av_image_copy(uint8_t *dst_data[4], int dst_linesizes[4], + const uint8_t *src_data[4], const int src_linesizes[4], + enum AVPixelFormat pix_fmt, int width, int height); + +/** + * Copy image data located in uncacheable (e.g. GPU mapped) memory. Where + * available, this function will use special functionality for reading from such + * memory, which may result in greatly improved performance compared to plain + * av_image_copy(). + * + * The data pointers and the linesizes must be aligned to the maximum required + * by the CPU architecture. + * + * @note The linesize parameters have the type ptrdiff_t here, while they are + * int for av_image_copy(). + * @note On x86, the linesizes currently need to be aligned to the cacheline + * size (i.e. 64) to get improved performance. + */ +void av_image_copy_uc_from(uint8_t *dst_data[4], const ptrdiff_t dst_linesizes[4], + const uint8_t *src_data[4], const ptrdiff_t src_linesizes[4], + enum AVPixelFormat pix_fmt, int width, int height); + +/** + * Setup the data pointers and linesizes based on the specified image + * parameters and the provided array. + * + * The fields of the given image are filled in by using the src + * address which points to the image data buffer. Depending on the + * specified pixel format, one or multiple image data pointers and + * line sizes will be set. If a planar format is specified, several + * pointers will be set pointing to the different picture planes and + * the line sizes of the different planes will be stored in the + * lines_sizes array. Call with src == NULL to get the required + * size for the src buffer. + * + * To allocate the buffer and fill in the dst_data and dst_linesize in + * one call, use av_image_alloc(). + * + * @param dst_data data pointers to be filled in + * @param dst_linesize linesizes for the image in dst_data to be filled in + * @param src buffer which will contain or contains the actual image data, can be NULL + * @param pix_fmt the pixel format of the image + * @param width the width of the image in pixels + * @param height the height of the image in pixels + * @param align the value used in src for linesize alignment + * @return the size in bytes required for src, a negative error code + * in case of failure + */ +int av_image_fill_arrays(uint8_t *dst_data[4], int dst_linesize[4], + const uint8_t *src, + enum AVPixelFormat pix_fmt, int width, int height, int align); + +/** + * Return the size in bytes of the amount of data required to store an + * image with the given parameters. + * + * @param pix_fmt the pixel format of the image + * @param width the width of the image in pixels + * @param height the height of the image in pixels + * @param align the assumed linesize alignment + * @return the buffer size in bytes, a negative error code in case of failure + */ +int av_image_get_buffer_size(enum AVPixelFormat pix_fmt, int width, int height, int align); + +/** + * Copy image data from an image into a buffer. + * + * av_image_get_buffer_size() can be used to compute the required size + * for the buffer to fill. + * + * @param dst a buffer into which picture data will be copied + * @param dst_size the size in bytes of dst + * @param src_data pointers containing the source image data + * @param src_linesize linesizes for the image in src_data + * @param pix_fmt the pixel format of the source image + * @param width the width of the source image in pixels + * @param height the height of the source image in pixels + * @param align the assumed linesize alignment for dst + * @return the number of bytes written to dst, or a negative value + * (error code) on error + */ +int av_image_copy_to_buffer(uint8_t *dst, int dst_size, + const uint8_t * const src_data[4], const int src_linesize[4], + enum AVPixelFormat pix_fmt, int width, int height, int align); + +/** + * Check if the given dimension of an image is valid, meaning that all + * bytes of the image can be addressed with a signed int. + * + * @param w the width of the picture + * @param h the height of the picture + * @param log_offset the offset to sum to the log level for logging with log_ctx + * @param log_ctx the parent logging context, it may be NULL + * @return >= 0 if valid, a negative error code otherwise + */ +int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx); + +/** + * Check if the given dimension of an image is valid, meaning that all + * bytes of a plane of an image with the specified pix_fmt can be addressed + * with a signed int. + * + * @param w the width of the picture + * @param h the height of the picture + * @param max_pixels the maximum number of pixels the user wants to accept + * @param pix_fmt the pixel format, can be AV_PIX_FMT_NONE if unknown. + * @param log_offset the offset to sum to the log level for logging with log_ctx + * @param log_ctx the parent logging context, it may be NULL + * @return >= 0 if valid, a negative error code otherwise + */ +int av_image_check_size2(unsigned int w, unsigned int h, int64_t max_pixels, enum AVPixelFormat pix_fmt, int log_offset, void *log_ctx); + +/** + * Check if the given sample aspect ratio of an image is valid. + * + * It is considered invalid if the denominator is 0 or if applying the ratio + * to the image size would make the smaller dimension less than 1. If the + * sar numerator is 0, it is considered unknown and will return as valid. + * + * @param w width of the image + * @param h height of the image + * @param sar sample aspect ratio of the image + * @return 0 if valid, a negative AVERROR code otherwise + */ +int av_image_check_sar(unsigned int w, unsigned int h, AVRational sar); + +/** + * Overwrite the image data with black. This is suitable for filling a + * sub-rectangle of an image, meaning the padding between the right most pixel + * and the left most pixel on the next line will not be overwritten. For some + * formats, the image size might be rounded up due to inherent alignment. + * + * If the pixel format has alpha, the alpha is cleared to opaque. + * + * This can return an error if the pixel format is not supported. Normally, all + * non-hwaccel pixel formats should be supported. + * + * Passing NULL for dst_data is allowed. Then the function returns whether the + * operation would have succeeded. (It can return an error if the pix_fmt is + * not supported.) + * + * @param dst_data data pointers to destination image + * @param dst_linesize linesizes for the destination image + * @param pix_fmt the pixel format of the image + * @param range the color range of the image (important for colorspaces such as YUV) + * @param width the width of the image in pixels + * @param height the height of the image in pixels + * @return 0 if the image data was cleared, a negative AVERROR code otherwise + */ +int av_image_fill_black(uint8_t *dst_data[4], const ptrdiff_t dst_linesize[4], + enum AVPixelFormat pix_fmt, enum AVColorRange range, + int width, int height); + +/** + * @} + */ + + +#endif /* AVUTIL_IMGUTILS_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/intfloat.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/intfloat.h new file mode 100644 index 0000000..fe3d7ec --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/intfloat.h @@ -0,0 +1,77 @@ +/* + * Copyright (c) 2011 Mans Rullgard + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_INTFLOAT_H +#define AVUTIL_INTFLOAT_H + +#include +#include "attributes.h" + +union av_intfloat32 { + uint32_t i; + float f; +}; + +union av_intfloat64 { + uint64_t i; + double f; +}; + +/** + * Reinterpret a 32-bit integer as a float. + */ +static av_always_inline float av_int2float(uint32_t i) +{ + union av_intfloat32 v; + v.i = i; + return v.f; +} + +/** + * Reinterpret a float as a 32-bit integer. + */ +static av_always_inline uint32_t av_float2int(float f) +{ + union av_intfloat32 v; + v.f = f; + return v.i; +} + +/** + * Reinterpret a 64-bit integer as a double. + */ +static av_always_inline double av_int2double(uint64_t i) +{ + union av_intfloat64 v; + v.i = i; + return v.f; +} + +/** + * Reinterpret a double as a 64-bit integer. + */ +static av_always_inline uint64_t av_double2int(double f) +{ + union av_intfloat64 v; + v.f = f; + return v.i; +} + +#endif /* AVUTIL_INTFLOAT_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/intreadwrite.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/intreadwrite.h new file mode 100644 index 0000000..4c8413a --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/intreadwrite.h @@ -0,0 +1,644 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_INTREADWRITE_H +#define AVUTIL_INTREADWRITE_H + +#include +#include "libavutil/avconfig.h" +#include "attributes.h" +#include "bswap.h" + +typedef union { + uint64_t u64; + uint32_t u32[2]; + uint16_t u16[4]; + uint8_t u8 [8]; + double f64; + float f32[2]; +} av_alias av_alias64; + +typedef union { + uint32_t u32; + uint16_t u16[2]; + uint8_t u8 [4]; + float f32; +} av_alias av_alias32; + +typedef union { + uint16_t u16; + uint8_t u8 [2]; +} av_alias av_alias16; + +/* + * Arch-specific headers can provide any combination of + * AV_[RW][BLN](16|24|32|48|64) and AV_(COPY|SWAP|ZERO)(64|128) macros. + * Preprocessor symbols must be defined, even if these are implemented + * as inline functions. + * + * R/W means read/write, B/L/N means big/little/native endianness. + * The following macros require aligned access, compared to their + * unaligned variants: AV_(COPY|SWAP|ZERO)(64|128), AV_[RW]N[8-64]A. + * Incorrect usage may range from abysmal performance to crash + * depending on the platform. + * + * The unaligned variants are AV_[RW][BLN][8-64] and AV_COPY*U. + */ + +#ifdef HAVE_AV_CONFIG_H + +#include "config.h" + +#if ARCH_ARM +# include "arm/intreadwrite.h" +#elif ARCH_AVR32 +# include "avr32/intreadwrite.h" +#elif ARCH_MIPS +# include "mips/intreadwrite.h" +#elif ARCH_PPC +# include "ppc/intreadwrite.h" +#elif ARCH_TOMI +# include "tomi/intreadwrite.h" +#elif ARCH_X86 +# include "x86/intreadwrite.h" +#endif + +#endif /* HAVE_AV_CONFIG_H */ + +/* + * Map AV_RNXX <-> AV_R[BL]XX for all variants provided by per-arch headers. + */ + +#if AV_HAVE_BIGENDIAN + +# if defined(AV_RN16) && !defined(AV_RB16) +# define AV_RB16(p) AV_RN16(p) +# elif !defined(AV_RN16) && defined(AV_RB16) +# define AV_RN16(p) AV_RB16(p) +# endif + +# if defined(AV_WN16) && !defined(AV_WB16) +# define AV_WB16(p, v) AV_WN16(p, v) +# elif !defined(AV_WN16) && defined(AV_WB16) +# define AV_WN16(p, v) AV_WB16(p, v) +# endif + +# if defined(AV_RN24) && !defined(AV_RB24) +# define AV_RB24(p) AV_RN24(p) +# elif !defined(AV_RN24) && defined(AV_RB24) +# define AV_RN24(p) AV_RB24(p) +# endif + +# if defined(AV_WN24) && !defined(AV_WB24) +# define AV_WB24(p, v) AV_WN24(p, v) +# elif !defined(AV_WN24) && defined(AV_WB24) +# define AV_WN24(p, v) AV_WB24(p, v) +# endif + +# if defined(AV_RN32) && !defined(AV_RB32) +# define AV_RB32(p) AV_RN32(p) +# elif !defined(AV_RN32) && defined(AV_RB32) +# define AV_RN32(p) AV_RB32(p) +# endif + +# if defined(AV_WN32) && !defined(AV_WB32) +# define AV_WB32(p, v) AV_WN32(p, v) +# elif !defined(AV_WN32) && defined(AV_WB32) +# define AV_WN32(p, v) AV_WB32(p, v) +# endif + +# if defined(AV_RN48) && !defined(AV_RB48) +# define AV_RB48(p) AV_RN48(p) +# elif !defined(AV_RN48) && defined(AV_RB48) +# define AV_RN48(p) AV_RB48(p) +# endif + +# if defined(AV_WN48) && !defined(AV_WB48) +# define AV_WB48(p, v) AV_WN48(p, v) +# elif !defined(AV_WN48) && defined(AV_WB48) +# define AV_WN48(p, v) AV_WB48(p, v) +# endif + +# if defined(AV_RN64) && !defined(AV_RB64) +# define AV_RB64(p) AV_RN64(p) +# elif !defined(AV_RN64) && defined(AV_RB64) +# define AV_RN64(p) AV_RB64(p) +# endif + +# if defined(AV_WN64) && !defined(AV_WB64) +# define AV_WB64(p, v) AV_WN64(p, v) +# elif !defined(AV_WN64) && defined(AV_WB64) +# define AV_WN64(p, v) AV_WB64(p, v) +# endif + +#else /* AV_HAVE_BIGENDIAN */ + +# if defined(AV_RN16) && !defined(AV_RL16) +# define AV_RL16(p) AV_RN16(p) +# elif !defined(AV_RN16) && defined(AV_RL16) +# define AV_RN16(p) AV_RL16(p) +# endif + +# if defined(AV_WN16) && !defined(AV_WL16) +# define AV_WL16(p, v) AV_WN16(p, v) +# elif !defined(AV_WN16) && defined(AV_WL16) +# define AV_WN16(p, v) AV_WL16(p, v) +# endif + +# if defined(AV_RN24) && !defined(AV_RL24) +# define AV_RL24(p) AV_RN24(p) +# elif !defined(AV_RN24) && defined(AV_RL24) +# define AV_RN24(p) AV_RL24(p) +# endif + +# if defined(AV_WN24) && !defined(AV_WL24) +# define AV_WL24(p, v) AV_WN24(p, v) +# elif !defined(AV_WN24) && defined(AV_WL24) +# define AV_WN24(p, v) AV_WL24(p, v) +# endif + +# if defined(AV_RN32) && !defined(AV_RL32) +# define AV_RL32(p) AV_RN32(p) +# elif !defined(AV_RN32) && defined(AV_RL32) +# define AV_RN32(p) AV_RL32(p) +# endif + +# if defined(AV_WN32) && !defined(AV_WL32) +# define AV_WL32(p, v) AV_WN32(p, v) +# elif !defined(AV_WN32) && defined(AV_WL32) +# define AV_WN32(p, v) AV_WL32(p, v) +# endif + +# if defined(AV_RN48) && !defined(AV_RL48) +# define AV_RL48(p) AV_RN48(p) +# elif !defined(AV_RN48) && defined(AV_RL48) +# define AV_RN48(p) AV_RL48(p) +# endif + +# if defined(AV_WN48) && !defined(AV_WL48) +# define AV_WL48(p, v) AV_WN48(p, v) +# elif !defined(AV_WN48) && defined(AV_WL48) +# define AV_WN48(p, v) AV_WL48(p, v) +# endif + +# if defined(AV_RN64) && !defined(AV_RL64) +# define AV_RL64(p) AV_RN64(p) +# elif !defined(AV_RN64) && defined(AV_RL64) +# define AV_RN64(p) AV_RL64(p) +# endif + +# if defined(AV_WN64) && !defined(AV_WL64) +# define AV_WL64(p, v) AV_WN64(p, v) +# elif !defined(AV_WN64) && defined(AV_WL64) +# define AV_WN64(p, v) AV_WL64(p, v) +# endif + +#endif /* !AV_HAVE_BIGENDIAN */ + +/* + * Define AV_[RW]N helper macros to simplify definitions not provided + * by per-arch headers. + */ + +#if defined(__GNUC__) + +union unaligned_64 { uint64_t l; } __attribute__((packed)) av_alias; +union unaligned_32 { uint32_t l; } __attribute__((packed)) av_alias; +union unaligned_16 { uint16_t l; } __attribute__((packed)) av_alias; + +# define AV_RN(s, p) (((const union unaligned_##s *) (p))->l) +# define AV_WN(s, p, v) ((((union unaligned_##s *) (p))->l) = (v)) + +#elif defined(_MSC_VER) && (defined(_M_ARM) || defined(_M_X64) || defined(_M_ARM64)) && AV_HAVE_FAST_UNALIGNED + +# define AV_RN(s, p) (*((const __unaligned uint##s##_t*)(p))) +# define AV_WN(s, p, v) (*((__unaligned uint##s##_t*)(p)) = (v)) + +#elif AV_HAVE_FAST_UNALIGNED + +# define AV_RN(s, p) (((const av_alias##s*)(p))->u##s) +# define AV_WN(s, p, v) (((av_alias##s*)(p))->u##s = (v)) + +#else + +#ifndef AV_RB16 +# define AV_RB16(x) \ + ((((const uint8_t*)(x))[0] << 8) | \ + ((const uint8_t*)(x))[1]) +#endif +#ifndef AV_WB16 +# define AV_WB16(p, val) do { \ + uint16_t d = (val); \ + ((uint8_t*)(p))[1] = (d); \ + ((uint8_t*)(p))[0] = (d)>>8; \ + } while(0) +#endif + +#ifndef AV_RL16 +# define AV_RL16(x) \ + ((((const uint8_t*)(x))[1] << 8) | \ + ((const uint8_t*)(x))[0]) +#endif +#ifndef AV_WL16 +# define AV_WL16(p, val) do { \ + uint16_t d = (val); \ + ((uint8_t*)(p))[0] = (d); \ + ((uint8_t*)(p))[1] = (d)>>8; \ + } while(0) +#endif + +#ifndef AV_RB32 +# define AV_RB32(x) \ + (((uint32_t)((const uint8_t*)(x))[0] << 24) | \ + (((const uint8_t*)(x))[1] << 16) | \ + (((const uint8_t*)(x))[2] << 8) | \ + ((const uint8_t*)(x))[3]) +#endif +#ifndef AV_WB32 +# define AV_WB32(p, val) do { \ + uint32_t d = (val); \ + ((uint8_t*)(p))[3] = (d); \ + ((uint8_t*)(p))[2] = (d)>>8; \ + ((uint8_t*)(p))[1] = (d)>>16; \ + ((uint8_t*)(p))[0] = (d)>>24; \ + } while(0) +#endif + +#ifndef AV_RL32 +# define AV_RL32(x) \ + (((uint32_t)((const uint8_t*)(x))[3] << 24) | \ + (((const uint8_t*)(x))[2] << 16) | \ + (((const uint8_t*)(x))[1] << 8) | \ + ((const uint8_t*)(x))[0]) +#endif +#ifndef AV_WL32 +# define AV_WL32(p, val) do { \ + uint32_t d = (val); \ + ((uint8_t*)(p))[0] = (d); \ + ((uint8_t*)(p))[1] = (d)>>8; \ + ((uint8_t*)(p))[2] = (d)>>16; \ + ((uint8_t*)(p))[3] = (d)>>24; \ + } while(0) +#endif + +#ifndef AV_RB64 +# define AV_RB64(x) \ + (((uint64_t)((const uint8_t*)(x))[0] << 56) | \ + ((uint64_t)((const uint8_t*)(x))[1] << 48) | \ + ((uint64_t)((const uint8_t*)(x))[2] << 40) | \ + ((uint64_t)((const uint8_t*)(x))[3] << 32) | \ + ((uint64_t)((const uint8_t*)(x))[4] << 24) | \ + ((uint64_t)((const uint8_t*)(x))[5] << 16) | \ + ((uint64_t)((const uint8_t*)(x))[6] << 8) | \ + (uint64_t)((const uint8_t*)(x))[7]) +#endif +#ifndef AV_WB64 +# define AV_WB64(p, val) do { \ + uint64_t d = (val); \ + ((uint8_t*)(p))[7] = (d); \ + ((uint8_t*)(p))[6] = (d)>>8; \ + ((uint8_t*)(p))[5] = (d)>>16; \ + ((uint8_t*)(p))[4] = (d)>>24; \ + ((uint8_t*)(p))[3] = (d)>>32; \ + ((uint8_t*)(p))[2] = (d)>>40; \ + ((uint8_t*)(p))[1] = (d)>>48; \ + ((uint8_t*)(p))[0] = (d)>>56; \ + } while(0) +#endif + +#ifndef AV_RL64 +# define AV_RL64(x) \ + (((uint64_t)((const uint8_t*)(x))[7] << 56) | \ + ((uint64_t)((const uint8_t*)(x))[6] << 48) | \ + ((uint64_t)((const uint8_t*)(x))[5] << 40) | \ + ((uint64_t)((const uint8_t*)(x))[4] << 32) | \ + ((uint64_t)((const uint8_t*)(x))[3] << 24) | \ + ((uint64_t)((const uint8_t*)(x))[2] << 16) | \ + ((uint64_t)((const uint8_t*)(x))[1] << 8) | \ + (uint64_t)((const uint8_t*)(x))[0]) +#endif +#ifndef AV_WL64 +# define AV_WL64(p, val) do { \ + uint64_t d = (val); \ + ((uint8_t*)(p))[0] = (d); \ + ((uint8_t*)(p))[1] = (d)>>8; \ + ((uint8_t*)(p))[2] = (d)>>16; \ + ((uint8_t*)(p))[3] = (d)>>24; \ + ((uint8_t*)(p))[4] = (d)>>32; \ + ((uint8_t*)(p))[5] = (d)>>40; \ + ((uint8_t*)(p))[6] = (d)>>48; \ + ((uint8_t*)(p))[7] = (d)>>56; \ + } while(0) +#endif + +#if AV_HAVE_BIGENDIAN +# define AV_RN(s, p) AV_RB##s(p) +# define AV_WN(s, p, v) AV_WB##s(p, v) +#else +# define AV_RN(s, p) AV_RL##s(p) +# define AV_WN(s, p, v) AV_WL##s(p, v) +#endif + +#endif /* HAVE_FAST_UNALIGNED */ + +#ifndef AV_RN16 +# define AV_RN16(p) AV_RN(16, p) +#endif + +#ifndef AV_RN32 +# define AV_RN32(p) AV_RN(32, p) +#endif + +#ifndef AV_RN64 +# define AV_RN64(p) AV_RN(64, p) +#endif + +#ifndef AV_WN16 +# define AV_WN16(p, v) AV_WN(16, p, v) +#endif + +#ifndef AV_WN32 +# define AV_WN32(p, v) AV_WN(32, p, v) +#endif + +#ifndef AV_WN64 +# define AV_WN64(p, v) AV_WN(64, p, v) +#endif + +#if AV_HAVE_BIGENDIAN +# define AV_RB(s, p) AV_RN##s(p) +# define AV_WB(s, p, v) AV_WN##s(p, v) +# define AV_RL(s, p) av_bswap##s(AV_RN##s(p)) +# define AV_WL(s, p, v) AV_WN##s(p, av_bswap##s(v)) +#else +# define AV_RB(s, p) av_bswap##s(AV_RN##s(p)) +# define AV_WB(s, p, v) AV_WN##s(p, av_bswap##s(v)) +# define AV_RL(s, p) AV_RN##s(p) +# define AV_WL(s, p, v) AV_WN##s(p, v) +#endif + +#define AV_RB8(x) (((const uint8_t*)(x))[0]) +#define AV_WB8(p, d) do { ((uint8_t*)(p))[0] = (d); } while(0) + +#define AV_RL8(x) AV_RB8(x) +#define AV_WL8(p, d) AV_WB8(p, d) + +#ifndef AV_RB16 +# define AV_RB16(p) AV_RB(16, p) +#endif +#ifndef AV_WB16 +# define AV_WB16(p, v) AV_WB(16, p, v) +#endif + +#ifndef AV_RL16 +# define AV_RL16(p) AV_RL(16, p) +#endif +#ifndef AV_WL16 +# define AV_WL16(p, v) AV_WL(16, p, v) +#endif + +#ifndef AV_RB32 +# define AV_RB32(p) AV_RB(32, p) +#endif +#ifndef AV_WB32 +# define AV_WB32(p, v) AV_WB(32, p, v) +#endif + +#ifndef AV_RL32 +# define AV_RL32(p) AV_RL(32, p) +#endif +#ifndef AV_WL32 +# define AV_WL32(p, v) AV_WL(32, p, v) +#endif + +#ifndef AV_RB64 +# define AV_RB64(p) AV_RB(64, p) +#endif +#ifndef AV_WB64 +# define AV_WB64(p, v) AV_WB(64, p, v) +#endif + +#ifndef AV_RL64 +# define AV_RL64(p) AV_RL(64, p) +#endif +#ifndef AV_WL64 +# define AV_WL64(p, v) AV_WL(64, p, v) +#endif + +#ifndef AV_RB24 +# define AV_RB24(x) \ + ((((const uint8_t*)(x))[0] << 16) | \ + (((const uint8_t*)(x))[1] << 8) | \ + ((const uint8_t*)(x))[2]) +#endif +#ifndef AV_WB24 +# define AV_WB24(p, d) do { \ + ((uint8_t*)(p))[2] = (d); \ + ((uint8_t*)(p))[1] = (d)>>8; \ + ((uint8_t*)(p))[0] = (d)>>16; \ + } while(0) +#endif + +#ifndef AV_RL24 +# define AV_RL24(x) \ + ((((const uint8_t*)(x))[2] << 16) | \ + (((const uint8_t*)(x))[1] << 8) | \ + ((const uint8_t*)(x))[0]) +#endif +#ifndef AV_WL24 +# define AV_WL24(p, d) do { \ + ((uint8_t*)(p))[0] = (d); \ + ((uint8_t*)(p))[1] = (d)>>8; \ + ((uint8_t*)(p))[2] = (d)>>16; \ + } while(0) +#endif + +#ifndef AV_RB48 +# define AV_RB48(x) \ + (((uint64_t)((const uint8_t*)(x))[0] << 40) | \ + ((uint64_t)((const uint8_t*)(x))[1] << 32) | \ + ((uint64_t)((const uint8_t*)(x))[2] << 24) | \ + ((uint64_t)((const uint8_t*)(x))[3] << 16) | \ + ((uint64_t)((const uint8_t*)(x))[4] << 8) | \ + (uint64_t)((const uint8_t*)(x))[5]) +#endif +#ifndef AV_WB48 +# define AV_WB48(p, darg) do { \ + uint64_t d = (darg); \ + ((uint8_t*)(p))[5] = (d); \ + ((uint8_t*)(p))[4] = (d)>>8; \ + ((uint8_t*)(p))[3] = (d)>>16; \ + ((uint8_t*)(p))[2] = (d)>>24; \ + ((uint8_t*)(p))[1] = (d)>>32; \ + ((uint8_t*)(p))[0] = (d)>>40; \ + } while(0) +#endif + +#ifndef AV_RL48 +# define AV_RL48(x) \ + (((uint64_t)((const uint8_t*)(x))[5] << 40) | \ + ((uint64_t)((const uint8_t*)(x))[4] << 32) | \ + ((uint64_t)((const uint8_t*)(x))[3] << 24) | \ + ((uint64_t)((const uint8_t*)(x))[2] << 16) | \ + ((uint64_t)((const uint8_t*)(x))[1] << 8) | \ + (uint64_t)((const uint8_t*)(x))[0]) +#endif +#ifndef AV_WL48 +# define AV_WL48(p, darg) do { \ + uint64_t d = (darg); \ + ((uint8_t*)(p))[0] = (d); \ + ((uint8_t*)(p))[1] = (d)>>8; \ + ((uint8_t*)(p))[2] = (d)>>16; \ + ((uint8_t*)(p))[3] = (d)>>24; \ + ((uint8_t*)(p))[4] = (d)>>32; \ + ((uint8_t*)(p))[5] = (d)>>40; \ + } while(0) +#endif + +/* + * The AV_[RW]NA macros access naturally aligned data + * in a type-safe way. + */ + +#define AV_RNA(s, p) (((const av_alias##s*)(p))->u##s) +#define AV_WNA(s, p, v) (((av_alias##s*)(p))->u##s = (v)) + +#ifndef AV_RN16A +# define AV_RN16A(p) AV_RNA(16, p) +#endif + +#ifndef AV_RN32A +# define AV_RN32A(p) AV_RNA(32, p) +#endif + +#ifndef AV_RN64A +# define AV_RN64A(p) AV_RNA(64, p) +#endif + +#ifndef AV_WN16A +# define AV_WN16A(p, v) AV_WNA(16, p, v) +#endif + +#ifndef AV_WN32A +# define AV_WN32A(p, v) AV_WNA(32, p, v) +#endif + +#ifndef AV_WN64A +# define AV_WN64A(p, v) AV_WNA(64, p, v) +#endif + +#if AV_HAVE_BIGENDIAN +# define AV_RLA(s, p) av_bswap##s(AV_RN##s##A(p)) +# define AV_WLA(s, p, v) AV_WN##s##A(p, av_bswap##s(v)) +#else +# define AV_RLA(s, p) AV_RN##s##A(p) +# define AV_WLA(s, p, v) AV_WN##s##A(p, v) +#endif + +#ifndef AV_RL64A +# define AV_RL64A(p) AV_RLA(64, p) +#endif +#ifndef AV_WL64A +# define AV_WL64A(p, v) AV_WLA(64, p, v) +#endif + +/* + * The AV_COPYxxU macros are suitable for copying data to/from unaligned + * memory locations. + */ + +#define AV_COPYU(n, d, s) AV_WN##n(d, AV_RN##n(s)); + +#ifndef AV_COPY16U +# define AV_COPY16U(d, s) AV_COPYU(16, d, s) +#endif + +#ifndef AV_COPY32U +# define AV_COPY32U(d, s) AV_COPYU(32, d, s) +#endif + +#ifndef AV_COPY64U +# define AV_COPY64U(d, s) AV_COPYU(64, d, s) +#endif + +#ifndef AV_COPY128U +# define AV_COPY128U(d, s) \ + do { \ + AV_COPY64U(d, s); \ + AV_COPY64U((char *)(d) + 8, (const char *)(s) + 8); \ + } while(0) +#endif + +/* Parameters for AV_COPY*, AV_SWAP*, AV_ZERO* must be + * naturally aligned. They may be implemented using MMX, + * so emms_c() must be called before using any float code + * afterwards. + */ + +#define AV_COPY(n, d, s) \ + (((av_alias##n*)(d))->u##n = ((const av_alias##n*)(s))->u##n) + +#ifndef AV_COPY16 +# define AV_COPY16(d, s) AV_COPY(16, d, s) +#endif + +#ifndef AV_COPY32 +# define AV_COPY32(d, s) AV_COPY(32, d, s) +#endif + +#ifndef AV_COPY64 +# define AV_COPY64(d, s) AV_COPY(64, d, s) +#endif + +#ifndef AV_COPY128 +# define AV_COPY128(d, s) \ + do { \ + AV_COPY64(d, s); \ + AV_COPY64((char*)(d)+8, (char*)(s)+8); \ + } while(0) +#endif + +#define AV_SWAP(n, a, b) FFSWAP(av_alias##n, *(av_alias##n*)(a), *(av_alias##n*)(b)) + +#ifndef AV_SWAP64 +# define AV_SWAP64(a, b) AV_SWAP(64, a, b) +#endif + +#define AV_ZERO(n, d) (((av_alias##n*)(d))->u##n = 0) + +#ifndef AV_ZERO16 +# define AV_ZERO16(d) AV_ZERO(16, d) +#endif + +#ifndef AV_ZERO32 +# define AV_ZERO32(d) AV_ZERO(32, d) +#endif + +#ifndef AV_ZERO64 +# define AV_ZERO64(d) AV_ZERO(64, d) +#endif + +#ifndef AV_ZERO128 +# define AV_ZERO128(d) \ + do { \ + AV_ZERO64(d); \ + AV_ZERO64((char*)(d)+8); \ + } while(0) +#endif + +#endif /* AVUTIL_INTREADWRITE_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/lfg.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/lfg.h new file mode 100644 index 0000000..2b66920 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/lfg.h @@ -0,0 +1,80 @@ +/* + * Lagged Fibonacci PRNG + * Copyright (c) 2008 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_LFG_H +#define AVUTIL_LFG_H + +#include + +/** + * Context structure for the Lagged Fibonacci PRNG. + * The exact layout, types and content of this struct may change and should + * not be accessed directly. Only its sizeof() is guranteed to stay the same + * to allow easy instanciation. + */ +typedef struct AVLFG { + unsigned int state[64]; + int index; +} AVLFG; + +void av_lfg_init(AVLFG *c, unsigned int seed); + +/** + * Seed the state of the ALFG using binary data. + * + * Return value: 0 on success, negative value (AVERROR) on failure. + */ +int av_lfg_init_from_data(AVLFG *c, const uint8_t *data, unsigned int length); + +/** + * Get the next random unsigned 32-bit number using an ALFG. + * + * Please also consider a simple LCG like state= state*1664525+1013904223, + * it may be good enough and faster for your specific use case. + */ +static inline unsigned int av_lfg_get(AVLFG *c){ + unsigned a = c->state[c->index & 63] = c->state[(c->index-24) & 63] + c->state[(c->index-55) & 63]; + c->index += 1U; + return a; +} + +/** + * Get the next random unsigned 32-bit number using a MLFG. + * + * Please also consider av_lfg_get() above, it is faster. + */ +static inline unsigned int av_mlfg_get(AVLFG *c){ + unsigned int a= c->state[(c->index-55) & 63]; + unsigned int b= c->state[(c->index-24) & 63]; + a = c->state[c->index & 63] = 2*a*b+a+b; + c->index += 1U; + return a; +} + +/** + * Get the next two numbers generated by a Box-Muller Gaussian + * generator using the random numbers issued by lfg. + * + * @param out array where the two generated numbers are placed + */ +void av_bmg_get(AVLFG *lfg, double out[2]); + +#endif /* AVUTIL_LFG_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/log.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/log.h new file mode 100644 index 0000000..9c14188 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/log.h @@ -0,0 +1,383 @@ +/* + * copyright (c) 2006 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_LOG_H +#define AVUTIL_LOG_H + +#include +#include "avutil.h" +#include "attributes.h" +#include "version.h" + +typedef enum { + AV_CLASS_CATEGORY_NA = 0, + AV_CLASS_CATEGORY_INPUT, + AV_CLASS_CATEGORY_OUTPUT, + AV_CLASS_CATEGORY_MUXER, + AV_CLASS_CATEGORY_DEMUXER, + AV_CLASS_CATEGORY_ENCODER, + AV_CLASS_CATEGORY_DECODER, + AV_CLASS_CATEGORY_FILTER, + AV_CLASS_CATEGORY_BITSTREAM_FILTER, + AV_CLASS_CATEGORY_SWSCALER, + AV_CLASS_CATEGORY_SWRESAMPLER, + AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT = 40, + AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT, + AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT, + AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT, + AV_CLASS_CATEGORY_DEVICE_OUTPUT, + AV_CLASS_CATEGORY_DEVICE_INPUT, + AV_CLASS_CATEGORY_NB ///< not part of ABI/API +}AVClassCategory; + +#define AV_IS_INPUT_DEVICE(category) \ + (((category) == AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT) || \ + ((category) == AV_CLASS_CATEGORY_DEVICE_AUDIO_INPUT) || \ + ((category) == AV_CLASS_CATEGORY_DEVICE_INPUT)) + +#define AV_IS_OUTPUT_DEVICE(category) \ + (((category) == AV_CLASS_CATEGORY_DEVICE_VIDEO_OUTPUT) || \ + ((category) == AV_CLASS_CATEGORY_DEVICE_AUDIO_OUTPUT) || \ + ((category) == AV_CLASS_CATEGORY_DEVICE_OUTPUT)) + +struct AVOptionRanges; + +/** + * Describe the class of an AVClass context structure. That is an + * arbitrary struct of which the first field is a pointer to an + * AVClass struct (e.g. AVCodecContext, AVFormatContext etc.). + */ +typedef struct AVClass { + /** + * The name of the class; usually it is the same name as the + * context structure type to which the AVClass is associated. + */ + const char* class_name; + + /** + * A pointer to a function which returns the name of a context + * instance ctx associated with the class. + */ + const char* (*item_name)(void* ctx); + + /** + * a pointer to the first option specified in the class if any or NULL + * + * @see av_set_default_options() + */ + const struct AVOption *option; + + /** + * LIBAVUTIL_VERSION with which this structure was created. + * This is used to allow fields to be added without requiring major + * version bumps everywhere. + */ + + int version; + + /** + * Offset in the structure where log_level_offset is stored. + * 0 means there is no such variable + */ + int log_level_offset_offset; + + /** + * Offset in the structure where a pointer to the parent context for + * logging is stored. For example a decoder could pass its AVCodecContext + * to eval as such a parent context, which an av_log() implementation + * could then leverage to display the parent context. + * The offset can be NULL. + */ + int parent_log_context_offset; + + /** + * Return next AVOptions-enabled child or NULL + */ + void* (*child_next)(void *obj, void *prev); + + /** + * Return an AVClass corresponding to the next potential + * AVOptions-enabled child. + * + * The difference between child_next and this is that + * child_next iterates over _already existing_ objects, while + * child_class_next iterates over _all possible_ children. + */ + const struct AVClass* (*child_class_next)(const struct AVClass *prev); + + /** + * Category used for visualization (like color) + * This is only set if the category is equal for all objects using this class. + * available since version (51 << 16 | 56 << 8 | 100) + */ + AVClassCategory category; + + /** + * Callback to return the category. + * available since version (51 << 16 | 59 << 8 | 100) + */ + AVClassCategory (*get_category)(void* ctx); + + /** + * Callback to return the supported/allowed ranges. + * available since version (52.12) + */ + int (*query_ranges)(struct AVOptionRanges **, void *obj, const char *key, int flags); +} AVClass; + +/** + * @addtogroup lavu_log + * + * @{ + * + * @defgroup lavu_log_constants Logging Constants + * + * @{ + */ + +/** + * Print no output. + */ +#define AV_LOG_QUIET -8 + +/** + * Something went really wrong and we will crash now. + */ +#define AV_LOG_PANIC 0 + +/** + * Something went wrong and recovery is not possible. + * For example, no header was found for a format which depends + * on headers or an illegal combination of parameters is used. + */ +#define AV_LOG_FATAL 8 + +/** + * Something went wrong and cannot losslessly be recovered. + * However, not all future data is affected. + */ +#define AV_LOG_ERROR 16 + +/** + * Something somehow does not look correct. This may or may not + * lead to problems. An example would be the use of '-vstrict -2'. + */ +#define AV_LOG_WARNING 24 + +/** + * Standard information. + */ +#define AV_LOG_INFO 32 + +/** + * Detailed information. + */ +#define AV_LOG_VERBOSE 40 + +/** + * Stuff which is only useful for libav* developers. + */ +#define AV_LOG_DEBUG 48 + +/** + * Extremely verbose debugging, useful for libav* development. + */ +#define AV_LOG_TRACE 56 + +#define AV_LOG_MAX_OFFSET (AV_LOG_TRACE - AV_LOG_QUIET) + +/** + * @} + */ + +/** + * Sets additional colors for extended debugging sessions. + * @code + av_log(ctx, AV_LOG_DEBUG|AV_LOG_C(134), "Message in purple\n"); + @endcode + * Requires 256color terminal support. Uses outside debugging is not + * recommended. + */ +#define AV_LOG_C(x) ((x) << 8) + +/** + * Send the specified message to the log if the level is less than or equal + * to the current av_log_level. By default, all logging messages are sent to + * stderr. This behavior can be altered by setting a different logging callback + * function. + * @see av_log_set_callback + * + * @param avcl A pointer to an arbitrary struct of which the first field is a + * pointer to an AVClass struct or NULL if general log. + * @param level The importance level of the message expressed using a @ref + * lavu_log_constants "Logging Constant". + * @param fmt The format string (printf-compatible) that specifies how + * subsequent arguments are converted to output. + */ +void av_log(void *avcl, int level, const char *fmt, ...) av_printf_format(3, 4); + +/** + * Send the specified message to the log once with the initial_level and then with + * the subsequent_level. By default, all logging messages are sent to + * stderr. This behavior can be altered by setting a different logging callback + * function. + * @see av_log + * + * @param avcl A pointer to an arbitrary struct of which the first field is a + * pointer to an AVClass struct or NULL if general log. + * @param initial_level importance level of the message expressed using a @ref + * lavu_log_constants "Logging Constant" for the first occurance. + * @param subsequent_level importance level of the message expressed using a @ref + * lavu_log_constants "Logging Constant" after the first occurance. + * @param fmt The format string (printf-compatible) that specifies how + * subsequent arguments are converted to output. + * @param state a variable to keep trak of if a message has already been printed + * this must be initialized to 0 before the first use. The same state + * must not be accessed by 2 Threads simultaneously. + */ +void av_log_once(void* avcl, int initial_level, int subsequent_level, int *state, const char *fmt, ...) av_printf_format(5, 6); + + +/** + * Send the specified message to the log if the level is less than or equal + * to the current av_log_level. By default, all logging messages are sent to + * stderr. This behavior can be altered by setting a different logging callback + * function. + * @see av_log_set_callback + * + * @param avcl A pointer to an arbitrary struct of which the first field is a + * pointer to an AVClass struct. + * @param level The importance level of the message expressed using a @ref + * lavu_log_constants "Logging Constant". + * @param fmt The format string (printf-compatible) that specifies how + * subsequent arguments are converted to output. + * @param vl The arguments referenced by the format string. + */ +void av_vlog(void *avcl, int level, const char *fmt, va_list vl); + +/** + * Get the current log level + * + * @see lavu_log_constants + * + * @return Current log level + */ +int av_log_get_level(void); + +/** + * Set the log level + * + * @see lavu_log_constants + * + * @param level Logging level + */ +void av_log_set_level(int level); + +/** + * Set the logging callback + * + * @note The callback must be thread safe, even if the application does not use + * threads itself as some codecs are multithreaded. + * + * @see av_log_default_callback + * + * @param callback A logging function with a compatible signature. + */ +void av_log_set_callback(void (*callback)(void*, int, const char*, va_list)); + +/** + * Default logging callback + * + * It prints the message to stderr, optionally colorizing it. + * + * @param avcl A pointer to an arbitrary struct of which the first field is a + * pointer to an AVClass struct. + * @param level The importance level of the message expressed using a @ref + * lavu_log_constants "Logging Constant". + * @param fmt The format string (printf-compatible) that specifies how + * subsequent arguments are converted to output. + * @param vl The arguments referenced by the format string. + */ +void av_log_default_callback(void *avcl, int level, const char *fmt, + va_list vl); + +/** + * Return the context name + * + * @param ctx The AVClass context + * + * @return The AVClass class_name + */ +const char* av_default_item_name(void* ctx); +AVClassCategory av_default_get_category(void *ptr); + +/** + * Format a line of log the same way as the default callback. + * @param line buffer to receive the formatted line + * @param line_size size of the buffer + * @param print_prefix used to store whether the prefix must be printed; + * must point to a persistent integer initially set to 1 + */ +void av_log_format_line(void *ptr, int level, const char *fmt, va_list vl, + char *line, int line_size, int *print_prefix); + +/** + * Format a line of log the same way as the default callback. + * @param line buffer to receive the formatted line; + * may be NULL if line_size is 0 + * @param line_size size of the buffer; at most line_size-1 characters will + * be written to the buffer, plus one null terminator + * @param print_prefix used to store whether the prefix must be printed; + * must point to a persistent integer initially set to 1 + * @return Returns a negative value if an error occurred, otherwise returns + * the number of characters that would have been written for a + * sufficiently large buffer, not including the terminating null + * character. If the return value is not less than line_size, it means + * that the log message was truncated to fit the buffer. + */ +int av_log_format_line2(void *ptr, int level, const char *fmt, va_list vl, + char *line, int line_size, int *print_prefix); + +/** + * Skip repeated messages, this requires the user app to use av_log() instead of + * (f)printf as the 2 would otherwise interfere and lead to + * "Last message repeated x times" messages below (f)printf messages with some + * bad luck. + * Also to receive the last, "last repeated" line if any, the user app must + * call av_log(NULL, AV_LOG_QUIET, "%s", ""); at the end + */ +#define AV_LOG_SKIP_REPEATED 1 + +/** + * Include the log severity in messages originating from codecs. + * + * Results in messages such as: + * [rawvideo @ 0xDEADBEEF] [error] encode did not produce valid pts + */ +#define AV_LOG_PRINT_LEVEL 2 + +void av_log_set_flags(int arg); +int av_log_get_flags(void); + +/** + * @} + */ + +#endif /* AVUTIL_LOG_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/lzo.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/lzo.h new file mode 100644 index 0000000..c034039 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/lzo.h @@ -0,0 +1,66 @@ +/* + * LZO 1x decompression + * copyright (c) 2006 Reimar Doeffinger + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_LZO_H +#define AVUTIL_LZO_H + +/** + * @defgroup lavu_lzo LZO + * @ingroup lavu_crypto + * + * @{ + */ + +#include + +/** @name Error flags returned by av_lzo1x_decode + * @{ */ +/// end of the input buffer reached before decoding finished +#define AV_LZO_INPUT_DEPLETED 1 +/// decoded data did not fit into output buffer +#define AV_LZO_OUTPUT_FULL 2 +/// a reference to previously decoded data was wrong +#define AV_LZO_INVALID_BACKPTR 4 +/// a non-specific error in the compressed bitstream +#define AV_LZO_ERROR 8 +/** @} */ + +#define AV_LZO_INPUT_PADDING 8 +#define AV_LZO_OUTPUT_PADDING 12 + +/** + * @brief Decodes LZO 1x compressed data. + * @param out output buffer + * @param outlen size of output buffer, number of bytes left are returned here + * @param in input buffer + * @param inlen size of input buffer, number of bytes left are returned here + * @return 0 on success, otherwise a combination of the error flags above + * + * Make sure all buffers are appropriately padded, in must provide + * AV_LZO_INPUT_PADDING, out must provide AV_LZO_OUTPUT_PADDING additional bytes. + */ +int av_lzo1x_decode(void *out, int *outlen, const void *in, int *inlen); + +/** + * @} + */ + +#endif /* AVUTIL_LZO_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/macros.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/macros.h new file mode 100644 index 0000000..2007ee5 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/macros.h @@ -0,0 +1,50 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @ingroup lavu + * Utility Preprocessor macros + */ + +#ifndef AVUTIL_MACROS_H +#define AVUTIL_MACROS_H + +/** + * @addtogroup preproc_misc Preprocessor String Macros + * + * String manipulation macros + * + * @{ + */ + +#define AV_STRINGIFY(s) AV_TOSTRING(s) +#define AV_TOSTRING(s) #s + +#define AV_GLUE(a, b) a ## b +#define AV_JOIN(a, b) AV_GLUE(a, b) + +/** + * @} + */ + +#define AV_PRAGMA(s) _Pragma(#s) + +#define FFALIGN(x, a) (((x)+(a)-1)&~((a)-1)) + +#endif /* AVUTIL_MACROS_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/mastering_display_metadata.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/mastering_display_metadata.h new file mode 100644 index 0000000..c23b07c --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/mastering_display_metadata.h @@ -0,0 +1,128 @@ +/* + * Copyright (c) 2016 Neil Birkbeck + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_MASTERING_DISPLAY_METADATA_H +#define AVUTIL_MASTERING_DISPLAY_METADATA_H + +#include "frame.h" +#include "rational.h" + + +/** + * Mastering display metadata capable of representing the color volume of + * the display used to master the content (SMPTE 2086:2014). + * + * To be used as payload of a AVFrameSideData or AVPacketSideData with the + * appropriate type. + * + * @note The struct should be allocated with av_mastering_display_metadata_alloc() + * and its size is not a part of the public ABI. + */ +typedef struct AVMasteringDisplayMetadata { + /** + * CIE 1931 xy chromaticity coords of color primaries (r, g, b order). + */ + AVRational display_primaries[3][2]; + + /** + * CIE 1931 xy chromaticity coords of white point. + */ + AVRational white_point[2]; + + /** + * Min luminance of mastering display (cd/m^2). + */ + AVRational min_luminance; + + /** + * Max luminance of mastering display (cd/m^2). + */ + AVRational max_luminance; + + /** + * Flag indicating whether the display primaries (and white point) are set. + */ + int has_primaries; + + /** + * Flag indicating whether the luminance (min_ and max_) have been set. + */ + int has_luminance; + +} AVMasteringDisplayMetadata; + +/** + * Allocate an AVMasteringDisplayMetadata structure and set its fields to + * default values. The resulting struct can be freed using av_freep(). + * + * @return An AVMasteringDisplayMetadata filled with default values or NULL + * on failure. + */ +AVMasteringDisplayMetadata *av_mastering_display_metadata_alloc(void); + +/** + * Allocate a complete AVMasteringDisplayMetadata and add it to the frame. + * + * @param frame The frame which side data is added to. + * + * @return The AVMasteringDisplayMetadata structure to be filled by caller. + */ +AVMasteringDisplayMetadata *av_mastering_display_metadata_create_side_data(AVFrame *frame); + +/** + * Content light level needed by to transmit HDR over HDMI (CTA-861.3). + * + * To be used as payload of a AVFrameSideData or AVPacketSideData with the + * appropriate type. + * + * @note The struct should be allocated with av_content_light_metadata_alloc() + * and its size is not a part of the public ABI. + */ +typedef struct AVContentLightMetadata { + /** + * Max content light level (cd/m^2). + */ + unsigned MaxCLL; + + /** + * Max average light level per frame (cd/m^2). + */ + unsigned MaxFALL; +} AVContentLightMetadata; + +/** + * Allocate an AVContentLightMetadata structure and set its fields to + * default values. The resulting struct can be freed using av_freep(). + * + * @return An AVContentLightMetadata filled with default values or NULL + * on failure. + */ +AVContentLightMetadata *av_content_light_metadata_alloc(size_t *size); + +/** + * Allocate a complete AVContentLightMetadata and add it to the frame. + * + * @param frame The frame which side data is added to. + * + * @return The AVContentLightMetadata structure to be filled by caller. + */ +AVContentLightMetadata *av_content_light_metadata_create_side_data(AVFrame *frame); + +#endif /* AVUTIL_MASTERING_DISPLAY_METADATA_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/mathematics.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/mathematics.h new file mode 100644 index 0000000..5490180 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/mathematics.h @@ -0,0 +1,242 @@ +/* + * copyright (c) 2005-2012 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @addtogroup lavu_math + * Mathematical utilities for working with timestamp and time base. + */ + +#ifndef AVUTIL_MATHEMATICS_H +#define AVUTIL_MATHEMATICS_H + +#include +#include +#include "attributes.h" +#include "rational.h" +#include "intfloat.h" + +#ifndef M_E +#define M_E 2.7182818284590452354 /* e */ +#endif +#ifndef M_LN2 +#define M_LN2 0.69314718055994530942 /* log_e 2 */ +#endif +#ifndef M_LN10 +#define M_LN10 2.30258509299404568402 /* log_e 10 */ +#endif +#ifndef M_LOG2_10 +#define M_LOG2_10 3.32192809488736234787 /* log_2 10 */ +#endif +#ifndef M_PHI +#define M_PHI 1.61803398874989484820 /* phi / golden ratio */ +#endif +#ifndef M_PI +#define M_PI 3.14159265358979323846 /* pi */ +#endif +#ifndef M_PI_2 +#define M_PI_2 1.57079632679489661923 /* pi/2 */ +#endif +#ifndef M_SQRT1_2 +#define M_SQRT1_2 0.70710678118654752440 /* 1/sqrt(2) */ +#endif +#ifndef M_SQRT2 +#define M_SQRT2 1.41421356237309504880 /* sqrt(2) */ +#endif +#ifndef NAN +#define NAN av_int2float(0x7fc00000) +#endif +#ifndef INFINITY +#define INFINITY av_int2float(0x7f800000) +#endif + +/** + * @addtogroup lavu_math + * + * @{ + */ + +/** + * Rounding methods. + */ +enum AVRounding { + AV_ROUND_ZERO = 0, ///< Round toward zero. + AV_ROUND_INF = 1, ///< Round away from zero. + AV_ROUND_DOWN = 2, ///< Round toward -infinity. + AV_ROUND_UP = 3, ///< Round toward +infinity. + AV_ROUND_NEAR_INF = 5, ///< Round to nearest and halfway cases away from zero. + /** + * Flag telling rescaling functions to pass `INT64_MIN`/`MAX` through + * unchanged, avoiding special cases for #AV_NOPTS_VALUE. + * + * Unlike other values of the enumeration AVRounding, this value is a + * bitmask that must be used in conjunction with another value of the + * enumeration through a bitwise OR, in order to set behavior for normal + * cases. + * + * @code{.c} + * av_rescale_rnd(3, 1, 2, AV_ROUND_UP | AV_ROUND_PASS_MINMAX); + * // Rescaling 3: + * // Calculating 3 * 1 / 2 + * // 3 / 2 is rounded up to 2 + * // => 2 + * + * av_rescale_rnd(AV_NOPTS_VALUE, 1, 2, AV_ROUND_UP | AV_ROUND_PASS_MINMAX); + * // Rescaling AV_NOPTS_VALUE: + * // AV_NOPTS_VALUE == INT64_MIN + * // AV_NOPTS_VALUE is passed through + * // => AV_NOPTS_VALUE + * @endcode + */ + AV_ROUND_PASS_MINMAX = 8192, +}; + +/** + * Compute the greatest common divisor of two integer operands. + * + * @param a,b Operands + * @return GCD of a and b up to sign; if a >= 0 and b >= 0, return value is >= 0; + * if a == 0 and b == 0, returns 0. + */ +int64_t av_const av_gcd(int64_t a, int64_t b); + +/** + * Rescale a 64-bit integer with rounding to nearest. + * + * The operation is mathematically equivalent to `a * b / c`, but writing that + * directly can overflow. + * + * This function is equivalent to av_rescale_rnd() with #AV_ROUND_NEAR_INF. + * + * @see av_rescale_rnd(), av_rescale_q(), av_rescale_q_rnd() + */ +int64_t av_rescale(int64_t a, int64_t b, int64_t c) av_const; + +/** + * Rescale a 64-bit integer with specified rounding. + * + * The operation is mathematically equivalent to `a * b / c`, but writing that + * directly can overflow, and does not support different rounding methods. + * + * @see av_rescale(), av_rescale_q(), av_rescale_q_rnd() + */ +int64_t av_rescale_rnd(int64_t a, int64_t b, int64_t c, enum AVRounding rnd) av_const; + +/** + * Rescale a 64-bit integer by 2 rational numbers. + * + * The operation is mathematically equivalent to `a * bq / cq`. + * + * This function is equivalent to av_rescale_q_rnd() with #AV_ROUND_NEAR_INF. + * + * @see av_rescale(), av_rescale_rnd(), av_rescale_q_rnd() + */ +int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq) av_const; + +/** + * Rescale a 64-bit integer by 2 rational numbers with specified rounding. + * + * The operation is mathematically equivalent to `a * bq / cq`. + * + * @see av_rescale(), av_rescale_rnd(), av_rescale_q() + */ +int64_t av_rescale_q_rnd(int64_t a, AVRational bq, AVRational cq, + enum AVRounding rnd) av_const; + +/** + * Compare two timestamps each in its own time base. + * + * @return One of the following values: + * - -1 if `ts_a` is before `ts_b` + * - 1 if `ts_a` is after `ts_b` + * - 0 if they represent the same position + * + * @warning + * The result of the function is undefined if one of the timestamps is outside + * the `int64_t` range when represented in the other's timebase. + */ +int av_compare_ts(int64_t ts_a, AVRational tb_a, int64_t ts_b, AVRational tb_b); + +/** + * Compare the remainders of two integer operands divided by a common divisor. + * + * In other words, compare the least significant `log2(mod)` bits of integers + * `a` and `b`. + * + * @code{.c} + * av_compare_mod(0x11, 0x02, 0x10) < 0 // since 0x11 % 0x10 (0x1) < 0x02 % 0x10 (0x2) + * av_compare_mod(0x11, 0x02, 0x20) > 0 // since 0x11 % 0x20 (0x11) > 0x02 % 0x20 (0x02) + * @endcode + * + * @param a,b Operands + * @param mod Divisor; must be a power of 2 + * @return + * - a negative value if `a % mod < b % mod` + * - a positive value if `a % mod > b % mod` + * - zero if `a % mod == b % mod` + */ +int64_t av_compare_mod(uint64_t a, uint64_t b, uint64_t mod); + +/** + * Rescale a timestamp while preserving known durations. + * + * This function is designed to be called per audio packet to scale the input + * timestamp to a different time base. Compared to a simple av_rescale_q() + * call, this function is robust against possible inconsistent frame durations. + * + * The `last` parameter is a state variable that must be preserved for all + * subsequent calls for the same stream. For the first call, `*last` should be + * initialized to #AV_NOPTS_VALUE. + * + * @param[in] in_tb Input time base + * @param[in] in_ts Input timestamp + * @param[in] fs_tb Duration time base; typically this is finer-grained + * (greater) than `in_tb` and `out_tb` + * @param[in] duration Duration till the next call to this function (i.e. + * duration of the current packet/frame) + * @param[in,out] last Pointer to a timestamp expressed in terms of + * `fs_tb`, acting as a state variable + * @param[in] out_tb Output timebase + * @return Timestamp expressed in terms of `out_tb` + * + * @note In the context of this function, "duration" is in term of samples, not + * seconds. + */ +int64_t av_rescale_delta(AVRational in_tb, int64_t in_ts, AVRational fs_tb, int duration, int64_t *last, AVRational out_tb); + +/** + * Add a value to a timestamp. + * + * This function guarantees that when the same value is repeatly added that + * no accumulation of rounding errors occurs. + * + * @param[in] ts Input timestamp + * @param[in] ts_tb Input timestamp time base + * @param[in] inc Value to be added + * @param[in] inc_tb Time base of `inc` + */ +int64_t av_add_stable(AVRational ts_tb, int64_t ts, AVRational inc_tb, int64_t inc); + + +/** + * @} + */ + +#endif /* AVUTIL_MATHEMATICS_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/md5.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/md5.h new file mode 100644 index 0000000..ca72ccb --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/md5.h @@ -0,0 +1,98 @@ +/* + * copyright (c) 2006 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @ingroup lavu_md5 + * Public header for MD5 hash function implementation. + */ + +#ifndef AVUTIL_MD5_H +#define AVUTIL_MD5_H + +#include +#include + +#include "attributes.h" +#include "version.h" + +/** + * @defgroup lavu_md5 MD5 + * @ingroup lavu_hash + * MD5 hash function implementation. + * + * @{ + */ + +extern const int av_md5_size; + +struct AVMD5; + +/** + * Allocate an AVMD5 context. + */ +struct AVMD5 *av_md5_alloc(void); + +/** + * Initialize MD5 hashing. + * + * @param ctx pointer to the function context (of size av_md5_size) + */ +void av_md5_init(struct AVMD5 *ctx); + +/** + * Update hash value. + * + * @param ctx hash function context + * @param src input data to update hash with + * @param len input data length + */ +#if FF_API_CRYPTO_SIZE_T +void av_md5_update(struct AVMD5 *ctx, const uint8_t *src, int len); +#else +void av_md5_update(struct AVMD5 *ctx, const uint8_t *src, size_t len); +#endif + +/** + * Finish hashing and output digest value. + * + * @param ctx hash function context + * @param dst buffer where output digest value is stored + */ +void av_md5_final(struct AVMD5 *ctx, uint8_t *dst); + +/** + * Hash an array of data. + * + * @param dst The output buffer to write the digest into + * @param src The data to hash + * @param len The length of the data, in bytes + */ +#if FF_API_CRYPTO_SIZE_T +void av_md5_sum(uint8_t *dst, const uint8_t *src, const int len); +#else +void av_md5_sum(uint8_t *dst, const uint8_t *src, size_t len); +#endif + +/** + * @} + */ + +#endif /* AVUTIL_MD5_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/mem.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/mem.h new file mode 100644 index 0000000..5fb1a02 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/mem.h @@ -0,0 +1,700 @@ +/* + * copyright (c) 2006 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @ingroup lavu_mem + * Memory handling functions + */ + +#ifndef AVUTIL_MEM_H +#define AVUTIL_MEM_H + +#include +#include + +#include "attributes.h" +#include "error.h" +#include "avutil.h" + +/** + * @addtogroup lavu_mem + * Utilities for manipulating memory. + * + * FFmpeg has several applications of memory that are not required of a typical + * program. For example, the computing-heavy components like video decoding and + * encoding can be sped up significantly through the use of aligned memory. + * + * However, for each of FFmpeg's applications of memory, there might not be a + * recognized or standardized API for that specific use. Memory alignment, for + * instance, varies wildly depending on operating systems, architectures, and + * compilers. Hence, this component of @ref libavutil is created to make + * dealing with memory consistently possible on all platforms. + * + * @{ + * + * @defgroup lavu_mem_macros Alignment Macros + * Helper macros for declaring aligned variables. + * @{ + */ + +/** + * @def DECLARE_ALIGNED(n,t,v) + * Declare a variable that is aligned in memory. + * + * @code{.c} + * DECLARE_ALIGNED(16, uint16_t, aligned_int) = 42; + * DECLARE_ALIGNED(32, uint8_t, aligned_array)[128]; + * + * // The default-alignment equivalent would be + * uint16_t aligned_int = 42; + * uint8_t aligned_array[128]; + * @endcode + * + * @param n Minimum alignment in bytes + * @param t Type of the variable (or array element) + * @param v Name of the variable + */ + +/** + * @def DECLARE_ASM_ALIGNED(n,t,v) + * Declare an aligned variable appropriate for use in inline assembly code. + * + * @code{.c} + * DECLARE_ASM_ALIGNED(16, uint64_t, pw_08) = UINT64_C(0x0008000800080008); + * @endcode + * + * @param n Minimum alignment in bytes + * @param t Type of the variable (or array element) + * @param v Name of the variable + */ + +/** + * @def DECLARE_ASM_CONST(n,t,v) + * Declare a static constant aligned variable appropriate for use in inline + * assembly code. + * + * @code{.c} + * DECLARE_ASM_CONST(16, uint64_t, pw_08) = UINT64_C(0x0008000800080008); + * @endcode + * + * @param n Minimum alignment in bytes + * @param t Type of the variable (or array element) + * @param v Name of the variable + */ + +#if defined(__INTEL_COMPILER) && __INTEL_COMPILER < 1110 || defined(__SUNPRO_C) + #define DECLARE_ALIGNED(n,t,v) t __attribute__ ((aligned (n))) v + #define DECLARE_ASM_ALIGNED(n,t,v) t __attribute__ ((aligned (n))) v + #define DECLARE_ASM_CONST(n,t,v) const t __attribute__ ((aligned (n))) v +#elif defined(__DJGPP__) + #define DECLARE_ALIGNED(n,t,v) t __attribute__ ((aligned (FFMIN(n, 16)))) v + #define DECLARE_ASM_ALIGNED(n,t,v) t av_used __attribute__ ((aligned (FFMIN(n, 16)))) v + #define DECLARE_ASM_CONST(n,t,v) static const t av_used __attribute__ ((aligned (FFMIN(n, 16)))) v +#elif defined(__GNUC__) || defined(__clang__) + #define DECLARE_ALIGNED(n,t,v) t __attribute__ ((aligned (n))) v + #define DECLARE_ASM_ALIGNED(n,t,v) t av_used __attribute__ ((aligned (n))) v + #define DECLARE_ASM_CONST(n,t,v) static const t av_used __attribute__ ((aligned (n))) v +#elif defined(_MSC_VER) + #define DECLARE_ALIGNED(n,t,v) __declspec(align(n)) t v + #define DECLARE_ASM_ALIGNED(n,t,v) __declspec(align(n)) t v + #define DECLARE_ASM_CONST(n,t,v) __declspec(align(n)) static const t v +#else + #define DECLARE_ALIGNED(n,t,v) t v + #define DECLARE_ASM_ALIGNED(n,t,v) t v + #define DECLARE_ASM_CONST(n,t,v) static const t v +#endif + +/** + * @} + */ + +/** + * @defgroup lavu_mem_attrs Function Attributes + * Function attributes applicable to memory handling functions. + * + * These function attributes can help compilers emit more useful warnings, or + * generate better code. + * @{ + */ + +/** + * @def av_malloc_attrib + * Function attribute denoting a malloc-like function. + * + * @see Function attribute `malloc` in GCC's documentation + */ + +#if AV_GCC_VERSION_AT_LEAST(3,1) + #define av_malloc_attrib __attribute__((__malloc__)) +#else + #define av_malloc_attrib +#endif + +/** + * @def av_alloc_size(...) + * Function attribute used on a function that allocates memory, whose size is + * given by the specified parameter(s). + * + * @code{.c} + * void *av_malloc(size_t size) av_alloc_size(1); + * void *av_calloc(size_t nmemb, size_t size) av_alloc_size(1, 2); + * @endcode + * + * @param ... One or two parameter indexes, separated by a comma + * + * @see Function attribute `alloc_size` in GCC's documentation + */ + +#if AV_GCC_VERSION_AT_LEAST(4,3) + #define av_alloc_size(...) __attribute__((alloc_size(__VA_ARGS__))) +#else + #define av_alloc_size(...) +#endif + +/** + * @} + */ + +/** + * @defgroup lavu_mem_funcs Heap Management + * Functions responsible for allocating, freeing, and copying memory. + * + * All memory allocation functions have a built-in upper limit of `INT_MAX` + * bytes. This may be changed with av_max_alloc(), although exercise extreme + * caution when doing so. + * + * @{ + */ + +/** + * Allocate a memory block with alignment suitable for all memory accesses + * (including vectors if available on the CPU). + * + * @param size Size in bytes for the memory block to be allocated + * @return Pointer to the allocated block, or `NULL` if the block cannot + * be allocated + * @see av_mallocz() + */ +void *av_malloc(size_t size) av_malloc_attrib av_alloc_size(1); + +/** + * Allocate a memory block with alignment suitable for all memory accesses + * (including vectors if available on the CPU) and zero all the bytes of the + * block. + * + * @param size Size in bytes for the memory block to be allocated + * @return Pointer to the allocated block, or `NULL` if it cannot be allocated + * @see av_malloc() + */ +void *av_mallocz(size_t size) av_malloc_attrib av_alloc_size(1); + +/** + * Allocate a memory block for an array with av_malloc(). + * + * The allocated memory will have size `size * nmemb` bytes. + * + * @param nmemb Number of element + * @param size Size of a single element + * @return Pointer to the allocated block, or `NULL` if the block cannot + * be allocated + * @see av_malloc() + */ +av_alloc_size(1, 2) void *av_malloc_array(size_t nmemb, size_t size); + +/** + * Allocate a memory block for an array with av_mallocz(). + * + * The allocated memory will have size `size * nmemb` bytes. + * + * @param nmemb Number of elements + * @param size Size of the single element + * @return Pointer to the allocated block, or `NULL` if the block cannot + * be allocated + * + * @see av_mallocz() + * @see av_malloc_array() + */ +av_alloc_size(1, 2) void *av_mallocz_array(size_t nmemb, size_t size); + +/** + * Non-inlined equivalent of av_mallocz_array(). + * + * Created for symmetry with the calloc() C function. + */ +void *av_calloc(size_t nmemb, size_t size) av_malloc_attrib; + +/** + * Allocate, reallocate, or free a block of memory. + * + * If `ptr` is `NULL` and `size` > 0, allocate a new block. If `size` is + * zero, free the memory block pointed to by `ptr`. Otherwise, expand or + * shrink that block of memory according to `size`. + * + * @param ptr Pointer to a memory block already allocated with + * av_realloc() or `NULL` + * @param size Size in bytes of the memory block to be allocated or + * reallocated + * + * @return Pointer to a newly-reallocated block or `NULL` if the block + * cannot be reallocated or the function is used to free the memory block + * + * @warning Unlike av_malloc(), the returned pointer is not guaranteed to be + * correctly aligned. + * @see av_fast_realloc() + * @see av_reallocp() + */ +void *av_realloc(void *ptr, size_t size) av_alloc_size(2); + +/** + * Allocate, reallocate, or free a block of memory through a pointer to a + * pointer. + * + * If `*ptr` is `NULL` and `size` > 0, allocate a new block. If `size` is + * zero, free the memory block pointed to by `*ptr`. Otherwise, expand or + * shrink that block of memory according to `size`. + * + * @param[in,out] ptr Pointer to a pointer to a memory block already allocated + * with av_realloc(), or a pointer to `NULL`. The pointer + * is updated on success, or freed on failure. + * @param[in] size Size in bytes for the memory block to be allocated or + * reallocated + * + * @return Zero on success, an AVERROR error code on failure + * + * @warning Unlike av_malloc(), the allocated memory is not guaranteed to be + * correctly aligned. + */ +av_warn_unused_result +int av_reallocp(void *ptr, size_t size); + +/** + * Allocate, reallocate, or free a block of memory. + * + * This function does the same thing as av_realloc(), except: + * - It takes two size arguments and allocates `nelem * elsize` bytes, + * after checking the result of the multiplication for integer overflow. + * - It frees the input block in case of failure, thus avoiding the memory + * leak with the classic + * @code{.c} + * buf = realloc(buf); + * if (!buf) + * return -1; + * @endcode + * pattern. + */ +void *av_realloc_f(void *ptr, size_t nelem, size_t elsize); + +/** + * Allocate, reallocate, or free an array. + * + * If `ptr` is `NULL` and `nmemb` > 0, allocate a new block. If + * `nmemb` is zero, free the memory block pointed to by `ptr`. + * + * @param ptr Pointer to a memory block already allocated with + * av_realloc() or `NULL` + * @param nmemb Number of elements in the array + * @param size Size of the single element of the array + * + * @return Pointer to a newly-reallocated block or NULL if the block + * cannot be reallocated or the function is used to free the memory block + * + * @warning Unlike av_malloc(), the allocated memory is not guaranteed to be + * correctly aligned. + * @see av_reallocp_array() + */ +av_alloc_size(2, 3) void *av_realloc_array(void *ptr, size_t nmemb, size_t size); + +/** + * Allocate, reallocate, or free an array through a pointer to a pointer. + * + * If `*ptr` is `NULL` and `nmemb` > 0, allocate a new block. If `nmemb` is + * zero, free the memory block pointed to by `*ptr`. + * + * @param[in,out] ptr Pointer to a pointer to a memory block already + * allocated with av_realloc(), or a pointer to `NULL`. + * The pointer is updated on success, or freed on failure. + * @param[in] nmemb Number of elements + * @param[in] size Size of the single element + * + * @return Zero on success, an AVERROR error code on failure + * + * @warning Unlike av_malloc(), the allocated memory is not guaranteed to be + * correctly aligned. + */ +int av_reallocp_array(void *ptr, size_t nmemb, size_t size); + +/** + * Reallocate the given buffer if it is not large enough, otherwise do nothing. + * + * If the given buffer is `NULL`, then a new uninitialized buffer is allocated. + * + * If the given buffer is not large enough, and reallocation fails, `NULL` is + * returned and `*size` is set to 0, but the original buffer is not changed or + * freed. + * + * A typical use pattern follows: + * + * @code{.c} + * uint8_t *buf = ...; + * uint8_t *new_buf = av_fast_realloc(buf, ¤t_size, size_needed); + * if (!new_buf) { + * // Allocation failed; clean up original buffer + * av_freep(&buf); + * return AVERROR(ENOMEM); + * } + * @endcode + * + * @param[in,out] ptr Already allocated buffer, or `NULL` + * @param[in,out] size Pointer to the size of buffer `ptr`. `*size` is + * updated to the new allocated size, in particular 0 + * in case of failure. + * @param[in] min_size Desired minimal size of buffer `ptr` + * @return `ptr` if the buffer is large enough, a pointer to newly reallocated + * buffer if the buffer was not large enough, or `NULL` in case of + * error + * @see av_realloc() + * @see av_fast_malloc() + */ +void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size); + +/** + * Allocate a buffer, reusing the given one if large enough. + * + * Contrary to av_fast_realloc(), the current buffer contents might not be + * preserved and on error the old buffer is freed, thus no special handling to + * avoid memleaks is necessary. + * + * `*ptr` is allowed to be `NULL`, in which case allocation always happens if + * `size_needed` is greater than 0. + * + * @code{.c} + * uint8_t *buf = ...; + * av_fast_malloc(&buf, ¤t_size, size_needed); + * if (!buf) { + * // Allocation failed; buf already freed + * return AVERROR(ENOMEM); + * } + * @endcode + * + * @param[in,out] ptr Pointer to pointer to an already allocated buffer. + * `*ptr` will be overwritten with pointer to new + * buffer on success or `NULL` on failure + * @param[in,out] size Pointer to the size of buffer `*ptr`. `*size` is + * updated to the new allocated size, in particular 0 + * in case of failure. + * @param[in] min_size Desired minimal size of buffer `*ptr` + * @see av_realloc() + * @see av_fast_mallocz() + */ +void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size); + +/** + * Allocate and clear a buffer, reusing the given one if large enough. + * + * Like av_fast_malloc(), but all newly allocated space is initially cleared. + * Reused buffer is not cleared. + * + * `*ptr` is allowed to be `NULL`, in which case allocation always happens if + * `size_needed` is greater than 0. + * + * @param[in,out] ptr Pointer to pointer to an already allocated buffer. + * `*ptr` will be overwritten with pointer to new + * buffer on success or `NULL` on failure + * @param[in,out] size Pointer to the size of buffer `*ptr`. `*size` is + * updated to the new allocated size, in particular 0 + * in case of failure. + * @param[in] min_size Desired minimal size of buffer `*ptr` + * @see av_fast_malloc() + */ +void av_fast_mallocz(void *ptr, unsigned int *size, size_t min_size); + +/** + * Free a memory block which has been allocated with a function of av_malloc() + * or av_realloc() family. + * + * @param ptr Pointer to the memory block which should be freed. + * + * @note `ptr = NULL` is explicitly allowed. + * @note It is recommended that you use av_freep() instead, to prevent leaving + * behind dangling pointers. + * @see av_freep() + */ +void av_free(void *ptr); + +/** + * Free a memory block which has been allocated with a function of av_malloc() + * or av_realloc() family, and set the pointer pointing to it to `NULL`. + * + * @code{.c} + * uint8_t *buf = av_malloc(16); + * av_free(buf); + * // buf now contains a dangling pointer to freed memory, and accidental + * // dereference of buf will result in a use-after-free, which may be a + * // security risk. + * + * uint8_t *buf = av_malloc(16); + * av_freep(&buf); + * // buf is now NULL, and accidental dereference will only result in a + * // NULL-pointer dereference. + * @endcode + * + * @param ptr Pointer to the pointer to the memory block which should be freed + * @note `*ptr = NULL` is safe and leads to no action. + * @see av_free() + */ +void av_freep(void *ptr); + +/** + * Duplicate a string. + * + * @param s String to be duplicated + * @return Pointer to a newly-allocated string containing a + * copy of `s` or `NULL` if the string cannot be allocated + * @see av_strndup() + */ +char *av_strdup(const char *s) av_malloc_attrib; + +/** + * Duplicate a substring of a string. + * + * @param s String to be duplicated + * @param len Maximum length of the resulting string (not counting the + * terminating byte) + * @return Pointer to a newly-allocated string containing a + * substring of `s` or `NULL` if the string cannot be allocated + */ +char *av_strndup(const char *s, size_t len) av_malloc_attrib; + +/** + * Duplicate a buffer with av_malloc(). + * + * @param p Buffer to be duplicated + * @param size Size in bytes of the buffer copied + * @return Pointer to a newly allocated buffer containing a + * copy of `p` or `NULL` if the buffer cannot be allocated + */ +void *av_memdup(const void *p, size_t size); + +/** + * Overlapping memcpy() implementation. + * + * @param dst Destination buffer + * @param back Number of bytes back to start copying (i.e. the initial size of + * the overlapping window); must be > 0 + * @param cnt Number of bytes to copy; must be >= 0 + * + * @note `cnt > back` is valid, this will copy the bytes we just copied, + * thus creating a repeating pattern with a period length of `back`. + */ +void av_memcpy_backptr(uint8_t *dst, int back, int cnt); + +/** + * @} + */ + +/** + * @defgroup lavu_mem_dynarray Dynamic Array + * + * Utilities to make an array grow when needed. + * + * Sometimes, the programmer would want to have an array that can grow when + * needed. The libavutil dynamic array utilities fill that need. + * + * libavutil supports two systems of appending elements onto a dynamically + * allocated array, the first one storing the pointer to the value in the + * array, and the second storing the value directly. In both systems, the + * caller is responsible for maintaining a variable containing the length of + * the array, as well as freeing of the array after use. + * + * The first system stores pointers to values in a block of dynamically + * allocated memory. Since only pointers are stored, the function does not need + * to know the size of the type. Both av_dynarray_add() and + * av_dynarray_add_nofree() implement this system. + * + * @code + * type **array = NULL; //< an array of pointers to values + * int nb = 0; //< a variable to keep track of the length of the array + * + * type to_be_added = ...; + * type to_be_added2 = ...; + * + * av_dynarray_add(&array, &nb, &to_be_added); + * if (nb == 0) + * return AVERROR(ENOMEM); + * + * av_dynarray_add(&array, &nb, &to_be_added2); + * if (nb == 0) + * return AVERROR(ENOMEM); + * + * // Now: + * // nb == 2 + * // &to_be_added == array[0] + * // &to_be_added2 == array[1] + * + * av_freep(&array); + * @endcode + * + * The second system stores the value directly in a block of memory. As a + * result, the function has to know the size of the type. av_dynarray2_add() + * implements this mechanism. + * + * @code + * type *array = NULL; //< an array of values + * int nb = 0; //< a variable to keep track of the length of the array + * + * type to_be_added = ...; + * type to_be_added2 = ...; + * + * type *addr = av_dynarray2_add((void **)&array, &nb, sizeof(*array), NULL); + * if (!addr) + * return AVERROR(ENOMEM); + * memcpy(addr, &to_be_added, sizeof(to_be_added)); + * + * // Shortcut of the above. + * type *addr = av_dynarray2_add((void **)&array, &nb, sizeof(*array), + * (const void *)&to_be_added2); + * if (!addr) + * return AVERROR(ENOMEM); + * + * // Now: + * // nb == 2 + * // to_be_added == array[0] + * // to_be_added2 == array[1] + * + * av_freep(&array); + * @endcode + * + * @{ + */ + +/** + * Add the pointer to an element to a dynamic array. + * + * The array to grow is supposed to be an array of pointers to + * structures, and the element to add must be a pointer to an already + * allocated structure. + * + * The array is reallocated when its size reaches powers of 2. + * Therefore, the amortized cost of adding an element is constant. + * + * In case of success, the pointer to the array is updated in order to + * point to the new grown array, and the number pointed to by `nb_ptr` + * is incremented. + * In case of failure, the array is freed, `*tab_ptr` is set to `NULL` and + * `*nb_ptr` is set to 0. + * + * @param[in,out] tab_ptr Pointer to the array to grow + * @param[in,out] nb_ptr Pointer to the number of elements in the array + * @param[in] elem Element to add + * @see av_dynarray_add_nofree(), av_dynarray2_add() + */ +void av_dynarray_add(void *tab_ptr, int *nb_ptr, void *elem); + +/** + * Add an element to a dynamic array. + * + * Function has the same functionality as av_dynarray_add(), + * but it doesn't free memory on fails. It returns error code + * instead and leave current buffer untouched. + * + * @return >=0 on success, negative otherwise + * @see av_dynarray_add(), av_dynarray2_add() + */ +av_warn_unused_result +int av_dynarray_add_nofree(void *tab_ptr, int *nb_ptr, void *elem); + +/** + * Add an element of size `elem_size` to a dynamic array. + * + * The array is reallocated when its number of elements reaches powers of 2. + * Therefore, the amortized cost of adding an element is constant. + * + * In case of success, the pointer to the array is updated in order to + * point to the new grown array, and the number pointed to by `nb_ptr` + * is incremented. + * In case of failure, the array is freed, `*tab_ptr` is set to `NULL` and + * `*nb_ptr` is set to 0. + * + * @param[in,out] tab_ptr Pointer to the array to grow + * @param[in,out] nb_ptr Pointer to the number of elements in the array + * @param[in] elem_size Size in bytes of an element in the array + * @param[in] elem_data Pointer to the data of the element to add. If + * `NULL`, the space of the newly added element is + * allocated but left uninitialized. + * + * @return Pointer to the data of the element to copy in the newly allocated + * space + * @see av_dynarray_add(), av_dynarray_add_nofree() + */ +void *av_dynarray2_add(void **tab_ptr, int *nb_ptr, size_t elem_size, + const uint8_t *elem_data); + +/** + * @} + */ + +/** + * @defgroup lavu_mem_misc Miscellaneous Functions + * + * Other functions related to memory allocation. + * + * @{ + */ + +/** + * Multiply two `size_t` values checking for overflow. + * + * @param[in] a,b Operands of multiplication + * @param[out] r Pointer to the result of the operation + * @return 0 on success, AVERROR(EINVAL) on overflow + */ +static inline int av_size_mult(size_t a, size_t b, size_t *r) +{ + size_t t = a * b; + /* Hack inspired from glibc: don't try the division if nelem and elsize + * are both less than sqrt(SIZE_MAX). */ + if ((a | b) >= ((size_t)1 << (sizeof(size_t) * 4)) && a && t / a != b) + return AVERROR(EINVAL); + *r = t; + return 0; +} + +/** + * Set the maximum size that may be allocated in one block. + * + * The value specified with this function is effective for all libavutil's @ref + * lavu_mem_funcs "heap management functions." + * + * By default, the max value is defined as `INT_MAX`. + * + * @param max Value to be set as the new maximum size + * + * @warning Exercise extreme caution when using this function. Don't touch + * this if you do not understand the full consequence of doing so. + */ +void av_max_alloc(size_t max); + +/** + * @} + * @} + */ + +#endif /* AVUTIL_MEM_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/motion_vector.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/motion_vector.h new file mode 100644 index 0000000..ec29556 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/motion_vector.h @@ -0,0 +1,57 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_MOTION_VECTOR_H +#define AVUTIL_MOTION_VECTOR_H + +#include + +typedef struct AVMotionVector { + /** + * Where the current macroblock comes from; negative value when it comes + * from the past, positive value when it comes from the future. + * XXX: set exact relative ref frame reference instead of a +/- 1 "direction". + */ + int32_t source; + /** + * Width and height of the block. + */ + uint8_t w, h; + /** + * Absolute source position. Can be outside the frame area. + */ + int16_t src_x, src_y; + /** + * Absolute destination position. Can be outside the frame area. + */ + int16_t dst_x, dst_y; + /** + * Extra flag information. + * Currently unused. + */ + uint64_t flags; + /** + * Motion vector + * src_x = dst_x + motion_x / motion_scale + * src_y = dst_y + motion_y / motion_scale + */ + int32_t motion_x, motion_y; + uint16_t motion_scale; +} AVMotionVector; + +#endif /* AVUTIL_MOTION_VECTOR_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/murmur3.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/murmur3.h new file mode 100644 index 0000000..1b09175 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/murmur3.h @@ -0,0 +1,120 @@ +/* + * Copyright (C) 2013 Reimar Döffinger + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @ingroup lavu_murmur3 + * Public header for MurmurHash3 hash function implementation. + */ + +#ifndef AVUTIL_MURMUR3_H +#define AVUTIL_MURMUR3_H + +#include + +#include "version.h" + +/** + * @defgroup lavu_murmur3 Murmur3 + * @ingroup lavu_hash + * MurmurHash3 hash function implementation. + * + * MurmurHash3 is a non-cryptographic hash function, of which three + * incompatible versions were created by its inventor Austin Appleby: + * + * - 32-bit output + * - 128-bit output for 32-bit platforms + * - 128-bit output for 64-bit platforms + * + * FFmpeg only implements the last variant: 128-bit output designed for 64-bit + * platforms. Even though the hash function was designed for 64-bit platforms, + * the function in reality works on 32-bit systems too, only with reduced + * performance. + * + * @anchor lavu_murmur3_seedinfo + * By design, MurmurHash3 requires a seed to operate. In response to this, + * libavutil provides two functions for hash initiation, one that requires a + * seed (av_murmur3_init_seeded()) and one that uses a fixed arbitrary integer + * as the seed, and therefore does not (av_murmur3_init()). + * + * To make hashes comparable, you should provide the same seed for all calls to + * this hash function -- if you are supplying one yourself, that is. + * + * @{ + */ + +/** + * Allocate an AVMurMur3 hash context. + * + * @return Uninitialized hash context or `NULL` in case of error + */ +struct AVMurMur3 *av_murmur3_alloc(void); + +/** + * Initialize or reinitialize an AVMurMur3 hash context with a seed. + * + * @param[out] c Hash context + * @param[in] seed Random seed + * + * @see av_murmur3_init() + * @see @ref lavu_murmur3_seedinfo "Detailed description" on a discussion of + * seeds for MurmurHash3. + */ +void av_murmur3_init_seeded(struct AVMurMur3 *c, uint64_t seed); + +/** + * Initialize or reinitialize an AVMurMur3 hash context. + * + * Equivalent to av_murmur3_init_seeded() with a built-in seed. + * + * @param[out] c Hash context + * + * @see av_murmur3_init_seeded() + * @see @ref lavu_murmur3_seedinfo "Detailed description" on a discussion of + * seeds for MurmurHash3. + */ +void av_murmur3_init(struct AVMurMur3 *c); + +/** + * Update hash context with new data. + * + * @param[out] c Hash context + * @param[in] src Input data to update hash with + * @param[in] len Number of bytes to read from `src` + */ +#if FF_API_CRYPTO_SIZE_T +void av_murmur3_update(struct AVMurMur3 *c, const uint8_t *src, int len); +#else +void av_murmur3_update(struct AVMurMur3 *c, const uint8_t *src, size_t len); +#endif + +/** + * Finish hashing and output digest value. + * + * @param[in,out] c Hash context + * @param[out] dst Buffer where output digest value is stored + */ +void av_murmur3_final(struct AVMurMur3 *c, uint8_t dst[16]); + +/** + * @} + */ + +#endif /* AVUTIL_MURMUR3_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/opt.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/opt.h new file mode 100644 index 0000000..e461195 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/opt.h @@ -0,0 +1,871 @@ +/* + * AVOptions + * copyright (c) 2005 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_OPT_H +#define AVUTIL_OPT_H + +/** + * @file + * AVOptions + */ + +#include "rational.h" +#include "avutil.h" +#include "dict.h" +#include "log.h" +#include "pixfmt.h" +#include "samplefmt.h" +#include "version.h" + +/** + * @defgroup avoptions AVOptions + * @ingroup lavu_data + * @{ + * AVOptions provide a generic system to declare options on arbitrary structs + * ("objects"). An option can have a help text, a type and a range of possible + * values. Options may then be enumerated, read and written to. + * + * @section avoptions_implement Implementing AVOptions + * This section describes how to add AVOptions capabilities to a struct. + * + * All AVOptions-related information is stored in an AVClass. Therefore + * the first member of the struct should be a pointer to an AVClass describing it. + * The option field of the AVClass must be set to a NULL-terminated static array + * of AVOptions. Each AVOption must have a non-empty name, a type, a default + * value and for number-type AVOptions also a range of allowed values. It must + * also declare an offset in bytes from the start of the struct, where the field + * associated with this AVOption is located. Other fields in the AVOption struct + * should also be set when applicable, but are not required. + * + * The following example illustrates an AVOptions-enabled struct: + * @code + * typedef struct test_struct { + * const AVClass *class; + * int int_opt; + * char *str_opt; + * uint8_t *bin_opt; + * int bin_len; + * } test_struct; + * + * static const AVOption test_options[] = { + * { "test_int", "This is a test option of int type.", offsetof(test_struct, int_opt), + * AV_OPT_TYPE_INT, { .i64 = -1 }, INT_MIN, INT_MAX }, + * { "test_str", "This is a test option of string type.", offsetof(test_struct, str_opt), + * AV_OPT_TYPE_STRING }, + * { "test_bin", "This is a test option of binary type.", offsetof(test_struct, bin_opt), + * AV_OPT_TYPE_BINARY }, + * { NULL }, + * }; + * + * static const AVClass test_class = { + * .class_name = "test class", + * .item_name = av_default_item_name, + * .option = test_options, + * .version = LIBAVUTIL_VERSION_INT, + * }; + * @endcode + * + * Next, when allocating your struct, you must ensure that the AVClass pointer + * is set to the correct value. Then, av_opt_set_defaults() can be called to + * initialize defaults. After that the struct is ready to be used with the + * AVOptions API. + * + * When cleaning up, you may use the av_opt_free() function to automatically + * free all the allocated string and binary options. + * + * Continuing with the above example: + * + * @code + * test_struct *alloc_test_struct(void) + * { + * test_struct *ret = av_mallocz(sizeof(*ret)); + * ret->class = &test_class; + * av_opt_set_defaults(ret); + * return ret; + * } + * void free_test_struct(test_struct **foo) + * { + * av_opt_free(*foo); + * av_freep(foo); + * } + * @endcode + * + * @subsection avoptions_implement_nesting Nesting + * It may happen that an AVOptions-enabled struct contains another + * AVOptions-enabled struct as a member (e.g. AVCodecContext in + * libavcodec exports generic options, while its priv_data field exports + * codec-specific options). In such a case, it is possible to set up the + * parent struct to export a child's options. To do that, simply + * implement AVClass.child_next() and AVClass.child_class_next() in the + * parent struct's AVClass. + * Assuming that the test_struct from above now also contains a + * child_struct field: + * + * @code + * typedef struct child_struct { + * AVClass *class; + * int flags_opt; + * } child_struct; + * static const AVOption child_opts[] = { + * { "test_flags", "This is a test option of flags type.", + * offsetof(child_struct, flags_opt), AV_OPT_TYPE_FLAGS, { .i64 = 0 }, INT_MIN, INT_MAX }, + * { NULL }, + * }; + * static const AVClass child_class = { + * .class_name = "child class", + * .item_name = av_default_item_name, + * .option = child_opts, + * .version = LIBAVUTIL_VERSION_INT, + * }; + * + * void *child_next(void *obj, void *prev) + * { + * test_struct *t = obj; + * if (!prev && t->child_struct) + * return t->child_struct; + * return NULL + * } + * const AVClass child_class_next(const AVClass *prev) + * { + * return prev ? NULL : &child_class; + * } + * @endcode + * Putting child_next() and child_class_next() as defined above into + * test_class will now make child_struct's options accessible through + * test_struct (again, proper setup as described above needs to be done on + * child_struct right after it is created). + * + * From the above example it might not be clear why both child_next() + * and child_class_next() are needed. The distinction is that child_next() + * iterates over actually existing objects, while child_class_next() + * iterates over all possible child classes. E.g. if an AVCodecContext + * was initialized to use a codec which has private options, then its + * child_next() will return AVCodecContext.priv_data and finish + * iterating. OTOH child_class_next() on AVCodecContext.av_class will + * iterate over all available codecs with private options. + * + * @subsection avoptions_implement_named_constants Named constants + * It is possible to create named constants for options. Simply set the unit + * field of the option the constants should apply to a string and + * create the constants themselves as options of type AV_OPT_TYPE_CONST + * with their unit field set to the same string. + * Their default_val field should contain the value of the named + * constant. + * For example, to add some named constants for the test_flags option + * above, put the following into the child_opts array: + * @code + * { "test_flags", "This is a test option of flags type.", + * offsetof(child_struct, flags_opt), AV_OPT_TYPE_FLAGS, { .i64 = 0 }, INT_MIN, INT_MAX, "test_unit" }, + * { "flag1", "This is a flag with value 16", 0, AV_OPT_TYPE_CONST, { .i64 = 16 }, 0, 0, "test_unit" }, + * @endcode + * + * @section avoptions_use Using AVOptions + * This section deals with accessing options in an AVOptions-enabled struct. + * Such structs in FFmpeg are e.g. AVCodecContext in libavcodec or + * AVFormatContext in libavformat. + * + * @subsection avoptions_use_examine Examining AVOptions + * The basic functions for examining options are av_opt_next(), which iterates + * over all options defined for one object, and av_opt_find(), which searches + * for an option with the given name. + * + * The situation is more complicated with nesting. An AVOptions-enabled struct + * may have AVOptions-enabled children. Passing the AV_OPT_SEARCH_CHILDREN flag + * to av_opt_find() will make the function search children recursively. + * + * For enumerating there are basically two cases. The first is when you want to + * get all options that may potentially exist on the struct and its children + * (e.g. when constructing documentation). In that case you should call + * av_opt_child_class_next() recursively on the parent struct's AVClass. The + * second case is when you have an already initialized struct with all its + * children and you want to get all options that can be actually written or read + * from it. In that case you should call av_opt_child_next() recursively (and + * av_opt_next() on each result). + * + * @subsection avoptions_use_get_set Reading and writing AVOptions + * When setting options, you often have a string read directly from the + * user. In such a case, simply passing it to av_opt_set() is enough. For + * non-string type options, av_opt_set() will parse the string according to the + * option type. + * + * Similarly av_opt_get() will read any option type and convert it to a string + * which will be returned. Do not forget that the string is allocated, so you + * have to free it with av_free(). + * + * In some cases it may be more convenient to put all options into an + * AVDictionary and call av_opt_set_dict() on it. A specific case of this + * are the format/codec open functions in lavf/lavc which take a dictionary + * filled with option as a parameter. This makes it possible to set some options + * that cannot be set otherwise, since e.g. the input file format is not known + * before the file is actually opened. + */ + +enum AVOptionType{ + AV_OPT_TYPE_FLAGS, + AV_OPT_TYPE_INT, + AV_OPT_TYPE_INT64, + AV_OPT_TYPE_DOUBLE, + AV_OPT_TYPE_FLOAT, + AV_OPT_TYPE_STRING, + AV_OPT_TYPE_RATIONAL, + AV_OPT_TYPE_BINARY, ///< offset must point to a pointer immediately followed by an int for the length + AV_OPT_TYPE_DICT, + AV_OPT_TYPE_UINT64, + AV_OPT_TYPE_CONST, + AV_OPT_TYPE_IMAGE_SIZE, ///< offset must point to two consecutive integers + AV_OPT_TYPE_PIXEL_FMT, + AV_OPT_TYPE_SAMPLE_FMT, + AV_OPT_TYPE_VIDEO_RATE, ///< offset must point to AVRational + AV_OPT_TYPE_DURATION, + AV_OPT_TYPE_COLOR, + AV_OPT_TYPE_CHANNEL_LAYOUT, + AV_OPT_TYPE_BOOL, +}; + +/** + * AVOption + */ +typedef struct AVOption { + const char *name; + + /** + * short English help text + * @todo What about other languages? + */ + const char *help; + + /** + * The offset relative to the context structure where the option + * value is stored. It should be 0 for named constants. + */ + int offset; + enum AVOptionType type; + + /** + * the default value for scalar options + */ + union { + int64_t i64; + double dbl; + const char *str; + /* TODO those are unused now */ + AVRational q; + } default_val; + double min; ///< minimum valid value for the option + double max; ///< maximum valid value for the option + + int flags; +#define AV_OPT_FLAG_ENCODING_PARAM 1 ///< a generic parameter which can be set by the user for muxing or encoding +#define AV_OPT_FLAG_DECODING_PARAM 2 ///< a generic parameter which can be set by the user for demuxing or decoding +#define AV_OPT_FLAG_AUDIO_PARAM 8 +#define AV_OPT_FLAG_VIDEO_PARAM 16 +#define AV_OPT_FLAG_SUBTITLE_PARAM 32 +/** + * The option is intended for exporting values to the caller. + */ +#define AV_OPT_FLAG_EXPORT 64 +/** + * The option may not be set through the AVOptions API, only read. + * This flag only makes sense when AV_OPT_FLAG_EXPORT is also set. + */ +#define AV_OPT_FLAG_READONLY 128 +#define AV_OPT_FLAG_BSF_PARAM (1<<8) ///< a generic parameter which can be set by the user for bit stream filtering +#define AV_OPT_FLAG_RUNTIME_PARAM (1<<15) ///< a generic parameter which can be set by the user at runtime +#define AV_OPT_FLAG_FILTERING_PARAM (1<<16) ///< a generic parameter which can be set by the user for filtering +#define AV_OPT_FLAG_DEPRECATED (1<<17) ///< set if option is deprecated, users should refer to AVOption.help text for more information +#define AV_OPT_FLAG_CHILD_CONSTS (1<<18) ///< set if option constants can also reside in child objects +//FIXME think about enc-audio, ... style flags + + /** + * The logical unit to which the option belongs. Non-constant + * options and corresponding named constants share the same + * unit. May be NULL. + */ + const char *unit; +} AVOption; + +/** + * A single allowed range of values, or a single allowed value. + */ +typedef struct AVOptionRange { + const char *str; + /** + * Value range. + * For string ranges this represents the min/max length. + * For dimensions this represents the min/max pixel count or width/height in multi-component case. + */ + double value_min, value_max; + /** + * Value's component range. + * For string this represents the unicode range for chars, 0-127 limits to ASCII. + */ + double component_min, component_max; + /** + * Range flag. + * If set to 1 the struct encodes a range, if set to 0 a single value. + */ + int is_range; +} AVOptionRange; + +/** + * List of AVOptionRange structs. + */ +typedef struct AVOptionRanges { + /** + * Array of option ranges. + * + * Most of option types use just one component. + * Following describes multi-component option types: + * + * AV_OPT_TYPE_IMAGE_SIZE: + * component index 0: range of pixel count (width * height). + * component index 1: range of width. + * component index 2: range of height. + * + * @note To obtain multi-component version of this structure, user must + * provide AV_OPT_MULTI_COMPONENT_RANGE to av_opt_query_ranges or + * av_opt_query_ranges_default function. + * + * Multi-component range can be read as in following example: + * + * @code + * int range_index, component_index; + * AVOptionRanges *ranges; + * AVOptionRange *range[3]; //may require more than 3 in the future. + * av_opt_query_ranges(&ranges, obj, key, AV_OPT_MULTI_COMPONENT_RANGE); + * for (range_index = 0; range_index < ranges->nb_ranges; range_index++) { + * for (component_index = 0; component_index < ranges->nb_components; component_index++) + * range[component_index] = ranges->range[ranges->nb_ranges * component_index + range_index]; + * //do something with range here. + * } + * av_opt_freep_ranges(&ranges); + * @endcode + */ + AVOptionRange **range; + /** + * Number of ranges per component. + */ + int nb_ranges; + /** + * Number of componentes. + */ + int nb_components; +} AVOptionRanges; + +/** + * Show the obj options. + * + * @param req_flags requested flags for the options to show. Show only the + * options for which it is opt->flags & req_flags. + * @param rej_flags rejected flags for the options to show. Show only the + * options for which it is !(opt->flags & req_flags). + * @param av_log_obj log context to use for showing the options + */ +int av_opt_show2(void *obj, void *av_log_obj, int req_flags, int rej_flags); + +/** + * Set the values of all AVOption fields to their default values. + * + * @param s an AVOption-enabled struct (its first member must be a pointer to AVClass) + */ +void av_opt_set_defaults(void *s); + +/** + * Set the values of all AVOption fields to their default values. Only these + * AVOption fields for which (opt->flags & mask) == flags will have their + * default applied to s. + * + * @param s an AVOption-enabled struct (its first member must be a pointer to AVClass) + * @param mask combination of AV_OPT_FLAG_* + * @param flags combination of AV_OPT_FLAG_* + */ +void av_opt_set_defaults2(void *s, int mask, int flags); + +/** + * Parse the key/value pairs list in opts. For each key/value pair + * found, stores the value in the field in ctx that is named like the + * key. ctx must be an AVClass context, storing is done using + * AVOptions. + * + * @param opts options string to parse, may be NULL + * @param key_val_sep a 0-terminated list of characters used to + * separate key from value + * @param pairs_sep a 0-terminated list of characters used to separate + * two pairs from each other + * @return the number of successfully set key/value pairs, or a negative + * value corresponding to an AVERROR code in case of error: + * AVERROR(EINVAL) if opts cannot be parsed, + * the error code issued by av_opt_set() if a key/value pair + * cannot be set + */ +int av_set_options_string(void *ctx, const char *opts, + const char *key_val_sep, const char *pairs_sep); + +/** + * Parse the key-value pairs list in opts. For each key=value pair found, + * set the value of the corresponding option in ctx. + * + * @param ctx the AVClass object to set options on + * @param opts the options string, key-value pairs separated by a + * delimiter + * @param shorthand a NULL-terminated array of options names for shorthand + * notation: if the first field in opts has no key part, + * the key is taken from the first element of shorthand; + * then again for the second, etc., until either opts is + * finished, shorthand is finished or a named option is + * found; after that, all options must be named + * @param key_val_sep a 0-terminated list of characters used to separate + * key from value, for example '=' + * @param pairs_sep a 0-terminated list of characters used to separate + * two pairs from each other, for example ':' or ',' + * @return the number of successfully set key=value pairs, or a negative + * value corresponding to an AVERROR code in case of error: + * AVERROR(EINVAL) if opts cannot be parsed, + * the error code issued by av_set_string3() if a key/value pair + * cannot be set + * + * Options names must use only the following characters: a-z A-Z 0-9 - . / _ + * Separators must use characters distinct from option names and from each + * other. + */ +int av_opt_set_from_string(void *ctx, const char *opts, + const char *const *shorthand, + const char *key_val_sep, const char *pairs_sep); +/** + * Free all allocated objects in obj. + */ +void av_opt_free(void *obj); + +/** + * Check whether a particular flag is set in a flags field. + * + * @param field_name the name of the flag field option + * @param flag_name the name of the flag to check + * @return non-zero if the flag is set, zero if the flag isn't set, + * isn't of the right type, or the flags field doesn't exist. + */ +int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name); + +/** + * Set all the options from a given dictionary on an object. + * + * @param obj a struct whose first element is a pointer to AVClass + * @param options options to process. This dictionary will be freed and replaced + * by a new one containing all options not found in obj. + * Of course this new dictionary needs to be freed by caller + * with av_dict_free(). + * + * @return 0 on success, a negative AVERROR if some option was found in obj, + * but could not be set. + * + * @see av_dict_copy() + */ +int av_opt_set_dict(void *obj, struct AVDictionary **options); + + +/** + * Set all the options from a given dictionary on an object. + * + * @param obj a struct whose first element is a pointer to AVClass + * @param options options to process. This dictionary will be freed and replaced + * by a new one containing all options not found in obj. + * Of course this new dictionary needs to be freed by caller + * with av_dict_free(). + * @param search_flags A combination of AV_OPT_SEARCH_*. + * + * @return 0 on success, a negative AVERROR if some option was found in obj, + * but could not be set. + * + * @see av_dict_copy() + */ +int av_opt_set_dict2(void *obj, struct AVDictionary **options, int search_flags); + +/** + * Extract a key-value pair from the beginning of a string. + * + * @param ropts pointer to the options string, will be updated to + * point to the rest of the string (one of the pairs_sep + * or the final NUL) + * @param key_val_sep a 0-terminated list of characters used to separate + * key from value, for example '=' + * @param pairs_sep a 0-terminated list of characters used to separate + * two pairs from each other, for example ':' or ',' + * @param flags flags; see the AV_OPT_FLAG_* values below + * @param rkey parsed key; must be freed using av_free() + * @param rval parsed value; must be freed using av_free() + * + * @return >=0 for success, or a negative value corresponding to an + * AVERROR code in case of error; in particular: + * AVERROR(EINVAL) if no key is present + * + */ +int av_opt_get_key_value(const char **ropts, + const char *key_val_sep, const char *pairs_sep, + unsigned flags, + char **rkey, char **rval); + +enum { + + /** + * Accept to parse a value without a key; the key will then be returned + * as NULL. + */ + AV_OPT_FLAG_IMPLICIT_KEY = 1, +}; + +/** + * @defgroup opt_eval_funcs Evaluating option strings + * @{ + * This group of functions can be used to evaluate option strings + * and get numbers out of them. They do the same thing as av_opt_set(), + * except the result is written into the caller-supplied pointer. + * + * @param obj a struct whose first element is a pointer to AVClass. + * @param o an option for which the string is to be evaluated. + * @param val string to be evaluated. + * @param *_out value of the string will be written here. + * + * @return 0 on success, a negative number on failure. + */ +int av_opt_eval_flags (void *obj, const AVOption *o, const char *val, int *flags_out); +int av_opt_eval_int (void *obj, const AVOption *o, const char *val, int *int_out); +int av_opt_eval_int64 (void *obj, const AVOption *o, const char *val, int64_t *int64_out); +int av_opt_eval_float (void *obj, const AVOption *o, const char *val, float *float_out); +int av_opt_eval_double(void *obj, const AVOption *o, const char *val, double *double_out); +int av_opt_eval_q (void *obj, const AVOption *o, const char *val, AVRational *q_out); +/** + * @} + */ + +#define AV_OPT_SEARCH_CHILDREN (1 << 0) /**< Search in possible children of the + given object first. */ +/** + * The obj passed to av_opt_find() is fake -- only a double pointer to AVClass + * instead of a required pointer to a struct containing AVClass. This is + * useful for searching for options without needing to allocate the corresponding + * object. + */ +#define AV_OPT_SEARCH_FAKE_OBJ (1 << 1) + +/** + * In av_opt_get, return NULL if the option has a pointer type and is set to NULL, + * rather than returning an empty string. + */ +#define AV_OPT_ALLOW_NULL (1 << 2) + +/** + * Allows av_opt_query_ranges and av_opt_query_ranges_default to return more than + * one component for certain option types. + * @see AVOptionRanges for details. + */ +#define AV_OPT_MULTI_COMPONENT_RANGE (1 << 12) + +/** + * Look for an option in an object. Consider only options which + * have all the specified flags set. + * + * @param[in] obj A pointer to a struct whose first element is a + * pointer to an AVClass. + * Alternatively a double pointer to an AVClass, if + * AV_OPT_SEARCH_FAKE_OBJ search flag is set. + * @param[in] name The name of the option to look for. + * @param[in] unit When searching for named constants, name of the unit + * it belongs to. + * @param opt_flags Find only options with all the specified flags set (AV_OPT_FLAG). + * @param search_flags A combination of AV_OPT_SEARCH_*. + * + * @return A pointer to the option found, or NULL if no option + * was found. + * + * @note Options found with AV_OPT_SEARCH_CHILDREN flag may not be settable + * directly with av_opt_set(). Use special calls which take an options + * AVDictionary (e.g. avformat_open_input()) to set options found with this + * flag. + */ +const AVOption *av_opt_find(void *obj, const char *name, const char *unit, + int opt_flags, int search_flags); + +/** + * Look for an option in an object. Consider only options which + * have all the specified flags set. + * + * @param[in] obj A pointer to a struct whose first element is a + * pointer to an AVClass. + * Alternatively a double pointer to an AVClass, if + * AV_OPT_SEARCH_FAKE_OBJ search flag is set. + * @param[in] name The name of the option to look for. + * @param[in] unit When searching for named constants, name of the unit + * it belongs to. + * @param opt_flags Find only options with all the specified flags set (AV_OPT_FLAG). + * @param search_flags A combination of AV_OPT_SEARCH_*. + * @param[out] target_obj if non-NULL, an object to which the option belongs will be + * written here. It may be different from obj if AV_OPT_SEARCH_CHILDREN is present + * in search_flags. This parameter is ignored if search_flags contain + * AV_OPT_SEARCH_FAKE_OBJ. + * + * @return A pointer to the option found, or NULL if no option + * was found. + */ +const AVOption *av_opt_find2(void *obj, const char *name, const char *unit, + int opt_flags, int search_flags, void **target_obj); + +/** + * Iterate over all AVOptions belonging to obj. + * + * @param obj an AVOptions-enabled struct or a double pointer to an + * AVClass describing it. + * @param prev result of the previous call to av_opt_next() on this object + * or NULL + * @return next AVOption or NULL + */ +const AVOption *av_opt_next(const void *obj, const AVOption *prev); + +/** + * Iterate over AVOptions-enabled children of obj. + * + * @param prev result of a previous call to this function or NULL + * @return next AVOptions-enabled child or NULL + */ +void *av_opt_child_next(void *obj, void *prev); + +/** + * Iterate over potential AVOptions-enabled children of parent. + * + * @param prev result of a previous call to this function or NULL + * @return AVClass corresponding to next potential child or NULL + */ +const AVClass *av_opt_child_class_next(const AVClass *parent, const AVClass *prev); + +/** + * @defgroup opt_set_funcs Option setting functions + * @{ + * Those functions set the field of obj with the given name to value. + * + * @param[in] obj A struct whose first element is a pointer to an AVClass. + * @param[in] name the name of the field to set + * @param[in] val The value to set. In case of av_opt_set() if the field is not + * of a string type, then the given string is parsed. + * SI postfixes and some named scalars are supported. + * If the field is of a numeric type, it has to be a numeric or named + * scalar. Behavior with more than one scalar and +- infix operators + * is undefined. + * If the field is of a flags type, it has to be a sequence of numeric + * scalars or named flags separated by '+' or '-'. Prefixing a flag + * with '+' causes it to be set without affecting the other flags; + * similarly, '-' unsets a flag. + * If the field is of a dictionary type, it has to be a ':' separated list of + * key=value parameters. Values containing ':' special characters must be + * escaped. + * @param search_flags flags passed to av_opt_find2. I.e. if AV_OPT_SEARCH_CHILDREN + * is passed here, then the option may be set on a child of obj. + * + * @return 0 if the value has been set, or an AVERROR code in case of + * error: + * AVERROR_OPTION_NOT_FOUND if no matching option exists + * AVERROR(ERANGE) if the value is out of range + * AVERROR(EINVAL) if the value is not valid + */ +int av_opt_set (void *obj, const char *name, const char *val, int search_flags); +int av_opt_set_int (void *obj, const char *name, int64_t val, int search_flags); +int av_opt_set_double (void *obj, const char *name, double val, int search_flags); +int av_opt_set_q (void *obj, const char *name, AVRational val, int search_flags); +int av_opt_set_bin (void *obj, const char *name, const uint8_t *val, int size, int search_flags); +int av_opt_set_image_size(void *obj, const char *name, int w, int h, int search_flags); +int av_opt_set_pixel_fmt (void *obj, const char *name, enum AVPixelFormat fmt, int search_flags); +int av_opt_set_sample_fmt(void *obj, const char *name, enum AVSampleFormat fmt, int search_flags); +int av_opt_set_video_rate(void *obj, const char *name, AVRational val, int search_flags); +int av_opt_set_channel_layout(void *obj, const char *name, int64_t ch_layout, int search_flags); +/** + * @note Any old dictionary present is discarded and replaced with a copy of the new one. The + * caller still owns val is and responsible for freeing it. + */ +int av_opt_set_dict_val(void *obj, const char *name, const AVDictionary *val, int search_flags); + +/** + * Set a binary option to an integer list. + * + * @param obj AVClass object to set options on + * @param name name of the binary option + * @param val pointer to an integer list (must have the correct type with + * regard to the contents of the list) + * @param term list terminator (usually 0 or -1) + * @param flags search flags + */ +#define av_opt_set_int_list(obj, name, val, term, flags) \ + (av_int_list_length(val, term) > INT_MAX / sizeof(*(val)) ? \ + AVERROR(EINVAL) : \ + av_opt_set_bin(obj, name, (const uint8_t *)(val), \ + av_int_list_length(val, term) * sizeof(*(val)), flags)) + +/** + * @} + */ + +/** + * @defgroup opt_get_funcs Option getting functions + * @{ + * Those functions get a value of the option with the given name from an object. + * + * @param[in] obj a struct whose first element is a pointer to an AVClass. + * @param[in] name name of the option to get. + * @param[in] search_flags flags passed to av_opt_find2. I.e. if AV_OPT_SEARCH_CHILDREN + * is passed here, then the option may be found in a child of obj. + * @param[out] out_val value of the option will be written here + * @return >=0 on success, a negative error code otherwise + */ +/** + * @note the returned string will be av_malloc()ed and must be av_free()ed by the caller + * + * @note if AV_OPT_ALLOW_NULL is set in search_flags in av_opt_get, and the + * option is of type AV_OPT_TYPE_STRING, AV_OPT_TYPE_BINARY or AV_OPT_TYPE_DICT + * and is set to NULL, *out_val will be set to NULL instead of an allocated + * empty string. + */ +int av_opt_get (void *obj, const char *name, int search_flags, uint8_t **out_val); +int av_opt_get_int (void *obj, const char *name, int search_flags, int64_t *out_val); +int av_opt_get_double (void *obj, const char *name, int search_flags, double *out_val); +int av_opt_get_q (void *obj, const char *name, int search_flags, AVRational *out_val); +int av_opt_get_image_size(void *obj, const char *name, int search_flags, int *w_out, int *h_out); +int av_opt_get_pixel_fmt (void *obj, const char *name, int search_flags, enum AVPixelFormat *out_fmt); +int av_opt_get_sample_fmt(void *obj, const char *name, int search_flags, enum AVSampleFormat *out_fmt); +int av_opt_get_video_rate(void *obj, const char *name, int search_flags, AVRational *out_val); +int av_opt_get_channel_layout(void *obj, const char *name, int search_flags, int64_t *ch_layout); +/** + * @param[out] out_val The returned dictionary is a copy of the actual value and must + * be freed with av_dict_free() by the caller + */ +int av_opt_get_dict_val(void *obj, const char *name, int search_flags, AVDictionary **out_val); +/** + * @} + */ +/** + * Gets a pointer to the requested field in a struct. + * This function allows accessing a struct even when its fields are moved or + * renamed since the application making the access has been compiled, + * + * @returns a pointer to the field, it can be cast to the correct type and read + * or written to. + */ +void *av_opt_ptr(const AVClass *avclass, void *obj, const char *name); + +/** + * Free an AVOptionRanges struct and set it to NULL. + */ +void av_opt_freep_ranges(AVOptionRanges **ranges); + +/** + * Get a list of allowed ranges for the given option. + * + * The returned list may depend on other fields in obj like for example profile. + * + * @param flags is a bitmask of flags, undefined flags should not be set and should be ignored + * AV_OPT_SEARCH_FAKE_OBJ indicates that the obj is a double pointer to a AVClass instead of a full instance + * AV_OPT_MULTI_COMPONENT_RANGE indicates that function may return more than one component, @see AVOptionRanges + * + * The result must be freed with av_opt_freep_ranges. + * + * @return number of compontents returned on success, a negative errro code otherwise + */ +int av_opt_query_ranges(AVOptionRanges **, void *obj, const char *key, int flags); + +/** + * Copy options from src object into dest object. + * + * Options that require memory allocation (e.g. string or binary) are malloc'ed in dest object. + * Original memory allocated for such options is freed unless both src and dest options points to the same memory. + * + * @param dest Object to copy from + * @param src Object to copy into + * @return 0 on success, negative on error + */ +int av_opt_copy(void *dest, const void *src); + +/** + * Get a default list of allowed ranges for the given option. + * + * This list is constructed without using the AVClass.query_ranges() callback + * and can be used as fallback from within the callback. + * + * @param flags is a bitmask of flags, undefined flags should not be set and should be ignored + * AV_OPT_SEARCH_FAKE_OBJ indicates that the obj is a double pointer to a AVClass instead of a full instance + * AV_OPT_MULTI_COMPONENT_RANGE indicates that function may return more than one component, @see AVOptionRanges + * + * The result must be freed with av_opt_free_ranges. + * + * @return number of compontents returned on success, a negative errro code otherwise + */ +int av_opt_query_ranges_default(AVOptionRanges **, void *obj, const char *key, int flags); + +/** + * Check if given option is set to its default value. + * + * Options o must belong to the obj. This function must not be called to check child's options state. + * @see av_opt_is_set_to_default_by_name(). + * + * @param obj AVClass object to check option on + * @param o option to be checked + * @return >0 when option is set to its default, + * 0 when option is not set its default, + * <0 on error + */ +int av_opt_is_set_to_default(void *obj, const AVOption *o); + +/** + * Check if given option is set to its default value. + * + * @param obj AVClass object to check option on + * @param name option name + * @param search_flags combination of AV_OPT_SEARCH_* + * @return >0 when option is set to its default, + * 0 when option is not set its default, + * <0 on error + */ +int av_opt_is_set_to_default_by_name(void *obj, const char *name, int search_flags); + + +#define AV_OPT_SERIALIZE_SKIP_DEFAULTS 0x00000001 ///< Serialize options that are not set to default values only. +#define AV_OPT_SERIALIZE_OPT_FLAGS_EXACT 0x00000002 ///< Serialize options that exactly match opt_flags only. + +/** + * Serialize object's options. + * + * Create a string containing object's serialized options. + * Such string may be passed back to av_opt_set_from_string() in order to restore option values. + * A key/value or pairs separator occurring in the serialized value or + * name string are escaped through the av_escape() function. + * + * @param[in] obj AVClass object to serialize + * @param[in] opt_flags serialize options with all the specified flags set (AV_OPT_FLAG) + * @param[in] flags combination of AV_OPT_SERIALIZE_* flags + * @param[out] buffer Pointer to buffer that will be allocated with string containg serialized options. + * Buffer must be freed by the caller when is no longer needed. + * @param[in] key_val_sep character used to separate key from value + * @param[in] pairs_sep character used to separate two pairs from each other + * @return >= 0 on success, negative on error + * @warning Separators cannot be neither '\\' nor '\0'. They also cannot be the same. + */ +int av_opt_serialize(void *obj, int opt_flags, int flags, char **buffer, + const char key_val_sep, const char pairs_sep); +/** + * @} + */ + +#endif /* AVUTIL_OPT_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/parseutils.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/parseutils.h new file mode 100644 index 0000000..e66d24b --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/parseutils.h @@ -0,0 +1,193 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_PARSEUTILS_H +#define AVUTIL_PARSEUTILS_H + +#include + +#include "rational.h" + +/** + * @file + * misc parsing utilities + */ + +/** + * Parse str and store the parsed ratio in q. + * + * Note that a ratio with infinite (1/0) or negative value is + * considered valid, so you should check on the returned value if you + * want to exclude those values. + * + * The undefined value can be expressed using the "0:0" string. + * + * @param[in,out] q pointer to the AVRational which will contain the ratio + * @param[in] str the string to parse: it has to be a string in the format + * num:den, a float number or an expression + * @param[in] max the maximum allowed numerator and denominator + * @param[in] log_offset log level offset which is applied to the log + * level of log_ctx + * @param[in] log_ctx parent logging context + * @return >= 0 on success, a negative error code otherwise + */ +int av_parse_ratio(AVRational *q, const char *str, int max, + int log_offset, void *log_ctx); + +#define av_parse_ratio_quiet(rate, str, max) \ + av_parse_ratio(rate, str, max, AV_LOG_MAX_OFFSET, NULL) + +/** + * Parse str and put in width_ptr and height_ptr the detected values. + * + * @param[in,out] width_ptr pointer to the variable which will contain the detected + * width value + * @param[in,out] height_ptr pointer to the variable which will contain the detected + * height value + * @param[in] str the string to parse: it has to be a string in the format + * width x height or a valid video size abbreviation. + * @return >= 0 on success, a negative error code otherwise + */ +int av_parse_video_size(int *width_ptr, int *height_ptr, const char *str); + +/** + * Parse str and store the detected values in *rate. + * + * @param[in,out] rate pointer to the AVRational which will contain the detected + * frame rate + * @param[in] str the string to parse: it has to be a string in the format + * rate_num / rate_den, a float number or a valid video rate abbreviation + * @return >= 0 on success, a negative error code otherwise + */ +int av_parse_video_rate(AVRational *rate, const char *str); + +/** + * Put the RGBA values that correspond to color_string in rgba_color. + * + * @param color_string a string specifying a color. It can be the name of + * a color (case insensitive match) or a [0x|#]RRGGBB[AA] sequence, + * possibly followed by "@" and a string representing the alpha + * component. + * The alpha component may be a string composed by "0x" followed by an + * hexadecimal number or a decimal number between 0.0 and 1.0, which + * represents the opacity value (0x00/0.0 means completely transparent, + * 0xff/1.0 completely opaque). + * If the alpha component is not specified then 0xff is assumed. + * The string "random" will result in a random color. + * @param slen length of the initial part of color_string containing the + * color. It can be set to -1 if color_string is a null terminated string + * containing nothing else than the color. + * @return >= 0 in case of success, a negative value in case of + * failure (for example if color_string cannot be parsed). + */ +int av_parse_color(uint8_t *rgba_color, const char *color_string, int slen, + void *log_ctx); + +/** + * Get the name of a color from the internal table of hard-coded named + * colors. + * + * This function is meant to enumerate the color names recognized by + * av_parse_color(). + * + * @param color_idx index of the requested color, starting from 0 + * @param rgbp if not NULL, will point to a 3-elements array with the color value in RGB + * @return the color name string or NULL if color_idx is not in the array + */ +const char *av_get_known_color_name(int color_idx, const uint8_t **rgb); + +/** + * Parse timestr and return in *time a corresponding number of + * microseconds. + * + * @param timeval puts here the number of microseconds corresponding + * to the string in timestr. If the string represents a duration, it + * is the number of microseconds contained in the time interval. If + * the string is a date, is the number of microseconds since 1st of + * January, 1970 up to the time of the parsed date. If timestr cannot + * be successfully parsed, set *time to INT64_MIN. + + * @param timestr a string representing a date or a duration. + * - If a date the syntax is: + * @code + * [{YYYY-MM-DD|YYYYMMDD}[T|t| ]]{{HH:MM:SS[.m...]]]}|{HHMMSS[.m...]]]}}[Z] + * now + * @endcode + * If the value is "now" it takes the current time. + * Time is local time unless Z is appended, in which case it is + * interpreted as UTC. + * If the year-month-day part is not specified it takes the current + * year-month-day. + * - If a duration the syntax is: + * @code + * [-][HH:]MM:SS[.m...] + * [-]S+[.m...] + * @endcode + * @param duration flag which tells how to interpret timestr, if not + * zero timestr is interpreted as a duration, otherwise as a date + * @return >= 0 in case of success, a negative value corresponding to an + * AVERROR code otherwise + */ +int av_parse_time(int64_t *timeval, const char *timestr, int duration); + +/** + * Attempt to find a specific tag in a URL. + * + * syntax: '?tag1=val1&tag2=val2...'. Little URL decoding is done. + * Return 1 if found. + */ +int av_find_info_tag(char *arg, int arg_size, const char *tag1, const char *info); + +/** + * Simplified version of strptime + * + * Parse the input string p according to the format string fmt and + * store its results in the structure dt. + * This implementation supports only a subset of the formats supported + * by the standard strptime(). + * + * The supported input field descriptors are listed below. + * - %H: the hour as a decimal number, using a 24-hour clock, in the + * range '00' through '23' + * - %J: hours as a decimal number, in the range '0' through INT_MAX + * - %M: the minute as a decimal number, using a 24-hour clock, in the + * range '00' through '59' + * - %S: the second as a decimal number, using a 24-hour clock, in the + * range '00' through '59' + * - %Y: the year as a decimal number, using the Gregorian calendar + * - %m: the month as a decimal number, in the range '1' through '12' + * - %d: the day of the month as a decimal number, in the range '1' + * through '31' + * - %T: alias for '%H:%M:%S' + * - %%: a literal '%' + * + * @return a pointer to the first character not processed in this function + * call. In case the input string contains more characters than + * required by the format string the return value points right after + * the last consumed input character. In case the whole input string + * is consumed the return value points to the null byte at the end of + * the string. On failure NULL is returned. + */ +char *av_small_strptime(const char *p, const char *fmt, struct tm *dt); + +/** + * Convert the decomposed UTC time in tm to a time_t value. + */ +time_t av_timegm(struct tm *tm); + +#endif /* AVUTIL_PARSEUTILS_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/pixdesc.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/pixdesc.h new file mode 100644 index 0000000..c055810 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/pixdesc.h @@ -0,0 +1,440 @@ +/* + * pixel format descriptor + * Copyright (c) 2009 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_PIXDESC_H +#define AVUTIL_PIXDESC_H + +#include + +#include "attributes.h" +#include "pixfmt.h" +#include "version.h" + +typedef struct AVComponentDescriptor { + /** + * Which of the 4 planes contains the component. + */ + int plane; + + /** + * Number of elements between 2 horizontally consecutive pixels. + * Elements are bits for bitstream formats, bytes otherwise. + */ + int step; + + /** + * Number of elements before the component of the first pixel. + * Elements are bits for bitstream formats, bytes otherwise. + */ + int offset; + + /** + * Number of least significant bits that must be shifted away + * to get the value. + */ + int shift; + + /** + * Number of bits in the component. + */ + int depth; + +#if FF_API_PLUS1_MINUS1 + /** deprecated, use step instead */ + attribute_deprecated int step_minus1; + + /** deprecated, use depth instead */ + attribute_deprecated int depth_minus1; + + /** deprecated, use offset instead */ + attribute_deprecated int offset_plus1; +#endif +} AVComponentDescriptor; + +/** + * Descriptor that unambiguously describes how the bits of a pixel are + * stored in the up to 4 data planes of an image. It also stores the + * subsampling factors and number of components. + * + * @note This is separate of the colorspace (RGB, YCbCr, YPbPr, JPEG-style YUV + * and all the YUV variants) AVPixFmtDescriptor just stores how values + * are stored not what these values represent. + */ +typedef struct AVPixFmtDescriptor { + const char *name; + uint8_t nb_components; ///< The number of components each pixel has, (1-4) + + /** + * Amount to shift the luma width right to find the chroma width. + * For YV12 this is 1 for example. + * chroma_width = AV_CEIL_RSHIFT(luma_width, log2_chroma_w) + * The note above is needed to ensure rounding up. + * This value only refers to the chroma components. + */ + uint8_t log2_chroma_w; + + /** + * Amount to shift the luma height right to find the chroma height. + * For YV12 this is 1 for example. + * chroma_height= AV_CEIL_RSHIFT(luma_height, log2_chroma_h) + * The note above is needed to ensure rounding up. + * This value only refers to the chroma components. + */ + uint8_t log2_chroma_h; + + /** + * Combination of AV_PIX_FMT_FLAG_... flags. + */ + uint64_t flags; + + /** + * Parameters that describe how pixels are packed. + * If the format has 1 or 2 components, then luma is 0. + * If the format has 3 or 4 components: + * if the RGB flag is set then 0 is red, 1 is green and 2 is blue; + * otherwise 0 is luma, 1 is chroma-U and 2 is chroma-V. + * + * If present, the Alpha channel is always the last component. + */ + AVComponentDescriptor comp[4]; + + /** + * Alternative comma-separated names. + */ + const char *alias; +} AVPixFmtDescriptor; + +/** + * Pixel format is big-endian. + */ +#define AV_PIX_FMT_FLAG_BE (1 << 0) +/** + * Pixel format has a palette in data[1], values are indexes in this palette. + */ +#define AV_PIX_FMT_FLAG_PAL (1 << 1) +/** + * All values of a component are bit-wise packed end to end. + */ +#define AV_PIX_FMT_FLAG_BITSTREAM (1 << 2) +/** + * Pixel format is an HW accelerated format. + */ +#define AV_PIX_FMT_FLAG_HWACCEL (1 << 3) +/** + * At least one pixel component is not in the first data plane. + */ +#define AV_PIX_FMT_FLAG_PLANAR (1 << 4) +/** + * The pixel format contains RGB-like data (as opposed to YUV/grayscale). + */ +#define AV_PIX_FMT_FLAG_RGB (1 << 5) + +/** + * The pixel format is "pseudo-paletted". This means that it contains a + * fixed palette in the 2nd plane but the palette is fixed/constant for each + * PIX_FMT. This allows interpreting the data as if it was PAL8, which can + * in some cases be simpler. Or the data can be interpreted purely based on + * the pixel format without using the palette. + * An example of a pseudo-paletted format is AV_PIX_FMT_GRAY8 + * + * @deprecated This flag is deprecated, and will be removed. When it is removed, + * the extra palette allocation in AVFrame.data[1] is removed as well. Only + * actual paletted formats (as indicated by AV_PIX_FMT_FLAG_PAL) will have a + * palette. Starting with FFmpeg versions which have this flag deprecated, the + * extra "pseudo" palette is already ignored, and API users are not required to + * allocate a palette for AV_PIX_FMT_FLAG_PSEUDOPAL formats (it was required + * before the deprecation, though). + */ +#define AV_PIX_FMT_FLAG_PSEUDOPAL (1 << 6) + +/** + * The pixel format has an alpha channel. This is set on all formats that + * support alpha in some way, including AV_PIX_FMT_PAL8. The alpha is always + * straight, never pre-multiplied. + * + * If a codec or a filter does not support alpha, it should set all alpha to + * opaque, or use the equivalent pixel formats without alpha component, e.g. + * AV_PIX_FMT_RGB0 (or AV_PIX_FMT_RGB24 etc.) instead of AV_PIX_FMT_RGBA. + */ +#define AV_PIX_FMT_FLAG_ALPHA (1 << 7) + +/** + * The pixel format is following a Bayer pattern + */ +#define AV_PIX_FMT_FLAG_BAYER (1 << 8) + +/** + * The pixel format contains IEEE-754 floating point values. Precision (double, + * single, or half) should be determined by the pixel size (64, 32, or 16 bits). + */ +#define AV_PIX_FMT_FLAG_FLOAT (1 << 9) + +/** + * Return the number of bits per pixel used by the pixel format + * described by pixdesc. Note that this is not the same as the number + * of bits per sample. + * + * The returned number of bits refers to the number of bits actually + * used for storing the pixel information, that is padding bits are + * not counted. + */ +int av_get_bits_per_pixel(const AVPixFmtDescriptor *pixdesc); + +/** + * Return the number of bits per pixel for the pixel format + * described by pixdesc, including any padding or unused bits. + */ +int av_get_padded_bits_per_pixel(const AVPixFmtDescriptor *pixdesc); + +/** + * @return a pixel format descriptor for provided pixel format or NULL if + * this pixel format is unknown. + */ +const AVPixFmtDescriptor *av_pix_fmt_desc_get(enum AVPixelFormat pix_fmt); + +/** + * Iterate over all pixel format descriptors known to libavutil. + * + * @param prev previous descriptor. NULL to get the first descriptor. + * + * @return next descriptor or NULL after the last descriptor + */ +const AVPixFmtDescriptor *av_pix_fmt_desc_next(const AVPixFmtDescriptor *prev); + +/** + * @return an AVPixelFormat id described by desc, or AV_PIX_FMT_NONE if desc + * is not a valid pointer to a pixel format descriptor. + */ +enum AVPixelFormat av_pix_fmt_desc_get_id(const AVPixFmtDescriptor *desc); + +/** + * Utility function to access log2_chroma_w log2_chroma_h from + * the pixel format AVPixFmtDescriptor. + * + * @param[in] pix_fmt the pixel format + * @param[out] h_shift store log2_chroma_w (horizontal/width shift) + * @param[out] v_shift store log2_chroma_h (vertical/height shift) + * + * @return 0 on success, AVERROR(ENOSYS) on invalid or unknown pixel format + */ +int av_pix_fmt_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, + int *h_shift, int *v_shift); + +/** + * @return number of planes in pix_fmt, a negative AVERROR if pix_fmt is not a + * valid pixel format. + */ +int av_pix_fmt_count_planes(enum AVPixelFormat pix_fmt); + +/** + * @return the name for provided color range or NULL if unknown. + */ +const char *av_color_range_name(enum AVColorRange range); + +/** + * @return the AVColorRange value for name or an AVError if not found. + */ +int av_color_range_from_name(const char *name); + +/** + * @return the name for provided color primaries or NULL if unknown. + */ +const char *av_color_primaries_name(enum AVColorPrimaries primaries); + +/** + * @return the AVColorPrimaries value for name or an AVError if not found. + */ +int av_color_primaries_from_name(const char *name); + +/** + * @return the name for provided color transfer or NULL if unknown. + */ +const char *av_color_transfer_name(enum AVColorTransferCharacteristic transfer); + +/** + * @return the AVColorTransferCharacteristic value for name or an AVError if not found. + */ +int av_color_transfer_from_name(const char *name); + +/** + * @return the name for provided color space or NULL if unknown. + */ +const char *av_color_space_name(enum AVColorSpace space); + +/** + * @return the AVColorSpace value for name or an AVError if not found. + */ +int av_color_space_from_name(const char *name); + +/** + * @return the name for provided chroma location or NULL if unknown. + */ +const char *av_chroma_location_name(enum AVChromaLocation location); + +/** + * @return the AVChromaLocation value for name or an AVError if not found. + */ +int av_chroma_location_from_name(const char *name); + +/** + * Return the pixel format corresponding to name. + * + * If there is no pixel format with name name, then looks for a + * pixel format with the name corresponding to the native endian + * format of name. + * For example in a little-endian system, first looks for "gray16", + * then for "gray16le". + * + * Finally if no pixel format has been found, returns AV_PIX_FMT_NONE. + */ +enum AVPixelFormat av_get_pix_fmt(const char *name); + +/** + * Return the short name for a pixel format, NULL in case pix_fmt is + * unknown. + * + * @see av_get_pix_fmt(), av_get_pix_fmt_string() + */ +const char *av_get_pix_fmt_name(enum AVPixelFormat pix_fmt); + +/** + * Print in buf the string corresponding to the pixel format with + * number pix_fmt, or a header if pix_fmt is negative. + * + * @param buf the buffer where to write the string + * @param buf_size the size of buf + * @param pix_fmt the number of the pixel format to print the + * corresponding info string, or a negative value to print the + * corresponding header. + */ +char *av_get_pix_fmt_string(char *buf, int buf_size, + enum AVPixelFormat pix_fmt); + +/** + * Read a line from an image, and write the values of the + * pixel format component c to dst. + * + * @param data the array containing the pointers to the planes of the image + * @param linesize the array containing the linesizes of the image + * @param desc the pixel format descriptor for the image + * @param x the horizontal coordinate of the first pixel to read + * @param y the vertical coordinate of the first pixel to read + * @param w the width of the line to read, that is the number of + * values to write to dst + * @param read_pal_component if not zero and the format is a paletted + * format writes the values corresponding to the palette + * component c in data[1] to dst, rather than the palette indexes in + * data[0]. The behavior is undefined if the format is not paletted. + * @param dst_element_size size of elements in dst array (2 or 4 byte) + */ +void av_read_image_line2(void *dst, const uint8_t *data[4], + const int linesize[4], const AVPixFmtDescriptor *desc, + int x, int y, int c, int w, int read_pal_component, + int dst_element_size); + +void av_read_image_line(uint16_t *dst, const uint8_t *data[4], + const int linesize[4], const AVPixFmtDescriptor *desc, + int x, int y, int c, int w, int read_pal_component); + +/** + * Write the values from src to the pixel format component c of an + * image line. + * + * @param src array containing the values to write + * @param data the array containing the pointers to the planes of the + * image to write into. It is supposed to be zeroed. + * @param linesize the array containing the linesizes of the image + * @param desc the pixel format descriptor for the image + * @param x the horizontal coordinate of the first pixel to write + * @param y the vertical coordinate of the first pixel to write + * @param w the width of the line to write, that is the number of + * values to write to the image line + * @param src_element_size size of elements in src array (2 or 4 byte) + */ +void av_write_image_line2(const void *src, uint8_t *data[4], + const int linesize[4], const AVPixFmtDescriptor *desc, + int x, int y, int c, int w, int src_element_size); + +void av_write_image_line(const uint16_t *src, uint8_t *data[4], + const int linesize[4], const AVPixFmtDescriptor *desc, + int x, int y, int c, int w); + +/** + * Utility function to swap the endianness of a pixel format. + * + * @param[in] pix_fmt the pixel format + * + * @return pixel format with swapped endianness if it exists, + * otherwise AV_PIX_FMT_NONE + */ +enum AVPixelFormat av_pix_fmt_swap_endianness(enum AVPixelFormat pix_fmt); + +#define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */ +#define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */ +#define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */ +#define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */ +#define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */ +#define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */ + +/** + * Compute what kind of losses will occur when converting from one specific + * pixel format to another. + * When converting from one pixel format to another, information loss may occur. + * For example, when converting from RGB24 to GRAY, the color information will + * be lost. Similarly, other losses occur when converting from some formats to + * other formats. These losses can involve loss of chroma, but also loss of + * resolution, loss of color depth, loss due to the color space conversion, loss + * of the alpha bits or loss due to color quantization. + * av_get_fix_fmt_loss() informs you about the various types of losses + * which will occur when converting from one pixel format to another. + * + * @param[in] dst_pix_fmt destination pixel format + * @param[in] src_pix_fmt source pixel format + * @param[in] has_alpha Whether the source pixel format alpha channel is used. + * @return Combination of flags informing you what kind of losses will occur + * (maximum loss for an invalid dst_pix_fmt). + */ +int av_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, + enum AVPixelFormat src_pix_fmt, + int has_alpha); + +/** + * Compute what kind of losses will occur when converting from one specific + * pixel format to another. + * When converting from one pixel format to another, information loss may occur. + * For example, when converting from RGB24 to GRAY, the color information will + * be lost. Similarly, other losses occur when converting from some formats to + * other formats. These losses can involve loss of chroma, but also loss of + * resolution, loss of color depth, loss due to the color space conversion, loss + * of the alpha bits or loss due to color quantization. + * av_get_fix_fmt_loss() informs you about the various types of losses + * which will occur when converting from one pixel format to another. + * + * @param[in] dst_pix_fmt destination pixel format + * @param[in] src_pix_fmt source pixel format + * @param[in] has_alpha Whether the source pixel format alpha channel is used. + * @return Combination of flags informing you what kind of losses will occur + * (maximum loss for an invalid dst_pix_fmt). + */ +enum AVPixelFormat av_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2, + enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr); + +#endif /* AVUTIL_PIXDESC_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/pixelutils.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/pixelutils.h new file mode 100644 index 0000000..a8dbc15 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/pixelutils.h @@ -0,0 +1,52 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_PIXELUTILS_H +#define AVUTIL_PIXELUTILS_H + +#include +#include +#include "common.h" + +/** + * Sum of abs(src1[x] - src2[x]) + */ +typedef int (*av_pixelutils_sad_fn)(const uint8_t *src1, ptrdiff_t stride1, + const uint8_t *src2, ptrdiff_t stride2); + +/** + * Get a potentially optimized pointer to a Sum-of-absolute-differences + * function (see the av_pixelutils_sad_fn prototype). + * + * @param w_bits 1< + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_PIXFMT_H +#define AVUTIL_PIXFMT_H + +/** + * @file + * pixel format definitions + */ + +#include "libavutil/avconfig.h" +#include "version.h" + +#define AVPALETTE_SIZE 1024 +#define AVPALETTE_COUNT 256 + +/** + * Pixel format. + * + * @note + * AV_PIX_FMT_RGB32 is handled in an endian-specific manner. An RGBA + * color is put together as: + * (A << 24) | (R << 16) | (G << 8) | B + * This is stored as BGRA on little-endian CPU architectures and ARGB on + * big-endian CPUs. + * + * @note + * If the resolution is not a multiple of the chroma subsampling factor + * then the chroma plane resolution must be rounded up. + * + * @par + * When the pixel format is palettized RGB32 (AV_PIX_FMT_PAL8), the palettized + * image data is stored in AVFrame.data[0]. The palette is transported in + * AVFrame.data[1], is 1024 bytes long (256 4-byte entries) and is + * formatted the same as in AV_PIX_FMT_RGB32 described above (i.e., it is + * also endian-specific). Note also that the individual RGB32 palette + * components stored in AVFrame.data[1] should be in the range 0..255. + * This is important as many custom PAL8 video codecs that were designed + * to run on the IBM VGA graphics adapter use 6-bit palette components. + * + * @par + * For all the 8 bits per pixel formats, an RGB32 palette is in data[1] like + * for pal8. This palette is filled in automatically by the function + * allocating the picture. + */ +enum AVPixelFormat { + AV_PIX_FMT_NONE = -1, + AV_PIX_FMT_YUV420P, ///< planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples) + AV_PIX_FMT_YUYV422, ///< packed YUV 4:2:2, 16bpp, Y0 Cb Y1 Cr + AV_PIX_FMT_RGB24, ///< packed RGB 8:8:8, 24bpp, RGBRGB... + AV_PIX_FMT_BGR24, ///< packed RGB 8:8:8, 24bpp, BGRBGR... + AV_PIX_FMT_YUV422P, ///< planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples) + AV_PIX_FMT_YUV444P, ///< planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples) + AV_PIX_FMT_YUV410P, ///< planar YUV 4:1:0, 9bpp, (1 Cr & Cb sample per 4x4 Y samples) + AV_PIX_FMT_YUV411P, ///< planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples) + AV_PIX_FMT_GRAY8, ///< Y , 8bpp + AV_PIX_FMT_MONOWHITE, ///< Y , 1bpp, 0 is white, 1 is black, in each byte pixels are ordered from the msb to the lsb + AV_PIX_FMT_MONOBLACK, ///< Y , 1bpp, 0 is black, 1 is white, in each byte pixels are ordered from the msb to the lsb + AV_PIX_FMT_PAL8, ///< 8 bits with AV_PIX_FMT_RGB32 palette + AV_PIX_FMT_YUVJ420P, ///< planar YUV 4:2:0, 12bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV420P and setting color_range + AV_PIX_FMT_YUVJ422P, ///< planar YUV 4:2:2, 16bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV422P and setting color_range + AV_PIX_FMT_YUVJ444P, ///< planar YUV 4:4:4, 24bpp, full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV444P and setting color_range + AV_PIX_FMT_UYVY422, ///< packed YUV 4:2:2, 16bpp, Cb Y0 Cr Y1 + AV_PIX_FMT_UYYVYY411, ///< packed YUV 4:1:1, 12bpp, Cb Y0 Y1 Cr Y2 Y3 + AV_PIX_FMT_BGR8, ///< packed RGB 3:3:2, 8bpp, (msb)2B 3G 3R(lsb) + AV_PIX_FMT_BGR4, ///< packed RGB 1:2:1 bitstream, 4bpp, (msb)1B 2G 1R(lsb), a byte contains two pixels, the first pixel in the byte is the one composed by the 4 msb bits + AV_PIX_FMT_BGR4_BYTE, ///< packed RGB 1:2:1, 8bpp, (msb)1B 2G 1R(lsb) + AV_PIX_FMT_RGB8, ///< packed RGB 3:3:2, 8bpp, (msb)2R 3G 3B(lsb) + AV_PIX_FMT_RGB4, ///< packed RGB 1:2:1 bitstream, 4bpp, (msb)1R 2G 1B(lsb), a byte contains two pixels, the first pixel in the byte is the one composed by the 4 msb bits + AV_PIX_FMT_RGB4_BYTE, ///< packed RGB 1:2:1, 8bpp, (msb)1R 2G 1B(lsb) + AV_PIX_FMT_NV12, ///< planar YUV 4:2:0, 12bpp, 1 plane for Y and 1 plane for the UV components, which are interleaved (first byte U and the following byte V) + AV_PIX_FMT_NV21, ///< as above, but U and V bytes are swapped + + AV_PIX_FMT_ARGB, ///< packed ARGB 8:8:8:8, 32bpp, ARGBARGB... + AV_PIX_FMT_RGBA, ///< packed RGBA 8:8:8:8, 32bpp, RGBARGBA... + AV_PIX_FMT_ABGR, ///< packed ABGR 8:8:8:8, 32bpp, ABGRABGR... + AV_PIX_FMT_BGRA, ///< packed BGRA 8:8:8:8, 32bpp, BGRABGRA... + + AV_PIX_FMT_GRAY16BE, ///< Y , 16bpp, big-endian + AV_PIX_FMT_GRAY16LE, ///< Y , 16bpp, little-endian + AV_PIX_FMT_YUV440P, ///< planar YUV 4:4:0 (1 Cr & Cb sample per 1x2 Y samples) + AV_PIX_FMT_YUVJ440P, ///< planar YUV 4:4:0 full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV440P and setting color_range + AV_PIX_FMT_YUVA420P, ///< planar YUV 4:2:0, 20bpp, (1 Cr & Cb sample per 2x2 Y & A samples) + AV_PIX_FMT_RGB48BE, ///< packed RGB 16:16:16, 48bpp, 16R, 16G, 16B, the 2-byte value for each R/G/B component is stored as big-endian + AV_PIX_FMT_RGB48LE, ///< packed RGB 16:16:16, 48bpp, 16R, 16G, 16B, the 2-byte value for each R/G/B component is stored as little-endian + + AV_PIX_FMT_RGB565BE, ///< packed RGB 5:6:5, 16bpp, (msb) 5R 6G 5B(lsb), big-endian + AV_PIX_FMT_RGB565LE, ///< packed RGB 5:6:5, 16bpp, (msb) 5R 6G 5B(lsb), little-endian + AV_PIX_FMT_RGB555BE, ///< packed RGB 5:5:5, 16bpp, (msb)1X 5R 5G 5B(lsb), big-endian , X=unused/undefined + AV_PIX_FMT_RGB555LE, ///< packed RGB 5:5:5, 16bpp, (msb)1X 5R 5G 5B(lsb), little-endian, X=unused/undefined + + AV_PIX_FMT_BGR565BE, ///< packed BGR 5:6:5, 16bpp, (msb) 5B 6G 5R(lsb), big-endian + AV_PIX_FMT_BGR565LE, ///< packed BGR 5:6:5, 16bpp, (msb) 5B 6G 5R(lsb), little-endian + AV_PIX_FMT_BGR555BE, ///< packed BGR 5:5:5, 16bpp, (msb)1X 5B 5G 5R(lsb), big-endian , X=unused/undefined + AV_PIX_FMT_BGR555LE, ///< packed BGR 5:5:5, 16bpp, (msb)1X 5B 5G 5R(lsb), little-endian, X=unused/undefined + +#if FF_API_VAAPI + /** @name Deprecated pixel formats */ + /**@{*/ + AV_PIX_FMT_VAAPI_MOCO, ///< HW acceleration through VA API at motion compensation entry-point, Picture.data[3] contains a vaapi_render_state struct which contains macroblocks as well as various fields extracted from headers + AV_PIX_FMT_VAAPI_IDCT, ///< HW acceleration through VA API at IDCT entry-point, Picture.data[3] contains a vaapi_render_state struct which contains fields extracted from headers + AV_PIX_FMT_VAAPI_VLD, ///< HW decoding through VA API, Picture.data[3] contains a VASurfaceID + /**@}*/ + AV_PIX_FMT_VAAPI = AV_PIX_FMT_VAAPI_VLD, +#else + /** + * Hardware acceleration through VA-API, data[3] contains a + * VASurfaceID. + */ + AV_PIX_FMT_VAAPI, +#endif + + AV_PIX_FMT_YUV420P16LE, ///< planar YUV 4:2:0, 24bpp, (1 Cr & Cb sample per 2x2 Y samples), little-endian + AV_PIX_FMT_YUV420P16BE, ///< planar YUV 4:2:0, 24bpp, (1 Cr & Cb sample per 2x2 Y samples), big-endian + AV_PIX_FMT_YUV422P16LE, ///< planar YUV 4:2:2, 32bpp, (1 Cr & Cb sample per 2x1 Y samples), little-endian + AV_PIX_FMT_YUV422P16BE, ///< planar YUV 4:2:2, 32bpp, (1 Cr & Cb sample per 2x1 Y samples), big-endian + AV_PIX_FMT_YUV444P16LE, ///< planar YUV 4:4:4, 48bpp, (1 Cr & Cb sample per 1x1 Y samples), little-endian + AV_PIX_FMT_YUV444P16BE, ///< planar YUV 4:4:4, 48bpp, (1 Cr & Cb sample per 1x1 Y samples), big-endian + AV_PIX_FMT_DXVA2_VLD, ///< HW decoding through DXVA2, Picture.data[3] contains a LPDIRECT3DSURFACE9 pointer + + AV_PIX_FMT_RGB444LE, ///< packed RGB 4:4:4, 16bpp, (msb)4X 4R 4G 4B(lsb), little-endian, X=unused/undefined + AV_PIX_FMT_RGB444BE, ///< packed RGB 4:4:4, 16bpp, (msb)4X 4R 4G 4B(lsb), big-endian, X=unused/undefined + AV_PIX_FMT_BGR444LE, ///< packed BGR 4:4:4, 16bpp, (msb)4X 4B 4G 4R(lsb), little-endian, X=unused/undefined + AV_PIX_FMT_BGR444BE, ///< packed BGR 4:4:4, 16bpp, (msb)4X 4B 4G 4R(lsb), big-endian, X=unused/undefined + AV_PIX_FMT_YA8, ///< 8 bits gray, 8 bits alpha + + AV_PIX_FMT_Y400A = AV_PIX_FMT_YA8, ///< alias for AV_PIX_FMT_YA8 + AV_PIX_FMT_GRAY8A= AV_PIX_FMT_YA8, ///< alias for AV_PIX_FMT_YA8 + + AV_PIX_FMT_BGR48BE, ///< packed RGB 16:16:16, 48bpp, 16B, 16G, 16R, the 2-byte value for each R/G/B component is stored as big-endian + AV_PIX_FMT_BGR48LE, ///< packed RGB 16:16:16, 48bpp, 16B, 16G, 16R, the 2-byte value for each R/G/B component is stored as little-endian + + /** + * The following 12 formats have the disadvantage of needing 1 format for each bit depth. + * Notice that each 9/10 bits sample is stored in 16 bits with extra padding. + * If you want to support multiple bit depths, then using AV_PIX_FMT_YUV420P16* with the bpp stored separately is better. + */ + AV_PIX_FMT_YUV420P9BE, ///< planar YUV 4:2:0, 13.5bpp, (1 Cr & Cb sample per 2x2 Y samples), big-endian + AV_PIX_FMT_YUV420P9LE, ///< planar YUV 4:2:0, 13.5bpp, (1 Cr & Cb sample per 2x2 Y samples), little-endian + AV_PIX_FMT_YUV420P10BE,///< planar YUV 4:2:0, 15bpp, (1 Cr & Cb sample per 2x2 Y samples), big-endian + AV_PIX_FMT_YUV420P10LE,///< planar YUV 4:2:0, 15bpp, (1 Cr & Cb sample per 2x2 Y samples), little-endian + AV_PIX_FMT_YUV422P10BE,///< planar YUV 4:2:2, 20bpp, (1 Cr & Cb sample per 2x1 Y samples), big-endian + AV_PIX_FMT_YUV422P10LE,///< planar YUV 4:2:2, 20bpp, (1 Cr & Cb sample per 2x1 Y samples), little-endian + AV_PIX_FMT_YUV444P9BE, ///< planar YUV 4:4:4, 27bpp, (1 Cr & Cb sample per 1x1 Y samples), big-endian + AV_PIX_FMT_YUV444P9LE, ///< planar YUV 4:4:4, 27bpp, (1 Cr & Cb sample per 1x1 Y samples), little-endian + AV_PIX_FMT_YUV444P10BE,///< planar YUV 4:4:4, 30bpp, (1 Cr & Cb sample per 1x1 Y samples), big-endian + AV_PIX_FMT_YUV444P10LE,///< planar YUV 4:4:4, 30bpp, (1 Cr & Cb sample per 1x1 Y samples), little-endian + AV_PIX_FMT_YUV422P9BE, ///< planar YUV 4:2:2, 18bpp, (1 Cr & Cb sample per 2x1 Y samples), big-endian + AV_PIX_FMT_YUV422P9LE, ///< planar YUV 4:2:2, 18bpp, (1 Cr & Cb sample per 2x1 Y samples), little-endian + AV_PIX_FMT_GBRP, ///< planar GBR 4:4:4 24bpp + AV_PIX_FMT_GBR24P = AV_PIX_FMT_GBRP, // alias for #AV_PIX_FMT_GBRP + AV_PIX_FMT_GBRP9BE, ///< planar GBR 4:4:4 27bpp, big-endian + AV_PIX_FMT_GBRP9LE, ///< planar GBR 4:4:4 27bpp, little-endian + AV_PIX_FMT_GBRP10BE, ///< planar GBR 4:4:4 30bpp, big-endian + AV_PIX_FMT_GBRP10LE, ///< planar GBR 4:4:4 30bpp, little-endian + AV_PIX_FMT_GBRP16BE, ///< planar GBR 4:4:4 48bpp, big-endian + AV_PIX_FMT_GBRP16LE, ///< planar GBR 4:4:4 48bpp, little-endian + AV_PIX_FMT_YUVA422P, ///< planar YUV 4:2:2 24bpp, (1 Cr & Cb sample per 2x1 Y & A samples) + AV_PIX_FMT_YUVA444P, ///< planar YUV 4:4:4 32bpp, (1 Cr & Cb sample per 1x1 Y & A samples) + AV_PIX_FMT_YUVA420P9BE, ///< planar YUV 4:2:0 22.5bpp, (1 Cr & Cb sample per 2x2 Y & A samples), big-endian + AV_PIX_FMT_YUVA420P9LE, ///< planar YUV 4:2:0 22.5bpp, (1 Cr & Cb sample per 2x2 Y & A samples), little-endian + AV_PIX_FMT_YUVA422P9BE, ///< planar YUV 4:2:2 27bpp, (1 Cr & Cb sample per 2x1 Y & A samples), big-endian + AV_PIX_FMT_YUVA422P9LE, ///< planar YUV 4:2:2 27bpp, (1 Cr & Cb sample per 2x1 Y & A samples), little-endian + AV_PIX_FMT_YUVA444P9BE, ///< planar YUV 4:4:4 36bpp, (1 Cr & Cb sample per 1x1 Y & A samples), big-endian + AV_PIX_FMT_YUVA444P9LE, ///< planar YUV 4:4:4 36bpp, (1 Cr & Cb sample per 1x1 Y & A samples), little-endian + AV_PIX_FMT_YUVA420P10BE, ///< planar YUV 4:2:0 25bpp, (1 Cr & Cb sample per 2x2 Y & A samples, big-endian) + AV_PIX_FMT_YUVA420P10LE, ///< planar YUV 4:2:0 25bpp, (1 Cr & Cb sample per 2x2 Y & A samples, little-endian) + AV_PIX_FMT_YUVA422P10BE, ///< planar YUV 4:2:2 30bpp, (1 Cr & Cb sample per 2x1 Y & A samples, big-endian) + AV_PIX_FMT_YUVA422P10LE, ///< planar YUV 4:2:2 30bpp, (1 Cr & Cb sample per 2x1 Y & A samples, little-endian) + AV_PIX_FMT_YUVA444P10BE, ///< planar YUV 4:4:4 40bpp, (1 Cr & Cb sample per 1x1 Y & A samples, big-endian) + AV_PIX_FMT_YUVA444P10LE, ///< planar YUV 4:4:4 40bpp, (1 Cr & Cb sample per 1x1 Y & A samples, little-endian) + AV_PIX_FMT_YUVA420P16BE, ///< planar YUV 4:2:0 40bpp, (1 Cr & Cb sample per 2x2 Y & A samples, big-endian) + AV_PIX_FMT_YUVA420P16LE, ///< planar YUV 4:2:0 40bpp, (1 Cr & Cb sample per 2x2 Y & A samples, little-endian) + AV_PIX_FMT_YUVA422P16BE, ///< planar YUV 4:2:2 48bpp, (1 Cr & Cb sample per 2x1 Y & A samples, big-endian) + AV_PIX_FMT_YUVA422P16LE, ///< planar YUV 4:2:2 48bpp, (1 Cr & Cb sample per 2x1 Y & A samples, little-endian) + AV_PIX_FMT_YUVA444P16BE, ///< planar YUV 4:4:4 64bpp, (1 Cr & Cb sample per 1x1 Y & A samples, big-endian) + AV_PIX_FMT_YUVA444P16LE, ///< planar YUV 4:4:4 64bpp, (1 Cr & Cb sample per 1x1 Y & A samples, little-endian) + + AV_PIX_FMT_VDPAU, ///< HW acceleration through VDPAU, Picture.data[3] contains a VdpVideoSurface + + AV_PIX_FMT_XYZ12LE, ///< packed XYZ 4:4:4, 36 bpp, (msb) 12X, 12Y, 12Z (lsb), the 2-byte value for each X/Y/Z is stored as little-endian, the 4 lower bits are set to 0 + AV_PIX_FMT_XYZ12BE, ///< packed XYZ 4:4:4, 36 bpp, (msb) 12X, 12Y, 12Z (lsb), the 2-byte value for each X/Y/Z is stored as big-endian, the 4 lower bits are set to 0 + AV_PIX_FMT_NV16, ///< interleaved chroma YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples) + AV_PIX_FMT_NV20LE, ///< interleaved chroma YUV 4:2:2, 20bpp, (1 Cr & Cb sample per 2x1 Y samples), little-endian + AV_PIX_FMT_NV20BE, ///< interleaved chroma YUV 4:2:2, 20bpp, (1 Cr & Cb sample per 2x1 Y samples), big-endian + + AV_PIX_FMT_RGBA64BE, ///< packed RGBA 16:16:16:16, 64bpp, 16R, 16G, 16B, 16A, the 2-byte value for each R/G/B/A component is stored as big-endian + AV_PIX_FMT_RGBA64LE, ///< packed RGBA 16:16:16:16, 64bpp, 16R, 16G, 16B, 16A, the 2-byte value for each R/G/B/A component is stored as little-endian + AV_PIX_FMT_BGRA64BE, ///< packed RGBA 16:16:16:16, 64bpp, 16B, 16G, 16R, 16A, the 2-byte value for each R/G/B/A component is stored as big-endian + AV_PIX_FMT_BGRA64LE, ///< packed RGBA 16:16:16:16, 64bpp, 16B, 16G, 16R, 16A, the 2-byte value for each R/G/B/A component is stored as little-endian + + AV_PIX_FMT_YVYU422, ///< packed YUV 4:2:2, 16bpp, Y0 Cr Y1 Cb + + AV_PIX_FMT_YA16BE, ///< 16 bits gray, 16 bits alpha (big-endian) + AV_PIX_FMT_YA16LE, ///< 16 bits gray, 16 bits alpha (little-endian) + + AV_PIX_FMT_GBRAP, ///< planar GBRA 4:4:4:4 32bpp + AV_PIX_FMT_GBRAP16BE, ///< planar GBRA 4:4:4:4 64bpp, big-endian + AV_PIX_FMT_GBRAP16LE, ///< planar GBRA 4:4:4:4 64bpp, little-endian + /** + * HW acceleration through QSV, data[3] contains a pointer to the + * mfxFrameSurface1 structure. + */ + AV_PIX_FMT_QSV, + /** + * HW acceleration though MMAL, data[3] contains a pointer to the + * MMAL_BUFFER_HEADER_T structure. + */ + AV_PIX_FMT_MMAL, + + AV_PIX_FMT_D3D11VA_VLD, ///< HW decoding through Direct3D11 via old API, Picture.data[3] contains a ID3D11VideoDecoderOutputView pointer + + /** + * HW acceleration through CUDA. data[i] contain CUdeviceptr pointers + * exactly as for system memory frames. + */ + AV_PIX_FMT_CUDA, + + AV_PIX_FMT_0RGB, ///< packed RGB 8:8:8, 32bpp, XRGBXRGB... X=unused/undefined + AV_PIX_FMT_RGB0, ///< packed RGB 8:8:8, 32bpp, RGBXRGBX... X=unused/undefined + AV_PIX_FMT_0BGR, ///< packed BGR 8:8:8, 32bpp, XBGRXBGR... X=unused/undefined + AV_PIX_FMT_BGR0, ///< packed BGR 8:8:8, 32bpp, BGRXBGRX... X=unused/undefined + + AV_PIX_FMT_YUV420P12BE, ///< planar YUV 4:2:0,18bpp, (1 Cr & Cb sample per 2x2 Y samples), big-endian + AV_PIX_FMT_YUV420P12LE, ///< planar YUV 4:2:0,18bpp, (1 Cr & Cb sample per 2x2 Y samples), little-endian + AV_PIX_FMT_YUV420P14BE, ///< planar YUV 4:2:0,21bpp, (1 Cr & Cb sample per 2x2 Y samples), big-endian + AV_PIX_FMT_YUV420P14LE, ///< planar YUV 4:2:0,21bpp, (1 Cr & Cb sample per 2x2 Y samples), little-endian + AV_PIX_FMT_YUV422P12BE, ///< planar YUV 4:2:2,24bpp, (1 Cr & Cb sample per 2x1 Y samples), big-endian + AV_PIX_FMT_YUV422P12LE, ///< planar YUV 4:2:2,24bpp, (1 Cr & Cb sample per 2x1 Y samples), little-endian + AV_PIX_FMT_YUV422P14BE, ///< planar YUV 4:2:2,28bpp, (1 Cr & Cb sample per 2x1 Y samples), big-endian + AV_PIX_FMT_YUV422P14LE, ///< planar YUV 4:2:2,28bpp, (1 Cr & Cb sample per 2x1 Y samples), little-endian + AV_PIX_FMT_YUV444P12BE, ///< planar YUV 4:4:4,36bpp, (1 Cr & Cb sample per 1x1 Y samples), big-endian + AV_PIX_FMT_YUV444P12LE, ///< planar YUV 4:4:4,36bpp, (1 Cr & Cb sample per 1x1 Y samples), little-endian + AV_PIX_FMT_YUV444P14BE, ///< planar YUV 4:4:4,42bpp, (1 Cr & Cb sample per 1x1 Y samples), big-endian + AV_PIX_FMT_YUV444P14LE, ///< planar YUV 4:4:4,42bpp, (1 Cr & Cb sample per 1x1 Y samples), little-endian + AV_PIX_FMT_GBRP12BE, ///< planar GBR 4:4:4 36bpp, big-endian + AV_PIX_FMT_GBRP12LE, ///< planar GBR 4:4:4 36bpp, little-endian + AV_PIX_FMT_GBRP14BE, ///< planar GBR 4:4:4 42bpp, big-endian + AV_PIX_FMT_GBRP14LE, ///< planar GBR 4:4:4 42bpp, little-endian + AV_PIX_FMT_YUVJ411P, ///< planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples) full scale (JPEG), deprecated in favor of AV_PIX_FMT_YUV411P and setting color_range + + AV_PIX_FMT_BAYER_BGGR8, ///< bayer, BGBG..(odd line), GRGR..(even line), 8-bit samples + AV_PIX_FMT_BAYER_RGGB8, ///< bayer, RGRG..(odd line), GBGB..(even line), 8-bit samples + AV_PIX_FMT_BAYER_GBRG8, ///< bayer, GBGB..(odd line), RGRG..(even line), 8-bit samples + AV_PIX_FMT_BAYER_GRBG8, ///< bayer, GRGR..(odd line), BGBG..(even line), 8-bit samples + AV_PIX_FMT_BAYER_BGGR16LE, ///< bayer, BGBG..(odd line), GRGR..(even line), 16-bit samples, little-endian + AV_PIX_FMT_BAYER_BGGR16BE, ///< bayer, BGBG..(odd line), GRGR..(even line), 16-bit samples, big-endian + AV_PIX_FMT_BAYER_RGGB16LE, ///< bayer, RGRG..(odd line), GBGB..(even line), 16-bit samples, little-endian + AV_PIX_FMT_BAYER_RGGB16BE, ///< bayer, RGRG..(odd line), GBGB..(even line), 16-bit samples, big-endian + AV_PIX_FMT_BAYER_GBRG16LE, ///< bayer, GBGB..(odd line), RGRG..(even line), 16-bit samples, little-endian + AV_PIX_FMT_BAYER_GBRG16BE, ///< bayer, GBGB..(odd line), RGRG..(even line), 16-bit samples, big-endian + AV_PIX_FMT_BAYER_GRBG16LE, ///< bayer, GRGR..(odd line), BGBG..(even line), 16-bit samples, little-endian + AV_PIX_FMT_BAYER_GRBG16BE, ///< bayer, GRGR..(odd line), BGBG..(even line), 16-bit samples, big-endian + + AV_PIX_FMT_XVMC,///< XVideo Motion Acceleration via common packet passing + + AV_PIX_FMT_YUV440P10LE, ///< planar YUV 4:4:0,20bpp, (1 Cr & Cb sample per 1x2 Y samples), little-endian + AV_PIX_FMT_YUV440P10BE, ///< planar YUV 4:4:0,20bpp, (1 Cr & Cb sample per 1x2 Y samples), big-endian + AV_PIX_FMT_YUV440P12LE, ///< planar YUV 4:4:0,24bpp, (1 Cr & Cb sample per 1x2 Y samples), little-endian + AV_PIX_FMT_YUV440P12BE, ///< planar YUV 4:4:0,24bpp, (1 Cr & Cb sample per 1x2 Y samples), big-endian + AV_PIX_FMT_AYUV64LE, ///< packed AYUV 4:4:4,64bpp (1 Cr & Cb sample per 1x1 Y & A samples), little-endian + AV_PIX_FMT_AYUV64BE, ///< packed AYUV 4:4:4,64bpp (1 Cr & Cb sample per 1x1 Y & A samples), big-endian + + AV_PIX_FMT_VIDEOTOOLBOX, ///< hardware decoding through Videotoolbox + + AV_PIX_FMT_P010LE, ///< like NV12, with 10bpp per component, data in the high bits, zeros in the low bits, little-endian + AV_PIX_FMT_P010BE, ///< like NV12, with 10bpp per component, data in the high bits, zeros in the low bits, big-endian + + AV_PIX_FMT_GBRAP12BE, ///< planar GBR 4:4:4:4 48bpp, big-endian + AV_PIX_FMT_GBRAP12LE, ///< planar GBR 4:4:4:4 48bpp, little-endian + + AV_PIX_FMT_GBRAP10BE, ///< planar GBR 4:4:4:4 40bpp, big-endian + AV_PIX_FMT_GBRAP10LE, ///< planar GBR 4:4:4:4 40bpp, little-endian + + AV_PIX_FMT_MEDIACODEC, ///< hardware decoding through MediaCodec + + AV_PIX_FMT_GRAY12BE, ///< Y , 12bpp, big-endian + AV_PIX_FMT_GRAY12LE, ///< Y , 12bpp, little-endian + AV_PIX_FMT_GRAY10BE, ///< Y , 10bpp, big-endian + AV_PIX_FMT_GRAY10LE, ///< Y , 10bpp, little-endian + + AV_PIX_FMT_P016LE, ///< like NV12, with 16bpp per component, little-endian + AV_PIX_FMT_P016BE, ///< like NV12, with 16bpp per component, big-endian + + /** + * Hardware surfaces for Direct3D11. + * + * This is preferred over the legacy AV_PIX_FMT_D3D11VA_VLD. The new D3D11 + * hwaccel API and filtering support AV_PIX_FMT_D3D11 only. + * + * data[0] contains a ID3D11Texture2D pointer, and data[1] contains the + * texture array index of the frame as intptr_t if the ID3D11Texture2D is + * an array texture (or always 0 if it's a normal texture). + */ + AV_PIX_FMT_D3D11, + + AV_PIX_FMT_GRAY9BE, ///< Y , 9bpp, big-endian + AV_PIX_FMT_GRAY9LE, ///< Y , 9bpp, little-endian + + AV_PIX_FMT_GBRPF32BE, ///< IEEE-754 single precision planar GBR 4:4:4, 96bpp, big-endian + AV_PIX_FMT_GBRPF32LE, ///< IEEE-754 single precision planar GBR 4:4:4, 96bpp, little-endian + AV_PIX_FMT_GBRAPF32BE, ///< IEEE-754 single precision planar GBRA 4:4:4:4, 128bpp, big-endian + AV_PIX_FMT_GBRAPF32LE, ///< IEEE-754 single precision planar GBRA 4:4:4:4, 128bpp, little-endian + + /** + * DRM-managed buffers exposed through PRIME buffer sharing. + * + * data[0] points to an AVDRMFrameDescriptor. + */ + AV_PIX_FMT_DRM_PRIME, + /** + * Hardware surfaces for OpenCL. + * + * data[i] contain 2D image objects (typed in C as cl_mem, used + * in OpenCL as image2d_t) for each plane of the surface. + */ + AV_PIX_FMT_OPENCL, + + AV_PIX_FMT_GRAY14BE, ///< Y , 14bpp, big-endian + AV_PIX_FMT_GRAY14LE, ///< Y , 14bpp, little-endian + + AV_PIX_FMT_GRAYF32BE, ///< IEEE-754 single precision Y, 32bpp, big-endian + AV_PIX_FMT_GRAYF32LE, ///< IEEE-754 single precision Y, 32bpp, little-endian + + AV_PIX_FMT_YUVA422P12BE, ///< planar YUV 4:2:2,24bpp, (1 Cr & Cb sample per 2x1 Y samples), 12b alpha, big-endian + AV_PIX_FMT_YUVA422P12LE, ///< planar YUV 4:2:2,24bpp, (1 Cr & Cb sample per 2x1 Y samples), 12b alpha, little-endian + AV_PIX_FMT_YUVA444P12BE, ///< planar YUV 4:4:4,36bpp, (1 Cr & Cb sample per 1x1 Y samples), 12b alpha, big-endian + AV_PIX_FMT_YUVA444P12LE, ///< planar YUV 4:4:4,36bpp, (1 Cr & Cb sample per 1x1 Y samples), 12b alpha, little-endian + + AV_PIX_FMT_NV24, ///< planar YUV 4:4:4, 24bpp, 1 plane for Y and 1 plane for the UV components, which are interleaved (first byte U and the following byte V) + AV_PIX_FMT_NV42, ///< as above, but U and V bytes are swapped + + /** + * Vulkan hardware images. + * + * data[0] points to an AVVkFrame + */ + AV_PIX_FMT_VULKAN, + + AV_PIX_FMT_Y210BE, ///< packed YUV 4:2:2 like YUYV422, 20bpp, data in the high bits, big-endian + AV_PIX_FMT_Y210LE, ///< packed YUV 4:2:2 like YUYV422, 20bpp, data in the high bits, little-endian + + AV_PIX_FMT_NB ///< number of pixel formats, DO NOT USE THIS if you want to link with shared libav* because the number of formats might differ between versions +}; + +#if AV_HAVE_BIGENDIAN +# define AV_PIX_FMT_NE(be, le) AV_PIX_FMT_##be +#else +# define AV_PIX_FMT_NE(be, le) AV_PIX_FMT_##le +#endif + +#define AV_PIX_FMT_RGB32 AV_PIX_FMT_NE(ARGB, BGRA) +#define AV_PIX_FMT_RGB32_1 AV_PIX_FMT_NE(RGBA, ABGR) +#define AV_PIX_FMT_BGR32 AV_PIX_FMT_NE(ABGR, RGBA) +#define AV_PIX_FMT_BGR32_1 AV_PIX_FMT_NE(BGRA, ARGB) +#define AV_PIX_FMT_0RGB32 AV_PIX_FMT_NE(0RGB, BGR0) +#define AV_PIX_FMT_0BGR32 AV_PIX_FMT_NE(0BGR, RGB0) + +#define AV_PIX_FMT_GRAY9 AV_PIX_FMT_NE(GRAY9BE, GRAY9LE) +#define AV_PIX_FMT_GRAY10 AV_PIX_FMT_NE(GRAY10BE, GRAY10LE) +#define AV_PIX_FMT_GRAY12 AV_PIX_FMT_NE(GRAY12BE, GRAY12LE) +#define AV_PIX_FMT_GRAY14 AV_PIX_FMT_NE(GRAY14BE, GRAY14LE) +#define AV_PIX_FMT_GRAY16 AV_PIX_FMT_NE(GRAY16BE, GRAY16LE) +#define AV_PIX_FMT_YA16 AV_PIX_FMT_NE(YA16BE, YA16LE) +#define AV_PIX_FMT_RGB48 AV_PIX_FMT_NE(RGB48BE, RGB48LE) +#define AV_PIX_FMT_RGB565 AV_PIX_FMT_NE(RGB565BE, RGB565LE) +#define AV_PIX_FMT_RGB555 AV_PIX_FMT_NE(RGB555BE, RGB555LE) +#define AV_PIX_FMT_RGB444 AV_PIX_FMT_NE(RGB444BE, RGB444LE) +#define AV_PIX_FMT_RGBA64 AV_PIX_FMT_NE(RGBA64BE, RGBA64LE) +#define AV_PIX_FMT_BGR48 AV_PIX_FMT_NE(BGR48BE, BGR48LE) +#define AV_PIX_FMT_BGR565 AV_PIX_FMT_NE(BGR565BE, BGR565LE) +#define AV_PIX_FMT_BGR555 AV_PIX_FMT_NE(BGR555BE, BGR555LE) +#define AV_PIX_FMT_BGR444 AV_PIX_FMT_NE(BGR444BE, BGR444LE) +#define AV_PIX_FMT_BGRA64 AV_PIX_FMT_NE(BGRA64BE, BGRA64LE) + +#define AV_PIX_FMT_YUV420P9 AV_PIX_FMT_NE(YUV420P9BE , YUV420P9LE) +#define AV_PIX_FMT_YUV422P9 AV_PIX_FMT_NE(YUV422P9BE , YUV422P9LE) +#define AV_PIX_FMT_YUV444P9 AV_PIX_FMT_NE(YUV444P9BE , YUV444P9LE) +#define AV_PIX_FMT_YUV420P10 AV_PIX_FMT_NE(YUV420P10BE, YUV420P10LE) +#define AV_PIX_FMT_YUV422P10 AV_PIX_FMT_NE(YUV422P10BE, YUV422P10LE) +#define AV_PIX_FMT_YUV440P10 AV_PIX_FMT_NE(YUV440P10BE, YUV440P10LE) +#define AV_PIX_FMT_YUV444P10 AV_PIX_FMT_NE(YUV444P10BE, YUV444P10LE) +#define AV_PIX_FMT_YUV420P12 AV_PIX_FMT_NE(YUV420P12BE, YUV420P12LE) +#define AV_PIX_FMT_YUV422P12 AV_PIX_FMT_NE(YUV422P12BE, YUV422P12LE) +#define AV_PIX_FMT_YUV440P12 AV_PIX_FMT_NE(YUV440P12BE, YUV440P12LE) +#define AV_PIX_FMT_YUV444P12 AV_PIX_FMT_NE(YUV444P12BE, YUV444P12LE) +#define AV_PIX_FMT_YUV420P14 AV_PIX_FMT_NE(YUV420P14BE, YUV420P14LE) +#define AV_PIX_FMT_YUV422P14 AV_PIX_FMT_NE(YUV422P14BE, YUV422P14LE) +#define AV_PIX_FMT_YUV444P14 AV_PIX_FMT_NE(YUV444P14BE, YUV444P14LE) +#define AV_PIX_FMT_YUV420P16 AV_PIX_FMT_NE(YUV420P16BE, YUV420P16LE) +#define AV_PIX_FMT_YUV422P16 AV_PIX_FMT_NE(YUV422P16BE, YUV422P16LE) +#define AV_PIX_FMT_YUV444P16 AV_PIX_FMT_NE(YUV444P16BE, YUV444P16LE) + +#define AV_PIX_FMT_GBRP9 AV_PIX_FMT_NE(GBRP9BE , GBRP9LE) +#define AV_PIX_FMT_GBRP10 AV_PIX_FMT_NE(GBRP10BE, GBRP10LE) +#define AV_PIX_FMT_GBRP12 AV_PIX_FMT_NE(GBRP12BE, GBRP12LE) +#define AV_PIX_FMT_GBRP14 AV_PIX_FMT_NE(GBRP14BE, GBRP14LE) +#define AV_PIX_FMT_GBRP16 AV_PIX_FMT_NE(GBRP16BE, GBRP16LE) +#define AV_PIX_FMT_GBRAP10 AV_PIX_FMT_NE(GBRAP10BE, GBRAP10LE) +#define AV_PIX_FMT_GBRAP12 AV_PIX_FMT_NE(GBRAP12BE, GBRAP12LE) +#define AV_PIX_FMT_GBRAP16 AV_PIX_FMT_NE(GBRAP16BE, GBRAP16LE) + +#define AV_PIX_FMT_BAYER_BGGR16 AV_PIX_FMT_NE(BAYER_BGGR16BE, BAYER_BGGR16LE) +#define AV_PIX_FMT_BAYER_RGGB16 AV_PIX_FMT_NE(BAYER_RGGB16BE, BAYER_RGGB16LE) +#define AV_PIX_FMT_BAYER_GBRG16 AV_PIX_FMT_NE(BAYER_GBRG16BE, BAYER_GBRG16LE) +#define AV_PIX_FMT_BAYER_GRBG16 AV_PIX_FMT_NE(BAYER_GRBG16BE, BAYER_GRBG16LE) + +#define AV_PIX_FMT_GBRPF32 AV_PIX_FMT_NE(GBRPF32BE, GBRPF32LE) +#define AV_PIX_FMT_GBRAPF32 AV_PIX_FMT_NE(GBRAPF32BE, GBRAPF32LE) + +#define AV_PIX_FMT_GRAYF32 AV_PIX_FMT_NE(GRAYF32BE, GRAYF32LE) + +#define AV_PIX_FMT_YUVA420P9 AV_PIX_FMT_NE(YUVA420P9BE , YUVA420P9LE) +#define AV_PIX_FMT_YUVA422P9 AV_PIX_FMT_NE(YUVA422P9BE , YUVA422P9LE) +#define AV_PIX_FMT_YUVA444P9 AV_PIX_FMT_NE(YUVA444P9BE , YUVA444P9LE) +#define AV_PIX_FMT_YUVA420P10 AV_PIX_FMT_NE(YUVA420P10BE, YUVA420P10LE) +#define AV_PIX_FMT_YUVA422P10 AV_PIX_FMT_NE(YUVA422P10BE, YUVA422P10LE) +#define AV_PIX_FMT_YUVA444P10 AV_PIX_FMT_NE(YUVA444P10BE, YUVA444P10LE) +#define AV_PIX_FMT_YUVA422P12 AV_PIX_FMT_NE(YUVA422P12BE, YUVA422P12LE) +#define AV_PIX_FMT_YUVA444P12 AV_PIX_FMT_NE(YUVA444P12BE, YUVA444P12LE) +#define AV_PIX_FMT_YUVA420P16 AV_PIX_FMT_NE(YUVA420P16BE, YUVA420P16LE) +#define AV_PIX_FMT_YUVA422P16 AV_PIX_FMT_NE(YUVA422P16BE, YUVA422P16LE) +#define AV_PIX_FMT_YUVA444P16 AV_PIX_FMT_NE(YUVA444P16BE, YUVA444P16LE) + +#define AV_PIX_FMT_XYZ12 AV_PIX_FMT_NE(XYZ12BE, XYZ12LE) +#define AV_PIX_FMT_NV20 AV_PIX_FMT_NE(NV20BE, NV20LE) +#define AV_PIX_FMT_AYUV64 AV_PIX_FMT_NE(AYUV64BE, AYUV64LE) +#define AV_PIX_FMT_P010 AV_PIX_FMT_NE(P010BE, P010LE) +#define AV_PIX_FMT_P016 AV_PIX_FMT_NE(P016BE, P016LE) + +#define AV_PIX_FMT_Y210 AV_PIX_FMT_NE(Y210BE, Y210LE) + +/** + * Chromaticity coordinates of the source primaries. + * These values match the ones defined by ISO/IEC 23001-8_2013 § 7.1. + */ +enum AVColorPrimaries { + AVCOL_PRI_RESERVED0 = 0, + AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B + AVCOL_PRI_UNSPECIFIED = 2, + AVCOL_PRI_RESERVED = 3, + AVCOL_PRI_BT470M = 4, ///< also FCC Title 47 Code of Federal Regulations 73.682 (a)(20) + + AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM + AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC + AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above + AVCOL_PRI_FILM = 8, ///< colour filters using Illuminant C + AVCOL_PRI_BT2020 = 9, ///< ITU-R BT2020 + AVCOL_PRI_SMPTE428 = 10, ///< SMPTE ST 428-1 (CIE 1931 XYZ) + AVCOL_PRI_SMPTEST428_1 = AVCOL_PRI_SMPTE428, + AVCOL_PRI_SMPTE431 = 11, ///< SMPTE ST 431-2 (2011) / DCI P3 + AVCOL_PRI_SMPTE432 = 12, ///< SMPTE ST 432-1 (2010) / P3 D65 / Display P3 + AVCOL_PRI_EBU3213 = 22, ///< EBU Tech. 3213-E / JEDEC P22 phosphors + AVCOL_PRI_JEDEC_P22 = AVCOL_PRI_EBU3213, + AVCOL_PRI_NB ///< Not part of ABI +}; + +/** + * Color Transfer Characteristic. + * These values match the ones defined by ISO/IEC 23001-8_2013 § 7.2. + */ +enum AVColorTransferCharacteristic { + AVCOL_TRC_RESERVED0 = 0, + AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361 + AVCOL_TRC_UNSPECIFIED = 2, + AVCOL_TRC_RESERVED = 3, + AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM + AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG + AVCOL_TRC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC + AVCOL_TRC_SMPTE240M = 7, + AVCOL_TRC_LINEAR = 8, ///< "Linear transfer characteristics" + AVCOL_TRC_LOG = 9, ///< "Logarithmic transfer characteristic (100:1 range)" + AVCOL_TRC_LOG_SQRT = 10, ///< "Logarithmic transfer characteristic (100 * Sqrt(10) : 1 range)" + AVCOL_TRC_IEC61966_2_4 = 11, ///< IEC 61966-2-4 + AVCOL_TRC_BT1361_ECG = 12, ///< ITU-R BT1361 Extended Colour Gamut + AVCOL_TRC_IEC61966_2_1 = 13, ///< IEC 61966-2-1 (sRGB or sYCC) + AVCOL_TRC_BT2020_10 = 14, ///< ITU-R BT2020 for 10-bit system + AVCOL_TRC_BT2020_12 = 15, ///< ITU-R BT2020 for 12-bit system + AVCOL_TRC_SMPTE2084 = 16, ///< SMPTE ST 2084 for 10-, 12-, 14- and 16-bit systems + AVCOL_TRC_SMPTEST2084 = AVCOL_TRC_SMPTE2084, + AVCOL_TRC_SMPTE428 = 17, ///< SMPTE ST 428-1 + AVCOL_TRC_SMPTEST428_1 = AVCOL_TRC_SMPTE428, + AVCOL_TRC_ARIB_STD_B67 = 18, ///< ARIB STD-B67, known as "Hybrid log-gamma" + AVCOL_TRC_NB ///< Not part of ABI +}; + +/** + * YUV colorspace type. + * These values match the ones defined by ISO/IEC 23001-8_2013 § 7.3. + */ +enum AVColorSpace { + AVCOL_SPC_RGB = 0, ///< order of coefficients is actually GBR, also IEC 61966-2-1 (sRGB) + AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B + AVCOL_SPC_UNSPECIFIED = 2, + AVCOL_SPC_RESERVED = 3, + AVCOL_SPC_FCC = 4, ///< FCC Title 47 Code of Federal Regulations 73.682 (a)(20) + AVCOL_SPC_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601 + AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC + AVCOL_SPC_SMPTE240M = 7, ///< functionally identical to above + AVCOL_SPC_YCGCO = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16 + AVCOL_SPC_YCOCG = AVCOL_SPC_YCGCO, + AVCOL_SPC_BT2020_NCL = 9, ///< ITU-R BT2020 non-constant luminance system + AVCOL_SPC_BT2020_CL = 10, ///< ITU-R BT2020 constant luminance system + AVCOL_SPC_SMPTE2085 = 11, ///< SMPTE 2085, Y'D'zD'x + AVCOL_SPC_CHROMA_DERIVED_NCL = 12, ///< Chromaticity-derived non-constant luminance system + AVCOL_SPC_CHROMA_DERIVED_CL = 13, ///< Chromaticity-derived constant luminance system + AVCOL_SPC_ICTCP = 14, ///< ITU-R BT.2100-0, ICtCp + AVCOL_SPC_NB ///< Not part of ABI +}; + +/** + * MPEG vs JPEG YUV range. + */ +enum AVColorRange { + AVCOL_RANGE_UNSPECIFIED = 0, + AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges + AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges + AVCOL_RANGE_NB ///< Not part of ABI +}; + +/** + * Location of chroma samples. + * + * Illustration showing the location of the first (top left) chroma sample of the + * image, the left shows only luma, the right + * shows the location of the chroma sample, the 2 could be imagined to overlay + * each other but are drawn separately due to limitations of ASCII + * + * 1st 2nd 1st 2nd horizontal luma sample positions + * v v v v + * ______ ______ + *1st luma line > |X X ... |3 4 X ... X are luma samples, + * | |1 2 1-6 are possible chroma positions + *2nd luma line > |X X ... |5 6 X ... 0 is undefined/unknown position + */ +enum AVChromaLocation { + AVCHROMA_LOC_UNSPECIFIED = 0, + AVCHROMA_LOC_LEFT = 1, ///< MPEG-2/4 4:2:0, H.264 default for 4:2:0 + AVCHROMA_LOC_CENTER = 2, ///< MPEG-1 4:2:0, JPEG 4:2:0, H.263 4:2:0 + AVCHROMA_LOC_TOPLEFT = 3, ///< ITU-R 601, SMPTE 274M 296M S314M(DV 4:1:1), mpeg2 4:2:2 + AVCHROMA_LOC_TOP = 4, + AVCHROMA_LOC_BOTTOMLEFT = 5, + AVCHROMA_LOC_BOTTOM = 6, + AVCHROMA_LOC_NB ///< Not part of ABI +}; + +#endif /* AVUTIL_PIXFMT_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/random_seed.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/random_seed.h new file mode 100644 index 0000000..0462a04 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/random_seed.h @@ -0,0 +1,43 @@ +/* + * Copyright (c) 2009 Baptiste Coudurier + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_RANDOM_SEED_H +#define AVUTIL_RANDOM_SEED_H + +#include +/** + * @addtogroup lavu_crypto + * @{ + */ + +/** + * Get a seed to use in conjunction with random functions. + * This function tries to provide a good seed at a best effort bases. + * Its possible to call this function multiple times if more bits are needed. + * It can be quite slow, which is why it should only be used as seed for a faster + * PRNG. The quality of the seed depends on the platform. + */ +uint32_t av_get_random_seed(void); + +/** + * @} + */ + +#endif /* AVUTIL_RANDOM_SEED_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/rational.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/rational.h new file mode 100644 index 0000000..def7402 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/rational.h @@ -0,0 +1,220 @@ +/* + * rational numbers + * Copyright (c) 2003 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @ingroup lavu_math_rational + * Utilties for rational number calculation. + * @author Michael Niedermayer + */ + +#ifndef AVUTIL_RATIONAL_H +#define AVUTIL_RATIONAL_H + +#include +#include +#include "attributes.h" + +/** + * @defgroup lavu_math_rational AVRational + * @ingroup lavu_math + * Rational number calculation. + * + * While rational numbers can be expressed as floating-point numbers, the + * conversion process is a lossy one, so are floating-point operations. On the + * other hand, the nature of FFmpeg demands highly accurate calculation of + * timestamps. This set of rational number utilities serves as a generic + * interface for manipulating rational numbers as pairs of numerators and + * denominators. + * + * Many of the functions that operate on AVRational's have the suffix `_q`, in + * reference to the mathematical symbol "Q" (Q) which denotes the set of all + * rational numbers. + * + * @{ + */ + +/** + * Rational number (pair of numerator and denominator). + */ +typedef struct AVRational{ + int num; ///< Numerator + int den; ///< Denominator +} AVRational; + +/** + * Create an AVRational. + * + * Useful for compilers that do not support compound literals. + * + * @note The return value is not reduced. + * @see av_reduce() + */ +static inline AVRational av_make_q(int num, int den) +{ + AVRational r = { num, den }; + return r; +} + +/** + * Compare two rationals. + * + * @param a First rational + * @param b Second rational + * + * @return One of the following values: + * - 0 if `a == b` + * - 1 if `a > b` + * - -1 if `a < b` + * - `INT_MIN` if one of the values is of the form `0 / 0` + */ +static inline int av_cmp_q(AVRational a, AVRational b){ + const int64_t tmp= a.num * (int64_t)b.den - b.num * (int64_t)a.den; + + if(tmp) return (int)((tmp ^ a.den ^ b.den)>>63)|1; + else if(b.den && a.den) return 0; + else if(a.num && b.num) return (a.num>>31) - (b.num>>31); + else return INT_MIN; +} + +/** + * Convert an AVRational to a `double`. + * @param a AVRational to convert + * @return `a` in floating-point form + * @see av_d2q() + */ +static inline double av_q2d(AVRational a){ + return a.num / (double) a.den; +} + +/** + * Reduce a fraction. + * + * This is useful for framerate calculations. + * + * @param[out] dst_num Destination numerator + * @param[out] dst_den Destination denominator + * @param[in] num Source numerator + * @param[in] den Source denominator + * @param[in] max Maximum allowed values for `dst_num` & `dst_den` + * @return 1 if the operation is exact, 0 otherwise + */ +int av_reduce(int *dst_num, int *dst_den, int64_t num, int64_t den, int64_t max); + +/** + * Multiply two rationals. + * @param b First rational + * @param c Second rational + * @return b*c + */ +AVRational av_mul_q(AVRational b, AVRational c) av_const; + +/** + * Divide one rational by another. + * @param b First rational + * @param c Second rational + * @return b/c + */ +AVRational av_div_q(AVRational b, AVRational c) av_const; + +/** + * Add two rationals. + * @param b First rational + * @param c Second rational + * @return b+c + */ +AVRational av_add_q(AVRational b, AVRational c) av_const; + +/** + * Subtract one rational from another. + * @param b First rational + * @param c Second rational + * @return b-c + */ +AVRational av_sub_q(AVRational b, AVRational c) av_const; + +/** + * Invert a rational. + * @param q value + * @return 1 / q + */ +static av_always_inline AVRational av_inv_q(AVRational q) +{ + AVRational r = { q.den, q.num }; + return r; +} + +/** + * Convert a double precision floating point number to a rational. + * + * In case of infinity, the returned value is expressed as `{1, 0}` or + * `{-1, 0}` depending on the sign. + * + * @param d `double` to convert + * @param max Maximum allowed numerator and denominator + * @return `d` in AVRational form + * @see av_q2d() + */ +AVRational av_d2q(double d, int max) av_const; + +/** + * Find which of the two rationals is closer to another rational. + * + * @param q Rational to be compared against + * @param q1,q2 Rationals to be tested + * @return One of the following values: + * - 1 if `q1` is nearer to `q` than `q2` + * - -1 if `q2` is nearer to `q` than `q1` + * - 0 if they have the same distance + */ +int av_nearer_q(AVRational q, AVRational q1, AVRational q2); + +/** + * Find the value in a list of rationals nearest a given reference rational. + * + * @param q Reference rational + * @param q_list Array of rationals terminated by `{0, 0}` + * @return Index of the nearest value found in the array + */ +int av_find_nearest_q_idx(AVRational q, const AVRational* q_list); + +/** + * Convert an AVRational to a IEEE 32-bit `float` expressed in fixed-point + * format. + * + * @param q Rational to be converted + * @return Equivalent floating-point value, expressed as an unsigned 32-bit + * integer. + * @note The returned value is platform-indepedant. + */ +uint32_t av_q2intfloat(AVRational q); + +/** + * Return the best rational so that a and b are multiple of it. + * If the resulting denominator is larger than max_den, return def. + */ +AVRational av_gcd_q(AVRational a, AVRational b, int max_den, AVRational def); + +/** + * @} + */ + +#endif /* AVUTIL_RATIONAL_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/rc4.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/rc4.h new file mode 100644 index 0000000..029cd2a --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/rc4.h @@ -0,0 +1,66 @@ +/* + * RC4 encryption/decryption/pseudo-random number generator + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_RC4_H +#define AVUTIL_RC4_H + +#include + +/** + * @defgroup lavu_rc4 RC4 + * @ingroup lavu_crypto + * @{ + */ + +typedef struct AVRC4 { + uint8_t state[256]; + int x, y; +} AVRC4; + +/** + * Allocate an AVRC4 context. + */ +AVRC4 *av_rc4_alloc(void); + +/** + * @brief Initializes an AVRC4 context. + * + * @param key_bits must be a multiple of 8 + * @param decrypt 0 for encryption, 1 for decryption, currently has no effect + * @return zero on success, negative value otherwise + */ +int av_rc4_init(struct AVRC4 *d, const uint8_t *key, int key_bits, int decrypt); + +/** + * @brief Encrypts / decrypts using the RC4 algorithm. + * + * @param count number of bytes + * @param dst destination array, can be equal to src + * @param src source array, can be equal to dst, may be NULL + * @param iv not (yet) used for RC4, should be NULL + * @param decrypt 0 for encryption, 1 for decryption, not (yet) used + */ +void av_rc4_crypt(struct AVRC4 *d, uint8_t *dst, const uint8_t *src, int count, uint8_t *iv, int decrypt); + +/** + * @} + */ + +#endif /* AVUTIL_RC4_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/replaygain.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/replaygain.h new file mode 100644 index 0000000..b49bf1a --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/replaygain.h @@ -0,0 +1,50 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_REPLAYGAIN_H +#define AVUTIL_REPLAYGAIN_H + +#include + +/** + * ReplayGain information (see + * http://wiki.hydrogenaudio.org/index.php?title=ReplayGain_1.0_specification). + * The size of this struct is a part of the public ABI. + */ +typedef struct AVReplayGain { + /** + * Track replay gain in microbels (divide by 100000 to get the value in dB). + * Should be set to INT32_MIN when unknown. + */ + int32_t track_gain; + /** + * Peak track amplitude, with 100000 representing full scale (but values + * may overflow). 0 when unknown. + */ + uint32_t track_peak; + /** + * Same as track_gain, but for the whole album. + */ + int32_t album_gain; + /** + * Same as track_peak, but for the whole album, + */ + uint32_t album_peak; +} AVReplayGain; + +#endif /* AVUTIL_REPLAYGAIN_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/ripemd.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/ripemd.h new file mode 100644 index 0000000..0db6858 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/ripemd.h @@ -0,0 +1,87 @@ +/* + * Copyright (C) 2007 Michael Niedermayer + * Copyright (C) 2013 James Almer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @ingroup lavu_ripemd + * Public header for RIPEMD hash function implementation. + */ + +#ifndef AVUTIL_RIPEMD_H +#define AVUTIL_RIPEMD_H + +#include + +#include "attributes.h" +#include "version.h" + +/** + * @defgroup lavu_ripemd RIPEMD + * @ingroup lavu_hash + * RIPEMD hash function implementation. + * + * @{ + */ + +extern const int av_ripemd_size; + +struct AVRIPEMD; + +/** + * Allocate an AVRIPEMD context. + */ +struct AVRIPEMD *av_ripemd_alloc(void); + +/** + * Initialize RIPEMD hashing. + * + * @param context pointer to the function context (of size av_ripemd_size) + * @param bits number of bits in digest (128, 160, 256 or 320 bits) + * @return zero if initialization succeeded, -1 otherwise + */ +int av_ripemd_init(struct AVRIPEMD* context, int bits); + +/** + * Update hash value. + * + * @param context hash function context + * @param data input data to update hash with + * @param len input data length + */ +#if FF_API_CRYPTO_SIZE_T +void av_ripemd_update(struct AVRIPEMD* context, const uint8_t* data, unsigned int len); +#else +void av_ripemd_update(struct AVRIPEMD* context, const uint8_t* data, size_t len); +#endif + +/** + * Finish hashing and output digest value. + * + * @param context hash function context + * @param digest buffer where output digest value is stored + */ +void av_ripemd_final(struct AVRIPEMD* context, uint8_t *digest); + +/** + * @} + */ + +#endif /* AVUTIL_RIPEMD_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/samplefmt.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/samplefmt.h new file mode 100644 index 0000000..8cd43ae --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/samplefmt.h @@ -0,0 +1,272 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_SAMPLEFMT_H +#define AVUTIL_SAMPLEFMT_H + +#include + +#include "avutil.h" +#include "attributes.h" + +/** + * @addtogroup lavu_audio + * @{ + * + * @defgroup lavu_sampfmts Audio sample formats + * + * Audio sample format enumeration and related convenience functions. + * @{ + */ + +/** + * Audio sample formats + * + * - The data described by the sample format is always in native-endian order. + * Sample values can be expressed by native C types, hence the lack of a signed + * 24-bit sample format even though it is a common raw audio data format. + * + * - The floating-point formats are based on full volume being in the range + * [-1.0, 1.0]. Any values outside this range are beyond full volume level. + * + * - The data layout as used in av_samples_fill_arrays() and elsewhere in FFmpeg + * (such as AVFrame in libavcodec) is as follows: + * + * @par + * For planar sample formats, each audio channel is in a separate data plane, + * and linesize is the buffer size, in bytes, for a single plane. All data + * planes must be the same size. For packed sample formats, only the first data + * plane is used, and samples for each channel are interleaved. In this case, + * linesize is the buffer size, in bytes, for the 1 plane. + * + */ +enum AVSampleFormat { + AV_SAMPLE_FMT_NONE = -1, + AV_SAMPLE_FMT_U8, ///< unsigned 8 bits + AV_SAMPLE_FMT_S16, ///< signed 16 bits + AV_SAMPLE_FMT_S32, ///< signed 32 bits + AV_SAMPLE_FMT_FLT, ///< float + AV_SAMPLE_FMT_DBL, ///< double + + AV_SAMPLE_FMT_U8P, ///< unsigned 8 bits, planar + AV_SAMPLE_FMT_S16P, ///< signed 16 bits, planar + AV_SAMPLE_FMT_S32P, ///< signed 32 bits, planar + AV_SAMPLE_FMT_FLTP, ///< float, planar + AV_SAMPLE_FMT_DBLP, ///< double, planar + AV_SAMPLE_FMT_S64, ///< signed 64 bits + AV_SAMPLE_FMT_S64P, ///< signed 64 bits, planar + + AV_SAMPLE_FMT_NB ///< Number of sample formats. DO NOT USE if linking dynamically +}; + +/** + * Return the name of sample_fmt, or NULL if sample_fmt is not + * recognized. + */ +const char *av_get_sample_fmt_name(enum AVSampleFormat sample_fmt); + +/** + * Return a sample format corresponding to name, or AV_SAMPLE_FMT_NONE + * on error. + */ +enum AVSampleFormat av_get_sample_fmt(const char *name); + +/** + * Return the planar<->packed alternative form of the given sample format, or + * AV_SAMPLE_FMT_NONE on error. If the passed sample_fmt is already in the + * requested planar/packed format, the format returned is the same as the + * input. + */ +enum AVSampleFormat av_get_alt_sample_fmt(enum AVSampleFormat sample_fmt, int planar); + +/** + * Get the packed alternative form of the given sample format. + * + * If the passed sample_fmt is already in packed format, the format returned is + * the same as the input. + * + * @return the packed alternative form of the given sample format or + AV_SAMPLE_FMT_NONE on error. + */ +enum AVSampleFormat av_get_packed_sample_fmt(enum AVSampleFormat sample_fmt); + +/** + * Get the planar alternative form of the given sample format. + * + * If the passed sample_fmt is already in planar format, the format returned is + * the same as the input. + * + * @return the planar alternative form of the given sample format or + AV_SAMPLE_FMT_NONE on error. + */ +enum AVSampleFormat av_get_planar_sample_fmt(enum AVSampleFormat sample_fmt); + +/** + * Generate a string corresponding to the sample format with + * sample_fmt, or a header if sample_fmt is negative. + * + * @param buf the buffer where to write the string + * @param buf_size the size of buf + * @param sample_fmt the number of the sample format to print the + * corresponding info string, or a negative value to print the + * corresponding header. + * @return the pointer to the filled buffer or NULL if sample_fmt is + * unknown or in case of other errors + */ +char *av_get_sample_fmt_string(char *buf, int buf_size, enum AVSampleFormat sample_fmt); + +/** + * Return number of bytes per sample. + * + * @param sample_fmt the sample format + * @return number of bytes per sample or zero if unknown for the given + * sample format + */ +int av_get_bytes_per_sample(enum AVSampleFormat sample_fmt); + +/** + * Check if the sample format is planar. + * + * @param sample_fmt the sample format to inspect + * @return 1 if the sample format is planar, 0 if it is interleaved + */ +int av_sample_fmt_is_planar(enum AVSampleFormat sample_fmt); + +/** + * Get the required buffer size for the given audio parameters. + * + * @param[out] linesize calculated linesize, may be NULL + * @param nb_channels the number of channels + * @param nb_samples the number of samples in a single channel + * @param sample_fmt the sample format + * @param align buffer size alignment (0 = default, 1 = no alignment) + * @return required buffer size, or negative error code on failure + */ +int av_samples_get_buffer_size(int *linesize, int nb_channels, int nb_samples, + enum AVSampleFormat sample_fmt, int align); + +/** + * @} + * + * @defgroup lavu_sampmanip Samples manipulation + * + * Functions that manipulate audio samples + * @{ + */ + +/** + * Fill plane data pointers and linesize for samples with sample + * format sample_fmt. + * + * The audio_data array is filled with the pointers to the samples data planes: + * for planar, set the start point of each channel's data within the buffer, + * for packed, set the start point of the entire buffer only. + * + * The value pointed to by linesize is set to the aligned size of each + * channel's data buffer for planar layout, or to the aligned size of the + * buffer for all channels for packed layout. + * + * The buffer in buf must be big enough to contain all the samples + * (use av_samples_get_buffer_size() to compute its minimum size), + * otherwise the audio_data pointers will point to invalid data. + * + * @see enum AVSampleFormat + * The documentation for AVSampleFormat describes the data layout. + * + * @param[out] audio_data array to be filled with the pointer for each channel + * @param[out] linesize calculated linesize, may be NULL + * @param buf the pointer to a buffer containing the samples + * @param nb_channels the number of channels + * @param nb_samples the number of samples in a single channel + * @param sample_fmt the sample format + * @param align buffer size alignment (0 = default, 1 = no alignment) + * @return >=0 on success or a negative error code on failure + * @todo return minimum size in bytes required for the buffer in case + * of success at the next bump + */ +int av_samples_fill_arrays(uint8_t **audio_data, int *linesize, + const uint8_t *buf, + int nb_channels, int nb_samples, + enum AVSampleFormat sample_fmt, int align); + +/** + * Allocate a samples buffer for nb_samples samples, and fill data pointers and + * linesize accordingly. + * The allocated samples buffer can be freed by using av_freep(&audio_data[0]) + * Allocated data will be initialized to silence. + * + * @see enum AVSampleFormat + * The documentation for AVSampleFormat describes the data layout. + * + * @param[out] audio_data array to be filled with the pointer for each channel + * @param[out] linesize aligned size for audio buffer(s), may be NULL + * @param nb_channels number of audio channels + * @param nb_samples number of samples per channel + * @param align buffer size alignment (0 = default, 1 = no alignment) + * @return >=0 on success or a negative error code on failure + * @todo return the size of the allocated buffer in case of success at the next bump + * @see av_samples_fill_arrays() + * @see av_samples_alloc_array_and_samples() + */ +int av_samples_alloc(uint8_t **audio_data, int *linesize, int nb_channels, + int nb_samples, enum AVSampleFormat sample_fmt, int align); + +/** + * Allocate a data pointers array, samples buffer for nb_samples + * samples, and fill data pointers and linesize accordingly. + * + * This is the same as av_samples_alloc(), but also allocates the data + * pointers array. + * + * @see av_samples_alloc() + */ +int av_samples_alloc_array_and_samples(uint8_t ***audio_data, int *linesize, int nb_channels, + int nb_samples, enum AVSampleFormat sample_fmt, int align); + +/** + * Copy samples from src to dst. + * + * @param dst destination array of pointers to data planes + * @param src source array of pointers to data planes + * @param dst_offset offset in samples at which the data will be written to dst + * @param src_offset offset in samples at which the data will be read from src + * @param nb_samples number of samples to be copied + * @param nb_channels number of audio channels + * @param sample_fmt audio sample format + */ +int av_samples_copy(uint8_t **dst, uint8_t * const *src, int dst_offset, + int src_offset, int nb_samples, int nb_channels, + enum AVSampleFormat sample_fmt); + +/** + * Fill an audio buffer with silence. + * + * @param audio_data array of pointers to data planes + * @param offset offset in samples at which to start filling + * @param nb_samples number of samples to fill + * @param nb_channels number of audio channels + * @param sample_fmt audio sample format + */ +int av_samples_set_silence(uint8_t **audio_data, int offset, int nb_samples, + int nb_channels, enum AVSampleFormat sample_fmt); + +/** + * @} + * @} + */ +#endif /* AVUTIL_SAMPLEFMT_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/sha.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/sha.h new file mode 100644 index 0000000..c0180e5 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/sha.h @@ -0,0 +1,95 @@ +/* + * Copyright (C) 2007 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @ingroup lavu_sha + * Public header for SHA-1 & SHA-256 hash function implementations. + */ + +#ifndef AVUTIL_SHA_H +#define AVUTIL_SHA_H + +#include +#include + +#include "attributes.h" +#include "version.h" + +/** + * @defgroup lavu_sha SHA + * @ingroup lavu_hash + * SHA-1 and SHA-256 (Secure Hash Algorithm) hash function implementations. + * + * This module supports the following SHA hash functions: + * + * - SHA-1: 160 bits + * - SHA-224: 224 bits, as a variant of SHA-2 + * - SHA-256: 256 bits, as a variant of SHA-2 + * + * @see For SHA-384, SHA-512, and variants thereof, see @ref lavu_sha512. + * + * @{ + */ + +extern const int av_sha_size; + +struct AVSHA; + +/** + * Allocate an AVSHA context. + */ +struct AVSHA *av_sha_alloc(void); + +/** + * Initialize SHA-1 or SHA-2 hashing. + * + * @param context pointer to the function context (of size av_sha_size) + * @param bits number of bits in digest (SHA-1 - 160 bits, SHA-2 224 or 256 bits) + * @return zero if initialization succeeded, -1 otherwise + */ +int av_sha_init(struct AVSHA* context, int bits); + +/** + * Update hash value. + * + * @param ctx hash function context + * @param data input data to update hash with + * @param len input data length + */ +#if FF_API_CRYPTO_SIZE_T +void av_sha_update(struct AVSHA *ctx, const uint8_t *data, unsigned int len); +#else +void av_sha_update(struct AVSHA *ctx, const uint8_t *data, size_t len); +#endif + +/** + * Finish hashing and output digest value. + * + * @param context hash function context + * @param digest buffer where output digest value is stored + */ +void av_sha_final(struct AVSHA* context, uint8_t *digest); + +/** + * @} + */ + +#endif /* AVUTIL_SHA_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/sha512.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/sha512.h new file mode 100644 index 0000000..bef714b --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/sha512.h @@ -0,0 +1,97 @@ +/* + * Copyright (C) 2007 Michael Niedermayer + * Copyright (C) 2013 James Almer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @ingroup lavu_sha512 + * Public header for SHA-512 implementation. + */ + +#ifndef AVUTIL_SHA512_H +#define AVUTIL_SHA512_H + +#include +#include + +#include "attributes.h" +#include "version.h" + +/** + * @defgroup lavu_sha512 SHA-512 + * @ingroup lavu_hash + * SHA-512 (Secure Hash Algorithm) hash function implementations. + * + * This module supports the following SHA-2 hash functions: + * + * - SHA-512/224: 224 bits + * - SHA-512/256: 256 bits + * - SHA-384: 384 bits + * - SHA-512: 512 bits + * + * @see For SHA-1, SHA-256, and variants thereof, see @ref lavu_sha. + * + * @{ + */ + +extern const int av_sha512_size; + +struct AVSHA512; + +/** + * Allocate an AVSHA512 context. + */ +struct AVSHA512 *av_sha512_alloc(void); + +/** + * Initialize SHA-2 512 hashing. + * + * @param context pointer to the function context (of size av_sha512_size) + * @param bits number of bits in digest (224, 256, 384 or 512 bits) + * @return zero if initialization succeeded, -1 otherwise + */ +int av_sha512_init(struct AVSHA512* context, int bits); + +/** + * Update hash value. + * + * @param context hash function context + * @param data input data to update hash with + * @param len input data length + */ +#if FF_API_CRYPTO_SIZE_T +void av_sha512_update(struct AVSHA512* context, const uint8_t* data, unsigned int len); +#else +void av_sha512_update(struct AVSHA512* context, const uint8_t* data, size_t len); +#endif + +/** + * Finish hashing and output digest value. + * + * @param context hash function context + * @param digest buffer where output digest value is stored + */ +void av_sha512_final(struct AVSHA512* context, uint8_t *digest); + +/** + * @} + */ + +#endif /* AVUTIL_SHA512_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/spherical.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/spherical.h new file mode 100644 index 0000000..cef759c --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/spherical.h @@ -0,0 +1,232 @@ +/* + * Copyright (c) 2016 Vittorio Giovara + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * Spherical video + */ + +#ifndef AVUTIL_SPHERICAL_H +#define AVUTIL_SPHERICAL_H + +#include +#include + +/** + * @addtogroup lavu_video + * @{ + * + * @defgroup lavu_video_spherical Spherical video mapping + * @{ + */ + +/** + * @addtogroup lavu_video_spherical + * A spherical video file contains surfaces that need to be mapped onto a + * sphere. Depending on how the frame was converted, a different distortion + * transformation or surface recomposition function needs to be applied before + * the video should be mapped and displayed. + */ + +/** + * Projection of the video surface(s) on a sphere. + */ +enum AVSphericalProjection { + /** + * Video represents a sphere mapped on a flat surface using + * equirectangular projection. + */ + AV_SPHERICAL_EQUIRECTANGULAR, + + /** + * Video frame is split into 6 faces of a cube, and arranged on a + * 3x2 layout. Faces are oriented upwards for the front, left, right, + * and back faces. The up face is oriented so the top of the face is + * forwards and the down face is oriented so the top of the face is + * to the back. + */ + AV_SPHERICAL_CUBEMAP, + + /** + * Video represents a portion of a sphere mapped on a flat surface + * using equirectangular projection. The @ref bounding fields indicate + * the position of the current video in a larger surface. + */ + AV_SPHERICAL_EQUIRECTANGULAR_TILE, +}; + +/** + * This structure describes how to handle spherical videos, outlining + * information about projection, initial layout, and any other view modifier. + * + * @note The struct must be allocated with av_spherical_alloc() and + * its size is not a part of the public ABI. + */ +typedef struct AVSphericalMapping { + /** + * Projection type. + */ + enum AVSphericalProjection projection; + + /** + * @name Initial orientation + * @{ + * There fields describe additional rotations applied to the sphere after + * the video frame is mapped onto it. The sphere is rotated around the + * viewer, who remains stationary. The order of transformation is always + * yaw, followed by pitch, and finally by roll. + * + * The coordinate system matches the one defined in OpenGL, where the + * forward vector (z) is coming out of screen, and it is equivalent to + * a rotation matrix of R = r_y(yaw) * r_x(pitch) * r_z(roll). + * + * A positive yaw rotates the portion of the sphere in front of the viewer + * toward their right. A positive pitch rotates the portion of the sphere + * in front of the viewer upwards. A positive roll tilts the portion of + * the sphere in front of the viewer to the viewer's right. + * + * These values are exported as 16.16 fixed point. + * + * See this equirectangular projection as example: + * + * @code{.unparsed} + * Yaw + * -180 0 180 + * 90 +-------------+-------------+ 180 + * | | | up + * P | | | y| forward + * i | ^ | | /z + * t 0 +-------------X-------------+ 0 Roll | / + * c | | | | / + * h | | | 0|/_____right + * | | | x + * -90 +-------------+-------------+ -180 + * + * X - the default camera center + * ^ - the default up vector + * @endcode + */ + int32_t yaw; ///< Rotation around the up vector [-180, 180]. + int32_t pitch; ///< Rotation around the right vector [-90, 90]. + int32_t roll; ///< Rotation around the forward vector [-180, 180]. + /** + * @} + */ + + /** + * @name Bounding rectangle + * @anchor bounding + * @{ + * These fields indicate the location of the current tile, and where + * it should be mapped relative to the original surface. They are + * exported as 0.32 fixed point, and can be converted to classic + * pixel values with av_spherical_bounds(). + * + * @code{.unparsed} + * +----------------+----------+ + * | |bound_top | + * | +--------+ | + * | bound_left |tile | | + * +<---------->| |<--->+bound_right + * | +--------+ | + * | | | + * | bound_bottom| | + * +----------------+----------+ + * @endcode + * + * If needed, the original video surface dimensions can be derived + * by adding the current stream or frame size to the related bounds, + * like in the following example: + * + * @code{c} + * original_width = tile->width + bound_left + bound_right; + * original_height = tile->height + bound_top + bound_bottom; + * @endcode + * + * @note These values are valid only for the tiled equirectangular + * projection type (@ref AV_SPHERICAL_EQUIRECTANGULAR_TILE), + * and should be ignored in all other cases. + */ + uint32_t bound_left; ///< Distance from the left edge + uint32_t bound_top; ///< Distance from the top edge + uint32_t bound_right; ///< Distance from the right edge + uint32_t bound_bottom; ///< Distance from the bottom edge + /** + * @} + */ + + /** + * Number of pixels to pad from the edge of each cube face. + * + * @note This value is valid for only for the cubemap projection type + * (@ref AV_SPHERICAL_CUBEMAP), and should be ignored in all other + * cases. + */ + uint32_t padding; +} AVSphericalMapping; + +/** + * Allocate a AVSphericalVideo structure and initialize its fields to default + * values. + * + * @return the newly allocated struct or NULL on failure + */ +AVSphericalMapping *av_spherical_alloc(size_t *size); + +/** + * Convert the @ref bounding fields from an AVSphericalVideo + * from 0.32 fixed point to pixels. + * + * @param map The AVSphericalVideo map to read bound values from. + * @param width Width of the current frame or stream. + * @param height Height of the current frame or stream. + * @param left Pixels from the left edge. + * @param top Pixels from the top edge. + * @param right Pixels from the right edge. + * @param bottom Pixels from the bottom edge. + */ +void av_spherical_tile_bounds(const AVSphericalMapping *map, + size_t width, size_t height, + size_t *left, size_t *top, + size_t *right, size_t *bottom); + +/** + * Provide a human-readable name of a given AVSphericalProjection. + * + * @param projection The input AVSphericalProjection. + * + * @return The name of the AVSphericalProjection, or "unknown". + */ +const char *av_spherical_projection_name(enum AVSphericalProjection projection); + +/** + * Get the AVSphericalProjection form a human-readable name. + * + * @param name The input string. + * + * @return The AVSphericalProjection value, or -1 if not found. + */ +int av_spherical_from_name(const char *name); +/** + * @} + * @} + */ + +#endif /* AVUTIL_SPHERICAL_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/stereo3d.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/stereo3d.h new file mode 100644 index 0000000..d421aac --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/stereo3d.h @@ -0,0 +1,233 @@ +/* + * Copyright (c) 2013 Vittorio Giovara + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * Stereoscopic video + */ + +#ifndef AVUTIL_STEREO3D_H +#define AVUTIL_STEREO3D_H + +#include + +#include "frame.h" + +/** + * @addtogroup lavu_video + * @{ + * + * @defgroup lavu_video_stereo3d Stereo3D types and functions + * @{ + */ + +/** + * @addtogroup lavu_video_stereo3d + * A stereoscopic video file consists in multiple views embedded in a single + * frame, usually describing two views of a scene. This file describes all + * possible codec-independent view arrangements. + * */ + +/** + * List of possible 3D Types + */ +enum AVStereo3DType { + /** + * Video is not stereoscopic (and metadata has to be there). + */ + AV_STEREO3D_2D, + + /** + * Views are next to each other. + * + * @code{.unparsed} + * LLLLRRRR + * LLLLRRRR + * LLLLRRRR + * ... + * @endcode + */ + AV_STEREO3D_SIDEBYSIDE, + + /** + * Views are on top of each other. + * + * @code{.unparsed} + * LLLLLLLL + * LLLLLLLL + * RRRRRRRR + * RRRRRRRR + * @endcode + */ + AV_STEREO3D_TOPBOTTOM, + + /** + * Views are alternated temporally. + * + * @code{.unparsed} + * frame0 frame1 frame2 ... + * LLLLLLLL RRRRRRRR LLLLLLLL + * LLLLLLLL RRRRRRRR LLLLLLLL + * LLLLLLLL RRRRRRRR LLLLLLLL + * ... ... ... + * @endcode + */ + AV_STEREO3D_FRAMESEQUENCE, + + /** + * Views are packed in a checkerboard-like structure per pixel. + * + * @code{.unparsed} + * LRLRLRLR + * RLRLRLRL + * LRLRLRLR + * ... + * @endcode + */ + AV_STEREO3D_CHECKERBOARD, + + /** + * Views are next to each other, but when upscaling + * apply a checkerboard pattern. + * + * @code{.unparsed} + * LLLLRRRR L L L L R R R R + * LLLLRRRR => L L L L R R R R + * LLLLRRRR L L L L R R R R + * LLLLRRRR L L L L R R R R + * @endcode + */ + AV_STEREO3D_SIDEBYSIDE_QUINCUNX, + + /** + * Views are packed per line, as if interlaced. + * + * @code{.unparsed} + * LLLLLLLL + * RRRRRRRR + * LLLLLLLL + * ... + * @endcode + */ + AV_STEREO3D_LINES, + + /** + * Views are packed per column. + * + * @code{.unparsed} + * LRLRLRLR + * LRLRLRLR + * LRLRLRLR + * ... + * @endcode + */ + AV_STEREO3D_COLUMNS, +}; + +/** + * List of possible view types. + */ +enum AVStereo3DView { + /** + * Frame contains two packed views. + */ + AV_STEREO3D_VIEW_PACKED, + + /** + * Frame contains only the left view. + */ + AV_STEREO3D_VIEW_LEFT, + + /** + * Frame contains only the right view. + */ + AV_STEREO3D_VIEW_RIGHT, +}; + +/** + * Inverted views, Right/Bottom represents the left view. + */ +#define AV_STEREO3D_FLAG_INVERT (1 << 0) + +/** + * Stereo 3D type: this structure describes how two videos are packed + * within a single video surface, with additional information as needed. + * + * @note The struct must be allocated with av_stereo3d_alloc() and + * its size is not a part of the public ABI. + */ +typedef struct AVStereo3D { + /** + * How views are packed within the video. + */ + enum AVStereo3DType type; + + /** + * Additional information about the frame packing. + */ + int flags; + + /** + * Determines which views are packed. + */ + enum AVStereo3DView view; +} AVStereo3D; + +/** + * Allocate an AVStereo3D structure and set its fields to default values. + * The resulting struct can be freed using av_freep(). + * + * @return An AVStereo3D filled with default values or NULL on failure. + */ +AVStereo3D *av_stereo3d_alloc(void); + +/** + * Allocate a complete AVFrameSideData and add it to the frame. + * + * @param frame The frame which side data is added to. + * + * @return The AVStereo3D structure to be filled by caller. + */ +AVStereo3D *av_stereo3d_create_side_data(AVFrame *frame); + +/** + * Provide a human-readable name of a given stereo3d type. + * + * @param type The input stereo3d type value. + * + * @return The name of the stereo3d value, or "unknown". + */ +const char *av_stereo3d_type_name(unsigned int type); + +/** + * Get the AVStereo3DType form a human-readable name. + * + * @param name The input string. + * + * @return The AVStereo3DType value, or -1 if not found. + */ +int av_stereo3d_from_name(const char *name); + +/** + * @} + * @} + */ + +#endif /* AVUTIL_STEREO3D_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/tea.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/tea.h new file mode 100644 index 0000000..dd929bd --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/tea.h @@ -0,0 +1,71 @@ +/* + * A 32-bit implementation of the TEA algorithm + * Copyright (c) 2015 Vesselin Bontchev + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_TEA_H +#define AVUTIL_TEA_H + +#include + +/** + * @file + * @brief Public header for libavutil TEA algorithm + * @defgroup lavu_tea TEA + * @ingroup lavu_crypto + * @{ + */ + +extern const int av_tea_size; + +struct AVTEA; + +/** + * Allocate an AVTEA context + * To free the struct: av_free(ptr) + */ +struct AVTEA *av_tea_alloc(void); + +/** + * Initialize an AVTEA context. + * + * @param ctx an AVTEA context + * @param key a key of 16 bytes used for encryption/decryption + * @param rounds the number of rounds in TEA (64 is the "standard") + */ +void av_tea_init(struct AVTEA *ctx, const uint8_t key[16], int rounds); + +/** + * Encrypt or decrypt a buffer using a previously initialized context. + * + * @param ctx an AVTEA context + * @param dst destination array, can be equal to src + * @param src source array, can be equal to dst + * @param count number of 8 byte blocks + * @param iv initialization vector for CBC mode, if NULL then ECB will be used + * @param decrypt 0 for encryption, 1 for decryption + */ +void av_tea_crypt(struct AVTEA *ctx, uint8_t *dst, const uint8_t *src, + int count, uint8_t *iv, int decrypt); + +/** + * @} + */ + +#endif /* AVUTIL_TEA_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/threadmessage.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/threadmessage.h new file mode 100644 index 0000000..42ce655 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/threadmessage.h @@ -0,0 +1,115 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public License + * as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with FFmpeg; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_THREADMESSAGE_H +#define AVUTIL_THREADMESSAGE_H + +typedef struct AVThreadMessageQueue AVThreadMessageQueue; + +typedef enum AVThreadMessageFlags { + + /** + * Perform non-blocking operation. + * If this flag is set, send and recv operations are non-blocking and + * return AVERROR(EAGAIN) immediately if they can not proceed. + */ + AV_THREAD_MESSAGE_NONBLOCK = 1, + +} AVThreadMessageFlags; + +/** + * Allocate a new message queue. + * + * @param mq pointer to the message queue + * @param nelem maximum number of elements in the queue + * @param elsize size of each element in the queue + * @return >=0 for success; <0 for error, in particular AVERROR(ENOSYS) if + * lavu was built without thread support + */ +int av_thread_message_queue_alloc(AVThreadMessageQueue **mq, + unsigned nelem, + unsigned elsize); + +/** + * Free a message queue. + * + * The message queue must no longer be in use by another thread. + */ +void av_thread_message_queue_free(AVThreadMessageQueue **mq); + +/** + * Send a message on the queue. + */ +int av_thread_message_queue_send(AVThreadMessageQueue *mq, + void *msg, + unsigned flags); + +/** + * Receive a message from the queue. + */ +int av_thread_message_queue_recv(AVThreadMessageQueue *mq, + void *msg, + unsigned flags); + +/** + * Set the sending error code. + * + * If the error code is set to non-zero, av_thread_message_queue_send() will + * return it immediately. Conventional values, such as AVERROR_EOF or + * AVERROR(EAGAIN), can be used to cause the sending thread to stop or + * suspend its operation. + */ +void av_thread_message_queue_set_err_send(AVThreadMessageQueue *mq, + int err); + +/** + * Set the receiving error code. + * + * If the error code is set to non-zero, av_thread_message_queue_recv() will + * return it immediately when there are no longer available messages. + * Conventional values, such as AVERROR_EOF or AVERROR(EAGAIN), can be used + * to cause the receiving thread to stop or suspend its operation. + */ +void av_thread_message_queue_set_err_recv(AVThreadMessageQueue *mq, + int err); + +/** + * Set the optional free message callback function which will be called if an + * operation is removing messages from the queue. + */ +void av_thread_message_queue_set_free_func(AVThreadMessageQueue *mq, + void (*free_func)(void *msg)); + +/** + * Return the current number of messages in the queue. + * + * @return the current number of messages or AVERROR(ENOSYS) if lavu was built + * without thread support + */ +int av_thread_message_queue_nb_elems(AVThreadMessageQueue *mq); + +/** + * Flush the message queue + * + * This function is mostly equivalent to reading and free-ing every message + * except that it will be done in a single operation (no lock/unlock between + * reads). + */ +void av_thread_message_flush(AVThreadMessageQueue *mq); + +#endif /* AVUTIL_THREADMESSAGE_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/time.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/time.h new file mode 100644 index 0000000..dc169b0 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/time.h @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2000-2003 Fabrice Bellard + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_TIME_H +#define AVUTIL_TIME_H + +#include + +/** + * Get the current time in microseconds. + */ +int64_t av_gettime(void); + +/** + * Get the current time in microseconds since some unspecified starting point. + * On platforms that support it, the time comes from a monotonic clock + * This property makes this time source ideal for measuring relative time. + * The returned values may not be monotonic on platforms where a monotonic + * clock is not available. + */ +int64_t av_gettime_relative(void); + +/** + * Indicates with a boolean result if the av_gettime_relative() time source + * is monotonic. + */ +int av_gettime_relative_is_monotonic(void); + +/** + * Sleep for a period of time. Although the duration is expressed in + * microseconds, the actual delay may be rounded to the precision of the + * system timer. + * + * @param usec Number of microseconds to sleep. + * @return zero on success or (negative) error code. + */ +int av_usleep(unsigned usec); + +#endif /* AVUTIL_TIME_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/timecode.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/timecode.h new file mode 100644 index 0000000..37c1361 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/timecode.h @@ -0,0 +1,140 @@ +/* + * Copyright (c) 2006 Smartjog S.A.S, Baptiste Coudurier + * Copyright (c) 2011-2012 Smartjog S.A.S, Clément Bœsch + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * Timecode helpers header + */ + +#ifndef AVUTIL_TIMECODE_H +#define AVUTIL_TIMECODE_H + +#include +#include "rational.h" + +#define AV_TIMECODE_STR_SIZE 23 + +enum AVTimecodeFlag { + AV_TIMECODE_FLAG_DROPFRAME = 1<<0, ///< timecode is drop frame + AV_TIMECODE_FLAG_24HOURSMAX = 1<<1, ///< timecode wraps after 24 hours + AV_TIMECODE_FLAG_ALLOWNEGATIVE = 1<<2, ///< negative time values are allowed +}; + +typedef struct { + int start; ///< timecode frame start (first base frame number) + uint32_t flags; ///< flags such as drop frame, +24 hours support, ... + AVRational rate; ///< frame rate in rational form + unsigned fps; ///< frame per second; must be consistent with the rate field +} AVTimecode; + +/** + * Adjust frame number for NTSC drop frame time code. + * + * @param framenum frame number to adjust + * @param fps frame per second, 30 or 60 + * @return adjusted frame number + * @warning adjustment is only valid in NTSC 29.97 and 59.94 + */ +int av_timecode_adjust_ntsc_framenum2(int framenum, int fps); + +/** + * Convert frame number to SMPTE 12M binary representation. + * + * @param tc timecode data correctly initialized + * @param framenum frame number + * @return the SMPTE binary representation + * + * @note Frame number adjustment is automatically done in case of drop timecode, + * you do NOT have to call av_timecode_adjust_ntsc_framenum2(). + * @note The frame number is relative to tc->start. + * @note Color frame (CF), binary group flags (BGF) and biphase mark polarity + * correction (PC) bits are set to zero. + */ +uint32_t av_timecode_get_smpte_from_framenum(const AVTimecode *tc, int framenum); + +/** + * Load timecode string in buf. + * + * @param buf destination buffer, must be at least AV_TIMECODE_STR_SIZE long + * @param tc timecode data correctly initialized + * @param framenum frame number + * @return the buf parameter + * + * @note Timecode representation can be a negative timecode and have more than + * 24 hours, but will only be honored if the flags are correctly set. + * @note The frame number is relative to tc->start. + */ +char *av_timecode_make_string(const AVTimecode *tc, char *buf, int framenum); + +/** + * Get the timecode string from the SMPTE timecode format. + * + * @param buf destination buffer, must be at least AV_TIMECODE_STR_SIZE long + * @param tcsmpte the 32-bit SMPTE timecode + * @param prevent_df prevent the use of a drop flag when it is known the DF bit + * is arbitrary + * @return the buf parameter + */ +char *av_timecode_make_smpte_tc_string(char *buf, uint32_t tcsmpte, int prevent_df); + +/** + * Get the timecode string from the 25-bit timecode format (MPEG GOP format). + * + * @param buf destination buffer, must be at least AV_TIMECODE_STR_SIZE long + * @param tc25bit the 25-bits timecode + * @return the buf parameter + */ +char *av_timecode_make_mpeg_tc_string(char *buf, uint32_t tc25bit); + +/** + * Init a timecode struct with the passed parameters. + * + * @param log_ctx a pointer to an arbitrary struct of which the first field + * is a pointer to an AVClass struct (used for av_log) + * @param tc pointer to an allocated AVTimecode + * @param rate frame rate in rational form + * @param flags miscellaneous flags such as drop frame, +24 hours, ... + * (see AVTimecodeFlag) + * @param frame_start the first frame number + * @return 0 on success, AVERROR otherwise + */ +int av_timecode_init(AVTimecode *tc, AVRational rate, int flags, int frame_start, void *log_ctx); + +/** + * Parse timecode representation (hh:mm:ss[:;.]ff). + * + * @param log_ctx a pointer to an arbitrary struct of which the first field is a + * pointer to an AVClass struct (used for av_log). + * @param tc pointer to an allocated AVTimecode + * @param rate frame rate in rational form + * @param str timecode string which will determine the frame start + * @return 0 on success, AVERROR otherwise + */ +int av_timecode_init_from_string(AVTimecode *tc, AVRational rate, const char *str, void *log_ctx); + +/** + * Check if the timecode feature is available for the given frame rate + * + * @return 0 if supported, <0 otherwise + */ +int av_timecode_check_frame_rate(AVRational rate); + +#endif /* AVUTIL_TIMECODE_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/timestamp.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/timestamp.h new file mode 100644 index 0000000..e082f01 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/timestamp.h @@ -0,0 +1,78 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * timestamp utils, mostly useful for debugging/logging purposes + */ + +#ifndef AVUTIL_TIMESTAMP_H +#define AVUTIL_TIMESTAMP_H + +#include "common.h" + +#if defined(__cplusplus) && !defined(__STDC_FORMAT_MACROS) && !defined(PRId64) +#error missing -D__STDC_FORMAT_MACROS / #define __STDC_FORMAT_MACROS +#endif + +#define AV_TS_MAX_STRING_SIZE 32 + +/** + * Fill the provided buffer with a string containing a timestamp + * representation. + * + * @param buf a buffer with size in bytes of at least AV_TS_MAX_STRING_SIZE + * @param ts the timestamp to represent + * @return the buffer in input + */ +static inline char *av_ts_make_string(char *buf, int64_t ts) +{ + if (ts == AV_NOPTS_VALUE) snprintf(buf, AV_TS_MAX_STRING_SIZE, "NOPTS"); + else snprintf(buf, AV_TS_MAX_STRING_SIZE, "%" PRId64, ts); + return buf; +} + +/** + * Convenience macro, the return value should be used only directly in + * function arguments but never stand-alone. + */ +#define av_ts2str(ts) av_ts_make_string((char[AV_TS_MAX_STRING_SIZE]){0}, ts) + +/** + * Fill the provided buffer with a string containing a timestamp time + * representation. + * + * @param buf a buffer with size in bytes of at least AV_TS_MAX_STRING_SIZE + * @param ts the timestamp to represent + * @param tb the timebase of the timestamp + * @return the buffer in input + */ +static inline char *av_ts_make_time_string(char *buf, int64_t ts, AVRational *tb) +{ + if (ts == AV_NOPTS_VALUE) snprintf(buf, AV_TS_MAX_STRING_SIZE, "NOPTS"); + else snprintf(buf, AV_TS_MAX_STRING_SIZE, "%.6g", av_q2d(*tb) * ts); + return buf; +} + +/** + * Convenience macro, the return value should be used only directly in + * function arguments but never stand-alone. + */ +#define av_ts2timestr(ts, tb) av_ts_make_time_string((char[AV_TS_MAX_STRING_SIZE]){0}, ts, tb) + +#endif /* AVUTIL_TIMESTAMP_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/tree.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/tree.h new file mode 100644 index 0000000..d5e0aeb --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/tree.h @@ -0,0 +1,138 @@ +/* + * copyright (c) 2006 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * A tree container. + * @author Michael Niedermayer + */ + +#ifndef AVUTIL_TREE_H +#define AVUTIL_TREE_H + +#include "attributes.h" +#include "version.h" + +/** + * @addtogroup lavu_tree AVTree + * @ingroup lavu_data + * + * Low-complexity tree container + * + * Insertion, removal, finding equal, largest which is smaller than and + * smallest which is larger than, all have O(log n) worst-case complexity. + * @{ + */ + + +struct AVTreeNode; +extern const int av_tree_node_size; + +/** + * Allocate an AVTreeNode. + */ +struct AVTreeNode *av_tree_node_alloc(void); + +/** + * Find an element. + * @param root a pointer to the root node of the tree + * @param next If next is not NULL, then next[0] will contain the previous + * element and next[1] the next element. If either does not exist, + * then the corresponding entry in next is unchanged. + * @param cmp compare function used to compare elements in the tree, + * API identical to that of Standard C's qsort + * It is guaranteed that the first and only the first argument to cmp() + * will be the key parameter to av_tree_find(), thus it could if the + * user wants, be a different type (like an opaque context). + * @return An element with cmp(key, elem) == 0 or NULL if no such element + * exists in the tree. + */ +void *av_tree_find(const struct AVTreeNode *root, void *key, + int (*cmp)(const void *key, const void *b), void *next[2]); + +/** + * Insert or remove an element. + * + * If *next is NULL, then the supplied element will be removed if it exists. + * If *next is non-NULL, then the supplied element will be inserted, unless + * it already exists in the tree. + * + * @param rootp A pointer to a pointer to the root node of the tree; note that + * the root node can change during insertions, this is required + * to keep the tree balanced. + * @param key pointer to the element key to insert in the tree + * @param next Used to allocate and free AVTreeNodes. For insertion the user + * must set it to an allocated and zeroed object of at least + * av_tree_node_size bytes size. av_tree_insert() will set it to + * NULL if it has been consumed. + * For deleting elements *next is set to NULL by the user and + * av_tree_insert() will set it to the AVTreeNode which was + * used for the removed element. + * This allows the use of flat arrays, which have + * lower overhead compared to many malloced elements. + * You might want to define a function like: + * @code + * void *tree_insert(struct AVTreeNode **rootp, void *key, + * int (*cmp)(void *key, const void *b), + * AVTreeNode **next) + * { + * if (!*next) + * *next = av_mallocz(av_tree_node_size); + * return av_tree_insert(rootp, key, cmp, next); + * } + * void *tree_remove(struct AVTreeNode **rootp, void *key, + * int (*cmp)(void *key, const void *b, AVTreeNode **next)) + * { + * av_freep(next); + * return av_tree_insert(rootp, key, cmp, next); + * } + * @endcode + * @param cmp compare function used to compare elements in the tree, API identical + * to that of Standard C's qsort + * @return If no insertion happened, the found element; if an insertion or + * removal happened, then either key or NULL will be returned. + * Which one it is depends on the tree state and the implementation. You + * should make no assumptions that it's one or the other in the code. + */ +void *av_tree_insert(struct AVTreeNode **rootp, void *key, + int (*cmp)(const void *key, const void *b), + struct AVTreeNode **next); + +void av_tree_destroy(struct AVTreeNode *t); + +/** + * Apply enu(opaque, &elem) to all the elements in the tree in a given range. + * + * @param cmp a comparison function that returns < 0 for an element below the + * range, > 0 for an element above the range and == 0 for an + * element inside the range + * + * @note The cmp function should use the same ordering used to construct the + * tree. + */ +void av_tree_enumerate(struct AVTreeNode *t, void *opaque, + int (*cmp)(void *opaque, void *elem), + int (*enu)(void *opaque, void *elem)); + +/** + * @} + */ + +#endif /* AVUTIL_TREE_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/twofish.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/twofish.h new file mode 100644 index 0000000..813cfec --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/twofish.h @@ -0,0 +1,70 @@ +/* + * An implementation of the TwoFish algorithm + * Copyright (c) 2015 Supraja Meedinti + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_TWOFISH_H +#define AVUTIL_TWOFISH_H + +#include + + +/** + * @file + * @brief Public header for libavutil TWOFISH algorithm + * @defgroup lavu_twofish TWOFISH + * @ingroup lavu_crypto + * @{ + */ + +extern const int av_twofish_size; + +struct AVTWOFISH; + +/** + * Allocate an AVTWOFISH context + * To free the struct: av_free(ptr) + */ +struct AVTWOFISH *av_twofish_alloc(void); + +/** + * Initialize an AVTWOFISH context. + * + * @param ctx an AVTWOFISH context + * @param key a key of size ranging from 1 to 32 bytes used for encryption/decryption + * @param key_bits number of keybits: 128, 192, 256 If less than the required, padded with zeroes to nearest valid value; return value is 0 if key_bits is 128/192/256, -1 if less than 0, 1 otherwise + */ +int av_twofish_init(struct AVTWOFISH *ctx, const uint8_t *key, int key_bits); + +/** + * Encrypt or decrypt a buffer using a previously initialized context + * + * @param ctx an AVTWOFISH context + * @param dst destination array, can be equal to src + * @param src source array, can be equal to dst + * @param count number of 16 byte blocks + * @paran iv initialization vector for CBC mode, NULL for ECB mode + * @param decrypt 0 for encryption, 1 for decryption + */ +void av_twofish_crypt(struct AVTWOFISH *ctx, uint8_t *dst, const uint8_t *src, int count, uint8_t* iv, int decrypt); + +/** + * @} + */ +#endif /* AVUTIL_TWOFISH_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/tx.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/tx.h new file mode 100644 index 0000000..418e8ec --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/tx.h @@ -0,0 +1,117 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_TX_H +#define AVUTIL_TX_H + +#include +#include + +typedef struct AVTXContext AVTXContext; + +typedef struct AVComplexFloat { + float re, im; +} AVComplexFloat; + +typedef struct AVComplexDouble { + double re, im; +} AVComplexDouble; + +typedef struct AVComplexInt32 { + int32_t re, im; +} AVComplexInt32; + +enum AVTXType { + /** + * Standard complex to complex FFT with sample data type AVComplexFloat. + * Output is not 1/len normalized. Scaling currently unsupported. + * The stride parameter is ignored. + */ + AV_TX_FLOAT_FFT = 0, + /** + * Standard MDCT with sample data type of float and a scale type of + * float. Length is the frame size, not the window size (which is 2x frame) + * For forward transforms, the stride specifies the spacing between each + * sample in the output array in bytes. The input must be a flat array. + * For inverse transforms, the stride specifies the spacing between each + * sample in the input array in bytes. The output will be a flat array. + * Stride must be a non-zero multiple of sizeof(float). + */ + AV_TX_FLOAT_MDCT = 1, + /** + * Same as AV_TX_FLOAT_FFT with a data type of AVComplexDouble. + */ + AV_TX_DOUBLE_FFT = 2, + /** + * Same as AV_TX_FLOAT_MDCT with data and scale type of double. + * Stride must be a non-zero multiple of sizeof(double). + */ + AV_TX_DOUBLE_MDCT = 3, + /** + * Same as AV_TX_FLOAT_FFT with a data type of AVComplexInt32. + */ + AV_TX_INT32_FFT = 4, + /** + * Same as AV_TX_FLOAT_MDCT with data type of int32_t and scale type of float. + * Only scale values less than or equal to 1.0 are supported. + * Stride must be a non-zero multiple of sizeof(int32_t). + */ + AV_TX_INT32_MDCT = 5, +}; + +/** + * Function pointer to a function to perform the transform. + * + * @note Using a different context than the one allocated during av_tx_init() + * is not allowed. + * + * @param s the transform context + * @param out the output array + * @param in the input array + * @param stride the input or output stride in bytes + * + * The out and in arrays must be aligned to the maximum required by the CPU + * architecture. + * The stride must follow the constraints the transform type has specified. + */ +typedef void (*av_tx_fn)(AVTXContext *s, void *out, void *in, ptrdiff_t stride); + +/** + * Initialize a transform context with the given configuration + * Currently power of two lengths from 2 to 131072 are supported, along with + * any length decomposable to a power of two and either 3, 5 or 15. + * + * @param ctx the context to allocate, will be NULL on error + * @param tx pointer to the transform function pointer to set + * @param type type the type of transform + * @param inv whether to do an inverse or a forward transform + * @param len the size of the transform in samples + * @param scale pointer to the value to scale the output if supported by type + * @param flags currently unused + * + * @return 0 on success, negative error code on failure + */ +int av_tx_init(AVTXContext **ctx, av_tx_fn *tx, enum AVTXType type, + int inv, int len, const void *scale, uint64_t flags); + +/** + * Frees a context and sets ctx to NULL, does nothing when ctx == NULL + */ +void av_tx_uninit(AVTXContext **ctx); + +#endif /* AVUTIL_TX_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/version.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/version.h new file mode 100644 index 0000000..0ff722f --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/version.h @@ -0,0 +1,139 @@ +/* + * copyright (c) 2003 Fabrice Bellard + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +/** + * @file + * @ingroup lavu + * Libavutil version macros + */ + +#ifndef AVUTIL_VERSION_H +#define AVUTIL_VERSION_H + +#include "macros.h" + +/** + * @addtogroup version_utils + * + * Useful to check and match library version in order to maintain + * backward compatibility. + * + * The FFmpeg libraries follow a versioning sheme very similar to + * Semantic Versioning (http://semver.org/) + * The difference is that the component called PATCH is called MICRO in FFmpeg + * and its value is reset to 100 instead of 0 to keep it above or equal to 100. + * Also we do not increase MICRO for every bugfix or change in git master. + * + * Prior to FFmpeg 3.2 point releases did not change any lib version number to + * avoid aliassing different git master checkouts. + * Starting with FFmpeg 3.2, the released library versions will occupy + * a separate MAJOR.MINOR that is not used on the master development branch. + * That is if we branch a release of master 55.10.123 we will bump to 55.11.100 + * for the release and master will continue at 55.12.100 after it. Each new + * point release will then bump the MICRO improving the usefulness of the lib + * versions. + * + * @{ + */ + +#define AV_VERSION_INT(a, b, c) ((a)<<16 | (b)<<8 | (c)) +#define AV_VERSION_DOT(a, b, c) a ##.## b ##.## c +#define AV_VERSION(a, b, c) AV_VERSION_DOT(a, b, c) + +/** + * Extract version components from the full ::AV_VERSION_INT int as returned + * by functions like ::avformat_version() and ::avcodec_version() + */ +#define AV_VERSION_MAJOR(a) ((a) >> 16) +#define AV_VERSION_MINOR(a) (((a) & 0x00FF00) >> 8) +#define AV_VERSION_MICRO(a) ((a) & 0xFF) + +/** + * @} + */ + +/** + * @defgroup lavu_ver Version and Build diagnostics + * + * Macros and function useful to check at compiletime and at runtime + * which version of libavutil is in use. + * + * @{ + */ + +#define LIBAVUTIL_VERSION_MAJOR 56 +#define LIBAVUTIL_VERSION_MINOR 51 +#define LIBAVUTIL_VERSION_MICRO 100 + +#define LIBAVUTIL_VERSION_INT AV_VERSION_INT(LIBAVUTIL_VERSION_MAJOR, \ + LIBAVUTIL_VERSION_MINOR, \ + LIBAVUTIL_VERSION_MICRO) +#define LIBAVUTIL_VERSION AV_VERSION(LIBAVUTIL_VERSION_MAJOR, \ + LIBAVUTIL_VERSION_MINOR, \ + LIBAVUTIL_VERSION_MICRO) +#define LIBAVUTIL_BUILD LIBAVUTIL_VERSION_INT + +#define LIBAVUTIL_IDENT "Lavu" AV_STRINGIFY(LIBAVUTIL_VERSION) + +/** + * @defgroup lavu_depr_guards Deprecation Guards + * FF_API_* defines may be placed below to indicate public API that will be + * dropped at a future version bump. The defines themselves are not part of + * the public API and may change, break or disappear at any time. + * + * @note, when bumping the major version it is recommended to manually + * disable each FF_API_* in its own commit instead of disabling them all + * at once through the bump. This improves the git bisect-ability of the change. + * + * @{ + */ + +#ifndef FF_API_VAAPI +#define FF_API_VAAPI (LIBAVUTIL_VERSION_MAJOR < 57) +#endif +#ifndef FF_API_FRAME_QP +#define FF_API_FRAME_QP (LIBAVUTIL_VERSION_MAJOR < 57) +#endif +#ifndef FF_API_PLUS1_MINUS1 +#define FF_API_PLUS1_MINUS1 (LIBAVUTIL_VERSION_MAJOR < 57) +#endif +#ifndef FF_API_ERROR_FRAME +#define FF_API_ERROR_FRAME (LIBAVUTIL_VERSION_MAJOR < 57) +#endif +#ifndef FF_API_PKT_PTS +#define FF_API_PKT_PTS (LIBAVUTIL_VERSION_MAJOR < 57) +#endif +#ifndef FF_API_CRYPTO_SIZE_T +#define FF_API_CRYPTO_SIZE_T (LIBAVUTIL_VERSION_MAJOR < 57) +#endif +#ifndef FF_API_FRAME_GET_SET +#define FF_API_FRAME_GET_SET (LIBAVUTIL_VERSION_MAJOR < 57) +#endif +#ifndef FF_API_PSEUDOPAL +#define FF_API_PSEUDOPAL (LIBAVUTIL_VERSION_MAJOR < 57) +#endif + + +/** + * @} + * @} + */ + +#endif /* AVUTIL_VERSION_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/video_enc_params.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/video_enc_params.h new file mode 100644 index 0000000..43fa443 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/video_enc_params.h @@ -0,0 +1,163 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_VIDEO_ENC_PARAMS_H +#define AVUTIL_VIDEO_ENC_PARAMS_H + +#include +#include + +#include "libavutil/avassert.h" +#include "libavutil/frame.h" + +enum AVVideoEncParamsType { + AV_VIDEO_ENC_PARAMS_NONE = -1, + /** + * VP9 stores: + * - per-frame base (luma AC) quantizer index, exported as AVVideoEncParams.qp + * - deltas for luma DC, chroma AC and chroma DC, exported in the + * corresponding entries in AVVideoEncParams.delta_qp + * - per-segment delta, exported as for each block as AVVideoBlockParams.delta_qp + * + * To compute the resulting quantizer index for a block: + * - for luma AC, add the base qp and the per-block delta_qp, saturating to + * unsigned 8-bit. + * - for luma DC and chroma AC/DC, add the corresponding + * AVVideoBlockParams.delta_qp to the luma AC index, again saturating to + * unsigned 8-bit. + */ + AV_VIDEO_ENC_PARAMS_VP9, + + /** + * H.264 stores: + * - in PPS (per-picture): + * * initial QP_Y (luma) value, exported as AVVideoEncParams.qp + * * delta(s) for chroma QP values (same for both, or each separately), + * exported as in the corresponding entries in AVVideoEncParams.delta_qp + * - per-slice QP delta, not exported directly, added to the per-MB value + * - per-MB delta; not exported directly; the final per-MB quantizer + * parameter - QP_Y - minus the value in AVVideoEncParams.qp is exported + * as AVVideoBlockParams.qp_delta. + */ + AV_VIDEO_ENC_PARAMS_H264, +}; + +/** + * Video encoding parameters for a given frame. This struct is allocated along + * with an optional array of per-block AVVideoBlockParams descriptors. + * Must be allocated with av_video_enc_params_alloc(). + */ +typedef struct AVVideoEncParams { + /** + * Number of blocks in the array. + * + * May be 0, in which case no per-block information is present. In this case + * the values of blocks_offset / block_size are unspecified and should not + * be accessed. + */ + unsigned int nb_blocks; + /** + * Offset in bytes from the beginning of this structure at which the array + * of blocks starts. + */ + size_t blocks_offset; + /* + * Size of each block in bytes. May not match sizeof(AVVideoBlockParams). + */ + size_t block_size; + + /** + * Type of the parameters (the codec they are used with). + */ + enum AVVideoEncParamsType type; + + /** + * Base quantisation parameter for the frame. The final quantiser for a + * given block in a given plane is obtained from this value, possibly + * combined with {@code delta_qp} and the per-block delta in a manner + * documented for each type. + */ + int32_t qp; + + /** + * Quantisation parameter offset from the base (per-frame) qp for a given + * plane (first index) and AC/DC coefficients (second index). + */ + int32_t delta_qp[4][2]; +} AVVideoEncParams; + +/** + * Data structure for storing block-level encoding information. + * It is allocated as a part of AVVideoEncParams and should be retrieved with + * av_video_enc_params_block(). + * + * sizeof(AVVideoBlockParams) is not a part of the ABI and new fields may be + * added to it. + */ +typedef struct AVVideoBlockParams { + /** + * Distance in luma pixels from the top-left corner of the visible frame + * to the top-left corner of the block. + * Can be negative if top/right padding is present on the coded frame. + */ + int src_x, src_y; + /** + * Width and height of the block in luma pixels. + */ + int w, h; + + /** + * Difference between this block's final quantization parameter and the + * corresponding per-frame value. + */ + int32_t delta_qp; +} AVVideoBlockParams; + +/* + * Get the block at the specified {@code idx}. Must be between 0 and nb_blocks. + */ +static av_always_inline AVVideoBlockParams* +av_video_enc_params_block(AVVideoEncParams *par, unsigned int idx) +{ + av_assert0(idx < par->nb_blocks); + return (AVVideoBlockParams *)((uint8_t *)par + par->blocks_offset + + idx * par->block_size); +} + +/** + * Allocates memory for AVVideoEncParams of the given type, plus an array of + * {@code nb_blocks} AVVideoBlockParams and initializes the variables. Can be + * freed with a normal av_free() call. + * + * @param out_size if non-NULL, the size in bytes of the resulting data array is + * written here. + */ +AVVideoEncParams *av_video_enc_params_alloc(enum AVVideoEncParamsType type, + unsigned int nb_blocks, size_t *out_size); + +/** + * Allocates memory for AVEncodeInfoFrame plus an array of + * {@code nb_blocks} AVEncodeInfoBlock in the given AVFrame {@code frame} + * as AVFrameSideData of type AV_FRAME_DATA_ENCODE_INFO + * and initializes the variables. + */ +AVVideoEncParams* +av_video_enc_params_create_side_data(AVFrame *frame, enum AVVideoEncParamsType type, + unsigned int nb_blocks); + +#endif /* AVUTIL_VIDEO_ENC_PARAMS_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/xtea.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/xtea.h new file mode 100644 index 0000000..735427c --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libavutil/xtea.h @@ -0,0 +1,94 @@ +/* + * A 32-bit implementation of the XTEA algorithm + * Copyright (c) 2012 Samuel Pitoiset + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef AVUTIL_XTEA_H +#define AVUTIL_XTEA_H + +#include + +/** + * @file + * @brief Public header for libavutil XTEA algorithm + * @defgroup lavu_xtea XTEA + * @ingroup lavu_crypto + * @{ + */ + +typedef struct AVXTEA { + uint32_t key[16]; +} AVXTEA; + +/** + * Allocate an AVXTEA context. + */ +AVXTEA *av_xtea_alloc(void); + +/** + * Initialize an AVXTEA context. + * + * @param ctx an AVXTEA context + * @param key a key of 16 bytes used for encryption/decryption, + * interpreted as big endian 32 bit numbers + */ +void av_xtea_init(struct AVXTEA *ctx, const uint8_t key[16]); + +/** + * Initialize an AVXTEA context. + * + * @param ctx an AVXTEA context + * @param key a key of 16 bytes used for encryption/decryption, + * interpreted as little endian 32 bit numbers + */ +void av_xtea_le_init(struct AVXTEA *ctx, const uint8_t key[16]); + +/** + * Encrypt or decrypt a buffer using a previously initialized context, + * in big endian format. + * + * @param ctx an AVXTEA context + * @param dst destination array, can be equal to src + * @param src source array, can be equal to dst + * @param count number of 8 byte blocks + * @param iv initialization vector for CBC mode, if NULL then ECB will be used + * @param decrypt 0 for encryption, 1 for decryption + */ +void av_xtea_crypt(struct AVXTEA *ctx, uint8_t *dst, const uint8_t *src, + int count, uint8_t *iv, int decrypt); + +/** + * Encrypt or decrypt a buffer using a previously initialized context, + * in little endian format. + * + * @param ctx an AVXTEA context + * @param dst destination array, can be equal to src + * @param src source array, can be equal to dst + * @param count number of 8 byte blocks + * @param iv initialization vector for CBC mode, if NULL then ECB will be used + * @param decrypt 0 for encryption, 1 for decryption + */ +void av_xtea_le_crypt(struct AVXTEA *ctx, uint8_t *dst, const uint8_t *src, + int count, uint8_t *iv, int decrypt); + +/** + * @} + */ + +#endif /* AVUTIL_XTEA_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libpostproc/postprocess.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libpostproc/postprocess.h new file mode 100644 index 0000000..348ee7c --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libpostproc/postprocess.h @@ -0,0 +1,107 @@ +/* + * Copyright (C) 2001-2003 Michael Niedermayer (michaelni@gmx.at) + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef POSTPROC_POSTPROCESS_H +#define POSTPROC_POSTPROCESS_H + +/** + * @file + * @ingroup lpp + * external API header + */ + +/** + * @defgroup lpp libpostproc + * Video postprocessing library. + * + * @{ + */ + +#include "libpostproc/version.h" + +/** + * Return the LIBPOSTPROC_VERSION_INT constant. + */ +unsigned postproc_version(void); + +/** + * Return the libpostproc build-time configuration. + */ +const char *postproc_configuration(void); + +/** + * Return the libpostproc license. + */ +const char *postproc_license(void); + +#define PP_QUALITY_MAX 6 + +#include + +typedef void pp_context; +typedef void pp_mode; + +#if LIBPOSTPROC_VERSION_INT < (52<<16) +typedef pp_context pp_context_t; +typedef pp_mode pp_mode_t; +extern const char *const pp_help; ///< a simple help text +#else +extern const char pp_help[]; ///< a simple help text +#endif + +void pp_postprocess(const uint8_t * src[3], const int srcStride[3], + uint8_t * dst[3], const int dstStride[3], + int horizontalSize, int verticalSize, + const int8_t *QP_store, int QP_stride, + pp_mode *mode, pp_context *ppContext, int pict_type); + + +/** + * Return a pp_mode or NULL if an error occurred. + * + * @param name the string after "-pp" on the command line + * @param quality a number from 0 to PP_QUALITY_MAX + */ +pp_mode *pp_get_mode_by_name_and_quality(const char *name, int quality); +void pp_free_mode(pp_mode *mode); + +pp_context *pp_get_context(int width, int height, int flags); +void pp_free_context(pp_context *ppContext); + +#define PP_CPU_CAPS_MMX 0x80000000 +#define PP_CPU_CAPS_MMX2 0x20000000 +#define PP_CPU_CAPS_3DNOW 0x40000000 +#define PP_CPU_CAPS_ALTIVEC 0x10000000 +#define PP_CPU_CAPS_AUTO 0x00080000 + +#define PP_FORMAT 0x00000008 +#define PP_FORMAT_420 (0x00000011|PP_FORMAT) +#define PP_FORMAT_422 (0x00000001|PP_FORMAT) +#define PP_FORMAT_411 (0x00000002|PP_FORMAT) +#define PP_FORMAT_444 (0x00000000|PP_FORMAT) +#define PP_FORMAT_440 (0x00000010|PP_FORMAT) + +#define PP_PICT_TYPE_QP2 0x00000010 ///< MPEG2 style QScale + +/** + * @} + */ + +#endif /* POSTPROC_POSTPROCESS_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libpostproc/version.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libpostproc/version.h new file mode 100644 index 0000000..e5de9ae --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libpostproc/version.h @@ -0,0 +1,45 @@ +/* + * Version macros. + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef POSTPROC_VERSION_H +#define POSTPROC_VERSION_H + +/** + * @file + * Libpostproc version macros + */ + +#include "libavutil/avutil.h" + +#define LIBPOSTPROC_VERSION_MAJOR 55 +#define LIBPOSTPROC_VERSION_MINOR 7 +#define LIBPOSTPROC_VERSION_MICRO 100 + +#define LIBPOSTPROC_VERSION_INT AV_VERSION_INT(LIBPOSTPROC_VERSION_MAJOR, \ + LIBPOSTPROC_VERSION_MINOR, \ + LIBPOSTPROC_VERSION_MICRO) +#define LIBPOSTPROC_VERSION AV_VERSION(LIBPOSTPROC_VERSION_MAJOR, \ + LIBPOSTPROC_VERSION_MINOR, \ + LIBPOSTPROC_VERSION_MICRO) +#define LIBPOSTPROC_BUILD LIBPOSTPROC_VERSION_INT + +#define LIBPOSTPROC_IDENT "postproc" AV_STRINGIFY(LIBPOSTPROC_VERSION) + +#endif /* POSTPROC_VERSION_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libswresample/swresample.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libswresample/swresample.h new file mode 100644 index 0000000..c7b84fb --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libswresample/swresample.h @@ -0,0 +1,579 @@ +/* + * Copyright (C) 2011-2013 Michael Niedermayer (michaelni@gmx.at) + * + * This file is part of libswresample + * + * libswresample is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * libswresample is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with libswresample; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef SWRESAMPLE_SWRESAMPLE_H +#define SWRESAMPLE_SWRESAMPLE_H + +/** + * @file + * @ingroup lswr + * libswresample public header + */ + +/** + * @defgroup lswr libswresample + * @{ + * + * Audio resampling, sample format conversion and mixing library. + * + * Interaction with lswr is done through SwrContext, which is + * allocated with swr_alloc() or swr_alloc_set_opts(). It is opaque, so all parameters + * must be set with the @ref avoptions API. + * + * The first thing you will need to do in order to use lswr is to allocate + * SwrContext. This can be done with swr_alloc() or swr_alloc_set_opts(). If you + * are using the former, you must set options through the @ref avoptions API. + * The latter function provides the same feature, but it allows you to set some + * common options in the same statement. + * + * For example the following code will setup conversion from planar float sample + * format to interleaved signed 16-bit integer, downsampling from 48kHz to + * 44.1kHz and downmixing from 5.1 channels to stereo (using the default mixing + * matrix). This is using the swr_alloc() function. + * @code + * SwrContext *swr = swr_alloc(); + * av_opt_set_channel_layout(swr, "in_channel_layout", AV_CH_LAYOUT_5POINT1, 0); + * av_opt_set_channel_layout(swr, "out_channel_layout", AV_CH_LAYOUT_STEREO, 0); + * av_opt_set_int(swr, "in_sample_rate", 48000, 0); + * av_opt_set_int(swr, "out_sample_rate", 44100, 0); + * av_opt_set_sample_fmt(swr, "in_sample_fmt", AV_SAMPLE_FMT_FLTP, 0); + * av_opt_set_sample_fmt(swr, "out_sample_fmt", AV_SAMPLE_FMT_S16, 0); + * @endcode + * + * The same job can be done using swr_alloc_set_opts() as well: + * @code + * SwrContext *swr = swr_alloc_set_opts(NULL, // we're allocating a new context + * AV_CH_LAYOUT_STEREO, // out_ch_layout + * AV_SAMPLE_FMT_S16, // out_sample_fmt + * 44100, // out_sample_rate + * AV_CH_LAYOUT_5POINT1, // in_ch_layout + * AV_SAMPLE_FMT_FLTP, // in_sample_fmt + * 48000, // in_sample_rate + * 0, // log_offset + * NULL); // log_ctx + * @endcode + * + * Once all values have been set, it must be initialized with swr_init(). If + * you need to change the conversion parameters, you can change the parameters + * using @ref AVOptions, as described above in the first example; or by using + * swr_alloc_set_opts(), but with the first argument the allocated context. + * You must then call swr_init() again. + * + * The conversion itself is done by repeatedly calling swr_convert(). + * Note that the samples may get buffered in swr if you provide insufficient + * output space or if sample rate conversion is done, which requires "future" + * samples. Samples that do not require future input can be retrieved at any + * time by using swr_convert() (in_count can be set to 0). + * At the end of conversion the resampling buffer can be flushed by calling + * swr_convert() with NULL in and 0 in_count. + * + * The samples used in the conversion process can be managed with the libavutil + * @ref lavu_sampmanip "samples manipulation" API, including av_samples_alloc() + * function used in the following example. + * + * The delay between input and output, can at any time be found by using + * swr_get_delay(). + * + * The following code demonstrates the conversion loop assuming the parameters + * from above and caller-defined functions get_input() and handle_output(): + * @code + * uint8_t **input; + * int in_samples; + * + * while (get_input(&input, &in_samples)) { + * uint8_t *output; + * int out_samples = av_rescale_rnd(swr_get_delay(swr, 48000) + + * in_samples, 44100, 48000, AV_ROUND_UP); + * av_samples_alloc(&output, NULL, 2, out_samples, + * AV_SAMPLE_FMT_S16, 0); + * out_samples = swr_convert(swr, &output, out_samples, + * input, in_samples); + * handle_output(output, out_samples); + * av_freep(&output); + * } + * @endcode + * + * When the conversion is finished, the conversion + * context and everything associated with it must be freed with swr_free(). + * A swr_close() function is also available, but it exists mainly for + * compatibility with libavresample, and is not required to be called. + * + * There will be no memory leak if the data is not completely flushed before + * swr_free(). + */ + +#include +#include "libavutil/channel_layout.h" +#include "libavutil/frame.h" +#include "libavutil/samplefmt.h" + +#include "libswresample/version.h" + +/** + * @name Option constants + * These constants are used for the @ref avoptions interface for lswr. + * @{ + * + */ + +#define SWR_FLAG_RESAMPLE 1 ///< Force resampling even if equal sample rate +//TODO use int resample ? +//long term TODO can we enable this dynamically? + +/** Dithering algorithms */ +enum SwrDitherType { + SWR_DITHER_NONE = 0, + SWR_DITHER_RECTANGULAR, + SWR_DITHER_TRIANGULAR, + SWR_DITHER_TRIANGULAR_HIGHPASS, + + SWR_DITHER_NS = 64, ///< not part of API/ABI + SWR_DITHER_NS_LIPSHITZ, + SWR_DITHER_NS_F_WEIGHTED, + SWR_DITHER_NS_MODIFIED_E_WEIGHTED, + SWR_DITHER_NS_IMPROVED_E_WEIGHTED, + SWR_DITHER_NS_SHIBATA, + SWR_DITHER_NS_LOW_SHIBATA, + SWR_DITHER_NS_HIGH_SHIBATA, + SWR_DITHER_NB, ///< not part of API/ABI +}; + +/** Resampling Engines */ +enum SwrEngine { + SWR_ENGINE_SWR, /**< SW Resampler */ + SWR_ENGINE_SOXR, /**< SoX Resampler */ + SWR_ENGINE_NB, ///< not part of API/ABI +}; + +/** Resampling Filter Types */ +enum SwrFilterType { + SWR_FILTER_TYPE_CUBIC, /**< Cubic */ + SWR_FILTER_TYPE_BLACKMAN_NUTTALL, /**< Blackman Nuttall windowed sinc */ + SWR_FILTER_TYPE_KAISER, /**< Kaiser windowed sinc */ +}; + +/** + * @} + */ + +/** + * The libswresample context. Unlike libavcodec and libavformat, this structure + * is opaque. This means that if you would like to set options, you must use + * the @ref avoptions API and cannot directly set values to members of the + * structure. + */ +typedef struct SwrContext SwrContext; + +/** + * Get the AVClass for SwrContext. It can be used in combination with + * AV_OPT_SEARCH_FAKE_OBJ for examining options. + * + * @see av_opt_find(). + * @return the AVClass of SwrContext + */ +const AVClass *swr_get_class(void); + +/** + * @name SwrContext constructor functions + * @{ + */ + +/** + * Allocate SwrContext. + * + * If you use this function you will need to set the parameters (manually or + * with swr_alloc_set_opts()) before calling swr_init(). + * + * @see swr_alloc_set_opts(), swr_init(), swr_free() + * @return NULL on error, allocated context otherwise + */ +struct SwrContext *swr_alloc(void); + +/** + * Initialize context after user parameters have been set. + * @note The context must be configured using the AVOption API. + * + * @see av_opt_set_int() + * @see av_opt_set_dict() + * + * @param[in,out] s Swr context to initialize + * @return AVERROR error code in case of failure. + */ +int swr_init(struct SwrContext *s); + +/** + * Check whether an swr context has been initialized or not. + * + * @param[in] s Swr context to check + * @see swr_init() + * @return positive if it has been initialized, 0 if not initialized + */ +int swr_is_initialized(struct SwrContext *s); + +/** + * Allocate SwrContext if needed and set/reset common parameters. + * + * This function does not require s to be allocated with swr_alloc(). On the + * other hand, swr_alloc() can use swr_alloc_set_opts() to set the parameters + * on the allocated context. + * + * @param s existing Swr context if available, or NULL if not + * @param out_ch_layout output channel layout (AV_CH_LAYOUT_*) + * @param out_sample_fmt output sample format (AV_SAMPLE_FMT_*). + * @param out_sample_rate output sample rate (frequency in Hz) + * @param in_ch_layout input channel layout (AV_CH_LAYOUT_*) + * @param in_sample_fmt input sample format (AV_SAMPLE_FMT_*). + * @param in_sample_rate input sample rate (frequency in Hz) + * @param log_offset logging level offset + * @param log_ctx parent logging context, can be NULL + * + * @see swr_init(), swr_free() + * @return NULL on error, allocated context otherwise + */ +struct SwrContext *swr_alloc_set_opts(struct SwrContext *s, + int64_t out_ch_layout, enum AVSampleFormat out_sample_fmt, int out_sample_rate, + int64_t in_ch_layout, enum AVSampleFormat in_sample_fmt, int in_sample_rate, + int log_offset, void *log_ctx); + +/** + * @} + * + * @name SwrContext destructor functions + * @{ + */ + +/** + * Free the given SwrContext and set the pointer to NULL. + * + * @param[in] s a pointer to a pointer to Swr context + */ +void swr_free(struct SwrContext **s); + +/** + * Closes the context so that swr_is_initialized() returns 0. + * + * The context can be brought back to life by running swr_init(), + * swr_init() can also be used without swr_close(). + * This function is mainly provided for simplifying the usecase + * where one tries to support libavresample and libswresample. + * + * @param[in,out] s Swr context to be closed + */ +void swr_close(struct SwrContext *s); + +/** + * @} + * + * @name Core conversion functions + * @{ + */ + +/** Convert audio. + * + * in and in_count can be set to 0 to flush the last few samples out at the + * end. + * + * If more input is provided than output space, then the input will be buffered. + * You can avoid this buffering by using swr_get_out_samples() to retrieve an + * upper bound on the required number of output samples for the given number of + * input samples. Conversion will run directly without copying whenever possible. + * + * @param s allocated Swr context, with parameters set + * @param out output buffers, only the first one need be set in case of packed audio + * @param out_count amount of space available for output in samples per channel + * @param in input buffers, only the first one need to be set in case of packed audio + * @param in_count number of input samples available in one channel + * + * @return number of samples output per channel, negative value on error + */ +int swr_convert(struct SwrContext *s, uint8_t **out, int out_count, + const uint8_t **in , int in_count); + +/** + * Convert the next timestamp from input to output + * timestamps are in 1/(in_sample_rate * out_sample_rate) units. + * + * @note There are 2 slightly differently behaving modes. + * @li When automatic timestamp compensation is not used, (min_compensation >= FLT_MAX) + * in this case timestamps will be passed through with delays compensated + * @li When automatic timestamp compensation is used, (min_compensation < FLT_MAX) + * in this case the output timestamps will match output sample numbers. + * See ffmpeg-resampler(1) for the two modes of compensation. + * + * @param s[in] initialized Swr context + * @param pts[in] timestamp for the next input sample, INT64_MIN if unknown + * @see swr_set_compensation(), swr_drop_output(), and swr_inject_silence() are + * function used internally for timestamp compensation. + * @return the output timestamp for the next output sample + */ +int64_t swr_next_pts(struct SwrContext *s, int64_t pts); + +/** + * @} + * + * @name Low-level option setting functions + * These functons provide a means to set low-level options that is not possible + * with the AVOption API. + * @{ + */ + +/** + * Activate resampling compensation ("soft" compensation). This function is + * internally called when needed in swr_next_pts(). + * + * @param[in,out] s allocated Swr context. If it is not initialized, + * or SWR_FLAG_RESAMPLE is not set, swr_init() is + * called with the flag set. + * @param[in] sample_delta delta in PTS per sample + * @param[in] compensation_distance number of samples to compensate for + * @return >= 0 on success, AVERROR error codes if: + * @li @c s is NULL, + * @li @c compensation_distance is less than 0, + * @li @c compensation_distance is 0 but sample_delta is not, + * @li compensation unsupported by resampler, or + * @li swr_init() fails when called. + */ +int swr_set_compensation(struct SwrContext *s, int sample_delta, int compensation_distance); + +/** + * Set a customized input channel mapping. + * + * @param[in,out] s allocated Swr context, not yet initialized + * @param[in] channel_map customized input channel mapping (array of channel + * indexes, -1 for a muted channel) + * @return >= 0 on success, or AVERROR error code in case of failure. + */ +int swr_set_channel_mapping(struct SwrContext *s, const int *channel_map); + +/** + * Generate a channel mixing matrix. + * + * This function is the one used internally by libswresample for building the + * default mixing matrix. It is made public just as a utility function for + * building custom matrices. + * + * @param in_layout input channel layout + * @param out_layout output channel layout + * @param center_mix_level mix level for the center channel + * @param surround_mix_level mix level for the surround channel(s) + * @param lfe_mix_level mix level for the low-frequency effects channel + * @param rematrix_maxval if 1.0, coefficients will be normalized to prevent + * overflow. if INT_MAX, coefficients will not be + * normalized. + * @param[out] matrix mixing coefficients; matrix[i + stride * o] is + * the weight of input channel i in output channel o. + * @param stride distance between adjacent input channels in the + * matrix array + * @param matrix_encoding matrixed stereo downmix mode (e.g. dplii) + * @param log_ctx parent logging context, can be NULL + * @return 0 on success, negative AVERROR code on failure + */ +int swr_build_matrix(uint64_t in_layout, uint64_t out_layout, + double center_mix_level, double surround_mix_level, + double lfe_mix_level, double rematrix_maxval, + double rematrix_volume, double *matrix, + int stride, enum AVMatrixEncoding matrix_encoding, + void *log_ctx); + +/** + * Set a customized remix matrix. + * + * @param s allocated Swr context, not yet initialized + * @param matrix remix coefficients; matrix[i + stride * o] is + * the weight of input channel i in output channel o + * @param stride offset between lines of the matrix + * @return >= 0 on success, or AVERROR error code in case of failure. + */ +int swr_set_matrix(struct SwrContext *s, const double *matrix, int stride); + +/** + * @} + * + * @name Sample handling functions + * @{ + */ + +/** + * Drops the specified number of output samples. + * + * This function, along with swr_inject_silence(), is called by swr_next_pts() + * if needed for "hard" compensation. + * + * @param s allocated Swr context + * @param count number of samples to be dropped + * + * @return >= 0 on success, or a negative AVERROR code on failure + */ +int swr_drop_output(struct SwrContext *s, int count); + +/** + * Injects the specified number of silence samples. + * + * This function, along with swr_drop_output(), is called by swr_next_pts() + * if needed for "hard" compensation. + * + * @param s allocated Swr context + * @param count number of samples to be dropped + * + * @return >= 0 on success, or a negative AVERROR code on failure + */ +int swr_inject_silence(struct SwrContext *s, int count); + +/** + * Gets the delay the next input sample will experience relative to the next output sample. + * + * Swresample can buffer data if more input has been provided than available + * output space, also converting between sample rates needs a delay. + * This function returns the sum of all such delays. + * The exact delay is not necessarily an integer value in either input or + * output sample rate. Especially when downsampling by a large value, the + * output sample rate may be a poor choice to represent the delay, similarly + * for upsampling and the input sample rate. + * + * @param s swr context + * @param base timebase in which the returned delay will be: + * @li if it's set to 1 the returned delay is in seconds + * @li if it's set to 1000 the returned delay is in milliseconds + * @li if it's set to the input sample rate then the returned + * delay is in input samples + * @li if it's set to the output sample rate then the returned + * delay is in output samples + * @li if it's the least common multiple of in_sample_rate and + * out_sample_rate then an exact rounding-free delay will be + * returned + * @returns the delay in 1 / @c base units. + */ +int64_t swr_get_delay(struct SwrContext *s, int64_t base); + +/** + * Find an upper bound on the number of samples that the next swr_convert + * call will output, if called with in_samples of input samples. This + * depends on the internal state, and anything changing the internal state + * (like further swr_convert() calls) will may change the number of samples + * swr_get_out_samples() returns for the same number of input samples. + * + * @param in_samples number of input samples. + * @note any call to swr_inject_silence(), swr_convert(), swr_next_pts() + * or swr_set_compensation() invalidates this limit + * @note it is recommended to pass the correct available buffer size + * to all functions like swr_convert() even if swr_get_out_samples() + * indicates that less would be used. + * @returns an upper bound on the number of samples that the next swr_convert + * will output or a negative value to indicate an error + */ +int swr_get_out_samples(struct SwrContext *s, int in_samples); + +/** + * @} + * + * @name Configuration accessors + * @{ + */ + +/** + * Return the @ref LIBSWRESAMPLE_VERSION_INT constant. + * + * This is useful to check if the build-time libswresample has the same version + * as the run-time one. + * + * @returns the unsigned int-typed version + */ +unsigned swresample_version(void); + +/** + * Return the swr build-time configuration. + * + * @returns the build-time @c ./configure flags + */ +const char *swresample_configuration(void); + +/** + * Return the swr license. + * + * @returns the license of libswresample, determined at build-time + */ +const char *swresample_license(void); + +/** + * @} + * + * @name AVFrame based API + * @{ + */ + +/** + * Convert the samples in the input AVFrame and write them to the output AVFrame. + * + * Input and output AVFrames must have channel_layout, sample_rate and format set. + * + * If the output AVFrame does not have the data pointers allocated the nb_samples + * field will be set using av_frame_get_buffer() + * is called to allocate the frame. + * + * The output AVFrame can be NULL or have fewer allocated samples than required. + * In this case, any remaining samples not written to the output will be added + * to an internal FIFO buffer, to be returned at the next call to this function + * or to swr_convert(). + * + * If converting sample rate, there may be data remaining in the internal + * resampling delay buffer. swr_get_delay() tells the number of + * remaining samples. To get this data as output, call this function or + * swr_convert() with NULL input. + * + * If the SwrContext configuration does not match the output and + * input AVFrame settings the conversion does not take place and depending on + * which AVFrame is not matching AVERROR_OUTPUT_CHANGED, AVERROR_INPUT_CHANGED + * or the result of a bitwise-OR of them is returned. + * + * @see swr_delay() + * @see swr_convert() + * @see swr_get_delay() + * + * @param swr audio resample context + * @param output output AVFrame + * @param input input AVFrame + * @return 0 on success, AVERROR on failure or nonmatching + * configuration. + */ +int swr_convert_frame(SwrContext *swr, + AVFrame *output, const AVFrame *input); + +/** + * Configure or reconfigure the SwrContext using the information + * provided by the AVFrames. + * + * The original resampling context is reset even on failure. + * The function calls swr_close() internally if the context is open. + * + * @see swr_close(); + * + * @param swr audio resample context + * @param output output AVFrame + * @param input input AVFrame + * @return 0 on success, AVERROR on failure. + */ +int swr_config_frame(SwrContext *swr, const AVFrame *out, const AVFrame *in); + +/** + * @} + * @} + */ + +#endif /* SWRESAMPLE_SWRESAMPLE_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libswresample/version.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libswresample/version.h new file mode 100644 index 0000000..2577391 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libswresample/version.h @@ -0,0 +1,45 @@ +/* + * Version macros. + * + * This file is part of libswresample + * + * libswresample is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * libswresample is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with libswresample; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef SWRESAMPLE_VERSION_H +#define SWRESAMPLE_VERSION_H + +/** + * @file + * Libswresample version macros + */ + +#include "libavutil/avutil.h" + +#define LIBSWRESAMPLE_VERSION_MAJOR 3 +#define LIBSWRESAMPLE_VERSION_MINOR 7 +#define LIBSWRESAMPLE_VERSION_MICRO 100 + +#define LIBSWRESAMPLE_VERSION_INT AV_VERSION_INT(LIBSWRESAMPLE_VERSION_MAJOR, \ + LIBSWRESAMPLE_VERSION_MINOR, \ + LIBSWRESAMPLE_VERSION_MICRO) +#define LIBSWRESAMPLE_VERSION AV_VERSION(LIBSWRESAMPLE_VERSION_MAJOR, \ + LIBSWRESAMPLE_VERSION_MINOR, \ + LIBSWRESAMPLE_VERSION_MICRO) +#define LIBSWRESAMPLE_BUILD LIBSWRESAMPLE_VERSION_INT + +#define LIBSWRESAMPLE_IDENT "SwR" AV_STRINGIFY(LIBSWRESAMPLE_VERSION) + +#endif /* SWRESAMPLE_VERSION_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libswscale/swscale.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libswscale/swscale.h new file mode 100644 index 0000000..7713f51 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libswscale/swscale.h @@ -0,0 +1,336 @@ +/* + * Copyright (C) 2001-2011 Michael Niedermayer + * + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef SWSCALE_SWSCALE_H +#define SWSCALE_SWSCALE_H + +/** + * @file + * @ingroup libsws + * external API header + */ + +#include + +#include "libavutil/avutil.h" +#include "libavutil/log.h" +#include "libavutil/pixfmt.h" +#include "version.h" + +/** + * @defgroup libsws libswscale + * Color conversion and scaling library. + * + * @{ + * + * Return the LIBSWSCALE_VERSION_INT constant. + */ +unsigned swscale_version(void); + +/** + * Return the libswscale build-time configuration. + */ +const char *swscale_configuration(void); + +/** + * Return the libswscale license. + */ +const char *swscale_license(void); + +/* values for the flags, the stuff on the command line is different */ +#define SWS_FAST_BILINEAR 1 +#define SWS_BILINEAR 2 +#define SWS_BICUBIC 4 +#define SWS_X 8 +#define SWS_POINT 0x10 +#define SWS_AREA 0x20 +#define SWS_BICUBLIN 0x40 +#define SWS_GAUSS 0x80 +#define SWS_SINC 0x100 +#define SWS_LANCZOS 0x200 +#define SWS_SPLINE 0x400 + +#define SWS_SRC_V_CHR_DROP_MASK 0x30000 +#define SWS_SRC_V_CHR_DROP_SHIFT 16 + +#define SWS_PARAM_DEFAULT 123456 + +#define SWS_PRINT_INFO 0x1000 + +//the following 3 flags are not completely implemented +//internal chrominance subsampling info +#define SWS_FULL_CHR_H_INT 0x2000 +//input subsampling info +#define SWS_FULL_CHR_H_INP 0x4000 +#define SWS_DIRECT_BGR 0x8000 +#define SWS_ACCURATE_RND 0x40000 +#define SWS_BITEXACT 0x80000 +#define SWS_ERROR_DIFFUSION 0x800000 + +#define SWS_MAX_REDUCE_CUTOFF 0.002 + +#define SWS_CS_ITU709 1 +#define SWS_CS_FCC 4 +#define SWS_CS_ITU601 5 +#define SWS_CS_ITU624 5 +#define SWS_CS_SMPTE170M 5 +#define SWS_CS_SMPTE240M 7 +#define SWS_CS_DEFAULT 5 +#define SWS_CS_BT2020 9 + +/** + * Return a pointer to yuv<->rgb coefficients for the given colorspace + * suitable for sws_setColorspaceDetails(). + * + * @param colorspace One of the SWS_CS_* macros. If invalid, + * SWS_CS_DEFAULT is used. + */ +const int *sws_getCoefficients(int colorspace); + +// when used for filters they must have an odd number of elements +// coeffs cannot be shared between vectors +typedef struct SwsVector { + double *coeff; ///< pointer to the list of coefficients + int length; ///< number of coefficients in the vector +} SwsVector; + +// vectors can be shared +typedef struct SwsFilter { + SwsVector *lumH; + SwsVector *lumV; + SwsVector *chrH; + SwsVector *chrV; +} SwsFilter; + +struct SwsContext; + +/** + * Return a positive value if pix_fmt is a supported input format, 0 + * otherwise. + */ +int sws_isSupportedInput(enum AVPixelFormat pix_fmt); + +/** + * Return a positive value if pix_fmt is a supported output format, 0 + * otherwise. + */ +int sws_isSupportedOutput(enum AVPixelFormat pix_fmt); + +/** + * @param[in] pix_fmt the pixel format + * @return a positive value if an endianness conversion for pix_fmt is + * supported, 0 otherwise. + */ +int sws_isSupportedEndiannessConversion(enum AVPixelFormat pix_fmt); + +/** + * Allocate an empty SwsContext. This must be filled and passed to + * sws_init_context(). For filling see AVOptions, options.c and + * sws_setColorspaceDetails(). + */ +struct SwsContext *sws_alloc_context(void); + +/** + * Initialize the swscaler context sws_context. + * + * @return zero or positive value on success, a negative value on + * error + */ +av_warn_unused_result +int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter); + +/** + * Free the swscaler context swsContext. + * If swsContext is NULL, then does nothing. + */ +void sws_freeContext(struct SwsContext *swsContext); + +/** + * Allocate and return an SwsContext. You need it to perform + * scaling/conversion operations using sws_scale(). + * + * @param srcW the width of the source image + * @param srcH the height of the source image + * @param srcFormat the source image format + * @param dstW the width of the destination image + * @param dstH the height of the destination image + * @param dstFormat the destination image format + * @param flags specify which algorithm and options to use for rescaling + * @param param extra parameters to tune the used scaler + * For SWS_BICUBIC param[0] and [1] tune the shape of the basis + * function, param[0] tunes f(1) and param[1] f´(1) + * For SWS_GAUSS param[0] tunes the exponent and thus cutoff + * frequency + * For SWS_LANCZOS param[0] tunes the width of the window function + * @return a pointer to an allocated context, or NULL in case of error + * @note this function is to be removed after a saner alternative is + * written + */ +struct SwsContext *sws_getContext(int srcW, int srcH, enum AVPixelFormat srcFormat, + int dstW, int dstH, enum AVPixelFormat dstFormat, + int flags, SwsFilter *srcFilter, + SwsFilter *dstFilter, const double *param); + +/** + * Scale the image slice in srcSlice and put the resulting scaled + * slice in the image in dst. A slice is a sequence of consecutive + * rows in an image. + * + * Slices have to be provided in sequential order, either in + * top-bottom or bottom-top order. If slices are provided in + * non-sequential order the behavior of the function is undefined. + * + * @param c the scaling context previously created with + * sws_getContext() + * @param srcSlice the array containing the pointers to the planes of + * the source slice + * @param srcStride the array containing the strides for each plane of + * the source image + * @param srcSliceY the position in the source image of the slice to + * process, that is the number (counted starting from + * zero) in the image of the first row of the slice + * @param srcSliceH the height of the source slice, that is the number + * of rows in the slice + * @param dst the array containing the pointers to the planes of + * the destination image + * @param dstStride the array containing the strides for each plane of + * the destination image + * @return the height of the output slice + */ +int sws_scale(struct SwsContext *c, const uint8_t *const srcSlice[], + const int srcStride[], int srcSliceY, int srcSliceH, + uint8_t *const dst[], const int dstStride[]); + +/** + * @param dstRange flag indicating the while-black range of the output (1=jpeg / 0=mpeg) + * @param srcRange flag indicating the while-black range of the input (1=jpeg / 0=mpeg) + * @param table the yuv2rgb coefficients describing the output yuv space, normally ff_yuv2rgb_coeffs[x] + * @param inv_table the yuv2rgb coefficients describing the input yuv space, normally ff_yuv2rgb_coeffs[x] + * @param brightness 16.16 fixed point brightness correction + * @param contrast 16.16 fixed point contrast correction + * @param saturation 16.16 fixed point saturation correction + * @return -1 if not supported + */ +int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4], + int srcRange, const int table[4], int dstRange, + int brightness, int contrast, int saturation); + +/** + * @return -1 if not supported + */ +int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table, + int *srcRange, int **table, int *dstRange, + int *brightness, int *contrast, int *saturation); + +/** + * Allocate and return an uninitialized vector with length coefficients. + */ +SwsVector *sws_allocVec(int length); + +/** + * Return a normalized Gaussian curve used to filter stuff + * quality = 3 is high quality, lower is lower quality. + */ +SwsVector *sws_getGaussianVec(double variance, double quality); + +/** + * Scale all the coefficients of a by the scalar value. + */ +void sws_scaleVec(SwsVector *a, double scalar); + +/** + * Scale all the coefficients of a so that their sum equals height. + */ +void sws_normalizeVec(SwsVector *a, double height); + +#if FF_API_SWS_VECTOR +attribute_deprecated SwsVector *sws_getConstVec(double c, int length); +attribute_deprecated SwsVector *sws_getIdentityVec(void); +attribute_deprecated void sws_convVec(SwsVector *a, SwsVector *b); +attribute_deprecated void sws_addVec(SwsVector *a, SwsVector *b); +attribute_deprecated void sws_subVec(SwsVector *a, SwsVector *b); +attribute_deprecated void sws_shiftVec(SwsVector *a, int shift); +attribute_deprecated SwsVector *sws_cloneVec(SwsVector *a); +attribute_deprecated void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level); +#endif + +void sws_freeVec(SwsVector *a); + +SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur, + float lumaSharpen, float chromaSharpen, + float chromaHShift, float chromaVShift, + int verbose); +void sws_freeFilter(SwsFilter *filter); + +/** + * Check if context can be reused, otherwise reallocate a new one. + * + * If context is NULL, just calls sws_getContext() to get a new + * context. Otherwise, checks if the parameters are the ones already + * saved in context. If that is the case, returns the current + * context. Otherwise, frees context and gets a new context with + * the new parameters. + * + * Be warned that srcFilter and dstFilter are not checked, they + * are assumed to remain the same. + */ +struct SwsContext *sws_getCachedContext(struct SwsContext *context, + int srcW, int srcH, enum AVPixelFormat srcFormat, + int dstW, int dstH, enum AVPixelFormat dstFormat, + int flags, SwsFilter *srcFilter, + SwsFilter *dstFilter, const double *param); + +/** + * Convert an 8-bit paletted frame into a frame with a color depth of 32 bits. + * + * The output frame will have the same packed format as the palette. + * + * @param src source frame buffer + * @param dst destination frame buffer + * @param num_pixels number of pixels to convert + * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src + */ +void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette); + +/** + * Convert an 8-bit paletted frame into a frame with a color depth of 24 bits. + * + * With the palette format "ABCD", the destination frame ends up with the format "ABC". + * + * @param src source frame buffer + * @param dst destination frame buffer + * @param num_pixels number of pixels to convert + * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src + */ +void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette); + +/** + * Get the AVClass for swsContext. It can be used in combination with + * AV_OPT_SEARCH_FAKE_OBJ for examining options. + * + * @see av_opt_find(). + */ +const AVClass *sws_get_class(void); + +/** + * @} + */ + +#endif /* SWSCALE_SWSCALE_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libswscale/version.h b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libswscale/version.h new file mode 100644 index 0000000..3aec51f --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/include/libswscale/version.h @@ -0,0 +1,53 @@ +/* + * This file is part of FFmpeg. + * + * FFmpeg is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * FFmpeg is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with FFmpeg; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef SWSCALE_VERSION_H +#define SWSCALE_VERSION_H + +/** + * @file + * swscale version macros + */ + +#include "libavutil/version.h" + +#define LIBSWSCALE_VERSION_MAJOR 5 +#define LIBSWSCALE_VERSION_MINOR 7 +#define LIBSWSCALE_VERSION_MICRO 100 + +#define LIBSWSCALE_VERSION_INT AV_VERSION_INT(LIBSWSCALE_VERSION_MAJOR, \ + LIBSWSCALE_VERSION_MINOR, \ + LIBSWSCALE_VERSION_MICRO) +#define LIBSWSCALE_VERSION AV_VERSION(LIBSWSCALE_VERSION_MAJOR, \ + LIBSWSCALE_VERSION_MINOR, \ + LIBSWSCALE_VERSION_MICRO) +#define LIBSWSCALE_BUILD LIBSWSCALE_VERSION_INT + +#define LIBSWSCALE_IDENT "SwS" AV_STRINGIFY(LIBSWSCALE_VERSION) + +/** + * FF_API_* defines may be placed below to indicate public API that will be + * dropped at a future version bump. The defines themselves are not part of + * the public API and may change, break or disappear at any time. + */ + +#ifndef FF_API_SWS_VECTOR +#define FF_API_SWS_VECTOR (LIBSWSCALE_VERSION_MAJOR < 6) +#endif + +#endif /* SWSCALE_VERSION_H */ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avcodec-58.def b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avcodec-58.def new file mode 100644 index 0000000..38092af --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avcodec-58.def @@ -0,0 +1,239 @@ +EXPORTS + av_ac3_parse_header + av_adts_header_parse + av_bitstream_filter_close + av_bitstream_filter_filter + av_bitstream_filter_init + av_bitstream_filter_next + av_bsf_alloc + av_bsf_flush + av_bsf_free + av_bsf_get_by_name + av_bsf_get_class + av_bsf_get_null_filter + av_bsf_init + av_bsf_iterate + av_bsf_list_alloc + av_bsf_list_append + av_bsf_list_append2 + av_bsf_list_finalize + av_bsf_list_free + av_bsf_list_parse_str + av_bsf_next + av_bsf_receive_packet + av_bsf_send_packet + av_codec_ffversion + av_codec_get_chroma_intra_matrix + av_codec_get_codec_descriptor + av_codec_get_codec_properties + av_codec_get_lowres + av_codec_get_max_lowres + av_codec_get_pkt_timebase + av_codec_get_seek_preroll + av_codec_is_decoder + av_codec_is_encoder + av_codec_iterate + av_codec_next + av_codec_set_chroma_intra_matrix + av_codec_set_codec_descriptor + av_codec_set_lowres + av_codec_set_pkt_timebase + av_codec_set_seek_preroll + av_copy_packet + av_copy_packet_side_data + av_cpb_properties_alloc + av_d3d11va_alloc_context + av_dct_calc + av_dct_end + av_dct_init + av_dirac_parse_sequence_header + av_dup_packet + av_dv_codec_profile + av_dv_codec_profile2 + av_dv_frame_profile + av_fast_padded_malloc + av_fast_padded_mallocz + av_fft_calc + av_fft_end + av_fft_init + av_fft_permute + av_free_packet + av_get_audio_frame_duration + av_get_audio_frame_duration2 + av_get_bits_per_sample + av_get_codec_tag_string + av_get_exact_bits_per_sample + av_get_pcm_codec + av_get_profile_name + av_grow_packet + av_hwaccel_next + av_imdct_calc + av_imdct_half + av_init_packet + av_jni_get_java_vm + av_jni_set_java_vm + av_lockmgr_register + av_mdct_calc + av_mdct_end + av_mdct_init + av_mediacodec_alloc_context + av_mediacodec_default_free + av_mediacodec_default_init + av_mediacodec_release_buffer + av_mediacodec_render_buffer_at_time + av_new_packet + av_packet_add_side_data + av_packet_alloc + av_packet_clone + av_packet_copy_props + av_packet_free + av_packet_free_side_data + av_packet_from_data + av_packet_get_side_data + av_packet_make_refcounted + av_packet_make_writable + av_packet_merge_side_data + av_packet_move_ref + av_packet_new_side_data + av_packet_pack_dictionary + av_packet_ref + av_packet_rescale_ts + av_packet_shrink_side_data + av_packet_side_data_name + av_packet_split_side_data + av_packet_unpack_dictionary + av_packet_unref + av_parser_change + av_parser_close + av_parser_init + av_parser_iterate + av_parser_next + av_parser_parse2 + av_picture_copy + av_picture_crop + av_picture_pad + av_qsv_alloc_context + av_rdft_calc + av_rdft_end + av_rdft_init + av_register_bitstream_filter + av_register_codec_parser + av_register_hwaccel + av_shrink_packet + av_vorbis_parse_frame + av_vorbis_parse_frame_flags + av_vorbis_parse_free + av_vorbis_parse_init + av_vorbis_parse_reset + av_xiphlacing + avcodec_align_dimensions + avcodec_align_dimensions2 + avcodec_alloc_context3 + avcodec_chroma_pos_to_enum + avcodec_close + avcodec_configuration + avcodec_copy_context + avcodec_dct_alloc + avcodec_dct_get_class + avcodec_dct_init + avcodec_decode_audio4 + avcodec_decode_subtitle2 + avcodec_decode_video2 + avcodec_default_execute + avcodec_default_execute2 + avcodec_default_get_buffer2 + avcodec_default_get_format + avcodec_descriptor_get + avcodec_descriptor_get_by_name + avcodec_descriptor_next + avcodec_encode_audio2 + avcodec_encode_subtitle + avcodec_encode_video2 + avcodec_enum_to_chroma_pos + avcodec_fill_audio_frame + avcodec_find_best_pix_fmt2 + avcodec_find_best_pix_fmt_of_2 + avcodec_find_best_pix_fmt_of_list + avcodec_find_decoder + avcodec_find_decoder_by_name + avcodec_find_encoder + avcodec_find_encoder_by_name + avcodec_flush_buffers + avcodec_free_context + avcodec_get_chroma_sub_sample + avcodec_get_class + avcodec_get_context_defaults3 + avcodec_get_frame_class + avcodec_get_hw_config + avcodec_get_hw_frames_parameters + avcodec_get_name + avcodec_get_pix_fmt_loss + avcodec_get_subtitle_rect_class + avcodec_get_type + avcodec_is_open + avcodec_license + avcodec_open2 + avcodec_parameters_alloc + avcodec_parameters_copy + avcodec_parameters_free + avcodec_parameters_from_context + avcodec_parameters_to_context + avcodec_pix_fmt_to_codec_tag + avcodec_profile_name + avcodec_receive_frame + avcodec_receive_packet + avcodec_register + avcodec_register_all + avcodec_send_frame + avcodec_send_packet + avcodec_string + avcodec_version + avpicture_alloc + avpicture_fill + avpicture_free + avpicture_get_size + avpicture_layout + avpriv_ac3_channel_layout_tab + avpriv_ac3_parse_header + avpriv_align_put_bits + avpriv_bprint_to_extradata + avpriv_codec2_mode_bit_rate + avpriv_codec2_mode_block_align + avpriv_codec2_mode_frame_size + avpriv_codec_get_cap_skip_frame_fill_param + avpriv_copy_bits + avpriv_dca_convert_bitstream + avpriv_dca_parse_core_frame_header + avpriv_dca_sample_rates + avpriv_dnxhd_get_frame_size + avpriv_dnxhd_get_hr_frame_size + avpriv_dnxhd_get_interlaced + avpriv_do_elbg + avpriv_exif_decode_ifd + avpriv_find_pix_fmt + avpriv_find_start_code + avpriv_fits_header_init + avpriv_fits_header_parse_line + avpriv_get_raw_pix_fmt_tags + avpriv_h264_has_num_reorder_frames + avpriv_init_elbg + avpriv_mjpeg_bits_ac_chrominance + avpriv_mjpeg_bits_ac_luminance + avpriv_mjpeg_bits_dc_chrominance + avpriv_mjpeg_bits_dc_luminance + avpriv_mjpeg_val_ac_chrominance + avpriv_mjpeg_val_ac_luminance + avpriv_mjpeg_val_dc + avpriv_mpa_bitrate_tab + avpriv_mpa_freq_tab + avpriv_mpeg4audio_get_config + avpriv_mpeg4audio_get_config2 + avpriv_mpeg4audio_sample_rates + avpriv_mpegaudio_decode_header + avpriv_pix_fmt_bps_avi + avpriv_pix_fmt_bps_mov + avpriv_put_string + avpriv_split_xiph_headers + avpriv_tak_parse_streaminfo + avpriv_toupper4 + avsubtitle_free diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avcodec.lib b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avcodec.lib new file mode 100644 index 0000000..cf72624 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avcodec.lib differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avdevice-58.def b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avdevice-58.def new file mode 100644 index 0000000..01682fc --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avdevice-58.def @@ -0,0 +1,19 @@ +EXPORTS + av_device_capabilities + av_device_ffversion + av_input_audio_device_next + av_input_video_device_next + av_output_audio_device_next + av_output_video_device_next + avdevice_app_to_dev_control_message + avdevice_capabilities_create + avdevice_capabilities_free + avdevice_configuration + avdevice_dev_to_app_control_message + avdevice_free_list_devices + avdevice_license + avdevice_list_devices + avdevice_list_input_sources + avdevice_list_output_sinks + avdevice_register_all + avdevice_version diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avdevice.lib b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avdevice.lib new file mode 100644 index 0000000..673c0ab Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avdevice.lib differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avfilter-7.def b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avfilter-7.def new file mode 100644 index 0000000..08e7048 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avfilter-7.def @@ -0,0 +1,69 @@ +EXPORTS + av_abuffersink_params_alloc + av_buffersink_get_channel_layout + av_buffersink_get_channels + av_buffersink_get_format + av_buffersink_get_frame + av_buffersink_get_frame_flags + av_buffersink_get_frame_rate + av_buffersink_get_h + av_buffersink_get_hw_frames_ctx + av_buffersink_get_sample_aspect_ratio + av_buffersink_get_sample_rate + av_buffersink_get_samples + av_buffersink_get_time_base + av_buffersink_get_type + av_buffersink_get_w + av_buffersink_params_alloc + av_buffersink_set_frame_size + av_buffersrc_add_frame + av_buffersrc_add_frame_flags + av_buffersrc_close + av_buffersrc_get_nb_failed_requests + av_buffersrc_parameters_alloc + av_buffersrc_parameters_set + av_buffersrc_write_frame + av_filter_ffversion + av_filter_iterate + avfilter_add_matrix + avfilter_config_links + avfilter_configuration + avfilter_free + avfilter_get_by_name + avfilter_get_class + avfilter_graph_alloc + avfilter_graph_alloc_filter + avfilter_graph_config + avfilter_graph_create_filter + avfilter_graph_dump + avfilter_graph_free + avfilter_graph_get_filter + avfilter_graph_parse + avfilter_graph_parse2 + avfilter_graph_parse_ptr + avfilter_graph_queue_command + avfilter_graph_request_oldest + avfilter_graph_send_command + avfilter_graph_set_auto_convert + avfilter_init_dict + avfilter_init_str + avfilter_inout_alloc + avfilter_inout_free + avfilter_insert_filter + avfilter_license + avfilter_link + avfilter_link_free + avfilter_link_get_channels + avfilter_link_set_closed + avfilter_make_format64_list + avfilter_mul_matrix + avfilter_next + avfilter_pad_count + avfilter_pad_get_name + avfilter_pad_get_type + avfilter_process_command + avfilter_register + avfilter_register_all + avfilter_sub_matrix + avfilter_transform + avfilter_version diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avfilter.lib b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avfilter.lib new file mode 100644 index 0000000..d1c30c5 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avfilter.lib differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avformat-58.def b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avformat-58.def new file mode 100644 index 0000000..9dfa9e7 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avformat-58.def @@ -0,0 +1,177 @@ +EXPORTS + av_add_index_entry + av_append_packet + av_apply_bitstream_filters + av_codec_get_id + av_codec_get_tag + av_codec_get_tag2 + av_demuxer_iterate + av_demuxer_open + av_dump_format + av_filename_number_test + av_find_best_stream + av_find_default_stream_index + av_find_input_format + av_find_program_from_stream + av_fmt_ctx_get_duration_estimation_method + av_format_ffversion + av_format_get_audio_codec + av_format_get_control_message_cb + av_format_get_data_codec + av_format_get_metadata_header_padding + av_format_get_opaque + av_format_get_open_cb + av_format_get_probe_score + av_format_get_subtitle_codec + av_format_get_video_codec + av_format_inject_global_side_data + av_format_set_audio_codec + av_format_set_control_message_cb + av_format_set_data_codec + av_format_set_metadata_header_padding + av_format_set_opaque + av_format_set_open_cb + av_format_set_subtitle_codec + av_format_set_video_codec + av_get_frame_filename + av_get_frame_filename2 + av_get_output_timestamp + av_get_packet + av_guess_codec + av_guess_format + av_guess_frame_rate + av_guess_sample_aspect_ratio + av_hex_dump + av_hex_dump_log + av_iformat_next + av_index_search_timestamp + av_interleaved_write_frame + av_interleaved_write_uncoded_frame + av_match_ext + av_muxer_iterate + av_new_program + av_oformat_next + av_pkt_dump2 + av_pkt_dump_log2 + av_probe_input_buffer + av_probe_input_buffer2 + av_probe_input_format + av_probe_input_format2 + av_probe_input_format3 + av_program_add_stream_index + av_read_frame + av_read_pause + av_read_play + av_register_all + av_register_input_format + av_register_output_format + av_sdp_create + av_seek_frame + av_stream_add_side_data + av_stream_get_codec_timebase + av_stream_get_end_pts + av_stream_get_parser + av_stream_get_r_frame_rate + av_stream_get_recommended_encoder_configuration + av_stream_get_side_data + av_stream_new_side_data + av_stream_set_r_frame_rate + av_stream_set_recommended_encoder_configuration + av_url_split + av_write_frame + av_write_trailer + av_write_uncoded_frame + av_write_uncoded_frame_query + avformat_alloc_context + avformat_alloc_output_context2 + avformat_close_input + avformat_configuration + avformat_find_stream_info + avformat_flush + avformat_free_context + avformat_get_class + avformat_get_mov_audio_tags + avformat_get_mov_video_tags + avformat_get_riff_audio_tags + avformat_get_riff_video_tags + avformat_init_output + avformat_license + avformat_match_stream_specifier + avformat_network_deinit + avformat_network_init + avformat_new_stream + avformat_open_input + avformat_query_codec + avformat_queue_attached_pictures + avformat_seek_file + avformat_transfer_internal_stream_timing_info + avformat_version + avformat_write_header + avio_accept + avio_alloc_context + avio_check + avio_close + avio_close_dir + avio_close_dyn_buf + avio_closep + avio_context_free + avio_enum_protocols + avio_feof + avio_find_protocol_name + avio_flush + avio_free_directory_entry + avio_get_dyn_buf + avio_get_str + avio_get_str16be + avio_get_str16le + avio_handshake + avio_open + avio_open2 + avio_open_dir + avio_open_dyn_buf + avio_pause + avio_print_string_array + avio_printf + avio_protocol_get_class + avio_put_str + avio_put_str16be + avio_put_str16le + avio_r8 + avio_rb16 + avio_rb24 + avio_rb32 + avio_rb64 + avio_read + avio_read_dir + avio_read_partial + avio_read_to_bprint + avio_rl16 + avio_rl24 + avio_rl32 + avio_rl64 + avio_seek + avio_seek_time + avio_size + avio_skip + avio_w8 + avio_wb16 + avio_wb24 + avio_wb32 + avio_wb64 + avio_wl16 + avio_wl24 + avio_wl32 + avio_wl64 + avio_write + avio_write_marker + avpriv_dv_get_packet + avpriv_dv_init_demux + avpriv_dv_produce_packet + avpriv_io_delete + avpriv_io_move + avpriv_mpegts_parse_close + avpriv_mpegts_parse_open + avpriv_mpegts_parse_packet + avpriv_new_chapter + avpriv_register_devices + avpriv_set_pts_info diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avformat.lib b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avformat.lib new file mode 100644 index 0000000..b088cfd Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avformat.lib differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avutil-56.def b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avutil-56.def new file mode 100644 index 0000000..08096eb --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avutil-56.def @@ -0,0 +1,545 @@ +EXPORTS + av_add_i + av_add_q + av_add_stable + av_adler32_update + av_aes_alloc + av_aes_crypt + av_aes_ctr_alloc + av_aes_ctr_crypt + av_aes_ctr_free + av_aes_ctr_get_iv + av_aes_ctr_increment_iv + av_aes_ctr_init + av_aes_ctr_set_full_iv + av_aes_ctr_set_iv + av_aes_ctr_set_random_iv + av_aes_init + av_aes_size + av_append_path_component + av_asprintf + av_assert0_fpu + av_audio_fifo_alloc + av_audio_fifo_drain + av_audio_fifo_free + av_audio_fifo_peek + av_audio_fifo_peek_at + av_audio_fifo_read + av_audio_fifo_realloc + av_audio_fifo_reset + av_audio_fifo_size + av_audio_fifo_space + av_audio_fifo_write + av_base64_decode + av_base64_encode + av_basename + av_blowfish_alloc + av_blowfish_crypt + av_blowfish_crypt_ecb + av_blowfish_init + av_bmg_get + av_bprint_append_data + av_bprint_channel_layout + av_bprint_chars + av_bprint_clear + av_bprint_escape + av_bprint_finalize + av_bprint_get_buffer + av_bprint_init + av_bprint_init_for_buffer + av_bprint_strftime + av_bprintf + av_buffer_alloc + av_buffer_allocz + av_buffer_create + av_buffer_default_free + av_buffer_get_opaque + av_buffer_get_ref_count + av_buffer_is_writable + av_buffer_make_writable + av_buffer_pool_buffer_get_opaque + av_buffer_pool_get + av_buffer_pool_init + av_buffer_pool_init2 + av_buffer_pool_uninit + av_buffer_realloc + av_buffer_ref + av_buffer_unref + av_calloc + av_camellia_alloc + av_camellia_crypt + av_camellia_init + av_camellia_size + av_cast5_alloc + av_cast5_crypt + av_cast5_crypt2 + av_cast5_init + av_cast5_size + av_channel_layout_extract_channel + av_chroma_location_from_name + av_chroma_location_name + av_cmp_i + av_color_primaries_from_name + av_color_primaries_name + av_color_range_from_name + av_color_range_name + av_color_space_from_name + av_color_space_name + av_color_transfer_from_name + av_color_transfer_name + av_compare_mod + av_compare_ts + av_content_light_metadata_alloc + av_content_light_metadata_create_side_data + av_cpu_count + av_cpu_max_align + av_crc + av_crc_get_table + av_crc_init + av_d2q + av_d2str + av_default_get_category + av_default_item_name + av_des_alloc + av_des_crypt + av_des_init + av_des_mac + av_dict_copy + av_dict_count + av_dict_free + av_dict_get + av_dict_get_string + av_dict_parse_string + av_dict_set + av_dict_set_int + av_dirname + av_display_matrix_flip + av_display_rotation_get + av_display_rotation_set + av_div_i + av_div_q + av_dovi_alloc + av_downmix_info_update_side_data + av_dynamic_hdr_plus_alloc + av_dynamic_hdr_plus_create_side_data + av_dynarray2_add + av_dynarray_add + av_dynarray_add_nofree + av_encryption_info_add_side_data + av_encryption_info_alloc + av_encryption_info_clone + av_encryption_info_free + av_encryption_info_get_side_data + av_encryption_init_info_add_side_data + av_encryption_init_info_alloc + av_encryption_init_info_free + av_encryption_init_info_get_side_data + av_escape + av_expr_count_func + av_expr_count_vars + av_expr_eval + av_expr_free + av_expr_parse + av_expr_parse_and_eval + av_fast_malloc + av_fast_mallocz + av_fast_realloc + av_fifo_alloc + av_fifo_alloc_array + av_fifo_drain + av_fifo_free + av_fifo_freep + av_fifo_generic_peek + av_fifo_generic_peek_at + av_fifo_generic_read + av_fifo_generic_write + av_fifo_grow + av_fifo_realloc2 + av_fifo_reset + av_fifo_size + av_fifo_space + av_file_map + av_file_unmap + av_find_best_pix_fmt_of_2 + av_find_info_tag + av_find_nearest_q_idx + av_fopen_utf8 + av_force_cpu_flags + av_fourcc_make_string + av_frame_alloc + av_frame_apply_cropping + av_frame_clone + av_frame_copy + av_frame_copy_props + av_frame_free + av_frame_get_best_effort_timestamp + av_frame_get_buffer + av_frame_get_channel_layout + av_frame_get_channels + av_frame_get_color_range + av_frame_get_colorspace + av_frame_get_decode_error_flags + av_frame_get_metadata + av_frame_get_pkt_duration + av_frame_get_pkt_pos + av_frame_get_pkt_size + av_frame_get_plane_buffer + av_frame_get_qp_table + av_frame_get_sample_rate + av_frame_get_side_data + av_frame_is_writable + av_frame_make_writable + av_frame_move_ref + av_frame_new_side_data + av_frame_new_side_data_from_buf + av_frame_ref + av_frame_remove_side_data + av_frame_set_best_effort_timestamp + av_frame_set_channel_layout + av_frame_set_channels + av_frame_set_color_range + av_frame_set_colorspace + av_frame_set_decode_error_flags + av_frame_set_metadata + av_frame_set_pkt_duration + av_frame_set_pkt_pos + av_frame_set_pkt_size + av_frame_set_qp_table + av_frame_set_sample_rate + av_frame_side_data_name + av_frame_unref + av_free + av_freep + av_gcd + av_gcd_q + av_get_alt_sample_fmt + av_get_bits_per_pixel + av_get_bytes_per_sample + av_get_channel_description + av_get_channel_layout + av_get_channel_layout_channel_index + av_get_channel_layout_nb_channels + av_get_channel_layout_string + av_get_channel_name + av_get_colorspace_name + av_get_cpu_flags + av_get_default_channel_layout + av_get_extended_channel_layout + av_get_known_color_name + av_get_media_type_string + av_get_packed_sample_fmt + av_get_padded_bits_per_pixel + av_get_picture_type_char + av_get_pix_fmt + av_get_pix_fmt_loss + av_get_pix_fmt_name + av_get_pix_fmt_string + av_get_planar_sample_fmt + av_get_random_seed + av_get_sample_fmt + av_get_sample_fmt_name + av_get_sample_fmt_string + av_get_standard_channel_layout + av_get_time_base_q + av_get_token + av_gettime + av_gettime_relative + av_gettime_relative_is_monotonic + av_hash_alloc + av_hash_final + av_hash_final_b64 + av_hash_final_bin + av_hash_final_hex + av_hash_freep + av_hash_get_name + av_hash_get_size + av_hash_init + av_hash_names + av_hash_update + av_hmac_alloc + av_hmac_calc + av_hmac_final + av_hmac_free + av_hmac_init + av_hmac_update + av_hwdevice_ctx_alloc + av_hwdevice_ctx_create + av_hwdevice_ctx_create_derived + av_hwdevice_ctx_create_derived_opts + av_hwdevice_ctx_init + av_hwdevice_find_type_by_name + av_hwdevice_get_hwframe_constraints + av_hwdevice_get_type_name + av_hwdevice_hwconfig_alloc + av_hwdevice_iterate_types + av_hwframe_constraints_free + av_hwframe_ctx_alloc + av_hwframe_ctx_create_derived + av_hwframe_ctx_init + av_hwframe_get_buffer + av_hwframe_map + av_hwframe_transfer_data + av_hwframe_transfer_get_formats + av_i2int + av_image_alloc + av_image_check_sar + av_image_check_size + av_image_check_size2 + av_image_copy + av_image_copy_plane + av_image_copy_to_buffer + av_image_copy_uc_from + av_image_fill_arrays + av_image_fill_black + av_image_fill_linesizes + av_image_fill_max_pixsteps + av_image_fill_pointers + av_image_get_buffer_size + av_image_get_linesize + av_int2i + av_int_list_length_for_size + av_lfg_init + av_lfg_init_from_data + av_log + av_log2 + av_log2_16bit + av_log2_i + av_log_default_callback + av_log_format_line + av_log_format_line2 + av_log_get_flags + av_log_get_level + av_log_once + av_log_set_callback + av_log_set_flags + av_log_set_level + av_lzo1x_decode + av_malloc + av_malloc_array + av_mallocz + av_mallocz_array + av_mastering_display_metadata_alloc + av_mastering_display_metadata_create_side_data + av_match_list + av_match_name + av_max_alloc + av_md5_alloc + av_md5_final + av_md5_init + av_md5_size + av_md5_sum + av_md5_update + av_memcpy_backptr + av_memdup + av_mod_i + av_mul_i + av_mul_q + av_murmur3_alloc + av_murmur3_final + av_murmur3_init + av_murmur3_init_seeded + av_murmur3_update + av_nearer_q + av_opt_child_class_next + av_opt_child_next + av_opt_copy + av_opt_eval_double + av_opt_eval_flags + av_opt_eval_float + av_opt_eval_int + av_opt_eval_int64 + av_opt_eval_q + av_opt_find + av_opt_find2 + av_opt_flag_is_set + av_opt_free + av_opt_freep_ranges + av_opt_get + av_opt_get_channel_layout + av_opt_get_dict_val + av_opt_get_double + av_opt_get_image_size + av_opt_get_int + av_opt_get_key_value + av_opt_get_pixel_fmt + av_opt_get_q + av_opt_get_sample_fmt + av_opt_get_video_rate + av_opt_is_set_to_default + av_opt_is_set_to_default_by_name + av_opt_next + av_opt_ptr + av_opt_query_ranges + av_opt_query_ranges_default + av_opt_serialize + av_opt_set + av_opt_set_bin + av_opt_set_channel_layout + av_opt_set_defaults + av_opt_set_defaults2 + av_opt_set_dict + av_opt_set_dict2 + av_opt_set_dict_val + av_opt_set_double + av_opt_set_from_string + av_opt_set_image_size + av_opt_set_int + av_opt_set_pixel_fmt + av_opt_set_q + av_opt_set_sample_fmt + av_opt_set_video_rate + av_opt_show2 + av_parse_color + av_parse_cpu_caps + av_parse_cpu_flags + av_parse_ratio + av_parse_time + av_parse_video_rate + av_parse_video_size + av_pix_fmt_count_planes + av_pix_fmt_desc_get + av_pix_fmt_desc_get_id + av_pix_fmt_desc_next + av_pix_fmt_get_chroma_sub_sample + av_pix_fmt_swap_endianness + av_pixelutils_get_sad_fn + av_q2intfloat + av_rc4_alloc + av_rc4_crypt + av_rc4_init + av_read_image_line + av_read_image_line2 + av_realloc + av_realloc_array + av_realloc_f + av_reallocp + av_reallocp_array + av_reduce + av_rescale + av_rescale_delta + av_rescale_q + av_rescale_q_rnd + av_rescale_rnd + av_ripemd_alloc + av_ripemd_final + av_ripemd_init + av_ripemd_size + av_ripemd_update + av_sample_fmt_is_planar + av_samples_alloc + av_samples_alloc_array_and_samples + av_samples_copy + av_samples_fill_arrays + av_samples_get_buffer_size + av_samples_set_silence + av_set_cpu_flags_mask + av_set_options_string + av_sha512_alloc + av_sha512_final + av_sha512_init + av_sha512_size + av_sha512_update + av_sha_alloc + av_sha_final + av_sha_init + av_sha_size + av_sha_update + av_shr_i + av_small_strptime + av_spherical_alloc + av_spherical_from_name + av_spherical_projection_name + av_spherical_tile_bounds + av_sscanf + av_stereo3d_alloc + av_stereo3d_create_side_data + av_stereo3d_from_name + av_stereo3d_type_name + av_strcasecmp + av_strdup + av_strerror + av_strireplace + av_stristart + av_stristr + av_strlcat + av_strlcatf + av_strlcpy + av_strncasecmp + av_strndup + av_strnstr + av_strstart + av_strtod + av_strtok + av_sub_i + av_sub_q + av_tea_alloc + av_tea_crypt + av_tea_init + av_tea_size + av_tempfile + av_thread_message_flush + av_thread_message_queue_alloc + av_thread_message_queue_free + av_thread_message_queue_nb_elems + av_thread_message_queue_recv + av_thread_message_queue_send + av_thread_message_queue_set_err_recv + av_thread_message_queue_set_err_send + av_thread_message_queue_set_free_func + av_timecode_adjust_ntsc_framenum2 + av_timecode_check_frame_rate + av_timecode_get_smpte_from_framenum + av_timecode_init + av_timecode_init_from_string + av_timecode_make_mpeg_tc_string + av_timecode_make_smpte_tc_string + av_timecode_make_string + av_timegm + av_tree_destroy + av_tree_enumerate + av_tree_find + av_tree_insert + av_tree_node_alloc + av_tree_node_size + av_twofish_alloc + av_twofish_crypt + av_twofish_init + av_twofish_size + av_tx_init + av_tx_uninit + av_usleep + av_utf8_decode + av_util_ffversion + av_vbprintf + av_version_info + av_video_enc_params_alloc + av_video_enc_params_create_side_data + av_vlog + av_write_image_line + av_write_image_line2 + av_xtea_alloc + av_xtea_crypt + av_xtea_init + av_xtea_le_crypt + av_xtea_le_init + avpriv_alloc_fixed_dsp + avpriv_cga_font + avpriv_dict_set_timestamp + avpriv_float_dsp_alloc + avpriv_get_gamma_from_trc + avpriv_get_trc_function_from_trc + avpriv_init_lls + avpriv_open + avpriv_report_missing_feature + avpriv_request_sample + avpriv_scalarproduct_float_c + avpriv_set_systematic_pal2 + avpriv_slicethread_create + avpriv_slicethread_execute + avpriv_slicethread_free + avpriv_solve_lls + avpriv_tempfile + avpriv_vga16_font + avutil_configuration + avutil_license + avutil_version diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avutil.lib b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avutil.lib new file mode 100644 index 0000000..363d982 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/avutil.lib differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavcodec.dll.a b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavcodec.dll.a new file mode 100644 index 0000000..4dad824 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavcodec.dll.a differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavdevice.dll.a b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavdevice.dll.a new file mode 100644 index 0000000..05567fb Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavdevice.dll.a differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavfilter.dll.a b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavfilter.dll.a new file mode 100644 index 0000000..fe10a57 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavfilter.dll.a differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavformat.dll.a b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavformat.dll.a new file mode 100644 index 0000000..2090e44 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavformat.dll.a differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavutil.dll.a b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavutil.dll.a new file mode 100644 index 0000000..cc6f17b Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libavutil.dll.a differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libpostproc.dll.a b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libpostproc.dll.a new file mode 100644 index 0000000..71f6088 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libpostproc.dll.a differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libswresample.dll.a b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libswresample.dll.a new file mode 100644 index 0000000..da2cd8e Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libswresample.dll.a differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libswscale.dll.a b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libswscale.dll.a new file mode 100644 index 0000000..3c5ff17 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/libswscale.dll.a differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/postproc-55.def b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/postproc-55.def new file mode 100644 index 0000000..1dd67ee --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/postproc-55.def @@ -0,0 +1,11 @@ +EXPORTS + postproc_configuration + postproc_ffversion + postproc_license + postproc_version + pp_free_context + pp_free_mode + pp_get_context + pp_get_mode_by_name_and_quality + pp_help + pp_postprocess diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/postproc.lib b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/postproc.lib new file mode 100644 index 0000000..3408587 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/postproc.lib differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/swresample-3.def b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/swresample-3.def new file mode 100644 index 0000000..4ca6d90 --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/swresample-3.def @@ -0,0 +1,24 @@ +EXPORTS + swr_alloc + swr_alloc_set_opts + swr_build_matrix + swr_close + swr_config_frame + swr_convert + swr_convert_frame + swr_drop_output + swr_ffversion + swr_free + swr_get_class + swr_get_delay + swr_get_out_samples + swr_init + swr_inject_silence + swr_is_initialized + swr_next_pts + swr_set_channel_mapping + swr_set_compensation + swr_set_matrix + swresample_configuration + swresample_license + swresample_version diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/swresample.lib b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/swresample.lib new file mode 100644 index 0000000..73cc17e Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/swresample.lib differ diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/swscale-5.def b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/swscale-5.def new file mode 100644 index 0000000..ce3dc0d --- /dev/null +++ b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/swscale-5.def @@ -0,0 +1,35 @@ +EXPORTS + sws_addVec + sws_allocVec + sws_alloc_context + sws_alloc_set_opts + sws_cloneVec + sws_convVec + sws_convertPalette8ToPacked24 + sws_convertPalette8ToPacked32 + sws_freeContext + sws_freeFilter + sws_freeVec + sws_getCachedContext + sws_getCoefficients + sws_getColorspaceDetails + sws_getConstVec + sws_getContext + sws_getDefaultFilter + sws_getGaussianVec + sws_getIdentityVec + sws_get_class + sws_init_context + sws_isSupportedEndiannessConversion + sws_isSupportedInput + sws_isSupportedOutput + sws_normalizeVec + sws_printVec2 + sws_scale + sws_scaleVec + sws_setColorspaceDetails + sws_shiftVec + sws_subVec + swscale_configuration + swscale_license + swscale_version diff --git a/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/swscale.lib b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/swscale.lib new file mode 100644 index 0000000..604f7b6 Binary files /dev/null and b/ffmpeg-n4.3.2-win64-gpl-shared-4.3/lib/swscale.lib differ diff --git a/ffvideo.cpp b/ffvideo.cpp new file mode 100644 index 0000000..690d02d --- /dev/null +++ b/ffvideo.cpp @@ -0,0 +1,107 @@ +#include "ffvideo.h" + +void ffvideo::initH264() { + AVDictionary* options = nullptr; + av_dict_set(&options, "preset", "superfast", 0); + av_dict_set(&options, "tune", "zerolatency", 0); + AVCodec* encoder = avcodec_find_encoder(AV_CODEC_ID_H264); + encoder_ctx = avcodec_alloc_context3(encoder); + encoder_ctx->codec_id = AV_CODEC_ID_H264; + encoder_ctx->codec_type = AVMEDIA_TYPE_VIDEO; + encoder_ctx->pix_fmt = AV_PIX_FMT_YUV420P; + encoder_ctx->width = info.dst_width; + encoder_ctx->height = info.dst_height; + encoder_ctx->time_base.num = 1; + encoder_ctx->time_base.den = info.frame_rate; //ʱ + encoder_ctx->framerate = { info.frame_rate,1 };//֡ + encoder_ctx->bit_rate = info.bit_rate;//ҪƵ + encoder_ctx->gop_size = info.gop_size;//ؼ֡ + encoder_ctx->qmin = 30;//Сѹ + encoder_ctx->qmax = 35;//ѹСһѹͼ + encoder_ctx->max_b_frames = 0;//B֡B֡ʱƽΪ + encoder_ctx->flags |= AV_CODEC_FLAG_GLOBAL_HEADER;//úͨextradataȡspspps + avcodec_open2(encoder_ctx, encoder, &options); + dst_packet = av_packet_alloc(); +} + +void ffvideo::initSws() { + line_size = new int[4]; + src_size = av_image_get_buffer_size(info.src_fmt, info.src_width, info.src_height, 1); + dst_size = av_image_get_buffer_size(info.dst_fmt, info.dst_width, info.dst_height, 1); + src_buffer = new uint8_t[src_size]; + dst_buffer = new uint8_t[dst_size]; + dst_frame = av_frame_alloc(); + dst_frame->format = info.dst_fmt; + dst_frame->width = info.dst_width; + dst_frame->height = info.dst_height; + av_image_fill_arrays(dst_frame->data, dst_frame->linesize, dst_buffer, info.dst_fmt, info.dst_width, info.dst_height, 1); + + sws_ctx = sws_getContext(info.src_width, info.src_height, info.src_fmt, + info.dst_width, info.dst_height, info.dst_fmt, + SWS_BICUBIC, nullptr, nullptr, nullptr); + sws_init_context(sws_ctx, nullptr, nullptr); +} + +void ffvideo::process_data(int dts, int pts, void(*cb)(ffvideo*)) { + sws_scale(sws_ctx, static_cast(&src_buffer), line_size, 0, + info.src_height, dst_frame->data, dst_frame->linesize); + dst_frame->pkt_dts = dts; + dst_frame->pts = pts; + + int ret = avcodec_send_frame(encoder_ctx, dst_frame); + if (ret < 0) { + if (ret == AVERROR(EAGAIN)) { + return; + } + return; + } + while (ret >= 0) { + ret = avcodec_receive_packet(encoder_ctx, dst_packet); + if (ret == AVERROR(EAGAIN) || ret == AVERROR_EOF) { + break; + } + if (ret < 0) { + return; + } + if (cb) cb(this); + av_packet_unref(dst_packet); + } +} + +//FILE* f = nullptr; +// +//void output2(FFplay* ctx) { +// if (f == nullptr) { +// f = fopen("a.h264", "wb"); +// fwrite(ctx->encoder_ctx->extradata, sizeof(uint8_t), ctx->encoder_ctx->extradata_size, f); +// } +// +// fwrite(ctx->dst_packet->data, sizeof(uint8_t), ctx->dst_packet->size, f); +// +// cout << "ENCODE_SUCCESS: size = " << ctx->dst_packet->size << endl; +//} +// +//int main_test() { +// +// FFplay play{}; +// +// play.info = { +// 1920, 1080, AV_PIX_FMT_BGRA, +// 1920, 1080, AV_PIX_FMT_YUV420P, +// 30, 2 * 1024 * 1024, 30 +// }; +// +// play.initSws(); +// play.initH264(); +// +// int count = 0; +// while (true) { +// if (count == 10 * 30) break; +// count++; +// //fake_data(count); +// play.process_data(count, count, output2); +// } +// fflush(f); +// fclose(f); +// return 0; +//} diff --git a/ffvideo.h b/ffvideo.h new file mode 100644 index 0000000..a8a4187 --- /dev/null +++ b/ffvideo.h @@ -0,0 +1,39 @@ +#pragma once +extern "C" +{ +#include "libswscale/swscale.h" +#include "libavutil/imgutils.h" +#include "libavcodec/codec.h" +#include "libavformat/avformat.h" +} + +typedef struct { + int src_width; + int src_height; + AVPixelFormat src_fmt; + + int dst_width; + int dst_height; + AVPixelFormat dst_fmt; + + int frame_rate; + int bit_rate; + int gop_size; +} INFO; + +class ffvideo { +public: + + void initH264(); + void initSws(); + void process_data(int dts, int pts, void(*cb)(ffvideo*)); + + int* line_size; + SwsContext* sws_ctx; + INFO info; + int src_size, dst_size; + uint8_t* src_buffer, * dst_buffer; + AVFrame* dst_frame; + AVPacket* dst_packet; + AVCodecContext* encoder_ctx; +}; \ No newline at end of file