1schema_version: 0.1
2type: producer
3identifier: decklink
4title: Blackmagic Design DeckLink Capture
5version: 1
6copyright: Copyright (C) 2011-2018 Meltytech, LLC
7license: LGPL
8language: en
9creator: Dan Dennedy
10tags:
11  - Audio
12  - Video
13description: >
14  Capture video and audio using Blackmagic Design DeckLink SDI or Intensity
15  HDMI cards.
16notes: >
17  Please ensure that you use a MLT profile that is compatible with a broadcast
18  standard which the card you are using supports. If you must use an interlaced
19  profile but wish to deinterlace or scale the input, then you must use the
20  consumer producer, e.g.:
21  melt -profile square_pal consumer:decklink: profile=dv_pal
22bugs:
23  - It is incompatible with the yadif deinterlacer.
24  - Transport controls such as seeking has no affect.
25  - External deck control is not implemented.
26  - Only 8-bit Y'CbCr is supported at this time.
27parameters:
28  - identifier: argument
29    title: Card
30    type: integer
31    default: 0
32    minimum: 0
33    widget: spinner
34
35  - identifier: channels
36    title: Audio channels
37    type: integer
38    default: 2
39    minimum: 2
40    maximum: 16
41    widget: spinner
42
43  - identifier: buffer
44    title: Maximum buffer
45    description: >
46      There is a queue of frames between this plugin and its consumer.
47      If the consumer has a little, intermittent delay then it reduces the
48      risk of dropping a frame. However, this provides a maximum number of
49      frames that can be buffered to prevent consuming memory unbounded in
50      the case of frequent or sustained delays.
51    type: integer
52    default: 25
53    minimum: 0
54    unit: frames
55    widget: spinner
56
57  - identifier: prefill
58    title: Initial buffer
59    description: Initially fill the buffer with a number of frames.
60    type: integer
61    default: 25
62    minimum: 0
63    unit: frames
64    widget: spinner
65
66  - identifier: vanc
67    title: Vertical ancillary capture
68    description: >
69      Captures vertical ancillary data as image data and places it at the top
70      of the visible/active image.
71      You can either set the number of lines to capture or use -1 for automatic
72      (32 lines) mode.
73    type: integer
74    minimum: -1
75    default: 0
76    unit: lines
77    widget: spinner
78
79  - identifier: preview
80    title: Enable preview
81    description: Support preview monitoring when paused (speed = 0).
82    type: integer
83    minimum: 0
84    maximum: 1
85    default: 0
86    widget: checkbox
87
88  - identifier: devices
89    title: Number of devices
90    type: integer
91    readonly: yes
92    minimum: 0
93
94  - identifier: device.*
95    title: Device model
96    description: The model name of each device that accepts input.
97    type: string
98    readonly: yes
99
100  - identifier: priority
101    title: Thread priority
102    description: Set the DeckLink thread's scheduling class to realtime and its priority.
103    type: integer
104    minimum: 1
105    maximum: 99
106    default: 20
107
108  - identifier: vitc_in
109    title: Start timecode
110    type: integer
111    description: >
112      The vertical interval timecode (VITC) in binary-coded decimal (BCD) format.
113      It skips frames that has VITC timecode less then specified.
114      After reaching first frame with timecode greater or equal then specified this
115      property is reset to zero.
116
117  - identifier: bitdepth
118    title: Bitdepth for capturing
119    description: Enable capturing in 10-bit native SDI signal
120    type: integer
121    values:
122      - 8 # 8-bit data
123      - 10 # 10-bit data
124