Documentation/userspace-api/media/rc/rc-tables.rst

   1 .. SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later
   2
   3 .. _Remote_controllers_tables:
   4
   5 ************************
   6 Remote controller tables
   7 ************************
   8
   9 Unfortunately, for several years, there was no effort to create uniform
  10 IR keycodes for different devices. This caused the same IR keyname to be
  11 mapped completely differently on different IR devices. This resulted
  12 that the same IR keyname to be mapped completely different on different
  13 IR's. Due to that, V4L2 API now specifies a standard for mapping Media
  14 keys on IR.
  15
  16 This standard should be used by both V4L/DVB drivers and userspace
  17 applications
  18
  19 The modules register the remote as keyboard within the linux input
  20 layer. This means that the IR key strokes will look like normal keyboard
  21 key strokes (if CONFIG_INPUT_KEYBOARD is enabled). Using the event
  22 devices (CONFIG_INPUT_EVDEV) it is possible for applications to access
  23 the remote via /dev/input/event devices.
  24
  25
  26 .. _rc_standard_keymap:
  27
  28 .. tabularcolumns:: |p{4.4cm}|p{4.4cm}|p{8.7cm}|
  29
  30 .. flat-table:: IR default keymapping
  31     :header-rows:  0
  32     :stub-columns: 0
  33     :widths:       1 1 2
  34
  35
  36     -  .. row 1
  37
  38        -  Key code
  39
  40        -  Meaning
  41
  42        -  Key examples on IR
  43
  44     -  .. row 2
  45
  46        -  **Numeric keys**
  47
  48     -  .. row 3
  49
  50        -  ``KEY_NUMERIC_0``
  51
  52        -  Keyboard digit 0
  53
  54        -  0
  55
  56     -  .. row 4
  57
  58        -  ``KEY_NUMERIC_1``
  59
  60        -  Keyboard digit 1
  61
  62        -  1
  63
  64     -  .. row 5
  65
  66        -  ``KEY_NUMERIC_2``
  67
  68        -  Keyboard digit 2
  69
  70        -  2
  71
  72     -  .. row 6
  73
  74        -  ``KEY_NUMERIC_3``
  75
  76        -  Keyboard digit 3
  77
  78        -  3
  79
  80     -  .. row 7
  81
  82        -  ``KEY_NUMERIC_4``
  83
  84        -  Keyboard digit 4
  85
  86        -  4
  87
  88     -  .. row 8
  89
  90        -  ``KEY_NUMERIC_5``
  91
  92        -  Keyboard digit 5
  93
  94        -  5
  95
  96     -  .. row 9
  97
  98        -  ``KEY_NUMERIC_6``
  99
 100        -  Keyboard digit 6
 101
 102        -  6
 103
 104     -  .. row 10
 105
 106        -  ``KEY_NUMERIC_7``
 107
 108        -  Keyboard digit 7
 109
 110        -  7
 111
 112     -  .. row 11
 113
 114        -  ``KEY_NUMERIC_8``
 115
 116        -  Keyboard digit 8
 117
 118        -  8
 119
 120     -  .. row 12
 121
 122        -  ``KEY_NUMERIC_9``
 123
 124        -  Keyboard digit 9
 125
 126        -  9
 127
 128     -  .. row 13
 129
 130        -  **Movie play control**
 131
 132     -  .. row 14
 133
 134        -  ``KEY_FORWARD``
 135
 136        -  Instantly advance in time
 137
 138        -  >> / FORWARD
 139
 140     -  .. row 15
 141
 142        -  ``KEY_BACK``
 143
 144        -  Instantly go back in time
 145
 146        -  <<< / BACK
 147
 148     -  .. row 16
 149
 150        -  ``KEY_FASTFORWARD``
 151
 152        -  Play movie faster
 153
 154        -  >>> / FORWARD
 155
 156     -  .. row 17
 157
 158        -  ``KEY_REWIND``
 159
 160        -  Play movie back
 161
 162        -  REWIND / BACKWARD
 163
 164     -  .. row 18
 165
 166        -  ``KEY_NEXT``
 167
 168        -  Select next chapter / sub-chapter / interval
 169
 170        -  NEXT / SKIP
 171
 172     -  .. row 19
 173
 174        -  ``KEY_PREVIOUS``
 175
 176        -  Select previous chapter / sub-chapter / interval
 177
 178        -  << / PREV / PREVIOUS
 179
 180     -  .. row 20
 181
 182        -  ``KEY_AGAIN``
 183
 184        -  Repeat the video or a video interval
 185
 186        -  REPEAT / LOOP / RECALL
 187
 188     -  .. row 21
 189
 190        -  ``KEY_PAUSE``
 191
 192        -  Pause stream
 193
 194        -  PAUSE / FREEZE
 195
 196     -  .. row 22
 197
 198        -  ``KEY_PLAY``
 199
 200        -  Play movie at the normal timeshift
 201
 202        -  NORMAL TIMESHIFT / LIVE / >
 203
 204     -  .. row 23
 205
 206        -  ``KEY_PLAYPAUSE``
 207
 208        -  Alternate between play and pause
 209
 210        -  PLAY / PAUSE
 211
 212     -  .. row 24
 213
 214        -  ``KEY_STOP``
 215
 216        -  Stop stream
 217
 218        -  STOP
 219
 220     -  .. row 25
 221
 222        -  ``KEY_RECORD``
 223
 224        -  Start/stop recording stream
 225
 226        -  CAPTURE / REC / RECORD/PAUSE
 227
 228     -  .. row 26
 229
 230        -  ``KEY_CAMERA``
 231
 232        -  Take a picture of the image
 233
 234        -  CAMERA ICON / CAPTURE / SNAPSHOT
 235
 236     -  .. row 27
 237
 238        -  ``KEY_SHUFFLE``
 239
 240        -  Enable shuffle mode
 241
 242        -  SHUFFLE
 243
 244     -  .. row 28
 245
 246        -  ``KEY_TIME``
 247
 248        -  Activate time shift mode
 249
 250        -  TIME SHIFT
 251
 252     -  .. row 29
 253
 254        -  ``KEY_TITLE``
 255
 256        -  Allow changing the chapter
 257
 258        -  CHAPTER
 259
 260     -  .. row 30
 261
 262        -  ``KEY_SUBTITLE``
 263
 264        -  Allow changing the subtitle
 265
 266        -  SUBTITLE
 267
 268     -  .. row 31
 269
 270        -  **Image control**
 271
 272     -  .. row 32
 273
 274        -  ``KEY_BRIGHTNESSDOWN``
 275
 276        -  Decrease Brightness
 277
 278        -  BRIGHTNESS DECREASE
 279
 280     -  .. row 33
 281
 282        -  ``KEY_BRIGHTNESSUP``
 283
 284        -  Increase Brightness
 285
 286        -  BRIGHTNESS INCREASE
 287
 288     -  .. row 34
 289
 290        -  ``KEY_ANGLE``
 291
 292        -  Switch video camera angle (on videos with more than one angle
 293           stored)
 294
 295        -  ANGLE / SWAP
 296
 297     -  .. row 35
 298
 299        -  ``KEY_EPG``
 300
 301        -  Open the Elecrowonic Play Guide (EPG)
 302
 303        -  EPG / GUIDE
 304
 305     -  .. row 36
 306
 307        -  ``KEY_TEXT``
 308
 309        -  Activate/change closed caption mode
 310
 311        -  CLOSED CAPTION/TELETEXT / DVD TEXT / TELETEXT / TTX
 312
 313     -  .. row 37
 314
 315        -  **Audio control**
 316
 317     -  .. row 38
 318
 319        -  ``KEY_AUDIO``
 320
 321        -  Change audio source
 322
 323        -  AUDIO SOURCE / AUDIO / MUSIC
 324
 325     -  .. row 39
 326
 327        -  ``KEY_MUTE``
 328
 329        -  Mute/unmute audio
 330
 331        -  MUTE / DEMUTE / UNMUTE
 332
 333     -  .. row 40
 334
 335        -  ``KEY_VOLUMEDOWN``
 336
 337        -  Decrease volume
 338
 339        -  VOLUME- / VOLUME DOWN
 340
 341     -  .. row 41
 342
 343        -  ``KEY_VOLUMEUP``
 344
 345        -  Increase volume
 346
 347        -  VOLUME+ / VOLUME UP
 348
 349     -  .. row 42
 350
 351        -  ``KEY_MODE``
 352
 353        -  Change sound mode
 354
 355        -  MONO/STEREO
 356
 357     -  .. row 43
 358
 359        -  ``KEY_LANGUAGE``
 360
 361        -  Select Language
 362
 363        -  1ST / 2ND LANGUAGE / DVD LANG / MTS/SAP / MTS SEL
 364
 365     -  .. row 44
 366
 367        -  **Channel control**
 368
 369     -  .. row 45
 370
 371        -  ``KEY_CHANNEL``
 372
 373        -  Go to the next favorite channel
 374
 375        -  ALT / CHANNEL / CH SURFING / SURF / FAV
 376
 377     -  .. row 46
 378
 379        -  ``KEY_CHANNELDOWN``
 380
 381        -  Decrease channel sequentially
 382
 383        -  CHANNEL - / CHANNEL DOWN / DOWN
 384
 385     -  .. row 47
 386
 387        -  ``KEY_CHANNELUP``
 388
 389        -  Increase channel sequentially
 390
 391        -  CHANNEL + / CHANNEL UP / UP
 392
 393     -  .. row 48
 394
 395        -  ``KEY_DIGITS``
 396
 397        -  Use more than one digit for channel
 398
 399        -  PLUS / 100/ 1xx / xxx / -/-- / Single Double Triple Digit
 400
 401     -  .. row 49
 402
 403        -  ``KEY_SEARCH``
 404
 405        -  Start channel autoscan
 406
 407        -  SCAN / AUTOSCAN
 408
 409     -  .. row 50
 410
 411        -  **Colored keys**
 412
 413     -  .. row 51
 414
 415        -  ``KEY_BLUE``
 416
 417        -  IR Blue key
 418
 419        -  BLUE
 420
 421     -  .. row 52
 422
 423        -  ``KEY_GREEN``
 424
 425        -  IR Green Key
 426
 427        -  GREEN
 428
 429     -  .. row 53
 430
 431        -  ``KEY_RED``
 432
 433        -  IR Red key
 434
 435        -  RED
 436
 437     -  .. row 54
 438
 439        -  ``KEY_YELLOW``
 440
 441        -  IR Yellow key
 442
 443        -  YELLOW
 444
 445     -  .. row 55
 446
 447        -  **Media selection**
 448
 449     -  .. row 56
 450
 451        -  ``KEY_CD``
 452
 453        -  Change input source to Compact Disc
 454
 455        -  CD
 456
 457     -  .. row 57
 458
 459        -  ``KEY_DVD``
 460
 461        -  Change input to DVD
 462
 463        -  DVD / DVD MENU
 464
 465     -  .. row 58
 466
 467        -  ``KEY_EJECTCLOSECD``
 468
 469        -  Open/close the CD/DVD player
 470
 471        -  -> ) / CLOSE / OPEN
 472
 473     -  .. row 59
 474
 475        -  ``KEY_MEDIA``
 476
 477        -  Turn on/off Media application
 478
 479        -  PC/TV / TURN ON/OFF APP
 480
 481     -  .. row 60
 482
 483        -  ``KEY_PC``
 484
 485        -  Selects from TV to PC
 486
 487        -  PC
 488
 489     -  .. row 61
 490
 491        -  ``KEY_RADIO``
 492
 493        -  Put into AM/FM radio mode
 494
 495        -  RADIO / TV/FM / TV/RADIO / FM / FM/RADIO
 496
 497     -  .. row 62
 498
 499        -  ``KEY_TV``
 500
 501        -  Select tv mode
 502
 503        -  TV / LIVE TV
 504
 505     -  .. row 63
 506
 507        -  ``KEY_TV2``
 508
 509        -  Select Cable mode
 510
 511        -  AIR/CBL
 512
 513     -  .. row 64
 514
 515        -  ``KEY_VCR``
 516
 517        -  Select VCR mode
 518
 519        -  VCR MODE / DTR
 520
 521     -  .. row 65
 522
 523        -  ``KEY_VIDEO``
 524
 525        -  Alternate between input modes
 526
 527        -  SOURCE / SELECT / DISPLAY / SWITCH INPUTS / VIDEO
 528
 529     -  .. row 66
 530
 531        -  **Power control**
 532
 533     -  .. row 67
 534
 535        -  ``KEY_POWER``
 536
 537        -  Turn on/off computer
 538
 539        -  SYSTEM POWER / COMPUTER POWER
 540
 541     -  .. row 68
 542
 543        -  ``KEY_POWER2``
 544
 545        -  Turn on/off application
 546
 547        -  TV ON/OFF / POWER
 548
 549     -  .. row 69
 550
 551        -  ``KEY_SLEEP``
 552
 553        -  Activate sleep timer
 554
 555        -  SLEEP / SLEEP TIMER
 556
 557     -  .. row 70
 558
 559        -  ``KEY_SUSPEND``
 560
 561        -  Put computer into suspend mode
 562
 563        -  STANDBY / SUSPEND
 564
 565     -  .. row 71
 566
 567        -  **Window control**
 568
 569     -  .. row 72
 570
 571        -  ``KEY_CLEAR``
 572
 573        -  Stop stream and return to default input video/audio
 574
 575        -  CLEAR / RESET / BOSS KEY
 576
 577     -  .. row 73
 578
 579        -  ``KEY_CYCLEWINDOWS``
 580
 581        -  Minimize windows and move to the next one
 582
 583        -  ALT-TAB / MINIMIZE / DESKTOP
 584
 585     -  .. row 74
 586
 587        -  ``KEY_FAVORITES``
 588
 589        -  Open the favorites stream window
 590
 591        -  TV WALL / Favorites
 592
 593     -  .. row 75
 594
 595        -  ``KEY_MENU``
 596
 597        -  Call application menu
 598
 599        -  2ND CONTROLS (USA: MENU) / DVD/MENU / SHOW/HIDE CTRL
 600
 601     -  .. row 76
 602
 603        -  ``KEY_NEW``
 604
 605        -  Open/Close Picture in Picture
 606
 607        -  PIP
 608
 609     -  .. row 77
 610
 611        -  ``KEY_OK``
 612
 613        -  Send a confirmation code to application
 614
 615        -  OK / ENTER / RETURN
 616
 617     -  .. row 78
 618
 619        -  ``KEY_ASPECT_RATIO``
 620
 621        -  Select screen aspect ratio
 622
 623        -  4:3 16:9 SELECT
 624
 625     -  .. row 79
 626
 627        -  ``KEY_FULL_SCREEN``
 628
 629        -  Put device into zoom/full screen mode
 630
 631        -  ZOOM / FULL SCREEN / ZOOM+ / HIDE PANNEL / SWITCH
 632
 633     -  .. row 80
 634
 635        -  **Navigation keys**
 636
 637     -  .. row 81
 638
 639        -  ``KEY_ESC``
 640
 641        -  Cancel current operation
 642
 643        -  CANCEL / BACK
 644
 645     -  .. row 82
 646
 647        -  ``KEY_HELP``
 648
 649        -  Open a Help window
 650
 651        -  HELP
 652
 653     -  .. row 83
 654
 655        -  ``KEY_HOMEPAGE``
 656
 657        -  Navigate to Homepage
 658
 659        -  HOME
 660
 661     -  .. row 84
 662
 663        -  ``KEY_INFO``
 664
 665        -  Open On Screen Display
 666
 667        -  DISPLAY INFORMATION / OSD
 668
 669     -  .. row 85
 670
 671        -  ``KEY_WWW``
 672
 673        -  Open the default browser
 674
 675        -  WEB
 676
 677     -  .. row 86
 678
 679        -  ``KEY_UP``
 680
 681        -  Up key
 682
 683        -  UP
 684
 685     -  .. row 87
 686
 687        -  ``KEY_DOWN``
 688
 689        -  Down key
 690
 691        -  DOWN
 692
 693     -  .. row 88
 694
 695        -  ``KEY_LEFT``
 696
 697        -  Left key
 698
 699        -  LEFT
 700
 701     -  .. row 89
 702
 703        -  ``KEY_RIGHT``
 704
 705        -  Right key
 706
 707        -  RIGHT
 708
 709     -  .. row 90
 710
 711        -  **Miscellaneous keys**
 712
 713     -  .. row 91
 714
 715        -  ``KEY_DOT``
 716
 717        -  Return a dot
 718
 719        -  .
 720
 721     -  .. row 92
 722
 723        -  ``KEY_FN``
 724
 725        -  Select a function
 726
 727        -  FUNCTION
 728
 729
 730 It should be noted that, sometimes, there some fundamental missing keys
 731 at some cheaper IR's. Due to that, it is recommended to:
 732
 733
 734 .. _rc_keymap_notes:
 735
 736 .. flat-table:: Notes
 737     :header-rows:  0
 738     :stub-columns: 0
 739
 740
 741     -  .. row 1
 742
 743        -  On simpler IR's, without separate channel keys, you need to map UP
 744           as ``KEY_CHANNELUP``
 745
 746     -  .. row 2
 747
 748        -  On simpler IR's, without separate channel keys, you need to map
 749           DOWN as ``KEY_CHANNELDOWN``
 750
 751     -  .. row 3
 752
 753        -  On simpler IR's, without separate volume keys, you need to map
 754           LEFT as ``KEY_VOLUMEDOWN``
 755
 756     -  .. row 4
 757
 758        -  On simpler IR's, without separate volume keys, you need to map
 759           RIGHT as ``KEY_VOLUMEUP``