]> git.tdb.fi Git - libs/gl.git/blobdiff - source/animation.cpp
Refactor KeyFrame ownership management in Animation
[libs/gl.git] / source / animation.cpp
index f0e2630a502f6f43339ef7cbd1be8bcbe3aed7a3..900542dd04bded26a97186b41c98ee949be4dc4f 100644 (file)
@@ -1,7 +1,7 @@
 #include <cmath>
 #include <msp/core/maputils.h>
 #include <msp/datafile/collection.h>
-#include <msp/time/units.h>
+#include <msp/interpolate/bezierspline.h>
 #include "animation.h"
 #include "animationeventobserver.h"
 #include "armature.h"
@@ -24,6 +24,8 @@ Animation::~Animation()
 
 void Animation::set_armature(const Armature &a)
 {
+       if(!keyframes.empty() && &a!=armature)
+               throw invalid_operation("Animation::set_armature");
        armature = &a;
 }
 
@@ -44,7 +46,8 @@ const string &Animation::get_uniform_name(unsigned i) const
 
 void Animation::add_keyframe(const Time::TimeDelta &t, const KeyFrame &kf)
 {
-       add_keyframe(t, kf, 1.0f, 1.0f);
+       add_keyframe(t, &kf, false, false);
+       create_curves();
 }
 
 void Animation::add_keyframe(const Time::TimeDelta &t, const KeyFrame &kf, float slope)
@@ -52,57 +55,150 @@ void Animation::add_keyframe(const Time::TimeDelta &t, const KeyFrame &kf, float
        add_keyframe(t, kf, slope, slope);
 }
 
-void Animation::add_keyframe(const Time::TimeDelta &t, const KeyFrame &kf, float ss, float es)
+void Animation::add_keyframe(const Time::TimeDelta &t, const KeyFrame &kf, float, float)
 {
-       RefPtr<const KeyFrame> kfr(&kf);
-       kfr.keep();
-       add_keyframe(t, kfr, ss, es);
+       add_keyframe(t, kf);
 }
 
-void Animation::add_keyframe(const Time::TimeDelta &t, const RefPtr<const KeyFrame> &kf, float ss, float es)
+void Animation::add_control_keyframe(const KeyFrame &kf)
 {
+       if(keyframes.empty())
+               throw invalid_operation("Animation::add_control_keyframe");
+
+       add_keyframe(keyframes.back().time, &kf, true, false);
+}
+
+void Animation::add_keyframe(const Time::TimeDelta &t, const KeyFrame *kf, bool c, bool owned)
+{
+       if(c && keyframes.empty())
+               throw invalid_argument("Animation::add_keyframe");
+       if(keyframes.empty() && t!=Time::zero)
+               throw invalid_argument("Animation::add_keyframe");
        if(!keyframes.empty() && t<keyframes.back().time)
                throw invalid_argument("Animation::add_keyframe");
+       if(kf->get_pose() && armature && kf->get_pose()->get_armature()!=armature)
+               throw invalid_argument("Animation::add_keyframe");
 
-       bool realloc = (keyframes.size()>=keyframes.capacity());
+       const KeyFrame::UniformMap &kf_uniforms = kf->get_uniforms();
+       for(vector<UniformInfo>::const_iterator i=uniforms.begin(); i!=uniforms.end(); ++i)
+       {
+               KeyFrame::UniformMap::const_iterator j = kf_uniforms.find(i->name);
+               if(j!=kf_uniforms.end() && j->second.size!=i->size)
+                       throw invalid_argument("Animation::add_keyframe");
+       }
 
-       keyframes.push_back(TimedKeyFrame());
-       TimedKeyFrame &tkf = keyframes.back();
+       if(kf->get_pose() && !armature)
+               armature = kf->get_pose()->get_armature();
+
+       TimedKeyFrame tkf;
        tkf.time = t;
-       tkf.start_slope = ss;
-       tkf.end_slope = es;
        tkf.keyframe = kf;
+       if(!owned)
+               tkf.keyframe.keep();
+       tkf.control = c;
+
+       keyframes.push_back(tkf);
 
-       if(realloc)
+       for(KeyFrame::UniformMap::const_iterator i=kf_uniforms.begin(); i!=kf_uniforms.end(); ++i)
        {
-               for(unsigned i=1; i<keyframes.size(); ++i)
-                       keyframes[i].prev = &keyframes[i-1];
+               bool found = false;
+               for(vector<UniformInfo>::const_iterator j=uniforms.begin(); (!found && j!=uniforms.end()); ++j)
+                       found = (j->name==i->first);
+
+               if(!found)
+                       uniforms.push_back(UniformInfo(i->first, i->second.size));
        }
-       else if(keyframes.size()>1)
-               tkf.prev = &tkf-1;
+}
 
-       prepare_keyframe(tkf);
+void Animation::create_curves()
+{
+       for(vector<Curve *>::iterator i=curves.begin(); i!=curves.end(); ++i)
+               delete *i;
+       curves.clear();
+
+       curves.reserve(3+uniforms.size());
+       create_curve<3>(POSITION, &extract_position);
+       create_curve<3>(EULER, &extract_euler);
+       create_curve<3>(SCALE, &extract_scale);
+
+       for(vector<UniformInfo>::const_iterator i=uniforms.begin(); i!=uniforms.end(); ++i)
+       {
+               if(i->size==1)
+                       create_curve<1>(UNIFORM, ExtractUniform<1>(i->name));
+               else if(i->size==2)
+                       create_curve<2>(UNIFORM, ExtractUniform<2>(i->name));
+               else if(i->size==3)
+                       create_curve<3>(UNIFORM, ExtractUniform<3>(i->name));
+               else if(i->size==4)
+                       create_curve<4>(UNIFORM, ExtractUniform<4>(i->name));
+       }
 }
 
-void Animation::prepare_keyframe(TimedKeyFrame &tkf)
+template<unsigned N, typename T>
+void Animation::create_curve(CurveTarget target, const T &extract)
 {
-       const KeyFrame::UniformMap &kf_uniforms = tkf.keyframe->get_uniforms();
-       for(KeyFrame::UniformMap::const_iterator i=kf_uniforms.begin(); i!=kf_uniforms.end(); ++i)
+       typedef typename ValueCurve<N>::Knot Knot;
+
+       vector<Knot> knots;
+       unsigned n_control = 0;
+       for(vector<TimedKeyFrame>::const_iterator i=keyframes.begin(); i!=keyframes.end(); ++i)
        {
-               bool found = false;
-               for(unsigned j=0; (!found && j<uniforms.size()); ++j)
-                       if(uniforms[j].name==i->first)
+               if(i->control && knots.empty())
+                       continue;
+
+               typename Interpolate::SplineValue<float, N>::Type value;
+               if(extract(*i->keyframe, value))
+               {
+                       float x = i->time/Time::sec;
+                       if(i->control)
                        {
-                               if(uniforms[j].size!=i->second.size)
-                                       throw invalid_operation("Animation::prepare_keyframe");
-                               found = true;
+                               ++n_control;
+                               if(n_control>2)
+                                       throw logic_error("too many control keyframes");
                        }
-
-               if(!found)
-                       uniforms.push_back(UniformInfo(i->first, i->second.size));
+                       else
+                       {
+                               if(n_control==1)
+                               {
+                                       typename Knot::Value cv = knots.back().y;
+                                       knots.back().y = (knots[knots.size()-2].y+cv*2.0f)/3.0f;
+                                       knots.push_back(Knot(x, (value+cv*2.0f)/3.0f));
+                               }
+                               else if(n_control==0 && !knots.empty())
+                               {
+                                       typename Knot::Value prev = knots.back().y;
+                                       knots.push_back(Knot(knots.back().x, (prev*2.0f+value)/3.0f));
+                                       knots.push_back(Knot(x, (prev+value*2.0f)/3.0f));
+                               }
+                               n_control = 0;
+                       }
+                       knots.push_back(Knot(x, value));
+               }
        }
+       
+       while(n_control--)
+               knots.pop_back();
 
-       tkf.prepare(*this);
+       curves.push_back(new ValueCurve<N>(target, knots));
+}
+
+bool Animation::extract_position(const KeyFrame &kf, Vector3 &value)
+{
+       value = kf.get_transform().get_position();
+       return true;
+}
+
+bool Animation::extract_euler(const KeyFrame &kf, Vector3 &value)
+{
+       const Transform::AngleVector3 &euler = kf.get_transform().get_euler();
+       value = Vector3(euler.x.radians(), euler.y.radians(), euler.z.radians());
+       return true;
+}
+
+bool Animation::extract_scale(const KeyFrame &kf, Vector3 &value)
+{
+       value = kf.get_transform().get_scale();
+       return true;
 }
 
 void Animation::add_event(const Time::TimeDelta &t, const string &n, const Variant &v)
@@ -114,139 +210,75 @@ void Animation::add_event(const Time::TimeDelta &t, const string &n, const Varia
        events.push_back(event);
 }
 
+const Time::TimeDelta &Animation::get_duration() const
+{
+       if(keyframes.empty())
+               return Time::zero;
+
+       return keyframes.back().time;
+}
+
 void Animation::set_looping(bool l)
 {
        looping = l;
 }
 
 
-Animation::AxisInterpolation::AxisInterpolation():
-       slope(0),
-       scale(0)
+Animation::Curve::Curve(CurveTarget t):
+       target(t)
 { }
 
-Animation::AxisInterpolation::AxisInterpolation(const float *axis1, const float *axis2)
-{
-       // Compute a normalized vector halfway between the two endpoints
-       float a1_len = 0;
-       float h_len = 0;
-       float cos_half = 0;
-       for(unsigned i=0; i<3; ++i)
-       {
-               float half_i = (axis1[i]+axis2[i])/2;
-               cos_half += axis1[i]*half_i;
-               a1_len += axis1[i]*axis1[i];
-               h_len += half_i*half_i;
-       }
-
-       // Compute correction factors for smooth interpolation
-       cos_half = min(max(cos_half/sqrt(a1_len*h_len), -1.0f), 1.0f);
-       float angle = acos(cos_half);
-       slope = (angle ? angle/tan(angle) : 1);
-       scale = cos_half;
-}
-
 
-Animation::MatrixInterpolation::MatrixInterpolation():
-       matrix1(0),
-       matrix2(0)
+template<unsigned N>
+Animation::ValueCurve<N>::ValueCurve(CurveTarget t, const vector<Knot> &k):
+       Curve(t),
+       spline(Interpolate::BezierSpline<float, 3, N>(k))
 { }
 
-Animation::MatrixInterpolation::MatrixInterpolation(const Matrix &m1, const Matrix &m2):
-       matrix1(&m1),
-       matrix2(&m2)
+template<unsigned N>
+void Animation::ValueCurve<N>::apply(float, Matrix &) const
 {
-       const float *m1_data = matrix1->data();
-       const float *m2_data = matrix2->data();
-       for(unsigned i=0; i<3; ++i)
-               axes[i] = AxisInterpolation(m1_data+i*4, m2_data+i*4);
+       throw invalid_operation("ValueCurve::apply");
 }
 
-Matrix Animation::MatrixInterpolation::get(float t) const
+template<>
+void Animation::ValueCurve<3>::apply(float x, Matrix &matrix) const
 {
-       float u = t*2.0f-1.0f;
-
-       float matrix[16];
-       for(unsigned i=0; i<4; ++i)
+       Vector3 value = spline(x);
+       if(target==POSITION)
+               matrix.translate(value);
+       else if(target==EULER)
        {
-               const float *m1_col = matrix1->data()+i*4;
-               const float *m2_col = matrix2->data()+i*4;
-               float *out_col = matrix+i*4;
-
-               if(i<3)
-               {
-                       /* Linear interpolation will produce vectors that fall on the line
-                       between the two endpoints, and has a higher angular velocity near the
-                       middle.  We compensate for the velocity by interpolating the angle
-                       around the halfway point and computing its tangent.  This is
-                       approximated by a third degree polynomial, scaled so that the result
-                       will be in the range [-1, 1]. */
-                       float w = (axes[i].slope+(1-axes[i].slope)*u*u)*u*0.5f+0.5f;
-
-                       /* The interpolated vectors will also be shorter than unit length.  At
-                       the halfway point the length will be equal to the cosine of half the
-                       angle, which was computed earlier.  Use a second degree polynomial to
-                       approximate. */
-                       float n = (axes[i].scale+(1-axes[i].scale)*u*u);
-
-                       for(unsigned j=0; j<3; ++j)
-                               out_col[j] = ((1-w)*m1_col[j]+w*m2_col[j])/n;
-               }
-               else
-               {
-                       for(unsigned j=0; j<3; ++j)
-                               out_col[j] = (1-t)*m1_col[j]+t*m2_col[j];
-               }
+               matrix.rotate(value.z, Vector3(0, 0, 1));
+               matrix.rotate(value.y, Vector3(0, 1, 0));
+               matrix.rotate(value.x, Vector3(1, 0, 0));
        }
-
-       matrix[3] = 0;
-       matrix[7] = 0;
-       matrix[11] = 0;
-       matrix[15] = 1;
-
-       return matrix;
+       else if(target==SCALE)
+               matrix.scale(value);
+       else
+               throw invalid_operation("ValueCurve::apply");
 }
 
-
-Animation::TimedKeyFrame::TimedKeyFrame():
-       prev(0),
-       start_slope(1),
-       end_slope(1)
-{ }
-
-void Animation::TimedKeyFrame::prepare(const Animation &animation)
+template<unsigned N>
+void Animation::ValueCurve<N>::apply(float x, KeyFrame::AnimatedUniform &uni) const
 {
-       const KeyFrame::UniformMap &kf_uniforms = keyframe->get_uniforms();
-       for(KeyFrame::UniformMap::const_iterator i=kf_uniforms.begin(); i!=kf_uniforms.end(); ++i)
-       {
-               unsigned j = animation.get_slot_for_uniform(i->first);
-               uniforms.reserve(j+1);
-               for(unsigned k=uniforms.size(); k<=j; ++k)
-                       uniforms.push_back(KeyFrame::AnimatedUniform(animation.uniforms[k].size, 0.0f));
-
-               uniforms[j] = i->second;
-       }
+       uni.size = N;
+       typename Interpolate::Spline<float, 3, N>::Value value = spline(x);
+       for(unsigned i=0; i<N; ++i)
+               uni.values[i] = Interpolate::SplineValue<float, N>::get(value, i);
+}
 
-       if(!prev)
-               return;
 
-       delta_t = time-prev->time;
-       matrix = MatrixInterpolation(prev->keyframe->get_matrix(), keyframe->get_matrix());
+template<unsigned N>
+bool Animation::ExtractUniform<N>::operator()(const KeyFrame &kf, typename Interpolate::SplineValue<float, N>::Type &value) const
+{
+       const KeyFrame::UniformMap &kf_uniforms = kf.get_uniforms();
+       const KeyFrame::UniformMap::const_iterator i = kf_uniforms.find(name);
+       if(i==kf_uniforms.end())
+               return false;
 
-       if(animation.armature)
-       {
-               unsigned max_index = animation.armature->get_max_link_index();
-               pose_matrices.resize(max_index+1);
-               const Pose *pose1 = prev->keyframe->get_pose();
-               const Pose *pose2 = keyframe->get_pose();
-               static Matrix identity;
-               for(unsigned i=0; i<=max_index; ++i)
-               {
-                       const Matrix &matrix1 = (pose1 ? pose1->get_link_matrix(i) : identity);
-                       const Matrix &matrix2 = (pose2 ? pose2->get_link_matrix(i) : identity);
-                       pose_matrices[i] = MatrixInterpolation(matrix1, matrix2);
-               }
-       }
+       value = Interpolate::SplineValue<float, N>::make(i->second.values);
+       return true;
 }
 
 
@@ -258,82 +290,54 @@ Animation::UniformInfo::UniformInfo(const string &n, unsigned s):
 
 Animation::Iterator::Iterator(const Animation &a):
        animation(&a),
-       iter(animation->keyframes.begin()),
        event_iter(animation->events.begin()),
-       x(0),
        end(false)
-{ }
+{
+}
 
 Animation::Iterator &Animation::Iterator::operator+=(const Time::TimeDelta &t)
 {
-       time_since_keyframe += t;
-       while(time_since_keyframe>iter->delta_t)
-       {
-               vector<TimedKeyFrame>::const_iterator next = iter;
-               ++next;
-               if(next==animation->keyframes.end())
-               {
-                       if(animation->looping)
-                               next = animation->keyframes.begin();
-                       else
-                       {
-                               end = true;
-                               time_since_keyframe = iter->delta_t;
-                               break;
-                       }
-               }
+       const Time::TimeDelta &duration = animation->get_duration();
+       if(!duration)
+               return *this;
 
-               time_since_keyframe -= iter->delta_t;
-               iter = next;
+       elapsed += t;
+       if(animation->looping)
+       {
+               while(elapsed>=duration)
+                       elapsed -= duration;
+       }
+       else if(elapsed>=duration)
+       {
+               end = true;
+               elapsed = duration;
        }
-
-       x = time_since_keyframe/iter->delta_t;
-       x += (iter->start_slope-1)*((x-2)*x+1)*x + (1-iter->end_slope)*(1-x)*x*x;
 
        return *this;
 }
 
 void Animation::Iterator::dispatch_events(AnimationEventObserver &observer)
 {
-       vector<Event>::const_iterator events_end = animation->events.end();
-       if(end)
-       {
-               for(; event_iter!=events_end; ++event_iter)
-                       observer.animation_event(0, event_iter->name, event_iter->value);
-       }
-       else if(event_iter!=events_end)
-       {
-               Time::TimeDelta t = time_since_keyframe;
-               if(iter->prev)
-                       t += iter->prev->time;
-               for(; (event_iter!=events_end && event_iter->time<=t); ++event_iter)
-                       observer.animation_event(0, event_iter->name, event_iter->value);
-       }
+       for(; (event_iter!=animation->events.end() && event_iter->time<=elapsed); ++event_iter)
+               observer.animation_event(0, event_iter->name, event_iter->value);
 }
 
 Matrix Animation::Iterator::get_matrix() const
 {
-       if(!iter->prev)
-               return iter->keyframe->get_matrix();
-
-       return iter->matrix.get(x);
+       Matrix matrix;
+       for(unsigned i=0; i<3; ++i)
+               animation->curves[i]->apply(elapsed/Time::sec, matrix);
+       return matrix;
 }
 
 KeyFrame::AnimatedUniform Animation::Iterator::get_uniform(unsigned i) const
 {
-       if(!iter->prev)
-       {
-               if(iter->uniforms.size()>i)
-                       return iter->uniforms[i];
-               else
-                       return KeyFrame::AnimatedUniform(animation->uniforms[i].size, 0.0f);
-       }
+       if(i>=animation->uniforms.size())
+               throw out_of_range("Animation::Iterator::get_uniform");
 
-       unsigned size = animation->uniforms[i].size;
-       KeyFrame::AnimatedUniform result(size, 0.0f);
-       for(unsigned j=0; j<size; ++j)
-               result.values[j] = iter->prev->uniforms[i].values[j]*(1-x)+iter->uniforms[i].values[j]*x;
-       return result;
+       KeyFrame::AnimatedUniform uni(animation->uniforms[i].size, 0.0f);
+       animation->curves[3+i]->apply(elapsed/Time::sec, uni);
+       return uni;
 }
 
 Matrix Animation::Iterator::get_pose_matrix(unsigned link) const
@@ -343,21 +347,7 @@ Matrix Animation::Iterator::get_pose_matrix(unsigned link) const
        if(link>animation->armature->get_max_link_index())
                throw out_of_range("Animation::Iterator::get_pose_matrix");
 
-       if(!iter->prev)
-       {
-               if(const Pose *pose = iter->keyframe->get_pose())
-                       return pose->get_link_matrix(link);
-               else
-                       return Matrix();
-       }
-
-       // We must redo the base point correction since interpolation throws it off
-       // XXX This should probably be done on local matrices
-       Matrix result = iter->pose_matrices[link].get(x);
-       const Vector3 &base = animation->armature->get_link(link).get_base();
-       Vector3 new_base = result*base;
-       result = Matrix::translation(base-new_base)*result;
-       return result;
+       throw logic_error("pose animations are currently unimplemented");
 }
 
 
@@ -378,6 +368,8 @@ void Animation::Loader::init()
        start_slope = 1;
        end_slope = 1;
        add("armature", &Animation::armature);
+       add("control_keyframe", &Loader::control_keyframe);
+       add("control_keyframe", &Loader::control_keyframe_inline);
        add("event", &Loader::event);
        add("event", &Loader::event1i);
        add("event", &Loader::event1f);
@@ -391,6 +383,38 @@ void Animation::Loader::init()
        add("slopes", &Loader::slopes);
 }
 
+void Animation::Loader::finish()
+{
+       obj.create_curves();
+}
+
+void Animation::Loader::load_kf(const string &n, bool c)
+{
+       obj.add_keyframe(current_time, &get_collection().get<KeyFrame>(n), c, false);
+}
+
+void Animation::Loader::load_kf_inline(bool c)
+{
+       RefPtr<KeyFrame> kf = new KeyFrame;
+       if(coll)
+               load_sub(*kf, get_collection());
+       else
+               load_sub(*kf);
+
+       obj.add_keyframe(current_time, *kf, c, true);
+       kf.release();
+}
+
+void Animation::Loader::control_keyframe(const string &n)
+{
+       load_kf(n, true);
+}
+
+void Animation::Loader::control_keyframe_inline()
+{
+       load_kf_inline(true);
+}
+
 void Animation::Loader::event(const string &n)
 {
        obj.add_event(current_time, n);
@@ -428,22 +452,12 @@ void Animation::Loader::interval(float t)
 
 void Animation::Loader::keyframe(const string &n)
 {
-       obj.add_keyframe(current_time, get_collection().get<KeyFrame>(n), start_slope, end_slope);
-       start_slope = end_slope;
-       end_slope = 1;
+       load_kf(n, false);
 }
 
 void Animation::Loader::keyframe_inline()
 {
-       RefPtr<KeyFrame> kf = new KeyFrame;
-       if(coll)
-               load_sub(*kf, get_collection());
-       else
-               load_sub(*kf);
-
-       obj.add_keyframe(current_time, kf, start_slope, end_slope);
-       start_slope = end_slope;
-       end_slope = 1;
+       load_kf_inline(false);
 }
 
 void Animation::Loader::slopes(float s, float e)