- Main Page
- Classes
- Files

# Ap4Sample.h

Go to the documentation of this file.

    00001 /*****************************************************************
    00002 |
    00003 |    AP4 - Sample Objects
    00004 |
    00005 |    Copyright 2002-2005 Gilles Boccon-Gibod & Julien Boeuf
    00006 |
    00007 |
    00008 |    This file is part of Bento4/AP4 (MP4 Atom Processing Library).
    00009 |
    00010 |    Unless you have obtained Bento4 under a difference license,
    00011 |    this version of Bento4 is Bento4|GPL.
    00012 |    Bento4|GPL is free software; you can redistribute it and/or modify
    00013 |    it under the terms of the GNU General Public License as published by
    00014 |    the Free Software Foundation; either version 2, or (at your option)
    00015 |    any later version.
    00016 |
    00017 |    Bento4|GPL is distributed in the hope that it will be useful,
    00018 |    but WITHOUT ANY WARRANTY; without even the implied warranty of
    00019 |    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    00020 |    GNU General Public License for more details.
    00021 |
    00022 |    You should have received a copy of the GNU General Public License
    00023 |    along with Bento4|GPL; see the file COPYING.  If not, write to the
    00024 |    Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
    00025 |    02111-1307, USA.
    00026 |
    00027  ****************************************************************/
    00028
    00029 #ifndef _AP4_SAMPLE_H_
    00030 #define _AP4_SAMPLE_H_
    00031
    00032 /*----------------------------------------------------------------------
    00033 |   includes
    00034 +---------------------------------------------------------------------*/
    00035 #include "Ap4Types.h"
    00036
    00037 /*----------------------------------------------------------------------
    00038 |   class references
    00039 +---------------------------------------------------------------------*/
    00040 class AP4_ByteStream;
    00041 class AP4_DataBuffer;
    00042
    00043 /*----------------------------------------------------------------------
    00044 |   AP4_Sample DO NOT DERIVE FROM THIS CLASS
    00045 +---------------------------------------------------------------------*/
    00046 class AP4_Sample
    00047 {
    00048 public:
    00049     // constructors and destructor
    00050     AP4_Sample();
    00051     AP4_Sample(const AP4_Sample& other);
    00052     AP4_Sample(AP4_ByteStream& data_stream,
    00053                AP4_Position    offset,
    00054                AP4_Size        size,
    00055                AP4_Ordinal     description_index,
    00056                AP4_TimeStamp   dts,
    00057                AP4_UI32        cts_offset = 0,
    00058                bool            sync_flag = true);
    00059     ~AP4_Sample(); // not virtual on purpose: do not derive from it
    00060
    00061     // operators
    00062     AP4_Sample&     operator=(const AP4_Sample& other);
    00063
    00064     // methods
    00065     AP4_Result      ReadData(AP4_DataBuffer& data);
    00066     AP4_Result      ReadData(AP4_DataBuffer& data,
    00067                              AP4_Size        size,
    00068                              AP4_Size        offset = 0);
    00069
    00070     // sample properties accessors
    00071     AP4_ByteStream* GetDataStream();
    00072     void            SetDataStream(AP4_ByteStream& stream);
    00073     AP4_Position    GetOffset() const { return m_Offset; }
    00074     void            SetOffset(AP4_Position offset) { m_Offset = offset; }
    00075     AP4_Size        GetSize() { return m_Size; }
    00076     void            SetSize(AP4_Size size) { m_Size = size; }
    00077     AP4_Ordinal     GetDescriptionIndex() const { return m_DescriptionIndex; }
    00078     void            SetDescriptionIndex(AP4_Ordinal index) { m_DescriptionIndex = index; }
    00079     AP4_TimeStamp   GetDts() const { return m_Dts; }
    00080     void            SetDts(AP4_TimeStamp dts) { m_Dts = dts; }
    00081     AP4_TimeStamp   GetCts() const { return m_Cts; }
    00082     void            SetCts(AP4_TimeStamp cts) { m_Cts = cts; }
    00083     bool            IsSync() const { return m_IsSync; }
    00084     void            SetSync(bool is_sync) { m_IsSync = is_sync; }
    00085
    00086 protected:
    00087     AP4_ByteStream* m_DataStream;
    00088     AP4_Position    m_Offset;
    00089     AP4_Size        m_Size;
    00090     AP4_Ordinal     m_DescriptionIndex;
    00091     AP4_TimeStamp   m_Dts;
    00092     AP4_TimeStamp   m_Cts;
    00093     bool            m_IsSync;
    00094 };
    00095
    00096 #endif // _AP4_SAMPLE_H_