media_source_samsung.h

Go to the documentation of this file.

// Copyright 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef PPAPI_CPP_SAMSUNG_MEDIA_SOURCE_SAMSUNG_H_
#define PPAPI_CPP_SAMSUNG_MEDIA_SOURCE_SAMSUNG_H_

#include "ppapi/c/pp_array_output.h"
#include "ppapi/c/samsung/pp_media_source_samsung.h"
#include "ppapi/cpp/resource.h"
#include "ppapi/cpp/var.h"
#include "ppapi/cpp/samsung/media_control_samsung.h"

namespace pp {

class InstanceHandle;

/// Interface used by PNaCl appliction to provide chunks of multimedia data
/// to the platform. Those chunks will be decoded and played by the platform.
///
/// This interface inherits from PPB_MediaControl_Samsung.
///
/// API is similar to one defined in JavaScript's Media Source Extensions
class MediaSource_Samsung : public MediaControl_Samsung, public Resource {
 public:
  // Creates an is_null() MediaControl object.
  MediaSource_Samsung() {}

  /// Cretes MediaSource_Samsung resource for given |instance|
  explicit MediaSource_Samsung(const InstanceHandle& instance);

  /// Destructor
  virtual ~MediaSource_Samsung() {}

  /// PPB_MediaSource_Samsung API

  /// Binds given MediaSource to vide/audio object of given |id| present on
  /// HTML page on which given module is embedded.
  bool BindToHTMLPlayer(const Var& id);

  /// Adds source for which data are appended using Append method. Added source
  /// is container of type |type| encoded using codecs on |codecs| list.
  ///
  /// Returns status - PP_SourceAddStatus and |id| if status is OK.
  PP_SourceAddStatus AddSource(const Var& type, const Var& codecs,
      Var* out_id);

  /// Checks if given source is active i.e. it contains video, audio or
  /// text (subtitle) track being played
  bool IsSourceActive(const Var& id);

  /// Removes source of given |id| and frees associated resources with it.
  void RemoveSource(const Var& id);

  /// Appends data to given buffer (identified by |id|).
  /// |data| argument must be a handle to PPB_Buffer_Dev_0_4 instance.
  void Append(const Var& id, const Resource& data);

  /// Aborts given data source
  void Abort(const Var& id);

  /// Sets duration in microseconds of currently played stream
  /// duration is given in microseconds
  void SetDuration(PP_MicrosecondsDelta duration);

  /// Gets duration in microseconds of currently played stream
  PP_MicrosecondsDelta GetDuration();

  /// Sets end of stream. |error| argument represents whether it is just end
  /// of the stream (PP_MEDIAERROR_NO_ERROR) or some kind of error occured.
  void SetEndOfStream(PP_MediaError error);

  /// Sets a time offset (in microseconds) to be applied to subsequent
  /// buffers appended to the given buffer.
  bool SetTimestampOffset(const Var& id, PP_MicrosecondsDelta offset);

  /// |output| - An output array which will receive
  /// <code>PP_TimeRange</code> structures on success.
  ///
  /// The browser can not allocate memory on behalf of the plugin becaues
  /// the plugin and browser may have different allocators.
  /// A PP_ArrayOutput must be provided so that output will be stored in its
  /// allocated buffer.
  bool ReadTimeRanges(const Var& id,
                      PP_ArrayOutput output);

  /// Gets a current time of media.
  PP_MicrosecondsDelta GetMediaTime();

  /// Gets a ReadyState of media.
  PP_MediaReadyState GetReadyState();

  /// PPP_MediaSource_Samsung API

  /// Signals error during processing given data source (e.g. decoding error).
  virtual void Error(const Var& id, PP_SourceError reason) = 0;

  /// Signals activation of given data source.
  virtual void SourceOpen() = 0;

  /// Called when source is still attached to a media element, but endOfStream()
  /// has been called.
  virtual void SourceEnded() = 0;

  /// Signals unaatached data source to a media elemenet.
  virtual void SourceClose() = 0;

  // Signal sucsesfull append data.
  virtual void AppendEnd(const Var& id) = 0;

};

} // namespace pp

#endif // PPAPI_CPP_SAMSUNG_MEDIA_SOURCE_SAMSUNG_H_