version et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc 117 c6adf5598d61edb9918f65d88df9b79a6b9e4969
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /*===========================================================================*/
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /*
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * This file is part of libogg++ - a c++ library for the Ogg transport format
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc *
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * Copyright (C) 2006, 2007 Elaine Tsiang YueLien
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc *
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * libogg++ is free software; you can redistribute it and/or
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * modify it under the terms of the GNU Lesser General Public
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * License as published by the Free Software Foundation; either
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * version 2.1 of the License, or (at your option) any later version.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc *
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * This library is distributed in the hope that it will be useful,
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * but WITHOUT ANY WARRANTY; without even the implied warranty of
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * Lesser General Public License for more details.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc *
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * You should have received a copy of the GNU Lesser General Public
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * License along with this library; if not, write to the
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * Free Software Foundation, Inc.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * 51 Franklin Street, Fifth Floor
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc * Boston, MA 02110-1301, USA
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc *
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc *===========================================================================*/
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /** @file Ogg.H *
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /*===========================================================================*/
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc #ifndef __OGGPLUSPLUS__
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc #define __OGGPLUSPLUS__
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// @mainpage
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// @em libogg++ is a c++ library for the %Ogg transport format.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// %Ogg is an interleaving data container developed by Monty
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// at Xiph.Org, originally to
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// support the %Ogg Vorbis audio format.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// @em libogg++ provides encapsulation/multiplexing and demultiplexing/decapsulation.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// It overlaps in functionality with liboggz, which depends on libogg
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// for the lower-level capabilities. But @em libogg++ is not a c++ wrapper
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// of liboggz or libogg.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// @section goals Design Goals
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// - Minimally gnostic transport and logical layers.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// The logical layer assumes only that the transport layer
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// transports with fidelity.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// The transport layer knows that the logical streams, distinguishable
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// by a serial number,come in packets of specified sizes, and marked
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// each with a granule position which is monotonically increasing.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
- The transport layer can be elaborated for interleave ordering
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// for codecs of multiple contemporaneous streams of more than
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// one logical type, which may not be all time-continuous.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
- The logical layer can be elaborated for specific codecs.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
- The transport and logical layers can run in separate threads.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// @section licensing Licensing
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// @verbatim
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// Copyright (C) 2006, 2007 Elaine Tsiang YueLien
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// libogg++ is free software; you can redistribute it and/or
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// modify it under the terms of the GNU Lesser General Public
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// License as published by the Free Software Foundation; either
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// version 2.1 of the License, or (at your option) any later version.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// This library is distributed in the hope that it will be useful,
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// but WITHOUT ANY WARRANTY; without even the implied warranty of
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// Lesser General Public License for more details.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// You should have received a copy of the GNU Lesser General Public
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// License along with this library; if not, write to the
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// Free Software Foundation, Inc.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// 51 Franklin Street, Fifth Floor
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// Boston, MA 02110-1301, USA
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// @endverbatim
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// @defgroup overrides Specialization via Overloading
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// These are either Ogg:: functions or virtual class methods.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// The Ogg:: functions relate either to sequence ordering among logical streams
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// (termed media mapping in the %Ogg specification)
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// or conversion between granule position and some codec-specific time-like unit.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// Overriding these functions provide a first level of specialization
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// without class derivation.
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// @defgroup derivables Derivable and Nonderivable Classes
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc /// @defgroup errorHandling Error and Excception Handling
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc ///
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc #ifdef __GNUG__
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc #pragma interface
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc #endif
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc #include
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc namespace Ogg
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc {
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc typedef long long int Position;
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc typedef long long int PacketNo;
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc }
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc #include
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc #include
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc
et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc #endif
end et@ihear.com-20070423221242-5xzo4m8ryu5c4cyc
version et@ihear.com-20070913164653-xf8zawy2qxz9oos0 2 55a8f72ecef2139cb19ec62bd9b26def9f0bee59
23,24,1
et@ihear.com-20070913164653-xf8zawy2qxz9oos0 /** @file Ogg.H */
end et@ihear.com-20070913164653-xf8zawy2qxz9oos0
version et@ihear.com-20080719223822-rex690bniszzrc0x 4 57e4b9da7e038ba1d769f224c44c56e2fdada407
4,5,1
et@ihear.com-20080719223822-rex690bniszzrc0x * Copyright (C) 2006, 2007, 2008 Elaine Tsiang YueLien
65,66,1
et@ihear.com-20080719223822-rex690bniszzrc0x /// Copyright (C) 2006, 2007, 2008 Elaine Tsiang YueLien
end et@ihear.com-20080719223822-rex690bniszzrc0x