/*****************************************************************
|
|    AP4 - tfra Atoms 
|
|    Copyright 2002-2008 Axiomatic Systems, LLC
|
|
|    This file is part of Bento4/AP4 (MP4 Atom Processing Library).
|
|    Unless you have obtained Bento4 under a difference license,
|    this version of Bento4 is Bento4|GPL.
|    Bento4|GPL 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, or (at your option)
|    any later version.
|
|    Bento4|GPL 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 Bento4|GPL; see the file COPYING.  If not, write to the
|    Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
|    02111-1307, USA.
|
 ****************************************************************/

#ifndef _AP4_TFRA_ATOM_H_
#define _AP4_TFRA_ATOM_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "Ap4Types.h"
#include "Ap4Atom.h"
#include "Ap4Array.h"

/*----------------------------------------------------------------------
|   class references
+---------------------------------------------------------------------*/
class AP4_ByteStream;

/*----------------------------------------------------------------------
|   AP4_TfraAtom
+---------------------------------------------------------------------*/
class AP4_TfraAtom : public AP4_Atom
{
public:
    AP4_IMPLEMENT_DYNAMIC_CAST_D(AP4_TfraAtom, AP4_Atom)

    // types
    struct Entry {
        Entry() : m_Time(0), m_MoofOffset(0), m_TrafNumber(0), m_TrunNumber(0), m_SampleNumber(0) {}
        Entry(AP4_UI64 time,
              AP4_UI64 moof_offset,
              AP4_UI32 traf_number,
              AP4_UI32 trun_number,
              AP4_UI32 sample_number) :
            m_Time(time), m_MoofOffset(moof_offset), m_TrafNumber(traf_number), m_TrunNumber(trun_number), m_SampleNumber(sample_number) {}
        AP4_UI64 m_Time;
        AP4_UI64 m_MoofOffset;
        AP4_UI32 m_TrafNumber;
        AP4_UI32 m_TrunNumber;
        AP4_UI32 m_SampleNumber;
    };
    
    // class methods
    static AP4_TfraAtom* Create(AP4_Size size, AP4_ByteStream& stream);
    
    // constructors 
    AP4_TfraAtom(AP4_UI32 track_id,
                 AP4_UI08 length_size_of_traf_number   = 0,
                 AP4_UI08 length_size_of_trun_number   = 0,
                 AP4_UI08 length_size_of_sample_number = 0);

    // methods
    virtual AP4_Result InspectFields(AP4_AtomInspector& inspector);
    virtual AP4_Result WriteFields(AP4_ByteStream& stream);
    AP4_Result         AddEntry(AP4_UI64 time,
                                AP4_UI64 moof_offset,
                                AP4_UI32 traf_number = 1,
                                AP4_UI32 trun_number = 1,
                                AP4_UI32 sample_number = 1);
    
    // accessors
    AP4_Array<Entry>& GetEntries() { return m_Entries; }
    void     SetTrackId(AP4_UI32 track_id) { m_TrackId = track_id; }
    AP4_UI32 GetTrackId( )                 { return m_TrackId;     }
    
private:
    // methods
    AP4_TfraAtom(AP4_UI32 size, AP4_UI08 version, AP4_UI32 flags, AP4_ByteStream& stream);
        
    // members
    AP4_UI32         m_TrackId;
    AP4_UI08         m_LengthSizeOfTrafNumber;
    AP4_UI08         m_LengthSizeOfTrunNumber;
    AP4_UI08         m_LengthSizeOfSampleNumber;
    AP4_Array<Entry> m_Entries;
};

#endif // _AP4_TFRA_ATOM_H_