apps/keymaps/keymap-ipod.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2006 Jonathan Gordon
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21
  22 /* Button Code Definitions for ipod target */
  23
  24 #include "config.h"
  25 #include "action.h"
  26 #include "button.h"
  27 #include "settings.h"
  28
  29 /*
  30  * The format of the list is as follows
  31  * { Action Code,   Button code,    Prereq button code }
  32  * if there's no need to check the previous button's value, use BUTTON_NONE
  33  * Insert LAST_ITEM_IN_LIST at the end of each mapping
  34  */
  35
  36 /* CONTEXT_CUSTOM's used in this file...
  37
  38 CONTEXT_CUSTOM|CONTEXT_TREE = the standard list/tree defines (without directions)
  39
  40
  41 */
  42
  43 static const struct button_mapping button_context_standard[]  = {
  44     { ACTION_STD_PREV,          BUTTON_SCROLL_BACK,                 BUTTON_NONE },
  45     { ACTION_STD_PREVREPEAT,    BUTTON_SCROLL_BACK|BUTTON_REPEAT,   BUTTON_NONE },
  46     { ACTION_STD_NEXT,          BUTTON_SCROLL_FWD,                  BUTTON_NONE },
  47     { ACTION_STD_NEXTREPEAT,    BUTTON_SCROLL_FWD|BUTTON_REPEAT,    BUTTON_NONE },
  48     { ACTION_STD_CANCEL,        BUTTON_LEFT,                        BUTTON_NONE },
  49     { ACTION_STD_OK,            BUTTON_RIGHT,                       BUTTON_NONE },
  50
  51     { ACTION_STD_OK,            BUTTON_SELECT|BUTTON_REL,           BUTTON_SELECT },
  52     { ACTION_STD_MENU,          BUTTON_MENU|BUTTON_REL,             BUTTON_MENU },
  53     { ACTION_STD_QUICKSCREEN,   BUTTON_MENU|BUTTON_REPEAT,          BUTTON_MENU },
  54     { ACTION_STD_CONTEXT,       BUTTON_SELECT|BUTTON_REPEAT,        BUTTON_SELECT },
  55     { ACTION_STD_CANCEL,        BUTTON_PLAY|BUTTON_REPEAT,          BUTTON_NONE },
  56
  57     LAST_ITEM_IN_LIST
  58 }; /* button_context_standard */
  59 static const struct button_mapping button_context_tree[]  = {
  60     { ACTION_TREE_WPS,          BUTTON_PLAY|BUTTON_REL,      BUTTON_PLAY },
  61     { ACTION_TREE_STOP,         BUTTON_PLAY|BUTTON_REPEAT,   BUTTON_PLAY },
  62
  63     LAST_ITEM_IN_LIST__NEXTLIST(CONTEXT_STD)
  64 }; /* button_context_tree */
  65
  66 static const struct button_mapping button_context_tree_scroll_lr[]  = {
  67     { ACTION_NONE,              BUTTON_LEFT,                BUTTON_NONE },
  68     { ACTION_STD_CANCEL,        BUTTON_LEFT|BUTTON_REL,     BUTTON_LEFT },
  69     { ACTION_TREE_ROOT_INIT,    BUTTON_LEFT|BUTTON_REPEAT,  BUTTON_LEFT },
  70     { ACTION_TREE_PGLEFT,       BUTTON_LEFT|BUTTON_REPEAT,  BUTTON_NONE },
  71     { ACTION_TREE_PGLEFT,       BUTTON_LEFT|BUTTON_REL,     BUTTON_LEFT|BUTTON_REPEAT },
  72     { ACTION_NONE,              BUTTON_RIGHT,               BUTTON_NONE },
  73     { ACTION_STD_OK,            BUTTON_RIGHT|BUTTON_REL,    BUTTON_RIGHT },
  74     { ACTION_TREE_PGRIGHT,      BUTTON_RIGHT|BUTTON_REPEAT, BUTTON_NONE },
  75     { ACTION_TREE_PGRIGHT,      BUTTON_RIGHT|BUTTON_REL,    BUTTON_RIGHT|BUTTON_REPEAT },
  76     LAST_ITEM_IN_LIST__NEXTLIST(CONTEXT_CUSTOM|CONTEXT_TREE),
  77 };
  78
  79 static const struct button_mapping button_context_wps[]  = {
  80     { ACTION_WPS_PLAY,      BUTTON_PLAY|BUTTON_REL,         BUTTON_PLAY },
  81     { ACTION_WPS_STOP,      BUTTON_PLAY|BUTTON_REPEAT,      BUTTON_PLAY },
  82     { ACTION_WPS_SKIPPREV,  BUTTON_LEFT|BUTTON_REL,         BUTTON_LEFT },
  83     { ACTION_WPS_SEEKBACK,  BUTTON_LEFT|BUTTON_REPEAT,      BUTTON_NONE },
  84     { ACTION_WPS_STOPSEEK,  BUTTON_LEFT|BUTTON_REL,         BUTTON_LEFT|BUTTON_REPEAT },
  85     { ACTION_WPS_SKIPNEXT,  BUTTON_RIGHT|BUTTON_REL,        BUTTON_RIGHT },
  86     { ACTION_WPS_SEEKFWD,   BUTTON_RIGHT|BUTTON_REPEAT,     BUTTON_NONE },
  87     { ACTION_WPS_STOPSEEK,  BUTTON_RIGHT|BUTTON_REL,        BUTTON_RIGHT|BUTTON_REPEAT },
  88     { ACTION_WPS_VOLDOWN,   BUTTON_SCROLL_BACK,                 BUTTON_NONE },
  89     { ACTION_WPS_VOLDOWN,   BUTTON_SCROLL_BACK|BUTTON_REPEAT,   BUTTON_NONE },
  90     { ACTION_WPS_VOLUP,     BUTTON_SCROLL_FWD,                  BUTTON_NONE },
  91     { ACTION_WPS_VOLUP,     BUTTON_SCROLL_FWD|BUTTON_REPEAT,    BUTTON_NONE },
  92     { ACTION_WPS_BROWSE,    BUTTON_SELECT|BUTTON_REL,           BUTTON_SELECT },
  93     { ACTION_WPS_CONTEXT,   BUTTON_SELECT|BUTTON_REPEAT,        BUTTON_SELECT },
  94     { ACTION_WPS_MENU,          BUTTON_MENU|BUTTON_REL,         BUTTON_MENU },
  95     { ACTION_WPS_QUICKSCREEN,   BUTTON_MENU|BUTTON_REPEAT,      BUTTON_MENU },
  96
  97     LAST_ITEM_IN_LIST,
  98 }; /* button_context_wps */
  99
 100 static const struct button_mapping button_context_settings[]  = {
 101     { ACTION_SETTINGS_INC,          BUTTON_SCROLL_FWD,         BUTTON_NONE },
 102     { ACTION_SETTINGS_INCREPEAT,    BUTTON_SCROLL_FWD|BUTTON_REPEAT,  BUTTON_NONE },
 103     { ACTION_SETTINGS_DEC,          BUTTON_SCROLL_BACK,          BUTTON_NONE },
 104     { ACTION_SETTINGS_DECREPEAT,    BUTTON_SCROLL_BACK|BUTTON_REPEAT,  BUTTON_NONE },
 105     { ACTION_STD_PREV,              BUTTON_LEFT,                  BUTTON_NONE },
 106     { ACTION_STD_PREVREPEAT,        BUTTON_LEFT|BUTTON_REPEAT,    BUTTON_NONE },
 107     { ACTION_STD_NEXT,              BUTTON_RIGHT,                BUTTON_NONE },
 108     { ACTION_STD_NEXTREPEAT,        BUTTON_RIGHT|BUTTON_REPEAT,  BUTTON_NONE },
 109     { ACTION_STD_OK,                BUTTON_SELECT|BUTTON_REL,    BUTTON_NONE },
 110     { ACTION_STD_CANCEL,            BUTTON_MENU|BUTTON_REL,      BUTTON_MENU },
 111
 112     LAST_ITEM_IN_LIST__NEXTLIST(CONTEXT_STD)
 113 }; /* button_context_settings */
 114
 115 static const struct button_mapping button_context_yesno[]  = {
 116     { ACTION_YESNO_ACCEPT,          BUTTON_SELECT,                  BUTTON_NONE },
 117     LAST_ITEM_IN_LIST
 118 }; /* button_context_settings_yesno */
 119
 120 static const struct button_mapping button_context_bmark[]  = {
 121     { ACTION_BMS_DELETE,          BUTTON_MENU|BUTTON_REPEAT,       BUTTON_MENU },
 122     LAST_ITEM_IN_LIST__NEXTLIST(CONTEXT_LIST),
 123 }; /* button_context_settings_bmark */
 124
 125 static const struct button_mapping button_context_quickscreen[]  = {
 126     { ACTION_QS_DOWN,       BUTTON_PLAY,                    BUTTON_NONE },
 127     { ACTION_QS_DOWN,       BUTTON_PLAY|BUTTON_REPEAT,      BUTTON_NONE },
 128     { ACTION_QS_LEFT,       BUTTON_LEFT,                    BUTTON_NONE },
 129     { ACTION_QS_LEFT,       BUTTON_LEFT|BUTTON_REPEAT,      BUTTON_NONE },
 130     { ACTION_QS_RIGHT,      BUTTON_RIGHT,                   BUTTON_NONE },
 131     { ACTION_QS_RIGHT,      BUTTON_RIGHT|BUTTON_REPEAT,     BUTTON_NONE },
 132     { ACTION_STD_CANCEL,    BUTTON_MENU,                    BUTTON_NONE },
 133
 134     LAST_ITEM_IN_LIST__NEXTLIST(CONTEXT_STD)
 135 }; /* button_context_quickscreen */
 136
 137 static const struct button_mapping button_context_pitchscreen[]  = {
 138     { ACTION_PS_INC_SMALL,      BUTTON_SCROLL_FWD,                BUTTON_NONE },
 139     { ACTION_PS_INC_BIG,        BUTTON_SCROLL_FWD|BUTTON_REPEAT,  BUTTON_NONE },
 140     { ACTION_PS_DEC_SMALL,      BUTTON_SCROLL_BACK,                BUTTON_NONE },
 141     { ACTION_PS_DEC_BIG,        BUTTON_SCROLL_BACK|BUTTON_REPEAT,  BUTTON_NONE },
 142     { ACTION_PS_NUDGE_LEFT,     BUTTON_LEFT,                BUTTON_NONE },
 143     { ACTION_PS_NUDGE_LEFTOFF,  BUTTON_LEFT|BUTTON_REL,     BUTTON_NONE },
 144     { ACTION_PS_NUDGE_RIGHT,    BUTTON_RIGHT,               BUTTON_NONE },
 145     { ACTION_PS_NUDGE_RIGHTOFF, BUTTON_RIGHT|BUTTON_REL,    BUTTON_NONE },
 146     { ACTION_PS_TOGGLE_MODE,    BUTTON_PLAY,                BUTTON_NONE },
 147     { ACTION_PS_RESET,          BUTTON_MENU,                BUTTON_NONE },
 148     { ACTION_PS_EXIT,           BUTTON_SELECT,              BUTTON_NONE },
 149
 150     LAST_ITEM_IN_LIST__NEXTLIST(CONTEXT_STD)
 151 }; /* button_context_pitchscreen */
 152
 153 static const struct button_mapping button_context_keyboard[]  = {
 154     { ACTION_KBD_LEFT,         BUTTON_LEFT,                           BUTTON_NONE },
 155     { ACTION_KBD_LEFT,         BUTTON_LEFT|BUTTON_REPEAT,             BUTTON_NONE },
 156     { ACTION_KBD_RIGHT,        BUTTON_RIGHT,                          BUTTON_NONE },
 157     { ACTION_KBD_RIGHT,        BUTTON_RIGHT|BUTTON_REPEAT,            BUTTON_NONE },
 158     { ACTION_KBD_SELECT,       BUTTON_SELECT,                         BUTTON_NONE },
 159     { ACTION_KBD_DONE,         BUTTON_PLAY,                           BUTTON_NONE },
 160     { ACTION_KBD_ABORT,        BUTTON_MENU|BUTTON_REL,                BUTTON_MENU },
 161     { ACTION_KBD_UP,           BUTTON_SCROLL_BACK,                    BUTTON_NONE },
 162     { ACTION_KBD_UP,           BUTTON_SCROLL_BACK|BUTTON_REPEAT,      BUTTON_NONE },
 163     { ACTION_KBD_DOWN,         BUTTON_SCROLL_FWD,                     BUTTON_NONE },
 164     { ACTION_KBD_DOWN,         BUTTON_SCROLL_FWD|BUTTON_REPEAT,       BUTTON_NONE },
 165     { ACTION_KBD_MORSE_INPUT,  BUTTON_MENU|BUTTON_REPEAT,             BUTTON_MENU },
 166     { ACTION_KBD_MORSE_SELECT, BUTTON_SELECT|BUTTON_REL,              BUTTON_NONE },
 167     LAST_ITEM_IN_LIST
 168 }; /* button_context_keyboard */
 169
 170 #ifdef HAVE_RECORDING
 171 const struct button_mapping button_context_recscreen[]  = {
 172
 173     { ACTION_REC_NEWFILE,        BUTTON_SELECT|BUTTON_REL,        BUTTON_SELECT },
 174     { ACTION_STD_MENU,           BUTTON_SELECT|BUTTON_REPEAT,     BUTTON_SELECT },
 175     { ACTION_REC_PAUSE,          BUTTON_PLAY|BUTTON_REL,            BUTTON_PLAY },
 176     { ACTION_STD_CANCEL,         BUTTON_PLAY|BUTTON_REPEAT,         BUTTON_NONE },
 177     { ACTION_STD_CANCEL,         BUTTON_MENU,                       BUTTON_NONE },
 178     { ACTION_STD_NEXT,           BUTTON_SCROLL_FWD,                 BUTTON_NONE },
 179     { ACTION_STD_NEXT,           BUTTON_SCROLL_FWD|BUTTON_REPEAT,   BUTTON_NONE },
 180     { ACTION_STD_PREV,           BUTTON_SCROLL_BACK,                BUTTON_NONE },
 181     { ACTION_STD_PREV,           BUTTON_SCROLL_BACK|BUTTON_REPEAT,  BUTTON_NONE },
 182     { ACTION_SETTINGS_INC,       BUTTON_RIGHT,                      BUTTON_NONE },
 183     { ACTION_SETTINGS_INCREPEAT, BUTTON_RIGHT|BUTTON_REPEAT,        BUTTON_NONE },
 184     { ACTION_SETTINGS_DEC,       BUTTON_LEFT,                       BUTTON_NONE },
 185     { ACTION_SETTINGS_DECREPEAT, BUTTON_LEFT|BUTTON_REPEAT,         BUTTON_NONE },
 186
 187     LAST_ITEM_IN_LIST
 188 }; /* button_context_recscreen */
 189 #endif
 190
 191 #ifdef HAVE_USBSTACK
 192 static const struct button_mapping button_context_usb_hid[] = {
 193     { ACTION_USB_HID_PLAY,     BUTTON_PLAY,                      BUTTON_NONE },
 194     { ACTION_USB_HID_STOP,     BUTTON_PLAY|BUTTON_REPEAT,        BUTTON_NONE },
 195     { ACTION_USB_HID_SKIPPREV, BUTTON_LEFT,                      BUTTON_NONE },
 196     { ACTION_USB_HID_SKIPNEXT, BUTTON_RIGHT,                     BUTTON_NONE },
 197     { ACTION_USB_HID_VOLUP,    BUTTON_SCROLL_FWD,                BUTTON_NONE },
 198     { ACTION_USB_HID_VOLUP,    BUTTON_SCROLL_FWD|BUTTON_REPEAT,  BUTTON_NONE },
 199     { ACTION_USB_HID_VOLDOWN,  BUTTON_SCROLL_BACK,               BUTTON_NONE },
 200     { ACTION_USB_HID_VOLDOWN,  BUTTON_SCROLL_BACK|BUTTON_REPEAT, BUTTON_NONE },
 201     { ACTION_USB_HID_MUTE,     BUTTON_SELECT,                    BUTTON_NONE },
 202     { ACTION_USB_HID_MENU,     BUTTON_MENU,                      BUTTON_NONE },
 203
 204     LAST_ITEM_IN_LIST
 205 }; /* button_context_usb_hid */
 206 #endif
 207
 208 #if BUTTON_REMOTE != 0
 209 /*****************************************************************************
 210  *    Remote control mappings
 211  *****************************************************************************/
 212
 213 static const struct button_mapping remote_button_context_standard[]  = {
 214     { ACTION_STD_PREV,      BUTTON_RC_LEFT,     BUTTON_NONE },
 215     { ACTION_STD_NEXT,      BUTTON_RC_RIGHT,    BUTTON_NONE },
 216     { ACTION_STD_CANCEL,    BUTTON_RC_STOP,     BUTTON_NONE },
 217     { ACTION_STD_OK,        BUTTON_RC_PLAY,     BUTTON_NONE },
 218
 219     LAST_ITEM_IN_LIST
 220 };
 221
 222 static const struct button_mapping remote_button_context_wps[]  = {
 223     { ACTION_WPS_VOLDOWN,   BUTTON_RC_VOL_DOWN,               BUTTON_NONE },
 224     { ACTION_WPS_VOLDOWN,   BUTTON_RC_VOL_DOWN|BUTTON_REPEAT, BUTTON_NONE },
 225     { ACTION_WPS_VOLUP,     BUTTON_RC_VOL_UP,                 BUTTON_NONE },
 226     { ACTION_WPS_VOLUP,     BUTTON_RC_VOL_UP|BUTTON_REPEAT,   BUTTON_NONE },
 227
 228     { ACTION_WPS_PLAY,      BUTTON_RC_PLAY|BUTTON_REL,    BUTTON_RC_PLAY },
 229     { ACTION_WPS_STOP,      BUTTON_RC_PLAY|BUTTON_REPEAT, BUTTON_NONE },
 230     { ACTION_WPS_SKIPNEXT,  BUTTON_RC_RIGHT|BUTTON_REL,   BUTTON_RC_RIGHT },
 231     { ACTION_WPS_SEEKFWD,   BUTTON_RC_RIGHT|BUTTON_REPEAT,BUTTON_NONE },
 232     { ACTION_WPS_STOPSEEK,  BUTTON_RC_RIGHT|BUTTON_REL,   BUTTON_RC_RIGHT|BUTTON_REPEAT },
 233     { ACTION_WPS_SKIPPREV,  BUTTON_RC_LEFT|BUTTON_REL,    BUTTON_RC_LEFT },
 234     { ACTION_WPS_SEEKBACK,  BUTTON_RC_LEFT|BUTTON_REPEAT, BUTTON_NONE },
 235     { ACTION_WPS_STOPSEEK,  BUTTON_RC_LEFT|BUTTON_REL,    BUTTON_RC_LEFT|BUTTON_REPEAT },
 236
 237     LAST_ITEM_IN_LIST__NEXTLIST(CONTEXT_STD)
 238 };
 239
 240 #ifdef HAVE_USBSTACK
 241 static const struct button_mapping remote_button_context_usb_hid[] = {
 242     { ACTION_USB_HID_PLAY,     BUTTON_RC_PLAY,                   BUTTON_NONE },
 243     { ACTION_USB_HID_STOP,     BUTTON_RC_PLAY|BUTTON_REPEAT,     BUTTON_NONE },
 244     { ACTION_USB_HID_SKIPPREV, BUTTON_RC_LEFT,                   BUTTON_NONE },
 245     { ACTION_USB_HID_SKIPNEXT, BUTTON_RC_RIGHT,                  BUTTON_NONE },
 246     { ACTION_USB_HID_VOLUP,    BUTTON_RC_VOL_UP,                 BUTTON_NONE },
 247     { ACTION_USB_HID_VOLUP,    BUTTON_RC_VOL_UP|BUTTON_REPEAT,   BUTTON_NONE },
 248     { ACTION_USB_HID_VOLDOWN,  BUTTON_RC_VOL_DOWN,               BUTTON_NONE },
 249     { ACTION_USB_HID_VOLDOWN,  BUTTON_RC_VOL_DOWN|BUTTON_REPEAT, BUTTON_NONE },
 250
 251     LAST_ITEM_IN_LIST
 252 }; /* remote_button_context_usb_hid */
 253 #endif
 254
 255 static const struct button_mapping* get_context_mapping_remote( int context )
 256 {
 257     context ^= CONTEXT_REMOTE;
 258
 259     switch (context)
 260     {
 261         case CONTEXT_WPS:
 262             return remote_button_context_wps;
 263 #ifdef HAVE_USBSTACK
 264         case CONTEXT_USB_HID:
 265             return remote_button_context_usb_hid;
 266 #endif
 267         default:
 268             return remote_button_context_standard;
 269     }
 270 }
 271 #endif /* BUTTON_REMOTE != 0 */
 272
 273 /* get_context_mapping returns a pointer to one of the above defined arrays depending on the context */
 274 const struct button_mapping* get_context_mapping(int context)
 275 {
 276 #if BUTTON_REMOTE != 0
 277     if (context&CONTEXT_REMOTE)
 278         return get_context_mapping_remote(context);
 279 #endif
 280
 281     switch (context)
 282     {
 283         case CONTEXT_STD:
 284             return button_context_standard;
 285         case CONTEXT_WPS:
 286             return button_context_wps;
 287
 288         case CONTEXT_TREE:
 289         case CONTEXT_MAINMENU:
 290             if (global_settings.hold_lr_for_scroll_in_list)
 291                 return button_context_tree_scroll_lr;
 292             /* else fall through to CUSTOM|CONTEXT_TREE */
 293         case CONTEXT_CUSTOM|CONTEXT_TREE:
 294             return button_context_tree;
 295
 296         case CONTEXT_LIST:
 297             return button_context_standard;
 298
 299         case CONTEXT_SETTINGS_EQ:
 300         case CONTEXT_SETTINGS_COLOURCHOOSER:
 301         case CONTEXT_SETTINGS_TIME:
 302         case CONTEXT_SETTINGS:
 303         case CONTEXT_SETTINGS_RECTRIGGER:
 304             return button_context_settings;
 305         case CONTEXT_YESNOSCREEN:
 306             return button_context_yesno;
 307         case CONTEXT_BOOKMARKSCREEN:
 308             return button_context_bmark;
 309         case CONTEXT_QUICKSCREEN:
 310             return button_context_quickscreen;
 311         case CONTEXT_PITCHSCREEN:
 312             return button_context_pitchscreen;
 313         case CONTEXT_KEYBOARD:
 314             return button_context_keyboard;
 315 #ifdef HAVE_RECORDING
 316         case CONTEXT_RECSCREEN:
 317             return button_context_recscreen;
 318 #endif
 319 #ifdef HAVE_USBSTACK
 320         case CONTEXT_USB_HID:
 321             return button_context_usb_hid;
 322 #endif
 323         default:
 324             return button_context_standard;
 325     }
 326     return button_context_standard;
 327 }