git.sesse.net Git - mlt/blob - src/modules/core/filter_crop.yml

   1 schema_version: 0.1
   2 type: filter
   3 identifier: crop
   4 title: Crop
   5 version: 1
   6 copyright: Ushodaya Enterprises Limited
   7 creator: Dan Dennedy
   8 license: LGPLv2.1
   9 language: en
  10 description: Remove pixels from the edges of the video.
  11 tags:
  12   - Video
  13 notes: >
  14   This filter is meant to be included as a normalizing filter attached
  15   automatically by the loader so that cropping occurs early in the processing
  16   stack and can request the full resolution of the source image. Then, a
  17   second instance of the filter may be applied to set the parameters of the
  18   crop operation.
  19 parameters:
  20   - identifier: argument
  21     title: Active
  22     description: Whether to do the processing (1) or simply set the parameters.
  23     type: integer
  24     minimum: 0
  25     maximum: 1
  26     default: 0
  27   - identifier: left
  28     title: Left
  29     type: integer
  30     minimum: 0
  31     default: 0
  32     unit: pixels
  33   - identifier: right
  34     title: Right
  35     type: integer
  36     minimum: 0
  37     default: 0
  38     unit: pixels
  39   - identifier: top
  40     title: Top
  41     type: integer
  42     minimum: 0
  43     default: 0
  44     unit: pixels
  45   - identifier: bottom
  46     title: Bottom
  47     type: integer
  48     minimum: 0
  49     default: 0
  50     unit: pixels
  51   - identifier: center
  52     title: Center crop
  53     description: Whether to automatically crop whatever is needed to fill the output frame and prevent padding.
  54     type: integer
  55     minimum: 0
  56     maximum: 1
  57     default: 0
  58     widget: checkbox
  59   - identifier: center_bias
  60     title: Center balance
  61     description: When center crop is enabled, offset the center point.
  62     type: integer
  63     minimum: 0
  64     default: 0
  65     unit: pixels
  66   - identifier: use_profile
  67     title: Use profile resolution
  68     description: >
  69       This is useful for proxy editing. Normally all crop values are expressed in terms
  70       of pixels of the source footage, but this option makes them relative to the
  71       profile resolution.
  72     type: integer
  73     minimum: 0
  74     maximum: 1
  75     default: 0
  76     widget: checkbox