WallpaperService.java revision b1ef36965bf17e791afd16a9a34bcbb32f495f68
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.BaseSurfaceHolder; 22 23import android.annotation.SdkConstant; 24import android.annotation.SdkConstant.SdkConstantType; 25import android.app.Service; 26import android.app.WallpaperManager; 27import android.content.BroadcastReceiver; 28import android.content.Context; 29import android.content.Intent; 30import android.content.IntentFilter; 31import android.content.res.Configuration; 32import android.graphics.PixelFormat; 33import android.graphics.Rect; 34import android.os.Bundle; 35import android.os.IBinder; 36import android.os.Looper; 37import android.os.Message; 38import android.os.PowerManager; 39import android.os.RemoteException; 40import android.util.Log; 41import android.util.LogPrinter; 42import android.view.Display; 43import android.view.Gravity; 44import android.view.IWindowSession; 45import android.view.InputChannel; 46import android.view.InputDevice; 47import android.view.InputEvent; 48import android.view.InputEventReceiver; 49import android.view.MotionEvent; 50import android.view.SurfaceHolder; 51import android.view.View; 52import android.view.ViewGroup; 53import android.view.WindowManager; 54import android.view.WindowManagerGlobal; 55 56import java.io.FileDescriptor; 57import java.io.PrintWriter; 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_WINDOW_MOVED = 10035; 101 private static final int MSG_TOUCH_EVENT = 10040; 102 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 boolean mOffsetsChanged; 142 boolean mFixedSizeAllowed; 143 int mWidth; 144 int mHeight; 145 int mFormat; 146 int mType; 147 int mCurWidth; 148 int mCurHeight; 149 int mWindowFlags = WindowManager.LayoutParams.FLAG_NOT_TOUCHABLE; 150 int mWindowPrivateFlags = 151 WindowManager.LayoutParams.PRIVATE_FLAG_WANTS_OFFSET_NOTIFICATIONS; 152 int mCurWindowFlags = mWindowFlags; 153 int mCurWindowPrivateFlags = mWindowPrivateFlags; 154 final Rect mVisibleInsets = new Rect(); 155 final Rect mWinFrame = new Rect(); 156 final Rect mContentInsets = new Rect(); 157 final Configuration mConfiguration = new Configuration(); 158 159 final WindowManager.LayoutParams mLayout 160 = new WindowManager.LayoutParams(); 161 IWindowSession mSession; 162 InputChannel mInputChannel; 163 164 final Object mLock = new Object(); 165 boolean mOffsetMessageEnqueued; 166 float mPendingXOffset; 167 float mPendingYOffset; 168 float mPendingXOffsetStep; 169 float mPendingYOffsetStep; 170 boolean mPendingSync; 171 MotionEvent mPendingMove; 172 173 final BroadcastReceiver mReceiver = new BroadcastReceiver() { 174 @Override 175 public void onReceive(Context context, Intent intent) { 176 if (Intent.ACTION_SCREEN_ON.equals(intent.getAction())) { 177 mScreenOn = true; 178 reportVisibility(); 179 } else if (Intent.ACTION_SCREEN_OFF.equals(intent.getAction())) { 180 mScreenOn = false; 181 reportVisibility(); 182 } 183 } 184 }; 185 186 final BaseSurfaceHolder mSurfaceHolder = new BaseSurfaceHolder() { 187 { 188 mRequestedFormat = PixelFormat.RGBX_8888; 189 } 190 191 @Override 192 public boolean onAllowLockCanvas() { 193 return mDrawingAllowed; 194 } 195 196 @Override 197 public void onRelayoutContainer() { 198 Message msg = mCaller.obtainMessage(MSG_UPDATE_SURFACE); 199 mCaller.sendMessage(msg); 200 } 201 202 @Override 203 public void onUpdateSurface() { 204 Message msg = mCaller.obtainMessage(MSG_UPDATE_SURFACE); 205 mCaller.sendMessage(msg); 206 } 207 208 public boolean isCreating() { 209 return mIsCreating; 210 } 211 212 @Override 213 public void setFixedSize(int width, int height) { 214 if (!mFixedSizeAllowed) { 215 // Regular apps can't do this. It can only work for 216 // certain designs of window animations, so you can't 217 // rely on it. 218 throw new UnsupportedOperationException( 219 "Wallpapers currently only support sizing from layout"); 220 } 221 super.setFixedSize(width, height); 222 } 223 224 public void setKeepScreenOn(boolean screenOn) { 225 throw new UnsupportedOperationException( 226 "Wallpapers do not support keep screen on"); 227 } 228 229 }; 230 231 final class WallpaperInputEventReceiver extends InputEventReceiver { 232 public WallpaperInputEventReceiver(InputChannel inputChannel, Looper looper) { 233 super(inputChannel, looper); 234 } 235 236 @Override 237 public void onInputEvent(InputEvent event) { 238 boolean handled = false; 239 try { 240 if (event instanceof MotionEvent 241 && (event.getSource() & InputDevice.SOURCE_CLASS_POINTER) != 0) { 242 MotionEvent dup = MotionEvent.obtainNoHistory((MotionEvent)event); 243 dispatchPointer(dup); 244 handled = true; 245 } 246 } finally { 247 finishInputEvent(event, handled); 248 } 249 } 250 } 251 WallpaperInputEventReceiver mInputEventReceiver; 252 253 final BaseIWindow mWindow = new BaseIWindow() { 254 @Override 255 public void resized(Rect frame, Rect contentInsets, 256 Rect visibleInsets, boolean reportDraw, Configuration newConfig) { 257 Message msg = mCaller.obtainMessageI(MSG_WINDOW_RESIZED, 258 reportDraw ? 1 : 0); 259 mCaller.sendMessage(msg); 260 } 261 262 @Override 263 public void moved(int newX, int newY) { 264 Message msg = mCaller.obtainMessageII(MSG_WINDOW_MOVED, newX, newY); 265 mCaller.sendMessage(msg); 266 } 267 268 @Override 269 public void dispatchAppVisibility(boolean visible) { 270 // We don't do this in preview mode; we'll let the preview 271 // activity tell us when to run. 272 if (!mIWallpaperEngine.mIsPreview) { 273 Message msg = mCaller.obtainMessageI(MSG_VISIBILITY_CHANGED, 274 visible ? 1 : 0); 275 mCaller.sendMessage(msg); 276 } 277 } 278 279 @Override 280 public void dispatchWallpaperOffsets(float x, float y, float xStep, float yStep, 281 boolean sync) { 282 synchronized (mLock) { 283 if (DEBUG) Log.v(TAG, "Dispatch wallpaper offsets: " + x + ", " + y); 284 mPendingXOffset = x; 285 mPendingYOffset = y; 286 mPendingXOffsetStep = xStep; 287 mPendingYOffsetStep = yStep; 288 if (sync) { 289 mPendingSync = true; 290 } 291 if (!mOffsetMessageEnqueued) { 292 mOffsetMessageEnqueued = true; 293 Message msg = mCaller.obtainMessage(MSG_WALLPAPER_OFFSETS); 294 mCaller.sendMessage(msg); 295 } 296 } 297 } 298 299 @Override 300 public void dispatchWallpaperCommand(String action, int x, int y, 301 int z, Bundle extras, boolean sync) { 302 synchronized (mLock) { 303 if (DEBUG) Log.v(TAG, "Dispatch wallpaper command: " + x + ", " + y); 304 WallpaperCommand cmd = new WallpaperCommand(); 305 cmd.action = action; 306 cmd.x = x; 307 cmd.y = y; 308 cmd.z = z; 309 cmd.extras = extras; 310 cmd.sync = sync; 311 Message msg = mCaller.obtainMessage(MSG_WALLPAPER_COMMAND); 312 msg.obj = cmd; 313 mCaller.sendMessage(msg); 314 } 315 } 316 }; 317 318 /** 319 * Provides access to the surface in which this wallpaper is drawn. 320 */ 321 public SurfaceHolder getSurfaceHolder() { 322 return mSurfaceHolder; 323 } 324 325 /** 326 * Convenience for {@link WallpaperManager#getDesiredMinimumWidth() 327 * WallpaperManager.getDesiredMinimumWidth()}, returning the width 328 * that the system would like this wallpaper to run in. 329 */ 330 public int getDesiredMinimumWidth() { 331 return mIWallpaperEngine.mReqWidth; 332 } 333 334 /** 335 * Convenience for {@link WallpaperManager#getDesiredMinimumHeight() 336 * WallpaperManager.getDesiredMinimumHeight()}, returning the height 337 * that the system would like this wallpaper to run in. 338 */ 339 public int getDesiredMinimumHeight() { 340 return mIWallpaperEngine.mReqHeight; 341 } 342 343 /** 344 * Return whether the wallpaper is currently visible to the user, 345 * this is the last value supplied to 346 * {@link #onVisibilityChanged(boolean)}. 347 */ 348 public boolean isVisible() { 349 return mReportedVisible; 350 } 351 352 /** 353 * Returns true if this engine is running in preview mode -- that is, 354 * it is being shown to the user before they select it as the actual 355 * wallpaper. 356 */ 357 public boolean isPreview() { 358 return mIWallpaperEngine.mIsPreview; 359 } 360 361 /** 362 * Control whether this wallpaper will receive raw touch events 363 * from the window manager as the user interacts with the window 364 * that is currently displaying the wallpaper. By default they 365 * are turned off. If enabled, the events will be received in 366 * {@link #onTouchEvent(MotionEvent)}. 367 */ 368 public void setTouchEventsEnabled(boolean enabled) { 369 mWindowFlags = enabled 370 ? (mWindowFlags&~WindowManager.LayoutParams.FLAG_NOT_TOUCHABLE) 371 : (mWindowFlags|WindowManager.LayoutParams.FLAG_NOT_TOUCHABLE); 372 if (mCreated) { 373 updateSurface(false, false, false); 374 } 375 } 376 377 /** 378 * Control whether this wallpaper will receive notifications when the wallpaper 379 * has been scrolled. By default, wallpapers will receive notifications, although 380 * the default static image wallpapers do not. It is a performance optimization to 381 * set this to false. 382 * 383 * @param enabled whether the wallpaper wants to receive offset notifications 384 */ 385 public void setOffsetNotificationsEnabled(boolean enabled) { 386 mWindowPrivateFlags = enabled 387 ? (mWindowPrivateFlags | 388 WindowManager.LayoutParams.PRIVATE_FLAG_WANTS_OFFSET_NOTIFICATIONS) 389 : (mWindowPrivateFlags & 390 ~WindowManager.LayoutParams.PRIVATE_FLAG_WANTS_OFFSET_NOTIFICATIONS); 391 if (mCreated) { 392 updateSurface(false, false, false); 393 } 394 } 395 396 /** {@hide} */ 397 public void setFixedSizeAllowed(boolean allowed) { 398 mFixedSizeAllowed = allowed; 399 } 400 401 /** 402 * Called once to initialize the engine. After returning, the 403 * engine's surface will be created by the framework. 404 */ 405 public void onCreate(SurfaceHolder surfaceHolder) { 406 } 407 408 /** 409 * Called right before the engine is going away. After this the 410 * surface will be destroyed and this Engine object is no longer 411 * valid. 412 */ 413 public void onDestroy() { 414 } 415 416 /** 417 * Called to inform you of the wallpaper becoming visible or 418 * hidden. <em>It is very important that a wallpaper only use 419 * CPU while it is visible.</em>. 420 */ 421 public void onVisibilityChanged(boolean visible) { 422 } 423 424 /** 425 * Called as the user performs touch-screen interaction with the 426 * window that is currently showing this wallpaper. Note that the 427 * events you receive here are driven by the actual application the 428 * user is interacting with, so if it is slow you will get fewer 429 * move events. 430 */ 431 public void onTouchEvent(MotionEvent event) { 432 } 433 434 /** 435 * Called to inform you of the wallpaper's offsets changing 436 * within its contain, corresponding to the container's 437 * call to {@link WallpaperManager#setWallpaperOffsets(IBinder, float, float) 438 * WallpaperManager.setWallpaperOffsets()}. 439 */ 440 public void onOffsetsChanged(float xOffset, float yOffset, 441 float xOffsetStep, float yOffsetStep, 442 int xPixelOffset, int yPixelOffset) { 443 } 444 445 /** 446 * Process a command that was sent to the wallpaper with 447 * {@link WallpaperManager#sendWallpaperCommand}. 448 * The default implementation does nothing, and always returns null 449 * as the result. 450 * 451 * @param action The name of the command to perform. This tells you 452 * what to do and how to interpret the rest of the arguments. 453 * @param x Generic integer parameter. 454 * @param y Generic integer parameter. 455 * @param z Generic integer parameter. 456 * @param extras Any additional parameters. 457 * @param resultRequested If true, the caller is requesting that 458 * a result, appropriate for the command, be returned back. 459 * @return If returning a result, create a Bundle and place the 460 * result data in to it. Otherwise return null. 461 */ 462 public Bundle onCommand(String action, int x, int y, int z, 463 Bundle extras, boolean resultRequested) { 464 return null; 465 } 466 467 /** 468 * Called when an application has changed the desired virtual size of 469 * the wallpaper. 470 */ 471 public void onDesiredSizeChanged(int desiredWidth, int desiredHeight) { 472 } 473 474 /** 475 * Convenience for {@link SurfaceHolder.Callback#surfaceChanged 476 * SurfaceHolder.Callback.surfaceChanged()}. 477 */ 478 public void onSurfaceChanged(SurfaceHolder holder, int format, int width, int height) { 479 } 480 481 /** 482 * Convenience for {@link SurfaceHolder.Callback2#surfaceRedrawNeeded 483 * SurfaceHolder.Callback.surfaceRedrawNeeded()}. 484 */ 485 public void onSurfaceRedrawNeeded(SurfaceHolder holder) { 486 } 487 488 /** 489 * Convenience for {@link SurfaceHolder.Callback#surfaceCreated 490 * SurfaceHolder.Callback.surfaceCreated()}. 491 */ 492 public void onSurfaceCreated(SurfaceHolder holder) { 493 } 494 495 /** 496 * Convenience for {@link SurfaceHolder.Callback#surfaceDestroyed 497 * SurfaceHolder.Callback.surfaceDestroyed()}. 498 */ 499 public void onSurfaceDestroyed(SurfaceHolder holder) { 500 } 501 502 protected void dump(String prefix, FileDescriptor fd, PrintWriter out, String[] args) { 503 out.print(prefix); out.print("mInitializing="); out.print(mInitializing); 504 out.print(" mDestroyed="); out.println(mDestroyed); 505 out.print(prefix); out.print("mVisible="); out.print(mVisible); 506 out.print(" mScreenOn="); out.print(mScreenOn); 507 out.print(" mReportedVisible="); out.println(mReportedVisible); 508 out.print(prefix); out.print("mCreated="); out.print(mCreated); 509 out.print(" mSurfaceCreated="); out.print(mSurfaceCreated); 510 out.print(" mIsCreating="); out.print(mIsCreating); 511 out.print(" mDrawingAllowed="); out.println(mDrawingAllowed); 512 out.print(prefix); out.print("mWidth="); out.print(mWidth); 513 out.print(" mCurWidth="); out.print(mCurWidth); 514 out.print(" mHeight="); out.print(mHeight); 515 out.print(" mCurHeight="); out.println(mCurHeight); 516 out.print(prefix); out.print("mType="); out.print(mType); 517 out.print(" mWindowFlags="); out.print(mWindowFlags); 518 out.print(" mCurWindowFlags="); out.println(mCurWindowFlags); 519 out.print(" mWindowPrivateFlags="); out.print(mWindowPrivateFlags); 520 out.print(" mCurWindowPrivateFlags="); out.println(mCurWindowPrivateFlags); 521 out.print(prefix); out.print("mVisibleInsets="); 522 out.print(mVisibleInsets.toShortString()); 523 out.print(" mWinFrame="); out.print(mWinFrame.toShortString()); 524 out.print(" mContentInsets="); out.println(mContentInsets.toShortString()); 525 out.print(prefix); out.print("mConfiguration="); out.println(mConfiguration); 526 out.print(prefix); out.print("mLayout="); out.println(mLayout); 527 synchronized (mLock) { 528 out.print(prefix); out.print("mPendingXOffset="); out.print(mPendingXOffset); 529 out.print(" mPendingXOffset="); out.println(mPendingXOffset); 530 out.print(prefix); out.print("mPendingXOffsetStep="); 531 out.print(mPendingXOffsetStep); 532 out.print(" mPendingXOffsetStep="); out.println(mPendingXOffsetStep); 533 out.print(prefix); out.print("mOffsetMessageEnqueued="); 534 out.print(mOffsetMessageEnqueued); 535 out.print(" mPendingSync="); out.println(mPendingSync); 536 if (mPendingMove != null) { 537 out.print(prefix); out.print("mPendingMove="); out.println(mPendingMove); 538 } 539 } 540 } 541 542 private void dispatchPointer(MotionEvent event) { 543 if (event.isTouchEvent()) { 544 synchronized (mLock) { 545 if (event.getAction() == MotionEvent.ACTION_MOVE) { 546 mPendingMove = event; 547 } else { 548 mPendingMove = null; 549 } 550 } 551 Message msg = mCaller.obtainMessageO(MSG_TOUCH_EVENT, event); 552 mCaller.sendMessage(msg); 553 } else { 554 event.recycle(); 555 } 556 } 557 558 void updateSurface(boolean forceRelayout, boolean forceReport, boolean redrawNeeded) { 559 if (mDestroyed) { 560 Log.w(TAG, "Ignoring updateSurface: destroyed"); 561 } 562 563 int myWidth = mSurfaceHolder.getRequestedWidth(); 564 if (myWidth <= 0) myWidth = ViewGroup.LayoutParams.MATCH_PARENT; 565 int myHeight = mSurfaceHolder.getRequestedHeight(); 566 if (myHeight <= 0) myHeight = ViewGroup.LayoutParams.MATCH_PARENT; 567 568 final boolean creating = !mCreated; 569 final boolean surfaceCreating = !mSurfaceCreated; 570 final boolean formatChanged = mFormat != mSurfaceHolder.getRequestedFormat(); 571 boolean sizeChanged = mWidth != myWidth || mHeight != myHeight; 572 final boolean typeChanged = mType != mSurfaceHolder.getRequestedType(); 573 final boolean flagsChanged = mCurWindowFlags != mWindowFlags || 574 mCurWindowPrivateFlags != mWindowPrivateFlags; 575 if (forceRelayout || creating || surfaceCreating || formatChanged || sizeChanged 576 || typeChanged || flagsChanged || redrawNeeded 577 || !mIWallpaperEngine.mShownReported) { 578 579 if (DEBUG) Log.v(TAG, "Changes: creating=" + creating 580 + " format=" + formatChanged + " size=" + sizeChanged); 581 582 try { 583 mWidth = myWidth; 584 mHeight = myHeight; 585 mFormat = mSurfaceHolder.getRequestedFormat(); 586 mType = mSurfaceHolder.getRequestedType(); 587 588 mLayout.x = 0; 589 mLayout.y = 0; 590 mLayout.width = myWidth; 591 mLayout.height = myHeight; 592 593 mLayout.format = mFormat; 594 595 mCurWindowFlags = mWindowFlags; 596 mLayout.flags = mWindowFlags 597 | WindowManager.LayoutParams.FLAG_LAYOUT_NO_LIMITS 598 | WindowManager.LayoutParams.FLAG_LAYOUT_IN_SCREEN 599 | WindowManager.LayoutParams.FLAG_NOT_FOCUSABLE 600 ; 601 mCurWindowPrivateFlags = mWindowPrivateFlags; 602 mLayout.privateFlags = mWindowPrivateFlags; 603 604 mLayout.memoryType = mType; 605 mLayout.token = mWindowToken; 606 607 if (!mCreated) { 608 mLayout.type = mIWallpaperEngine.mWindowType; 609 mLayout.gravity = Gravity.START|Gravity.TOP; 610 mLayout.setTitle(WallpaperService.this.getClass().getName()); 611 mLayout.windowAnimations = 612 com.android.internal.R.style.Animation_Wallpaper; 613 mInputChannel = new InputChannel(); 614 if (mSession.addToDisplay(mWindow, mWindow.mSeq, mLayout, View.VISIBLE, 615 Display.DEFAULT_DISPLAY, mContentInsets, mInputChannel) < 0) { 616 Log.w(TAG, "Failed to add window while updating wallpaper surface."); 617 return; 618 } 619 mCreated = true; 620 621 mInputEventReceiver = new WallpaperInputEventReceiver( 622 mInputChannel, Looper.myLooper()); 623 } 624 625 mSurfaceHolder.mSurfaceLock.lock(); 626 mDrawingAllowed = true; 627 628 final int relayoutResult = mSession.relayout( 629 mWindow, mWindow.mSeq, mLayout, mWidth, mHeight, 630 View.VISIBLE, 0, mWinFrame, mContentInsets, 631 mVisibleInsets, mConfiguration, mSurfaceHolder.mSurface); 632 633 if (DEBUG) Log.v(TAG, "New surface: " + mSurfaceHolder.mSurface 634 + ", frame=" + mWinFrame); 635 636 int w = mWinFrame.width(); 637 if (mCurWidth != w) { 638 sizeChanged = true; 639 mCurWidth = w; 640 } 641 int h = mWinFrame.height(); 642 if (mCurHeight != h) { 643 sizeChanged = true; 644 mCurHeight = h; 645 } 646 647 mSurfaceHolder.setSurfaceFrameSize(w, h); 648 mSurfaceHolder.mSurfaceLock.unlock(); 649 650 if (!mSurfaceHolder.mSurface.isValid()) { 651 reportSurfaceDestroyed(); 652 if (DEBUG) Log.v(TAG, "Layout: Surface destroyed"); 653 return; 654 } 655 656 boolean didSurface = false; 657 658 try { 659 mSurfaceHolder.ungetCallbacks(); 660 661 if (surfaceCreating) { 662 mIsCreating = true; 663 didSurface = true; 664 if (DEBUG) Log.v(TAG, "onSurfaceCreated(" 665 + mSurfaceHolder + "): " + this); 666 onSurfaceCreated(mSurfaceHolder); 667 SurfaceHolder.Callback callbacks[] = mSurfaceHolder.getCallbacks(); 668 if (callbacks != null) { 669 for (SurfaceHolder.Callback c : callbacks) { 670 c.surfaceCreated(mSurfaceHolder); 671 } 672 } 673 } 674 675 redrawNeeded |= creating || (relayoutResult 676 & WindowManagerGlobal.RELAYOUT_RES_FIRST_TIME) != 0; 677 678 if (forceReport || creating || surfaceCreating 679 || formatChanged || sizeChanged) { 680 if (DEBUG) { 681 RuntimeException e = new RuntimeException(); 682 e.fillInStackTrace(); 683 Log.w(TAG, "forceReport=" + forceReport + " creating=" + creating 684 + " formatChanged=" + formatChanged 685 + " sizeChanged=" + sizeChanged, e); 686 } 687 if (DEBUG) Log.v(TAG, "onSurfaceChanged(" 688 + mSurfaceHolder + ", " + mFormat 689 + ", " + mCurWidth + ", " + mCurHeight 690 + "): " + this); 691 didSurface = true; 692 onSurfaceChanged(mSurfaceHolder, mFormat, 693 mCurWidth, mCurHeight); 694 SurfaceHolder.Callback callbacks[] = mSurfaceHolder.getCallbacks(); 695 if (callbacks != null) { 696 for (SurfaceHolder.Callback c : callbacks) { 697 c.surfaceChanged(mSurfaceHolder, mFormat, 698 mCurWidth, mCurHeight); 699 } 700 } 701 } 702 703 if (redrawNeeded) { 704 onSurfaceRedrawNeeded(mSurfaceHolder); 705 SurfaceHolder.Callback callbacks[] = mSurfaceHolder.getCallbacks(); 706 if (callbacks != null) { 707 for (SurfaceHolder.Callback c : callbacks) { 708 if (c instanceof SurfaceHolder.Callback2) { 709 ((SurfaceHolder.Callback2)c).surfaceRedrawNeeded( 710 mSurfaceHolder); 711 } 712 } 713 } 714 } 715 716 if (didSurface && !mReportedVisible) { 717 // This wallpaper is currently invisible, but its 718 // surface has changed. At this point let's tell it 719 // again that it is invisible in case the report about 720 // the surface caused it to start running. We really 721 // don't want wallpapers running when not visible. 722 if (mIsCreating) { 723 // Some wallpapers will ignore this call if they 724 // had previously been told they were invisble, 725 // so if we are creating a new surface then toggle 726 // the state to get them to notice. 727 if (DEBUG) Log.v(TAG, "onVisibilityChanged(true) at surface: " 728 + this); 729 onVisibilityChanged(true); 730 } 731 if (DEBUG) Log.v(TAG, "onVisibilityChanged(false) at surface: " 732 + this); 733 onVisibilityChanged(false); 734 } 735 736 } finally { 737 mIsCreating = false; 738 mSurfaceCreated = true; 739 if (redrawNeeded) { 740 mSession.finishDrawing(mWindow); 741 } 742 mIWallpaperEngine.reportShown(); 743 } 744 } catch (RemoteException ex) { 745 } 746 if (DEBUG) Log.v( 747 TAG, "Layout: x=" + mLayout.x + " y=" + mLayout.y + 748 " w=" + mLayout.width + " h=" + mLayout.height); 749 } 750 } 751 752 void attach(IWallpaperEngineWrapper wrapper) { 753 if (DEBUG) Log.v(TAG, "attach: " + this + " wrapper=" + wrapper); 754 if (mDestroyed) { 755 return; 756 } 757 758 mIWallpaperEngine = wrapper; 759 mCaller = wrapper.mCaller; 760 mConnection = wrapper.mConnection; 761 mWindowToken = wrapper.mWindowToken; 762 mSurfaceHolder.setSizeFromLayout(); 763 mInitializing = true; 764 mSession = WindowManagerGlobal.getWindowSession(getMainLooper()); 765 766 mWindow.setSession(mSession); 767 768 mScreenOn = ((PowerManager)getSystemService(Context.POWER_SERVICE)).isScreenOn(); 769 770 IntentFilter filter = new IntentFilter(); 771 filter.addAction(Intent.ACTION_SCREEN_ON); 772 filter.addAction(Intent.ACTION_SCREEN_OFF); 773 registerReceiver(mReceiver, filter); 774 775 if (DEBUG) Log.v(TAG, "onCreate(): " + this); 776 onCreate(mSurfaceHolder); 777 778 mInitializing = false; 779 mReportedVisible = false; 780 updateSurface(false, false, false); 781 } 782 783 void doDesiredSizeChanged(int desiredWidth, int desiredHeight) { 784 if (!mDestroyed) { 785 if (DEBUG) Log.v(TAG, "onDesiredSizeChanged(" 786 + desiredWidth + "," + desiredHeight + "): " + this); 787 mIWallpaperEngine.mReqWidth = desiredWidth; 788 mIWallpaperEngine.mReqHeight = desiredHeight; 789 onDesiredSizeChanged(desiredWidth, desiredHeight); 790 doOffsetsChanged(true); 791 } 792 } 793 794 void doVisibilityChanged(boolean visible) { 795 if (!mDestroyed) { 796 mVisible = visible; 797 reportVisibility(); 798 } 799 } 800 801 void reportVisibility() { 802 if (!mDestroyed) { 803 boolean visible = mVisible && mScreenOn; 804 if (mReportedVisible != visible) { 805 mReportedVisible = visible; 806 if (DEBUG) Log.v(TAG, "onVisibilityChanged(" + visible 807 + "): " + this); 808 if (visible) { 809 // If becoming visible, in preview mode the surface 810 // may have been destroyed so now we need to make 811 // sure it is re-created. 812 doOffsetsChanged(false); 813 updateSurface(false, false, false); 814 } 815 onVisibilityChanged(visible); 816 } 817 } 818 } 819 820 void doOffsetsChanged(boolean always) { 821 if (mDestroyed) { 822 return; 823 } 824 825 if (!always && !mOffsetsChanged) { 826 return; 827 } 828 829 float xOffset; 830 float yOffset; 831 float xOffsetStep; 832 float yOffsetStep; 833 boolean sync; 834 synchronized (mLock) { 835 xOffset = mPendingXOffset; 836 yOffset = mPendingYOffset; 837 xOffsetStep = mPendingXOffsetStep; 838 yOffsetStep = mPendingYOffsetStep; 839 sync = mPendingSync; 840 mPendingSync = false; 841 mOffsetMessageEnqueued = false; 842 } 843 844 if (mSurfaceCreated) { 845 if (mReportedVisible) { 846 if (DEBUG) Log.v(TAG, "Offsets change in " + this 847 + ": " + xOffset + "," + yOffset); 848 final int availw = mIWallpaperEngine.mReqWidth-mCurWidth; 849 final int xPixels = availw > 0 ? -(int)(availw*xOffset+.5f) : 0; 850 final int availh = mIWallpaperEngine.mReqHeight-mCurHeight; 851 final int yPixels = availh > 0 ? -(int)(availh*yOffset+.5f) : 0; 852 onOffsetsChanged(xOffset, yOffset, xOffsetStep, yOffsetStep, xPixels, yPixels); 853 } else { 854 mOffsetsChanged = true; 855 } 856 } 857 858 if (sync) { 859 try { 860 if (DEBUG) Log.v(TAG, "Reporting offsets change complete"); 861 mSession.wallpaperOffsetsComplete(mWindow.asBinder()); 862 } catch (RemoteException e) { 863 } 864 } 865 } 866 867 void doCommand(WallpaperCommand cmd) { 868 Bundle result; 869 if (!mDestroyed) { 870 result = onCommand(cmd.action, cmd.x, cmd.y, cmd.z, 871 cmd.extras, cmd.sync); 872 } else { 873 result = null; 874 } 875 if (cmd.sync) { 876 try { 877 if (DEBUG) Log.v(TAG, "Reporting command complete"); 878 mSession.wallpaperCommandComplete(mWindow.asBinder(), result); 879 } catch (RemoteException e) { 880 } 881 } 882 } 883 884 void reportSurfaceDestroyed() { 885 if (mSurfaceCreated) { 886 mSurfaceCreated = false; 887 mSurfaceHolder.ungetCallbacks(); 888 SurfaceHolder.Callback callbacks[] = mSurfaceHolder.getCallbacks(); 889 if (callbacks != null) { 890 for (SurfaceHolder.Callback c : callbacks) { 891 c.surfaceDestroyed(mSurfaceHolder); 892 } 893 } 894 if (DEBUG) Log.v(TAG, "onSurfaceDestroyed(" 895 + mSurfaceHolder + "): " + this); 896 onSurfaceDestroyed(mSurfaceHolder); 897 } 898 } 899 900 void detach() { 901 if (mDestroyed) { 902 return; 903 } 904 905 mDestroyed = true; 906 907 if (mVisible) { 908 mVisible = false; 909 if (DEBUG) Log.v(TAG, "onVisibilityChanged(false): " + this); 910 onVisibilityChanged(false); 911 } 912 913 reportSurfaceDestroyed(); 914 915 if (DEBUG) Log.v(TAG, "onDestroy(): " + this); 916 onDestroy(); 917 918 unregisterReceiver(mReceiver); 919 920 if (mCreated) { 921 try { 922 if (DEBUG) Log.v(TAG, "Removing window and destroying surface " 923 + mSurfaceHolder.getSurface() + " of: " + this); 924 925 if (mInputEventReceiver != null) { 926 mInputEventReceiver.dispose(); 927 mInputEventReceiver = null; 928 } 929 930 mSession.remove(mWindow); 931 } catch (RemoteException e) { 932 } 933 mSurfaceHolder.mSurface.release(); 934 mCreated = false; 935 936 // Dispose the input channel after removing the window so the Window Manager 937 // doesn't interpret the input channel being closed as an abnormal termination. 938 if (mInputChannel != null) { 939 mInputChannel.dispose(); 940 mInputChannel = null; 941 } 942 } 943 } 944 } 945 946 class IWallpaperEngineWrapper extends IWallpaperEngine.Stub 947 implements HandlerCaller.Callback { 948 private final HandlerCaller mCaller; 949 950 final IWallpaperConnection mConnection; 951 final IBinder mWindowToken; 952 final int mWindowType; 953 final boolean mIsPreview; 954 boolean mShownReported; 955 int mReqWidth; 956 int mReqHeight; 957 958 Engine mEngine; 959 960 IWallpaperEngineWrapper(WallpaperService context, 961 IWallpaperConnection conn, IBinder windowToken, 962 int windowType, boolean isPreview, int reqWidth, int reqHeight) { 963 mCaller = new HandlerCaller(context, context.getMainLooper(), this); 964 mConnection = conn; 965 mWindowToken = windowToken; 966 mWindowType = windowType; 967 mIsPreview = isPreview; 968 mReqWidth = reqWidth; 969 mReqHeight = reqHeight; 970 971 Message msg = mCaller.obtainMessage(DO_ATTACH); 972 mCaller.sendMessage(msg); 973 } 974 975 public void setDesiredSize(int width, int height) { 976 Message msg = mCaller.obtainMessageII(DO_SET_DESIRED_SIZE, width, height); 977 mCaller.sendMessage(msg); 978 } 979 980 public void setVisibility(boolean visible) { 981 Message msg = mCaller.obtainMessageI(MSG_VISIBILITY_CHANGED, 982 visible ? 1 : 0); 983 mCaller.sendMessage(msg); 984 } 985 986 public void dispatchPointer(MotionEvent event) { 987 if (mEngine != null) { 988 mEngine.dispatchPointer(event); 989 } else { 990 event.recycle(); 991 } 992 } 993 994 public void dispatchWallpaperCommand(String action, int x, int y, 995 int z, Bundle extras) { 996 if (mEngine != null) { 997 mEngine.mWindow.dispatchWallpaperCommand(action, x, y, z, extras, false); 998 } 999 } 1000 1001 public void reportShown() { 1002 if (!mShownReported) { 1003 mShownReported = true; 1004 try { 1005 mConnection.engineShown(this); 1006 } catch (RemoteException e) { 1007 Log.w(TAG, "Wallpaper host disappeared", e); 1008 return; 1009 } 1010 } 1011 } 1012 1013 public void destroy() { 1014 Message msg = mCaller.obtainMessage(DO_DETACH); 1015 mCaller.sendMessage(msg); 1016 } 1017 1018 public void executeMessage(Message message) { 1019 switch (message.what) { 1020 case DO_ATTACH: { 1021 try { 1022 mConnection.attachEngine(this); 1023 } catch (RemoteException e) { 1024 Log.w(TAG, "Wallpaper host disappeared", e); 1025 return; 1026 } 1027 Engine engine = onCreateEngine(); 1028 mEngine = engine; 1029 mActiveEngines.add(engine); 1030 engine.attach(this); 1031 return; 1032 } 1033 case DO_DETACH: { 1034 mActiveEngines.remove(mEngine); 1035 mEngine.detach(); 1036 return; 1037 } 1038 case DO_SET_DESIRED_SIZE: { 1039 mEngine.doDesiredSizeChanged(message.arg1, message.arg2); 1040 return; 1041 } 1042 case MSG_UPDATE_SURFACE: 1043 mEngine.updateSurface(true, false, false); 1044 break; 1045 case MSG_VISIBILITY_CHANGED: 1046 if (DEBUG) Log.v(TAG, "Visibility change in " + mEngine 1047 + ": " + message.arg1); 1048 mEngine.doVisibilityChanged(message.arg1 != 0); 1049 break; 1050 case MSG_WALLPAPER_OFFSETS: { 1051 mEngine.doOffsetsChanged(true); 1052 } break; 1053 case MSG_WALLPAPER_COMMAND: { 1054 WallpaperCommand cmd = (WallpaperCommand)message.obj; 1055 mEngine.doCommand(cmd); 1056 } break; 1057 case MSG_WINDOW_RESIZED: { 1058 final boolean reportDraw = message.arg1 != 0; 1059 mEngine.updateSurface(true, false, reportDraw); 1060 mEngine.doOffsetsChanged(true); 1061 } break; 1062 case MSG_WINDOW_MOVED: { 1063 // Do nothing. What does it mean for a Wallpaper to move? 1064 } break; 1065 case MSG_TOUCH_EVENT: { 1066 boolean skip = false; 1067 MotionEvent ev = (MotionEvent)message.obj; 1068 if (ev.getAction() == MotionEvent.ACTION_MOVE) { 1069 synchronized (mEngine.mLock) { 1070 if (mEngine.mPendingMove == ev) { 1071 mEngine.mPendingMove = null; 1072 } else { 1073 // this is not the motion event we are looking for.... 1074 skip = true; 1075 } 1076 } 1077 } 1078 if (!skip) { 1079 if (DEBUG) Log.v(TAG, "Delivering touch event: " + ev); 1080 mEngine.onTouchEvent(ev); 1081 } 1082 ev.recycle(); 1083 } break; 1084 default : 1085 Log.w(TAG, "Unknown message type " + message.what); 1086 } 1087 } 1088 } 1089 1090 /** 1091 * Implements the internal {@link IWallpaperService} interface to convert 1092 * incoming calls to it back to calls on an {@link WallpaperService}. 1093 */ 1094 class IWallpaperServiceWrapper extends IWallpaperService.Stub { 1095 private final WallpaperService mTarget; 1096 1097 public IWallpaperServiceWrapper(WallpaperService context) { 1098 mTarget = context; 1099 } 1100 1101 @Override 1102 public void attach(IWallpaperConnection conn, IBinder windowToken, 1103 int windowType, boolean isPreview, int reqWidth, int reqHeight) { 1104 new IWallpaperEngineWrapper(mTarget, conn, windowToken, 1105 windowType, isPreview, reqWidth, reqHeight); 1106 } 1107 } 1108 1109 @Override 1110 public void onCreate() { 1111 super.onCreate(); 1112 } 1113 1114 @Override 1115 public void onDestroy() { 1116 super.onDestroy(); 1117 for (int i=0; i<mActiveEngines.size(); i++) { 1118 mActiveEngines.get(i).detach(); 1119 } 1120 mActiveEngines.clear(); 1121 } 1122 1123 /** 1124 * Implement to return the implementation of the internal accessibility 1125 * service interface. Subclasses should not override. 1126 */ 1127 @Override 1128 public final IBinder onBind(Intent intent) { 1129 return new IWallpaperServiceWrapper(this); 1130 } 1131 1132 /** 1133 * Must be implemented to return a new instance of the wallpaper's engine. 1134 * Note that multiple instances may be active at the same time, such as 1135 * when the wallpaper is currently set as the active wallpaper and the user 1136 * is in the wallpaper picker viewing a preview of it as well. 1137 */ 1138 public abstract Engine onCreateEngine(); 1139 1140 @Override 1141 protected void dump(FileDescriptor fd, PrintWriter out, String[] args) { 1142 out.print("State of wallpaper "); out.print(this); out.println(":"); 1143 for (int i=0; i<mActiveEngines.size(); i++) { 1144 Engine engine = mActiveEngines.get(i); 1145 out.print(" Engine "); out.print(engine); out.println(":"); 1146 engine.dump(" ", fd, out, args); 1147 } 1148 } 1149} 1150