src/hb-cff2-interp-cs.hh

   1 /*
   2  * Copyright © 2018 Adobe Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Adobe Author(s): Michiharu Ariza
  25  */
  26 #ifndef HB_CFF2_INTERP_CS_HH
  27 #define HB_CFF2_INTERP_CS_HH
  28
  29 #include "hb.hh"
  30 #include "hb-cff-interp-cs-common.hh"
  31
  32 namespace CFF {
  33
  34 using namespace OT;
  35
  36 struct blend_arg_t : number_t
  37 {
  38   void init ()
  39   {
  40     number_t::init ();
  41     deltas.init ();
  42   }
  43
  44   void fini ()
  45   {
  46     number_t::fini ();
  47     deltas.fini_deep ();
  48   }
  49
  50   void set_int (int v) { reset_blends (); number_t::set_int (v); }
  51   void set_fixed (int32_t v) { reset_blends (); number_t::set_fixed (v); }
  52   void set_real (double v) { reset_blends (); number_t::set_real (v); }
  53
  54   void set_blends (unsigned int numValues_, unsigned int valueIndex_,
  55                           unsigned int numBlends, hb_array_t<const blend_arg_t> blends_)
  56   {
  57     numValues = numValues_;
  58     valueIndex = valueIndex_;
  59     deltas.resize (numBlends);
  60     for (unsigned int i = 0; i < numBlends; i++)
  61       deltas[i] = blends_[i];
  62   }
  63
  64   bool blending () const { return deltas.length > 0; }
  65   void reset_blends ()
  66   {
  67     numValues = valueIndex = 0;
  68     deltas.resize (0);
  69   }
  70
  71   unsigned int numValues;
  72   unsigned int valueIndex;
  73   hb_vector_t<number_t> deltas;
  74 };
  75
  76 typedef interp_env_t<blend_arg_t> BlendInterpEnv;
  77 typedef biased_subrs_t<CFF2Subrs>   cff2_biased_subrs_t;
  78
  79 struct cff2_cs_interp_env_t : cs_interp_env_t<blend_arg_t, CFF2Subrs>
  80 {
  81   template <typename ACC>
  82   void init (const byte_str_t &str, ACC &acc, unsigned int fd,
  83              const int *coords_=nullptr, unsigned int num_coords_=0)
  84   {
  85     SUPER::init (str, acc.globalSubrs, acc.privateDicts[fd].localSubrs);
  86
  87     coords = coords_;
  88     num_coords = num_coords_;
  89     varStore = acc.varStore;
  90     seen_blend = false;
  91     seen_vsindex_ = false;
  92     scalars.init ();
  93     do_blend = num_coords && coords && varStore->size;
  94     set_ivs (acc.privateDicts[fd].ivs);
  95   }
  96
  97   void fini ()
  98   {
  99     scalars.fini ();
 100     SUPER::fini ();
 101   }
 102
 103   op_code_t fetch_op ()
 104   {
 105     if (this->str_ref.avail ())
 106       return SUPER::fetch_op ();
 107
 108     /* make up return or endchar op */
 109     if (this->callStack.is_empty ())
 110       return OpCode_endchar;
 111     else
 112       return OpCode_return;
 113   }
 114
 115   const blend_arg_t& eval_arg (unsigned int i)
 116   {
 117     blend_arg_t  &arg = argStack[i];
 118     blend_arg (arg);
 119     return arg;
 120   }
 121
 122   const blend_arg_t& pop_arg ()
 123   {
 124     blend_arg_t  &arg = argStack.pop ();
 125     blend_arg (arg);
 126     return arg;
 127   }
 128
 129   void process_blend ()
 130   {
 131     if (!seen_blend)
 132     {
 133       region_count = varStore->varStore.get_region_index_count (get_ivs ());
 134       if (do_blend)
 135       {
 136         scalars.resize (region_count);
 137         varStore->varStore.get_scalars (get_ivs (), coords, num_coords,
 138                                         &scalars[0], region_count);
 139       }
 140       seen_blend = true;
 141     }
 142   }
 143
 144   void process_vsindex ()
 145   {
 146     unsigned int  index = argStack.pop_uint ();
 147     if (unlikely (seen_vsindex () || seen_blend))
 148     {
 149       set_error ();
 150     }
 151     else
 152     {
 153       set_ivs (index);
 154     }
 155     seen_vsindex_ = true;
 156   }
 157
 158   unsigned int get_region_count () const { return region_count; }
 159   void   set_region_count (unsigned int region_count_) { region_count = region_count_; }
 160   unsigned int get_ivs () const { return ivs; }
 161   void   set_ivs (unsigned int ivs_) { ivs = ivs_; }
 162   bool   seen_vsindex () const { return seen_vsindex_; }
 163
 164   protected:
 165   void blend_arg (blend_arg_t &arg)
 166   {
 167     if (do_blend && arg.blending ())
 168     {
 169       if (likely (scalars.length == arg.deltas.length))
 170       {
 171         double v = arg.to_real ();
 172         for (unsigned int i = 0; i < scalars.length; i++)
 173         {
 174           v += (double)scalars[i] * arg.deltas[i].to_real ();
 175         }
 176         arg.set_real (v);
 177         arg.deltas.resize (0);
 178       }
 179     }
 180   }
 181
 182   protected:
 183   const int     *coords;
 184   unsigned int  num_coords;
 185   const  CFF2VariationStore *varStore;
 186   unsigned int  region_count;
 187   unsigned int  ivs;
 188   hb_vector_t<float>  scalars;
 189   bool    do_blend;
 190   bool    seen_vsindex_;
 191   bool    seen_blend;
 192
 193   typedef cs_interp_env_t<blend_arg_t, CFF2Subrs> SUPER;
 194 };
 195 template <typename OPSET, typename PARAM, typename PATH=path_procs_null_t<cff2_cs_interp_env_t, PARAM>>
 196 struct cff2_cs_opset_t : cs_opset_t<blend_arg_t, OPSET, cff2_cs_interp_env_t, PARAM, PATH>
 197 {
 198   static void process_op (op_code_t op, cff2_cs_interp_env_t &env, PARAM& param)
 199   {
 200     switch (op) {
 201       case OpCode_callsubr:
 202       case OpCode_callgsubr:
 203         /* a subroutine number shoudln't be a blended value */
 204         if (unlikely (env.argStack.peek ().blending ()))
 205         {
 206           env.set_error ();
 207           break;
 208         }
 209         SUPER::process_op (op, env, param);
 210         break;
 211
 212       case OpCode_blendcs:
 213         OPSET::process_blend (env, param);
 214         break;
 215
 216       case OpCode_vsindexcs:
 217         if (unlikely (env.argStack.peek ().blending ()))
 218         {
 219           env.set_error ();
 220           break;
 221         }
 222         OPSET::process_vsindex (env, param);
 223         break;
 224
 225       default:
 226         SUPER::process_op (op, env, param);
 227     }
 228   }
 229
 230   static void process_blend (cff2_cs_interp_env_t &env, PARAM& param)
 231   {
 232     unsigned int n, k;
 233
 234     env.process_blend ();
 235     k = env.get_region_count ();
 236     n = env.argStack.pop_uint ();
 237     /* copy the blend values into blend array of the default values */
 238     unsigned int start = env.argStack.get_count () - ((k+1) * n);
 239     /* let an obvious error case fail, but note CFF2 spec doesn't forbid n==0 */
 240     if (unlikely (start > env.argStack.get_count ()))
 241     {
 242       env.set_error ();
 243       return;
 244     }
 245     for (unsigned int i = 0; i < n; i++)
 246     {
 247       const hb_array_t<const blend_arg_t>       blends = env.argStack.get_subarray (start + n + (i * k));
 248       env.argStack[start + i].set_blends (n, i, k, blends);
 249     }
 250
 251     /* pop off blend values leaving default values now adorned with blend values */
 252     env.argStack.pop (k * n);
 253   }
 254
 255   static void process_vsindex (cff2_cs_interp_env_t &env, PARAM& param)
 256   {
 257     env.process_vsindex ();
 258     env.clear_args ();
 259   }
 260
 261   private:
 262   typedef cs_opset_t<blend_arg_t, OPSET, cff2_cs_interp_env_t, PARAM, PATH>  SUPER;
 263 };
 264
 265 template <typename OPSET, typename PARAM>
 266 struct cff2_cs_interpreter_t : cs_interpreter_t<cff2_cs_interp_env_t, OPSET, PARAM> {};
 267
 268 } /* namespace CFF */
 269
 270 #endif /* HB_CFF2_INTERP_CS_HH */