summaryrefslogtreecommitdiffstats
path: root/dom/media/imagecapture/ImageCapture.h
diff options
context:
space:
mode:
Diffstat (limited to 'dom/media/imagecapture/ImageCapture.h')
-rw-r--r--dom/media/imagecapture/ImageCapture.h95
1 files changed, 95 insertions, 0 deletions
diff --git a/dom/media/imagecapture/ImageCapture.h b/dom/media/imagecapture/ImageCapture.h
new file mode 100644
index 0000000000..957a3ffccc
--- /dev/null
+++ b/dom/media/imagecapture/ImageCapture.h
@@ -0,0 +1,95 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim:set ts=2 sw=2 sts=2 et cindent: */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef IMAGECAPTURE_H
+#define IMAGECAPTURE_H
+
+#include "mozilla/DOMEventTargetHelper.h"
+#include "mozilla/dom/ImageCaptureBinding.h"
+#include "mozilla/Logging.h"
+
+namespace mozilla {
+
+#ifndef IC_LOG
+LogModule* GetICLog();
+# define IC_LOG(...) \
+ MOZ_LOG(GetICLog(), mozilla::LogLevel::Debug, (__VA_ARGS__))
+#endif
+
+namespace dom {
+
+class Blob;
+class MediaStreamTrack;
+class VideoStreamTrack;
+
+/**
+ * Implementation of https://dvcs.w3.org/hg/dap/raw-file/default/media-stream-
+ * capture/ImageCapture.html.
+ * The ImageCapture accepts a video MediaStreamTrack as input source. The image
+ * will be sent back as a JPG format via Blob event.
+ *
+ * All the functions in ImageCapture are run in main thread.
+ *
+ * There are two ways to capture image, MediaEngineSource and MediaTrackGraph.
+ * When the implementation of MediaEngineSource supports TakePhoto(),
+ * it uses the platform camera to grab image. Otherwise, it falls back
+ * to the MediaTrackGraph way.
+ */
+
+class ImageCapture final : public DOMEventTargetHelper {
+ public:
+ NS_DECL_ISUPPORTS_INHERITED
+ NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(ImageCapture, DOMEventTargetHelper)
+
+ IMPL_EVENT_HANDLER(photo)
+ IMPL_EVENT_HANDLER(error)
+
+ // WebIDL members.
+ void TakePhoto(ErrorResult& aResult);
+
+ // The MediaStreamTrack passed into the constructor.
+ MediaStreamTrack* GetVideoStreamTrack() const;
+
+ // nsWrapperCache member
+ JSObject* WrapObject(JSContext* aCx,
+ JS::Handle<JSObject*> aGivenProto) override {
+ return ImageCapture_Binding::Wrap(aCx, this, aGivenProto);
+ }
+
+ // ImageCapture class members
+ nsPIDOMWindowInner* GetParentObject() { return GetOwner(); }
+
+ static already_AddRefed<ImageCapture> Constructor(const GlobalObject& aGlobal,
+ MediaStreamTrack& aTrack,
+ ErrorResult& aRv);
+
+ ImageCapture(VideoStreamTrack* aTrack, nsPIDOMWindowInner* aOwnerWindow);
+
+ // Post a Blob event to script.
+ nsresult PostBlobEvent(Blob* aBlob);
+
+ // Post an error event to script.
+ // aErrorCode should be one of error codes defined in ImageCaptureError.h.
+ // aReason is the nsresult which maps to a error string in
+ // dom/base/domerr.msg.
+ nsresult PostErrorEvent(uint16_t aErrorCode, nsresult aReason = NS_OK);
+
+ bool CheckPrincipal();
+
+ protected:
+ virtual ~ImageCapture();
+
+ // Capture image by MediaEngine. If it's not support taking photo, this
+ // function should return NS_ERROR_NOT_IMPLEMENTED.
+ nsresult TakePhotoByMediaEngine();
+
+ RefPtr<VideoStreamTrack> mTrack;
+};
+
+} // namespace dom
+} // namespace mozilla
+
+#endif // IMAGECAPTURE_H