Add block_shm_Alloc()

[vlc] / include / vlc_spu.h

diff --git a/include/vlc_spu.h b/include/vlc_spu.h
index 5e454bc01e478287e4dde2b14ed7219bc8603c5a..d448d06f8c9f9c91d70239ff0d07cb5ceac06423 100644 (file)
--- a/include/vlc_spu.h
+++ b/include/vlc_spu.h
@@ -1,26 +1,26 @@
 /*****************************************************************************
  * vlc_spu.h: spu_t definition and functions.
  *****************************************************************************
- * Copyright (C) 1999-2010 the VideoLAN team
+ * Copyright (C) 1999-2010 VLC authors and VideoLAN
  * Copyright (C) 2010 Laurent Aimar
  * $Id$
  *
  * Authors: Gildas Bazin <gbazin@videolan.org>
  *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 #ifndef VLC_SPU_H
@@ -58,10 +58,9 @@ struct spu_t
     spu_private_t *p;
 };
 
-VLC_EXPORT( spu_t *, spu_Create, ( vlc_object_t * ) );
+VLC_API spu_t * spu_Create( vlc_object_t * );
 #define spu_Create(a) spu_Create(VLC_OBJECT(a))
-VLC_EXPORT( void, spu_Destroy, ( spu_t * ) );
-void spu_Attach( spu_t *, vlc_object_t *, bool );
+VLC_API void spu_Destroy( spu_t * );
 
 /**
  * This function sends a subpicture to the spu_t core.
@@ -69,37 +68,39 @@ void spu_Attach( spu_t *, vlc_object_t *, bool );
  * You cannot use the provided subpicture anymore. The spu_t core
  * will destroy it at its convenience.
  */
-VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) );
+VLC_API void spu_PutSubpicture( spu_t *, subpicture_t * );
 
 /**
- * This function asks the spu_t core a list of subpictures to display.
+ * This function will return an unique subpicture containing the OSD and
+ * subtitles visibles at the requested date.
  *
- * The returned list can only be used by spu_RenderSubpictures.
- */
-VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t render_subtitle_date, bool b_subtitle_only ) );
-
-/**
- * This function renders a list of subpicture_t on the provided picture.
- *
- * \param p_fmt_dst is the format of the destination picture.
+ * \param p_chroma_list is a list of supported chroma for the output (can be NULL)
+ * \param p_fmt_dst is the format of the picture on which the return subpicture will be rendered.
  * \param p_fmt_src is the format of the original(source) video.
+ *
+ * The returned value if non NULL must be released by subpicture_Delete().
  */
-VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *,  picture_t *, const video_format_t *p_fmt_dst, subpicture_t *p_list, const video_format_t *p_fmt_src, mtime_t render_subtitle_date ) );
+VLC_API subpicture_t * spu_Render( spu_t *, const vlc_fourcc_t *p_chroma_list, const video_format_t *p_fmt_dst, const video_format_t *p_fmt_src, mtime_t render_subtitle_date, mtime_t render_osd_date, bool ignore_osd );
 
 /**
  * It registers a new SPU channel.
  */
-VLC_EXPORT( int, spu_RegisterChannel, ( spu_t * ) );
+VLC_API int spu_RegisterChannel( spu_t * );
 
 /**
  * It clears all subpictures associated to a SPU channel.
  */
-VLC_EXPORT( void, spu_ClearChannel, ( spu_t *, int ) );
+VLC_API void spu_ClearChannel( spu_t *, int );
+
+/**
+ * It changes the sub sources list
+ */
+VLC_API void spu_ChangeSources( spu_t *, const char * );
 
 /**
  * It changes the sub filters list
  */
-VLC_EXPORT( void, spu_ChangeFilters, ( spu_t *, const char * ) );
+VLC_API void spu_ChangeFilters( spu_t *, const char * );
 
 /** @}*/