1 // Copyright (c) 2005-2007, Rodrigo Braz Monteiro
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are met:
6 //
7 //   * Redistributions of source code must retain the above copyright notice,
8 //     this list of conditions and the following disclaimer.
9 //   * Redistributions in binary form must reproduce the above copyright notice,
10 //     this list of conditions and the following disclaimer in the documentation
11 //     and/or other materials provided with the distribution.
12 //   * Neither the name of the Aegisub Group nor the names of its contributors
13 //     may be used to endorse or promote products derived from this software
14 //     without specific prior written permission.
15 //
16 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 // POSSIBILITY OF SUCH DAMAGE.
27 //
28 // Aegisub Project http://www.aegisub.org/
29 
30 /// @file audio_player.h
31 /// @brief Declaration of base-class for audio players
32 /// @ingroup main_headers audio_output
33 ///
34 
35 #pragma once
36 
37 #include <libaegisub/exception.h>
38 
39 #include <cstdint>
40 #include <memory>
41 #include <string>
42 #include <vector>
43 
44 namespace agi { class AudioProvider; }
45 class wxWindow;
46 
47 class AudioPlayer {
48 protected:
49 	agi::AudioProvider *provider;
50 
51 public:
AudioPlayer(agi::AudioProvider * provider)52 	AudioPlayer(agi::AudioProvider *provider) : provider(provider) { }
53 	virtual ~AudioPlayer() = default;
54 
55 	virtual void Play(int64_t start,int64_t count)=0;	// Play sample range
56 	virtual void Stop()=0;			// Stop playing
57 	virtual bool IsPlaying()=0;
58 
59 	virtual void SetVolume(double volume)=0;
60 
61 	virtual int64_t GetEndPosition()=0;
62 	virtual int64_t GetCurrentPosition()=0;
63 	virtual void SetEndPosition(int64_t pos)=0;
64 };
65 
66 struct AudioPlayerFactory {
67 	static std::vector<std::string> GetClasses();
68 	static std::unique_ptr<AudioPlayer> GetAudioPlayer(agi::AudioProvider *provider, wxWindow *window);
69 };
70 
71 DEFINE_EXCEPTION(AudioPlayerOpenError, agi::Exception);
72