---

soundfactory.cpp

Go to the documentation of this file.

/* -------------------------------------------------------------
   From KDE Tuberling
   mailto:e.bischoff@noos.fr
 ------------------------------------------------------------- */
/*
 * Copyright (C) 2001-2003 Eric Bischoff
  Anne-Marie Mahfouf <annma@kde.org>

    This program is free software; you can redistribute it and/or
    modify it under the terms of version 2 of the GNU General Public
    License as published by the Free Software Foundation.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
#include <stdlib.h>

#include <kmessagebox.h>
#include <klocale.h>
#include <kaudioplayer.h>
#include <kdebug.h>


#include "soundfactory.h"
#include "soundfactory.moc"
#include "klettres.h"

SoundFactory::SoundFactory(KLettres *parent, const char *name, uint selectedLanguage)
        : QObject(parent, name)
{
  klettres = parent;

  namesList = filesList = 0;

  QDomDocument layoutsDocument;
  bool ok = klettres->loadLayout(layoutsDocument);
   if (ok)
        ok = registerLanguages(layoutsDocument);
  if (ok)
        ok = loadLanguage(layoutsDocument, selectedLanguage);
  if (!ok) loadFailure();
}

SoundFactory::~SoundFactory()
{
  if (namesList) delete [] namesList;
  if (filesList) delete [] filesList;
}

//When the language changes in KLettres menu
void SoundFactory::change(uint selectedLanguage)
{
  QDomDocument layoutsDocument;
  bool ok = klettres->loadLayout(layoutsDocument);
  //go load the sounds for the current language
  if (ok) ok = loadLanguage(layoutsDocument, selectedLanguage);
  //tell the user if there are no sounds
  if (!ok) loadFailure();
}

//Play the sound associated to int soundRef
void SoundFactory::playSound(int mySound)
{
  QString soundFile;

   if (mySound >= sounds) return;

  soundFile = locate("data", "klettres/" + filesList[mySound]);
  kdDebug() << "File to play:  " << soundFile << endl;

  if (soundFile == 0) return;

  KAudioPlayer::play(soundFile);
}

//Report a load failure
void SoundFactory::loadFailure()
{
        KMessageBox::error(klettres, i18n("Error while loading the sound names."));
}

bool SoundFactory::registerLanguages(QDomDocument &layoutDocument)
{
  QDomNodeList languagesList, menuItemsList, labelsList;
  QDomElement languageElement, menuItemElement, labelElement;
  QDomAttr codeAttribute, actionAttribute;
  bool enabled;
  languagesList = layoutDocument.elementsByTagName("language");
  if (languagesList.count() < 1)
    return false;

  for (uint i = 0; i < languagesList.count(); i++)
  {
    languageElement = (const QDomElement &) languagesList.item(i).toElement();
    codeAttribute = languageElement.attributeNode("code");
    //here it looks in $KDEDIR/share/apps/klettres and in $KDEHOME/share/apps/klettres
    enabled = locate("data", "klettres/" + codeAttribute.value() + "/") != 0;
    menuItemsList = languageElement.elementsByTagName("menuitem");
    if (menuItemsList.count() != 1)
      return false;

    menuItemElement = (const QDomElement &) menuItemsList.item(0).toElement();

    labelsList = menuItemElement.elementsByTagName("label");
    if (labelsList.count() != 1)
      return false;

    labelElement = (const QDomElement &) labelsList.item(0).toElement();
    actionAttribute = menuItemElement.attributeNode("action");

    klettres->registerLanguage(labelElement.text(), actionAttribute.value().latin1(), enabled);
  }

  return true;
}

/*
 * Load the sounds of one given language
 * Call that when you read the language from Config and when the language changes
 * or when the level changes
 */
bool SoundFactory::loadLanguage(QDomDocument &layoutDocument, uint toLoad)
{
  QDomNodeList languagesList,
               alphabetList,
               syllablesList,
               soundNamesList;
  QDomElement languageElement,
              alphabetElement,
              syllableElement,
              soundNameElement;
  QDomAttr nameAttribute, fileAttribute;

  languagesList = layoutDocument.elementsByTagName("language");
  if (toLoad >= languagesList.count())
    return false;

  languageElement = (const QDomElement &) languagesList.item(toLoad).toElement();

  //load the sounds for level 1 and 2 (alphabet)
  if ((klettres->m_view->niveau == 1) || (klettres->m_view->niveau == 2))
  {
        alphabetList = languageElement.elementsByTagName("alphabet");
        if (alphabetList.count() != 1)
                return false;

        alphabetElement = (const QDomElement &) alphabetList.item(0).toElement();

        soundNamesList = alphabetElement.elementsByTagName("sound");
  }

  //load the sounds for level 3 and 4 (syllables)
  if ((klettres->m_view->niveau == 3) || (klettres->m_view->niveau == 4))
  {
        syllablesList = languageElement.elementsByTagName("syllables");
        if (syllablesList.count() != 1)
                return false;

        syllableElement = (const QDomElement &) syllablesList.item(0).toElement();

        soundNamesList = syllableElement.elementsByTagName("sound");
  }
  sounds = soundNamesList.count();
  if (sounds < 1)
    return false;

  if (!(namesList = new QString[sounds]))
    return false;
  if (!(filesList = new QString[sounds]))
    return false;

  for (uint sound = 0; sound < sounds; sound++)
  {
    soundNameElement = (const QDomElement &) soundNamesList.item(sound).toElement();
    nameAttribute = soundNameElement.attributeNode("name");
    //namesList helds the names of the letter or syllable to display
    namesList[sound] = nameAttribute.value();
    fileAttribute = soundNameElement.attributeNode("file");
    //filesList helds the names of the sound files (i.e the location of the sounds like fr/alpha/a-0.mp3
    filesList[sound] = fileAttribute.value();
  }
  return true;
}

---