word-phoneme-map/forward-phoneme-indexer.js

Provides a two-way map between the words and phonemes listed in the CMU Pronouncing Dictionary.

var createLevelTree = require('basic-level-tree');
var callNextTick = require('call-next-tick');

function createForwardPhonemeIndexer(opts, createDone) {
  var db;
  var root;

  if (opts) {
    db = opts.db;
  }

  if (!db) {
    createDone(new Error('Cannot create forward indexer without db.'));
    return;
  }

  var levelTree = createLevelTree(
    {
      db: db,
      treeName: 'forward-phonemes',
      root: {
        name: 'START'
      }
    },
    passBackMethod
  );

  function passBackMethod(error, levelTreeRoot) {
    if (error) {
      createDone(error);
    }
    else {
      root = levelTreeRoot;
      createDone(error, indexWordByForwardPhonemes);
    }
  }

  function indexWordByForwardPhonemes(word, phonemesInOrder, done) {
    mapToTree(root, word, phonemesInOrder, done);
  }

  // Maps the phonemes to the tree, using one node for each phoneme. When it 
  // gets to the last phoneme, it stores the word in that node.
  function mapToTree(node, word, phonemes, done) {
    if (phonemes.length < 1) {
      callNextTick(done);
    }
    else {
      node.addChildIfNotThere(
        {
          value: {
            name: phonemes[0]
          },
          equalityFn: nodeNamesAreEqual
        },
        updateChild
      );
    }

    function updateChild(error, child) {
      if (error) {
        done(error);
      }
      else if (phonemes.length === 1) {
        if (child.value.words === undefined) {
          child.value.words = [];
        }
        child.value.words.push(word);
        child.save(done);
      }
      else {
        mapToTree(child, word, phonemes.slice(1), done);
      }
    }
  }

  return indexWordByForwardPhonemes;
}

function nodeNamesAreEqual(a, b) {
  return a.name === b.name;
}

module.exports = createForwardPhonemeIndexer;