Difference between revisions of "Media-ctl"

[checked revision] [quality revision]
m
m
 
Applicable for STM32MP13x lines

1 Overview[edit]

media-ctl is a V4L2 utility[1] is used to set up and configure the camera subsystem subdevices. It is based on the media controller Linux kernel interface[2].

2 Usage[edit]

 media-ctl --help
media-ctl [options]
-d, --device dev        Media device name (default: /dev/media0)
                        If <dev> starts with a digit, then /dev/media<dev> is used.
                        If <dev> doesn't exist, then find a media device that
                        reports a bus info string equal to <dev>.
-e, --entity name       Print the device name associated with the given entity
-V, --set-v4l2 v4l2     Comma-separated list of formats to setup
    --get-v4l2 pad      Print the active format on a given pad
    --get-dv pad        Print detected and current DV timings on a given pad
    --set-dv pad        Configure DV timings on a given pad
-h, --help              Show verbose help and exit
-i, --interactive       Modify links interactively
-l, --links links       Comma-separated list of link descriptors to setup
    --known-mbus-fmts   List known media bus formats and their numeric values
-p, --print-topology    Print the device topology. If an entity
                        is specified through the -e option, print
                        information for that entity only.
    --print-dot         Print the device topology as a dot graph
-r, --reset             Reset all links to inactive
-v, --verbose           Be verbose

Links and formats are defined as
        links           = link { ',' link } ;
        link            = pad '->' pad '[' flags ']' ;
        pad             = entity ':' pad-number ;
        entity          = entity-number | ( '"' entity-name '"' ) ;

        v4l2            = pad '[' v4l2-properties ']' ;
        v4l2-properties = v4l2-property { ',' v4l2-property } ;
        v4l2-property   = v4l2-mbusfmt | v4l2-crop | v4l2-interval
                        | v4l2-compose | v4l2-interval ;
        v4l2-mbusfmt    = 'fmt:' fcc '/' size ; { 'field:' v4l2-field ; } { 'colorspace:' v4l2-colorspace ; }
                           { 'xfer:' v4l2-xfer-func ; } { 'ycbcr-enc:' v4l2-ycbcr-enc-func ; }
                           { 'quantization:' v4l2-quant ; }
        v4l2-crop       = 'crop:' rectangle ;
        v4l2-compose    = 'compose:' rectangle ;
        v4l2-interval   = '@' numerator '/' denominator ;

        rectangle       = '(' left ',' top, ')' '/' size ;
        size            = width 'x' height ;

where the fields are
        entity-number   Entity numeric identifier
        entity-name     Entity name (string) 
        pad-number      Pad numeric identifier
        flags           Link flags (0: inactive, 1: active)
        fcc             Format FourCC
        width           Image width in pixels
        height          Image height in pixels
        numerator       Frame interval numerator
        denominator     Frame interval denominator
        v4l2-field      One of the following:
                        any
                        none
                        top
                        bottom
                        interlaced
                        seq-tb
                        seq-bt
                        alternate
                        interlaced-tb
                        interlaced-bt
        v4l2-colorspace One of the following:
                        default
                        smpte170m
                        smpte240m
                        rec709
                        unknown
                        470m
                        470bg
                        jpeg
                        srgb
                        oprgb
                        bt2020
                        raw
                        dcip3
        v4l2-xfer-func  One of the following:
                        default
                        709
                        srgb
                        oprgb
                        smpte240m
                        none
                        dcip3
                        smpte2084
        v4l2-quant      One of the following:
                        default
                        full-range
                        lim-range

3 Examples[edit]

Refer to V4L2 camera subsystem setup for examples of usage.

4 References[edit]


<noinclude>{{ApplicableFor
|MPUs list=STM32MP13x
|MPUs checklist=STM32MP13x,STM32MP15x
}}</noinclude>


== Overview ==
{{highlight|'''media-ctl'''}} is a V4L2 utility<ref>[https://git.linuxtv.org/v4l-utils.git V4L2 utilities]</ref> is used to set up and configure the camera subsystem subdevices. It is based on the media controller Linux kernel interface<ref name=API_MC>{{DocSource | domain=Linux kernel | path=userspace-api/media/mediactl/media-controller.html | text=Linux Media Infrastructure userspace API » Part IV - Media Controller API}}</ref>.

==Usage==
 {{Board$}} media-ctl --help<pre>

media-ctl [options]
-d, --device dev        Media device name (default: /dev/media0)
                        If <dev> starts with a digit, then /dev/media<dev> is used.
                        If <dev> doesn't exist, then find a media device that
                        reports a bus info string equal to <dev>.
-e, --entity name       Print the device name associated with the given entity
-V, --set-v4l2 v4l2     Comma-separated list of formats to setup
    --get-v4l2 pad      Print the active format on a given pad
    --get-dv pad        Print detected and current DV timings on a given pad
    --set-dv pad        Configure DV timings on a given pad
-h, --help              Show verbose help and exit
-i, --interactive       Modify links interactively
-l, --links links       Comma-separated list of link descriptors to setup
    --known-mbus-fmts   List known media bus formats and their numeric values
-p, --print-topology    Print the device topology. If an entity
                        is specified through the -e option, print
                        information for that entity only.
    --print-dot         Print the device topology as a dot graph
-r, --reset             Reset all links to inactive
-v, --verbose           Be verbose

Links and formats are defined as
        links           = link { ',' link } ;
        link            = pad '->' pad '[' flags ']' ;
        pad             = entity ':' pad-number ;
        entity          = entity-number | ( '"' entity-name '"' ) ;

        v4l2            = pad '[' v4l2-properties ']' ;
        v4l2-properties = v4l2-property { ',' v4l2-property } ;
        v4l2-property   = v4l2-mbusfmt | v4l2-crop | v4l2-interval
                        | v4l2-compose | v4l2-interval ;
        v4l2-mbusfmt    = 'fmt:' fcc '/' size ; { 'field:' v4l2-field ; } { 'colorspace:' v4l2-colorspace ; }
                           { 'xfer:' v4l2-xfer-func ; } { 'ycbcr-enc:' v4l2-ycbcr-enc-func ; }
                           { 'quantization:' v4l2-quant ; }
        v4l2-crop       = 'crop:' rectangle ;
        v4l2-compose    = 'compose:' rectangle ;
        v4l2-interval   = '@' numerator '/' denominator ;

        rectangle       = '(' left ',' top, ')' '/' size ;
        size            = width 'x' height ;

where the fields are
        entity-number   Entity numeric identifier
        entity-name     Entity name (string) 
        pad-number      Pad numeric identifier
        flags           Link flags (0: inactive, 1: active)
        fcc             Format FourCC
        width           Image width in pixels
        height          Image height in pixels
        numerator       Frame interval numerator
        denominator     Frame interval denominator
        v4l2-field      One of the following:
                        any
                        none
                        top
                        bottom
                        interlaced
                        seq-tb
                        seq-bt
                        alternate
                        interlaced-tb
                        interlaced-bt
        v4l2-colorspace One of the following:
                        default
                        smpte170m
                        smpte240m
                        rec709
                        unknown
                        470m
                        470bg
                        jpeg
                        srgb
                        oprgb
                        bt2020
                        raw
                        dcip3
        v4l2-xfer-func  One of the following:
                        default
                        709
                        srgb
                        oprgb
                        smpte240m
                        none
                        dcip3
                        smpte2084
        v4l2-quant      One of the following:
                        default
                        full-range
                        lim-range</pre>


==Examples==
Refer to [[STM32MP13_V4L2_camera_overview#Camera_subsystem_setup|V4L2 camera subsystem setup]] for examples of usage.

==References==<references />

<noinclude>

[[Category:V4L2]]
{{PublicationRequestId | 22730 | 2022-03-03 | }}</noinclude>
Line 5: Line 5:
   
 
== Overview ==
 
== Overview ==
{{highlight|'''media-ctl'''}} is a V4L2 utility<ref>[https://git.linuxtv.org/v4l-utils.git V4L2 utilities]</ref> is used to set up and configure the camera subsystem subdevices. It is based on the media controller Linux kernel interface<ref name=API_MC>{{DocSource | domain=Linux kernel | path=userspace-api/media/mediactl/media-controller.html | text=Linux Media Infrastructure userspace API » Part IV - Media Controller API}}</ref>.
+
{{highlight|'''media-ctl'''}} is a V4L2 utility<ref>[https://git.linuxtv.org/v4l-utils.git V4L2 utilities]</ref> used to set up and configure the camera subsystem subdevices. It is based on the media controller Linux kernel interface<ref name=API_MC>{{DocSource | domain=Linux kernel | path=userspace-api/media/mediactl/media-controller.html | text=Linux Media Infrastructure userspace API » Part IV - Media Controller API}}</ref>.
   
 
==Usage==
 
==Usage==