Ocean
Loading...
Searching...
No Matches
DSFiniteMedium.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) Meta Platforms, Inc. and affiliates.
3
*
4
* This source code is licensed under the MIT license found in the
5
* LICENSE file in the root directory of this source tree.
6
*/
7
8
#ifndef META_OCEAN_MEDIA_DS_FINITE_MEDIUM_H
9
#define META_OCEAN_MEDIA_DS_FINITE_MEDIUM_H
10
11
#include "
ocean/media/directshow/DirectShow.h
"
12
#include "
ocean/media/directshow/DSMedium.h
"
13
14
#include "
ocean/media/FiniteMedium.h
"
15
16
#include "
ocean/base/Scheduler.h
"
17
18
namespace
Ocean
19
{
20
21
namespace
Media
22
{
23
24
namespace
DirectShow
25
{
26
27
/**
28
* This class is the base class for all direct show finite mediums.
29
* @ingroup mediads
30
*/
31
class
OCEAN_MEDIA_DS_EXPORT
DSFiniteMedium
:
32
virtual
public
FiniteMedium
,
33
virtual
public
DSMedium
34
{
35
friend
class
DSFrameMedium
;
36
37
public
:
38
39
/**
40
* Returns the duration of the finite medium.
41
* @see FiniteMedium::duration().
42
*/
43
double
duration
()
const override
;
44
45
/**
46
* Returns the duration without speed consideration.
47
* @see FiniteMedium::normalDuration().
48
*/
49
double
normalDuration
()
const override
;
50
51
/**
52
* Returns the recent position of the finite medium.
53
* @see FiniteMedium::position().
54
*/
55
double
position
()
const override
;
56
57
/**
58
* Sets the recent position of the finit medium.
59
* @see FiniteMedium::setPosition().
60
*/
61
bool
setPosition
(
const
double
position
)
override
;
62
63
/**
64
* Returns the speed of the finite medium.
65
* @see FiniteMedium::speed().
66
*/
67
float
speed
()
const override
;
68
69
/**
70
* Sets the speed of the finite medium.
71
* @see FiniteMedium::setSpeed().
72
*/
73
bool
setSpeed
(
const
float
speed
)
override
;
74
75
/**
76
* Returns whether a previous task has been finished.
77
* @see FiniteMedium::taskFinished().
78
*/
79
bool
taskFinished
()
const override
;
80
81
protected
:
82
83
/**
84
* Creates a new finite medium by a given url.
85
* @param url Url of the finite medium
86
*/
87
explicit
DSFiniteMedium
(
const
std::string&
url
);
88
89
/**
90
* Destructs a DSFiniteMedium object.
91
*/
92
~DSFiniteMedium
()
override
;
93
94
/**
95
* Stars the filter graph.
96
* @see DSGraphObject::startGraph().
97
*/
98
bool
startGraph
()
override
;
99
100
/**
101
* Creates several DirectShow interface.
102
* @return True, if succeeded
103
*/
104
bool
createFiniteInterface
();
105
106
/**
107
* Release the DirectShow interface.
108
*/
109
void
releaseFiniteInterface
();
110
111
/**
112
* Informs this finite medium object that the medium has been stopped (without knowledge of this finite medium).
113
*/
114
void
hasStopped
();
115
116
/**
117
* Function called by the scheduler repeatedly.
118
*/
119
virtual
void
onScheduler
();
120
121
protected
:
122
123
/// DirectShow media seeking interface.
124
ScopedIMediaSeeking
seekingInterface_
;
125
126
/// Explicit state that the medium has stopped.
127
bool
hasStopped_
=
false
;
128
129
/// Medium speed.
130
float
speed_
= 1.0f;
131
};
132
133
}
134
135
}
136
137
}
138
139
#endif
// META_OCEAN_MEDIA_DS_FINITE_MEDIUM_H
DSMedium.h
DirectShow.h
FiniteMedium.h
Scheduler.h
Ocean::Media::DirectShow::DSFiniteMedium::setSpeed
bool setSpeed(const float speed) override
Sets the speed of the finite medium.
Ocean::Media::DirectShow::DSFiniteMedium::createFiniteInterface
bool createFiniteInterface()
Creates several DirectShow interface.
Ocean::Media::DirectShow::DSFiniteMedium::releaseFiniteInterface
void releaseFiniteInterface()
Release the DirectShow interface.
Ocean::Media::DirectShow::DSFiniteMedium::~DSFiniteMedium
~DSFiniteMedium() override
Destructs a DSFiniteMedium object.
Ocean::Media::DirectShow::DSFiniteMedium::position
double position() const override
Returns the recent position of the finite medium.
Ocean::Media::DirectShow::DSFiniteMedium::DSFrameMedium
friend class DSFrameMedium
Definition
DSFiniteMedium.h:35
Ocean::Media::DirectShow::DSFiniteMedium::taskFinished
bool taskFinished() const override
Returns whether a previous task has been finished.
Ocean::Media::DirectShow::DSFiniteMedium::onScheduler
virtual void onScheduler()
Function called by the scheduler repeatedly.
Ocean::Media::DirectShow::DSFiniteMedium::seekingInterface_
ScopedIMediaSeeking seekingInterface_
DirectShow media seeking interface.
Definition
DSFiniteMedium.h:124
Ocean::Media::DirectShow::DSFiniteMedium::hasStopped
void hasStopped()
Informs this finite medium object that the medium has been stopped (without knowledge of this finite ...
Ocean::Media::DirectShow::DSFiniteMedium::speed_
float speed_
Medium speed.
Definition
DSFiniteMedium.h:130
Ocean::Media::DirectShow::DSFiniteMedium::setPosition
bool setPosition(const double position) override
Sets the recent position of the finit medium.
Ocean::Media::DirectShow::DSFiniteMedium::hasStopped_
bool hasStopped_
Explicit state that the medium has stopped.
Definition
DSFiniteMedium.h:127
Ocean::Media::DirectShow::DSFiniteMedium::duration
double duration() const override
Returns the duration of the finite medium.
Ocean::Media::DirectShow::DSFiniteMedium::speed
float speed() const override
Returns the speed of the finite medium.
Ocean::Media::DirectShow::DSFiniteMedium::normalDuration
double normalDuration() const override
Returns the duration without speed consideration.
Ocean::Media::DirectShow::DSFiniteMedium::startGraph
bool startGraph() override
Stars the filter graph.
Ocean::Media::DirectShow::DSFiniteMedium::DSFiniteMedium
DSFiniteMedium(const std::string &url)
Creates a new finite medium by a given url.
Ocean::Media::DirectShow::DSMedium::DSMedium
DSMedium(const std::string &url)
Creates a new medium by a given url.
Ocean::Media::FiniteMedium::FiniteMedium
FiniteMedium(const std::string &url)
Creates a new finite medium by a given url.
Ocean::Media::Medium::url
const std::string & url() const
Returns the url of the medium.
Definition
Medium.h:236
Ocean::Media::DirectShow::ScopedIMediaSeeking
ScopeDirectShowObject< IMediaSeeking > ScopedIMediaSeeking
Definition of a scoped object holding an IMediaSeeking object.
Definition
DSObject.h:139
Ocean::Media::DirectShow
Namespace of the Media DirectShow library.
Definition
DirectShow.h:24
Ocean::Media
Namespace of the Media library.
Definition
AAudio.h:26
Ocean
The namespace covering the entire Ocean framework.
Definition
Accessor.h:15
impl
ocean
media
directshow
DSFiniteMedium.h
Generated on
for Ocean by
1.15.0