# ffmpeg

Reference for the ffmpeg camera model. Uses a camera device, video file, or stream as a camera component.
> Source: https://docs.viam.com/reference/components/camera/ffmpeg/


The `ffmpeg` camera model uses a camera device, a video file, or a stream as a camera.

When used with a streaming camera, the `ffmpeg` camera model supports any streaming camera format that is supported by the [`ffmpeg` program](https://ffmpeg.org/), including MJPEG, H264, and MP4.

> **Note:**
> 
> 
> The [`ffmpeg` program](https://ffmpeg.org/) must be installed separately from `viam-server` on your system for this driver to work.
> 

## Configuration




### JSON Template

```json
{
  "name": "<your-camera-name>",
  "model": "rdk:builtin:ffmpeg",
  "api": "rdk:component:camera",
  "attributes": {
    "intrinsic_parameters": {
      "width_px": <int>,
      "height_px": <int>,
      "fx": <float>,
      "fy": <float>,
      "ppx": <float>,
      "ppy": <float>
    },
    "distortion_parameters": {
      "rk1": <float>,
      "rk2": <float>,
      "rk3": <float>,
      "tp1": <float>,
      "tp2": <float>
    },
    "video_path": "<your-video-path>",
    "input_kw_args": { ... },
    "filters": [
      {
        "name": <string>,
        "args": [ "<first>", "<second>", ... ],
        "kw_args": { ... }
      }
    ],
    "output_kw_args": { ... },
  }
}
```

### JSON Example

```json
{
  "name": "stream-camera",
  "api": "rdk:component:camera",
  "model": "rdk:builtin:ffmpeg",
  "attributes": {
    "video_path": "udp://127.0.0.1:23000",
    "distortion_parameters": {},
    "intrinsic_parameters": {
      "height_px": 2486,
      "width_px": 1970
    }
  }
}
```



## Attributes

<!-- prettier-ignore -->
| Name | Type | Required? | Description |
| ---- | ---- | --------- | ----------- |
| `video_path` | string | **Required** | The file path to the camera device, color image file, or streaming camera. If you are using a camera with an RTSP stream, provide the RTSP address to this attribute. |
| `intrinsic_parameters` | object | Optional | The intrinsic parameters of the camera used to do 2D <-> 3D projections: <ul> <li> <code>width_px</code>: The expected width of the aligned image in pixels. Value must be positive. </li> <li> <code>height_px</code>: The expected height of the aligned image in pixels. Value must be positive. </li> <li> <code>fx</code>: The image center x point. </li> <li> <code>fy</code>: The image center y point. </li> <li> <code>ppx</code>: The image focal x. </li> <li> <code>ppy</code>: The image focal y. </li> </ul> |
| `distortion_parameters` | object | Optional | Modified Brown-Conrady parameters used to correct for distortions caused by the shape of the camera lens: <ul> <li> <code>rk1</code>: The radial distortion x. </li> <li> <code>rk2</code>: The radial distortion y. </li> <li> <code>rk3</code>: The radial distortion z. </li> <li> <code>tp1</code>: The tangential distortion x. </li> <li> <code>tp2</code>: The tangential distortion y. </li> </ul> |
| `input_kw_args` | object | Optional | The input keyword arguments. |
| `filters` | array | Optional | Array of filter objects that specify: <ul> <li> <code>name</code>: The name of the filter. </li> <li> <code>args</code>: The arguments for the filter. </li> <li> <code>kw_args</code>: Any keyword arguments for the filter. </li> </ul> |
| `output_kw_args` | object | Optional | The output keyword arguments. |