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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
/* $Id: RecordingStream.h $ */
/** @file
* Recording stream code header.
*/
/*
* Copyright (C) 2012-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program 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, in version 3 of the
* License.
*
* This program 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 this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef MAIN_INCLUDED_RecordingStream_h
#define MAIN_INCLUDED_RecordingStream_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <map>
#include <vector>
#include <iprt/critsect.h>
#include "RecordingInternals.h"
class WebMWriter;
class RecordingContext;
/** Structure for queuing all blocks bound to a single timecode.
* This can happen if multiple tracks are being involved. */
struct RecordingBlocks
{
virtual ~RecordingBlocks()
{
Clear();
}
/**
* Resets a recording block list by removing (destroying)
* all current elements.
*/
void Clear()
{
while (!List.empty())
{
RecordingBlock *pBlock = List.front();
List.pop_front();
delete pBlock;
}
Assert(List.size() == 0);
}
/** The actual block list for this timecode. */
RecordingBlockList List;
};
/** A block map containing all currently queued blocks.
* The key specifies a unique timecode, whereas the value
* is a list of blocks which all correlate to the same key (timecode). */
typedef std::map<uint64_t, RecordingBlocks *> RecordingBlockMap;
/**
* Structure for holding a set of recording (data) blocks.
*/
struct RecordingBlockSet
{
virtual ~RecordingBlockSet()
{
Clear();
}
/**
* Resets a recording block set by removing (destroying)
* all current elements.
*/
void Clear(void)
{
RecordingBlockMap::iterator it = Map.begin();
while (it != Map.end())
{
it->second->Clear();
delete it->second;
Map.erase(it);
it = Map.begin();
}
Assert(Map.size() == 0);
}
/** Timestamp (in ms) when this set was last processed. */
uint64_t tsLastProcessedMs;
/** All blocks related to this block set. */
RecordingBlockMap Map;
};
/**
* Class for managing a recording stream.
*
* A recording stream represents one entity to record (e.g. on screen / monitor),
* so there is a 1:1 mapping (stream <-> monitors).
*/
class RecordingStream
{
public:
RecordingStream(RecordingContext *pCtx, uint32_t uScreen, const settings::RecordingScreenSettings &Settings);
virtual ~RecordingStream(void);
public:
int Init(RecordingContext *pCtx, uint32_t uScreen, const settings::RecordingScreenSettings &Settings);
int Uninit(void);
int Process(RecordingBlockMap &mapBlocksCommon);
int SendAudioFrame(const void *pvData, size_t cbData, uint64_t msTimestamp);
int SendVideoFrame(uint32_t x, uint32_t y, uint32_t uPixelFormat, uint32_t uBPP, uint32_t uBytesPerLine,
uint32_t uSrcWidth, uint32_t uSrcHeight, uint8_t *puSrcData, uint64_t msTimestamp);
const settings::RecordingScreenSettings &GetConfig(void) const;
uint16_t GetID(void) const { return this->m_uScreenID; };
#ifdef VBOX_WITH_AUDIO_RECORDING
PRECORDINGCODEC GetAudioCodec(void) { return this->m_pCodecAudio; };
#endif
PRECORDINGCODEC GetVideoCodec(void) { return &this->m_CodecVideo; };
bool IsLimitReached(uint64_t msTimestamp) const;
bool IsReady(void) const;
bool NeedsUpdate(uint64_t msTimestamp) const;
public:
static DECLCALLBACK(int) codecWriteDataCallback(PRECORDINGCODEC pCodec, const void *pvData, size_t cbData, uint64_t msAbsPTS, uint32_t uFlags, void *pvUser);
protected:
int open(const settings::RecordingScreenSettings &screenSettings);
int close(void);
int initInternal(RecordingContext *pCtx, uint32_t uScreen, const settings::RecordingScreenSettings &screenSettings);
int uninitInternal(void);
int initVideo(const settings::RecordingScreenSettings &screenSettings);
int unitVideo(void);
bool isLimitReachedInternal(uint64_t msTimestamp) const;
int iterateInternal(uint64_t msTimestamp);
int codecWriteToWebM(PRECORDINGCODEC pCodec, const void *pvData, size_t cbData, uint64_t msAbsPTS, uint32_t uFlags);
void lock(void);
void unlock(void);
protected:
/**
* Enumeration for a recording stream state.
*/
enum RECORDINGSTREAMSTATE
{
/** Stream not initialized. */
RECORDINGSTREAMSTATE_UNINITIALIZED = 0,
/** Stream was initialized. */
RECORDINGSTREAMSTATE_INITIALIZED = 1,
/** The usual 32-bit hack. */
RECORDINGSTREAMSTATE_32BIT_HACK = 0x7fffffff
};
/** Recording context this stream is associated to. */
RecordingContext *m_pCtx;
/** The current state. */
RECORDINGSTREAMSTATE m_enmState;
struct
{
/** File handle to use for writing. */
RTFILE m_hFile;
/** Pointer to WebM writer instance being used. */
WebMWriter *m_pWEBM;
} File;
bool m_fEnabled;
/** Track number of audio stream.
* Set to UINT8_MAX if not being used. */
uint8_t m_uTrackAudio;
/** Track number of video stream.
* Set to UINT8_MAX if not being used. */
uint8_t m_uTrackVideo;
/** Screen ID. */
uint16_t m_uScreenID;
/** Critical section to serialize access. */
RTCRITSECT m_CritSect;
/** Timestamp (in ms) of when recording has been started. */
uint64_t m_tsStartMs;
#ifdef VBOX_WITH_AUDIO_RECORDING
/** Pointer to audio codec instance data to use.
*
* We multiplex audio data from the recording context to all streams,
* to avoid encoding the same audio data for each stream. We ASSUME that
* all audio data of a VM will be the same for each stream at a given
* point in time.
*
* Might be NULL if not being used. */
PRECORDINGCODEC m_pCodecAudio;
#endif /* VBOX_WITH_AUDIO_RECORDING */
/** Video codec instance data to use. */
RECORDINGCODEC m_CodecVideo;
/** Screen settings to use. */
settings::RecordingScreenSettings
m_ScreenSettings;
/** Common set of recording (data) blocks, needed for
* multiplexing to all recording streams. */
RecordingBlockSet m_Blocks;
};
/** Vector of recording streams. */
typedef std::vector <RecordingStream *> RecordingStreams;
#endif /* !MAIN_INCLUDED_RecordingStream_h */
|
