]> git.sesse.net Git - vlc/blobdiff - include/vlc/vlc.h
LGPL
[vlc] / include / vlc / vlc.h
index 212033905c84180ec8a3831eb8ec799a2668b142..8f39094bd4b15c99288cecd001f76fcc10565daa 100644 (file)
 /*****************************************************************************
- * vlc.h: global header for vlc
+ * vlc.h: global header for libvlc
  *****************************************************************************
- * Copyright (C) 1998, 1999, 2000 VideoLAN
- * $Id: vlc.h,v 1.5 2002/07/17 21:58:21 massiot Exp $
+ * Copyright (C) 1998-2008 VLC authors and VideoLAN
+ * $Id$
  *
- * 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
+ * Authors: Vincent Seguin <seguin@via.ecp.fr>
+ *          Samuel Hocevar <sam@zoy.org>
+ *          Gildas Bazin <gbazin@netcourrier.com>
+ *          Derk-Jan Hartman <hartman at videolan dot org>
+ *          Pierre d'Herbemont <pdherbemont@videolan.org>
+ *
+ * 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., 59 Temple Place - Suite 330, Boston, MA  02111, 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_VLC_H
-#define _VLC_VLC_H 1
+#ifndef VLC_VLC_H
+#define VLC_VLC_H 1
+
+/**
+ * \file
+ * This file defines libvlc new external API
+ */
 
 # ifdef __cplusplus
 extern "C" {
 # endif
 
-/*****************************************************************************
- * Our custom types
- *****************************************************************************/
-#define VLC_DECLARE_STRUCT( name ) \
-    struct name##_s;         \
-    typedef struct name##_s name##_t;
-VLC_DECLARE_STRUCT(vlc)
-VLC_DECLARE_STRUCT(vlc_object)
-
-typedef signed int vlc_error_t;
-typedef int        vlc_bool_t;
-typedef int        vlc_status_t;
-
-/*****************************************************************************
- * Error values
- *****************************************************************************/
-#define VLC_SUCCESS         -0                                   /* No error */
-#define VLC_EGENERIC        -1                              /* Generic error */
-#define VLC_ENOMEM          -2                          /* Not enough memory */
-#define VLC_ESTATUS         -3                             /* Invalid status */
-#define VLC_EEXIT         -255                             /* Program exited */
-
-/*****************************************************************************
- * Booleans
- *****************************************************************************/
-#define VLC_FALSE 0
-#define VLC_TRUE  1
-
-/*****************************************************************************
- * Main structure status
- *****************************************************************************/
-#define VLC_STATUS_NONE     0x00000000
-#define VLC_STATUS_CREATED  0x02020202
-#define VLC_STATUS_STOPPED  0x12121212
-#define VLC_STATUS_RUNNING  0x42424242
-
-/*****************************************************************************
- * Playlist
- *****************************************************************************/
-
-/* Used by playlist_Add */
-#define PLAYLIST_INSERT      0x0001
-#define PLAYLIST_REPLACE     0x0002
-#define PLAYLIST_APPEND      0x0004
-#define PLAYLIST_GO          0x0008
-
-#define PLAYLIST_END           -666
-
-/* Playlist parsing mode */
-#define PLAYLIST_REPEAT_CURRENT   0             /* Keep playing current item */
-#define PLAYLIST_FORWARD          1              /* Parse playlist until end */
-#define PLAYLIST_BACKWARD        -1                       /* Parse backwards */
-#define PLAYLIST_FORWARD_LOOP     2               /* Parse playlist and loop */
-#define PLAYLIST_BACKWARD_LOOP   -2              /* Parse backwards and loop */
-#define PLAYLIST_RANDOM           3                          /* Shuffle play */
-#define PLAYLIST_REVERSE_RANDOM  -3                  /* Reverse shuffle play */
-
-/* Playlist commands */
-#define PLAYLIST_PLAY   1                         /* Starts playing. No arg. */
-#define PLAYLIST_PAUSE  2                 /* Toggles playlist pause. No arg. */
-#define PLAYLIST_STOP   3                          /* Stops playing. No arg. */
-#define PLAYLIST_SKIP   4                          /* Skip X items and play. */
-#define PLAYLIST_GOTO   5                                  /* Goto Xth item. */
-#define PLAYLIST_MODE   6                          /* Set playlist mode. ??? */
-
-/*****************************************************************************
- * Required internal headers
- *****************************************************************************/
-#if defined( __VLC__ )
-#   include "defs.h"
-#   include "config.h"
-#   include "modules_inner.h"
-#   include "vlc_common.h"
-#   include "os_specific.h"
-#   include "vlc_messages.h"
-#   include "mtime.h"
-#   include "modules.h"
-#   include "main.h"
-#   include "configuration.h"
-#   include "vlc_objects.h"
-#endif
-
-/*****************************************************************************
- * Exported libvlc base API
- *****************************************************************************/
-vlc_t *         vlc_create     ( void );
-vlc_error_t     vlc_init       ( vlc_t *, int, char *[] );
-vlc_error_t     vlc_run        ( vlc_t * );
-vlc_error_t     vlc_stop       ( vlc_t * );
-vlc_error_t     vlc_end        ( vlc_t * );
-vlc_error_t     vlc_destroy    ( vlc_t * );
-
-vlc_error_t     vlc_add_intf   ( vlc_t *, const char *, vlc_bool_t );
-vlc_error_t     vlc_add_target ( vlc_t *, const char *, int, int );
-
-vlc_status_t    vlc_status     ( vlc_t * );
+#include <vlc/libvlc_structures.h>
+#include <vlc/libvlc.h>
+#include <vlc/libvlc_media.h>
+#include <vlc/libvlc_media_player.h>
+#include <vlc/libvlc_media_list.h>
+#include <vlc/libvlc_media_list_player.h>
+#include <vlc/libvlc_media_library.h>
+#include <vlc/libvlc_media_discoverer.h>
+#include <vlc/libvlc_events.h>
+#include <vlc/libvlc_vlm.h>
+#include <vlc/deprecated.h>
 
 # ifdef __cplusplus
 }
 # endif
 
-#endif /* <vlc/vlc.h> */
+#endif /* _VLC_VLC_H */