Mercurial > mplayer.hg
annotate libass/ass.h @ 25944:8a1c062707ff
Do not uselessly erase background, OpenGL will take care of drawing everything.
author | reimar |
---|---|
date | Sun, 10 Feb 2008 19:47:54 +0000 |
parents | aaebaf255b23 |
children | 74055622161d |
rev | line source |
---|---|
20008
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
1 // -*- c-basic-offset: 8; indent-tabs-mode: t -*- |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
2 // vim:ts=8:sw=8:noet:ai: |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
3 /* |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
4 Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com> |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
5 |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
6 This program is free software; you can redistribute it and/or modify |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
7 it under the terms of the GNU General Public License as published by |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
8 the Free Software Foundation; either version 2 of the License, or |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
9 (at your option) any later version. |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
10 |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
11 This program is distributed in the hope that it will be useful, |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
12 but WITHOUT ANY WARRANTY; without even the implied warranty of |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
14 GNU General Public License for more details. |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
15 |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
16 You should have received a copy of the GNU General Public License |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
17 along with this program; if not, write to the Free Software |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
18 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
19 */ |
fa122b7c71c6
Add copyright notice and vim/emacs comments to libass and vf_ass.c.
eugeni
parents:
19652
diff
changeset
|
20 |
25897
aaebaf255b23
Consistently give all libass multiple inclusion guards a LIBASS_ prefix.
diego
parents:
25613
diff
changeset
|
21 #ifndef LIBASS_ASS_H |
aaebaf255b23
Consistently give all libass multiple inclusion guards a LIBASS_ prefix.
diego
parents:
25613
diff
changeset
|
22 #define LIBASS_ASS_H |
18937 | 23 |
24 #include "ass_types.h" | |
25 | |
20477 | 26 /// Libass renderer object. Contents are private. |
27 typedef struct ass_renderer_s ass_renderer_t; | |
18937 | 28 |
29 /// a linked list of images produced by ass renderer | |
30 typedef struct ass_image_s { | |
31 int w, h; // bitmap width/height | |
32 int stride; // bitmap stride | |
33 unsigned char* bitmap; // 1bpp stride*h alpha buffer | |
34 uint32_t color; // RGBA | |
35 int dst_x, dst_y; // bitmap placement inside the video frame | |
36 | |
37 struct ass_image_s* next; // linked list | |
38 } ass_image_t; | |
39 | |
23134
1de2a46a0987
Add -ass-hinting option for setting font hinting method.
eugeni
parents:
21506
diff
changeset
|
40 /// Hinting type |
1de2a46a0987
Add -ass-hinting option for setting font hinting method.
eugeni
parents:
21506
diff
changeset
|
41 typedef enum {ASS_HINTING_NONE = 0, |
1de2a46a0987
Add -ass-hinting option for setting font hinting method.
eugeni
parents:
21506
diff
changeset
|
42 ASS_HINTING_LIGHT, |
1de2a46a0987
Add -ass-hinting option for setting font hinting method.
eugeni
parents:
21506
diff
changeset
|
43 ASS_HINTING_NORMAL, |
1de2a46a0987
Add -ass-hinting option for setting font hinting method.
eugeni
parents:
21506
diff
changeset
|
44 ASS_HINTING_NATIVE |
1de2a46a0987
Add -ass-hinting option for setting font hinting method.
eugeni
parents:
21506
diff
changeset
|
45 } ass_hinting_t; |
1de2a46a0987
Add -ass-hinting option for setting font hinting method.
eugeni
parents:
21506
diff
changeset
|
46 |
18937 | 47 /** |
48 * \brief initialize the library | |
49 * \return library handle or NULL if failed | |
50 */ | |
20477 | 51 ass_library_t* ass_library_init(void); |
18937 | 52 |
53 /** | |
54 * \brief finalize the library | |
55 * \param priv library handle | |
56 */ | |
20477 | 57 void ass_library_done(ass_library_t*); |
58 | |
59 /** | |
60 * \brief set private font directory | |
61 * It is used for saving embedded fonts and also in font lookup. | |
62 */ | |
63 void ass_set_fonts_dir(ass_library_t* priv, const char* fonts_dir); | |
64 | |
65 void ass_set_extract_fonts(ass_library_t* priv, int extract); | |
66 | |
67 void ass_set_style_overrides(ass_library_t* priv, char** list); | |
18937 | 68 |
20477 | 69 /** |
70 * \brief initialize the renderer | |
71 * \param priv library handle | |
72 * \return renderer handle or NULL if failed | |
73 */ | |
74 ass_renderer_t* ass_renderer_init(ass_library_t*); | |
75 | |
76 /** | |
77 * \brief finalize the renderer | |
78 * \param priv renderer handle | |
79 */ | |
80 void ass_renderer_done(ass_renderer_t* priv); | |
81 | |
82 void ass_set_frame_size(ass_renderer_t* priv, int w, int h); | |
83 void ass_set_margins(ass_renderer_t* priv, int t, int b, int l, int r); | |
84 void ass_set_use_margins(ass_renderer_t* priv, int use); | |
85 void ass_set_aspect_ratio(ass_renderer_t* priv, double ar); | |
86 void ass_set_font_scale(ass_renderer_t* priv, double font_scale); | |
23134
1de2a46a0987
Add -ass-hinting option for setting font hinting method.
eugeni
parents:
21506
diff
changeset
|
87 void ass_set_hinting(ass_renderer_t* priv, ass_hinting_t ht); |
24554 | 88 void ass_set_line_spacing(ass_renderer_t* priv, double line_spacing); |
20477 | 89 |
90 /** | |
91 * \brief set font lookup defaults | |
92 */ | |
93 int ass_set_fonts(ass_renderer_t* priv, const char* default_font, const char* default_family); | |
18937 | 94 |
95 /** | |
96 * \brief render a frame, producing a list of ass_image_t | |
97 * \param priv library | |
98 * \param track subtitle track | |
99 * \param now video timestamp in milliseconds | |
100 */ | |
21506
8174acbf0633
Speed up ASS subtitles display by detecting changes between two consecutive
eugeni
parents:
21458
diff
changeset
|
101 ass_image_t* ass_render_frame(ass_renderer_t *priv, ass_track_t* track, long long now, int* detect_change); |
18937 | 102 |
103 | |
20477 | 104 // The following functions operate on track objects and do not need an ass_renderer // |
18937 | 105 |
106 /** | |
107 * \brief allocate a new empty track object | |
108 * \return pointer to empty track | |
109 */ | |
20477 | 110 ass_track_t* ass_new_track(ass_library_t*); |
18937 | 111 |
112 /** | |
113 * \brief deallocate track and all its child objects (styles and events) | |
114 * \param track track to deallocate | |
115 */ | |
116 void ass_free_track(ass_track_t* track); | |
117 | |
118 /** | |
119 * \brief allocate new style | |
120 * \param track track | |
121 * \return newly allocated style id | |
122 */ | |
123 int ass_alloc_style(ass_track_t* track); | |
124 | |
125 /** | |
126 * \brief allocate new event | |
127 * \param track track | |
128 * \return newly allocated event id | |
129 */ | |
130 int ass_alloc_event(ass_track_t* track); | |
131 | |
132 /** | |
19474
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
133 * \brief delete a style |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
134 * \param track track |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
135 * \param sid style id |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
136 * Deallocates style data. Does not modify track->n_styles. |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
137 */ |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
138 void ass_free_style(ass_track_t* track, int sid); |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
139 |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
140 /** |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
141 * \brief delete an event |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
142 * \param track track |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
143 * \param eid event id |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
144 * Deallocates event data. Does not modify track->n_events. |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
145 */ |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
146 void ass_free_event(ass_track_t* track, int eid); |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
147 |
07209f48e527
Add public functions for removal of styles and events.
eugeni
parents:
18937
diff
changeset
|
148 /** |
25514 | 149 * \brief Parse Codec Private section of subtitle stream |
18937 | 150 * \param track target track |
151 * \param data string to parse | |
152 * \param size length of data | |
153 */ | |
19492 | 154 void ass_process_codec_private(ass_track_t* track, char *data, int size); |
18937 | 155 |
156 /** | |
25515 | 157 * \brief Parse a chunk of subtitle stream data. In Matroska, this contains exactly 1 event (or a commentary). |
18937 | 158 * \param track track |
159 * \param data string to parse | |
160 * \param size length of data | |
161 * \param timecode starting time of the event (milliseconds) | |
162 * \param duration duration of the event (milliseconds) | |
163 */ | |
19492 | 164 void ass_process_chunk(ass_track_t* track, char *data, int size, long long timecode, long long duration); |
18937 | 165 |
23424
7286d245bf33
Move code for reading a file and recoding it to utf-8 to a separate function.
eugeni
parents:
23134
diff
changeset
|
166 char* read_file_recode(char* fname, char* codepage, int* size); |
7286d245bf33
Move code for reading a file and recoding it to utf-8 to a separate function.
eugeni
parents:
23134
diff
changeset
|
167 |
18937 | 168 /** |
169 * \brief Read subtitles from file. | |
170 * \param fname file name | |
171 * \return newly allocated track | |
172 */ | |
20477 | 173 ass_track_t* ass_read_file(ass_library_t* library, char* fname, char* codepage); |
18937 | 174 |
175 /** | |
20603 | 176 * \brief Read subtitles from memory. |
177 * \param library libass library object | |
178 * \param buf pointer to subtitles text | |
179 * \param bufsize size of buffer | |
180 * \param codepage recode buffer contents from given codepage | |
181 * \return newly allocated track | |
182 */ | |
183 ass_track_t* ass_read_memory(ass_library_t* library, char* buf, size_t bufsize, char* codepage); | |
184 /** | |
19652
2c016957360a
Add -ass-styles option. It allows to load styles from a file and use them
eugeni
parents:
19638
diff
changeset
|
185 * \brief read styles from file into already initialized track |
2c016957360a
Add -ass-styles option. It allows to load styles from a file and use them
eugeni
parents:
19638
diff
changeset
|
186 * \return 0 on success |
2c016957360a
Add -ass-styles option. It allows to load styles from a file and use them
eugeni
parents:
19638
diff
changeset
|
187 */ |
20477 | 188 int ass_read_styles(ass_track_t* track, char* fname, char* codepage); |
19652
2c016957360a
Add -ass-styles option. It allows to load styles from a file and use them
eugeni
parents:
19638
diff
changeset
|
189 |
2c016957360a
Add -ass-styles option. It allows to load styles from a file and use them
eugeni
parents:
19638
diff
changeset
|
190 /** |
21455 | 191 * \brief Add a memory font. |
18937 | 192 * \param name attachment name |
193 * \param data binary font data | |
194 * \param data_size data size | |
195 */ | |
21458
7af6c25a0cfc
Keep embedded fonts in ass_library_t and perform actual disk write
eugeni
parents:
21455
diff
changeset
|
196 void ass_add_font(ass_library_t* library, char* name, char* data, int data_size); |
18937 | 197 |
198 /** | |
25613
f00333e3facf
Copy font data to ass_library instead of referencing demuxer-owned memory.
eugeni
parents:
25535
diff
changeset
|
199 * \brief Remove all fonts stored in ass_library object |
f00333e3facf
Copy font data to ass_library instead of referencing demuxer-owned memory.
eugeni
parents:
25535
diff
changeset
|
200 */ |
f00333e3facf
Copy font data to ass_library instead of referencing demuxer-owned memory.
eugeni
parents:
25535
diff
changeset
|
201 void ass_clear_fonts(ass_library_t* library); |
f00333e3facf
Copy font data to ass_library instead of referencing demuxer-owned memory.
eugeni
parents:
25535
diff
changeset
|
202 |
f00333e3facf
Copy font data to ass_library instead of referencing demuxer-owned memory.
eugeni
parents:
25535
diff
changeset
|
203 /** |
18937 | 204 * \brief Calculates timeshift from now to the start of some other subtitle event, depending on movement parameter |
205 * \param track subtitle track | |
206 * \param now current time, ms | |
207 * \param movement how many events to skip from the one currently displayed | |
208 * +2 means "the one after the next", -1 means "previous" | |
209 * \return timeshift, ms | |
210 */ | |
211 long long ass_step_sub(ass_track_t* track, long long now, int movement); | |
212 | |
25897
aaebaf255b23
Consistently give all libass multiple inclusion guards a LIBASS_ prefix.
diego
parents:
25613
diff
changeset
|
213 #endif /* LIBASS_ASS_H */ |