dali/internal/text/text-abstraction/cairo-renderer.cpp

   1 /*
   2  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   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  */
  17
  18 // FILE HEADER
  19 #include <dali/internal/text/text-abstraction/cairo-renderer.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/constants.h>
  23 #include <cairo.h>
  24 #include <cairo-ft.h>
  25 #include <cstring>
  26 #include <memory>
  27
  28 #include <ft2build.h>
  29 #include FT_FREETYPE_H
  30 #include FT_GLYPH_H
  31 #include FT_OUTLINE_H
  32 #include FT_STROKER_H
  33
  34 // INTERNAL INCLUDES
  35 #include <dali/devel-api/text-abstraction/font-client.h>
  36 #include <dali/devel-api/text-abstraction/text-renderer-layout-helper.h>
  37 #include <dali/integration-api/debug.h>
  38 #include <dali/internal/imaging/common/image-operations.h>
  39 #include <dali/internal/text/text-abstraction/font-client-impl.h>
  40
  41 namespace
  42 {
  43
  44 const float TO_FLOAT = 1.f / 255.f;
  45 const float TO_UCHAR = 255.f;
  46 const float TWO_PI = 2.f * Dali::Math::PI; ///< 360 degrees in radians
  47
  48 /**
  49  * @brief Run of glyphs that have the same style.
  50  */
  51 struct GlyphRun
  52 {
  53   GlyphRun()
  54   : fontFace{ nullptr },
  55     fontSize{ 0.0 },
  56     glyphIndex{ 0u },
  57     numberOfGlyphs{ 0u },
  58     fontId{ 0u },
  59     colorIndex{ 0u },
  60     isItalicRequired{ false },
  61     isBoldRequired{ false }
  62   {}
  63
  64   FT_Face      fontFace;           ///< The font face used by the glyphs in the run.
  65   double       fontSize;           ///< The font size used by the glyphs in the run. According the Cairo's documentation this is in user space units. It works if I set the size in pixels.
  66   unsigned int glyphIndex;         ///< Index to the first glyph of the run.
  67   unsigned int numberOfGlyphs;     ///< Number of glyphs in the run.
  68   unsigned int fontId;             ///< The id of the font.
  69   unsigned int colorIndex;         ///< The index to the color of the glyphs.
  70   bool         isItalicRequired:1; ///< Whether the italic style is required.
  71   bool         isBoldRequired:1;   ///< Whether the bold style is required.
  72 };
  73
  74 /**
  75  * @brief Helper struct used to destroy a bitmap buffer.
  76  *
  77  * The font client allocates a bitmap's buffer with the new operator.
  78  * However, the PixelBuffer class allocates the buffer with the
  79  * malloc() function and the Rotate() function which is intended
  80  * for the PixelBuffer as well allocates memory with malloc().
  81  *
  82  * This struct keeps the type of allocation and uses the delete[]
  83  * operator or the free() function to deallocate resources.
  84  */
  85 struct GlyphBuffer
  86 {
  87   enum DestructorType
  88   {
  89     FREE,
  90     DELETE
  91   };
  92
  93   GlyphBuffer( Dali::TextAbstraction::FontClient::GlyphBufferData& data, DestructorType type )
  94   : data( data ),
  95     type( type )
  96   {
  97   }
  98
  99   ~GlyphBuffer()
 100   {
 101     switch( type )
 102     {
 103       case FREE:
 104       {
 105         free( data.buffer );
 106         break;
 107       }
 108       case DELETE:
 109       {
 110         delete[] data.buffer;
 111       }
 112     }
 113   }
 114
 115   Dali::TextAbstraction::FontClient::GlyphBufferData& data;
 116   DestructorType type;
 117 };
 118
 119 /**
 120  * @brief Creates a pixel buffer with all pixels set to transparent.
 121  *
 122  * @param[in] parameters Contains the width and height of the pixel buffer.
 123  *
 124  * @return The pixel buffer.
 125  */
 126 Dali::Devel::PixelBuffer CreateVoidPixelBuffer( const Dali::TextAbstraction::TextRenderer::Parameters& parameters )
 127 {
 128   Dali::Pixel::Format pixelFormat = parameters.pixelFormat == Dali::TextAbstraction::TextRenderer::Parameters::A8 ? Dali::Pixel::A8 : Dali::Pixel::RGBA8888;
 129   Dali::Devel::PixelBuffer pixelBuffer = Dali::Devel::PixelBuffer::New( parameters.width,
 130                                                                         parameters.height,
 131                                                                         pixelFormat );
 132
 133   const unsigned int bufferSize = parameters.width * parameters.height * Dali::Pixel::GetBytesPerPixel( pixelFormat );
 134   unsigned char* buffer = pixelBuffer.GetBuffer();
 135   memset( buffer, 0, bufferSize );
 136
 137   return pixelBuffer;
 138 }
 139
 140 /**
 141  * @brief Wraps the vertices of glyphs laid out on a horizontal strainght line on a circular path.
 142  *
 143  * It copies the vertices from the extra cairo context created to lay out the text
 144  * on a horizontal straight line to the cairo context used to render it.
 145  *
 146  * @param[in,out] cr The cairo context used to render the text.
 147  * @param[in] circularCr The extra cairo context created to layout horizontal text.
 148  * @param[in] parameters The parameters of the circular path.
 149  */
 150 void WrapToCircularPath( cairo_t* cr, cairo_t* circularCr, const Dali::TextAbstraction::CircularTextParameters& parameters )
 151 {
 152   bool first = true;
 153
 154   // Copy the path to get a cairo_path_t pointer used to iterate through all its items.
 155   std::unique_ptr<cairo_path_t, void(*)(cairo_path_t*)> path( cairo_copy_path( circularCr ), cairo_path_destroy );
 156
 157   void ( *transformToArc )( const Dali::TextAbstraction::CircularTextParameters&, double&, double& );
 158   transformToArc = parameters.isClockwise ? &Dali::TextAbstraction::TransformToArcClockwise : &Dali::TextAbstraction::TransformToArcAntiClockwise;
 159
 160   // Iterates through all the path items and transform each vertex to follow the circle.
 161   // Transformed vertices are added to a new path in the 'cr' context (the one used to render the circular text)
 162   for( int i = 0; i < path->num_data; i += path->data[i].header.length )
 163   {
 164     cairo_path_data_t* data = &path->data[i];
 165
 166     switch( data->header.type )
 167     {
 168       case CAIRO_PATH_MOVE_TO:
 169       {
 170         if( first )
 171         {
 172           cairo_new_path( cr );
 173         }
 174
 175         first = false;
 176         double x = data[1].point.x;
 177         double y = data[1].point.y;
 178         transformToArc( parameters, x, y );
 179         cairo_move_to( cr, x, y );
 180         break;
 181       }
 182       case CAIRO_PATH_LINE_TO:
 183       {
 184         double x = data[1].point.x;
 185         double y = data[1].point.y;
 186         transformToArc( parameters, x, y );
 187         cairo_line_to( cr, x, y );
 188         break;
 189       }
 190       case CAIRO_PATH_CURVE_TO:
 191       {
 192         double x1 = data[1].point.x;
 193         double y1 = data[1].point.y;
 194         double x2 = data[2].point.x;
 195         double y2 = data[2].point.y;
 196         double x3 = data[3].point.x;
 197         double y3 = data[3].point.y;
 198         transformToArc( parameters, x1, y1 );
 199         transformToArc( parameters, x2, y2 );
 200         transformToArc( parameters, x3, y3 );
 201         cairo_curve_to( cr, x1, y1, x2, y2, x3, y3 );
 202         break;
 203       }
 204       case CAIRO_PATH_CLOSE_PATH:
 205       {
 206         cairo_close_path( cr );
 207         break;
 208       }
 209       default:
 210       {
 211         DALI_LOG_WARNING( "Type of path not handled.\n" );
 212         // Nothing else to do.
 213         break;
 214       }
 215     }
 216   }
 217 }
 218
 219 } // namespace
 220
 221 namespace Dali
 222 {
 223
 224 namespace TextAbstraction
 225 {
 226
 227 namespace Internal
 228 {
 229
 230 Devel::PixelBuffer RenderTextCairo( const TextAbstraction::TextRenderer::Parameters& parameters )
 231 {
 232   const unsigned int numberOfGlyphs = parameters.glyphs.Count();
 233
 234   if( 0u == numberOfGlyphs )
 235   {
 236     // return a pixel buffer with all pixels set to transparent.
 237     return CreateVoidPixelBuffer( parameters );
 238   }
 239
 240   // Convert from DALi glyphs to Cairo glyphs.
 241   std::vector<cairo_glyph_t> cairoGlyphs;
 242   cairoGlyphs.resize( numberOfGlyphs );
 243   cairo_glyph_t* cairoGlyphsBuffer = &cairoGlyphs[0u];
 244
 245   const GlyphInfo* const daliGlyphsBuffer = parameters.glyphs.Begin();
 246   const Vector2* const positionsBuffer = parameters.positions.Begin();
 247   const ColorIndex* const colorIndicesBuffer = ( 0u == parameters.colorIndices.Count() ) ? nullptr : parameters.colorIndices.Begin();
 248
 249   for( unsigned index = 0u; index < numberOfGlyphs; ++index )
 250   {
 251     const GlyphInfo& daliGlyph = *( daliGlyphsBuffer + index );
 252     const Vector2& position = *( positionsBuffer + index );
 253     cairo_glyph_t& cairoGlyph = *( cairoGlyphsBuffer + index );
 254
 255     cairoGlyph.index = daliGlyph.index;
 256     cairoGlyph.x = std::round( position.x );
 257     cairoGlyph.y = std::round( position.y );
 258   }
 259
 260   // Retrieve the FreeType fonts needed by Cairo from the font-client.
 261   Dali::TextAbstraction::FontClient fontClient = Dali::TextAbstraction::FontClient::Get();
 262
 263   FT_Library ftLibrary;
 264   auto error = FT_Init_FreeType(&ftLibrary);
 265   if( error )
 266   {
 267     DALI_LOG_ERROR( "Error initializing FT library\n" );
 268     return CreateVoidPixelBuffer( parameters );
 269   }
 270
 271   // Vector used to store the FreeType font faces, its size and the run of glyphs that use the font.
 272   std::vector<GlyphRun> glyphRuns;
 273   glyphRuns.reserve( 8u );
 274
 275   // The size set in Cairo and FreeType has different units.
 276   // Before the size is set in Cairo it needs to be converted according the formula
 277   // 'pixel_size = point_size * resolution / 72' got from the FreeType doc.
 278   // https://www.freetype.org/freetype2/docs/glyphs/glyphs-2.html
 279
 280   unsigned int horizontalDpi = 0u;
 281   unsigned int verticalDpi = 0u;
 282   fontClient.GetDpi( horizontalDpi, verticalDpi );
 283   const double dVerticalDpi = static_cast<double>( verticalDpi );
 284
 285   const double FROM_26_DOT_6_TO_PIXELS = dVerticalDpi / ( 64.0 * 72.0 );
 286
 287   GlyphRun currentGlyphRun;
 288   currentGlyphRun.fontId = 0u;
 289   currentGlyphRun.colorIndex = 0u;
 290   currentGlyphRun.isItalicRequired = false;
 291   currentGlyphRun.isBoldRequired = false;
 292   for( unsigned index = 0u; index < numberOfGlyphs; ++index )
 293   {
 294     const GlyphInfo& daliGlyph = *( daliGlyphsBuffer + index );
 295     const FontId fontId = daliGlyph.fontId;
 296     const ColorIndex colorIndex = ( nullptr == colorIndicesBuffer ) ? 0u : *( colorIndicesBuffer + index );
 297     const bool isItalicRequired = daliGlyph.isItalicRequired;
 298     const bool isBoldRequired = daliGlyph.isBoldRequired;
 299
 300     if( ( fontId != currentGlyphRun.fontId ) ||
 301         ( ( 0u == fontId ) && ( 0u != daliGlyph.index ) ) ||
 302         ( colorIndex != currentGlyphRun.colorIndex ) ||
 303         ( isItalicRequired != currentGlyphRun.isItalicRequired ) ||
 304         ( isBoldRequired != currentGlyphRun.isBoldRequired ) )
 305     {
 306       // There is a new run. First set the number of glyphs of the previous run and store it.
 307       currentGlyphRun.numberOfGlyphs = index - currentGlyphRun.glyphIndex;
 308       if( 0u != currentGlyphRun.numberOfGlyphs )
 309       {
 310         glyphRuns.push_back( currentGlyphRun );
 311       }
 312
 313       currentGlyphRun.fontFace = nullptr;
 314       currentGlyphRun.fontSize = 0.0;
 315       currentGlyphRun.glyphIndex = index;
 316       currentGlyphRun.numberOfGlyphs = 0u;
 317       currentGlyphRun.fontId = 0u;
 318       currentGlyphRun.colorIndex = 0u;
 319       currentGlyphRun.isItalicRequired = false;
 320       currentGlyphRun.isBoldRequired = false;
 321
 322       if( 0u != fontId )
 323       {
 324         // Get the font's path file name from the font Id.
 325         FontDescription fontDescription;
 326         fontClient.GetDescription( fontId, fontDescription );
 327
 328         switch( fontDescription.type )
 329         {
 330           case FontDescription::FACE_FONT:
 331           {
 332             // Create a FreeType font's face.
 333             error = FT_New_Face( ftLibrary, fontDescription.path.c_str(), 0u, &currentGlyphRun.fontFace );
 334             if( error )
 335             {
 336               DALI_LOG_ERROR( "Error in FT while creating new face\n" );
 337               return CreateVoidPixelBuffer( parameters );
 338             }
 339
 340             // Set the font's size. It needs to be set in the Freetype font and in the Cairo's context.
 341             unsigned int fontSize = fontClient.GetPointSize( fontId );
 342
 343             // Font's size to be set in the Cairo's context.
 344             currentGlyphRun.fontSize = FROM_26_DOT_6_TO_PIXELS * static_cast<double>( fontSize );
 345             break;
 346           }
 347           case FontDescription::BITMAP_FONT:
 348           {
 349             //Nothing to do.
 350             break;
 351           }
 352           default:
 353           {
 354             //Nothing to do.
 355             break;
 356           }
 357         }
 358       }
 359       currentGlyphRun.fontId = fontId;
 360       currentGlyphRun.colorIndex = colorIndex;
 361       currentGlyphRun.isItalicRequired = isItalicRequired;
 362       currentGlyphRun.isBoldRequired = isBoldRequired;
 363     }
 364   }
 365
 366   // Calculate the number of glyphs of the last run and store it.
 367   currentGlyphRun.numberOfGlyphs = numberOfGlyphs - currentGlyphRun.glyphIndex;
 368   if( 0u != currentGlyphRun.numberOfGlyphs )
 369   {
 370     glyphRuns.push_back( currentGlyphRun );
 371   }
 372
 373   // Choose the pixel format to be used.
 374   //
 375   // @note Behdad wrote "Upper 8 bits maps to the fourth byte in a little-endian machine like the intels."
 376   //       https://lists.cairographics.org/archives/cairo/2006-March/006563.html
 377   //
 378   //       Here in practice Cairo's ARGB32 is like DALi's RGBA8888.
 379   //
 380   const bool isDstRgba = TextAbstraction::TextRenderer::Parameters::RGBA8888 == parameters.pixelFormat;
 381   const Pixel::Format pixelFormat = isDstRgba ? Pixel::Format::RGBA8888 : Pixel::Format::A8;
 382   const cairo_format_t cairoFormat = isDstRgba ? CAIRO_FORMAT_ARGB32 : CAIRO_FORMAT_A8;
 383
 384   // This function provides a stride value that will respect all alignment requirements of the
 385   // accelerated image-rendering code within cairo.
 386   const int stride = cairo_format_stride_for_width( cairoFormat,
 387                                                     static_cast<int>( parameters.width ) );
 388   const int strideWidth = stride / Pixel::GetBytesPerPixel( pixelFormat );
 389
 390   // Creates the pixel buffer and retrieves the buffer pointer used to create the Cairo's surface.
 391   Devel::PixelBuffer pixelBuffer = Devel::PixelBuffer::New( strideWidth, parameters.height, pixelFormat );
 392
 393   unsigned char* buffer = pixelBuffer.GetBuffer();
 394   const unsigned int bufferSize = stride * parameters.height;
 395   memset( buffer, 0, bufferSize );
 396
 397   std::unique_ptr<cairo_surface_t, void(*)(cairo_surface_t*)> surfacePtr( cairo_image_surface_create_for_data( buffer,
 398                                                                                                                cairoFormat,
 399                                                                                                                parameters.width,
 400                                                                                                                parameters.height,
 401                                                                                                                stride ),
 402                                                                           cairo_surface_destroy );
 403   cairo_surface_t* surface = surfacePtr.get();
 404
 405   if( ( nullptr == surface ) || ( CAIRO_STATUS_SUCCESS != cairo_surface_status( surface ) ) )
 406   {
 407     DALI_LOG_ERROR( "Failed to create a cairo's surface\n" );
 408
 409     return CreateVoidPixelBuffer( parameters );
 410   }
 411
 412   // Whether the text is circular.
 413   const bool isCircularText = 0u != parameters.radius;
 414
 415   // Creates a surface for circular text.
 416   //
 417   // The reason to create a surface for circular text is that the strategy
 418   // followed is to layout the text in a straight horizontal line and apply a
 419   // transform to each vertex that forms the geometry of the glyphs to place
 420   // and bend the glyphs accordingly to the circular path.
 421   //
 422   // As the glyphs are laid out first in a straight line they may exceed the
 423   // boundaries of the surface in that case cairo ignores them.
 424   std::unique_ptr<cairo_surface_t, void(*)(cairo_surface_t*)> circularSurfacePtr( nullptr, cairo_surface_destroy );
 425   cairo_surface_t* circularSurface = nullptr;
 426   if( isCircularText )
 427   {
 428     circularSurfacePtr.reset( cairo_surface_create_similar( surface,
 429                                                             CAIRO_CONTENT_ALPHA,
 430                                                             parameters.circularWidth,
 431                                                             parameters.circularHeight ) );
 432     circularSurface = circularSurfacePtr.get();
 433
 434     if( ( nullptr == circularSurface ) || ( CAIRO_STATUS_SUCCESS != cairo_surface_status( circularSurface ) ) )
 435     {
 436       DALI_LOG_ERROR( "Failed to create a cairo's circular surface\n" );
 437
 438       return CreateVoidPixelBuffer( parameters );
 439     }
 440   }
 441
 442   std::unique_ptr<cairo_t, void(*)(cairo_t*)> crPtr( cairo_create( surface ), cairo_destroy );
 443   cairo_t* cr = crPtr.get();
 444
 445   if( CAIRO_STATUS_SUCCESS != cairo_status( cr ) )
 446   {
 447     DALI_LOG_ERROR( "Failed to create a cairo context\n" );
 448
 449     return CreateVoidPixelBuffer( parameters );
 450   }
 451
 452   std::unique_ptr<cairo_t, void(*)(cairo_t*)> circularCrPtr( nullptr, cairo_destroy );
 453   cairo_t* circularCr = nullptr;
 454
 455   if( isCircularText )
 456   {
 457     circularCrPtr.reset( cairo_create( circularSurface ) );
 458     circularCr = circularCrPtr.get();
 459
 460     if( CAIRO_STATUS_SUCCESS != cairo_status( circularCr ) )
 461     {
 462       DALI_LOG_ERROR( "Failed to create a cairo context\n" );
 463
 464       return CreateVoidPixelBuffer( parameters );
 465     }
 466   }
 467
 468   CircularTextParameters circularTextParameters;
 469
 470   // Render the glyphs.
 471   if( isCircularText )
 472   {
 473     // Set the parameters.
 474     circularTextParameters.isClockwise = ( TextAbstraction::TextRenderer::Parameters::CLOCKWISE == parameters.circularLayout );
 475
 476     circularTextParameters.centerX = static_cast<double>( parameters.centerX );
 477     circularTextParameters.centerY = static_cast<double>( parameters.centerY );
 478     circularTextParameters.radius = static_cast<double>( parameters.radius );
 479     circularTextParameters.invRadius = 1.0 / circularTextParameters.radius;
 480     circularTextParameters.beginAngle = -parameters.beginAngle + Dali::Math::PI_2;
 481   }
 482
 483   cairo_move_to( cr, 0.0, 0.0 );
 484
 485   for( const auto& run: glyphRuns )
 486   {
 487     const bool isEmoji = parameters.isEmoji[run.glyphIndex];
 488     if( isEmoji || ( nullptr == run.fontFace ) )
 489     {
 490       // Retrieve the color for the glyph.
 491       const Vector4& color = parameters.colors[run.colorIndex];
 492
 493       const unsigned int lastGlyphIndex = run.glyphIndex + run.numberOfGlyphs;
 494       for( unsigned int index = run.glyphIndex; index < lastGlyphIndex; ++index )
 495       {
 496         // Whether it's a bitmap font.
 497         const bool doBlendWithTextColor = !isEmoji && ( ColorBlendingMode::MULTIPLY == parameters.blendingMode[index] );
 498
 499         // Check if there is an embedded image or a bitmap font image.
 500         const GlyphIndex glyphFontIndex = daliGlyphsBuffer[index].index;
 501         if( 0u != glyphFontIndex )
 502         {
 503           // The embedded image could be A8, RGBA8888 or BGRA8888.
 504           //
 505           // If the embedded image is RGBA8888 or BGRA8888 then the cairo's buffer is ARGB32. It's needed to convert from RGBA or BGRA to ARGB.
 506           // If the embedded image is A8 it's needed to check if the cairo's buffer is A8 or ARGB32 and do the conversion if needed.
 507
 508           const cairo_glyph_t& glyph = *( cairoGlyphsBuffer + index );
 509
 510           // Retrieve the image
 511           TextAbstraction::FontClient::GlyphBufferData data;
 512           std::unique_ptr<GlyphBuffer> glyphBufferPtr( new GlyphBuffer( data, GlyphBuffer::DELETE ) );
 513           if( isEmoji )
 514           {
 515             data.width = parameters.glyphs[run.glyphIndex].width;
 516             data.height = parameters.glyphs[run.glyphIndex].height;
 517           }
 518
 519           fontClient.CreateBitmap( run.fontId, glyphFontIndex, false, false, data, 0u );
 520
 521           if( nullptr == data.buffer )
 522           {
 523             // nothing else to do if there is no image.
 524             continue;
 525           }
 526
 527           // Calculate the position for the circular text.
 528           double glyphX = glyph.x;
 529           double glyphY = glyph.y;
 530
 531           if( isCircularText )
 532           {
 533             // Center of the bitmap.
 534             const double halfWidth = 0.5 * static_cast<double>( data.width );
 535             const double halfHeight = 0.5 * static_cast<double>( data.height );
 536
 537             double centerX = glyph.x + halfWidth;
 538             double centerY = glyph.y - halfHeight;
 539
 540             float radians = circularTextParameters.beginAngle + ( circularTextParameters.isClockwise ? -1.f : 1.f ) * ( Dali::Math::PI_2 + circularTextParameters.invRadius * centerX );
 541             radians = fmod( radians, TWO_PI );
 542             radians += ( radians < 0.f ) ? TWO_PI : 0.f;
 543
 544             void ( *transformToArc )( const CircularTextParameters&, double&, double& );
 545             transformToArc = circularTextParameters.isClockwise ? &TransformToArcClockwise : &TransformToArcAntiClockwise;
 546
 547             transformToArc( circularTextParameters, centerX, centerY );
 548
 549             uint8_t* pixelsOut = nullptr;
 550             unsigned int widthOut = data.width;
 551             unsigned int heightOut = data.height;
 552             const unsigned int pixelSize = Pixel::GetBytesPerPixel( data.format );
 553
 554             Dali::Internal::Platform::RotateByShear( data.buffer,
 555                                                      data.width,
 556                                                      data.height,
 557                                                      pixelSize,
 558                                                      radians,
 559                                                      pixelsOut,
 560                                                      widthOut,
 561                                                      heightOut );
 562             if( nullptr != pixelsOut )
 563             {
 564               delete[] data.buffer;
 565               data.buffer = pixelsOut;
 566               glyphBufferPtr.get()->type = GlyphBuffer::FREE;
 567               data.width = widthOut;
 568               data.height = heightOut;
 569             }
 570
 571             glyphX = centerX - 0.5 * static_cast<double>( data.width );
 572             glyphY = centerY + 0.5 * static_cast<double>( data.height );
 573           }
 574
 575
 576           if( ( Pixel::A8 != data.format ) &&
 577               ( Pixel::L8 != data.format ) &&
 578               ( Pixel::RGBA8888 != data.format ) &&
 579               ( Pixel::BGRA8888 != data.format ) )
 580           {
 581             DALI_LOG_ERROR( " Cairo Renderer: The valid pixel format for embedded items are A8 or RGBA8888\n" );
 582             continue;
 583           }
 584
 585           // Check if the item is out of the buffer.
 586           if( ( glyphX + static_cast<float>( data.width ) < 0.f ) ||
 587               ( glyphX > static_cast<float>( strideWidth ) ) ||
 588               ( glyphY < 0.f ) ||
 589               ( glyphY - static_cast<float>( data.height ) > static_cast<float>( parameters.height ) ) )
 590           {
 591             // The embedded item is completely out of the buffer.
 592             continue;
 593           }
 594
 595           const bool isSrcA = ( Pixel::A8 == data.format ) || ( Pixel::L8 == data.format );
 596           const bool isSrcRgba = Pixel::RGBA8888 == data.format;
 597           const bool isSrcBgra = Pixel::BGRA8888 == data.format;
 598
 599           // 0 -> image and cairo buffer are A8
 600           // 1 -> image is A8, cairo buffer is ARGB
 601           // 2 -> image is RGBA and cairo buffer is ARGB
 602           // 3 -> image is BGRA and cairo buffer is ARGB
 603           int rgbaCase = 0;
 604           if( isSrcA && isDstRgba )
 605           {
 606             rgbaCase = 1;
 607           }
 608           else if( isSrcRgba && isDstRgba )
 609           {
 610             rgbaCase = 2;
 611           }
 612           else if( isSrcBgra && isDstRgba )
 613           {
 614             rgbaCase = 3;
 615           }
 616           else if( ( isSrcRgba || isSrcBgra ) && !isDstRgba )
 617           {
 618             DALI_LOG_ERROR( "Cairo Renderer: The embedded image is RGBA or BGRA and the Cairo's buffer has been creates with A8 format!\n" );
 619             continue;
 620           }
 621
 622           // Select the cropped source image area to copy into the surface buffer
 623           unsigned int glyphUintX = 0u;
 624           unsigned int glyphUintY = 0u;
 625           unsigned int srcWidth = data.width;
 626           unsigned int srcHeight = data.height;
 627           unsigned int xSrcIndex = 0u;
 628           unsigned int ySrcIndex = 0u;
 629           if( glyphX < 0.f )
 630           {
 631             xSrcIndex = static_cast<unsigned int>( std::abs( glyphX ) );
 632             srcWidth -= xSrcIndex;
 633           }
 634           else
 635           {
 636             glyphUintX = static_cast<unsigned int>( glyphX );
 637           }
 638
 639           if( glyphUintX + srcWidth > static_cast<unsigned int>( strideWidth ) )
 640           {
 641             srcWidth -= ( ( glyphUintX + srcWidth ) - strideWidth );
 642           }
 643
 644           if( glyphY - static_cast<float>( srcHeight ) < 0.f )
 645           {
 646             ySrcIndex = static_cast<unsigned int>( std::abs( glyphY - static_cast<float>( srcHeight ) ) );
 647             srcHeight -= ySrcIndex;
 648           }
 649           else
 650           {
 651             glyphUintY = static_cast<unsigned int>( glyphY - static_cast<float>( srcHeight ) );
 652           }
 653
 654           if( glyphUintY + srcHeight > parameters.height )
 655           {
 656             srcHeight -= ( ( glyphUintY + srcHeight ) - parameters.height );
 657           }
 658
 659           // Calculate the source and destination indices.
 660           const unsigned int srcPixelSize = Pixel::GetBytesPerPixel( data.format );
 661           const unsigned int dstPixelSize = Pixel::GetBytesPerPixel( pixelFormat );
 662
 663           unsigned int srcIndex = srcPixelSize * ( ySrcIndex * srcWidth + xSrcIndex );
 664           unsigned int dstIndex = dstPixelSize * ( glyphUintY * strideWidth + glyphUintX );
 665
 666           const unsigned int srcWidthOffset = srcPixelSize * ( data.width - srcWidth );
 667           const unsigned int dstWidthOffset = dstPixelSize * ( strideWidth - srcWidth );
 668
 669           // Copy the image to the surface
 670           for( unsigned int j = 0; j < srcHeight; ++j )
 671           {
 672             for( unsigned int i = 0; i < srcWidth; ++i )
 673             {
 674               switch( rgbaCase )
 675               {
 676                 case 0: // Both the image's buffer and cairo's buffer are A8
 677                 {
 678                   const unsigned char alpha = *( data.buffer + srcIndex );
 679                   if( alpha != 0u )
 680                   {
 681                     // @todo needs a proper blending!
 682                     *( buffer + dstIndex ) = alpha;
 683                   }
 684                   break;
 685                 }
 686                 case 1: // The image's buffer is A8 and the cairo's buffer is ARGB
 687                 {
 688                   const unsigned char alpha = *( data.buffer + srcIndex );
 689                   if( alpha != 0u )
 690                   {
 691                     // @todo needs a proper blending!
 692                     const float srcAlpha = TO_FLOAT * static_cast<float>( alpha );
 693
 694                     // Write the RGBA modulated with the given default color.
 695                     const float* const colorPtr = color.AsFloat();
 696                     *( buffer + dstIndex + 0u ) = static_cast<unsigned char>( TO_UCHAR * colorPtr[0u] * srcAlpha );
 697                     *( buffer + dstIndex + 1u ) = static_cast<unsigned char>( TO_UCHAR * colorPtr[1u] * srcAlpha );
 698                     *( buffer + dstIndex + 2u ) = static_cast<unsigned char>( TO_UCHAR * colorPtr[2u] * srcAlpha );
 699                     *( buffer + dstIndex + 3u ) = static_cast<unsigned char>( TO_UCHAR * colorPtr[3u] * srcAlpha );
 700                   }
 701                   break;
 702                 }
 703                 case 2: // The image's buffer is RGBA and the cairo's buffer is ARGB
 704                 {
 705                   const unsigned char alpha = *(data.buffer + srcIndex + 3u);
 706                   if( alpha != 0u )
 707                   {
 708                     if( doBlendWithTextColor )
 709                     {
 710                       const float* const colorPtr = color.AsFloat();
 711
 712                       const float srcAlpha = TO_FLOAT * static_cast<float>(alpha) * colorPtr[3u];
 713
 714                       *(buffer + dstIndex + 0u) = static_cast<unsigned char>( static_cast<float>( *(data.buffer + srcIndex + 0u) ) * colorPtr[0u] );
 715                       *(buffer + dstIndex + 1u) = static_cast<unsigned char>( static_cast<float>( *(data.buffer + srcIndex + 1u) ) * colorPtr[1u] );
 716                       *(buffer + dstIndex + 2u) = static_cast<unsigned char>( static_cast<float>( *(data.buffer + srcIndex + 2u) ) * colorPtr[2u] );
 717
 718                       // Write the alpha.
 719                       *(buffer + dstIndex + 3u) = static_cast<unsigned char>( TO_UCHAR * srcAlpha );
 720                     }
 721                     else
 722                     {
 723                       // @todo needs a proper blending!
 724                       // Write the RGB
 725                       *(buffer + dstIndex + 0u) = *(data.buffer + srcIndex + 0u);
 726                       *(buffer + dstIndex + 1u) = *(data.buffer + srcIndex + 1u);
 727                       *(buffer + dstIndex + 2u) = *(data.buffer + srcIndex + 2u);
 728
 729                       // Write the alpha.
 730                       *(buffer + dstIndex + 3u) = *(data.buffer + srcIndex + 3u);
 731                     }
 732                   }
 733                   break;
 734                 }
 735                 case 3: // The image's buffer is BGRA and the cairo's buffer is ARGB
 736                 {
 737                   const unsigned char alpha = *(data.buffer + srcIndex + 3u);
 738                   if( alpha != 0u )
 739                   {
 740                     if( doBlendWithTextColor )
 741                     {
 742                       const float* const colorPtr = color.AsFloat();
 743
 744                       const float srcAlpha = TO_FLOAT * static_cast<float>(alpha) * colorPtr[3u];
 745
 746                       *(buffer + dstIndex + 0u) = static_cast<unsigned char>( static_cast<float>( *(data.buffer + srcIndex + 2u) ) * colorPtr[0u] );
 747                       *(buffer + dstIndex + 1u) = static_cast<unsigned char>( static_cast<float>( *(data.buffer + srcIndex + 1u) ) * colorPtr[1u] );
 748                       *(buffer + dstIndex + 2u) = static_cast<unsigned char>( static_cast<float>( *(data.buffer + srcIndex + 0u) ) * colorPtr[2u] );
 749
 750                       // Write the alpha.
 751                       *(buffer + dstIndex + 3u) = static_cast<unsigned char>( TO_UCHAR * srcAlpha );
 752                     }
 753                     else
 754                     {
 755                       // @todo needs a proper blending!
 756                       // Write the RGBA
 757                       *(buffer + dstIndex + 0u) = *(data.buffer + srcIndex + 2u);
 758                       *(buffer + dstIndex + 1u) = *(data.buffer + srcIndex + 1u);
 759                       *(buffer + dstIndex + 2u) = *(data.buffer + srcIndex + 0u);
 760                       *(buffer + dstIndex + 3u) = *(data.buffer + srcIndex + 3u);
 761                     }
 762                   }
 763                   break;
 764                 }
 765                 default:
 766                 {
 767                   DALI_ASSERT_ALWAYS( !"Cairo Renderer: The accepted values for this switch case are: 0, 1, 2!" );
 768                 }
 769               } // switch
 770               srcIndex += srcPixelSize;
 771               dstIndex += dstPixelSize;
 772             } // for width
 773             srcIndex += srcWidthOffset;
 774             dstIndex += dstWidthOffset;
 775           } // for height
 776         }
 777       }
 778     }
 779     else
 780     {
 781       // Sets the color. The color is actually BGRA
 782       const Vector4& color = parameters.colors[run.colorIndex];
 783
 784       cairo_set_source_rgba( cr,
 785                              static_cast<double>( color.b ),
 786                              static_cast<double>( color.g ),
 787                              static_cast<double>( color.r ),
 788                              static_cast<double>( color.a ) );
 789
 790       // Create the Cairo's font from the FreeType font.
 791       std::unique_ptr<cairo_font_face_t, void(*)(cairo_font_face_t*)> fontFacePtr( cairo_ft_font_face_create_for_ft_face( run.fontFace, 0 ), cairo_font_face_destroy );
 792       cairo_font_face_t* fontFace = fontFacePtr.get();
 793
 794       static const cairo_user_data_key_t key = { 0 };
 795       cairo_status_t status = cairo_font_face_set_user_data( fontFace, &key, run.fontFace, reinterpret_cast<cairo_destroy_func_t>( FT_Done_Face ) );
 796       if( status )
 797       {
 798         cairo_font_face_destroy(fontFace);
 799       }
 800
 801       unsigned int ftSynthesizeFlag = 0u;
 802       if( run.isBoldRequired && !( run.fontFace->style_flags & FT_STYLE_FLAG_BOLD ) )
 803       {
 804         ftSynthesizeFlag |= CAIRO_FT_SYNTHESIZE_BOLD;
 805       }
 806
 807       cairo_ft_font_face_set_synthesize( fontFace, ftSynthesizeFlag );
 808
 809       cairo_font_face_reference( fontFace );
 810
 811       const bool synthesizeItalic = ( run.isItalicRequired && !( run.fontFace->style_flags & FT_STYLE_FLAG_ITALIC ) );
 812
 813       if( CAIRO_STATUS_SUCCESS != cairo_font_face_status( fontFace ) )
 814       {
 815         DALI_LOG_ERROR( "Failed to load the Freetype Font\n" );
 816       }
 817
 818       // Sets the font.
 819       cairo_set_font_face( isCircularText ? circularCr : cr, fontFace );
 820
 821       // Sets the size
 822       cairo_set_font_size( isCircularText ? circularCr : cr, run.fontSize );
 823
 824       // Render the glyphs.
 825       if( isCircularText )
 826       {
 827         // Create a new path where the text is laid out on a horizontal straight line.
 828         cairo_new_path( circularCr );
 829         cairo_move_to( circularCr, 0.0, 0.0 );
 830
 831         cairo_glyph_path( circularCr, ( cairoGlyphsBuffer + run.glyphIndex ), run.numberOfGlyphs );
 832         WrapToCircularPath( cr, circularCr, circularTextParameters );
 833       }
 834       else
 835       {
 836         if( synthesizeItalic )
 837         {
 838           // Apply a shear transform to synthesize the italics.
 839           // For a reason Cairo may trim some glyphs if the CAIRO_FT_SYNTHESIZE_OBLIQUE flag is used.
 840
 841           // This is to calculate an offset used to compensate the 'translation' done by the shear transform
 842           // as it's done for the whole render buffer.
 843           double maxY = 0.0;
 844           for( unsigned int index = run.glyphIndex, endIndex = run.glyphIndex + run.numberOfGlyphs; index < endIndex; ++index )
 845           {
 846             maxY = std::max( maxY, (*( cairoGlyphsBuffer + index )).y );
 847           }
 848
 849           cairo_matrix_t matrix;
 850           cairo_matrix_init( &matrix,
 851                                                                                   1.0, 0.0,
 852                                    -TextAbstraction::FontClient::DEFAULT_ITALIC_ANGLE, 1.0,
 853                              maxY * TextAbstraction::FontClient::DEFAULT_ITALIC_ANGLE, 0.0 );
 854
 855           cairo_transform( cr, &matrix );
 856         }
 857
 858         cairo_show_glyphs( cr, ( cairoGlyphsBuffer + run.glyphIndex ), run.numberOfGlyphs );
 859
 860         if( synthesizeItalic )
 861         {
 862           // Restore the transform matrix to the identity.
 863           cairo_matrix_t matrix;
 864           cairo_matrix_init_identity( &matrix );
 865           cairo_set_matrix( cr, &matrix );
 866         }
 867       }
 868       cairo_fill( cr );
 869     }
 870   }
 871
 872   return pixelBuffer;
 873 }
 874
 875 } // namespace Internal
 876
 877 } // namespace TextAbstraction
 878
 879 } // namespace Dali