third_party/WebKit/public/platform/WebMediaStreamTrack.h

/*
 * Copyright (C) 2013 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef WebMediaStreamTrack_h
#define WebMediaStreamTrack_h

#include "WebCommon.h"
#include "WebNonCopyable.h"
#include "WebPrivatePtr.h"
#include "WebString.h"

namespace blink {

class MediaStreamComponent;
class MediaStreamTrack;
class WebAudioSourceProvider;
class WebMediaStream;
class WebMediaStreamSource;
class WebString;

class WebMediaStreamTrack {
 public:
  enum class FacingMode { None, User, Environment, Left, Right };

  struct Settings {
    bool hasFrameRate() { return frameRate >= 0.0; }
    bool hasWidth() { return width >= 0; }
    bool hasHeight() { return height >= 0; }
    bool hasFacingMode() { return facingMode != FacingMode::None; }
    bool hasFocalLengthX() { return focalLengthX >= 0.0; }
    bool hasFocalLengthY() { return focalLengthY >= 0.0; }
    bool hasDepthNear() { return depthNear >= 0.0; }
    bool hasDepthFar() { return depthFar >= 0.0; }
    // The variables are read from
    // MediaStreamTrack::GetSettings only.
    double frameRate = -1.0;
    long width = -1;
    long height = -1;
    WebString deviceId;
    FacingMode facingMode = FacingMode::None;
    // Media Capture Depth Stream Extensions.
    double focalLengthX = -1.0;
    double focalLengthY = -1.0;
    double depthNear = -1.0;
    double depthFar = -1.0;
  };

  class TrackData {
   public:
    TrackData() {}
    virtual ~TrackData() {}
    virtual void getSettings(Settings&) = 0;
  };

  enum class ContentHintType {
    None,
    AudioSpeech,
    AudioMusic,
    VideoMotion,
    VideoDetail
  };

  WebMediaStreamTrack() {}
  WebMediaStreamTrack(const WebMediaStreamTrack& other) { assign(other); }
  ~WebMediaStreamTrack() { reset(); }

  WebMediaStreamTrack& operator=(const WebMediaStreamTrack& other) {
    assign(other);
    return *this;
  }
  BLINK_PLATFORM_EXPORT void assign(const WebMediaStreamTrack&);

  BLINK_PLATFORM_EXPORT void initialize(const WebMediaStreamSource&);
  BLINK_PLATFORM_EXPORT void initialize(const WebString& id,
                                        const WebMediaStreamSource&);

  BLINK_PLATFORM_EXPORT void reset();
  bool isNull() const { return m_private.isNull(); }

  BLINK_PLATFORM_EXPORT WebString id() const;

  BLINK_PLATFORM_EXPORT WebMediaStreamSource source() const;
  BLINK_PLATFORM_EXPORT bool isEnabled() const;
  BLINK_PLATFORM_EXPORT bool isMuted() const;
  BLINK_PLATFORM_EXPORT ContentHintType contentHint() const;

  // Extra data associated with this WebMediaStream.
  // If non-null, the extra data pointer will be deleted when the object is
  // destroyed.  Setting the track data pointer will cause any existing non-null
  // track data pointer to be deleted.
  BLINK_PLATFORM_EXPORT TrackData* getTrackData() const;
  BLINK_PLATFORM_EXPORT void setTrackData(TrackData*);

  // The lifetime of the WebAudioSourceProvider should outlive the
  // WebMediaStreamTrack, and clients are responsible for calling
  // setSourceProvider(0) before the WebMediaStreamTrack is going away.
  BLINK_PLATFORM_EXPORT void setSourceProvider(WebAudioSourceProvider*);

#if INSIDE_BLINK
  BLINK_PLATFORM_EXPORT WebMediaStreamTrack(MediaStreamComponent*);
  BLINK_PLATFORM_EXPORT WebMediaStreamTrack& operator=(MediaStreamComponent*);
  BLINK_PLATFORM_EXPORT operator WTF::PassRefPtr<MediaStreamComponent>() const;
  BLINK_PLATFORM_EXPORT operator MediaStreamComponent*() const;
#endif

 private:
  WebPrivatePtr<MediaStreamComponent> m_private;
};

}  // namespace blink

#endif  // WebMediaStreamTrack_h