1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2001-2003 VideoLAN
5 * $Id: sub.h,v 1.13 2004/01/26 20:02:15 gbazin Exp $
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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.
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.
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 *****************************************************************************/
24 #define SUB_TYPE_MICRODVD 0x00
25 #define SUB_TYPE_SUBRIP 0x01
26 #define SUB_TYPE_SSA1 0x02
27 #define SUB_TYPE_SSA2_4 0x03
28 #define SUB_TYPE_VPLAYER 0x04
29 #define SUB_TYPE_SAMI 0x05
30 #define SUB_TYPE_VOBSUB 0x100
31 #define SUB_TYPE_UNKNOWN 0xffff
33 typedef struct subtitle_s
39 int i_vobsub_location;
53 int i_previously_selected; /* to make pf_seek */
54 es_descriptor_t *p_es;
59 typedef struct subtitle_demux_s
65 int (*pf_open) ( struct subtitle_demux_s *p_sub,
66 input_thread_t*p_input,
68 mtime_t i_microsecperframe,
70 int (*pf_demux)( struct subtitle_demux_s *p_sub, mtime_t i_maxdate );
71 int (*pf_seek) ( struct subtitle_demux_s *p_sub, mtime_t i_date );
72 void (*pf_close)( struct subtitle_demux_s *p_sub );
75 input_thread_t *p_input;
83 int i_previously_selected; /* to make pf_seek */
86 /*unsigned int i_tracks;
87 subtitle_track_t *p_tracks
92 /*****************************************************************************
93 * subtitle_New: Start a new subtitle demux instance (but subtitle ES isn't
94 * selected by default.
95 *****************************************************************************
96 * Return: NULL if failed, else a pointer on a new subtitle_demux_t.
98 * XXX: - if psz_name is NULL then --sub-file is read
99 * - i_microsecperframe is used only for microdvd file. (overriden
101 * - it's at this point that --sub-delay is applied
103 *****************************************************************************/
104 static inline subtitle_demux_t *subtitle_New( input_thread_t *p_input,
106 mtime_t i_microsecperframe,
109 subtitle_demux_t *p_sub;
111 p_sub = vlc_object_create( p_input, sizeof( subtitle_demux_t ) );
112 p_sub->psz_object_name = "subtitle demux";
113 vlc_object_attach( p_sub, p_input );
114 p_sub->p_module = module_Need( p_sub, "subtitle demux", "" );
116 if( p_sub->p_module &&
117 p_sub->pf_open( p_sub, p_input, psz_name, i_microsecperframe,
120 msg_Info( p_input, "subtitle started" );
125 msg_Warn( p_input, "failed to start subtitle demux" );
126 vlc_object_detach( p_sub );
127 if( p_sub->p_module )
129 module_Unneed( p_sub, p_sub->p_module );
131 vlc_object_destroy( p_sub );
138 /*****************************************************************************
139 * subtitle_Demux: send subtitle to decoder from last date to i_max
140 *****************************************************************************/
141 static inline int subtitle_Demux( subtitle_demux_t *p_sub, mtime_t i_max )
143 return( p_sub->pf_demux( p_sub, i_max ) );
146 /*****************************************************************************
147 * subtitle_Seek: Seek to i_date
148 *****************************************************************************/
149 static inline int subtitle_Seek( subtitle_demux_t *p_sub, mtime_t i_date )
151 return( p_sub->pf_seek( p_sub, i_date ) );
154 /*****************************************************************************
155 * subtitle_Close: Stop ES decoder and free all memory included p_sub.
156 *****************************************************************************/
157 static inline void subtitle_Close( subtitle_demux_t *p_sub )
159 msg_Info( p_sub, "subtitle stopped" );
162 vlc_object_detach( p_sub );
163 if( p_sub->p_module )
165 module_Unneed( p_sub, p_sub->p_module );
167 vlc_object_destroy( p_sub );