HdmiCecLocalDevice.java revision 2e8f1b6399089626b4f0249427626ba6e63a62ef
1/* 2 * Copyright (C) 2014 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package com.android.server.hdmi; 18 19import android.hardware.hdmi.HdmiDeviceInfo; 20import android.hardware.input.InputManager; 21import android.os.Handler; 22import android.os.Looper; 23import android.os.Message; 24import android.os.SystemClock; 25import android.util.Slog; 26import android.view.InputDevice; 27import android.view.KeyCharacterMap; 28import android.view.KeyEvent; 29 30import com.android.internal.annotations.GuardedBy; 31import com.android.internal.util.IndentingPrintWriter; 32import com.android.server.hdmi.HdmiAnnotations.ServiceThreadOnly; 33 34import java.util.ArrayList; 35import java.util.Collections; 36import java.util.Iterator; 37import java.util.LinkedList; 38import java.util.List; 39 40/** 41 * Class that models a logical CEC device hosted in this system. Handles initialization, 42 * CEC commands that call for actions customized per device type. 43 */ 44abstract class HdmiCecLocalDevice { 45 private static final String TAG = "HdmiCecLocalDevice"; 46 47 private static final int MSG_DISABLE_DEVICE_TIMEOUT = 1; 48 private static final int MSG_USER_CONTROL_RELEASE_TIMEOUT = 2; 49 // Timeout in millisecond for device clean up (5s). 50 // Normal actions timeout is 2s but some of them would have several sequence of timeout. 51 private static final int DEVICE_CLEANUP_TIMEOUT = 5000; 52 // Within the timer, a received <User Control Pressed> will start "Press and Hold" behavior. 53 // When it expires, we can assume <User Control Release> is received. 54 private static final int FOLLOWER_SAFETY_TIMEOUT = 550; 55 56 protected final HdmiControlService mService; 57 protected final int mDeviceType; 58 protected int mAddress; 59 protected int mPreferredAddress; 60 protected HdmiDeviceInfo mDeviceInfo; 61 protected int mLastKeycode = HdmiCecKeycode.UNSUPPORTED_KEYCODE; 62 protected int mLastKeyRepeatCount = 0; 63 64 static class ActiveSource { 65 int logicalAddress; 66 int physicalAddress; 67 68 public ActiveSource() { 69 invalidate(); 70 } 71 public ActiveSource(int logical, int physical) { 72 logicalAddress = logical; 73 physicalAddress = physical; 74 } 75 public static ActiveSource of(int logical, int physical) { 76 return new ActiveSource(logical, physical); 77 } 78 public boolean isValid() { 79 return HdmiUtils.isValidAddress(logicalAddress); 80 } 81 public void invalidate() { 82 logicalAddress = Constants.ADDR_INVALID; 83 physicalAddress = Constants.INVALID_PHYSICAL_ADDRESS; 84 } 85 public boolean equals(int logical, int physical) { 86 return logicalAddress == logical && physicalAddress == physical; 87 } 88 @Override 89 public boolean equals(Object obj) { 90 if (obj instanceof ActiveSource) { 91 ActiveSource that = (ActiveSource) obj; 92 return that.logicalAddress == logicalAddress && 93 that.physicalAddress == physicalAddress; 94 } 95 return false; 96 } 97 @Override 98 public int hashCode() { 99 return logicalAddress * 29 + physicalAddress; 100 } 101 @Override 102 public String toString() { 103 StringBuffer s = new StringBuffer(); 104 String logicalAddressString = (logicalAddress == Constants.ADDR_INVALID) 105 ? "invalid" : String.format("0x%02x", logicalAddress); 106 s.append("logical_address: ").append(logicalAddressString); 107 String physicalAddressString = (physicalAddress == Constants.INVALID_PHYSICAL_ADDRESS) 108 ? "invalid" : String.format("0x%04x", physicalAddress); 109 s.append(", physical_address: ").append(physicalAddressString); 110 return s.toString(); 111 } 112 } 113 // Logical address of the active source. 114 @GuardedBy("mLock") 115 protected final ActiveSource mActiveSource = new ActiveSource(); 116 117 // Active routing path. Physical address of the active source but not all the time, such as 118 // when the new active source does not claim itself to be one. Note that we don't keep 119 // the active port id (or active input) since it can be gotten by {@link #pathToPortId(int)}. 120 @GuardedBy("mLock") 121 private int mActiveRoutingPath; 122 123 protected final HdmiCecMessageCache mCecMessageCache = new HdmiCecMessageCache(); 124 protected final Object mLock; 125 126 // A collection of FeatureAction. 127 // Note that access to this collection should happen in service thread. 128 private final LinkedList<HdmiCecFeatureAction> mActions = new LinkedList<>(); 129 130 private final Handler mHandler = new Handler () { 131 @Override 132 public void handleMessage(Message msg) { 133 switch (msg.what) { 134 case MSG_DISABLE_DEVICE_TIMEOUT: 135 handleDisableDeviceTimeout(); 136 break; 137 case MSG_USER_CONTROL_RELEASE_TIMEOUT: 138 handleUserControlReleased(); 139 break; 140 } 141 } 142 }; 143 144 /** 145 * A callback interface to get notified when all pending action is cleared. 146 * It can be called when timeout happened. 147 */ 148 interface PendingActionClearedCallback { 149 void onCleared(HdmiCecLocalDevice device); 150 } 151 152 protected PendingActionClearedCallback mPendingActionClearedCallback; 153 154 protected HdmiCecLocalDevice(HdmiControlService service, int deviceType) { 155 mService = service; 156 mDeviceType = deviceType; 157 mAddress = Constants.ADDR_UNREGISTERED; 158 mLock = service.getServiceLock(); 159 } 160 161 // Factory method that returns HdmiCecLocalDevice of corresponding type. 162 static HdmiCecLocalDevice create(HdmiControlService service, int deviceType) { 163 switch (deviceType) { 164 case HdmiDeviceInfo.DEVICE_TV: 165 return new HdmiCecLocalDeviceTv(service); 166 case HdmiDeviceInfo.DEVICE_PLAYBACK: 167 return new HdmiCecLocalDevicePlayback(service); 168 default: 169 return null; 170 } 171 } 172 173 @ServiceThreadOnly 174 void init() { 175 assertRunOnServiceThread(); 176 mPreferredAddress = getPreferredAddress(); 177 } 178 179 /** 180 * Called once a logical address of the local device is allocated. 181 */ 182 protected abstract void onAddressAllocated(int logicalAddress, int reason); 183 184 /** 185 * Get the preferred logical address from system properties. 186 */ 187 protected abstract int getPreferredAddress(); 188 189 /** 190 * Set the preferred logical address to system properties. 191 */ 192 protected abstract void setPreferredAddress(int addr); 193 194 /** 195 * Dispatch incoming message. 196 * 197 * @param message incoming message 198 * @return true if consumed a message; otherwise, return false. 199 */ 200 @ServiceThreadOnly 201 boolean dispatchMessage(HdmiCecMessage message) { 202 assertRunOnServiceThread(); 203 int dest = message.getDestination(); 204 if (dest != mAddress && dest != Constants.ADDR_BROADCAST) { 205 return false; 206 } 207 // Cache incoming message. Note that it caches only white-listed one. 208 mCecMessageCache.cacheMessage(message); 209 return onMessage(message); 210 } 211 212 @ServiceThreadOnly 213 protected final boolean onMessage(HdmiCecMessage message) { 214 assertRunOnServiceThread(); 215 if (dispatchMessageToAction(message)) { 216 return true; 217 } 218 switch (message.getOpcode()) { 219 case Constants.MESSAGE_ACTIVE_SOURCE: 220 return handleActiveSource(message); 221 case Constants.MESSAGE_INACTIVE_SOURCE: 222 return handleInactiveSource(message); 223 case Constants.MESSAGE_REQUEST_ACTIVE_SOURCE: 224 return handleRequestActiveSource(message); 225 case Constants.MESSAGE_GET_MENU_LANGUAGE: 226 return handleGetMenuLanguage(message); 227 case Constants.MESSAGE_GIVE_PHYSICAL_ADDRESS: 228 return handleGivePhysicalAddress(); 229 case Constants.MESSAGE_GIVE_OSD_NAME: 230 return handleGiveOsdName(message); 231 case Constants.MESSAGE_GIVE_DEVICE_VENDOR_ID: 232 return handleGiveDeviceVendorId(); 233 case Constants.MESSAGE_GET_CEC_VERSION: 234 return handleGetCecVersion(message); 235 case Constants.MESSAGE_REPORT_PHYSICAL_ADDRESS: 236 return handleReportPhysicalAddress(message); 237 case Constants.MESSAGE_ROUTING_CHANGE: 238 return handleRoutingChange(message); 239 case Constants.MESSAGE_ROUTING_INFORMATION: 240 return handleRoutingInformation(message); 241 case Constants.MESSAGE_INITIATE_ARC: 242 return handleInitiateArc(message); 243 case Constants.MESSAGE_TERMINATE_ARC: 244 return handleTerminateArc(message); 245 case Constants.MESSAGE_SET_SYSTEM_AUDIO_MODE: 246 return handleSetSystemAudioMode(message); 247 case Constants.MESSAGE_SYSTEM_AUDIO_MODE_STATUS: 248 return handleSystemAudioModeStatus(message); 249 case Constants.MESSAGE_REPORT_AUDIO_STATUS: 250 return handleReportAudioStatus(message); 251 case Constants.MESSAGE_STANDBY: 252 return handleStandby(message); 253 case Constants.MESSAGE_TEXT_VIEW_ON: 254 return handleTextViewOn(message); 255 case Constants.MESSAGE_IMAGE_VIEW_ON: 256 return handleImageViewOn(message); 257 case Constants.MESSAGE_USER_CONTROL_PRESSED: 258 return handleUserControlPressed(message); 259 case Constants.MESSAGE_USER_CONTROL_RELEASED: 260 return handleUserControlReleased(); 261 case Constants.MESSAGE_SET_STREAM_PATH: 262 return handleSetStreamPath(message); 263 case Constants.MESSAGE_GIVE_DEVICE_POWER_STATUS: 264 return handleGiveDevicePowerStatus(message); 265 case Constants.MESSAGE_MENU_REQUEST: 266 return handleGiveDeviceMenuStatus(message); 267 case Constants.MESSAGE_VENDOR_COMMAND: 268 return handleVendorCommand(message); 269 case Constants.MESSAGE_VENDOR_COMMAND_WITH_ID: 270 return handleVendorCommandWithId(message); 271 case Constants.MESSAGE_SET_OSD_NAME: 272 return handleSetOsdName(message); 273 case Constants.MESSAGE_RECORD_TV_SCREEN: 274 return handleRecordTvScreen(message); 275 case Constants.MESSAGE_TIMER_CLEARED_STATUS: 276 return handleTimerClearedStatus(message); 277 default: 278 return false; 279 } 280 } 281 282 @ServiceThreadOnly 283 private boolean dispatchMessageToAction(HdmiCecMessage message) { 284 assertRunOnServiceThread(); 285 for (HdmiCecFeatureAction action : mActions) { 286 if (action.processCommand(message)) { 287 return true; 288 } 289 } 290 return false; 291 } 292 293 @ServiceThreadOnly 294 protected boolean handleGivePhysicalAddress() { 295 assertRunOnServiceThread(); 296 297 int physicalAddress = mService.getPhysicalAddress(); 298 HdmiCecMessage cecMessage = HdmiCecMessageBuilder.buildReportPhysicalAddressCommand( 299 mAddress, physicalAddress, mDeviceType); 300 mService.sendCecCommand(cecMessage); 301 return true; 302 } 303 304 @ServiceThreadOnly 305 protected boolean handleGiveDeviceVendorId() { 306 assertRunOnServiceThread(); 307 int vendorId = mService.getVendorId(); 308 HdmiCecMessage cecMessage = HdmiCecMessageBuilder.buildDeviceVendorIdCommand( 309 mAddress, vendorId); 310 mService.sendCecCommand(cecMessage); 311 return true; 312 } 313 314 @ServiceThreadOnly 315 protected boolean handleGetCecVersion(HdmiCecMessage message) { 316 assertRunOnServiceThread(); 317 int version = mService.getCecVersion(); 318 HdmiCecMessage cecMessage = HdmiCecMessageBuilder.buildCecVersion(message.getDestination(), 319 message.getSource(), version); 320 mService.sendCecCommand(cecMessage); 321 return true; 322 } 323 324 @ServiceThreadOnly 325 protected boolean handleActiveSource(HdmiCecMessage message) { 326 return false; 327 } 328 329 @ServiceThreadOnly 330 protected boolean handleInactiveSource(HdmiCecMessage message) { 331 return false; 332 } 333 334 @ServiceThreadOnly 335 protected boolean handleRequestActiveSource(HdmiCecMessage message) { 336 return false; 337 } 338 339 @ServiceThreadOnly 340 protected boolean handleGetMenuLanguage(HdmiCecMessage message) { 341 assertRunOnServiceThread(); 342 Slog.w(TAG, "Only TV can handle <Get Menu Language>:" + message.toString()); 343 // 'return false' will cause to reply with <Feature Abort>. 344 return false; 345 } 346 347 @ServiceThreadOnly 348 protected boolean handleGiveOsdName(HdmiCecMessage message) { 349 assertRunOnServiceThread(); 350 // Note that since this method is called after logical address allocation is done, 351 // mDeviceInfo should not be null. 352 HdmiCecMessage cecMessage = HdmiCecMessageBuilder.buildSetOsdNameCommand( 353 mAddress, message.getSource(), mDeviceInfo.getDisplayName()); 354 if (cecMessage != null) { 355 mService.sendCecCommand(cecMessage); 356 } else { 357 Slog.w(TAG, "Failed to build <Get Osd Name>:" + mDeviceInfo.getDisplayName()); 358 } 359 return true; 360 } 361 362 protected boolean handleRoutingChange(HdmiCecMessage message) { 363 return false; 364 } 365 366 protected boolean handleRoutingInformation(HdmiCecMessage message) { 367 return false; 368 } 369 370 protected boolean handleReportPhysicalAddress(HdmiCecMessage message) { 371 return false; 372 } 373 374 protected boolean handleSystemAudioModeStatus(HdmiCecMessage message) { 375 return false; 376 } 377 378 protected boolean handleSetSystemAudioMode(HdmiCecMessage message) { 379 return false; 380 } 381 382 protected boolean handleTerminateArc(HdmiCecMessage message) { 383 return false; 384 } 385 386 protected boolean handleInitiateArc(HdmiCecMessage message) { 387 return false; 388 } 389 390 protected boolean handleReportAudioStatus(HdmiCecMessage message) { 391 return false; 392 } 393 394 @ServiceThreadOnly 395 protected boolean handleStandby(HdmiCecMessage message) { 396 assertRunOnServiceThread(); 397 // Seq #12 398 if (mService.isControlEnabled() && !mService.isProhibitMode() 399 && mService.isPowerOnOrTransient()) { 400 mService.standby(); 401 return true; 402 } 403 return false; 404 } 405 406 @ServiceThreadOnly 407 protected boolean handleUserControlPressed(HdmiCecMessage message) { 408 assertRunOnServiceThread(); 409 mHandler.removeMessages(MSG_USER_CONTROL_RELEASE_TIMEOUT); 410 if (mService.isPowerOnOrTransient() && isPowerOffOrToggleCommand(message)) { 411 mService.standby(); 412 return true; 413 } else if (mService.isPowerStandbyOrTransient() && isPowerOnOrToggleCommand(message)) { 414 mService.wakeUp(); 415 return true; 416 } 417 418 final long downTime = SystemClock.uptimeMillis(); 419 final byte[] params = message.getParams(); 420 // Note that we don't support parameterized keycode now. 421 // TODO: translate parameterized keycode as well. 422 final int keycode = HdmiCecKeycode.cecKeyToAndroidKey(params[0]); 423 int keyRepeatCount = 0; 424 if (mLastKeycode != HdmiCecKeycode.UNSUPPORTED_KEYCODE) { 425 if (keycode == mLastKeycode) { 426 keyRepeatCount = mLastKeyRepeatCount + 1; 427 } else { 428 injectKeyEvent(downTime, KeyEvent.ACTION_UP, mLastKeycode, 0); 429 } 430 } 431 mLastKeycode = keycode; 432 mLastKeyRepeatCount = keyRepeatCount; 433 434 if (keycode != HdmiCecKeycode.UNSUPPORTED_KEYCODE) { 435 injectKeyEvent(downTime, KeyEvent.ACTION_DOWN, keycode, keyRepeatCount); 436 mHandler.sendMessageDelayed(Message.obtain(mHandler, MSG_USER_CONTROL_RELEASE_TIMEOUT), 437 FOLLOWER_SAFETY_TIMEOUT); 438 return true; 439 } 440 return false; 441 } 442 443 @ServiceThreadOnly 444 protected boolean handleUserControlReleased() { 445 assertRunOnServiceThread(); 446 mHandler.removeMessages(MSG_USER_CONTROL_RELEASE_TIMEOUT); 447 mLastKeyRepeatCount = 0; 448 if (mLastKeycode != HdmiCecKeycode.UNSUPPORTED_KEYCODE) { 449 final long upTime = SystemClock.uptimeMillis(); 450 injectKeyEvent(upTime, KeyEvent.ACTION_UP, mLastKeycode, 0); 451 mLastKeycode = HdmiCecKeycode.UNSUPPORTED_KEYCODE; 452 return true; 453 } 454 return false; 455 } 456 457 static void injectKeyEvent(long time, int action, int keycode, int repeat) { 458 KeyEvent keyEvent = KeyEvent.obtain(time, time, action, keycode, 459 repeat, 0, KeyCharacterMap.VIRTUAL_KEYBOARD, 0, KeyEvent.FLAG_FROM_SYSTEM, 460 InputDevice.SOURCE_HDMI, null); 461 InputManager.getInstance().injectInputEvent(keyEvent, 462 InputManager.INJECT_INPUT_EVENT_MODE_ASYNC); 463 keyEvent.recycle(); 464 } 465 466 static boolean isPowerOnOrToggleCommand(HdmiCecMessage message) { 467 byte[] params = message.getParams(); 468 return message.getOpcode() == Constants.MESSAGE_USER_CONTROL_PRESSED 469 && (params[0] == HdmiCecKeycode.CEC_KEYCODE_POWER 470 || params[0] == HdmiCecKeycode.CEC_KEYCODE_POWER_ON_FUNCTION 471 || params[0] == HdmiCecKeycode.CEC_KEYCODE_POWER_TOGGLE_FUNCTION); 472 } 473 474 static boolean isPowerOffOrToggleCommand(HdmiCecMessage message) { 475 byte[] params = message.getParams(); 476 return message.getOpcode() == Constants.MESSAGE_USER_CONTROL_PRESSED 477 && (params[0] == HdmiCecKeycode.CEC_KEYCODE_POWER 478 || params[0] == HdmiCecKeycode.CEC_KEYCODE_POWER_OFF_FUNCTION 479 || params[0] == HdmiCecKeycode.CEC_KEYCODE_POWER_TOGGLE_FUNCTION); 480 } 481 482 protected boolean handleTextViewOn(HdmiCecMessage message) { 483 return false; 484 } 485 486 protected boolean handleImageViewOn(HdmiCecMessage message) { 487 return false; 488 } 489 490 protected boolean handleSetStreamPath(HdmiCecMessage message) { 491 return false; 492 } 493 494 protected boolean handleGiveDevicePowerStatus(HdmiCecMessage message) { 495 mService.sendCecCommand(HdmiCecMessageBuilder.buildReportPowerStatus( 496 mAddress, message.getSource(), mService.getPowerStatus())); 497 return true; 498 } 499 500 protected boolean handleGiveDeviceMenuStatus(HdmiCecMessage message) { 501 // Always report menu active to receive Remote Control. 502 mService.sendCecCommand(HdmiCecMessageBuilder.buildReportMenuStatus( 503 mAddress, message.getSource(), Constants.MENU_STATE_ACTIVATED)); 504 return true; 505 } 506 507 protected boolean handleVendorCommand(HdmiCecMessage message) { 508 mService.invokeVendorCommandListeners(mDeviceType, message.getSource(), 509 message.getParams(), false); 510 return true; 511 } 512 513 protected boolean handleVendorCommandWithId(HdmiCecMessage message) { 514 byte[] params = message.getParams(); 515 int vendorId = HdmiUtils.threeBytesToInt(params); 516 if (vendorId == mService.getVendorId()) { 517 mService.invokeVendorCommandListeners(mDeviceType, message.getSource(), params, true); 518 } else if (message.getDestination() != Constants.ADDR_BROADCAST && 519 message.getSource() != Constants.ADDR_UNREGISTERED) { 520 Slog.v(TAG, "Wrong direct vendor command. Replying with <Feature Abort>"); 521 mService.maySendFeatureAbortCommand(message, Constants.ABORT_UNRECOGNIZED_OPCODE); 522 } else { 523 Slog.v(TAG, "Wrong broadcast vendor command. Ignoring"); 524 } 525 return true; 526 } 527 528 protected boolean handleSetOsdName(HdmiCecMessage message) { 529 // The default behavior of <Set Osd Name> is doing nothing. 530 return true; 531 } 532 533 protected boolean handleRecordTvScreen(HdmiCecMessage message) { 534 // The default behavior of <Record TV Screen> is replying <Feature Abort> with 535 // "Cannot provide source". 536 mService.maySendFeatureAbortCommand(message, Constants.ABORT_CANNOT_PROVIDE_SOURCE); 537 return true; 538 } 539 540 protected boolean handleTimerClearedStatus(HdmiCecMessage message) { 541 return false; 542 } 543 544 @ServiceThreadOnly 545 final void handleAddressAllocated(int logicalAddress, int reason) { 546 assertRunOnServiceThread(); 547 mAddress = mPreferredAddress = logicalAddress; 548 onAddressAllocated(logicalAddress, reason); 549 setPreferredAddress(logicalAddress); 550 } 551 552 int getType() { 553 return mDeviceType; 554 } 555 556 @ServiceThreadOnly 557 HdmiDeviceInfo getDeviceInfo() { 558 assertRunOnServiceThread(); 559 return mDeviceInfo; 560 } 561 562 @ServiceThreadOnly 563 void setDeviceInfo(HdmiDeviceInfo info) { 564 assertRunOnServiceThread(); 565 mDeviceInfo = info; 566 } 567 568 // Returns true if the logical address is same as the argument. 569 @ServiceThreadOnly 570 boolean isAddressOf(int addr) { 571 assertRunOnServiceThread(); 572 return addr == mAddress; 573 } 574 575 // Resets the logical address to unregistered(15), meaning the logical device is invalid. 576 @ServiceThreadOnly 577 void clearAddress() { 578 assertRunOnServiceThread(); 579 mAddress = Constants.ADDR_UNREGISTERED; 580 } 581 582 @ServiceThreadOnly 583 void addAndStartAction(final HdmiCecFeatureAction action) { 584 assertRunOnServiceThread(); 585 if (mService.isPowerStandbyOrTransient()) { 586 Slog.w(TAG, "Skip the action during Standby: " + action); 587 return; 588 } 589 mActions.add(action); 590 action.start(); 591 } 592 593 // See if we have an action of a given type in progress. 594 @ServiceThreadOnly 595 <T extends HdmiCecFeatureAction> boolean hasAction(final Class<T> clazz) { 596 assertRunOnServiceThread(); 597 for (HdmiCecFeatureAction action : mActions) { 598 if (action.getClass().equals(clazz)) { 599 return true; 600 } 601 } 602 return false; 603 } 604 605 // Returns all actions matched with given class type. 606 @ServiceThreadOnly 607 <T extends HdmiCecFeatureAction> List<T> getActions(final Class<T> clazz) { 608 assertRunOnServiceThread(); 609 List<T> actions = Collections.<T>emptyList(); 610 for (HdmiCecFeatureAction action : mActions) { 611 if (action.getClass().equals(clazz)) { 612 if (actions.isEmpty()) { 613 actions = new ArrayList<T>(); 614 } 615 actions.add((T) action); 616 } 617 } 618 return actions; 619 } 620 621 /** 622 * Remove the given {@link HdmiCecFeatureAction} object from the action queue. 623 * 624 * @param action {@link HdmiCecFeatureAction} to remove 625 */ 626 @ServiceThreadOnly 627 void removeAction(final HdmiCecFeatureAction action) { 628 assertRunOnServiceThread(); 629 action.finish(false); 630 mActions.remove(action); 631 checkIfPendingActionsCleared(); 632 } 633 634 // Remove all actions matched with the given Class type. 635 @ServiceThreadOnly 636 <T extends HdmiCecFeatureAction> void removeAction(final Class<T> clazz) { 637 assertRunOnServiceThread(); 638 removeActionExcept(clazz, null); 639 } 640 641 // Remove all actions matched with the given Class type besides |exception|. 642 @ServiceThreadOnly 643 <T extends HdmiCecFeatureAction> void removeActionExcept(final Class<T> clazz, 644 final HdmiCecFeatureAction exception) { 645 assertRunOnServiceThread(); 646 Iterator<HdmiCecFeatureAction> iter = mActions.iterator(); 647 while (iter.hasNext()) { 648 HdmiCecFeatureAction action = iter.next(); 649 if (action != exception && action.getClass().equals(clazz)) { 650 action.finish(false); 651 iter.remove(); 652 } 653 } 654 checkIfPendingActionsCleared(); 655 } 656 657 protected void checkIfPendingActionsCleared() { 658 if (mActions.isEmpty() && mPendingActionClearedCallback != null) { 659 PendingActionClearedCallback callback = mPendingActionClearedCallback; 660 // To prevent from calling the callback again during handling the callback itself. 661 mPendingActionClearedCallback = null; 662 callback.onCleared(this); 663 } 664 } 665 666 protected void assertRunOnServiceThread() { 667 if (Looper.myLooper() != mService.getServiceLooper()) { 668 throw new IllegalStateException("Should run on service thread."); 669 } 670 } 671 672 /** 673 * Called when a hot-plug event issued. 674 * 675 * @param portId id of port where a hot-plug event happened 676 * @param connected whether to connected or not on the event 677 */ 678 void onHotplug(int portId, boolean connected) { 679 } 680 681 final HdmiControlService getService() { 682 return mService; 683 } 684 685 @ServiceThreadOnly 686 final boolean isConnectedToArcPort(int path) { 687 assertRunOnServiceThread(); 688 return mService.isConnectedToArcPort(path); 689 } 690 691 ActiveSource getActiveSource() { 692 synchronized (mLock) { 693 return mActiveSource; 694 } 695 } 696 697 void setActiveSource(ActiveSource newActive) { 698 setActiveSource(newActive.logicalAddress, newActive.physicalAddress); 699 } 700 701 void setActiveSource(HdmiDeviceInfo info) { 702 setActiveSource(info.getLogicalAddress(), info.getPhysicalAddress()); 703 } 704 705 void setActiveSource(int logicalAddress, int physicalAddress) { 706 synchronized (mLock) { 707 mActiveSource.logicalAddress = logicalAddress; 708 mActiveSource.physicalAddress = physicalAddress; 709 } 710 mService.setLastInputForMhl(Constants.INVALID_PORT_ID); 711 } 712 713 int getActivePath() { 714 synchronized (mLock) { 715 return mActiveRoutingPath; 716 } 717 } 718 719 void setActivePath(int path) { 720 synchronized (mLock) { 721 mActiveRoutingPath = path; 722 } 723 mService.setActivePortId(pathToPortId(path)); 724 } 725 726 /** 727 * Returns the ID of the active HDMI port. The active port is the one that has the active 728 * routing path connected to it directly or indirectly under the device hierarchy. 729 */ 730 int getActivePortId() { 731 synchronized (mLock) { 732 return mService.pathToPortId(mActiveRoutingPath); 733 } 734 } 735 736 /** 737 * Update the active port. 738 * 739 * @param portId the new active port id 740 */ 741 void setActivePortId(int portId) { 742 // We update active routing path instead, since we get the active port id from 743 // the active routing path. 744 setActivePath(mService.portIdToPath(portId)); 745 } 746 747 @ServiceThreadOnly 748 HdmiCecMessageCache getCecMessageCache() { 749 assertRunOnServiceThread(); 750 return mCecMessageCache; 751 } 752 753 @ServiceThreadOnly 754 int pathToPortId(int newPath) { 755 assertRunOnServiceThread(); 756 return mService.pathToPortId(newPath); 757 } 758 759 /** 760 * Called when the system goes to standby mode. 761 * 762 * @param initiatedByCec true if this power sequence is initiated 763 * by the reception the CEC messages like <Standby> 764 */ 765 protected void onStandby(boolean initiatedByCec) {} 766 767 /** 768 * Disable device. {@code callback} is used to get notified when all pending 769 * actions are completed or timeout is issued. 770 * 771 * @param initiatedByCec true if this sequence is initiated 772 * by the reception the CEC messages like <Standby> 773 * @param origialCallback callback interface to get notified when all pending actions are 774 * cleared 775 */ 776 protected void disableDevice(boolean initiatedByCec, 777 final PendingActionClearedCallback origialCallback) { 778 mPendingActionClearedCallback = new PendingActionClearedCallback() { 779 @Override 780 public void onCleared(HdmiCecLocalDevice device) { 781 mHandler.removeMessages(MSG_DISABLE_DEVICE_TIMEOUT); 782 origialCallback.onCleared(device); 783 } 784 }; 785 mHandler.sendMessageDelayed(Message.obtain(mHandler, MSG_DISABLE_DEVICE_TIMEOUT), 786 DEVICE_CLEANUP_TIMEOUT); 787 } 788 789 @ServiceThreadOnly 790 private void handleDisableDeviceTimeout() { 791 assertRunOnServiceThread(); 792 793 // If all actions are not cleared in DEVICE_CLEANUP_TIMEOUT, enforce to finish them. 794 // onCleard will be called at the last action's finish method. 795 Iterator<HdmiCecFeatureAction> iter = mActions.iterator(); 796 while (iter.hasNext()) { 797 HdmiCecFeatureAction action = iter.next(); 798 action.finish(false); 799 iter.remove(); 800 } 801 } 802 803 /** 804 * Send a key event to other device. 805 * 806 * @param keyCode key code defined in {@link android.view.KeyEvent} 807 * @param isPressed {@code true} for key down event 808 */ 809 protected void sendKeyEvent(int keyCode, boolean isPressed) { 810 Slog.w(TAG, "sendKeyEvent not implemented"); 811 } 812 813 void sendUserControlPressedAndReleased(int targetAddress, int cecKeycode) { 814 mService.sendCecCommand(HdmiCecMessageBuilder.buildUserControlPressed( 815 mAddress, targetAddress, cecKeycode)); 816 mService.sendCecCommand(HdmiCecMessageBuilder.buildUserControlReleased( 817 mAddress, targetAddress)); 818 } 819 820 /** 821 * Dump internal status of HdmiCecLocalDevice object. 822 */ 823 protected void dump(final IndentingPrintWriter pw) { 824 pw.println("mDeviceType: " + mDeviceType); 825 pw.println("mAddress: " + mAddress); 826 pw.println("mPreferredAddress: " + mPreferredAddress); 827 pw.println("mDeviceInfo: " + mDeviceInfo); 828 pw.println("mActiveSource: " + mActiveSource); 829 pw.println(String.format("mActiveRoutingPath: 0x%04x", mActiveRoutingPath)); 830 } 831} 832