Segment.hxx

Go to the documentation of this file.

/*
 * Copyright (c) 2001-2004 MUSIC TECHNOLOGY GROUP (MTG)
 *                         UNIVERSITAT POMPEU FABRA
 *
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * 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
 *
 */

#ifndef _Segment_
#define _Segment_

#include "Frame.hxx"
#include "DataTypes.hxx"
#include "List.hxx"
#include "Search.hxx"
#include "ProcessingData.hxx"
#include "Audio.hxx"

namespace CLAM 
{

typedef Search < List < Frame >, Frame> FrameSearch;

class Segment : public ProcessingData
{
public:
        DYNAMIC_TYPE_USING_INTERFACE (Segment, 8, ProcessingData);
        DYN_ATTRIBUTE (0, public, TTime, BeginTime);
        DYN_ATTRIBUTE (1, public, TTime, EndTime);
        DYN_ATTRIBUTE (2, private, bool, prHoldsData);
        DYN_ATTRIBUTE (3, private, List<Frame>, prFramesArray);
        DYN_ATTRIBUTE (4, public, Audio, Audio);
        DYN_ATTRIBUTE (5, public, List<Segment>, Children);
        DYN_ATTRIBUTE (6, public, TData, SamplingRate);
        DYN_ATTRIBUTE (7, public, std::string, Id);     
        
private:
        FrameSearch mFramesSearch;
        Segment* pParent;

public:

        void AddFramesArray()
        {
                AddprFramesArray();
        }
        void RemoveFramesArray()
        {
                RemoveprFramesArray();
        }
        
        void SetFramesArray(const List<Frame>& frames)
        {
                SetprFramesArray(frames);
                GetFramesSearch().Set(GetprFramesArray());
        }
        const List<Frame>& GetFramesArray() const {return GetprFramesArray();}
        List<Frame>& GetFramesArray() {return GetprFramesArray();}
        TIndex mCurrentFrameIndex;
        
        Segment* GetpParent(){return pParent;}
        void SetpParent(Segment*  newParent){pParent=newParent;}
        void DefaultInit();

public:
        void CopyInit(const Segment& prototype);

        int GetnFrames() const;

//Interface for accessing and modifying frames

        Frame& GetFrame(TIndex pos);
        const Frame& GetFrame(TIndex pos) const;
        void AddFrame(Frame& newFrame); // XXX: should really be a const reference as the frame is copied
        void DeleteFrame(TIndex pos);

        TIndex FindFrame(TTime time) const;

        Frame& GetFrame(TTime time);

        const Frame& GetFrame(TTime time) const;

        void DeleteFrame(TTime time);
        
        void SetHoldsData(bool HoldsData);

        bool GetHoldsData() const {return GetprHoldsData();}

private:
        
        void SetFramesSearch (const FrameSearch & frame) 
        {
                mFramesSearch=frame;
        }
        
        const FrameSearch & GetFramesSearch () const 
        {
                return mFramesSearch;
        }
        
        FrameSearch & GetFramesSearch () 
        {
                return mFramesSearch;
        }
        
        void CopyDataFromParent();
        void DefaultValues();
};

} //namespace CLAM

#endif