File: NstApiMovie.hpp

package info (click to toggle)
libretro-nestopia 1.52.0%2B20230102.gitcb1e24e-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 12,960 kB
  • sloc: cpp: 107,513; xml: 27,221; python: 1,329; ansic: 772; makefile: 634
file content (195 lines) | stat: -rw-r--r-- 4,140 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
////////////////////////////////////////////////////////////////////////////////////////
//
// Nestopia - NES/Famicom emulator written in C++
//
// Copyright (C) 2003-2008 Martin Freij
//
// This file is part of Nestopia.
//
// Nestopia 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 2 of the License, or
// (at your option) any later version.
//
// Nestopia 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 Nestopia; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
////////////////////////////////////////////////////////////////////////////////////////

#ifndef NST_API_MOVIE_H
#define NST_API_MOVIE_H

#include <iosfwd>
#include "NstApi.hpp"

#ifdef NST_PRAGMA_ONCE
#pragma once
#endif

#if NST_ICC >= 810
#pragma warning( push )
#pragma warning( disable : 304 444 )
#elif NST_MSVC >= 1200
#pragma warning( push )
#pragma warning( disable : 4512 )
#endif

namespace Nes
{
	namespace Api
	{
		/**
		* Movie playing/recording interface.
		*/
		class Movie : public Base
		{
			struct EventCaller;

		public:

			/**
			* Interface constructor.
			*
			* @param instance emulator instance
			*/
			template<typename T>
			Movie(T& instance)
			: Base(instance) {}

			/**
			* Recording procedure.
			*/
			enum How
			{
				/**
				* Overwrite any previous content.
				*/
				CLEAN,
				/**
				* Keep any previous content.
				*/
				APPEND
			};

			/**
			* Plays movie.
			*
			* @param stream input stream to movie
			* @return result code
			*/
			Result Play(std::istream& stream) throw();

			/**
			* Records movie.
			*
			* @param stream stream to record movie to
			* @param how CLEAN to erase any previous content, APPEND to keep content, default is CLEAN
			* @return result code
			*/
			Result Record(std::iostream& stream,How how=CLEAN) throw();

			/**
			* Stops movie.
			*/
			void Stop() throw();

			/**
			* Ejects movie.
			*
			* @deprecated
			*/
			void Eject() {}

			/**
			* Checks if a movie is being played.
			*
			* @return true if playing
			*/
			bool IsPlaying() const throw();

			/**
			* Checks if a movie is being recorded.
			*
			* @return true if recording
			*/
			bool IsRecording() const throw();

			/**
			* Checks if a movie has stopped playing or recording.
			*
			* @return true if stopped
			*/
			bool IsStopped() const throw();

			/**
			* Movie event.
			*/
			enum Event
			{
				/**
				* Movie has started playing.
				*/
				EVENT_PLAYING,
				/**
				* Movie has stopped playing.
				*/
				EVENT_PLAYING_STOPPED,
				/**
				* Movie has started recording.
				*/
				EVENT_RECORDING,
				/**
				* Movie has stopped recording.
				*/
				EVENT_RECORDING_STOPPED
			};

			enum
			{
				NUM_EVENT_CALLBACKS = 4
			};

			/**
			* Movie event callback prototype.
			*
			* @param userData optional user data
			* @param event type of event
			* @param result result code of event
			*/
			typedef void (NST_CALLBACK *EventCallback) (UserData userData,Event event,Result result);

			/**
			* Movie event callback manager.
			*
			* Static object used for adding the user defined callback.
			*/
			static EventCaller eventCallback;
		};

		/**
		* Movie event callback invoker.
		*
		* Used internally by the core.
		*/
		struct Movie::EventCaller : Core::UserCallback<Movie::EventCallback>
		{
			void operator () (Event event,Result result=RESULT_OK) const
			{
				if (function)
					function( userdata, event, result );
			}
		};
	}
}

#if NST_MSVC >= 1200 || NST_ICC >= 810
#pragma warning( pop )
#endif

#endif