Line data    Source code

       1             : /* Copyright (C) 2021 Wildfire Games.
       2             :  * This file is part of 0 A.D.
       3             :  *
       4             :  * 0 A.D. is free software: you can redistribute it and/or modify
       5             :  * it under the terms of the GNU General Public License as published by
       6             :  * the Free Software Foundation, either version 2 of the License, or
       7             :  * (at your option) any later version.
       8             :  *
       9             :  * 0 A.D. is distributed in the hope that it will be useful,
      10             :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      11             :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      12             :  * GNU General Public License for more details.
      13             :  *
      14             :  * You should have received a copy of the GNU General Public License
      15             :  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
      16             :  */
      17             : #ifndef INCLUDED_OGG
      18             : #define INCLUDED_OGG
      19             : 
      20             : #include "lib/config2.h"
      21             : 
      22             : #if CONFIG2_AUDIO
      23             : 
      24             : #include "lib/external_libraries/openal.h"
      25             : #include "lib/file/vfs/vfs.h"
      26             : 
      27           0 : class OggStream
      28             : {
      29             : public:
      30           0 :     virtual ~OggStream() { }
      31             :     virtual ALenum Format() = 0;
      32             :     virtual ALsizei SamplingRate() = 0;
      33             :     virtual bool atFileEOF() = 0;
      34             :     virtual Status ResetFile() = 0;
      35             :   virtual Status Close() = 0;
      36             : 
      37             :     /**
      38             :      * @return bytes read (<= size) or a (negative) Status
      39             :      **/
      40             :     virtual Status GetNextChunk(u8* buffer, size_t size) = 0;
      41             : };
      42             : 
      43             : typedef std::shared_ptr<OggStream> OggStreamPtr;
      44             : 
      45             : extern Status OpenOggStream(const OsPath& pathname, OggStreamPtr& stream);
      46             : 
      47             : /**
      48             :  * A non-streaming OggStream (reading the whole file in advance)
      49             :  * that can cope with archived/compressed files.
      50             :  */
      51             : extern Status OpenOggNonstream(const PIVFS& vfs, const VfsPath& pathname, OggStreamPtr& stream);
      52             : 
      53             : #endif  // CONFIG2_AUDIO
      54             : 
      55             : #endif // INCLUDED_OGG