annotate eosd.h @ 32025:23d8b025634a

Mark vf_info_menu declaration as const.
author diego
date Thu, 09 Sep 2010 10:39:08 +0000
parents 710e01dbd994
children 2c49668d91c4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
31928
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
1 /*
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
2 * Extended On Screen Display
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
3 * Copyright (C) 2010 Nicolas George
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
4 *
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
5 * This file is part of MPlayer.
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
6 *
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
7 * MPlayer is free software; you can redistribute it and/or modify
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
8 * it under the terms of the GNU General Public License as published by
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
9 * the Free Software Foundation; either version 2 of the License, or
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
10 * (at your option) any later version.
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
11 *
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
12 * MPlayer is distributed in the hope that it will be useful,
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
15 * GNU General Public License for more details.
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
16 *
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License along
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
18 * with MPlayer; if not, write to the Free Software Foundation, Inc.,
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
20 */
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
21
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
22 #ifndef MPLAYER_EOSD_H
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
23 #define MPLAYER_EOSD_H
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
24
31942
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
25 /**
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
26 * Initialize the EOSD subsystem.
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
27 *
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
28 * @param vf the video filter chain where the rendering will take place.
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
29 */
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
30 void eosd_init(vf_instance_t *vf);
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
31
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
32 /**
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
33 * Configure the resolution for EOSD rendering.
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
34 * Should be called by the rendering engine whenever the resolution or
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
35 * settings change.
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
36 *
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
37 * @param res resolution and margins of the rendering area.
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
38 * @param hinting nonzero if hinting is useful.
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
39 */
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
40 void eosd_configure(mp_eosd_res_t *res, int hinting);
31928
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
41
31942
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
42 /**
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
43 * Renders the EOSD elements for the current frame.
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
44 * Should be called by the rendering engine when it is about to do or
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
45 * prepare the rendering.
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
46 *
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
47 * @param ts presentation timestamp of the frame.
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
48 * @param changed if not NULL, will be set to 0 if the elements are
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
49 * identical since the last call, 1 if they have changed
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
50 * only in coordinates, and 2 if they have really changed.
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
51 * @return a linked list of EOSD elements.
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
52 */
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
53 struct ass_image *eosd_render_frame(double ts, int *changed);
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
54
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
55 /**
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
56 * Shut down the EOSD subsystem and free the associated resources.
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
57 */
31928
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
58 void eosd_uninit(void);
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
59
31942
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
60 /**
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
61 * Initialize the use of EOSD for ASS subtitles rendering.
710e01dbd994 Add Doxygen comments and formal parameters names in eosd.h.
cigaes
parents: 31934
diff changeset
62 */
31934
30b03b5dbb3d Add #ifdefs to fix build with ASS disabled.
cigaes
parents: 31928
diff changeset
63 void eosd_ass_init(struct ass_library *);
31928
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
64
47c6a74eba0f Forgot to svn add those two files.
cigaes
parents:
diff changeset
65 #endif /* MPLAYER_EOSD_H */