git.sesse.net Git - vlc/blob - 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 it
   7  * 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 Lesser 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 Foundation,
  18  * 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 #include <assert.h>
  29
  30 static int Open (vlc_object_t *);
  31 static void Close (vlc_object_t *);
  32
  33 vlc_module_begin ()
  34     set_shortname (N_("Audio memory"))
  35     set_description (N_("Audio memory output"))
  36     set_capability ("audio output", 0)
  37     set_category (CAT_AUDIO)
  38     set_subcategory (SUBCAT_AUDIO_AOUT)
  39     set_callbacks (Open, Close)
  40
  41     add_string ("amem-format", "S16N",
  42                 N_("Sample format"), N_("Sample format"), false)
  43         change_private()
  44     add_integer ("amem-rate", 44100,
  45                  N_("Sample rate"), N_("Sample rate"), false)
  46         change_integer_range (1, 192000)
  47         change_private()
  48     add_integer ("amem-channels", 2,
  49                  N_("Channels count"), N_("Channels count"), false)
  50         change_integer_range (1, AOUT_CHAN_MAX)
  51         change_private()
  52
  53 vlc_module_end ()
  54
  55 struct aout_sys_t
  56 {
  57     void *opaque;
  58     void (*play) (void *opaque, const void *data, unsigned count, int64_t pts);
  59     void (*pause) (void *opaque, int64_t pts);
  60     void (*resume) (void *opaque, int64_t pts);
  61     void (*flush) (void *opaque);
  62     void (*drain) (void *opaque);
  63     int (*set_volume) (void *opaque, float vol, bool mute);
  64     void (*cleanup) (void *opaque);
  65     float volume;
  66     bool mute;
  67 };
  68
  69 static void Play (audio_output_t *aout, block_t *block)
  70 {
  71     aout_sys_t *sys = aout->sys;
  72
  73     sys->play (sys->opaque, block->p_buffer, block->i_nb_samples,
  74                block->i_pts);
  75     block_Release (block);
  76 }
  77
  78 static void Pause (audio_output_t *aout, bool paused, mtime_t date)
  79 {
  80     aout_sys_t *sys = aout->sys;
  81     void (*cb) (void *, int64_t) = paused ? sys->pause : sys->resume;
  82
  83     if (cb != NULL)
  84         cb (sys->opaque, date);
  85 }
  86
  87 static void Flush (audio_output_t *aout, bool wait)
  88 {
  89     aout_sys_t *sys = aout->sys;
  90     void (*cb) (void *) = wait ? sys->drain : sys->flush;
  91
  92     if (cb != NULL)
  93         cb (sys->opaque);
  94 }
  95
  96 static int VolumeSet (audio_output_t *aout, float vol)
  97 {
  98     aout_sys_t *sys = aout->sys;
  99
 100     sys->volume = vol;
 101     return sys->set_volume (sys->opaque, vol, sys->mute) ? -1 : 0;
 102 }
 103
 104 static int MuteSet (audio_output_t *aout, bool mute)
 105 {
 106     aout_sys_t *sys = aout->sys;
 107
 108     sys->mute = mute;
 109     return sys->set_volume (sys->opaque, sys->volume, mute) ? -1 : 0;
 110 }
 111
 112 typedef int (*vlc_audio_format_cb) (void **, char *, unsigned *, unsigned *);
 113
 114 static int Open (vlc_object_t *obj)
 115 {
 116     audio_output_t *aout = (audio_output_t *)obj;
 117     aout_sys_t *sys = malloc (sizeof (*sys));
 118     if (unlikely(sys == NULL))
 119         return VLC_ENOMEM;
 120
 121     aout->sys = sys;
 122     sys->opaque = var_InheritAddress (obj, "amem-data");
 123     sys->play = var_InheritAddress (obj, "amem-play");
 124     sys->pause = var_InheritAddress (obj, "amem-pause");
 125     sys->resume = var_InheritAddress (obj, "amem-resume");
 126     sys->flush = var_InheritAddress (obj, "amem-flush");
 127     sys->drain = var_InheritAddress (obj, "amem-drain");
 128     sys->set_volume = var_InheritAddress (obj, "amem-set-volume");
 129     sys->cleanup = NULL; /* defer */
 130     sys->volume = 1.;
 131     sys->mute = false;
 132     if (sys->play == NULL)
 133         goto error;
 134
 135     vlc_audio_format_cb setup = var_InheritAddress (obj, "amem-setup");
 136     char format[5] = "S16N";
 137     unsigned rate, channels;
 138
 139     if (setup != NULL)
 140     {
 141         rate = aout->format.i_rate;
 142         channels = aout_FormatNbChannels(&aout->format);
 143
 144         if (setup (&sys->opaque, format, &rate, &channels))
 145             goto error;
 146         /* Only call this callback if setup succeeded */
 147         sys->cleanup = var_InheritAddress (obj, "amem-cleanup");
 148     }
 149     else
 150     {
 151         rate = var_InheritInteger (obj, "amem-rate");
 152         channels = var_InheritInteger (obj, "amem-channels");
 153     }
 154
 155     if (rate == 0 || rate > 192000
 156      || channels == 0 || channels > AOUT_CHAN_MAX)
 157         goto error;
 158
 159     /* TODO: amem-format */
 160     if (strcmp(format, "S16N"))
 161     {
 162         msg_Err (aout, "format not supported");
 163         goto error;
 164     }
 165
 166     /* channel mapping */
 167     switch (channels)
 168     {
 169         case 1:
 170             aout->format.i_physical_channels = AOUT_CHAN_CENTER;
 171             break;
 172         case 2:
 173             aout->format.i_physical_channels =
 174                 AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
 175             break;
 176         case 3:
 177             aout->format.i_physical_channels =
 178                 AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_LFE;
 179             break;
 180         case 4:
 181             aout->format.i_physical_channels =
 182                 AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT |
 183                 AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
 184             break;
 185         case 5:
 186             aout->format.i_physical_channels =
 187                 AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER |
 188                 AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT;
 189             break;
 190         case 6:
 191             aout->format.i_physical_channels =
 192                 AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER |
 193                 AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE;
 194             break;
 195         case 7:
 196             aout->format.i_physical_channels =
 197                 AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER |
 198                 AOUT_CHAN_REARCENTER | AOUT_CHAN_MIDDLELEFT |
 199                 AOUT_CHAN_MIDDLERIGHT | AOUT_CHAN_LFE;
 200             break;
 201         case 8:
 202             aout->format.i_physical_channels =
 203                 AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER |
 204                 AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT |
 205                 AOUT_CHAN_MIDDLELEFT | AOUT_CHAN_MIDDLERIGHT | AOUT_CHAN_LFE;
 206             break;
 207         default:
 208             assert(0);
 209     }
 210
 211     aout->format.i_format = VLC_CODEC_S16N;
 212     aout->format.i_rate = rate;
 213     aout->format.i_original_channels = aout->format.i_physical_channels;
 214
 215     aout->pf_play = Play;
 216     aout->pf_pause = Pause;
 217     aout->pf_flush = Flush;
 218     if (sys->set_volume != NULL)
 219     {
 220         aout->volume_set = VolumeSet;
 221         aout->mute_set = MuteSet;
 222     }
 223     else
 224         aout_VolumeSoftInit (aout);
 225     return VLC_SUCCESS;
 226
 227 error:
 228     Close (obj);
 229     return VLC_EGENERIC;
 230 }
 231
 232 static void Close (vlc_object_t *obj)
 233 {
 234     audio_output_t *aout = (audio_output_t *)obj;
 235     aout_sys_t *sys = aout->sys;
 236
 237     if (sys->cleanup != NULL)
 238         sys->cleanup (sys->opaque);
 239     free (sys);
 240 }