3b9fb54f6b43247766e01b27132dabdbb6de7b9b
[vlc.git] / modules / misc / freetype.c
1 /*****************************************************************************
2  * freetype.c : Put text on the video, using freetype2
3  *****************************************************************************
4  * Copyright (C) 2002, 2003 VideoLAN
5  * $Id: freetype.c,v 1.14 2003/07/26 18:54:20 titer Exp $
6  *
7  * Authors: Sigmund Augdal <sigmunau@idi.ntnu.no>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>                                      /* malloc(), free() */
28 #include <string.h>
29
30 #include <vlc/vlc.h>
31 #include <vlc/vout.h>
32 #include <osd.h>
33 #include <math.h>
34
35 #include <ft2build.h>
36 #include FT_FREETYPE_H
37 #include FT_GLYPH_H
38
39 #ifdef SYS_DARWIN
40 #define DEFAULT_FONT "/System/Library/Fonts/LucidaGrande.dfont"
41 #elif defined( SYS_BEOS )
42 #define DEFAULT_FONT "/boot/beos/etc/fonts/ttfonts/Swiss721.ttf"
43 #else
44 #define DEFAULT_FONT ""
45 #endif
46
47 /*****************************************************************************
48  * Local prototypes
49  *****************************************************************************/
50 static int  Create    ( vlc_object_t * );
51 static void Destroy   ( vlc_object_t * );
52
53 static void Render    ( vout_thread_t *, picture_t *,
54                         const subpicture_t * );
55 static void RenderI420( vout_thread_t *, picture_t *,
56                         const subpicture_t * );
57 static void RenderYUY2( vout_thread_t *, picture_t *,
58                         const subpicture_t * );
59 static int  AddText   ( vout_thread_t *, byte_t *, text_style_t *, int,
60                         int, int, mtime_t, mtime_t );
61 static int  GetUnicodeCharFromUTF8( byte_t ** );
62 static void FreeString( subpicture_t * );
63
64 /*****************************************************************************
65  * Module descriptor
66  *****************************************************************************/
67 #define FONT_TEXT N_("Font")
68 #define FONT_LONGTEXT N_("Filename of Font")
69 #define FONTSIZE_TEXT N_("Font size")
70 #define FONTSIZE_LONGTEXT N_("The size of the fonts used by the osd module" )
71
72 vlc_module_begin();
73     add_category_hint( N_("Fonts"), NULL, VLC_FALSE );
74     add_file( "freetype-font", DEFAULT_FONT, NULL, FONT_TEXT, FONT_LONGTEXT, VLC_FALSE );
75     add_integer( "freetype-fontsize", 16, NULL, FONTSIZE_TEXT, FONTSIZE_LONGTEXT, VLC_FALSE );
76     set_description( _("freetype2 font renderer") );
77     set_capability( "text renderer", 100 );
78     add_shortcut( "text" );
79     set_callbacks( Create, Destroy );
80 vlc_module_end();
81
82 /**
83  * Private data in a aubpicture. Describes a string.
84  */
85 struct subpicture_sys_t
86 {
87     int            i_x_margin;
88     int            i_y_margin;
89     int            i_width;
90     int            i_height;
91     int            i_flags;
92     /** The string associated with this subpicture */
93     byte_t        *psz_text;
94     /** NULL-terminated list of glyphs making the string */
95     FT_BitmapGlyph      *pp_glyphs;
96     /** list of relative positions for the glyphs */
97     FT_Vector     *p_glyph_pos;
98 };
99
100 /*****************************************************************************
101  * text_remderer_sys_t: freetype local data
102  *****************************************************************************
103  * This structure is part of the video output thread descriptor.
104  * It describes the freetype specific properties of an output thread.
105  *****************************************************************************/
106 struct text_renderer_sys_t
107 {
108     FT_Library     p_library;   /* handle to library     */
109     FT_Face        p_face;      /* handle to face object */
110     vlc_mutex_t   *lock;
111     vlc_bool_t     i_use_kerning;
112     uint8_t        pi_gamma[256];
113 };
114
115 /*****************************************************************************
116  * Create: allocates osd-text video thread output method
117  *****************************************************************************
118  * This function allocates and initializes a Clone vout method.
119  *****************************************************************************/
120 #define gamma_value 2.0
121 static int Create( vlc_object_t *p_this )
122 {
123     vout_thread_t *p_vout = (vout_thread_t *)p_this;
124     char *psz_fontfile;
125     int i, i_error;
126     double gamma_inv = 1.0f / gamma_value;
127     vlc_value_t val;
128
129     /* Allocate structure */
130     p_vout->p_text_renderer_data = malloc( sizeof( text_renderer_sys_t ) );
131     if( p_vout->p_text_renderer_data == NULL )
132     {
133         msg_Err( p_vout, "out of memory" );
134         return VLC_ENOMEM;
135     }
136
137     for (i = 0; i < 256; i++) {
138         p_vout->p_text_renderer_data->pi_gamma[i] =
139             (uint8_t)( pow( (double)i / 255.0f, gamma_inv) * 255.0f );
140     }
141
142     var_Create( p_vout, "freetype-font", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
143     var_Create( p_vout, "freetype-fontsize",
144                 VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
145
146     /* Look what method was requested */
147     var_Get( p_vout, "freetype-font", &val );
148     psz_fontfile = val.psz_string;
149
150     if( !psz_fontfile || !*psz_fontfile )
151     {
152         if( psz_fontfile ) free( psz_fontfile );
153         psz_fontfile = (char *)malloc( PATH_MAX + 1 );
154 #ifdef WIN32
155         GetWindowsDirectory( psz_fontfile, PATH_MAX + 1 );
156         strcat( psz_fontfile, "\\fonts\\arial.ttf" );
157 #elif SYS_DARWIN
158         strcpy( psz_fontfile, DEFAULT_FONT );
159 #else
160         msg_Err( p_vout, "user didn't specify a font" );
161         free( p_vout->p_text_renderer_data );
162         return VLC_EGENERIC;
163 #endif
164     }
165
166     i_error = FT_Init_FreeType( &p_vout->p_text_renderer_data->p_library );
167     if( i_error )
168     {
169         msg_Err( p_vout, "couldn't initialize freetype" );
170         free( p_vout->p_text_renderer_data );
171         return VLC_EGENERIC;
172     }
173
174     i_error = FT_New_Face( p_vout->p_text_renderer_data->p_library,
175                            psz_fontfile ? psz_fontfile : "", 0,
176                            &p_vout->p_text_renderer_data->p_face );
177     if( i_error == FT_Err_Unknown_File_Format )
178     {
179         msg_Err( p_vout, "file %s have unknown format", psz_fontfile );
180         FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
181         free( p_vout->p_text_renderer_data );
182         if( psz_fontfile ) free( psz_fontfile );
183         return VLC_EGENERIC;
184     }
185     else if( i_error )
186     {
187         msg_Err( p_vout, "failed to load font file %s", psz_fontfile );
188         FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
189         free( p_vout->p_text_renderer_data );
190         if( psz_fontfile ) free( psz_fontfile );
191         return VLC_EGENERIC;
192     }
193     if( psz_fontfile ) free( psz_fontfile );
194
195     i_error = FT_Select_Charmap( p_vout->p_text_renderer_data->p_face,
196                                  ft_encoding_unicode );
197     if ( i_error )
198     {
199         msg_Err( p_vout, "Font has no unicode translation table" );
200         FT_Done_Face( p_vout->p_text_renderer_data->p_face );
201         FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
202         free( p_vout->p_text_renderer_data );
203         return VLC_EGENERIC;
204     }
205
206     p_vout->p_text_renderer_data->i_use_kerning =
207         FT_HAS_KERNING(p_vout->p_text_renderer_data->p_face);
208     var_Get( p_vout, "freetype-fontsize", &val );
209
210     i_error = FT_Set_Pixel_Sizes( p_vout->p_text_renderer_data->p_face, 0, val.i_int );
211     if( i_error )
212     {
213         msg_Err( p_vout, "couldn't set font size to %d", val.i_int );
214         free( p_vout->p_text_renderer_data );
215         return VLC_EGENERIC;
216     }
217     p_vout->pf_add_string = AddText;
218     return VLC_SUCCESS;
219 }
220
221 /*****************************************************************************
222  * Destroy: destroy Clone video thread output method
223  *****************************************************************************
224  * Clean up all data and library connections
225  *****************************************************************************/
226 static void Destroy( vlc_object_t *p_this )
227 {
228     vout_thread_t *p_vout = (vout_thread_t *)p_this;
229     FT_Done_Face( p_vout->p_text_renderer_data->p_face );
230     FT_Done_FreeType( p_vout->p_text_renderer_data->p_library );
231     free( p_vout->p_text_renderer_data );
232 }
233
234 /*****************************************************************************
235  * Render: place string in picture
236  *****************************************************************************
237  * This function merges the previously rendered freetype glyphs into a picture
238  *****************************************************************************/
239 static void Render( vout_thread_t *p_vout, picture_t *p_pic,
240                     const subpicture_t *p_subpic )
241 {
242     switch( p_vout->output.i_chroma )
243     {
244         /* I420 target, no scaling */
245         case VLC_FOURCC('I','4','2','0'):
246         case VLC_FOURCC('I','Y','U','V'):
247         case VLC_FOURCC('Y','V','1','2'):
248             RenderI420( p_vout, p_pic, p_subpic );
249             break;
250 #if 0
251         /* RV16 target, scaling */
252         case VLC_FOURCC('R','V','1','6'):
253             RenderRV16( p_vout, p_pic, p_subpic );
254             break;
255
256         /* RV32 target, scaling */
257         case VLC_FOURCC('R','V','2','4'):
258         case VLC_FOURCC('R','V','3','2'):
259             RenderRV32( p_vout, p_pic, p_subpic );
260             break;
261 #endif
262         /* NVidia or BeOS overlay, no scaling */
263         case VLC_FOURCC('Y','U','Y','2'):
264             RenderYUY2( p_vout, p_pic, p_subpic );
265             break;
266
267         default:
268             msg_Err( p_vout, "unknown chroma, can't render SPU" );
269             break;
270     }
271 }
272
273 /**
274  * Draw a string on a i420 (or similar) picture
275  */
276 static void RenderI420( vout_thread_t *p_vout, picture_t *p_pic,
277                     const subpicture_t *p_subpic )
278 {
279     subpicture_sys_t *p_string = p_subpic->p_sys;
280     int i_plane, x, y, pen_x, pen_y;
281     unsigned int i;
282
283     for( i_plane = 0 ; i_plane < p_pic->i_planes ; i_plane++ )
284     {
285         uint8_t *p_in;
286         int i_pitch = p_pic->p[i_plane].i_pitch;
287
288         p_in = p_pic->p[i_plane].p_pixels;
289
290         if ( i_plane == 0 )
291         {
292             if ( p_string->i_flags & OSD_ALIGN_BOTTOM )
293             {
294                 pen_y = p_pic->p[i_plane].i_lines - p_string->i_height -
295                     p_string->i_y_margin;
296             }
297             else
298             {
299                 pen_y = p_string->i_y_margin;
300             }
301             pen_y += p_vout->p_text_renderer_data->p_face->size->metrics.height / 100;
302             if ( p_string->i_flags & OSD_ALIGN_RIGHT )
303             {
304                 pen_x = i_pitch - p_string->i_width
305                     - p_string->i_x_margin;
306             }
307             else
308             {
309                 pen_x = p_string->i_x_margin;
310             }
311
312             for( i = 0; p_string->pp_glyphs[i] != NULL; i++ )
313             {
314                 if( p_string->pp_glyphs[i] )
315                 {
316                     FT_BitmapGlyph p_glyph = p_string->pp_glyphs[ i ];
317 #define alpha p_vout->p_text_renderer_data->pi_gamma[ p_glyph->bitmap.buffer[ x + y * p_glyph->bitmap.width ] ]
318 #define pixel p_in[ ( p_string->p_glyph_pos[ i ].y + pen_y + y - p_glyph->top ) * i_pitch+x + pen_x + p_string->p_glyph_pos[ i ].x + p_glyph->left ]
319                     for(y = 0; y < p_glyph->bitmap.rows; y++ )
320                     {
321                         for( x = 0; x < p_glyph->bitmap.width; x++ )
322                         {
323                             pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 ) +
324                                 ( 255 * alpha >> 8 );
325 #undef alpha
326 #undef pixel
327                         }
328                     }
329                 }
330             }
331         }
332         else
333         {
334             if ( p_string->i_flags & OSD_ALIGN_BOTTOM )
335             {
336                 pen_y = p_pic->p[i_plane].i_lines - ( p_string->i_height>>1) -
337                     (p_string->i_y_margin>>1);
338             }
339             else
340             {
341                 pen_y = p_string->i_y_margin >> 1;
342             }
343             pen_y += p_vout->p_text_renderer_data->p_face->size->metrics.height / 200;
344             if ( p_string->i_flags & OSD_ALIGN_RIGHT )
345             {
346                 pen_x = i_pitch - ( p_string->i_width >> 1 )
347                     - ( p_string->i_x_margin >> 1 );
348             }
349             else
350             {
351                 pen_x = p_string->i_x_margin >> 1;
352             }
353
354             for( i = 0; p_string->pp_glyphs[i] != NULL; i++ )
355             {
356                 if( p_string->pp_glyphs[i] )
357                 {
358                     FT_BitmapGlyph p_glyph = p_string->pp_glyphs[ i ];
359 #define alpha p_vout->p_text_renderer_data->pi_gamma[ p_glyph->bitmap.buffer[ ( x + y * p_glyph->bitmap.width ) ] ]
360 #define pixel p_in[ ( (p_string->p_glyph_pos[ i ].y>>1) + pen_y + (y>>1) -  ( p_glyph->top >> 1 ) ) * i_pitch + ( x >> 1 ) + pen_x + ( p_string->p_glyph_pos[ i ].x >> 1 ) + ( p_glyph->left >>1) ]
361                     for( y = 0; y < p_glyph->bitmap.rows; y+=2 )
362                     {
363                         for( x = 0; x < p_glyph->bitmap.width; x+=2 )
364                         {
365                             pixel = ( ( pixel * ( 0xFF - alpha ) ) >> 8 ) +
366                                 ( 0x80 * alpha >> 8 );
367 #undef alpha
368 #undef pixel
369                         }
370                     }
371                 }
372             }
373         }
374     }
375 }
376
377 /**
378  * Draw a string on a YUY2 picture
379  */
380 static void RenderYUY2( vout_thread_t *p_vout, picture_t *p_pic,
381                         const subpicture_t *p_subpic )
382 {
383     subpicture_sys_t *p_string = p_subpic->p_sys;
384     int x, y, pen_x, pen_y;
385     unsigned int i;
386
387     uint8_t *p_in;
388     int i_pitch = p_pic->p[0].i_pitch;
389
390     p_in = p_pic->p->p_pixels;
391
392     if ( p_string->i_flags & OSD_ALIGN_BOTTOM )
393     {
394         pen_y = p_pic->p->i_lines - p_string->i_height -
395                 p_string->i_y_margin;
396     }
397     else
398     {
399         pen_y = p_string->i_y_margin;
400     }
401     pen_y += p_vout->p_text_renderer_data->p_face->size->metrics.height / 100;
402     if ( p_string->i_flags & OSD_ALIGN_RIGHT )
403     {
404         pen_x = i_pitch - p_string->i_width - p_string->i_x_margin;
405     }
406     else
407     {
408         pen_x = p_string->i_x_margin;
409     }
410
411     /* TODO : set U & V bytes */
412     for( i = 0; p_string->pp_glyphs[i] != NULL; i++ )
413     {
414         if( p_string->pp_glyphs[i] )
415         {
416             FT_BitmapGlyph p_glyph = p_string->pp_glyphs[ i ];
417 #define alpha p_vout->p_text_renderer_data->pi_gamma[ p_glyph->bitmap.buffer[ x + y * p_glyph->bitmap.width ] ]
418 #define pixel p_in[ ( p_string->p_glyph_pos[ i ].y + pen_y + y - p_glyph->top ) * i_pitch + 2 * ( x + pen_x + p_string->p_glyph_pos[ i ].x + p_glyph->left ) ]
419             for( y = 0; y < p_glyph->bitmap.rows; y++ )
420             {
421                 for( x = 0; x < p_glyph->bitmap.width; x++ )
422                 {
423                     pixel = ( ( pixel * ( 255 - alpha ) ) >> 8 ) +
424                             ( 255 * alpha >> 8 );
425 #undef alpha
426 #undef pixel
427                 }
428             }
429         }
430     }
431 }
432
433
434 /**
435  * This function receives a string and creates a subpicture for it. It
436  * also calculates the size needed for this string, and renders the
437  * needed glyphs into memory. It is used as pf_add_string callback in
438  * the vout method by this module
439  */
440 static int AddText ( vout_thread_t *p_vout, byte_t *psz_string,
441                      text_style_t *p_style, int i_flags, int i_hmargin,
442                      int i_vmargin, mtime_t i_start, mtime_t i_stop )
443 {
444     subpicture_sys_t *p_string;
445     int i, i_pen_y, i_pen_x, i_error, i_glyph_index, i_previous, i_char;
446     subpicture_t *p_subpic;
447     FT_BBox line;
448     FT_BBox glyph_size;
449     FT_Vector result;
450     FT_Glyph tmp_glyph;
451
452     result.x = 0;
453     result.y = 0;
454     line.xMin = 0;
455     line.xMax = 0;
456     line.yMin = 0;
457     line.yMax = 0;
458
459     /* Create and initialize a subpicture */
460     p_subpic = vout_CreateSubPicture( p_vout, MEMORY_SUBPICTURE );
461     if ( p_subpic == NULL )
462     {
463         return VLC_EGENERIC;
464     }
465     p_subpic->pf_render = Render;
466     p_subpic->pf_destroy = FreeString;
467     p_subpic->i_start = i_start;
468     p_subpic->i_stop = i_stop;
469     if( i_stop == 0 )
470     {
471         p_subpic->b_ephemer = VLC_TRUE;
472     }
473     else
474     {
475         p_subpic->b_ephemer = VLC_FALSE;
476     }
477
478     /* Create and initialize private data for the subpicture */
479     p_string = malloc( sizeof(subpicture_sys_t) );
480     if ( p_string == NULL )
481     {
482         vout_DestroySubPicture( p_vout, p_subpic );
483         return VLC_ENOMEM;
484     }
485     p_subpic->p_sys = p_string;
486     p_string->i_flags = i_flags;
487     p_string->i_x_margin = i_hmargin;
488     p_string->i_y_margin = i_vmargin;
489
490     p_string->psz_text = strdup( psz_string );
491     p_string->pp_glyphs = malloc( sizeof(FT_GlyphSlot)
492                                   * ( strlen( p_string->psz_text ) + 1 ) );
493     if( p_string->pp_glyphs == NULL )
494     {
495         msg_Err( p_vout, "Out of memory" );
496         return VLC_ENOMEM;
497     }
498     p_string->p_glyph_pos = malloc( sizeof( FT_Vector )
499                                   * strlen( p_string->psz_text ) );
500     if( p_string->p_glyph_pos == NULL )
501     {
502         msg_Err( p_vout, "Out of memory" );
503         return VLC_ENOMEM;
504     }
505
506     /* Calculate relative glyph positions and a bounding box for the
507      * entire string */
508     i_pen_x = 0;
509     i_pen_y = 0;
510     i_previous = 0;
511     i = 0;
512     while( *psz_string )
513     {
514         i_char = GetUnicodeCharFromUTF8( &psz_string );
515 #define face p_vout->p_text_renderer_data->p_face
516 #define glyph face->glyph
517         if ( i_char == 13 ) /* ignore CR chars wherever they may be */
518         {
519             continue;
520         }
521         if ( i_char == '\n' )
522         {
523             i_pen_x = 0;
524             result.x = __MAX( result.x, line.xMax );
525             result.y += face->size->metrics.height / 100;
526             line.xMin = 0;
527             line.xMax = 0;
528             line.yMin = 0;
529             line.yMax = 0;
530             i_pen_y += face->size->metrics.height / 100;
531             continue;
532         }
533         i_glyph_index = FT_Get_Char_Index( face, i_char );
534         if ( p_vout->p_text_renderer_data->i_use_kerning && i_glyph_index
535             && i_previous )
536         {
537             FT_Vector delta;
538             FT_Get_Kerning( face, i_previous, i_glyph_index,
539                             ft_kerning_default, &delta );
540             i_pen_x += delta.x >> 6;
541
542         }
543         p_string->p_glyph_pos[ i ].x = i_pen_x;
544         p_string->p_glyph_pos[ i ].y = i_pen_y;
545         i_error = FT_Load_Glyph( face, i_glyph_index, FT_LOAD_DEFAULT );
546         if ( i_error )
547         {
548             msg_Err( p_vout, "FT_Load_Glyph returned %d", i_error );
549             return VLC_EGENERIC;
550         }
551         i_error = FT_Get_Glyph( glyph, &tmp_glyph );
552         if ( i_error )
553         {
554             msg_Err( p_vout, "FT_Get_Glyph returned %d", i_error );
555             return VLC_EGENERIC;
556         }
557         FT_Glyph_Get_CBox( tmp_glyph, ft_glyph_bbox_pixels, &glyph_size );
558         i_error = FT_Glyph_To_Bitmap( &tmp_glyph,
559                                       ft_render_mode_normal,
560                                       NULL,
561                                       1 );
562         if ( i_error ) continue;
563         p_string->pp_glyphs[ i ] = (FT_BitmapGlyph)tmp_glyph;
564
565         /* Do rest */
566         line.xMax = p_string->p_glyph_pos[i].x + glyph_size.xMax - glyph_size.xMin;
567         line.yMax = __MAX( line.yMax, glyph_size.yMax );
568         line.yMin = __MIN( line.yMin, glyph_size.yMin );
569
570         i_previous = i_glyph_index;
571         i_pen_x += glyph->advance.x >> 6;
572         i++;
573     }
574     p_string->pp_glyphs[i] = NULL;
575     result.x = __MAX( result.x, line.xMax );
576     result.y += line.yMax - line.yMin;
577     p_string->i_height = result.y;
578     p_string->i_width = result.x;
579     msg_Dbg( p_vout, "string height is %d, width is %d",
580              p_string->i_height, p_string->i_width );
581     msg_Dbg( p_vout, "adding string \"%s\" at (%d,%d) start_date "I64Fd
582              " end_date" I64Fd, p_string->psz_text, p_string->i_x_margin,
583              p_string->i_y_margin, i_start, i_stop );
584     vout_DisplaySubPicture( p_vout, p_subpic );
585     return VLC_SUCCESS;
586 }
587
588 static void FreeString( subpicture_t *p_subpic )
589 {
590     unsigned int i;
591     subpicture_sys_t *p_string = p_subpic->p_sys;
592     for ( i = 0; p_string->pp_glyphs[ i ] != NULL; i++ )
593     {
594         FT_Done_Glyph( (FT_Glyph)p_string->pp_glyphs[ i ] );
595     }
596     free( p_string->psz_text );
597     free( p_string->p_glyph_pos );
598     free( p_string->pp_glyphs );
599     free( p_string );
600 }
601
602 /* convert one or more utf8 bytes into a unicode character */
603 static int GetUnicodeCharFromUTF8( byte_t **ppsz_utf8_string )
604 {
605     int i_remaining_bytes, i_char = 0;
606     if( ( **ppsz_utf8_string & 0xFC ) == 0xFC )
607     {
608         i_char = **ppsz_utf8_string & 1;
609         i_remaining_bytes = 5;
610     }
611     else if( ( **ppsz_utf8_string & 0xF8 ) == 0xF8 )
612     {
613         i_char = **ppsz_utf8_string & 3;
614         i_remaining_bytes = 4;
615     }
616     else if( ( **ppsz_utf8_string & 0xF0 ) == 0xF0 )
617     {
618         i_char = **ppsz_utf8_string & 7;
619         i_remaining_bytes = 3;
620     }
621     else if( ( **ppsz_utf8_string & 0xE0 ) == 0xE0 )
622     {
623         i_char = **ppsz_utf8_string & 15;
624         i_remaining_bytes = 2;
625     }
626     else if( ( **ppsz_utf8_string & 0xC0 ) == 0xC0 )
627     {
628         i_char = **ppsz_utf8_string & 31;
629         i_remaining_bytes = 1;
630     }
631     else
632     {
633         i_char = **ppsz_utf8_string;
634         i_remaining_bytes = 0;
635     }
636     while( i_remaining_bytes )
637     {
638         (*ppsz_utf8_string)++;
639         i_remaining_bytes--;
640         i_char = ( i_char << 6 ) + ( **ppsz_utf8_string & 0x3F );
641     }
642     (*ppsz_utf8_string)++;
643     return i_char;
644 }