Ocean
Ocean Media Abstraction Library

The Ocean Media Library provides access to individual media objects. More...

Collaboration diagram for Ocean Media Abstraction Library:

Modules

 Ocean Media Android Library
 The Ocean Media Android Library provides camera access functionalities on android platforms.
 
 Ocean Media AVFoundation Library
 The Ocean Media AVFoundation Library provides media functionalities based on Apple's AV Foundation framework.
 
 Ocean Media DirectShow Library
 The Ocean Media DirectShow Library provides DirectShow media functionalities.
 
 Ocean Media FFmpeg Library
 The Ocean Media FFmpeg Library provides media functionalities based on the FFmpeg video/audio library.
 
 Ocean Media ImageIO Library
 The Ocean Media ImageIO Library provides media functionalities based on Apple's ImageIO Component.
 
 Ocean Media MediaFoundation Library
 The Ocean Media MediaFoundation Library provides MediaFoundation media functionalities.
 
 Ocean Media OpenImageLibraries Library
 The Ocean Media OpenImageLibraries Library provides image media functionalities based on common open image libraries like jpglib, libpng, and zlib.
 
 Ocean Media Special Library
 The Ocean Media Special Library provides image media functionalities based on special image formats like e.g., Npy, Pfm, or Bmp.
 
 Ocean Media USB Library
 The Ocean Media USB Library provides camera access to USB video devices.
 
 Ocean Media Windows Imaging Component (WIC) Library
 The Ocean Media WIC Library provides media functionalities based on the Microsoft's Windows Imaging Component.
 

Data Structures

class  Ocean::Media::Audio
 This class is the base class for all audio mediums. More...
 
class  Ocean::Media::BufferImage
 This class implements a frame medium object which is defined by a given buffer and image or frame type. More...
 
class  Ocean::Media::BufferImageRecorder
 This class is the base class for all buffer recorders. More...
 
class  Ocean::Media::BufferRecorder
 This class is the base class for all buffer recorders. More...
 
class  Ocean::Media::ConfigMedium
 This class is the base class for all mediums with advanced configuration possibilities. More...
 
class  Ocean::Media::ExplicitRecorder
 This class is the base class for all explicit media recorder. More...
 
class  Ocean::Media::FileRecorder
 This class is the base class for all file recorders. More...
 
class  Ocean::Media::FiniteMedium
 This class is the base class for all finite mediums. More...
 
class  Ocean::Media::FrameCollection
 This class implements a simple buffer holding several frames combined with their timestamps and optional camera calibrations. More...
 
class  Ocean::Media::FrameMedium
 This is the base class for all frame mediums. More...
 
class  Ocean::Media::FrameMemoryRecorder
 This class implements a frame recorder forwarding the frame to a shared memory. More...
 
class  Ocean::Media::FrameRecorder
 This class is the base class for all frame recorders. More...
 
class  Ocean::Media::Image
 This class is the base class for all images. More...
 
class  Ocean::Media::ImageRecorder
 This class is the base class for all image recorders. More...
 
class  Ocean::Media::ImageSequence
 This class is the base class for all image sequences. More...
 
class  Ocean::Media::ImageSequenceFrameProviderInterface
 This class implements a frame provider interface specialization using an image sequence medium object. More...
 
class  Ocean::Media::ImageSequenceRecorder
 This class implements an image sequence recorder. More...
 
class  Ocean::Media::ImageSequenceStereoImageProvider
 This class implements a provider for stereo images which are extracted from two separate image sequences and poses/calibration file. More...
 
class  Ocean::Media::ImplicitRecorder
 This class is the base class for all implicit media recorder. More...
 
class  Ocean::Media::Library
 This class is the base class for all media libraries. More...
 
class  Ocean::Media::LiveAudio
 This class is the base class for all live audios. More...
 
class  Ocean::Media::LiveMedium
 This class it the base class for all live mediums. More...
 
class  Ocean::Media::LiveVideo
 This class is the base class for all live videos. More...
 
class  Ocean::Media::Manager
 This class is the manager for all media objects. More...
 
class  Ocean::Media::Medium
 This is the base class for all mediums. More...
 
class  Ocean::Media::SmartMediumRef< T >
 This class implements a smart medium reference. More...
 
class  Ocean::Media::MediumRefManager
 This class implements a medium reference manager. More...
 
class  Ocean::Media::Microphone
 This class is the base class for all microphones. More...
 
class  Ocean::Media::Movie
 This class is the base class for all movies. More...
 
class  Ocean::Media::MovieFrameProvider
 This class implements a frame provider for movie mediums. More...
 
class  Ocean::Media::MovieFrameProviderInterface
 This class implements a frame provider interface specialization using a movie frame provider object. More...
 
class  Ocean::Media::MovieRecorder
 This class is the base class for all movie recorder. More...
 
class  Ocean::Media::PixelImage
 This class implements a frame medium object which uses an explicit frame only. More...
 
class  Ocean::Media::Recorder
 This class is the base class for all recorder. More...
 
class  Ocean::Media::SoundMedium
 This class is the base class for all sound mediums. More...
 
class  Ocean::Media::StereoImageProviderInterface
 This class is the abstract base class for all stereo image providers. More...
 
class  Ocean::Media::Utilities
 This class implements utilities functions for the media library. More...
 

Typedefs

typedef SmartMediumRef< AudioOcean::Media::AudioRef
 Definition of a smart medium reference holding a audio object. More...
 
typedef SmartMediumRef< BufferImageOcean::Media::BufferImageRef
 Definition of a smart medium reference holding a buffer image object. More...
 
typedef Ocean::SmartObjectRef< BufferImageRecorder, RecorderOcean::Media::BufferImageRecorderRef
 Definition of a object reference holding an buffer recorder. More...
 
typedef Ocean::SmartObjectRef< BufferRecorder, RecorderOcean::Media::BufferRecorderRef
 Definition of a object reference holding a buffer recorder. More...
 
typedef SmartMediumRef< ConfigMediumOcean::Media::ConfigMediumRef
 Definition of a smart medium reference holding a config medium object. More...
 
typedef Ocean::SmartObjectRef< ExplicitRecorder, RecorderOcean::Media::ExplicitRecorderRef
 Definition of a object reference holding an explicit recorder. More...
 
typedef Ocean::SmartObjectRef< FileRecorder, RecorderOcean::Media::FileRecorderRef
 Definition of a object reference holding a file recorder. More...
 
typedef SmartMediumRef< FiniteMediumOcean::Media::FiniteMediumRef
 Definition of a smart medium reference holding a finite medium object. More...
 
typedef SmartMediumRef< FrameMediumOcean::Media::FrameMediumRef
 Definition of a smart medium reference holding a frame medium object. More...
 
typedef std::vector< FrameMediumRefOcean::Media::FrameMediumRefs
 Definition of a vector holding frame medium reference objects. More...
 
typedef Ocean::SmartObjectRef< FrameMemoryRecorder, RecorderOcean::Media::FrameMemoryRecorderRef
 Definition of a object reference holding a frame memory recorder. More...
 
typedef Ocean::SmartObjectRef< FrameRecorder, RecorderOcean::Media::FrameRecorderRef
 Definition of a object reference holding a frame recorder. More...
 
typedef SmartMediumRef< ImageOcean::Media::ImageRef
 Definition of a smart medium reference holding an image object. More...
 
typedef Ocean::SmartObjectRef< ImageRecorder, RecorderOcean::Media::ImageRecorderRef
 Definition of a object reference holding an image recorder. More...
 
typedef SmartMediumRef< ImageSequenceOcean::Media::ImageSequenceRef
 Definition of a smart medium reference holding an image sequence object. More...
 
typedef Ocean::SmartObjectRef< ImageSequenceRecorder, RecorderOcean::Media::ImageSequenceRecorderRef
 Definition of a object reference holding an image sequence recorder. More...
 
typedef Ocean::SmartObjectRef< ImplicitRecorder, RecorderOcean::Media::ImplicitRecorderRef
 Definition of a object reference holding an explicit recorder. More...
 
typedef ObjectRef< LibraryOcean::Media::LibraryRef
 Definition of a object reference holding a library object. More...
 
typedef SmartMediumRef< LiveAudioOcean::Media::LiveAudioRef
 Definition of a smart medium reference holding a live audio object. More...
 
typedef SmartMediumRef< LiveMediumOcean::Media::LiveMediumRef
 Definition of a smart medium reference holding a live medium object. More...
 
typedef SmartMediumRef< LiveVideoOcean::Media::LiveVideoRef
 Definition of a smart medium reference holding a live video object. More...
 
typedef ObjectRef< MediumOcean::Media::MediumRef
 This class implements a medium reference with an internal reference counter. More...
 
typedef SmartMediumRef< MicrophoneOcean::Media::MicrophoneRef
 Definition of a smart medium reference holding a microphone object. More...
 
typedef SmartMediumRef< MovieOcean::Media::MovieRef
 Definition of a smart medium reference holding a movie object. More...
 
typedef ObjectRef< MovieFrameProviderOcean::Media::MovieFrameProviderRef
 Definition of an object reference holding a frame provider. More...
 
typedef Ocean::SmartObjectRef< MovieRecorder, RecorderOcean::Media::MovieRecorderRef
 Definition of a object reference holding a movie recorder. More...
 
typedef SmartMediumRef< PixelImageOcean::Media::PixelImageRef
 Definition of a smart medium reference holding a pixel image object. More...
 
typedef Ocean::ObjectRef< RecorderOcean::Media::RecorderRef
 Definition of a object reference holding recorder objects. More...
 
typedef SmartMediumRef< SoundMediumOcean::Media::SoundMediumRef
 Definition of a smart medium reference holding a sound medium object. More...
 
typedef ObjectRef< LibraryOcean::SceneDescription::LibraryRef
 Definition of a object reference holding a library object. More...
 

Detailed Description

The Ocean Media Library provides access to individual media objects.

Media object can provide visual or/and audio content or can capture visual or/and audio content.

The base class for all media objects providing content is the Medium class.
All Medium classes are designed to provide the content in real-time.
There can be finite Medium objects like movie or audio files or there can be infinite Medium objects like live video streams or live camera streams.

See also
Medium, Image, Movie, Audio, FiniteMedium.

The base class for all media objects capturing content is the Recorder class.
Whether a Recorder is able to capture content in real-time depends on the underlying hardware and the underlying encoder technology.

See also
Recorder, MovieRecorder.

Further, this library provides an abstract frame provider interface allowing random access for visual content of finite media objects.

See also
MediaFrameProviderInterface.

This library is mainly an abstraction layer for the media objects.
The actual implementation of the media objects is lokated in separate libraries allowing to realize individual media libraries on individual hardware platforms.
However, the actual implementation is hided from the user so that any kind of media object from any kind of media library can be applied by the same functions and interfaces.
Any derived media library implements a Library class which registers all supported media objects and media types at the media Manager of this abstraction library.
This manager provides the unique access to all media objects.

See also
Manager, Library.

The Utilities class provides simple helper functions to receive e.g., the visual content from an image file.

The library is platform independent.

Typedef Documentation

◆ AudioRef

Definition of a smart medium reference holding a audio object.

See also
SmartMediumRef, Audio.

◆ BufferImageRecorderRef

Definition of a object reference holding an buffer recorder.

See also
SmartObjectRef, BufferRecorder.

◆ BufferImageRef

Definition of a smart medium reference holding a buffer image object.

See also
SmartMediumRef, BufferImage.

◆ BufferRecorderRef

Definition of a object reference holding a buffer recorder.

See also
SmartObjectRef, BufferRecorder.

◆ ConfigMediumRef

Definition of a smart medium reference holding a config medium object.

See also
SmartMediumRef, ConfigMedium.

◆ ExplicitRecorderRef

Definition of a object reference holding an explicit recorder.

See also
SmartObjectRef, ExplicitRecorder.

◆ FileRecorderRef

Definition of a object reference holding a file recorder.

See also
SmartObjectRef, FileRecorder.

◆ FiniteMediumRef

Definition of a smart medium reference holding a finite medium object.

See also
SmartMediumRef, FiniteMedium.

◆ FrameMediumRef

Definition of a smart medium reference holding a frame medium object.

See also
SmartMediumRef, FrameMedium.

◆ FrameMediumRefs

Definition of a vector holding frame medium reference objects.

See also
FrameMediumRef.

◆ FrameMemoryRecorderRef

Definition of a object reference holding a frame memory recorder.

See also
SmartObjectRef, FrameMemoryRecorder.

◆ FrameRecorderRef

Definition of a object reference holding a frame recorder.

See also
SmartObjectRef, Recorder.

◆ ImageRecorderRef

Definition of a object reference holding an image recorder.

See also
SmartObjectRef, ImageRecorder.

◆ ImageRef

Definition of a smart medium reference holding an image object.

See also
SmartMediumRef, Image.

◆ ImageSequenceRecorderRef

Definition of a object reference holding an image sequence recorder.

See also
SmartObjectRef, ImageSequenceRecorder.

◆ ImageSequenceRef

Definition of a smart medium reference holding an image sequence object.

See also
SmartMediumRef, ImageSequence.

◆ ImplicitRecorderRef

Definition of a object reference holding an explicit recorder.

See also
SmartObjectRef, ExplicitRecorder.

◆ LibraryRef [1/2]

Definition of a object reference holding a library object.

See also
ObjectRef, Library.

◆ LibraryRef [2/2]

Definition of a object reference holding a library object.

See also
ObjectRef, Library.

◆ LiveAudioRef

Definition of a smart medium reference holding a live audio object.

See also
SmartMediumRef, LiveAudio.

◆ LiveMediumRef

Definition of a smart medium reference holding a live medium object.

See also
SmartMediumRef, LiveMedium.

◆ LiveVideoRef

Definition of a smart medium reference holding a live video object.

See also
SmartMediumRef, LiveVideo.

◆ MediumRef

This class implements a medium reference with an internal reference counter.

See also
ObjectRef, Medium

◆ MicrophoneRef

Definition of a smart medium reference holding a microphone object.

See also
SmartMediumRef, Microphone.

◆ MovieFrameProviderRef

Definition of an object reference holding a frame provider.

See also
MovieFrameProvider.

◆ MovieRecorderRef

Definition of a object reference holding a movie recorder.

See also
SmartObjectRef, MovieRecorder.

◆ MovieRef

Definition of a smart medium reference holding a movie object.

See also
SmartMediumRef, Movie.

◆ PixelImageRef

Definition of a smart medium reference holding a pixel image object.

See also
SmartMediumRef, PixelImage.

◆ RecorderRef

Definition of a object reference holding recorder objects.

◆ SoundMediumRef

Definition of a smart medium reference holding a sound medium object.

See also
SmartMediumRef, SoundMedium.