Alc/backends/solaris.cpp

   1 /**
   2  * OpenAL cross platform audio library
   3  * Copyright (C) 1999-2007 by authors.
   4  * This library is free software; you can redistribute it and/or
   5  *  modify it under the terms of the GNU Library General Public
   6  *  License as published by the Free Software Foundation; either
   7  *  version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  *  Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  *  License along with this library; if not, write to the
  16  *  Free Software Foundation, Inc.,
  17  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  * Or go to http://www.gnu.org/copyleft/lgpl.html
  19  */
  20
  21 #include "config.h"
  22
  23 #include "backends/solaris.h"
  24
  25 #include <sys/ioctl.h>
  26 #include <sys/types.h>
  27 #include <sys/time.h>
  28 #include <sys/stat.h>
  29 #include <fcntl.h>
  30 #include <stdlib.h>
  31 #include <stdio.h>
  32 #include <memory.h>
  33 #include <unistd.h>
  34 #include <errno.h>
  35 #include <math.h>
  36
  37 #include <thread>
  38
  39 #include "alMain.h"
  40 #include "alu.h"
  41 #include "alconfig.h"
  42 #include "threads.h"
  43 #include "compat.h"
  44
  45 #include <sys/audioio.h>
  46
  47
  48 struct ALCsolarisBackend final : public ALCbackend {
  49     int fd{-1};
  50
  51     ALubyte *mix_data{nullptr};
  52     int data_size{0};
  53
  54     std::atomic<ALenum> mKillNow{AL_TRUE};
  55     std::thread mThread;
  56 };
  57
  58 static int ALCsolarisBackend_mixerProc(ALCsolarisBackend *self);
  59
  60 static void ALCsolarisBackend_Construct(ALCsolarisBackend *self, ALCdevice *device);
  61 static void ALCsolarisBackend_Destruct(ALCsolarisBackend *self);
  62 static ALCenum ALCsolarisBackend_open(ALCsolarisBackend *self, const ALCchar *name);
  63 static ALCboolean ALCsolarisBackend_reset(ALCsolarisBackend *self);
  64 static ALCboolean ALCsolarisBackend_start(ALCsolarisBackend *self);
  65 static void ALCsolarisBackend_stop(ALCsolarisBackend *self);
  66 static DECLARE_FORWARD2(ALCsolarisBackend, ALCbackend, ALCenum, captureSamples, void*, ALCuint)
  67 static DECLARE_FORWARD(ALCsolarisBackend, ALCbackend, ALCuint, availableSamples)
  68 static DECLARE_FORWARD(ALCsolarisBackend, ALCbackend, ClockLatency, getClockLatency)
  69 static DECLARE_FORWARD(ALCsolarisBackend, ALCbackend, void, lock)
  70 static DECLARE_FORWARD(ALCsolarisBackend, ALCbackend, void, unlock)
  71 DECLARE_DEFAULT_ALLOCATORS(ALCsolarisBackend)
  72
  73 DEFINE_ALCBACKEND_VTABLE(ALCsolarisBackend);
  74
  75
  76 static const ALCchar solaris_device[] = "Solaris Default";
  77
  78 static const char *solaris_driver = "/dev/audio";
  79
  80
  81 static void ALCsolarisBackend_Construct(ALCsolarisBackend *self, ALCdevice *device)
  82 {
  83     new (self) ALCsolarisBackend{};
  84     ALCbackend_Construct(STATIC_CAST(ALCbackend, self), device);
  85     SET_VTABLE2(ALCsolarisBackend, ALCbackend, self);
  86 }
  87
  88 static void ALCsolarisBackend_Destruct(ALCsolarisBackend *self)
  89 {
  90     if(self->fd != -1)
  91         close(self->fd);
  92     self->fd = -1;
  93
  94     free(self->mix_data);
  95     self->mix_data = nullptr;
  96     self->data_size = 0;
  97
  98     ALCbackend_Destruct(STATIC_CAST(ALCbackend, self));
  99     self->~ALCsolarisBackend();
 100 }
 101
 102
 103 static int ALCsolarisBackend_mixerProc(ALCsolarisBackend *self)
 104 {
 105     ALCdevice *device = STATIC_CAST(ALCbackend, self)->mDevice;
 106     struct timeval timeout;
 107     ALubyte *write_ptr;
 108     ALint frame_size;
 109     ALint to_write;
 110     ssize_t wrote;
 111     fd_set wfds;
 112     int sret;
 113
 114     SetRTPriority();
 115     althrd_setname(MIXER_THREAD_NAME);
 116
 117     frame_size = FrameSizeFromDevFmt(device->FmtChans, device->FmtType, device->mAmbiOrder);
 118
 119     ALCsolarisBackend_lock(self);
 120     while(!self->mKillNow.load(std::memory_order_acquire) &&
 121           device->Connected.load(std::memory_order_acquire))
 122     {
 123         FD_ZERO(&wfds);
 124         FD_SET(self->fd, &wfds);
 125         timeout.tv_sec = 1;
 126         timeout.tv_usec = 0;
 127
 128         ALCsolarisBackend_unlock(self);
 129         sret = select(self->fd+1, nullptr, &wfds, nullptr, &timeout);
 130         ALCsolarisBackend_lock(self);
 131         if(sret < 0)
 132         {
 133             if(errno == EINTR)
 134                 continue;
 135             ERR("select failed: %s\n", strerror(errno));
 136             aluHandleDisconnect(device, "Failed to wait for playback buffer: %s", strerror(errno));
 137             break;
 138         }
 139         else if(sret == 0)
 140         {
 141             WARN("select timeout\n");
 142             continue;
 143         }
 144
 145         write_ptr = self->mix_data;
 146         to_write = self->data_size;
 147         aluMixData(device, write_ptr, to_write/frame_size);
 148         while(to_write > 0 && !self->mKillNow.load())
 149         {
 150             wrote = write(self->fd, write_ptr, to_write);
 151             if(wrote < 0)
 152             {
 153                 if(errno == EAGAIN || errno == EWOULDBLOCK || errno == EINTR)
 154                     continue;
 155                 ERR("write failed: %s\n", strerror(errno));
 156                 aluHandleDisconnect(device, "Failed to write playback samples: %s",
 157                                     strerror(errno));
 158                 break;
 159             }
 160
 161             to_write -= wrote;
 162             write_ptr += wrote;
 163         }
 164     }
 165     ALCsolarisBackend_unlock(self);
 166
 167     return 0;
 168 }
 169
 170
 171 static ALCenum ALCsolarisBackend_open(ALCsolarisBackend *self, const ALCchar *name)
 172 {
 173     ALCdevice *device;
 174
 175     if(!name)
 176         name = solaris_device;
 177     else if(strcmp(name, solaris_device) != 0)
 178         return ALC_INVALID_VALUE;
 179
 180     self->fd = open(solaris_driver, O_WRONLY);
 181     if(self->fd == -1)
 182     {
 183         ERR("Could not open %s: %s\n", solaris_driver, strerror(errno));
 184         return ALC_INVALID_VALUE;
 185     }
 186
 187     device = STATIC_CAST(ALCbackend,self)->mDevice;
 188     device->DeviceName = name;
 189
 190     return ALC_NO_ERROR;
 191 }
 192
 193 static ALCboolean ALCsolarisBackend_reset(ALCsolarisBackend *self)
 194 {
 195     ALCdevice *device = STATIC_CAST(ALCbackend,self)->mDevice;
 196     audio_info_t info;
 197     ALsizei frameSize;
 198     ALsizei numChannels;
 199
 200     AUDIO_INITINFO(&info);
 201
 202     info.play.sample_rate = device->Frequency;
 203
 204     if(device->FmtChans != DevFmtMono)
 205         device->FmtChans = DevFmtStereo;
 206     numChannels = ChannelsFromDevFmt(device->FmtChans, device->mAmbiOrder);
 207     info.play.channels = numChannels;
 208
 209     switch(device->FmtType)
 210     {
 211         case DevFmtByte:
 212             info.play.precision = 8;
 213             info.play.encoding = AUDIO_ENCODING_LINEAR;
 214             break;
 215         case DevFmtUByte:
 216             info.play.precision = 8;
 217             info.play.encoding = AUDIO_ENCODING_LINEAR8;
 218             break;
 219         case DevFmtUShort:
 220         case DevFmtInt:
 221         case DevFmtUInt:
 222         case DevFmtFloat:
 223             device->FmtType = DevFmtShort;
 224             /* fall-through */
 225         case DevFmtShort:
 226             info.play.precision = 16;
 227             info.play.encoding = AUDIO_ENCODING_LINEAR;
 228             break;
 229     }
 230
 231     frameSize = numChannels * BytesFromDevFmt(device->FmtType);
 232     info.play.buffer_size = device->UpdateSize*device->NumUpdates * frameSize;
 233
 234     if(ioctl(self->fd, AUDIO_SETINFO, &info) < 0)
 235     {
 236         ERR("ioctl failed: %s\n", strerror(errno));
 237         return ALC_FALSE;
 238     }
 239
 240     if(ChannelsFromDevFmt(device->FmtChans, device->mAmbiOrder) != (ALsizei)info.play.channels)
 241     {
 242         ERR("Failed to set %s, got %u channels instead\n", DevFmtChannelsString(device->FmtChans), info.play.channels);
 243         return ALC_FALSE;
 244     }
 245
 246     if(!((info.play.precision == 8 && info.play.encoding == AUDIO_ENCODING_LINEAR8 && device->FmtType == DevFmtUByte) ||
 247          (info.play.precision == 8 && info.play.encoding == AUDIO_ENCODING_LINEAR && device->FmtType == DevFmtByte) ||
 248          (info.play.precision == 16 && info.play.encoding == AUDIO_ENCODING_LINEAR && device->FmtType == DevFmtShort) ||
 249          (info.play.precision == 32 && info.play.encoding == AUDIO_ENCODING_LINEAR && device->FmtType == DevFmtInt)))
 250     {
 251         ERR("Could not set %s samples, got %d (0x%x)\n", DevFmtTypeString(device->FmtType),
 252             info.play.precision, info.play.encoding);
 253         return ALC_FALSE;
 254     }
 255
 256     device->Frequency = info.play.sample_rate;
 257     device->UpdateSize = (info.play.buffer_size/device->NumUpdates) + 1;
 258
 259     SetDefaultChannelOrder(device);
 260
 261     free(self->mix_data);
 262     self->data_size = device->UpdateSize * FrameSizeFromDevFmt(
 263         device->FmtChans, device->FmtType, device->mAmbiOrder
 264     );
 265     self->mix_data = static_cast<ALubyte*>(calloc(1, self->data_size));
 266
 267     return ALC_TRUE;
 268 }
 269
 270 static ALCboolean ALCsolarisBackend_start(ALCsolarisBackend *self)
 271 {
 272     try {
 273         self->mKillNow.store(AL_FALSE);
 274         self->mThread = std::thread(ALCsolarisBackend_mixerProc, self);
 275         return ALC_TRUE;
 276     }
 277     catch(std::exception& e) {
 278         ERR("Could not create playback thread: %s\n", e.what());
 279     }
 280     catch(...) {
 281     }
 282     return ALC_FALSE;
 283 }
 284
 285 static void ALCsolarisBackend_stop(ALCsolarisBackend *self)
 286 {
 287     if(self->mKillNow.exchange(AL_TRUE) || !self->mThread.joinable())
 288         return;
 289
 290     self->mThread.join();
 291
 292     if(ioctl(self->fd, AUDIO_DRAIN) < 0)
 293         ERR("Error draining device: %s\n", strerror(errno));
 294 }
 295
 296
 297 BackendFactory &SolarisBackendFactory::getFactory()
 298 {
 299     static SolarisBackendFactory factory{};
 300     return factory;
 301 }
 302
 303 bool SolarisBackendFactory::init()
 304 {
 305     ConfigValueStr(nullptr, "solaris", "device", &solaris_driver);
 306     return true;
 307 }
 308
 309 bool SolarisBackendFactory::querySupport(ALCbackend_Type type)
 310 { return (type == ALCbackend_Playback); }
 311
 312 void SolarisBackendFactory::probe(enum DevProbe type, std::string *outnames)
 313 {
 314     switch(type)
 315     {
 316         case ALL_DEVICE_PROBE:
 317         {
 318 #ifdef HAVE_STAT
 319             struct stat buf;
 320             if(stat(solaris_driver, &buf) == 0)
 321 #endif
 322                 outnames->append(solaris_device, sizeof(solaris_device));
 323         }
 324         break;
 325
 326         case CAPTURE_DEVICE_PROBE:
 327             break;
 328     }
 329 }
 330
 331 ALCbackend *SolarisBackendFactory::createBackend(ALCdevice *device, ALCbackend_Type type)
 332 {
 333     if(type == ALCbackend_Playback)
 334     {
 335         ALCsolarisBackend *backend;
 336         NEW_OBJ(backend, ALCsolarisBackend)(device);
 337         if(!backend) return nullptr;
 338         return STATIC_CAST(ALCbackend, backend);
 339     }
 340
 341     return nullptr;
 342 }