git.sesse.net Git - vlc/blob - modules/codec/subsdec.c

   1 /*****************************************************************************
   2  * subsdec.c : text subtitles decoder
   3  *****************************************************************************
   4  * Copyright (C) 2000-2001 VideoLAN
   5  * $Id: subsdec.c,v 1.5 2003/11/05 00:39:16 gbazin Exp $
   6  *
   7  * Authors: Gildas Bazin <gbazin@netcourrier.com>
   8  *          Samuel Hocevar <sam@zoy.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #include <stdlib.h>                                      /* malloc(), free() */
  29 #include <string.h>                                    /* memcpy(), memset() */
  30
  31 #include <vlc/vlc.h>
  32 #include <vlc/vout.h>
  33 #include <vlc/decoder.h>
  34 #include <osd.h>
  35 #include <codecs.h>
  36
  37 #if defined(HAVE_ICONV)
  38 #include <iconv.h>
  39 #endif
  40
  41 #include "charset.h"
  42
  43 /*****************************************************************************
  44  * decoder_sys_t : decoder descriptor
  45  *****************************************************************************/
  46 struct decoder_sys_t
  47 {
  48     int                 i_align;          /* Subtitles alignment on the vout */
  49
  50 #if defined(HAVE_ICONV)
  51     iconv_t             iconv_handle;            /* handle to iconv instance */
  52 #endif
  53 };
  54
  55 /*****************************************************************************
  56  * Local prototypes
  57  *****************************************************************************/
  58 static int  OpenDecoder   ( vlc_object_t * );
  59
  60 static int  InitDecoder   ( decoder_t * );
  61 static int  RunDecoder    ( decoder_t *, block_t * );
  62 static int  EndDecoder    ( decoder_t * );
  63
  64 static void ParseText     ( decoder_t *, block_t *, vout_thread_t * );
  65
  66 #define DEFAULT_NAME "System Default"
  67
  68 /*****************************************************************************
  69  * Module descriptor.
  70  *****************************************************************************/
  71 #if defined(HAVE_ICONV)
  72 static char *ppsz_encodings[] = { DEFAULT_NAME, "ASCII", "UTF-8", "",
  73     "ISO-8859-1", "CP1252", "MacRoman", "MacIceland","ISO-8859-15", "",
  74     "ISO-8859-2", "CP1250", "MacCentralEurope", "MacCroatian", "MacRomania", "",
  75     "ISO-8859-5", "CP1251", "MacCyrillic", "MacUkraine", "KOI8-R", "KOI8-U", "KOI8-RU", "",
  76     "ISO-8859-6", "CP1256", "MacArabic", "",
  77     "ISO-8859-7", "CP1253", "MacGreek", "",
  78     "ISO-8859-8", "CP1255", "MacHebrew", "",
  79     "ISO-8859-9", "CP1254", "MacTurkish", "",
  80     "ISO-8859-13", "CP1257", "",
  81     "ISO-2022-JP", "ISO-2022-JP-1", "ISO-2022-JP-2", "EUC-JP", "SHIFT_JIS", "",
  82     "ISO-2022-CN", "ISO-2022-CN-EXT", "EUC-CN", "EUC-TW", "BIG5", "BIG5-HKSCS", "",
  83     "ISO-2022-KR", "EUC-KR", "",
  84     "MacThai", "KOI8-T", "",
  85     "ISO-8859-3", "ISO-8859-4", "ISO-8859-10", "ISO-8859-14", "ISO-8859-16", "",
  86     "CP850", "CP862", "CP866", "CP874", "CP932", "CP949", "CP950", "CP1133", "CP1258", "",
  87     "Macintosh", "",
  88     "UTF-7", "UTF-16", "UTF-16BE", "UTF-16LE", "UTF-32", "UTF-32BE", "UTF-32LE",
  89     "C99", "JAVA", "UCS-2", "UCS-2BE", "UCS-2LE", "UCS-4", "UCS-4BE", "UCS-4LE", "",
  90     "HZ", "GBK", "GB18030", "JOHAB", "ARMSCII-8",
  91     "Georgian-Academy", "Georgian-PS", "TIS-620", "MuleLao-1", "VISCII", "TCVN",
  92     "HPROMAN8", "NEXTSTEP" };
  93 #endif
  94
  95 static int  pi_justification[] = { 0, 1, 2 };
  96 static char *ppsz_justification_text[] = {N_("Center"),N_("Left"),N_("Right")};
  97
  98 #define ENCODING_TEXT N_("Subtitles text encoding")
  99 #define ENCODING_LONGTEXT N_("Change the encoding used in text subtitles")
 100 #define ALIGN_TEXT N_("Subtitles justification")
 101 #define ALIGN_LONGTEXT N_("Change the justification of substitles")
 102
 103 vlc_module_begin();
 104     set_description( _("text subtitles decoder") );
 105     set_capability( "decoder", 50 );
 106     set_callbacks( OpenDecoder, NULL );
 107
 108     add_category_hint( N_("Subtitles"), NULL, VLC_FALSE );
 109     add_integer( "subsdec-align", 0, NULL, ALIGN_TEXT, ALIGN_LONGTEXT,
 110                  VLC_TRUE );
 111         change_integer_list( pi_justification, ppsz_justification_text, 0 );
 112 #if defined(HAVE_ICONV)
 113     add_string( "subsdec-encoding", DEFAULT_NAME, NULL,
 114                 ENCODING_TEXT, ENCODING_LONGTEXT, VLC_FALSE );
 115         change_string_list( ppsz_encodings, 0, 0 );
 116 #endif
 117 vlc_module_end();
 118
 119 /*****************************************************************************
 120  * OpenDecoder: probe the decoder and return score
 121  *****************************************************************************
 122  * Tries to launch a decoder and return score so that the interface is able
 123  * to chose.
 124  *****************************************************************************/
 125 static int OpenDecoder( vlc_object_t *p_this )
 126 {
 127     decoder_t *p_dec = (decoder_t*)p_this;
 128
 129     if( p_dec->p_fifo->i_fourcc != VLC_FOURCC('s','u','b','t') &&
 130         p_dec->p_fifo->i_fourcc != VLC_FOURCC('s','s','a',' ') )
 131     {
 132         return VLC_EGENERIC;
 133     }
 134
 135     p_dec->pf_init = InitDecoder;
 136     p_dec->pf_decode = RunDecoder;
 137     p_dec->pf_end = EndDecoder;
 138
 139     /* Allocate the memory needed to store the decoder's structure */
 140     if( ( p_dec->p_sys =
 141           (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
 142     {
 143         msg_Err( p_dec, "out of memory" );
 144         return VLC_EGENERIC;
 145     }
 146
 147     return VLC_SUCCESS;
 148 }
 149
 150 /*****************************************************************************
 151  * InitDecoder: Initalize the decoder
 152  *****************************************************************************/
 153 static int InitDecoder( decoder_t *p_dec )
 154 {
 155     decoder_sys_t *p_sys = p_dec->p_sys;
 156     subtitle_data_t *p_demux_data = (subtitle_data_t *)p_dec->p_fifo->p_demux_data;
 157     vlc_value_t val;
 158
 159     var_Create( p_dec, "subsdec-align", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 160     var_Get( p_dec, "subsdec-align", &val );
 161     p_sys->i_align = val.i_int;
 162
 163 #if defined(HAVE_ICONV)
 164     var_Create( p_dec, "subsdec-encoding",
 165                 VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 166     var_Get( p_dec, "subsdec-encoding", &val );
 167     if( !strcmp( val.psz_string, DEFAULT_NAME ) )
 168     {
 169         char *psz_charset =(char*)malloc( 100 );
 170         vlc_current_charset( &psz_charset );
 171         p_sys->iconv_handle = iconv_open( "UTF-8", psz_charset );
 172         free( psz_charset );
 173     }
 174     else
 175     {
 176         p_sys->iconv_handle = iconv_open( "UTF-8", val.psz_string );
 177     }
 178
 179     if( p_sys->iconv_handle == (iconv_t)-1 )
 180     {
 181         msg_Warn( p_dec, "Unable to do requested conversion" );
 182     }
 183
 184     if( val.psz_string ) free( val.psz_string );
 185 #else
 186     msg_Dbg( p_dec, "No iconv support available" );
 187 #endif
 188
 189 #if 1
 190     if( p_demux_data )
 191         msg_Dbg( p_dec, p_demux_data->psz_header );
 192 #endif
 193
 194     return VLC_SUCCESS;
 195 }
 196
 197 /****************************************************************************
 198  * RunDecoder: the whole thing
 199  ****************************************************************************
 200  * This function must be fed with complete subtitles units.
 201  ****************************************************************************/
 202 static int RunDecoder( decoder_t *p_dec, block_t *p_block )
 203 {
 204     vout_thread_t *p_vout;
 205
 206     /* Here we are dealing with text subtitles */
 207     p_vout = vlc_object_find( p_dec, VLC_OBJECT_VOUT, FIND_ANYWHERE );
 208     if( !p_vout )
 209     {
 210         msg_Warn( p_dec, "couldn't find a video output, trashing subtitle" );
 211         return VLC_SUCCESS;
 212     }
 213
 214     ParseText( p_dec, p_block, p_vout );
 215     vlc_object_release( p_vout );
 216
 217     return VLC_SUCCESS;
 218 }
 219
 220 /*****************************************************************************
 221  * EndDecoder: clean up the decoder
 222  *****************************************************************************/
 223 static int EndDecoder( decoder_t *p_dec )
 224 {
 225     decoder_sys_t *p_sys = p_dec->p_sys;
 226     vout_thread_t *p_vout;
 227
 228     p_vout = vlc_object_find( p_dec, VLC_OBJECT_VOUT, FIND_ANYWHERE );
 229     if( p_vout != NULL && p_vout->p_subpicture != NULL )
 230     {
 231         subpicture_t *p_subpic;
 232         int          i_subpic;
 233
 234         for( i_subpic = 0; i_subpic < VOUT_MAX_SUBPICTURES; i_subpic++ )
 235         {
 236             p_subpic = &p_vout->p_subpicture[i_subpic];
 237
 238             if( p_subpic != NULL &&
 239               ( p_subpic->i_status == RESERVED_SUBPICTURE
 240                 || p_subpic->i_status == READY_SUBPICTURE ) )
 241             {
 242                 vout_DestroySubPicture( p_vout, p_subpic );
 243             }
 244         }
 245     }
 246     if( p_vout ) vlc_object_release( p_vout );
 247
 248 #if defined(HAVE_ICONV)
 249     if( p_sys->iconv_handle != (iconv_t)-1 )
 250     {
 251         iconv_close( p_sys->iconv_handle );
 252     }
 253 #endif
 254
 255     free( p_sys );
 256
 257     return VLC_SUCCESS;
 258 }
 259
 260 /*****************************************************************************
 261  * ParseText: parse an text subtitle packet and send it to the video output
 262  *****************************************************************************/
 263 static void ParseText( decoder_t *p_dec, block_t *p_block,
 264                        vout_thread_t *p_vout )
 265 {
 266     decoder_sys_t *p_sys = p_dec->p_sys;
 267     char *psz_subtitle;
 268     int i_align_h, i_align_v;
 269
 270     /* We cannot display a subpicture with no date */
 271     if( p_block->i_pts == 0 )
 272     {
 273         msg_Warn( p_dec, "subtitle without a date" );
 274         return;
 275     }
 276
 277     /* Check validity of packet data */
 278     if( p_block->i_buffer <= 1 ||  p_block->p_buffer[0] == '\0' )
 279     {
 280         msg_Warn( p_dec, "empty subtitle" );
 281         return;
 282     }
 283
 284     /* Should be resiliant against bad subtitles */
 285     psz_subtitle = strndup( p_block->p_buffer, p_block->i_buffer );
 286
 287     i_align_h = p_sys->i_align ? 20 : 0;
 288     i_align_v = 10;
 289
 290 #if defined(HAVE_ICONV)
 291     if( p_sys->iconv_handle != (iconv_t)-1 )
 292     {
 293         char *psz_new_subtitle;
 294         char *psz_convert_buffer_out;
 295         const char *psz_convert_buffer_in;
 296         size_t ret, inbytes_left, outbytes_left;
 297
 298         psz_new_subtitle = malloc( 6 * strlen( psz_subtitle ) );
 299         psz_convert_buffer_out = psz_new_subtitle;
 300         psz_convert_buffer_in = psz_subtitle;
 301         inbytes_left = strlen( psz_subtitle );
 302         outbytes_left = 6 * inbytes_left;
 303         ret = iconv( p_sys->iconv_handle, &psz_convert_buffer_in,
 304                      &inbytes_left, &psz_convert_buffer_out, &outbytes_left );
 305         *psz_convert_buffer_out = '\0';
 306
 307         if( inbytes_left )
 308         {
 309             msg_Warn( p_dec, "Something fishy happened during conversion" );
 310         }
 311         else
 312         {
 313             free( psz_subtitle );
 314             psz_subtitle = psz_new_subtitle;
 315         }
 316     }
 317 #endif
 318
 319     if( p_dec->p_fifo->i_fourcc == VLC_FOURCC('s','s','a',' ') )
 320     {
 321         /* Decode SSA strings */
 322         /* We expect: ReadOrder, Layer, Style, Name, MarginL, MarginR, MarginV, Effect, Text */
 323         char *psz_new_subtitle;
 324         char *psz_buffer_sub;
 325         int         i_comma;
 326         int         i_text;
 327
 328         psz_buffer_sub = psz_subtitle;
 329         for( ;; )
 330         {
 331             i_comma = 0;
 332             while( i_comma < 8 &&
 333                 *psz_buffer_sub != '\0' )
 334             {
 335                 if( *psz_buffer_sub == ',' )
 336                 {
 337                     i_comma++;
 338                 }
 339                 psz_buffer_sub++;
 340             }
 341             psz_new_subtitle = malloc( strlen( psz_buffer_sub ) + 1);
 342             i_text = 0;
 343             while( psz_buffer_sub[0] != '\0' )
 344             {
 345                 if( psz_buffer_sub[0] == '\\' && ( psz_buffer_sub[1] =='n' || psz_buffer_sub[1] =='N' ) )
 346                 {
 347                     psz_new_subtitle[i_text] = '\n';
 348                     i_text++;
 349                     psz_buffer_sub += 2;
 350                 }
 351                 else if( psz_buffer_sub[0] == '{' && psz_buffer_sub[1] == '\\' )
 352                 {
 353                     /* SSA control code */
 354                     while( psz_buffer_sub[0] != '\0' && psz_buffer_sub[0] != '}' )
 355                     {
 356                         psz_buffer_sub++;
 357                     }
 358                     psz_buffer_sub++;
 359                 }
 360                 else
 361                 {
 362                     psz_new_subtitle[i_text] = psz_buffer_sub[0];
 363                     i_text++;
 364                     psz_buffer_sub++;
 365                 }
 366             }
 367             psz_new_subtitle[i_text] = '\0';
 368             free( psz_subtitle );
 369             psz_subtitle = psz_new_subtitle;
 370             break;
 371         }
 372     }
 373
 374     vout_ShowTextAbsolute( p_vout, psz_subtitle, NULL,
 375                            OSD_ALIGN_BOTTOM | p_sys->i_align,
 376                            i_align_h, i_align_v,
 377                            p_block->i_pts, p_block->i_dts );
 378
 379     free( psz_subtitle );
 380 }