Fix description
[vlc.git] / src / control / audio.c
blob22a886ef43bff20357921c57daf34f110886a350
1 /*****************************************************************************
2 * libvlc_audio.c: New libvlc audio control API
3 *****************************************************************************
4 * Copyright (C) 2006 the VideoLAN team
5 * $Id$
7 * Authors: Filippo Carone <filippo@carone.org>
8 * Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 #include "libvlc_internal.h"
26 #include <vlc/libvlc.h>
28 #include <vlc_input.h>
29 #include <vlc_aout.h>
33 * Remember to release the returned aout_instance_t since it is locked at
34 * the end of this function.
36 static aout_instance_t *GetAOut( libvlc_instance_t *p_instance,
37 libvlc_exception_t *p_exception )
39 aout_instance_t * p_aout = NULL;
41 p_aout = vlc_object_find( p_instance->p_libvlc_int, VLC_OBJECT_AOUT, FIND_CHILD );
42 if( !p_aout )
44 libvlc_exception_raise( p_exception, "No active audio output" );
45 return NULL;
48 return p_aout;
52 /*****************************************************************************
53 * libvlc_audio_get_mute : Get the volume state, true if muted
54 *****************************************************************************/
55 void libvlc_audio_toggle_mute( libvlc_instance_t *p_instance,
56 libvlc_exception_t *p_e )
58 VLC_UNUSED(p_e);
60 aout_VolumeMute( p_instance->p_libvlc_int, NULL );
63 int libvlc_audio_get_mute( libvlc_instance_t *p_instance,
64 libvlc_exception_t *p_e )
67 * If the volume level is 0, then the channel is muted
69 audio_volume_t i_volume;
71 i_volume = libvlc_audio_get_volume(p_instance, p_e);
72 if ( i_volume == 0 )
73 return true;
74 return false;
77 void libvlc_audio_set_mute( libvlc_instance_t *p_instance, int mute,
78 libvlc_exception_t *p_e )
80 if ( mute ^ libvlc_audio_get_mute( p_instance, p_e ) )
82 aout_VolumeMute( p_instance->p_libvlc_int, NULL );
86 /*****************************************************************************
87 * libvlc_audio_get_volume : Get the current volume (range 0-200 %)
88 *****************************************************************************/
89 int libvlc_audio_get_volume( libvlc_instance_t *p_instance,
90 libvlc_exception_t *p_e )
92 VLC_UNUSED(p_e);
94 audio_volume_t i_volume;
96 aout_VolumeGet( p_instance->p_libvlc_int, &i_volume );
98 return (i_volume*200+AOUT_VOLUME_MAX/2)/AOUT_VOLUME_MAX;
102 /*****************************************************************************
103 * libvlc_audio_set_volume : Set the current volume
104 *****************************************************************************/
105 void libvlc_audio_set_volume( libvlc_instance_t *p_instance, int i_volume,
106 libvlc_exception_t *p_e )
108 if( i_volume >= 0 && i_volume <= 200 )
110 i_volume = (i_volume * AOUT_VOLUME_MAX + 100) / 200;
112 aout_VolumeSet( p_instance->p_libvlc_int, i_volume );
114 else
116 libvlc_exception_raise( p_e, "Volume out of range" );
120 /*****************************************************************************
121 * libvlc_audio_get_track_count : Get the number of available audio tracks
122 *****************************************************************************/
123 int libvlc_audio_get_track_count( libvlc_media_player_t *p_mi,
124 libvlc_exception_t *p_e )
126 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
127 vlc_value_t val_list;
129 if( !p_input_thread )
130 return -1;
132 var_Change( p_input_thread, "audio-es", VLC_VAR_GETCHOICES, &val_list, NULL );
133 vlc_object_release( p_input_thread );
134 return val_list.p_list->i_count;
137 /*****************************************************************************
138 * libvlc_audio_get_track : Get the current audio track
139 *****************************************************************************/
140 int libvlc_audio_get_track( libvlc_media_player_t *p_mi,
141 libvlc_exception_t *p_e )
143 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
144 vlc_value_t val_list;
145 vlc_value_t val;
146 int i_track = -1;
147 int i_ret = -1;
148 int i;
150 if( !p_input_thread )
151 return -1;
153 i_ret = var_Get( p_input_thread, "audio-es", &val );
154 if( i_ret < 0 )
156 libvlc_exception_raise( p_e, "Getting Audio track information failed" );
157 vlc_object_release( p_input_thread );
158 return i_ret;
161 var_Change( p_input_thread, "audio-es", VLC_VAR_GETCHOICES, &val_list, NULL );
162 for( i = 0; i < val_list.p_list->i_count; i++ )
164 vlc_value_t track_val = val_list.p_list->p_values[i];
165 if( track_val.i_int == val.i_int )
167 i_track = i;
168 break;
171 vlc_object_release( p_input_thread );
172 return i_track;
176 /*****************************************************************************
177 * libvlc_audio_set_track : Set the current audio track
178 *****************************************************************************/
179 void libvlc_audio_set_track( libvlc_media_player_t *p_mi, int i_track,
180 libvlc_exception_t *p_e )
182 input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi, p_e );
183 vlc_value_t val_list;
184 int i_ret = -1;
185 int i;
187 if( !p_input_thread )
188 return;
190 var_Change( p_input_thread, "audio-es", VLC_VAR_GETCHOICES, &val_list, NULL );
191 for( i = 0; i < val_list.p_list->i_count; i++ )
193 vlc_value_t val = val_list.p_list->p_values[i];
194 if( i_track == val.i_int )
196 i_ret = var_Set( p_input_thread, "audio-es", val );
197 if( i_ret < 0 )
199 libvlc_exception_raise( p_e, "Setting audio track failed" );
201 vlc_object_release( p_input_thread );
202 return;
205 libvlc_exception_raise( p_e, "Audio track out of range" );
206 vlc_object_release( p_input_thread );
209 /*****************************************************************************
210 * libvlc_audio_get_channel : Get the current audio channel
211 *****************************************************************************/
212 int libvlc_audio_get_channel( libvlc_instance_t *p_instance,
213 libvlc_exception_t *p_e )
215 aout_instance_t *p_aout = GetAOut( p_instance, p_e );
216 if( p_aout )
218 vlc_value_t val;
220 var_Get( p_aout, "audio-channels", &val );
221 vlc_object_release( p_aout );
222 return val.i_int;
224 return -1;
227 /*****************************************************************************
228 * libvlc_audio_set_channel : Set the current audio channel
229 *****************************************************************************/
230 void libvlc_audio_set_channel( libvlc_instance_t *p_instance, int i_channel,
231 libvlc_exception_t *p_e )
233 aout_instance_t *p_aout = GetAOut( p_instance, p_e );
234 if( p_aout )
236 vlc_value_t val;
237 int i_ret = -1;
239 val.i_int = i_channel;
240 switch( i_channel )
242 case AOUT_VAR_CHAN_RSTEREO:
243 case AOUT_VAR_CHAN_STEREO:
244 case AOUT_VAR_CHAN_LEFT:
245 case AOUT_VAR_CHAN_RIGHT:
246 case AOUT_VAR_CHAN_DOLBYS:
247 i_ret = var_Set( p_aout, "audio-channels", val );
248 if( i_ret < 0 )
250 libvlc_exception_raise( p_e, "Failed setting audio channel" );
251 vlc_object_release( p_aout );
252 return;
254 vlc_object_release( p_aout );
255 return; /* Found */
256 default:
257 libvlc_exception_raise( p_e, "Audio channel out of range" );
258 break;
260 vlc_object_release( p_aout );