sol.h

Go to the documentation of this file.

// 
//   Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
// 
// 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 3 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

#ifndef GNASH_SOL_H
#define GNASH_SOL_H

#include <boost/cstdint.hpp>
#include <string>
#include <vector>

#include "dsodefs.h" //DSOEXPORT
#include "amf.h"

// It comprises of a magic number, followed by the file length, a
// filetype, which appears to always be "TCSO", and what appears to be
// a marker at the end of the header block.
// After the SOL header, the rest is all AMF objects.

// Magic Number - 2 bytes (always 0x00bf)
// Length       - 4 bytes (the length of the file including the Marker bytes)
// Marker       - 10 bytes (always "TCSO0x000400000000")
// Object Name  - variable (the name of the object as an AMF encoded string)
// Padding      - 4 bytes
// After this is a series of AMF objects

namespace cygnal
{

// Forward declarations
class Element;

class DSOEXPORT SOL {
public:
    SOL();
    ~SOL();

    size_t size() const { return _amfobjs.size(); }
 
    size_t fileSize() const { return _filesize; }

    bool extractHeader(const std::vector<boost::uint8_t> &data);

    bool extractHeader(const std::string &filespec);

    bool formatHeader(const std::vector<boost::uint8_t> &data);

    bool formatHeader(const std::string &name);

    bool formatHeader(const std::string &name, int filesize);

    bool writeFile();

    bool writeFile(const std::string &filespec, const std::string &objname);
    
    bool readFile(const std::string &filespec);

    std::vector<boost::uint8_t> getHeader() { return _header; };

    //
    void addObj(boost::shared_ptr<Element> el);

    std::vector<boost::shared_ptr<cygnal::Element> > &getElements() { return _amfobjs; }

    boost::shared_ptr<Element> getElement(size_t size)
    {
        assert(size<_amfobjs.size());
        return _amfobjs[size];
    }

    void setFilespec(const std::string &filespec) { _filespec = filespec; };

    const std::string &getFilespec() const { return _filespec; };

    void setObjectName(const std::string &objname) { _objname = objname; };

    const std::string &getObjectName() const { return _objname; };
        
    bool updateSO(boost::shared_ptr<cygnal::Element> &el);
    bool updateSO(int index, boost::shared_ptr<cygnal::Element> &el);
    
    void dump();

 private:
    std::vector<boost::uint8_t> _header;

    std::vector<boost::uint8_t> _data;

    std::string      _objname;

    std::string      _filespec;

    int              _filesize;

 protected:
    std::vector<boost::shared_ptr<Element> > _amfobjs;
    
  };

 
} // end of amf namespace

// end of _SOL_H_
#endif

// local Variables:
// mode: C++
// indent-tabs-mode: t
// End: