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