WallpaperService.java revision 391ef42c92ab97e5c22a720973790696d30576ca
1/* 2 * Copyright (C) 2009 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 android.service.wallpaper; 18 19import com.android.internal.os.HandlerCaller; 20import com.android.internal.view.BaseIWindow; 21import com.android.internal.view.BaseInputHandler; 22import com.android.internal.view.BaseSurfaceHolder; 23 24import android.annotation.SdkConstant; 25import android.annotation.SdkConstant.SdkConstantType; 26import android.app.Service; 27import android.app.WallpaperManager; 28import android.content.BroadcastReceiver; 29import android.content.Context; 30import android.content.Intent; 31import android.content.IntentFilter; 32import android.content.res.Configuration; 33import android.graphics.PixelFormat; 34import android.graphics.Rect; 35import android.os.Bundle; 36import android.os.IBinder; 37import android.os.Looper; 38import android.os.Message; 39import android.os.RemoteException; 40import android.util.Log; 41import android.util.LogPrinter; 42import android.view.Gravity; 43import android.view.IWindowSession; 44import android.view.InputChannel; 45import android.view.InputDevice; 46import android.view.InputHandler; 47import android.view.InputQueue; 48import android.view.KeyEvent; 49import android.view.MotionEvent; 50import android.view.SurfaceHolder; 51import android.view.View; 52import android.view.ViewGroup; 53import android.view.ViewRoot; 54import android.view.WindowManager; 55import android.view.WindowManagerImpl; 56import android.view.WindowManagerPolicy; 57 58import java.util.ArrayList; 59 60/** 61 * A wallpaper service is responsible for showing a live wallpaper behind 62 * applications that would like to sit on top of it. This service object 63 * itself does very little -- its only purpose is to generate instances of 64 * {@link Engine} as needed. Implementing a wallpaper thus 65 * involves subclassing from this, subclassing an Engine implementation, 66 * and implementing {@link #onCreateEngine()} to return a new instance of 67 * your engine. 68 */ 69public abstract class WallpaperService extends Service { 70 /** 71 * The {@link Intent} that must be declared as handled by the service. 72 * To be supported, the service must also require the 73 * {@link android.Manifest.permission#BIND_WALLPAPER} permission so 74 * that other applications can not abuse it. 75 */ 76 @SdkConstant(SdkConstantType.SERVICE_ACTION) 77 public static final String SERVICE_INTERFACE = 78 "android.service.wallpaper.WallpaperService"; 79 80 /** 81 * Name under which a WallpaperService component publishes information 82 * about itself. This meta-data must reference an XML resource containing 83 * a <code><{@link android.R.styleable#Wallpaper wallpaper}></code> 84 * tag. 85 */ 86 public static final String SERVICE_META_DATA = "android.service.wallpaper"; 87 88 static final String TAG = "WallpaperService"; 89 static final boolean DEBUG = false; 90 91 private static final int DO_ATTACH = 10; 92 private static final int DO_DETACH = 20; 93 private static final int DO_SET_DESIRED_SIZE = 30; 94 95 private static final int MSG_UPDATE_SURFACE = 10000; 96 private static final int MSG_VISIBILITY_CHANGED = 10010; 97 private static final int MSG_WALLPAPER_OFFSETS = 10020; 98 private static final int MSG_WALLPAPER_COMMAND = 10025; 99 private static final int MSG_WINDOW_RESIZED = 10030; 100 private static final int MSG_TOUCH_EVENT = 10040; 101 102 private Looper mCallbackLooper; 103 private final ArrayList<Engine> mActiveEngines 104 = new ArrayList<Engine>(); 105 106 static final class WallpaperCommand { 107 String action; 108 int x; 109 int y; 110 int z; 111 Bundle extras; 112 boolean sync; 113 } 114 115 /** 116 * The actual implementation of a wallpaper. A wallpaper service may 117 * have multiple instances running (for example as a real wallpaper 118 * and as a preview), each of which is represented by its own Engine 119 * instance. You must implement {@link WallpaperService#onCreateEngine()} 120 * to return your concrete Engine implementation. 121 */ 122 public class Engine { 123 IWallpaperEngineWrapper mIWallpaperEngine; 124 125 // Copies from mIWallpaperEngine. 126 HandlerCaller mCaller; 127 IWallpaperConnection mConnection; 128 IBinder mWindowToken; 129 130 boolean mInitializing = true; 131 boolean mVisible; 132 boolean mScreenOn = true; 133 boolean mReportedVisible; 134 boolean mDestroyed; 135 136 // Current window state. 137 boolean mCreated; 138 boolean mSurfaceCreated; 139 boolean mIsCreating; 140 boolean mDrawingAllowed; 141 int mWidth; 142 int mHeight; 143 int mFormat; 144 int mType; 145 int mCurWidth; 146 int mCurHeight; 147 int mWindowFlags = WindowManager.LayoutParams.FLAG_NOT_TOUCHABLE; 148 int mCurWindowFlags = mWindowFlags; 149 final Rect mVisibleInsets = new Rect(); 150 final Rect mWinFrame = new Rect(); 151 final Rect mContentInsets = new Rect(); 152 final Configuration mConfiguration = new Configuration(); 153 154 final WindowManager.LayoutParams mLayout 155 = new WindowManager.LayoutParams(); 156 IWindowSession mSession; 157 InputChannel mInputChannel; 158 159 final Object mLock = new Object(); 160 boolean mOffsetMessageEnqueued; 161 float mPendingXOffset; 162 float mPendingYOffset; 163 float mPendingXOffsetStep; 164 float mPendingYOffsetStep; 165 boolean mPendingSync; 166 MotionEvent mPendingMove; 167 168 final BroadcastReceiver mReceiver = new BroadcastReceiver() { 169 @Override 170 public void onReceive(Context context, Intent intent) { 171 if (Intent.ACTION_SCREEN_ON.equals(intent.getAction())) { 172 mScreenOn = true; 173 reportVisibility(); 174 } else if (Intent.ACTION_SCREEN_OFF.equals(intent.getAction())) { 175 mScreenOn = false; 176 reportVisibility(); 177 } 178 } 179 }; 180 181 final BaseSurfaceHolder mSurfaceHolder = new BaseSurfaceHolder() { 182 { 183 mRequestedFormat = PixelFormat.RGB_565; 184 } 185 186 @Override 187 public boolean onAllowLockCanvas() { 188 return mDrawingAllowed; 189 } 190 191 @Override 192 public void onRelayoutContainer() { 193 Message msg = mCaller.obtainMessage(MSG_UPDATE_SURFACE); 194 mCaller.sendMessage(msg); 195 } 196 197 @Override 198 public void onUpdateSurface() { 199 Message msg = mCaller.obtainMessage(MSG_UPDATE_SURFACE); 200 mCaller.sendMessage(msg); 201 } 202 203 public boolean isCreating() { 204 return mIsCreating; 205 } 206 207 @Override 208 public void setFixedSize(int width, int height) { 209 throw new UnsupportedOperationException( 210 "Wallpapers currently only support sizing from layout"); 211 } 212 213 public void setKeepScreenOn(boolean screenOn) { 214 throw new UnsupportedOperationException( 215 "Wallpapers do not support keep screen on"); 216 } 217 218 }; 219 220 final InputHandler mInputHandler = new BaseInputHandler() { 221 @Override 222 public void handleMotion(MotionEvent event, 223 InputQueue.FinishedCallback finishedCallback) { 224 boolean handled = false; 225 try { 226 int source = event.getSource(); 227 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) { 228 dispatchPointer(event); 229 handled = true; 230 } 231 } finally { 232 finishedCallback.finished(handled); 233 } 234 } 235 }; 236 237 final BaseIWindow mWindow = new BaseIWindow() { 238 @Override 239 public void resized(int w, int h, Rect coveredInsets, 240 Rect visibleInsets, boolean reportDraw, Configuration newConfig) { 241 Message msg = mCaller.obtainMessageI(MSG_WINDOW_RESIZED, 242 reportDraw ? 1 : 0); 243 mCaller.sendMessage(msg); 244 } 245 246 @Override 247 public void dispatchAppVisibility(boolean visible) { 248 // We don't do this in preview mode; we'll let the preview 249 // activity tell us when to run. 250 if (!mIWallpaperEngine.mIsPreview) { 251 Message msg = mCaller.obtainMessageI(MSG_VISIBILITY_CHANGED, 252 visible ? 1 : 0); 253 mCaller.sendMessage(msg); 254 } 255 } 256 257 @Override 258 public void dispatchWallpaperOffsets(float x, float y, float xStep, float yStep, 259 boolean sync) { 260 synchronized (mLock) { 261 if (DEBUG) Log.v(TAG, "Dispatch wallpaper offsets: " + x + ", " + y); 262 mPendingXOffset = x; 263 mPendingYOffset = y; 264 mPendingXOffsetStep = xStep; 265 mPendingYOffsetStep = yStep; 266 if (sync) { 267 mPendingSync = true; 268 } 269 if (!mOffsetMessageEnqueued) { 270 mOffsetMessageEnqueued = true; 271 Message msg = mCaller.obtainMessage(MSG_WALLPAPER_OFFSETS); 272 mCaller.sendMessage(msg); 273 } 274 } 275 } 276 277 public void dispatchWallpaperCommand(String action, int x, int y, 278 int z, Bundle extras, boolean sync) { 279 synchronized (mLock) { 280 if (DEBUG) Log.v(TAG, "Dispatch wallpaper command: " + x + ", " + y); 281 WallpaperCommand cmd = new WallpaperCommand(); 282 cmd.action = action; 283 cmd.x = x; 284 cmd.y = y; 285 cmd.z = z; 286 cmd.extras = extras; 287 cmd.sync = sync; 288 Message msg = mCaller.obtainMessage(MSG_WALLPAPER_COMMAND); 289 msg.obj = cmd; 290 mCaller.sendMessage(msg); 291 } 292 } 293 }; 294 295 /** 296 * Provides access to the surface in which this wallpaper is drawn. 297 */ 298 public SurfaceHolder getSurfaceHolder() { 299 return mSurfaceHolder; 300 } 301 302 /** 303 * Convenience for {@link WallpaperManager#getDesiredMinimumWidth() 304 * WallpaperManager.getDesiredMinimumWidth()}, returning the width 305 * that the system would like this wallpaper to run in. 306 */ 307 public int getDesiredMinimumWidth() { 308 return mIWallpaperEngine.mReqWidth; 309 } 310 311 /** 312 * Convenience for {@link WallpaperManager#getDesiredMinimumHeight() 313 * WallpaperManager.getDesiredMinimumHeight()}, returning the height 314 * that the system would like this wallpaper to run in. 315 */ 316 public int getDesiredMinimumHeight() { 317 return mIWallpaperEngine.mReqHeight; 318 } 319 320 /** 321 * Return whether the wallpaper is currently visible to the user, 322 * this is the last value supplied to 323 * {@link #onVisibilityChanged(boolean)}. 324 */ 325 public boolean isVisible() { 326 return mReportedVisible; 327 } 328 329 /** 330 * Returns true if this engine is running in preview mode -- that is, 331 * it is being shown to the user before they select it as the actual 332 * wallpaper. 333 */ 334 public boolean isPreview() { 335 return mIWallpaperEngine.mIsPreview; 336 } 337 338 /** 339 * Control whether this wallpaper will receive raw touch events 340 * from the window manager as the user interacts with the window 341 * that is currently displaying the wallpaper. By default they 342 * are turned off. If enabled, the events will be received in 343 * {@link #onTouchEvent(MotionEvent)}. 344 */ 345 public void setTouchEventsEnabled(boolean enabled) { 346 mWindowFlags = enabled 347 ? (mWindowFlags&~WindowManager.LayoutParams.FLAG_NOT_TOUCHABLE) 348 : (mWindowFlags|WindowManager.LayoutParams.FLAG_NOT_TOUCHABLE); 349 if (mCreated) { 350 updateSurface(false, false, false); 351 } 352 } 353 354 /** 355 * Called once to initialize the engine. After returning, the 356 * engine's surface will be created by the framework. 357 */ 358 public void onCreate(SurfaceHolder surfaceHolder) { 359 } 360 361 /** 362 * Called right before the engine is going away. After this the 363 * surface will be destroyed and this Engine object is no longer 364 * valid. 365 */ 366 public void onDestroy() { 367 } 368 369 /** 370 * Called to inform you of the wallpaper becoming visible or 371 * hidden. <em>It is very important that a wallpaper only use 372 * CPU while it is visible.</em>. 373 */ 374 public void onVisibilityChanged(boolean visible) { 375 } 376 377 /** 378 * Called as the user performs touch-screen interaction with the 379 * window that is currently showing this wallpaper. Note that the 380 * events you receive here are driven by the actual application the 381 * user is interacting with, so if it is slow you will get fewer 382 * move events. 383 */ 384 public void onTouchEvent(MotionEvent event) { 385 } 386 387 /** 388 * Called to inform you of the wallpaper's offsets changing 389 * within its contain, corresponding to the container's 390 * call to {@link WallpaperManager#setWallpaperOffsets(IBinder, float, float) 391 * WallpaperManager.setWallpaperOffsets()}. 392 */ 393 public void onOffsetsChanged(float xOffset, float yOffset, 394 float xOffsetStep, float yOffsetStep, 395 int xPixelOffset, int yPixelOffset) { 396 } 397 398 /** 399 * Process a command that was sent to the wallpaper with 400 * {@link WallpaperManager#sendWallpaperCommand}. 401 * The default implementation does nothing, and always returns null 402 * as the result. 403 * 404 * @param action The name of the command to perform. This tells you 405 * what to do and how to interpret the rest of the arguments. 406 * @param x Generic integer parameter. 407 * @param y Generic integer parameter. 408 * @param z Generic integer parameter. 409 * @param extras Any additional parameters. 410 * @param resultRequested If true, the caller is requesting that 411 * a result, appropriate for the command, be returned back. 412 * @return If returning a result, create a Bundle and place the 413 * result data in to it. Otherwise return null. 414 */ 415 public Bundle onCommand(String action, int x, int y, int z, 416 Bundle extras, boolean resultRequested) { 417 return null; 418 } 419 420 /** 421 * Called when an application has changed the desired virtual size of 422 * the wallpaper. 423 */ 424 public void onDesiredSizeChanged(int desiredWidth, int desiredHeight) { 425 } 426 427 /** 428 * Convenience for {@link SurfaceHolder.Callback#surfaceChanged 429 * SurfaceHolder.Callback.surfaceChanged()}. 430 */ 431 public void onSurfaceChanged(SurfaceHolder holder, int format, int width, int height) { 432 } 433 434 /** 435 * Convenience for {@link SurfaceHolder.Callback2#surfaceRedrawNeeded 436 * SurfaceHolder.Callback.surfaceRedrawNeeded()}. 437 */ 438 public void onSurfaceRedrawNeeded(SurfaceHolder holder) { 439 } 440 441 /** 442 * Convenience for {@link SurfaceHolder.Callback#surfaceCreated 443 * SurfaceHolder.Callback.surfaceCreated()}. 444 */ 445 public void onSurfaceCreated(SurfaceHolder holder) { 446 } 447 448 /** 449 * Convenience for {@link SurfaceHolder.Callback#surfaceDestroyed 450 * SurfaceHolder.Callback.surfaceDestroyed()}. 451 */ 452 public void onSurfaceDestroyed(SurfaceHolder holder) { 453 } 454 455 private void dispatchPointer(MotionEvent event) { 456 synchronized (mLock) { 457 if (event.getAction() == MotionEvent.ACTION_MOVE) { 458 mPendingMove = event; 459 } else { 460 mPendingMove = null; 461 } 462 } 463 464 Message msg = mCaller.obtainMessageO(MSG_TOUCH_EVENT, event); 465 mCaller.sendMessage(msg); 466 } 467 468 void updateSurface(boolean forceRelayout, boolean forceReport, boolean redrawNeeded) { 469 if (mDestroyed) { 470 Log.w(TAG, "Ignoring updateSurface: destroyed"); 471 } 472 473 int myWidth = mSurfaceHolder.getRequestedWidth(); 474 if (myWidth <= 0) myWidth = ViewGroup.LayoutParams.MATCH_PARENT; 475 int myHeight = mSurfaceHolder.getRequestedHeight(); 476 if (myHeight <= 0) myHeight = ViewGroup.LayoutParams.MATCH_PARENT; 477 478 final boolean creating = !mCreated; 479 final boolean surfaceCreating = !mSurfaceCreated; 480 final boolean formatChanged = mFormat != mSurfaceHolder.getRequestedFormat(); 481 boolean sizeChanged = mWidth != myWidth || mHeight != myHeight; 482 final boolean typeChanged = mType != mSurfaceHolder.getRequestedType(); 483 final boolean flagsChanged = mCurWindowFlags != mWindowFlags; 484 if (forceRelayout || creating || surfaceCreating || formatChanged || sizeChanged 485 || typeChanged || flagsChanged || redrawNeeded) { 486 487 if (DEBUG) Log.v(TAG, "Changes: creating=" + creating 488 + " format=" + formatChanged + " size=" + sizeChanged); 489 490 try { 491 mWidth = myWidth; 492 mHeight = myHeight; 493 mFormat = mSurfaceHolder.getRequestedFormat(); 494 mType = mSurfaceHolder.getRequestedType(); 495 496 mLayout.x = 0; 497 mLayout.y = 0; 498 mLayout.width = myWidth; 499 mLayout.height = myHeight; 500 501 mLayout.format = mFormat; 502 503 mCurWindowFlags = mWindowFlags; 504 mLayout.flags = mWindowFlags 505 | WindowManager.LayoutParams.FLAG_LAYOUT_NO_LIMITS 506 | WindowManager.LayoutParams.FLAG_LAYOUT_IN_SCREEN 507 | WindowManager.LayoutParams.FLAG_NOT_FOCUSABLE 508 ; 509 510 mLayout.memoryType = mType; 511 mLayout.token = mWindowToken; 512 513 if (!mCreated) { 514 mLayout.type = mIWallpaperEngine.mWindowType; 515 mLayout.gravity = Gravity.LEFT|Gravity.TOP; 516 mLayout.setTitle(WallpaperService.this.getClass().getName()); 517 mLayout.windowAnimations = 518 com.android.internal.R.style.Animation_Wallpaper; 519 mInputChannel = new InputChannel(); 520 if (mSession.add(mWindow, mLayout, View.VISIBLE, mContentInsets, 521 mInputChannel) < 0) { 522 Log.w(TAG, "Failed to add window while updating wallpaper surface."); 523 return; 524 } 525 mCreated = true; 526 527 InputQueue.registerInputChannel(mInputChannel, mInputHandler, 528 Looper.myQueue()); 529 } 530 531 mSurfaceHolder.mSurfaceLock.lock(); 532 mDrawingAllowed = true; 533 534 final int relayoutResult = mSession.relayout( 535 mWindow, mLayout, mWidth, mHeight, 536 View.VISIBLE, false, mWinFrame, mContentInsets, 537 mVisibleInsets, mConfiguration, mSurfaceHolder.mSurface); 538 539 if (DEBUG) Log.v(TAG, "New surface: " + mSurfaceHolder.mSurface 540 + ", frame=" + mWinFrame); 541 542 int w = mWinFrame.width(); 543 if (mCurWidth != w) { 544 sizeChanged = true; 545 mCurWidth = w; 546 } 547 int h = mWinFrame.height(); 548 if (mCurHeight != h) { 549 sizeChanged = true; 550 mCurHeight = h; 551 } 552 553 mSurfaceHolder.setSurfaceFrameSize(w, h); 554 mSurfaceHolder.mSurfaceLock.unlock(); 555 556 if (!mSurfaceHolder.mSurface.isValid()) { 557 reportSurfaceDestroyed(); 558 if (DEBUG) Log.v(TAG, "Layout: Surface destroyed"); 559 return; 560 } 561 562 try { 563 mSurfaceHolder.ungetCallbacks(); 564 565 if (surfaceCreating) { 566 mIsCreating = true; 567 if (DEBUG) Log.v(TAG, "onSurfaceCreated(" 568 + mSurfaceHolder + "): " + this); 569 onSurfaceCreated(mSurfaceHolder); 570 SurfaceHolder.Callback callbacks[] = mSurfaceHolder.getCallbacks(); 571 if (callbacks != null) { 572 for (SurfaceHolder.Callback c : callbacks) { 573 c.surfaceCreated(mSurfaceHolder); 574 } 575 } 576 } 577 578 redrawNeeded |= creating 579 || (relayoutResult&WindowManagerImpl.RELAYOUT_FIRST_TIME) != 0; 580 581 if (forceReport || creating || surfaceCreating 582 || formatChanged || sizeChanged) { 583 if (DEBUG) { 584 RuntimeException e = new RuntimeException(); 585 e.fillInStackTrace(); 586 Log.w(TAG, "forceReport=" + forceReport + " creating=" + creating 587 + " formatChanged=" + formatChanged 588 + " sizeChanged=" + sizeChanged, e); 589 } 590 if (DEBUG) Log.v(TAG, "onSurfaceChanged(" 591 + mSurfaceHolder + ", " + mFormat 592 + ", " + mCurWidth + ", " + mCurHeight 593 + "): " + this); 594 onSurfaceChanged(mSurfaceHolder, mFormat, 595 mCurWidth, mCurHeight); 596 SurfaceHolder.Callback callbacks[] = mSurfaceHolder.getCallbacks(); 597 if (callbacks != null) { 598 for (SurfaceHolder.Callback c : callbacks) { 599 c.surfaceChanged(mSurfaceHolder, mFormat, 600 mCurWidth, mCurHeight); 601 } 602 } 603 } 604 605 if (redrawNeeded) { 606 onSurfaceRedrawNeeded(mSurfaceHolder); 607 SurfaceHolder.Callback callbacks[] = mSurfaceHolder.getCallbacks(); 608 if (callbacks != null) { 609 for (SurfaceHolder.Callback c : callbacks) { 610 if (c instanceof SurfaceHolder.Callback2) { 611 ((SurfaceHolder.Callback2)c).surfaceRedrawNeeded( 612 mSurfaceHolder); 613 } 614 } 615 } 616 } 617 618 } finally { 619 mIsCreating = false; 620 mSurfaceCreated = true; 621 if (redrawNeeded) { 622 mSession.finishDrawing(mWindow); 623 } 624 } 625 } catch (RemoteException ex) { 626 } 627 if (DEBUG) Log.v( 628 TAG, "Layout: x=" + mLayout.x + " y=" + mLayout.y + 629 " w=" + mLayout.width + " h=" + mLayout.height); 630 } 631 } 632 633 void attach(IWallpaperEngineWrapper wrapper) { 634 if (DEBUG) Log.v(TAG, "attach: " + this + " wrapper=" + wrapper); 635 if (mDestroyed) { 636 return; 637 } 638 639 mIWallpaperEngine = wrapper; 640 mCaller = wrapper.mCaller; 641 mConnection = wrapper.mConnection; 642 mWindowToken = wrapper.mWindowToken; 643 mSurfaceHolder.setSizeFromLayout(); 644 mInitializing = true; 645 mSession = ViewRoot.getWindowSession(getMainLooper()); 646 647 mWindow.setSession(mSession); 648 649 IntentFilter filter = new IntentFilter(); 650 filter.addAction(Intent.ACTION_SCREEN_ON); 651 filter.addAction(Intent.ACTION_SCREEN_OFF); 652 registerReceiver(mReceiver, filter); 653 654 if (DEBUG) Log.v(TAG, "onCreate(): " + this); 655 onCreate(mSurfaceHolder); 656 657 mInitializing = false; 658 updateSurface(false, false, false); 659 } 660 661 void doDesiredSizeChanged(int desiredWidth, int desiredHeight) { 662 if (!mDestroyed) { 663 if (DEBUG) Log.v(TAG, "onDesiredSizeChanged(" 664 + desiredWidth + "," + desiredHeight + "): " + this); 665 mIWallpaperEngine.mReqWidth = desiredWidth; 666 mIWallpaperEngine.mReqHeight = desiredHeight; 667 onDesiredSizeChanged(desiredWidth, desiredHeight); 668 doOffsetsChanged(); 669 } 670 } 671 672 void doVisibilityChanged(boolean visible) { 673 if (!mDestroyed) { 674 mVisible = visible; 675 reportVisibility(); 676 } 677 } 678 679 void reportVisibility() { 680 if (!mDestroyed) { 681 boolean visible = mVisible && mScreenOn; 682 if (mReportedVisible != visible) { 683 mReportedVisible = visible; 684 if (DEBUG) Log.v(TAG, "onVisibilityChanged(" + visible 685 + "): " + this); 686 if (visible) { 687 // If becoming visible, in preview mode the surface 688 // may have been destroyed so now we need to make 689 // sure it is re-created. 690 updateSurface(false, false, false); 691 } 692 onVisibilityChanged(visible); 693 } 694 } 695 } 696 697 void doOffsetsChanged() { 698 if (mDestroyed) { 699 return; 700 } 701 702 float xOffset; 703 float yOffset; 704 float xOffsetStep; 705 float yOffsetStep; 706 boolean sync; 707 synchronized (mLock) { 708 xOffset = mPendingXOffset; 709 yOffset = mPendingYOffset; 710 xOffsetStep = mPendingXOffsetStep; 711 yOffsetStep = mPendingYOffsetStep; 712 sync = mPendingSync; 713 mPendingSync = false; 714 mOffsetMessageEnqueued = false; 715 } 716 717 if (mSurfaceCreated) { 718 if (DEBUG) Log.v(TAG, "Offsets change in " + this 719 + ": " + xOffset + "," + yOffset); 720 final int availw = mIWallpaperEngine.mReqWidth-mCurWidth; 721 final int xPixels = availw > 0 ? -(int)(availw*xOffset+.5f) : 0; 722 final int availh = mIWallpaperEngine.mReqHeight-mCurHeight; 723 final int yPixels = availh > 0 ? -(int)(availh*yOffset+.5f) : 0; 724 onOffsetsChanged(xOffset, yOffset, xOffsetStep, yOffsetStep, xPixels, yPixels); 725 } 726 727 if (sync) { 728 try { 729 if (DEBUG) Log.v(TAG, "Reporting offsets change complete"); 730 mSession.wallpaperOffsetsComplete(mWindow.asBinder()); 731 } catch (RemoteException e) { 732 } 733 } 734 } 735 736 void doCommand(WallpaperCommand cmd) { 737 Bundle result; 738 if (!mDestroyed) { 739 result = onCommand(cmd.action, cmd.x, cmd.y, cmd.z, 740 cmd.extras, cmd.sync); 741 } else { 742 result = null; 743 } 744 if (cmd.sync) { 745 try { 746 if (DEBUG) Log.v(TAG, "Reporting command complete"); 747 mSession.wallpaperCommandComplete(mWindow.asBinder(), result); 748 } catch (RemoteException e) { 749 } 750 } 751 } 752 753 void reportSurfaceDestroyed() { 754 if (mSurfaceCreated) { 755 mSurfaceCreated = false; 756 mSurfaceHolder.ungetCallbacks(); 757 SurfaceHolder.Callback callbacks[] = mSurfaceHolder.getCallbacks(); 758 if (callbacks != null) { 759 for (SurfaceHolder.Callback c : callbacks) { 760 c.surfaceDestroyed(mSurfaceHolder); 761 } 762 } 763 if (DEBUG) Log.v(TAG, "onSurfaceDestroyed(" 764 + mSurfaceHolder + "): " + this); 765 onSurfaceDestroyed(mSurfaceHolder); 766 } 767 } 768 769 void detach() { 770 if (mDestroyed) { 771 return; 772 } 773 774 mDestroyed = true; 775 776 if (mVisible) { 777 mVisible = false; 778 if (DEBUG) Log.v(TAG, "onVisibilityChanged(false): " + this); 779 onVisibilityChanged(false); 780 } 781 782 reportSurfaceDestroyed(); 783 784 if (DEBUG) Log.v(TAG, "onDestroy(): " + this); 785 onDestroy(); 786 787 unregisterReceiver(mReceiver); 788 789 if (mCreated) { 790 try { 791 if (DEBUG) Log.v(TAG, "Removing window and destroying surface " 792 + mSurfaceHolder.getSurface() + " of: " + this); 793 794 if (mInputChannel != null) { 795 InputQueue.unregisterInputChannel(mInputChannel); 796 } 797 798 mSession.remove(mWindow); 799 } catch (RemoteException e) { 800 } 801 mSurfaceHolder.mSurface.release(); 802 mCreated = false; 803 804 // Dispose the input channel after removing the window so the Window Manager 805 // doesn't interpret the input channel being closed as an abnormal termination. 806 if (mInputChannel != null) { 807 mInputChannel.dispose(); 808 mInputChannel = null; 809 } 810 } 811 } 812 } 813 814 class IWallpaperEngineWrapper extends IWallpaperEngine.Stub 815 implements HandlerCaller.Callback { 816 private final HandlerCaller mCaller; 817 818 final IWallpaperConnection mConnection; 819 final IBinder mWindowToken; 820 final int mWindowType; 821 final boolean mIsPreview; 822 int mReqWidth; 823 int mReqHeight; 824 825 Engine mEngine; 826 827 IWallpaperEngineWrapper(WallpaperService context, 828 IWallpaperConnection conn, IBinder windowToken, 829 int windowType, boolean isPreview, int reqWidth, int reqHeight) { 830 if (DEBUG && mCallbackLooper != null) { 831 mCallbackLooper.setMessageLogging(new LogPrinter(Log.VERBOSE, TAG)); 832 } 833 mCaller = new HandlerCaller(context, 834 mCallbackLooper != null 835 ? mCallbackLooper : context.getMainLooper(), 836 this); 837 mConnection = conn; 838 mWindowToken = windowToken; 839 mWindowType = windowType; 840 mIsPreview = isPreview; 841 mReqWidth = reqWidth; 842 mReqHeight = reqHeight; 843 844 Message msg = mCaller.obtainMessage(DO_ATTACH); 845 mCaller.sendMessage(msg); 846 } 847 848 public void setDesiredSize(int width, int height) { 849 Message msg = mCaller.obtainMessageII(DO_SET_DESIRED_SIZE, width, height); 850 mCaller.sendMessage(msg); 851 } 852 853 public void setVisibility(boolean visible) { 854 Message msg = mCaller.obtainMessageI(MSG_VISIBILITY_CHANGED, 855 visible ? 1 : 0); 856 mCaller.sendMessage(msg); 857 } 858 859 public void dispatchPointer(MotionEvent event) { 860 if (mEngine != null) { 861 mEngine.dispatchPointer(event); 862 } 863 } 864 865 public void dispatchWallpaperCommand(String action, int x, int y, 866 int z, Bundle extras) { 867 if (mEngine != null) { 868 mEngine.mWindow.dispatchWallpaperCommand(action, x, y, z, extras, false); 869 } 870 } 871 872 public void destroy() { 873 Message msg = mCaller.obtainMessage(DO_DETACH); 874 mCaller.sendMessage(msg); 875 } 876 877 public void executeMessage(Message message) { 878 switch (message.what) { 879 case DO_ATTACH: { 880 try { 881 mConnection.attachEngine(this); 882 } catch (RemoteException e) { 883 Log.w(TAG, "Wallpaper host disappeared", e); 884 return; 885 } 886 Engine engine = onCreateEngine(); 887 mEngine = engine; 888 mActiveEngines.add(engine); 889 engine.attach(this); 890 return; 891 } 892 case DO_DETACH: { 893 mActiveEngines.remove(mEngine); 894 mEngine.detach(); 895 return; 896 } 897 case DO_SET_DESIRED_SIZE: { 898 mEngine.doDesiredSizeChanged(message.arg1, message.arg2); 899 return; 900 } 901 case MSG_UPDATE_SURFACE: 902 mEngine.updateSurface(true, false, false); 903 break; 904 case MSG_VISIBILITY_CHANGED: 905 if (DEBUG) Log.v(TAG, "Visibility change in " + mEngine 906 + ": " + message.arg1); 907 mEngine.doVisibilityChanged(message.arg1 != 0); 908 break; 909 case MSG_WALLPAPER_OFFSETS: { 910 mEngine.doOffsetsChanged(); 911 } break; 912 case MSG_WALLPAPER_COMMAND: { 913 WallpaperCommand cmd = (WallpaperCommand)message.obj; 914 mEngine.doCommand(cmd); 915 } break; 916 case MSG_WINDOW_RESIZED: { 917 final boolean reportDraw = message.arg1 != 0; 918 mEngine.updateSurface(true, false, reportDraw); 919 mEngine.doOffsetsChanged(); 920 } break; 921 case MSG_TOUCH_EVENT: { 922 boolean skip = false; 923 MotionEvent ev = (MotionEvent)message.obj; 924 if (ev.getAction() == MotionEvent.ACTION_MOVE) { 925 synchronized (mEngine.mLock) { 926 if (mEngine.mPendingMove == ev) { 927 mEngine.mPendingMove = null; 928 } else { 929 // this is not the motion event we are looking for.... 930 skip = true; 931 } 932 } 933 } 934 if (!skip) { 935 if (DEBUG) Log.v(TAG, "Delivering touch event: " + ev); 936 mEngine.onTouchEvent(ev); 937 } 938 ev.recycle(); 939 } break; 940 default : 941 Log.w(TAG, "Unknown message type " + message.what); 942 } 943 } 944 } 945 946 /** 947 * Implements the internal {@link IWallpaperService} interface to convert 948 * incoming calls to it back to calls on an {@link WallpaperService}. 949 */ 950 class IWallpaperServiceWrapper extends IWallpaperService.Stub { 951 private final WallpaperService mTarget; 952 953 public IWallpaperServiceWrapper(WallpaperService context) { 954 mTarget = context; 955 } 956 957 public void attach(IWallpaperConnection conn, IBinder windowToken, 958 int windowType, boolean isPreview, int reqWidth, int reqHeight) { 959 new IWallpaperEngineWrapper(mTarget, conn, windowToken, 960 windowType, isPreview, reqWidth, reqHeight); 961 } 962 } 963 964 @Override 965 public void onCreate() { 966 super.onCreate(); 967 } 968 969 @Override 970 public void onDestroy() { 971 super.onDestroy(); 972 for (int i=0; i<mActiveEngines.size(); i++) { 973 mActiveEngines.get(i).detach(); 974 } 975 mActiveEngines.clear(); 976 } 977 978 /** 979 * Implement to return the implementation of the internal accessibility 980 * service interface. Subclasses should not override. 981 */ 982 @Override 983 public final IBinder onBind(Intent intent) { 984 return new IWallpaperServiceWrapper(this); 985 } 986 987 /** 988 * This allows subclasses to change the thread that most callbacks 989 * occur on. Currently hidden because it is mostly needed for the 990 * image wallpaper (which runs in the system process and doesn't want 991 * to get stuck running on that seriously in use main thread). Not 992 * exposed right now because the semantics of this are not totally 993 * well defined and some callbacks can still happen on the main thread). 994 * @hide 995 */ 996 public void setCallbackLooper(Looper looper) { 997 mCallbackLooper = looper; 998 } 999 1000 /** 1001 * Must be implemented to return a new instance of the wallpaper's engine. 1002 * Note that multiple instances may be active at the same time, such as 1003 * when the wallpaper is currently set as the active wallpaper and the user 1004 * is in the wallpaper picker viewing a preview of it as well. 1005 */ 1006 public abstract Engine onCreateEngine(); 1007} 1008