doc/apireference.rst

   1 VapourSynth C API Reference
   2 ===========================
   3 For now see the example filters in the sdk dir. Reading simplefilters.c, which contains almost all built-in functions, can also be very helpful.
   4
   5 Reserved Frame Properties
   6 #########################
   7 All frames contain a map of key--value pairs. It is recommended that these properties are named using only a-z, A-Z, 0-9 using CamelCase.
   8 There is a special category of keys starting with _ which have strictly defined meanings specified below. It is acceptable to not set any of these keys if they are unknown.
   9 It is also a fatal error to set them to a value not specified below.::
  10
  11    The frame's absolute timestamp in seconds if reported by the source filter.
  12    Should only be set by the source filter and not be modified.
  13    _AbsoluteTime float
  14
  15    Chroma sample position in YUV formats.
  16    _ChromaLocation int (0=left, 1=center, 2=topleft, 3=top, 4=bottomleft, 5=bottom)
  17
  18    Full or limited range (PC/TV range). Primarily used with YUV formats.
  19    _ColorRange int (0 = full range, 1 = limited range)
  20
  21    Encoded as in avcodec.h in libavcodec. It's so convoluted I'm not
  22    going to try to describe it here.
  23    _ColorSpace int
  24
  25    Whether or not the frame needs postprocessing, usually hinted from field
  26    matching filters.
  27    _Combed bint
  28
  29    The frame's duration in seconds as a rational number.
  30    Filters that modify the framerate should also change this value.
  31    _DurationNum int
  32    _DurationDen int
  33
  34    If the frame has been split into fields this says if the frame was
  35    derived from top or bottom fields.
  36    _Field int (0 = from bottom field, 1 = from top field)
  37
  38    If the frame is composed of two independent fields (interlaced).
  39    _FieldBased int (0 = frame based, 1 = field based)
  40
  41    A single character describing the frame type. It uses the common
  42    IPB letters but other letters may also be used for formats with
  43    additional frame types.
  44    _PictType data
  45
  46    Display aspect ratio as a rational number.
  47    _SARNum int
  48    _SARDen int
  49
  50    Indicates a scenechange for the next/previous frame transition.
  51    _SceneChangeNext bint
  52    _SceneChangePrev bint