edsdk.api.commands.SetPropertyCommand Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of edsdk4j Show documentation
Show all versions of edsdk4j Show documentation
Canon EDSDK Software Development Kit Java Wrapper
The newest version!
package edsdk.api.commands;
import com.sun.jna.NativeLong;
import edsdk.api.CanonCommand;
import edsdk.bindings.EdSdkLibrary.EdsBaseRef;
import edsdk.bindings.EdsPictureStyleDesc;
import edsdk.bindings.EdsPoint;
import edsdk.bindings.EdsRect;
import edsdk.bindings.EdsSize;
import edsdk.utils.CanonConstants.DescriptiveEnum;
import edsdk.utils.CanonConstants.EdsAEMode;
import edsdk.utils.CanonConstants.EdsAFMode;
import edsdk.utils.CanonConstants.EdsAv;
import edsdk.utils.CanonConstants.EdsColorSpace;
import edsdk.utils.CanonConstants.EdsCustomFunction;
import edsdk.utils.CanonConstants.EdsDataType;
import edsdk.utils.CanonConstants.EdsDriveMode;
import edsdk.utils.CanonConstants.EdsError;
import edsdk.utils.CanonConstants.EdsEvfAFMode;
import edsdk.utils.CanonConstants.EdsEvfOutputDevice;
import edsdk.utils.CanonConstants.EdsEvfZoom;
import edsdk.utils.CanonConstants.EdsExposureCompensation;
import edsdk.utils.CanonConstants.EdsFilterEffect;
import edsdk.utils.CanonConstants.EdsISOSpeed;
import edsdk.utils.CanonConstants.EdsImageQuality;
import edsdk.utils.CanonConstants.EdsMeteringMode;
import edsdk.utils.CanonConstants.EdsPictureStyle;
import edsdk.utils.CanonConstants.EdsPropertyID;
import edsdk.utils.CanonConstants.EdsSaveTo;
import edsdk.utils.CanonConstants.EdsTonigEffect;
import edsdk.utils.CanonConstants.EdsTv;
import edsdk.utils.CanonConstants.EdsWhiteBalance;
import edsdk.utils.CanonUtils;
/**
* Sets a property on the camera.
*
* Copyright © 2014 Hansi Raber , Ananta Palani
*
* This work is free. You can redistribute it and/or modify it under the
* terms of the Do What The Fuck You Want To Public License, Version 2,
* as published by Sam Hocevar. See the COPYING file for more details.
*
* @author hansi
* @author Ananta Palani
*
*/
//TODO: These are defined in EdSdkLibrary but are not described in the API
//Docs...
//kEdsPropID_DepthOfField (EdsUInt32),
//kEdsPropID_EFCompensation,
//kEdsPropID_Evf_FocusAid,
//kEdsPropID_MyMenu (kEdsDataType_UInt32_Array - EdsUInt32[])
//
//TODO: These are no longer in the EdSdkLibrary and are not described
//by the API Docs.. seem to be able to get the values
//(see GetPropertyCommand)...haven't tried setting it. Can it be set?
//kEdsPropID_Evf_ImageClipRect (EdsDataType.kEdsDataType_ByteBlock -
//EdsUInt32[])
//
//TODO: Should better handle kEdsDataType_Unknown, which seems to be returned
//if the camera doesn't support a property. Could have CanonCommand have an
//EdsError field, and if null is returned by the command, the error could be
//read by the user
//
public abstract class SetPropertyCommand extends CanonCommand {
private final EdsPropertyID property;
private final long param;
private final T value;
private final Class klass;
private final boolean isLiveViewCommand;
private final int liveViewRetryCount = 2;
private final int busyRetryCount = 500;
public SetPropertyCommand( final EdsPropertyID property, final T value ) {
this( property, 0, value, false );
}
public SetPropertyCommand( final EdsPropertyID property, final long param,
final T value ) {
this( property, param, value, false );
}
public SetPropertyCommand( final EdsPropertyID property, final T value,
final boolean isLiveViewCommand ) {
this( property, 0, value, isLiveViewCommand );
}
@SuppressWarnings( "unchecked" )
public SetPropertyCommand( final EdsPropertyID property, final long param,
final T value, final boolean isLiveViewCommand ) {
this.property = property;
this.param = param;
this.value = value;
if ( value != null ) {
klass = (Class) value.getClass();
} else {
klass = null;
}
this.isLiveViewCommand = isLiveViewCommand;
}
@SuppressWarnings( "unchecked" )
@Override
public void run() {
if ( value == null ) {
throw new IllegalStateException( "Cannot set a null value!" );
}
Throwable t = null;
EdsBaseRef.ByReference[] references = null;
try {
final EdsBaseRef baseRef;
if ( isLiveViewCommand ) {
if ( CanonUtils.isLiveViewEnabled( camera.getEdsCamera(), false ) ) {
for ( int i = 0; i < liveViewRetryCount &&
references == null; i++ ) {
if ( i > 0 ) {
Thread.sleep( 100 );
}
references = CanonUtils.getLiveViewImageReference( camera.getEdsCamera() );
}
if ( references != null ) {
baseRef = references[0].getValue();
} else {
//TODO: it may take several seconds for live view to start, so this might happen every time.. perhaps the previous should be tried for a few seconds
//throw new IllegalStateException( "Could not retrieve live view image reference!" );
System.err.println( "Could not retrieve live view image reference!" );
setResult( null );
return;
}
} else {
//throw new IllegalStateException( "Live view is not enabled!" );
System.err.println( "Live view is not enabled!" );
setResult( null );
return;
}
} else {
baseRef = camera.getEdsCamera();
}
final EdsDataType type = CanonUtils.getPropertyType( baseRef, property, param );
EdsError err = EdsError.EDS_ERR_DEVICE_BUSY;
int retries = 0;
while ( retries < busyRetryCount &&
err == EdsError.EDS_ERR_DEVICE_BUSY ) {
//TODO: it would be better to use the actual error from CanonUtils.getPropertyType(), but in testing a valid value was always returned if something was supported
err = EdsError.EDS_ERR_NOT_SUPPORTED;
switch ( type ) {
case kEdsDataType_Int32: //EdsInt32
case kEdsDataType_UInt32: { //EdsUInt32
final long longValue;
if ( Boolean.class.isAssignableFrom( klass ) ) {
// Boolean
longValue = (Boolean) value ? 1l : 0l;
} else if ( DescriptiveEnum.class.isAssignableFrom( klass ) ) {
// DescriptiveEnum
longValue = ( (DescriptiveEnum) value ).value().longValue();
} else {
// Long
longValue = (Long) value;
}
err = CanonUtils.setPropertyData( baseRef, property, param, longValue );
break;
}
case kEdsDataType_String: //EdsChar[]
case kEdsDataType_Point: //EdsPoint
case kEdsDataType_Rect: //EdsRect
case kEdsDataType_Time: //EdsTime
case kEdsDataType_FocusInfo: //EdsFocusInfo
case kEdsDataType_PictureStyleDesc: { //EdsPictureStyleDesc
err = CanonUtils.setPropertyDataAdvanced( baseRef, property, param, value );
break;
}
case kEdsDataType_ByteBlock: //EdsUInt32[]
case kEdsDataType_Int32_Array: //EdsInt32[]
case kEdsDataType_UInt32_Array: { //EdsUInt32[]
final int[] array;
if ( DescriptiveEnum[].class.isAssignableFrom( klass ) ) {
// DescriptiveEnum[]
final DescriptiveEnum[] valueArray = (DescriptiveEnum[]) value;
array = new int[valueArray.length];
for ( int i = 0; i < valueArray.length; i++ ) {
array[i] = valueArray[i].value().intValue();
}
} else if ( DescriptiveEnum.class.isAssignableFrom( klass ) ) {
// DescriptiveEnum
array = new int[] { ( (DescriptiveEnum) value ).value().intValue() };
} else if ( EdsRect.class.isAssignableFrom( klass ) ) {
// EdsRect
final EdsRect edsRect = (EdsRect) value;
array = new int[] { edsRect.point.x.intValue(),
edsRect.point.y.intValue(),
edsRect.size.width.intValue(),
edsRect.size.height.intValue() };
} else if ( EdsSize.class.isAssignableFrom( klass ) ) {
// EdsSize
final EdsSize edsSize = (EdsSize) value;
array = new int[] { edsSize.width.intValue(),
edsSize.height.intValue() };
} else {
// int[]
array = (int[]) value;
}
err = CanonUtils.setPropertyDataAdvanced( baseRef, property, param, array );
break;
}
default:
System.err.println( type.description() +
" (" +
type.name() +
") is not currently supported by SetPropertyCommand. Likely this camera does not support property " +
property.name() +
" in the current mode or at all." );
// throw new IllegalStateException( type.description() + " (" +
// type.name() +
// ") is not currently supported by SetPropertyCommand. Likely this camera does not support property " + property.name() + " in the current mode or at all." );
}
retries++;
Thread.sleep( 10 );
}
if( retries > 1 ){
System.out.println( "Set property: " + property.name() + " - " +
property.description() +
( param > 0l ? param : "" ) + " = " + value +
", result " + err.value() + ": " + err.name() +
" - " + err.description() + " after " +
retries + " tries" );
}
setResult( err == EdsError.EDS_ERR_OK );
return;
}
catch ( final IllegalArgumentException e ) {
t = e;
}
catch ( final InterruptedException e ) {
t = e;
}
finally {
if ( references != null ) {
CanonUtils.release( references );
}
}
System.err.println( t.getMessage() );
setResult( null );
}
public static class Data extends SetPropertyCommand {
public Data( final EdsPropertyID property, final long value,
final boolean isLiveViewCommand ) {
super( property, value, true );
}
public Data( final EdsPropertyID property, final long value ) {
super( property, value );
}
}
public static class EnumData extends SetPropertyCommand> {
public EnumData( final EdsPropertyID property,
final DescriptiveEnum value,
final boolean isLiveViewCommand ) {
super( property, value, true );
}
public EnumData( final EdsPropertyID property,
final DescriptiveEnum value ) {
super( property, value );
}
}
/*
* Specific Property ID Commands
*/
public static class CustomFunction extends SetPropertyCommand {
public CustomFunction( final EdsCustomFunction customFunction,
final long value ) {
super( EdsPropertyID.kEdsPropID_CFn, customFunction.value(), value );
}
}
public static class Artist extends SetPropertyCommand {
public Artist( final String value ) {
super( EdsPropertyID.kEdsPropID_Artist, value );
}
}
public static class Copyright extends SetPropertyCommand {
public Copyright( final String value ) {
super( EdsPropertyID.kEdsPropID_Copyright, value );
}
}
public static class OwnerName extends SetPropertyCommand {
public OwnerName( final String value ) {
super( EdsPropertyID.kEdsPropID_OwnerName, value );
}
}
public static class SaveTo extends SetPropertyCommand {
public SaveTo( final EdsSaveTo value ) {
super( EdsPropertyID.kEdsPropID_SaveTo, value );
}
}
public static class HardDriveDirectoryStructure extends SetPropertyCommand {
public HardDriveDirectoryStructure( final String value ) {
super( EdsPropertyID.kEdsPropID_HDDirectoryStructure, value );
}
}
public static class JPEGQuality extends SetPropertyCommand {
public JPEGQuality( final long value ) {
super( EdsPropertyID.kEdsPropID_JpegQuality, value );
}
}
public static class ColorTemperature extends SetPropertyCommand {
public ColorTemperature( final long value ) {
super( EdsPropertyID.kEdsPropID_ColorTemperature, value );
}
}
public static class WhiteBalanceShift extends SetPropertyCommand {
public WhiteBalanceShift( final int[] value ) {
super( EdsPropertyID.kEdsPropID_WhiteBalanceShift, value );
}
}
public static class ParameterSet extends SetPropertyCommand {
public ParameterSet( final long value ) {
super( EdsPropertyID.kEdsPropID_ParameterSet, value );
}
}
public static class PictureStyleDescription extends SetPropertyCommand {
public PictureStyleDescription( final EdsPictureStyleDesc value ) {
super( EdsPropertyID.kEdsPropID_PictureStyleDesc, value );
}
public PictureStyleDescription( final long contrast,
final long sharpness,
final long saturation,
final long colorTone,
final EdsFilterEffect filterEffect,
final EdsTonigEffect toningEffect ) {
super( EdsPropertyID.kEdsPropID_PictureStyleDesc, new EdsPictureStyleDesc( new NativeLong( contrast ), new NativeLong( sharpness ), new NativeLong( saturation ), new NativeLong( colorTone ), new NativeLong( filterEffect.value() ), new NativeLong( toningEffect.value() ) ) );
}
}
public static class MovieShootingStatus extends SetPropertyCommand {
public MovieShootingStatus( final long value ) {
super( EdsPropertyID.kEdsPropID_Record, value );
}
}
public static class LiveViewOutputDevice extends SetPropertyCommand {
public LiveViewOutputDevice( final EdsEvfOutputDevice value ) {
super( EdsPropertyID.kEdsPropID_Evf_OutputDevice, value );
}
}
// true if live view enabled, false if disabled
public static class LiveViewMode extends SetPropertyCommand {
public LiveViewMode( final boolean value ) {
super( EdsPropertyID.kEdsPropID_Evf_Mode, value );
}
}
public static class LiveViewColorTemperature extends SetPropertyCommand {
public LiveViewColorTemperature( final long value ) {
super( EdsPropertyID.kEdsPropID_Evf_ColorTemperature, value );
}
}
// true if preview on, false if off
public static class LiveViewDepthOfFieldInPreview extends SetPropertyCommand {
public LiveViewDepthOfFieldInPreview( final boolean value ) {
super( EdsPropertyID.kEdsPropID_Evf_DepthOfFieldPreview, value );
}
}
public static class DriveMode extends SetPropertyCommand {
public DriveMode( final EdsDriveMode value ) {
super( EdsPropertyID.kEdsPropID_DriveMode, value );
}
}
public static class ISOSpeed extends SetPropertyCommand {
public ISOSpeed( final EdsISOSpeed value ) {
super( EdsPropertyID.kEdsPropID_ISOSpeed, value );
}
}
public static class MeteringMode extends SetPropertyCommand {
public MeteringMode( final EdsMeteringMode value ) {
super( EdsPropertyID.kEdsPropID_MeteringMode, value );
}
}
/**
* AutoFocusMode = AFMode
*
*/
//TODO: API indicates this is a read only property - test if this works
public static class AutoFocusMode extends SetPropertyCommand {
public AutoFocusMode( final EdsAFMode value ) {
super( EdsPropertyID.kEdsPropID_AFMode, value );
}
}
/**
* ApertureValue = Av
*
*/
public static class ApertureValue extends SetPropertyCommand {
public ApertureValue( final EdsAv value ) {
super( EdsPropertyID.kEdsPropID_Av, value );
}
}
/**
* ShutterSpeed = Tv
*
*/
public static class ShutterSpeed extends SetPropertyCommand {
public ShutterSpeed( final EdsTv value ) {
super( EdsPropertyID.kEdsPropID_Tv, value );
}
}
public static class ExposureCompensation extends SetPropertyCommand {
public ExposureCompensation( final EdsExposureCompensation value ) {
super( EdsPropertyID.kEdsPropID_ExposureCompensation, value );
}
}
/**
* ShootingMode = AEMode
*
* According to the EDSDK API docs this should only work on cameras without
* dials. However, it seems to work on the EOS 550D and may work on other
* models, but note that it takes about half a second to change the mode
* on the EOS 550D, so you may want to do a loop that waits until the mode
* has changed by testing whether the current shooting mode is equal to
* the target shooting mode.
*
* Oddly, if you remove the USB cable without turning the camera off, the
* shooting mode stated on the camera display will be the same as that set
* by this function and may be different from that set on the dial. It is
* not reset by unplugging the USB cable.
*
* Switching the dial to another value will change the current mode
* regardless of whether the USB cable is plugged in or not.
*
*/
public static class ShootingMode extends SetPropertyCommand {
public ShootingMode( final EdsAEMode value ) {
super( EdsPropertyID.kEdsPropID_AEModeSelect, value );
}
}
public static class ImageQuality extends SetPropertyCommand {
public ImageQuality( final EdsImageQuality value ) {
super( EdsPropertyID.kEdsPropID_ImageQuality, value );
}
}
public static class WhiteBalance extends SetPropertyCommand {
public WhiteBalance( final EdsWhiteBalance value ) {
super( EdsPropertyID.kEdsPropID_WhiteBalance, value );
}
}
public static class ColorSpace extends SetPropertyCommand {
public ColorSpace( final EdsColorSpace value ) {
super( EdsPropertyID.kEdsPropID_ColorSpace, value );
}
}
public static class PictureStyle extends SetPropertyCommand {
public PictureStyle( final EdsPictureStyle value ) {
super( EdsPropertyID.kEdsPropID_PictureStyle, value );
}
}
/**
* LiveViewWhiteBalance = Evf_WhiteBalance
*
*/
public static class LiveViewWhiteBalance extends SetPropertyCommand {
public LiveViewWhiteBalance( final EdsWhiteBalance value ) {
super( EdsPropertyID.kEdsPropID_Evf_WhiteBalance, value );
}
}
/**
* LiveViewAutoFocusMode = Evf_AFMode
*
*/
public static class LiveViewAutoFocusMode extends SetPropertyCommand {
public LiveViewAutoFocusMode( final EdsEvfAFMode value ) {
super( EdsPropertyID.kEdsPropID_Evf_AFMode, value );
}
}
public static class LiveViewZoomRatio extends SetPropertyCommand {
public LiveViewZoomRatio( final EdsEvfZoom value ) {
super( EdsPropertyID.kEdsPropID_Evf_Zoom, value );
}
}
public static class LiveViewZoomPosition extends SetPropertyCommand {
public LiveViewZoomPosition( final EdsPoint value ) {
super( EdsPropertyID.kEdsPropID_Evf_ZoomPosition, value );
}
public LiveViewZoomPosition( final long x, final long y ) {
super( EdsPropertyID.kEdsPropID_Evf_ZoomPosition, new EdsPoint( new NativeLong( x ), new NativeLong( y ) ) );
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy