ScummVM API documentation
mod_xm_s3m.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 /*
23  * This code is based on IBXM mod player
24  *
25  * Copyright (c) 2015, Martin Cameron
26  * All rights reserved.
27  *
28  * Redistribution and use in source and binary forms, with or
29  * without modification, are permitted provided that the
30  * following conditions are met:
31  *
32  * * Redistributions of source code must retain the above
33  * copyright notice, this list of conditions and the
34  * following disclaimer.
35  *
36  * * Redistributions in binary form must reproduce the
37  * above copyright notice, this list of conditions and the
38  * following disclaimer in the documentation and/or other
39  * materials provided with the distribution.
40  *
41  * * Neither the name of the organization nor the names of
42  * its contributors may be used to endorse or promote
43  * products derived from this software without specific
44  * prior written permission.
45 
46  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
47  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
48  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
49  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
50  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
51  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
52  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
53  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
54  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
55  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
56  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
57  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
58  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
59  * POSSIBILITY OF SUCH DAMAGE.
60  *
61  */
62 
63 #ifndef AUDIO_MODS_MOD_XM_S3M_H
64 #define AUDIO_MODS_MOD_XM_S3M_H
65 
66 namespace Common {
67 class SeekableReadStream;
68 }
69 
70 namespace Audio {
71 
72 class AudioStream;
73 
87 RewindableAudioStream *makeModXmS3mStream(Common::SeekableReadStream *stream,
88  DisposeAfterUse::Flag disposeAfterUse,
89  int initialPos = 0,
90  int interpolation = 0);
91 
95 bool probeModXmS3m(Common::SeekableReadStream *stream);
96 
97 } // End of namespace Audio
98 
99 #endif
Audio::makeModXmS3mStream
RewindableAudioStream * makeModXmS3mStream(Common::SeekableReadStream *stream, DisposeAfterUse::Flag disposeAfterUse, int initialPos=0, int interpolation=0)
Common::SeekableReadStream
Definition: stream.h:745
Audio::probeModXmS3m
bool probeModXmS3m(Common::SeekableReadStream *stream)
Common
Definition: algorithm.h:29
Audio
Definition: system.h:38