Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/infinum/Android-GoldenEye

A wrapper for Camera1 and Camera2 API which exposes simple to use interface.
https://github.com/infinum/Android-GoldenEye

android android-development android-library camera camera1 camera2 kotlin kotlin-android kotlin-library open-source

Last synced: 3 months ago
JSON representation

A wrapper for Camera1 and Camera2 API which exposes simple to use interface.

Host: GitHub
URL: https://github.com/infinum/Android-GoldenEye
Owner: infinum
License: apache-2.0
Created: 2016-03-25T10:52:45.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2021-09-07T10:58:16.000Z (almost 3 years ago)
Last Synced: 2024-01-17T02:31:09.895Z (5 months ago)
Topics: android, android-development, android-library, camera, camera1, camera2, kotlin, kotlin-android, kotlin-library, open-source
Language: Kotlin
Homepage:
Size: 368 KB
Stars: 372
Watchers: 24
Forks: 53
Open Issues: 15
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-list - infinum/Android-GoldenEye - A wrapper for Camera1 and Camera2 API which exposes simple to use interface. (Kotlin)

README

# DEPRECATION NOTICE

This library is no longer being maintained. Since it is still being actively used on many projects, we will consider fixing any potential critical bugs, but there will be no further feature development nor minor bug fixing.

We recommend migrating to [CameraX](https://developer.android.com/training/camerax). While some very simple use-cases are still easier with GoldenEye, CameraX is lifecycle-aware and is an overall more complete solution.

# GoldenEye

## Quick guide

#### Add dependency

```gradle
implementation 'co.infinum:goldeneye:1.1.2'
```

#### Initialize

```kotlin
val goldenEye = GoldenEye.Builder(activity).build()
```

#### Open camera

```kotlin
if (ContextCompat.checkSelfPermission(context, Manifest.permission.CAMERA)
== PackageManager.PERMISSION_GRANTED
) {
/* Find back camera */
val backCamera = goldenEye.availableCameras.find { it.facing == Facing.BACK }
/* Open back camera */
goldenEye.open(textureView, backCamera, initCallback)
}
```

#### Take picture

```kotlin
goldenEye.takePicture(pictureCallback)
```

#### Record video

```kotlin
goldenEye.startRecording(file, videoCallback)
/* Somewhere later */
goldenEye.stopRecording()
```

You can see all GoldenEye methods [here](./goldeneye/src/main/java/co/infinum/goldeneye/GoldenEye.kt).

## Features

GoldenEye supports multiple Camera features that can be changed at runtime:

- [Flash mode](./goldeneye/src/main/java/co/infinum/goldeneye/models/FlashMode.kt)
- [Focus mode](./goldeneye/src/main/java/co/infinum/goldeneye/models/FocusMode.kt)
- [Preview scale](./goldeneye/src/main/java/co/infinum/goldeneye/models/PreviewScale.kt)
- Preview size
- Picture size
- Picture quality
- [Video quality](./goldeneye/src/main/java/co/infinum/goldeneye/models/VideoQuality.kt)
- Tap to focus
- Pinch to zoom
- [Antibanding mode](./goldeneye/src/main/java/co/infinum/goldeneye/models/AntibandingMode.kt)
- [White balance mode](./goldeneye/src/main/java/co/infinum/goldeneye/models/WhiteBalanceMode.kt)
- [Color effect mode](./goldeneye/src/main/java/co/infinum/goldeneye/models/ColorEffectMode.kt)

If you are interested to read in detail what is supported, there is thorough documentation inside [interfaces](./goldeneye/src/main/java/co/infinum/goldeneye/config).

## Builder

When initializing GoldenEye instance you can configure it to fit your needs with several interfaces.

#### [Logger](./goldeneye/src/main/java/co/infinum/goldeneye/Logger.kt)

By default logging is turned **OFF**. By implementing Logger interface, you can enable logs if needed.

```kotlin
object: Logger {
override fun log(message: String) {
/* Log standard message */
}

override fun log(t: Throwable) {
/* Log error */
}
}
```

#### [OnZoomChangedCallback](./goldeneye/src/main/java/co/infinum/goldeneye/Callbacks.kt)

GoldenEye supports pinch to zoom functionality. By using OnZoomChangedCallback you can receive callback every time the zoom changes.

```kotlin
object: OnZoomChangedCallback {
override fun onZoomChanged(zoom: Int) {
/* Do something */
}
}
```

#### [OnFocusChangedCallback](./goldeneye/src/main/java/co/infinum/goldeneye/Callbacks.kt)

GoldenEye supports tap to focus functionality. By using OnFocusChangedCallback you can receive callback every time the focus changes.

```kotlin
object: OnFocusChangedCallback {
override fun onFocusChanged(point: Point) {
/* Do something */
}
}
```

#### [PictureTransformation](./goldeneye/src/main/java/co/infinum/goldeneye/PictureTransformation.kt)

Once the picture is taken, by default, library will rotate the bitmap to be in sync with device's orientation and mirror
the image if it is taken with front camera. If you are not OK with this behavior, you can provide `PictureTransformation` implementation
that will be used instead. `PictureTransformation.transform` method is executed on the **background** thread!

```kotlin
object: PictureTransformation {
override fun transform(picture: Bitmap, config: CameraConfig, orientationDifference: Float): Bitmap {
/* Transform raw picture */
}
}
```

#### Advanced features

- [Antibanding mode](./goldeneye/src/main/java/co/infinum/goldeneye/models/AntibandingMode.kt)
- [White balance mode](./goldeneye/src/main/java/co/infinum/goldeneye/models/WhiteBalanceMode.kt)
- [Color effect mode](./goldeneye/src/main/java/co/infinum/goldeneye/models/ColorEffectMode.kt)

Advanced features are still in experimental phase and we noticed that they do not work on some devices and they were not
thoroughly tested so we decided to disable them by default. That means that if you try to change the value via setter, it will simply be ignored.

In case you want to try and play with advanced features, you can enable them when initializing GoldenEye instance.

```kotlin
GoldenEye.Builder(activity)
.withAdvancedFeatures()
.build()
```

#### Manually set Camera API

You can manually set Camera API and override default GoldenEye behavior. You can call `GoldenEye.preferredCameraApi(Context)` to check which
Camera API will be used by default. It can be useful to force Camera1 API as it is more consistent when taking pictures with FlashMode.ON
than Camera2. The issue with Camera1 is that some newer devices would **crash** when trying to record a video so be very cautious.

```kotlin
GoldenEye.Builder(activity)
.setCameraApi(CameraApi.CAMERA1)
.build()
```

## Edge case behavior

- If you call `startRecording` or `takePicture` while GoldenEye is already taking a picture or recording a video, immediate `onError`
callback will be dispatched for the **second** call, first call to `startRecording` or `takePicture` will still be active
- If you call `release` while GoldenEye is taking a picture or recording a video, everything will be canceled including all callbacks,
nothing will be dispatched
- If you call `GoldenEye.config` before `InitCallback#onReady` is dispatched, returned `config` will be `null`
- If you call `open` while camera is already opened, old camera will be released and closed and new camera will be opened

## Known issues

- Video recording with external camera is not supported due to current video configuration limitations of the internal API design
- OnePlus 6 - ColorEffectMode does not work
- Huawei Nexus 6P - Picture taken with Flash is too dark
- LG G5 - Picture taken with Flash is too dark

## Contributing

Feedback and code contributions are very much welcome. Just make a pull request with a short description of your changes.
By making contributions to this project you give permission for your code to be used under the same [license](LICENSE).

## Credits

Maintained and sponsored by [Infinum](http://www.infinum.co).