blob: 242398bba8fed1afd8424d0e8314e30bd4c1bb4f [file] [log] [blame]
/* libs/graphics/animator/SkAnimator.cpp
**
** Copyright 2006, The Android Open Source Project
**
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
**
** http://www.apache.org/licenses/LICENSE-2.0
**
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
#include "SkAnimator.h"
#include "SkAnimateMaker.h"
#include "SkCanvas.h"
#include "SkDisplayApply.h"
#include "SkDisplayMovie.h"
#include "SkDisplayTypes.h"
#include "SkDisplayXMLParser.h"
#include "SkStream.h"
#include "SkScript.h"
#include "SkScript2.h" // compiled script experiment
#include "SkSystemEventTypes.h"
#include "SkTypedArray.h"
#ifdef ANDROID
#include "SkDrawExtraPathEffect.h"
#endif
#ifdef SK_DEBUG
#include "SkTime.h"
#endif
#if defined SK_BUILD_FOR_WIN32 && defined SK_DEBUG
#define _static
extern const char gMathPrimerText[];
extern const char gMathPrimerBinary[];
#else
#define _static static
#endif
#if !defined SK_BUILD_FOR_BREW || defined SK_DEBUG
_static const char gMathPrimerText[] =
"<screenplay>"
"<Math id=\"Math\"/>"
"<Number id=\"Number\"/>"
"</screenplay>";
#endif
#if defined SK_BUILD_FOR_BREW || defined SK_DEBUG
_static const char gMathPrimerBinary[] =
"\x0Ascreenplay\x04Mathbid\x04Math@@"; // !!! now out of date -- does not include Number
#endif
#if defined SK_BUILD_FOR_BREW
#define gMathPrimer gMathPrimerBinary
#else
#define gMathPrimer gMathPrimerText
#endif
SkAnimator::SkAnimator() : fMaker(NULL) {
initialize();
}
SkAnimator::~SkAnimator() {
SkDELETE(fMaker);
}
void SkAnimator::addExtras(SkExtras* extras) {
*fMaker->fExtras.append() = extras;
}
bool SkAnimator::appendStream(SkStream* stream) {
return decodeStream(stream);
}
bool SkAnimator::decodeMemory(const void* buffer, size_t size)
{
fMaker->fFileName.reset();
SkDisplayXMLParser parser(*fMaker);
return parser.parse((const char*)buffer, size);
}
bool SkAnimator::decodeStream(SkStream* stream)
{
SkDisplayXMLParser parser(*fMaker);
bool result = parser.parse(*stream);
fMaker->setErrorString();
return result;
}
bool SkAnimator::decodeDOM(const SkDOM& dom, const SkDOMNode* node)
{
fMaker->fFileName.reset();
SkDisplayXMLParser parser(*fMaker);
return parser.parse(dom, node);
}
bool SkAnimator::decodeURI(const char uri[]) {
// SkDebugf("animator decode %s\n", uri);
// SkStream* stream = SkStream::GetURIStream(fMaker->fPrefix.c_str(), uri);
SkStream* stream = new SkFILEStream(uri);
SkAutoTDelete<SkStream> autoDel(stream);
setURIBase(uri);
return decodeStream(stream);
}
bool SkAnimator::doCharEvent(SkUnichar code) {
if (code == 0)
return false;
struct SkEventState state;
state.fCode = code;
fMaker->fEnableTime = fMaker->getAppTime();
bool result = fMaker->fEvents.doEvent(*fMaker, SkDisplayEvent::kKeyChar, &state);
fMaker->notifyInval();
return result;
}
bool SkAnimator::doClickEvent(int clickState, SkScalar x, SkScalar y) {
SkASSERT(clickState >= 0 && clickState <= 2);
struct SkEventState state;
state.fX = x;
state.fY = y;
fMaker->fEnableTime = fMaker->getAppTime();
bool result = fMaker->fEvents.doEvent(*fMaker,
clickState == 0 ? SkDisplayEvent::kMouseDown :
clickState == 1 ? SkDisplayEvent::kMouseDrag :
SkDisplayEvent::kMouseUp, &state);
fMaker->notifyInval();
return result;
}
bool SkAnimator::doKeyEvent(SkKey code) {
if (code == 0)
return false;
struct SkEventState state;
state.fCode = code;
fMaker->fEnableTime = fMaker->getAppTime();
bool result = fMaker->fEvents.doEvent(*fMaker, SkDisplayEvent::kKeyPress, &state);
fMaker->notifyInval();
return result;
}
bool SkAnimator::doKeyUpEvent(SkKey code) {
if (code == 0)
return false;
struct SkEventState state;
state.fCode = code;
fMaker->fEnableTime = fMaker->getAppTime();
bool result = fMaker->fEvents.doEvent(*fMaker, SkDisplayEvent::kKeyPressUp, &state);
fMaker->notifyInval();
return result;
}
bool SkAnimator::doUserEvent(const SkEvent& evt) {
fMaker->fEnableTime = fMaker->getAppTime();
return onEvent(evt);
}
SkAnimator::DifferenceType SkAnimator::draw(SkCanvas* canvas, SkPaint* paint, SkMSec time) {
if (paint == NULL)
return draw(canvas, time);
fMaker->fScreenplay.time = time;
fMaker->fCanvas = canvas;
fMaker->fPaint = paint;
fMaker->fDisplayList.fHasUnion = false;
int result = fMaker->fDisplayList.draw(*fMaker, time);
if (result)
result += fMaker->fDisplayList.fHasUnion;
return (DifferenceType) result;
}
SkAnimator::DifferenceType SkAnimator::draw(SkCanvas* canvas, SkMSec time) {
SkPaint paint;
return draw(canvas, &paint, time);
}
#ifdef SK_DEBUG
void SkAnimator::eventDone(const SkEvent& ) {
}
#endif
bool SkAnimator::findClickEvent(SkScalar x, SkScalar y) {
struct SkEventState state;
state.fDisable = true;
state.fX = x;
state.fY = y;
fMaker->fEnableTime = fMaker->getAppTime();
bool result = fMaker->fEvents.doEvent(*fMaker, SkDisplayEvent::kMouseDown, &state);
fMaker->notifyInval();
return result;
}
const SkAnimator* SkAnimator::getAnimator(const SkDisplayable* displayable) const {
if (displayable->getType() != SkType_Movie)
return NULL;
const SkDisplayMovie* movie = (const SkDisplayMovie*) displayable;
return movie->getAnimator();
}
const SkDisplayable* SkAnimator::getElement(const char* id) {
SkDisplayable* element;
if (fMaker->find(id, &element) == false)
return NULL;
return (const SkDisplayable*) element;
}
SkElementType SkAnimator::getElementType(const SkDisplayable* ae) {
SkDisplayable* element = (SkDisplayable*) ae;
const SkMemberInfo* info = SkDisplayType::GetMembers(fMaker, element->getType(), NULL);
return (SkElementType) SkDisplayType::Find(fMaker, info);
}
SkElementType SkAnimator::getElementType(const char* id) {
const SkDisplayable* element = getElement(id);
return getElementType(element);
}
const SkMemberInfo* SkAnimator::getField(const SkDisplayable* ae, const char* field) {
SkDisplayable* element = (SkDisplayable*) ae;
const SkMemberInfo* info = element->getMember(field);
return (const SkMemberInfo*) info;
}
const SkMemberInfo* SkAnimator::getField(const char* elementID, const char* field) {
const SkDisplayable* element = getElement(elementID);
return getField(element, field);
}
SkFieldType SkAnimator::getFieldType(const SkMemberInfo* ai) {
const SkMemberInfo* info = (const SkMemberInfo*) ai;
return (SkFieldType) info->getType();
}
SkFieldType SkAnimator::getFieldType(const char* id, const char* fieldID) {
const SkMemberInfo* field = getField(id, fieldID);
return getFieldType(field);
}
static bool getArrayCommon(const SkDisplayable* ae, const SkMemberInfo* ai,
int index, SkOperand* operand, SkDisplayTypes type) {
const SkDisplayable* element = (const SkDisplayable*) ae;
const SkMemberInfo* info = (const SkMemberInfo*) ai;
SkASSERT(info->fType == SkType_Array);
return info->getArrayValue(element, index, operand);
}
int32_t SkAnimator::getArrayInt(const SkDisplayable* ae,
const SkMemberInfo* ai, int index) {
SkOperand operand;
bool result = getArrayCommon(ae, ai, index, &operand, SkType_Int);
return result ? operand.fS32 : SK_NaN32;
}
int32_t SkAnimator::getArrayInt(const char* id, const char* fieldID, int index) {
const SkDisplayable* element = getElement(id);
if (element == NULL)
return SK_NaN32;
const SkMemberInfo* field = getField(element, fieldID);
if (field == NULL)
return SK_NaN32;
return getArrayInt(element, field, index);
}
SkScalar SkAnimator::getArrayScalar(const SkDisplayable* ae,
const SkMemberInfo* ai, int index) {
SkOperand operand;
bool result = getArrayCommon(ae, ai, index, &operand, SkType_Float);
return result ? operand.fScalar : SK_ScalarNaN;
}
SkScalar SkAnimator::getArrayScalar(const char* id, const char* fieldID, int index) {
const SkDisplayable* element = getElement(id);
if (element == NULL)
return SK_ScalarNaN;
const SkMemberInfo* field = getField(element, fieldID);
if (field == NULL)
return SK_ScalarNaN;
return getArrayScalar(element, field, index);
}
const char* SkAnimator::getArrayString(const SkDisplayable* ae,
const SkMemberInfo* ai, int index) {
SkOperand operand;
bool result = getArrayCommon(ae, ai, index, &operand, SkType_String);
return result ? operand.fString->c_str() : NULL;
}
const char* SkAnimator::getArrayString(const char* id, const char* fieldID, int index) {
const SkDisplayable* element = getElement(id);
if (element == NULL)
return NULL;
const SkMemberInfo* field = getField(element, fieldID);
if (field == NULL)
return NULL;
return getArrayString(element, field, index);
}
SkMSec SkAnimator::getInterval() {
return fMaker->fMinimumInterval == (SkMSec) -1 ? 0 : fMaker->fMinimumInterval;
}
void SkAnimator::getInvalBounds(SkRect* inval) {
if (fMaker->fDisplayList.fHasUnion) {
inval->fLeft = SkIntToScalar(fMaker->fDisplayList.fInvalBounds.fLeft);
inval->fTop = SkIntToScalar(fMaker->fDisplayList.fInvalBounds.fTop);
inval->fRight = SkIntToScalar(fMaker->fDisplayList.fInvalBounds.fRight);
inval->fBottom = SkIntToScalar(fMaker->fDisplayList.fInvalBounds.fBottom);
} else {
inval->fLeft = inval->fTop = -SK_ScalarMax;
inval->fRight = inval->fBottom = SK_ScalarMax;
}
}
const SkXMLParserError* SkAnimator::getParserError() {
return &fMaker->fError;
}
const char* SkAnimator::getParserErrorString() {
if (fMaker->fErrorString.size() == 0 && fMaker->fError.hasError())
fMaker->setErrorString();
return fMaker->fErrorString.c_str();
}
int32_t SkAnimator::getInt(const SkDisplayable* element, const SkMemberInfo* info) {
if (info->fType != SkType_MemberProperty) {
SkOperand operand;
if (info->getType() == SkType_Int) {
info->getValue(element, &operand, 1);
return operand.fS32;
}
return SK_NaN32;
}
SkScriptValue scriptValue;
bool success = element->getProperty(info->propertyIndex(), &scriptValue);
if (success && scriptValue.fType == SkType_Int)
return scriptValue.fOperand.fS32;
return SK_NaN32;
}
int32_t SkAnimator::getInt(const char* id, const char* fieldID) {
const SkDisplayable* element = getElement(id);
if (element == NULL)
return SK_NaN32;
const SkMemberInfo* field = getField(element, fieldID);
if (field == NULL)
return SK_NaN32;
return getInt(element, field);
}
SkScalar SkAnimator::getScalar(const SkDisplayable* element, const SkMemberInfo* info) {
if (info->fType != SkType_MemberProperty) {
SkOperand operand;
if (info->getType() == SkType_Float) {
info->getValue(element, &operand, 1);
return operand.fScalar;
}
return SK_ScalarNaN;
}
SkScriptValue scriptValue;
bool success = element->getProperty(info->propertyIndex(), &scriptValue);
if (success && scriptValue.fType == SkType_Float)
return scriptValue.fOperand.fScalar;
return SK_ScalarNaN;
}
SkScalar SkAnimator::getScalar(const char* id, const char* fieldID) {
const SkDisplayable* element = getElement(id);
if (element == NULL)
return SK_ScalarNaN;
const SkMemberInfo* field = getField(element, fieldID);
if (field == NULL)
return SK_ScalarNaN;
return getScalar(element, field);
}
const char* SkAnimator::getString(const SkDisplayable* ae,
const SkMemberInfo* ai) {
const SkDisplayable* element = (const SkDisplayable*) ae;
const SkMemberInfo* info = (const SkMemberInfo*) ai;
SkString* temp;
info->getString(element, &temp);
return temp->c_str();
}
const char* SkAnimator::getString(const char* id, const char* fieldID) {
const SkDisplayable* element = getElement(id);
if (element == NULL)
return NULL;
const SkMemberInfo* field = getField(element, fieldID);
if (field == NULL)
return NULL;
return getString(element, field);
}
const char* SkAnimator::getURIBase() {
return fMaker->fPrefix.c_str();
}
void SkAnimator::initialize() {
SkDELETE(fMaker);
fMaker = SkNEW_ARGS(SkAnimateMaker, (this, NULL, NULL));
decodeMemory(gMathPrimer, sizeof(gMathPrimer)-1);
#ifdef ANDROID
InitializeSkExtraPathEffects(this);
#endif
}
#ifdef SK_DEBUG
bool SkAnimator::isTrackingEvents() {
return false;
}
#endif
bool SkAnimator::onEvent(const SkEvent& evt) {
#ifdef SK_DEBUG
SkAnimator* root = fMaker->getRoot();
if (root == NULL)
root = this;
if (root->isTrackingEvents())
root->eventDone(evt);
#endif
if (evt.isType(SK_EventType_OnEnd)) {
SkEventState eventState;
bool success = evt.findPtr("anim", (void**) &eventState.fDisplayable);
SkASSERT(success);
success = evt.findS32("time", (int32_t*) &fMaker->fEnableTime);
SkASSERT(success);
fMaker->fAdjustedStart = fMaker->getAppTime() - fMaker->fEnableTime;
fMaker->fEvents.doEvent(*fMaker, SkDisplayEvent::kOnEnd, &eventState);
fMaker->fAdjustedStart = 0;
goto inval;
}
if (evt.isType(SK_EventType_Delay)) {
fMaker->doDelayedEvent();
goto inval;
}
{
const char* id = evt.findString("id");
if (id == NULL)
return false;
SkDisplayable** firstMovie = fMaker->fMovies.begin();
SkDisplayable** endMovie = fMaker->fMovies.end();
for (SkDisplayable** ptr = firstMovie; ptr < endMovie; ptr++) {
SkDisplayMovie* movie = (SkDisplayMovie*) *ptr;
movie->doEvent(evt);
}
{
SkDisplayable* event;
if (fMaker->find(id, &event) == false)
return false;
#if defined SK_DEBUG && defined SK_DEBUG_ANIMATION_TIMING
SkString debugOut;
SkMSec realTime = fMaker->getAppTime();
debugOut.appendS32(realTime - fMaker->fDebugTimeBase);
debugOut.append(" onEvent id=");
debugOut.append(id);
#endif
SkMSec time = evt.getFast32();
if (time != 0) {
SkMSec app = fMaker->getAppTime();
fMaker->setEnableTime(app, time);
#if defined SK_DEBUG && defined SK_DEBUG_ANIMATION_TIMING
debugOut.append(" time=");
debugOut.appendS32(time - fMaker->fDebugTimeBase);
debugOut.append(" adjust=");
debugOut.appendS32(fMaker->fAdjustedStart);
#endif
}
#if defined SK_DEBUG && defined SK_DEBUG_ANIMATION_TIMING
SkDebugf("%s\n", debugOut.c_str());
#endif
SkASSERT(event->isEvent());
SkDisplayEvent* displayEvent = (SkDisplayEvent*) event;
displayEvent->populateInput(*fMaker, evt);
displayEvent->enableEvent(*fMaker);
}
}
inval:
fMaker->notifyInval();
return true;
}
void SkAnimator::onEventPost(SkEvent* evt, SkEventSinkID sinkID)
{
#ifdef SK_DEBUG
SkAnimator* root = fMaker->getRoot();
if (root) {
root->onEventPost(evt, sinkID);
return;
}
#else
SkASSERT(sinkID == this->getSinkID() || this->getHostEventSinkID() == sinkID);
#endif
SkEvent::Post(evt, sinkID);
}
void SkAnimator::onEventPostTime(SkEvent* evt, SkEventSinkID sinkID, SkMSec time)
{
#ifdef SK_DEBUG
SkAnimator* root = fMaker->getRoot();
if (root) {
root->onEventPostTime(evt, sinkID, time);
return;
}
#else
SkASSERT(sinkID == this->getSinkID() || this->getHostEventSinkID() == sinkID);
#endif
SkEvent::PostTime(evt, sinkID, time);
}
void SkAnimator::reset() {
fMaker->fDisplayList.reset();
}
SkEventSinkID SkAnimator::getHostEventSinkID() const {
return fMaker->fHostEventSinkID;
}
void SkAnimator::setHostEventSinkID(SkEventSinkID target) {
fMaker->fHostEventSinkID = target;
}
void SkAnimator::onSetHostHandler(Handler ) {
}
void SkAnimator::setJavaOwner(Handler ) {
}
bool SkAnimator::setArrayString(const char* id, const char* fieldID, const char** array, int num)
{
SkTypedArray tArray(SkType_String);
tArray.setCount(num);
for (int i = 0; i < num; i++) {
SkOperand op;
op.fString = new SkString(array[i]);
tArray[i] = op;
}
return setArray(id, fieldID, tArray);
}
bool SkAnimator::setArrayInt(const char* id, const char* fieldID, const int* array, int num)
{
SkTypedArray tArray(SkType_Int);
tArray.setCount(num);
for (int i = 0; i < num; i++) {
SkOperand op;
op.fS32 = array[i];
tArray[i] = op;
}
return setArray(id, fieldID, tArray);
}
bool SkAnimator::setArray(SkDisplayable* element, const SkMemberInfo* info, SkTypedArray array) {
if (info->fType != SkType_Array)
return false; //the field is not an array
//i think we can handle the case where the displayable itself is an array differently from the
//case where it has an array - for one thing, if it is an array, i think we can change its type
//if it's not, we cannot
SkDisplayTypes type = element->getType();
if (type == SkType_Array) {
SkDisplayArray* dispArray = (SkDisplayArray*) element;
dispArray->values = array;
return true;
}
else
return false; //currently i don't care about this case
}
bool SkAnimator::setArray(const char* id, const char* fieldID, SkTypedArray array) {
SkDisplayable* element = (SkDisplayable*) getElement(id);
//should I go ahead and change all 'NULL's to 'NULL'?
if (element == NULL)
return false;
const SkMemberInfo* field = getField(element, fieldID);
if (field == NULL)
return false;
return setArray(element, field, array);
}
bool SkAnimator::setInt(SkDisplayable* element, const SkMemberInfo* info, int32_t s32) {
if (info->fType != SkType_MemberProperty) {
SkOperand operand;
operand.fS32 = s32;
SkASSERT(info->getType() == SkType_Int);
info->setValue(element, &operand, 1);
} else {
SkScriptValue scriptValue;
scriptValue.fType = SkType_Int;
scriptValue.fOperand.fS32 = s32;
element->setProperty(info->propertyIndex(), scriptValue);
}
return true;
}
bool SkAnimator::setInt(const char* id, const char* fieldID, int32_t s32) {
SkDisplayable* element = (SkDisplayable*) getElement(id);
if (element == NULL)
return false;
const SkMemberInfo* field = getField(element, fieldID);
if (field == NULL)
return false;
return setInt(element, field, s32);
}
bool SkAnimator::setScalar(SkDisplayable* element, const SkMemberInfo* info, SkScalar scalar) {
if (info->fType != SkType_MemberProperty) {
SkOperand operand;
operand.fScalar = scalar;
SkASSERT(info->getType() == SkType_Float);
info->setValue(element, &operand, 1);
} else {
SkScriptValue scriptValue;
scriptValue.fType = SkType_Float;
scriptValue.fOperand.fScalar = scalar;
element->setProperty(info->propertyIndex(), scriptValue);
}
return true;
}
bool SkAnimator::setScalar(const char* id, const char* fieldID, SkScalar scalar) {
SkDisplayable* element = (SkDisplayable*) getElement(id);
if (element == NULL)
return false;
const SkMemberInfo* field = getField(element, fieldID);
if (field == NULL)
return false;
return setScalar(element, field, scalar);
}
bool SkAnimator::setString(SkDisplayable* element,
const SkMemberInfo* info, const char* str) {
// !!! until this is fixed, can't call script with global references from here
info->setValue(*fMaker, NULL, 0, info->fCount, element, info->getType(), str, strlen(str));
return true;
}
bool SkAnimator::setString(const char* id, const char* fieldID, const char* str) {
SkDisplayable* element = (SkDisplayable*) getElement(id);
if (element == NULL)
return false;
const SkMemberInfo* field = getField(element, fieldID);
if (field == NULL)
return false;
return setString(element, field, str);
}
void SkAnimator::setTimeline(const Timeline& timeline) {
fMaker->fTimeline = &timeline;
}
void SkAnimator::setURIBase(const char* uri) {
if (uri)
{
const char* tail = strrchr(uri, '/');
if (tail) {
SkString prefix(uri, tail - uri + 1);
if (uri[0] != '.' /*SkStream::IsAbsoluteURI(uri)*/)
fMaker->fPrefix.reset();
fMaker->fPrefix.append(prefix);
fMaker->fFileName.set(tail + 1);
} else
fMaker->fFileName.set(uri);
}
}
#ifdef SK_DEBUG
bool SkAnimator::NoLeaks() {
#ifdef SK_BUILD_FOR_MAC
if (SkDisplayable::fAllocations.count() == 0)
return true;
// return SkDisplayable::fAllocationCount == 0;
SkDebugf("!!! leaked %d displayables:\n", SkDisplayable::fAllocations.count());
for (SkDisplayable** leak = SkDisplayable::fAllocations.begin(); leak < SkDisplayable::fAllocations.end(); leak++)
SkDebugf("%08x %s\n", *leak, (*leak)->id);
#endif
return false;
}
#endif
#ifdef SK_SUPPORT_UNITTEST
#include "SkAnimatorScript.h"
#include "SkBase64.h"
#include "SkParse.h"
#include "SkMemberInfo.h"
#define unittestline(type) { #type , type::UnitTest }
#endif
void SkAnimator::Init(bool runUnitTests) {
#ifdef SK_SUPPORT_UNITTEST
if (runUnitTests == false)
return;
static const struct {
const char* fTypeName;
void (*fUnitTest)( );
} gUnitTests[] = {
unittestline(SkBase64),
unittestline(SkDisplayType),
unittestline(SkParse),
unittestline(SkScriptEngine),
// unittestline(SkScriptEngine2), // compiled script experiment
unittestline(SkAnimatorScript)
};
for (int i = 0; i < (int)SK_ARRAY_COUNT(gUnitTests); i++)
{
SkDebugf("SkAnimator: Running UnitTest for %s\n", gUnitTests[i].fTypeName);
gUnitTests[i].fUnitTest();
SkDebugf("SkAnimator: End UnitTest for %s\n", gUnitTests[i].fTypeName);
}
#endif
}
void SkAnimator::Term() {
}