config_openalAudio.cxx

Go to the documentation of this file.

/**
 * PANDA 3D SOFTWARE
 * Copyright (c) Carnegie Mellon University.  All rights reserved.
 *
 * All use of this software is subject to the terms of the revised BSD
 * license.  You should have received a copy of this license along
 * with this source code in a file named "LICENSE."
 *
 * @file config_openalAudio.cxx
 * @author cort
 */

#include "pandabase.h"

#include "config_openalAudio.h"
#include "openalAudioManager.h"
#include "openalAudioSound.h"
#include "pandaSystem.h"
#include "dconfig.h"

#if !defined(CPPPARSER) && !defined(LINK_ALL_STATIC) && !defined(BUILDING_OPENAL_AUDIO)
  #error Buildsystem error: BUILDING_OPENAL_AUDIO not defined
#endif

ConfigureDef(config_openalAudio);
NotifyCategoryDef(openalAudio, ":audio");

ConfigureFn(config_openalAudio) {
  init_libOpenALAudio();
}

ConfigVariableString openal_device
("openal-device", "",
 PRC_DESC("Specify the OpenAL device string for audio playback (no quotes).  If this "
          "is not specified, the OpenAL default device is used."));

ConfigVariableInt openal_buffer_delete_retries
("openal-buffer-delete-retries", 5,
 PRC_DESC("If deleting a buffer fails due to still being in use, the OpenAL "
          "sound plugin will wait a moment and retry deletion, with an "
          "exponentially-increasing delay for each try.  This number "
          "specifies how many repeat tries (not counting the initial try) "
          "should be made before giving up and raising an error."));

ConfigVariableDouble openal_buffer_delete_delay
("openal-buffer-delete-delay", 0.001,
 PRC_DESC("If deleting a buffer fails due to still being in use, the OpenAL "
          "sound plugin will wait a moment and retry deletion, with an "
          "exponentially-increasing delay for each try.  This number "
          "specifies how long, in seconds, the OpenAL plugin will wait after "
          "its first failed try.  The second try will be double this "
          "delay, the third quadruple, and so on."));


/**
 * Initializes the library.  This must be called at least once before any of
 * the functions or classes in this library can be used.  Normally it will be
 * called by the static initializers and need not be called explicitly, but
 * special cases exist.
 */
void
init_libOpenALAudio() {
  static bool initialized = false;
  if (initialized) {
    return;
  }

  initialized = true;
  OpenALAudioManager::init_type();
  OpenALAudioSound::init_type();

  AudioManager::register_AudioManager_creator(&Create_OpenALAudioManager);

  PandaSystem *ps = PandaSystem::get_global_ptr();
  ps->add_system("OpenAL");
  ps->add_system("audio");
  ps->set_system_tag("audio", "implementation", "OpenAL");
}

/**
 * This function is called when the dynamic library is loaded; it should
 * return the Create_AudioManager function appropriate to create an
 * OpenALAudioManager.
 */
Create_AudioManager_proc *
get_audio_manager_func_openal_audio() {
  init_libOpenALAudio();
  return &Create_OpenALAudioManager;
}