Files
Bento4/Source/C++/Core/Ap4File.h
2017-10-01 19:00:47 -07:00

173 lines
6.3 KiB
C++

/*****************************************************************
|
| AP4 - File
|
| 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_FILE_H_
#define _AP4_FILE_H_
/*----------------------------------------------------------------------
| includes
+---------------------------------------------------------------------*/
#include "Ap4Types.h"
#include "Ap4List.h"
#include "Ap4Atom.h"
#include "Ap4AtomFactory.h"
/*----------------------------------------------------------------------
| class references
+---------------------------------------------------------------------*/
class AP4_ByteStream;
class AP4_Movie;
class AP4_FtypAtom;
class AP4_MetaData;
/*----------------------------------------------------------------------
| file type/brands
+---------------------------------------------------------------------*/
const AP4_UI32 AP4_FILE_BRAND_QT__ = AP4_ATOM_TYPE('q','t',' ',' ');
const AP4_UI32 AP4_FILE_BRAND_ISOM = AP4_ATOM_TYPE('i','s','o','m');
const AP4_UI32 AP4_FILE_BRAND_ISO1 = AP4_ATOM_TYPE('i','s','o','1');
const AP4_UI32 AP4_FILE_BRAND_ISO2 = AP4_ATOM_TYPE('i','s','o','2');
const AP4_UI32 AP4_FILE_BRAND_ISO3 = AP4_ATOM_TYPE('i','s','o','3');
const AP4_UI32 AP4_FILE_BRAND_ISO4 = AP4_ATOM_TYPE('i','s','o','4');
const AP4_UI32 AP4_FILE_BRAND_ISO5 = AP4_ATOM_TYPE('i','s','o','5');
const AP4_UI32 AP4_FILE_BRAND_ISO6 = AP4_ATOM_TYPE('i','s','o','6');
const AP4_UI32 AP4_FILE_BRAND_MP41 = AP4_ATOM_TYPE('m','p','4','1');
const AP4_UI32 AP4_FILE_BRAND_MP42 = AP4_ATOM_TYPE('m','p','4','2');
const AP4_UI32 AP4_FILE_BRAND_3GP1 = AP4_ATOM_TYPE('3','g','p','1');
const AP4_UI32 AP4_FILE_BRAND_3GP2 = AP4_ATOM_TYPE('3','g','p','2');
const AP4_UI32 AP4_FILE_BRAND_3GP3 = AP4_ATOM_TYPE('3','g','p','3');
const AP4_UI32 AP4_FILE_BRAND_3GP4 = AP4_ATOM_TYPE('3','g','p','4');
const AP4_UI32 AP4_FILE_BRAND_3GP5 = AP4_ATOM_TYPE('3','g','p','5');
const AP4_UI32 AP4_FILE_BRAND_3G2A = AP4_ATOM_TYPE('3','g','2','a');
const AP4_UI32 AP4_FILE_BRAND_MMP4 = AP4_ATOM_TYPE('m','m','p','4');
const AP4_UI32 AP4_FILE_BRAND_M4A_ = AP4_ATOM_TYPE('M','4','A',' ');
const AP4_UI32 AP4_FILE_BRAND_M4P_ = AP4_ATOM_TYPE('M','4','P',' ');
const AP4_UI32 AP4_FILE_BRAND_MJP2 = AP4_ATOM_TYPE('m','j','p','2');
const AP4_UI32 AP4_FILE_BRAND_ODCF = AP4_ATOM_TYPE('o','d','c','f');
const AP4_UI32 AP4_FILE_BRAND_OPF2 = AP4_ATOM_TYPE('o','p','f','2');
const AP4_UI32 AP4_FILE_BRAND_AVC1 = AP4_ATOM_TYPE('a','v','c','1');
const AP4_UI32 AP4_FILE_BRAND_HVC1 = AP4_ATOM_TYPE('h','v','c','1');
/*----------------------------------------------------------------------
| AP4_File
+---------------------------------------------------------------------*/
/**
* The AP4_File object is the top level object for MP4 Files.
*/
class AP4_File : public AP4_AtomParent {
public:
// constructors and destructor
/**
* Constructs an AP4_File from an AP4_Movie (used for writing)
* @param movie the movie
*/
AP4_File(AP4_Movie* movie = NULL);
/**
* Constructs an AP4_File from a stream
* @param stream the stream containing the data of the file
* @param atom_factory the atom factory that will be used to parse the stream
* @param moov_only indicates whether parsing of the atoms should stop
* when the moov atom is found or if all atoms should be parsed until the
* end of the file.
*/
AP4_File(AP4_ByteStream& stream,
AP4_AtomFactory& atom_factory,
bool moov_only);
/**
* Constructs an AP4_File from a stream using the default atom factory
* @param stream the stream containing the data of the file
* @param moov_only indicates whether parsing of the atoms should stop
* when the moov atom is found or if all atoms should be parsed until the
* end of the file.
*/
AP4_File(AP4_ByteStream& stream, bool moov_only = false);
/**
* Destroys the AP4_File instance
*/
virtual ~AP4_File();
/**
* Get the top level atoms of the file
*/
AP4_List<AP4_Atom>& GetTopLevelAtoms() { return m_Children; }
/**
* Get the AP4_Movie object of this file
*/
AP4_Movie* GetMovie() { return m_Movie; }
/**
* Get the file type atom of this file
*/
AP4_FtypAtom* GetFileType() { return m_FileType; }
/**
* Set the file type. Will internally create an AP4_Ftyp atom
* and attach it to the file
*/
AP4_Result SetFileType(AP4_UI32 major_brand,
AP4_UI32 minor_version,
AP4_UI32* compatible_brands = NULL,
AP4_Cardinal compatible_brand_count = 0);
/**
* Ask whether the moov atom appears before the first mdat atom
*/
bool IsMoovBeforeMdat() const { return m_MoovIsBeforeMdat; }
/**
* Get the file's metadata description
*/
const AP4_MetaData* GetMetaData();
/**
* Inspect the content of the file with an AP4_AtomInspector
*/
virtual AP4_Result Inspect(AP4_AtomInspector& inspector);
private:
// methods
void ParseStream(AP4_ByteStream& stream,
AP4_AtomFactory& atom_factory,
bool moov_only);
// members
AP4_Movie* m_Movie;
AP4_FtypAtom* m_FileType;
AP4_MetaData* m_MetaData;
bool m_MoovIsBeforeMdat;
};
#endif // _AP4_FILE_H_