]> git.sesse.net Git - vlc/blobdiff - include/vlc_aout.h
aout: add option to initialize hardware volume
[vlc] / include / vlc_aout.h
index a0791f8e5109befe0843be79652f712c6080e1de..e2ef66812dbb553a7cddf587413add64d61a228a 100644 (file)
@@ -1,23 +1,23 @@
 /*****************************************************************************
  * vlc_aout.h : audio output interface
  *****************************************************************************
- * Copyright (C) 2002-2011 the VideoLAN team
+ * Copyright (C) 2002-2011 VLC authors and VideoLAN
  *
  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  *
- * 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_AOUT_H
       && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
       && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
 
+#define AOUT_FMT_LINEAR( p_format ) \
+    (aout_BitsPerSample((p_format)->i_format) != 0)
+
 #define VLC_CODEC_SPDIFL VLC_FOURCC('s','p','d','i')
 #define VLC_CODEC_SPDIFB VLC_FOURCC('s','p','d','b')
 
-#define AOUT_FMT_NON_LINEAR( p_format )                 \
+#define AOUT_FMT_SPDIF( p_format ) \
     ( ((p_format)->i_format == VLC_CODEC_SPDIFL)       \
        || ((p_format)->i_format == VLC_CODEC_SPDIFB)   \
        || ((p_format)->i_format == VLC_CODEC_A52)       \
@@ -102,29 +105,6 @@ typedef int32_t vlc_fixed_t;
 #define FIXED32_MAX ((vlc_fixed_t) +0x7fffffffL)
 #define FIXED32_ONE ((vlc_fixed_t) 0x10000000)
 
-/*
- * Channels descriptions
- */
-
-/* Values available for physical and original channels */
-#define AOUT_CHAN_CENTER            0x1
-#define AOUT_CHAN_LEFT              0x2
-#define AOUT_CHAN_RIGHT             0x4
-#define AOUT_CHAN_REARCENTER        0x10
-#define AOUT_CHAN_REARLEFT          0x20
-#define AOUT_CHAN_REARRIGHT         0x40
-#define AOUT_CHAN_MIDDLELEFT        0x100
-#define AOUT_CHAN_MIDDLERIGHT       0x200
-#define AOUT_CHAN_LFE               0x1000
-
-/* Values available for original channels only */
-#define AOUT_CHAN_DOLBYSTEREO       0x10000
-#define AOUT_CHAN_DUALMONO          0x20000
-#define AOUT_CHAN_REVERSESTEREO     0x40000
-
-#define AOUT_CHAN_PHYSMASK          0xFFFF
-#define AOUT_CHAN_MAX               9
-
 /* Values used for the audio-device and audio-channels object variables */
 #define AOUT_VAR_MONO               1
 #define AOUT_VAR_STEREO             2
@@ -163,8 +143,6 @@ struct audio_output
 {
     VLC_COMMON_MEMBERS
 
-    vlc_mutex_t             lock;
-
     audio_sample_format_t format; /**< Output format (plugin can modify it
         only when succesfully probed and not afterward) */
 
@@ -192,8 +170,6 @@ static const uint32_t pi_vlc_chan_order_wg4[] =
  * Prototypes
  *****************************************************************************/
 
-VLC_API aout_buffer_t * aout_OutputNextBuffer( audio_output_t *, mtime_t, bool ) VLC_USED;
-
 /**
  * This function computes the reordering needed to go from pi_chan_order_in to
  * pi_chan_order_out.
@@ -233,19 +209,23 @@ VLC_API void aout_ChannelExtract( void *p_dst, int i_dst_channels, const void *p
 /* */
 static inline unsigned aout_FormatNbChannels(const audio_sample_format_t *fmt)
 {
-    return popcount(fmt->i_physical_channels & AOUT_CHAN_PHYSMASK);
+    return popcount(fmt->i_physical_channels);
 }
 
 VLC_API unsigned int aout_BitsPerSample( vlc_fourcc_t i_format ) VLC_USED;
 VLC_API void aout_FormatPrepare( audio_sample_format_t * p_format );
-VLC_API void aout_FormatPrint( audio_output_t * p_aout, const char * psz_text, const audio_sample_format_t * p_format );
+VLC_API void aout_FormatPrint(vlc_object_t *, const char *,
+                              const audio_sample_format_t *);
+#define aout_FormatPrint(o, t, f) aout_FormatPrint(VLC_OBJECT(o), t, f)
 VLC_API const char * aout_FormatPrintChannels( const audio_sample_format_t * ) VLC_USED;
 
 VLC_API void aout_VolumeNoneInit( audio_output_t * );
 VLC_API void aout_VolumeSoftInit( audio_output_t * );
-VLC_API void aout_VolumeHardInit( audio_output_t *, aout_volume_cb );
+VLC_API void aout_VolumeHardInit( audio_output_t *, aout_volume_cb, bool );
 VLC_API void aout_VolumeHardSet( audio_output_t *, float, bool );
 
+VLC_API void aout_TimeReport(audio_output_t *, mtime_t);
+
 VLC_API int aout_ChannelsRestart( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * );
 
 /* */
@@ -262,22 +242,23 @@ struct aout_fifo_t
 /* Legacy packet-oriented audio output helpers */
 typedef struct
 {
-   aout_fifo_t partial; /**< Audio blocks before packetization */
-   aout_fifo_t fifo; /**< Packetized audio blocks */
-   mtime_t pause_date; /**< Date when paused or VLC_TS_INVALID */
-   unsigned samples; /**< Samples per packet */
-   bool starving;
-   /* Indicates whether the audio output is currently starving, to avoid
-    * printing a 1,000 "output is starving" messages. */
+    vlc_mutex_t lock;
+    aout_fifo_t partial; /**< Audio blocks before packetization */
+    aout_fifo_t fifo; /**< Packetized audio blocks */
+    mtime_t pause_date; /**< Date when paused or VLC_TS_INVALID */
+    mtime_t time_report; /**< Desynchronization estimate or VLC_TS_INVALID */
+    unsigned samples; /**< Samples per packet */
+    bool starving; /**< Whether currently starving (to limit error messages) */
 } aout_packet_t;
 
-VLC_API void aout_PacketInit(audio_output_t *, aout_packet_t *, unsigned);
-VLC_API void aout_PacketDestroy(audio_output_t *);
+VLC_DEPRECATED void aout_PacketInit(audio_output_t *, aout_packet_t *, unsigned);
+VLC_DEPRECATED void aout_PacketDestroy(audio_output_t *);
+
+VLC_DEPRECATED void aout_PacketPlay(audio_output_t *, block_t *);
+VLC_DEPRECATED void aout_PacketPause(audio_output_t *, bool, mtime_t);
+VLC_DEPRECATED void aout_PacketFlush(audio_output_t *, bool);
 
-VLC_API void aout_PacketPlay(audio_output_t *, block_t *);
-VLC_API void aout_PacketPause(audio_output_t *, bool, mtime_t);
-VLC_API void aout_PacketFlush(audio_output_t *, bool);
+VLC_DEPRECATED block_t *aout_PacketNext(audio_output_t *, mtime_t) VLC_USED;
 
-VLC_API block_t *aout_PacketNext(audio_output_t *, mtime_t, bool) VLC_USED;
 
 #endif /* VLC_AOUT_H */