view src/Support/StrobeList.h @ 611:0fbaf443ec82

Carfac C++ revision 3, indluding more style improvements. The output structs are now classes again, and have separate storage methods for each output structure along with flags in the Run and RunSegment methods to allow for only storing NAPs if desired.

// Copyright 2007-2010, Thomas Walters
//
// AIM-C: A C++ implementation of the Auditory Image Model
// http://www.acousticscale.org/AIMC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/*!
 * \file
 * \brief Modifiable List of Strobe Points - helper for SAI generation
 *
 * \author Tom Walters <[e-mail]>
 * \date created 2007/08/22
 * \version \$Id$
 */

#ifndef AIMC_SUPPORT_STROBELIST_H_
#define AIMC_SUPPORT_STROBELIST_H_

#include <cmath>
#include <deque>

namespace aimc {
using std::deque;
struct StrobePoint {
  int time;
  float weight;
  float working_weight;
  StrobePoint() {
    time = 0;
    weight = 0.0f;
    working_weight = 0.0f;
  }
};

class StrobeList {
 public:
  /*! \brief Create a new strobe list
   */
  inline StrobeList() {
    strobes_.resize(0);
  };

  inline ~StrobeList() {
  };

  /*! \brief Return the strobe time (in samples, can be negative)
   */
  inline StrobePoint Strobe(int strobe_number) {
    return strobes_.at(strobe_number);
  };

  /*! \brief Set the strobe weight
   */
  inline void SetWeight(int strobe_number, float weight) {
    strobes_.at(strobe_number).weight = weight;
  };

  /*! \brief Set the strobe's working weight
   */
  inline void SetWorkingWeight(int strobe_number, float working_weight) {
    strobes_.at(strobe_number).working_weight = working_weight;
  };

  /*! \brief Add a strobe to the list (must be in order)
   */
  inline void AddStrobe(int time, float weight) {
    StrobePoint s;
    s.time = time;
    s.weight = weight;
    strobes_.push_back(s);
  };

  /*! \brief Delete a strobe from the list
   */
  inline void DeleteFirstStrobe() {
    strobes_.pop_front();
  };

  /*! \brief Get the number of strobes
   */
  inline int strobe_count() const {
    return strobes_.size();
  };

  /*! \brief Shift the position of all strobes by subtracting offset from
   *  the time value of each
   */
  inline void ShiftStrobes(int offset) {
    for (unsigned int i = 0; i < strobes_.size(); ++i)
      strobes_[i].time -= offset;
  };

 private:
  deque<StrobePoint> strobes_;
};
}  // namespace aimc

#endif /* AIMC_SUPPORT_STROBELIST_H_ */