1 .. -*- coding: utf-8; mode: rst -*-
3 .. _media-controller-types:
5 Types and flags used to represent the media graph elements
6 ==========================================================
8 .. tabularcolumns:: |p{8.2cm}|p{10.3cm}|
10 .. _media-entity-functions:
12 .. cssclass:: longtable
14 .. flat-table:: Media entity functions
21 .. _MEDIA-ENT-F-UNKNOWN:
22 .. _MEDIA-ENT-F-V4L2-SUBDEV-UNKNOWN:
24 - ``MEDIA_ENT_F_UNKNOWN`` and
26 ``MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN``
28 - Unknown entity. That generally indicates that a driver didn't
29 initialize properly the entity, which is a Kernel bug
33 .. _MEDIA-ENT-F-IO-V4L:
35 - ``MEDIA_ENT_F_IO_V4L``
37 - Data streaming input and/or output entity.
41 .. _MEDIA-ENT-F-IO-VBI:
43 - ``MEDIA_ENT_F_IO_VBI``
45 - V4L VBI streaming input or output entity
49 .. _MEDIA-ENT-F-IO-SWRADIO:
51 - ``MEDIA_ENT_F_IO_SWRADIO``
53 - V4L Software Digital Radio (SDR) streaming input or output entity
57 .. _MEDIA-ENT-F-IO-DTV:
59 - ``MEDIA_ENT_F_IO_DTV``
61 - DVB Digital TV streaming input or output entity
65 .. _MEDIA-ENT-F-DTV-DEMOD:
67 - ``MEDIA_ENT_F_DTV_DEMOD``
69 - Digital TV demodulator entity.
73 .. _MEDIA-ENT-F-TS-DEMUX:
75 - ``MEDIA_ENT_F_TS_DEMUX``
77 - MPEG Transport stream demux entity. Could be implemented on
78 hardware or in Kernelspace by the Linux DVB subsystem.
82 .. _MEDIA-ENT-F-DTV-CA:
84 - ``MEDIA_ENT_F_DTV_CA``
86 - Digital TV Conditional Access module (CAM) entity
90 .. _MEDIA-ENT-F-DTV-NET-DECAP:
92 - ``MEDIA_ENT_F_DTV_NET_DECAP``
94 - Digital TV network ULE/MLE desencapsulation entity. Could be
95 implemented on hardware or in Kernelspace
99 .. _MEDIA-ENT-F-CONN-RF:
101 - ``MEDIA_ENT_F_CONN_RF``
103 - Connector for a Radio Frequency (RF) signal.
107 .. _MEDIA-ENT-F-CONN-SVIDEO:
109 - ``MEDIA_ENT_F_CONN_SVIDEO``
111 - Connector for a S-Video signal.
115 .. _MEDIA-ENT-F-CONN-COMPOSITE:
117 - ``MEDIA_ENT_F_CONN_COMPOSITE``
119 - Connector for a RGB composite signal.
123 .. _MEDIA-ENT-F-CAM-SENSOR:
125 - ``MEDIA_ENT_F_CAM_SENSOR``
127 - Camera video sensor entity.
131 .. _MEDIA-ENT-F-FLASH:
133 - ``MEDIA_ENT_F_FLASH``
135 - Flash controller entity.
139 .. _MEDIA-ENT-F-LENS:
141 - ``MEDIA_ENT_F_LENS``
143 - Lens controller entity.
147 .. _MEDIA-ENT-F-ATV-DECODER:
149 - ``MEDIA_ENT_F_ATV_DECODER``
151 - Analog video decoder, the basic function of the video decoder is
152 to accept analogue video from a wide variety of sources such as
153 broadcast, DVD players, cameras and video cassette recorders, in
154 either NTSC, PAL, SECAM or HD format, separating the stream into
155 its component parts, luminance and chrominance, and output it in
156 some digital video standard, with appropriate timing signals.
160 .. _MEDIA-ENT-F-TUNER:
162 - ``MEDIA_ENT_F_TUNER``
164 - Digital TV, analog TV, radio and/or software radio tuner, with
165 consists on a PLL tuning stage that converts radio frequency (RF)
166 signal into an Intermediate Frequency (IF). Modern tuners have
167 internally IF-PLL decoders for audio and video, but older models
168 have those stages implemented on separate entities.
172 .. _MEDIA-ENT-F-IF-VID-DECODER:
174 - ``MEDIA_ENT_F_IF_VID_DECODER``
176 - IF-PLL video decoder. It receives the IF from a PLL and decodes
177 the analog TV video signal. This is commonly found on some very
178 old analog tuners, like Philips MK3 designs. They all contain a
179 tda9887 (or some software compatible similar chip, like tda9885).
180 Those devices use a different I2C address than the tuner PLL.
184 .. _MEDIA-ENT-F-IF-AUD-DECODER:
186 - ``MEDIA_ENT_F_IF_AUD_DECODER``
188 - IF-PLL sound decoder. It receives the IF from a PLL and decodes
189 the analog TV audio signal. This is commonly found on some very
190 old analog hardware, like Micronas msp3400, Philips tda9840,
191 tda985x, etc. Those devices use a different I2C address than the
192 tuner PLL and should be controlled together with the IF-PLL video
197 .. _MEDIA-ENT-F-AUDIO-CAPTURE:
199 - ``MEDIA_ENT_F_AUDIO_CAPTURE``
201 - Audio Capture Function Entity.
205 .. _MEDIA-ENT-F-AUDIO-PLAYBACK:
207 - ``MEDIA_ENT_F_AUDIO_PLAYBACK``
209 - Audio Playback Function Entity.
213 .. _MEDIA-ENT-F-AUDIO-MIXER:
215 - ``MEDIA_ENT_F_AUDIO_MIXER``
217 - Audio Mixer Function Entity.
221 .. _MEDIA-ENT-F-PROC-VIDEO-COMPOSER:
223 - ``MEDIA_ENT_F_PROC_VIDEO_COMPOSER``
225 - Video composer (blender). An entity capable of video
226 composing must have at least two sink pads and one source
227 pad, and composes input video frames onto output video
228 frames. Composition can be performed using alpha blending,
229 color keying, raster operations (ROP), stitching or any other
234 .. _MEDIA-ENT-F-PROC-VIDEO-PIXEL-FORMATTER:
236 - ``MEDIA_ENT_F_PROC_VIDEO_PIXEL_FORMATTER``
238 - Video pixel formatter. An entity capable of pixel formatting
239 must have at least one sink pad and one source pad. Read
240 pixel formatters read pixels from memory and perform a subset
241 of unpacking, cropping, color keying, alpha multiplication
242 and pixel encoding conversion. Write pixel formatters perform
243 a subset of dithering, pixel encoding conversion and packing
244 and write pixels to memory.
248 .. _MEDIA-ENT-F-PROC-VIDEO-PIXEL-ENC-CONV:
250 - ``MEDIA_ENT_F_PROC_VIDEO_PIXEL_ENC_CONV``
252 - Video pixel encoding converter. An entity capable of pixel
253 enconding conversion must have at least one sink pad and one
254 source pad, and convert the encoding of pixels received on
255 its sink pad(s) to a different encoding output on its source
256 pad(s). Pixel encoding conversion includes but isn't limited
257 to RGB to/from HSV, RGB to/from YUV and CFA (Bayer) to RGB
262 .. _MEDIA-ENT-F-PROC-VIDEO-LUT:
264 - ``MEDIA_ENT_F_PROC_VIDEO_LUT``
266 - Video look-up table. An entity capable of video lookup table
267 processing must have one sink pad and one source pad. It uses
268 the values of the pixels received on its sink pad to look up
269 entries in internal tables and output them on its source pad.
270 The lookup processing can be performed on all components
271 separately or combine them for multi-dimensional table
276 .. _MEDIA-ENT-F-PROC-VIDEO-SCALER:
278 - ``MEDIA_ENT_F_PROC_VIDEO_SCALER``
280 - Video scaler. An entity capable of video scaling must have
281 at least one sink pad and one source pad, and scale the
282 video frame(s) received on its sink pad(s) to a different
283 resolution output on its source pad(s). The range of
284 supported scaling ratios is entity-specific and can differ
285 between the horizontal and vertical directions (in particular
286 scaling can be supported in one direction only). Binning and
287 sub-sampling (occasionally also referred to as skipping) are
288 considered as scaling.
292 .. _MEDIA-ENT-F-PROC-VIDEO-STATISTICS:
294 - ``MEDIA_ENT_F_PROC_VIDEO_STATISTICS``
296 - Video statistics computation (histogram, 3A, etc.). An entity
297 capable of statistics computation must have one sink pad and
298 one source pad. It computes statistics over the frames
299 received on its sink pad and outputs the statistics data on
304 .. _MEDIA-ENT-F-VID-MUX:
306 - ``MEDIA_ENT_F_VID_MUX``
308 - Video multiplexer. An entity capable of multiplexing must have at
309 least two sink pads and one source pad, and must pass the video
310 frame(s) received from the active sink pad to the source pad.
314 .. _MEDIA-ENT-F-VID-IF-BRIDGE:
316 - ``MEDIA_ENT_F_VID_IF_BRIDGE``
318 - Video interface bridge. A video interface bridge entity must have at
319 least one sink pad and at least one source pad. It receives video
320 frames on its sink pad from an input video bus of one type (HDMI, eDP,
321 MIPI CSI-2, etc.), and outputs them on its source pad to an output
322 video bus of another type (eDP, MIPI CSI-2, parallel, etc.).
326 .. _MEDIA-ENT-F-DTV-DECODER:
328 - ``MEDIA_ENT_F_DTV_DECODER``
330 - Digital video decoder. The basic function of the video decoder is
331 to accept digital video from a wide variety of sources
332 and output it in some digital video standard, with appropriate
335 .. tabularcolumns:: |p{5.5cm}|p{12.0cm}|
337 .. _media-entity-flag:
339 .. flat-table:: Media entity flags
346 .. _MEDIA-ENT-FL-DEFAULT:
348 - ``MEDIA_ENT_FL_DEFAULT``
350 - Default entity for its type. Used to discover the default audio,
351 VBI and video devices, the default camera sensor, etc.
355 .. _MEDIA-ENT-FL-CONNECTOR:
357 - ``MEDIA_ENT_FL_CONNECTOR``
359 - The entity represents a connector.
362 .. tabularcolumns:: |p{6.5cm}|p{6.0cm}|p{5.0cm}|
366 .. flat-table:: Media interface types
373 .. _MEDIA-INTF-T-DVB-FE:
375 - ``MEDIA_INTF_T_DVB_FE``
377 - Device node interface for the Digital TV frontend
379 - typically, /dev/dvb/adapter?/frontend?
383 .. _MEDIA-INTF-T-DVB-DEMUX:
385 - ``MEDIA_INTF_T_DVB_DEMUX``
387 - Device node interface for the Digital TV demux
389 - typically, /dev/dvb/adapter?/demux?
393 .. _MEDIA-INTF-T-DVB-DVR:
395 - ``MEDIA_INTF_T_DVB_DVR``
397 - Device node interface for the Digital TV DVR
399 - typically, /dev/dvb/adapter?/dvr?
403 .. _MEDIA-INTF-T-DVB-CA:
405 - ``MEDIA_INTF_T_DVB_CA``
407 - Device node interface for the Digital TV Conditional Access
409 - typically, /dev/dvb/adapter?/ca?
413 .. _MEDIA-INTF-T-DVB-NET:
415 - ``MEDIA_INTF_T_DVB_NET``
417 - Device node interface for the Digital TV network control
419 - typically, /dev/dvb/adapter?/net?
423 .. _MEDIA-INTF-T-V4L-VIDEO:
425 - ``MEDIA_INTF_T_V4L_VIDEO``
427 - Device node interface for video (V4L)
429 - typically, /dev/video?
433 .. _MEDIA-INTF-T-V4L-VBI:
435 - ``MEDIA_INTF_T_V4L_VBI``
437 - Device node interface for VBI (V4L)
439 - typically, /dev/vbi?
443 .. _MEDIA-INTF-T-V4L-RADIO:
445 - ``MEDIA_INTF_T_V4L_RADIO``
447 - Device node interface for radio (V4L)
449 - typically, /dev/radio?
453 .. _MEDIA-INTF-T-V4L-SUBDEV:
455 - ``MEDIA_INTF_T_V4L_SUBDEV``
457 - Device node interface for a V4L subdevice
459 - typically, /dev/v4l-subdev?
463 .. _MEDIA-INTF-T-V4L-SWRADIO:
465 - ``MEDIA_INTF_T_V4L_SWRADIO``
467 - Device node interface for Software Defined Radio (V4L)
469 - typically, /dev/swradio?
473 .. _MEDIA-INTF-T-V4L-TOUCH:
475 - ``MEDIA_INTF_T_V4L_TOUCH``
477 - Device node interface for Touch device (V4L)
479 - typically, /dev/v4l-touch?
483 .. _MEDIA-INTF-T-ALSA-PCM-CAPTURE:
485 - ``MEDIA_INTF_T_ALSA_PCM_CAPTURE``
487 - Device node interface for ALSA PCM Capture
489 - typically, /dev/snd/pcmC?D?c
493 .. _MEDIA-INTF-T-ALSA-PCM-PLAYBACK:
495 - ``MEDIA_INTF_T_ALSA_PCM_PLAYBACK``
497 - Device node interface for ALSA PCM Playback
499 - typically, /dev/snd/pcmC?D?p
503 .. _MEDIA-INTF-T-ALSA-CONTROL:
505 - ``MEDIA_INTF_T_ALSA_CONTROL``
507 - Device node interface for ALSA Control
509 - typically, /dev/snd/controlC?
513 .. _MEDIA-INTF-T-ALSA-COMPRESS:
515 - ``MEDIA_INTF_T_ALSA_COMPRESS``
517 - Device node interface for ALSA Compress
519 - typically, /dev/snd/compr?
523 .. _MEDIA-INTF-T-ALSA-RAWMIDI:
525 - ``MEDIA_INTF_T_ALSA_RAWMIDI``
527 - Device node interface for ALSA Raw MIDI
529 - typically, /dev/snd/midi?
533 .. _MEDIA-INTF-T-ALSA-HWDEP:
535 - ``MEDIA_INTF_T_ALSA_HWDEP``
537 - Device node interface for ALSA Hardware Dependent
539 - typically, /dev/snd/hwC?D?
543 .. _MEDIA-INTF-T-ALSA-SEQUENCER:
545 - ``MEDIA_INTF_T_ALSA_SEQUENCER``
547 - Device node interface for ALSA Sequencer
549 - typically, /dev/snd/seq
553 .. _MEDIA-INTF-T-ALSA-TIMER:
555 - ``MEDIA_INTF_T_ALSA_TIMER``
557 - Device node interface for ALSA Timer
559 - typically, /dev/snd/timer
562 .. tabularcolumns:: |p{5.5cm}|p{12.0cm}|
566 .. flat-table:: Media pad flags
573 .. _MEDIA-PAD-FL-SINK:
575 - ``MEDIA_PAD_FL_SINK``
577 - Input pad, relative to the entity. Input pads sink data and are
582 .. _MEDIA-PAD-FL-SOURCE:
584 - ``MEDIA_PAD_FL_SOURCE``
586 - Output pad, relative to the entity. Output pads source data and
587 are origins of links.
591 .. _MEDIA-PAD-FL-MUST-CONNECT:
593 - ``MEDIA_PAD_FL_MUST_CONNECT``
595 - If this flag is set and the pad is linked to any other pad, then
596 at least one of those links must be enabled for the entity to be
597 able to stream. There could be temporary reasons (e.g. device
598 configuration dependent) for the pad to need enabled links even
599 when this flag isn't set; the absence of the flag doesn't imply
603 One and only one of ``MEDIA_PAD_FL_SINK`` and ``MEDIA_PAD_FL_SOURCE``
604 must be set for every pad.
606 .. tabularcolumns:: |p{5.5cm}|p{12.0cm}|
610 .. flat-table:: Media link flags
617 .. _MEDIA-LNK-FL-ENABLED:
619 - ``MEDIA_LNK_FL_ENABLED``
621 - The link is enabled and can be used to transfer media data. When
622 two or more links target a sink pad, only one of them can be
627 .. _MEDIA-LNK-FL-IMMUTABLE:
629 - ``MEDIA_LNK_FL_IMMUTABLE``
631 - The link enabled state can't be modified at runtime. An immutable
632 link is always enabled.
636 .. _MEDIA-LNK-FL-DYNAMIC:
638 - ``MEDIA_LNK_FL_DYNAMIC``
640 - The link enabled state can be modified during streaming. This flag
641 is set by drivers and is read-only for applications.
645 .. _MEDIA-LNK-FL-LINK-TYPE:
647 - ``MEDIA_LNK_FL_LINK_TYPE``
649 - This is a bitmask that defines the type of the link. Currently,
650 two types of links are supported:
652 .. _MEDIA-LNK-FL-DATA-LINK:
654 ``MEDIA_LNK_FL_DATA_LINK`` if the link is between two pads
656 .. _MEDIA-LNK-FL-INTERFACE-LINK:
658 ``MEDIA_LNK_FL_INTERFACE_LINK`` if the link is between an
659 interface and an entity