CMMFVideoPlayHwDevice Class Reference

Commit all changes since the last CommitL(), Revert() or Initialize() to the hardware device. This only applies to methods which can be called both before AND after DevVideoPlay has been initialized.

See also: SetPostProcessTypesL SetInputCropOptionsL SetYuvToRgbOptionsL SetRotateOptionsL SetScaleOptionsL SetOutputCropOptionsL SetPostProcSpecificOptionsL

leave

"The method will leave if an error occurs."

Pre-condition

"This method can only be called after the hwdevice has been initialized with Initialize()."

Freezes a picture on the screen. After the picture has been frozen, no new pictures are displayed until the freeze is released with ReleaseFreeze(). If the device output is being written to memory buffers or to another plug-in, instead of the screen, no decoded pictures will be delivered while the freeze is active, and they are simply discarded.

Gets information about a computational complexity level. This method can be called after NumComplexityLevels() has returned a non-zero value - at that point the information is guaranteed to be available. Some hardware device implementations may not be able to provide all values, in that case the values will be approximated.

Retrieves the list of the output formats that the device supports. The list is ordered in plug-in preference order, with the preferred formats at the beginning of the list. The list can depend on the device source format, and therefore SetSourceFormatL() must be called before calling this method.

Reads various counters related to decoded pictures. The counters are reset when Initialize() or this method is called, and thus they only include pictures processed since the last call.

Post-processor devices return the number of input pictures in iPicturesDecoded and iTotalPictures. If the decoded pictures are written to another plug-in, they are considered to be "virtually displayed".

Gets a copy of the latest picture sent to output.

Gets a list of the supported snapshot picture formats.

When the snapshot is available, it will be returned to the client using the TimedSnapshotComplete() callback. To cancel a timed snapshot request, use CancelTimedSnapshot(). Only one timed snapshot request can be active at a time.

When the snapshot is available, it will be returned to the client using the TimedSnapshotComplete() callback. To cancel a timed snapshot request, use CancelTimedSnapshot(). Only one timed snapshot request can be active at a time.

Initializes the device. This method is asynchronous, the device will call MMFVideoPlayProxy::MdvppInitializeComplete() after initialization has completed. After this method has successfully completed, further configuration changes are not possible except where separately noted.

Notifies the hardware device that the end of input data has been reached and no more input data will be written. The hardware device can use this signal to ensure that the remaining data gets processed, without waiting for new data. For example when the data type is not EDuCodedPicture, calling this method is necessary otherwise a hardware device implementation might be looking for the start code for the next picture to ensure it has a complete picture before starting to decode the previous one.

After the remaining data has been processed (and displayed, if applicable), the hardware device must notify the proxy with the MdvppStreamEnd() callback.

DevVideo clients are encouraged to call this method, but its use is not mandatory for synchronized processing. For synchronized playback, all video pictures are processed or discarded according to their timestamps, and so the client can easily infer when processing is complete. However, it should be noted that the last picture might not be displayed if this method is not called and the input data type is not EDuCodedPicture.

For non-synchronized playback (e.g. file conversion), a client must call this method otherwise it will never find out when the hardware device has finished processing the data.

Indicates whether playback is proceeding. This method can be used to check whether playback was paused or not in response to a new clipping region or DSA abort.

Gets the number of complexity levels available.

Returns the total amount of memory allocated for uncompressed pictures. This figure only includes the pictures actually allocated by the plug-in itself, so that the total number of bytes allocated in the system can be calculated by taking the sum of the values from all plug-ins.

Returns the current playback position, i.e. the timestamp for the most recently displayed or virtually displayed picture. If the device output is written to another device, the most recent output picture is used.

Retrieves post-processing information about this hardware device. The device creates a CPostProcessorInfo structure, fills it with correct data, pushes it to the cleanup stack and returns it. The client will delete the object when it is no longer needed.

Releases a picture frozen with FreezePicture().

Returns a picture back to the device. This method is called by CMMFDevVideoPlay to return pictures from the client (after they have been written with NewPicture()), or by the output device when it has finished using a picture.

Revert all changes since the last CommitL(), Revert() or Initialize() back to their previous settings. This only applies to methods which can be called both before AND after DevVideoPlay has been initialized.

See also: SetPostProcessTypesL SetInputCropOptionsL SetYuvToRgbOptionsL SetRotateOptionsL SetScaleOptionsL SetOutputCropOptionsL SetPostProcSpecificOptionsL

Pre-condition

"This method can only be called after the hwdevice has been initialized with Initialize()."

Sets the clock source to use for video timing. If no clock source is set. video playback will not be synchronized, but will proceed as fast as possible, depending on input data and output buffer availability.

Sets the computational complexity level to use. If separate complexity levels are not available, the method call is ignored. If the level specified is not available, the results are undefined. Typically the device will either ignore the request or use the nearest suitable level.

The complexity level can be changed at any point during playback.

Sets post-processing options for input (pan-scan) cropping.

Sets post-processing options for output cropping. SetPostProcessTypesL() must be called before this method is used.

Sets the device output format.

Sets whether the system should pause playback when it gets a clipping region it cannot handle, or Direct Screen Access is aborted completely. If not, processing will proceed normally, but no video will be drawn. By default, playback is paused.

Changes to a new decoding and playback position, used for randomly accessing (seeking) the input stream. The position change flushes all input and output buffers. Pre-decoder and post-decoder buffering are handled as if a new bitstream was being decoded. If the device still has buffered pictures that precede the new playback position, they will be discarded. If playback is synchronized to a clock source, the client is responsible for setting the clock source to the new position.

Sets post-processing plug-in specific options. SetPostProcessTypesL() must be called before this method is used.

Sets the post-processing types to be used.

Sets post-processing options for rotation. SetPostProcessTypesL() must be called before this method is used.

Sets post-processing options for scaling. SetPostProcessTypesL() must be called before this method is used.

Sets a new clipping region for Direct Screen Access. After the method returns, no video will be drawn outside of the region. If clipping is not supported, or the clipping region is too complex, either playback will pause or will resume without video display, depending on the current setting of SetPauseOnClipFail(), and the result can be verified with IsPlaying(). Clipping can be disabled by setting a new clipping region that includes the whole video window.

Sets the device video output destination. The destination can be the screen (using direct screen access) or memory buffers. By default memory buffers are used. If data is written to another device, this method is ignored, and suitable memory buffers are always used.

Sets post-processing options for YUV to RGB color space conversion. Specifies the input YUV and output RGB formats to use explicitly. SetSourceFormatL(), SetOutputFormatL(), and SetPostProcessTypesL() must be called before this method is used.

Sets post-processing options for YUV to RGB color space conversion. Uses the device input and output formats. For decoder devices the default YUV format used is the format specified in the input bitstream. SetSourceFormatL(), SetOutputFormatL(), and SetPostProcessTypesL() must be called before this method is used.

Starts writing output directly to the display frame buffer using Direct Screen Access.