]> git.sesse.net Git - vlc/blob - modules/audio_output/amem.c
Add virtual audio output plugin
[vlc] / modules / audio_output / amem.c
1 /*****************************************************************************
2  * amem.c : virtual LibVLC audio output plugin
3  *****************************************************************************
4  * Copyright (C) 2011 RĂ©mi Denis-Courmont
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as published by
8  * the Free Software Foundation; either version 2.1 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
19  *****************************************************************************/
20
21 #ifdef HAVE_CONFIG_H
22 # include "config.h"
23 #endif
24
25 #include <vlc_common.h>
26 #include <vlc_plugin.h>
27 #include <vlc_aout.h>
28
29 static int Open (vlc_object_t *);
30 static void Close (vlc_object_t *);
31
32 vlc_module_begin ()
33     set_shortname (N_("Audio memory"))
34     set_description (N_("Audio memory output"))
35     set_capability ("audio output", 0)
36     set_category (CAT_AUDIO)
37     set_subcategory (SUBCAT_AUDIO_AOUT)
38     set_callbacks (Open, Close)
39
40     add_string ("amem-format", "S16N",
41                 N_("Sample format"), N_("Sample format"), false)
42         change_private()
43     add_integer ("amem-rate", 44100,
44                  N_("Sample rate"), N_("Sample rate"), false)
45         change_integer_range (1, 192000)
46         change_private()
47     add_integer ("amem-channels", 2,
48                  N_("Channels count"), N_("Channels count"), false)
49         change_integer_range (1, AOUT_CHAN_MAX)
50         change_private()
51
52 vlc_module_end ()
53
54 struct aout_sys_t
55 {
56     void *opaque;
57     void (*play) (void *opaque, const void *data, size_t count, int64_t pts);
58     int (*set_volume) (void *opaque, float vol, bool mute);
59     void (*cleanup) (void *opaque);
60 };
61
62 static void Play (aout_instance_t *aout)
63 {
64     aout_sys_t *sys = aout->output.p_sys;
65     block_t *block;
66
67     while ((block = aout_FifoPop(aout, &aout->output.fifo)) != NULL)
68     {
69         sys->play (sys->opaque, block->p_buffer, block->i_nb_samples,
70                    block->i_pts);
71         block_Release (block);
72     }
73 }
74
75 static int VolumeSet (aout_instance_t *aout, audio_volume_t ivol, bool mute)
76 {
77     aout_sys_t *sys = aout->output.p_sys;
78     float fvol = ivol / (float)AOUT_VOLUME_DEFAULT;
79
80     return sys->set_volume (sys->opaque, fvol, mute) ? -1 : 0;
81 }
82
83 typedef int (*vlc_audio_format_cb) (void **, char *, unsigned *, unsigned *);
84
85 static int Open (vlc_object_t *obj)
86 {
87     aout_instance_t *aout = (aout_instance_t *)obj;
88     aout_sys_t *sys = malloc (sizeof (*sys));
89     if (unlikely(sys == NULL))
90         return VLC_ENOMEM;
91
92     aout->output.p_sys = sys;
93     sys->opaque = var_InheritAddress (obj, "amem-data");
94     sys->play = var_InheritAddress (obj, "amem-play");
95     sys->set_volume = var_InheritAddress (obj, "amem-set-volume");
96     sys->cleanup = NULL; /* defer */
97     if (sys->play == NULL)
98         goto error;
99
100     vlc_audio_format_cb setup = var_InheritAddress (obj, "amem-setup");
101     char format[5] = "S16N";
102     unsigned rate, channels;
103
104     if (setup != NULL)
105     {
106         rate = aout->output.output.i_rate;
107         channels = aout_FormatNbChannels(&aout->output.output);
108
109         if (setup (&sys->opaque, format, &rate, &channels))
110             goto error;
111         /* Only call this callback if setup succeeded */ 
112         sys->cleanup = var_InheritAddress (obj, "amem-cleanup");
113     }
114     else
115     {
116         rate = var_InheritInteger (obj, "amem-rate");
117         channels = var_InheritInteger (obj, "amem-channels");
118     }
119
120     if (rate == 0 || rate > 192000
121      || channels == 0 || channels > AOUT_CHAN_MAX)
122         goto error;
123
124     /* TODO: amem-format */
125     /* FIXME/TODO channel mapping */
126     if (strcmp(format, "S16N") || aout->output.output.i_channels != channels)
127     {
128         msg_Err (aout, "format not supported");
129         goto error;
130     }
131     aout->output.output.i_format = VLC_CODEC_S16N;
132     aout->output.output.i_rate = rate;
133
134     aout->output.pf_play = Play;
135     if (sys->set_volume != NULL)
136         aout->output.pf_volume_set = VolumeSet;
137     else
138         aout_VolumeSoftInit (aout);
139     return VLC_SUCCESS;
140
141 error:
142     Close (obj);
143     return VLC_EGENERIC;
144 }
145
146 static void Close (vlc_object_t *obj)
147 {
148     aout_instance_t *aout = (aout_instance_t *)obj;
149     aout_sys_t *sys = aout->output.p_sys;
150
151     if (sys->cleanup != NULL)
152         sys->cleanup (sys->opaque);
153     free (sys);
154 }