/usr/lib/python2.7/dist-packages/gphoto2cffi/gphoto2.py is in python-gphoto2cffi 0.3~a1-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 | from __future__ import unicode_literals, division, absolute_import
import functools
import itertools
import logging
import math
import os
import re
import string
import sys
import time
from collections import namedtuple
from datetime import datetime
from . import errors, backend
from .backend import ffi, lib
from .util import SimpleNamespace, get_string, get_ctype, new_gp_object
if sys.version_info > (3,):
basestring = str
def get_library_version():
""" Get the version number of the underlying gphoto2 library.
:return: The version
:rtype: tuple of (major, minor, patch) version numbers
"""
version_str = ffi.string(lib.gp_library_version(True)[0]).decode()
return tuple(int(x) for x in version_str.split('.'))
def list_cameras():
""" List all attached USB cameras that are supported by libgphoto2.
:return: All recognized cameras
:rtype: list of :py:class:`Camera`
"""
ctx = lib.gp_context_new()
camlist_p = new_gp_object("CameraList")
port_list_p = new_gp_object("GPPortInfoList")
lib.gp_port_info_list_load(port_list_p)
abilities_list_p = new_gp_object("CameraAbilitiesList")
lib.gp_abilities_list_load(abilities_list_p, ctx)
lib.gp_abilities_list_detect(abilities_list_p, port_list_p,
camlist_p, ctx)
out = []
for idx in range(lib.gp_list_count(camlist_p)):
name = get_string(lib.gp_list_get_name, camlist_p, idx)
value = get_string(lib.gp_list_get_value, camlist_p, idx)
bus_no, device_no = (int(x) for x in
re.match(r"usb:(\d+),(\d+)", value).groups())
abilities = ffi.new("CameraAbilities*")
ability_idx = lib.gp_abilities_list_lookup_model(
abilities_list_p, name.encode())
lib.gp_abilities_list_get_abilities(abilities_list_p, ability_idx,
abilities)
if abilities.device_type == lib.GP_DEVICE_STILL_CAMERA:
out.append(Camera(bus_no, device_no, lazy=True,
_abilities=abilities))
lib.gp_list_free(camlist_p)
lib.gp_port_info_list_free(port_list_p)
lib.gp_abilities_list_free(abilities_list_p)
return out
def supported_cameras():
""" List the names of all cameras supported by libgphoto2, grouped by the
name of their driver.
"""
ctx = lib.gp_context_new()
abilities_list_p = new_gp_object("CameraAbilitiesList")
lib.gp_abilities_list_load(abilities_list_p, ctx)
abilities = ffi.new("CameraAbilities*")
out = []
for idx in range(lib.gp_abilities_list_count(abilities_list_p)):
lib.gp_abilities_list_get_abilities(abilities_list_p, idx, abilities)
if abilities.device_type == lib.GP_DEVICE_STILL_CAMERA:
libname = os.path.basename(ffi.string(abilities.library)
.decode())
out.append((ffi.string(abilities.model).decode(), libname))
lib.gp_abilities_list_free(abilities_list_p)
key_func = lambda name, driver: driver
out = sorted(out, key=key_func)
return {k: tuple(x[0] for x in v)
for k, v in itertools.groupby(out, key_func)}
return out
def exit_after(meth=None, cam_struc=None):
if meth is None:
return functools.partial(exit_after, cam_struc=cam_struc)
@functools.wraps(meth)
def wrapped(self, *args, **kwargs):
if not isinstance(self, Camera):
cam, ctx = self._cam._cam, self._cam._ctx
else:
cam, ctx = self._cam, self._ctx
rval = meth(self, *args, **kwargs)
lib.gp_camera_exit(cam, ctx)
return rval
return wrapped
class Range(namedtuple("Range", ('min', 'max', 'step'))):
""" Specifies a range of values (:py:attr:`max`, :py:attr:`min`,
:py:attr:`step`)
"""
pass
class ImageDimensions(namedtuple("ImageDimensions", ('width', 'height'))):
""" Describes the dimension of an image (:py:attr:`width`,
:py:attr:`height`)
"""
pass
class UsbInformation(namedtuple(
"UsbInformation", ('vendor', 'product', 'devclass', 'subclass',
'protocol'))):
""" Information about a USB device. (:py:attr:`vendor`,
:py:attr:`product`, :py:attr:`devclass`, :py:attr:`subclass`)
"""
pass
class VideoCaptureContext(object):
""" Context object that allows the stopping of a video capture via the
:py:meth:`start` method.
Can also be used as a context manager, where the capture will be stopped
upon leaving. Get the resulting videofile by accessing the
:py:attr:`videofile` attribute.
"""
def __init__(self, camera):
#: Camera the capture is running on
self.camera = camera
#: Resulting video :py:class:`File`, only available after stopping
#: the capture
self.videofile = None
target = self.camera.config['settings']['capturetarget']
self._old_captarget = target.value
if self._old_captarget != "Memory card":
target.set("Memory card")
self.camera._get_config()['actions']['movie'].set(True)
def stop(self):
""" Stop the capture. """
self.camera._get_config()['actions']['movie'].set(False)
self.videofile = self.camera._wait_for_event(
event_type=lib.GP_EVENT_FILE_ADDED)
if self._old_captarget != "Memory card":
self.camera.config['settings']['capturetarget'].set(
self._old_captarget)
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
if self.videofile is None:
self.stop()
lib.gp_camera_exit(self.camera._cam, self.camera._ctx)
class Directory(object):
""" A directory on the camera. """
def __init__(self, name, parent, camera):
self.name = name
self.parent = parent
self._file_ops = camera._abilities.file_operations
self._dir_ops = camera._abilities.folder_operations
self._cam = camera
@property
def path(self):
""" Absolute path to the directory on the camera's filesystem. """
if self.parent is None:
return "/"
else:
return os.path.join(self.parent.path, self.name)
@property
def supported_operations(self):
""" All directory operations supported by the camera. """
return tuple(op for op in backend.DIR_OPS if self._dir_ops & op)
@property
def exists(self):
""" Check whether the directory exists on the camera. """
if self.name in ("", "/") and self.parent is None:
return True
else:
return self in self.parent.directories
@property
@exit_after
def files(self):
""" Get a generator that yields all files in the directory. """
filelist_p = new_gp_object("CameraList")
lib.gp_camera_folder_list_files(self._cam._cam, self.path.encode(),
filelist_p, self._cam._ctx)
for idx in range(lib.gp_list_count(filelist_p)):
fname = get_string(lib.gp_list_get_name, filelist_p, idx)
yield File(name=fname, directory=self, camera=self._cam)
lib.gp_list_free(filelist_p)
@property
@exit_after
def directories(self):
""" Get a generator that yields all subdirectories in the directory.
"""
dirlist_p = new_gp_object("CameraList")
lib.gp_camera_folder_list_folders(self._cam._cam, self.path.encode(),
dirlist_p, self._cam._ctx)
for idx in range(lib.gp_list_count(dirlist_p)):
name = os.path.join(
self.path, get_string(lib.gp_list_get_name, dirlist_p, idx))
yield Directory(name=name, parent=self, camera=self._cam)
lib.gp_list_free(dirlist_p)
@exit_after
def create(self):
""" Create the directory. """
lib.gp_camera_folder_make_dir(
self._cam._cam, self.parent.path.encode(), self.name.encode(),
self._cam._ctx)
@exit_after
def remove(self):
""" Remove the directory. """
lib.gp_camera_folder_remove_dir(
self._cam._cam, self.parent.path.encode(), self.name.encode(),
self._cam._ctx)
@exit_after
def upload(self, local_path):
""" Upload a file to the camera's permanent storage.
:param local_path: Path to file to copy
:type local_path: str/unicode
"""
camerafile_p = ffi.new("CameraFile**")
with open(local_path, 'rb') as fp:
lib.gp_file_new_from_fd(camerafile_p, fp.fileno())
lib.gp_camera_folder_put_file(
self._cam._cam, self.path.encode() + b"/",
os.path.basename(local_path).encode(),
backend.FILE_TYPES['normal'], camerafile_p[0],
self._cam.ctx)
def __eq__(self, other):
return (self.name == other.name and
self.parent == other.parent and
self._cam == other._cam)
def __repr__(self):
return "Directory(\"{0}\")".format(self.path)
class File(object):
""" A file on the camera. """
def __init__(self, name, directory, camera):
self.name = name
self.directory = directory
self._cam = camera
self._operations = camera._abilities.file_operations
self.__info = None
@property
def supported_operations(self):
""" All file operations supported by the camera. """
return tuple(op for op in backend.FILE_OPS if self._operations & op)
@property
def size(self):
""" File size in bytes.
:rtype: int
"""
return int(self._info.file.size)
@property
def mimetype(self):
""" MIME type of the file.
:rtype: str
"""
return ffi.string(self._info.file.type).decode()
@property
def dimensions(self):
""" Dimensions of the image.
:rtype: :py:class:`ImageDimensions`
"""
return ImageDimensions(self._info.file.width, self._info.file.height)
@property
def permissions(self):
""" Permissions of the file.
Can be "r-" (read-only), "-w" (write-only), "rw" (read-write)
or "--" (no rights).
:rtype: str
"""
can_read = self._info.file.permissions & lib.GP_FILE_PERM_READ
can_write = self._info.file.permissions & lib.GP_FILE_PERM_DELETE
return "{0}{1}".format("r" if can_read else "-",
"w" if can_write else "-")
@property
def last_modified(self):
""" Date of last modification.
:rtype: :py:class:`datetime.datetime`
"""
return datetime.fromtimestamp(self._info.file.mtime)
@exit_after
def save(self, target_path, ftype='normal'):
""" Save file content to a local file.
:param target_path: Path to save remote file as.
:type target_path: str/unicode
:param ftype: Select 'view' on file.
:type ftype: str
"""
camfile_p = ffi.new("CameraFile**")
with open(target_path, 'wb') as fp:
lib.gp_file_new_from_fd(camfile_p, fp.fileno())
lib.gp_camera_file_get(
self._cam._cam, self.directory.path.encode(),
self.name.encode(), backend.FILE_TYPES[ftype], camfile_p[0],
self._cam._ctx)
@exit_after
def get_data(self, ftype='normal'):
""" Get file content as a bytestring.
:param ftype: Select 'view' on file.
:type ftype: str
:return: File content
:rtype: bytes
"""
camfile_p = ffi.new("CameraFile**")
lib.gp_file_new(camfile_p)
lib.gp_camera_file_get(
self._cam._cam, self.directory.path.encode(), self.name.encode(),
backend.FILE_TYPES[ftype], camfile_p[0], self._cam._ctx)
data_p = ffi.new("char**")
length_p = ffi.new("unsigned long*")
lib.gp_file_get_data_and_size(camfile_p[0], data_p, length_p)
return ffi.buffer(data_p[0], length_p[0])[:]
@exit_after
def iter_data(self, chunk_size=2**16, ftype='normal'):
""" Get an iterator that yields chunks of the file content.
:param chunk_size: Size of yielded chunks in bytes
:type chunk_size: int
:param ftype: Select 'view' on file.
:type ftype: str
:return: Iterator
"""
self._check_type_supported(ftype)
buf_p = ffi.new("char[{0}]".format(chunk_size))
size_p = ffi.new("uint64_t*")
offset_p = ffi.new("uint64_t*")
for chunk_idx in range(int(math.ceil(self.size/chunk_size))):
size_p[0] = chunk_size
lib.gp_camera_file_read(
self._cam._cam, self.directory.path.encode(),
self.name.encode(), backend.FILE_TYPES[ftype], offset_p[0],
buf_p, size_p, self._cam._ctx)
yield ffi.buffer(buf_p, size_p[0])[:]
@exit_after
def remove(self):
""" Remove file from device. """
lib.gp_camera_file_delete(self._cam._cam, self.directory.path.encode(),
self.name.encode(), self._cam._ctx)
@property
def _info(self):
if self.__info is None:
self.__info = ffi.new("CameraFileInfo*")
try:
lib.gp_camera_file_get_info(
self._cam._cam, self.directory.path.encode(),
self.name.encode(), self.__info, self._cam._ctx)
lib.gp_camera_exit(self._cam._cam, self._cam._ctx)
except errors.GPhoto2Error:
raise ValueError("Could not get file info, are you sure the "
"file exists on the device?")
return self.__info
def __eq__(self, other):
return (self.name == other.name and
self.directory == other.directory and
self._cam == other._cam)
def __repr__(self):
return "File(\"{0}/{1}\")".format(self.directory.path.rstrip("/"),
self.name)
class ConfigItem(object):
""" A configuration option on the device. """
def __init__(self, widget, camera):
self._widget = widget
root_p = ffi.new("CameraWidget**")
lib.gp_widget_get_root(self._widget, root_p)
self._root = root_p[0]
self._cam = camera
#: Short name
self.name = get_string(lib.gp_widget_get_name, widget)
typenum = get_ctype("CameraWidgetType*", lib.gp_widget_get_type,
widget)
#: Type of option, can be one of `selection`, `text`, `range`,
#: `toggle` or `date`.
self.type = backend.WIDGET_TYPES[typenum]
#: Human-readable label
self.label = get_string(lib.gp_widget_get_label, widget)
#: Information about the widget
self.info = get_string(lib.gp_widget_get_info, widget)
#: Current value
self.value = None
value_fn = lib.gp_widget_get_value
if self.type in ('selection', 'text'):
self.value = get_string(value_fn, widget)
elif self.type == 'range':
self.value = get_ctype("float*", value_fn, widget)
#: Valid range for value, only present when :py:attr:`type` is
#: `range`.
self.range = self._read_range()
elif self.type in ('toggle', 'date'):
val = get_ctype("int*", value_fn, widget)
if self.type == 'date':
self.value = val
else:
self.value = None if val == 2 else bool(val)
else:
raise ValueError("Unsupported widget type for ConfigItem: {0}"
.format(self.type))
if self.type == 'selection':
#: Valid choices for value, only present when :py:attr:`type`
#: is `selection`.
self.choices = self._read_choices()
#: Whether the value can be written to or not
self.readonly = bool(get_ctype(
"int*", lib.gp_widget_get_readonly, widget))
@exit_after
def set(self, value):
""" Update value of the option.
Only possible for options with :py:attr:`readonly` set to `False`.
If :py:attr:`type` is `choice`, the value must be one of the
:py:attr:`choices`.
If :py:attr:`type` is `range`, the value must be in the range
described by :py:attr:`range`.
:param value: Value to set
"""
if self.readonly:
raise ValueError("Option is read-only.")
val_p = None
if self.type == 'selection':
if value not in self.choices:
raise ValueError("Invalid choice (valid: {0})".format(
repr(self.choices)))
val_p = ffi.new("const char[]", value.encode())
elif self.type == 'text':
if not isinstance(value, basestring):
raise ValueError("Value must be a string.")
val_p = ffi.new("char**")
val_p[0] = ffi.new("char[]", value.encode())
elif self.type == 'range':
if value < self.range.min or value > self.range.max:
raise ValueError("Value exceeds valid range ({0}-{1}."
.format(self.range.min, self.range.max))
if value % self.range.step:
raise ValueError("Value can only be changed in steps of {0}."
.format(self.range.step))
val_p = ffi.new("float*")
val_p[0] = value
elif self.type == 'toggle':
if not isinstance(value, bool):
raise ValueError("Value must be bool.")
val_p = ffi.new("int*")
val_p[0] = int(value)
elif self.type == 'date':
val_p = ffi.new("int*")
val_p[0] = value
lib.gp_widget_set_value(self._widget, val_p)
lib.gp_camera_set_config(self._cam._cam, self._root, self._cam._ctx)
def _read_choices(self):
if self.type != 'selection':
raise ValueError("Can only read choices for items of type "
"'selection'.")
choices = []
for idx in range(lib.gp_widget_count_choices(self._widget)):
choices.append(get_string(lib.gp_widget_get_choice, self._widget,
idx))
return choices
def _read_range(self):
rmin = ffi.new("float*")
rmax = ffi.new("float*")
rinc = ffi.new("float*")
lib.gp_widget_get_range(self._widget, rmin, rmax, rinc)
return Range(rmin[0], rmax[0], rinc[0])
def __repr__(self):
return ("ConfigItem('{0}', {1}, {2}, r{3})"
.format(self.label, self.type, repr(self.value),
"o" if self.readonly else "w"))
class Camera(object):
""" A camera device.
The specific device can be auto-detected or set manually by
specifying the USB bus and device number.
:param bus: USB bus number
:param device: USB device number
:param lazy: Only initialize the device when needed
"""
def __init__(self, bus=None, device=None, lazy=False, _abilities=None):
self._logger = logging.getLogger()
# NOTE: It is not strictly neccessary to create a context for every
# device, however it is significantly (>500ms) faster when
# actions are to be performed simultaneously.
self._ctx = lib.gp_context_new()
self._usb_address = (bus, device)
self.__abilities = _abilities
self.__cam = None
if not lazy:
# Trigger the property
self._cam
@property
def supported_operations(self):
""" All operations supported by the camera. """
return tuple(op for op in backend.CAM_OPS
if self._abilities.operations & op)
@property
def usb_info(self):
""" The camera's USB information. """
return UsbInformation(self._abilities.usb_vendor,
self._abilities.usb_product,
self._abilities.usb_class,
self._abilities.usb_subclass,
self._abilities.usb_protocol)
@property
def model_name(self):
""" Camera model name as specified in the gphoto2 driver. """
return ffi.string(self._abilities.model).decode()
@property
def config(self):
""" Writeable configuration parameters.
:rtype: dict
"""
config = self._get_config()
return {section: {itm.name: itm for itm in config[section].values()
if not itm.readonly}
for section in config
if 'settings' in section or section == 'other'}
@property
def status(self):
""" Status information (read-only).
:rtype: :py:class:`SimpleNamespace`
"""
config = self._get_config()
is_hex = lambda name: (len(name) == 4 and
all(c in string.hexdigits for c in name))
out = SimpleNamespace()
for sect in config:
for itm in config[sect].values():
if (itm.readonly or sect == 'status') and not is_hex(itm.name):
setattr(out, itm.name, itm.value)
return out
@property
def filesystem(self):
""" The camera's root directory. """
return Directory(name="/", parent=None, camera=self)
@property
@exit_after
def storage_info(self):
""" Information about the camera's storage. """
info_p = ffi.new("CameraStorageInformation**")
num_info_p = ffi.new("int*")
lib.gp_camera_get_storageinfo(self._cam, info_p, num_info_p, self._ctx)
infos = []
for idx in range(num_info_p[0]):
out = SimpleNamespace()
struc = (info_p[0] + idx)
fields = struc.fields
if lib.GP_STORAGEINFO_BASE & fields:
out.directory = next(
(d for d in self.list_all_directories()
if d.path == ffi.string(struc.basedir).decode()),
None)
if lib.GP_STORAGEINFO_LABEL & fields:
out.label = ffi.string(struc.label).decode()
if lib.GP_STORAGEINFO_DESCRIPTION & fields:
out.description = ffi.string(struc.description).decode()
if lib.GP_STORAGEINFO_STORAGETYPE & fields:
stype = struc.type
if lib.GP_STORAGEINFO_ST_FIXED_ROM & stype:
out.type = 'fixed_rom'
elif lib.GP_STORAGEINFO_ST_REMOVABLE_ROM & stype:
out.type = 'removable_rom'
elif lib.GP_STORAGEINFO_ST_FIXED_RAM & stype:
out.type = 'fixed_ram'
elif lib.GP_STORAGEINFO_ST_REMOVABLE_RAM & stype:
out.type = 'removable_ram'
else:
out.type = 'unknown'
if lib.GP_STORAGEINFO_ACCESS & fields:
if lib.GP_STORAGEINFO_AC_READWRITE & struc.access:
out.access = 'read-write'
elif lib.GP_STORAGEINFO_AC_READONLY & struc.access:
out.access = 'read-only'
elif lib.GP_STORAGEINFO_AC_READONLY_WITH_DELETE & struc.access:
out.access = 'read-delete'
if lib.GP_STORAGEINFO_MAXCAPACITY & fields:
out.capacity = int(struc.capacitykbytes)
if lib.GP_STORAGEINFO_FREESPACEKBYTES & fields:
out.free_space = int(struc.freekbytes)
if lib.GP_STORAGEINFO_FREESPACEIMAGES & fields:
out.remaining_images = int(struc.freeimages)
infos.append(out)
return infos
def list_all_files(self):
""" Utility method that yields all files on the device's file
systems.
"""
def list_files_recursively(directory):
f_gen = itertools.chain(
directory.files,
*tuple(list_files_recursively(d)
for d in directory.directories))
for f in f_gen:
yield f
return list_files_recursively(self.filesystem)
def list_all_directories(self):
""" Utility method that yields all directories on the device's file
systems.
"""
def list_dirs_recursively(directory):
if directory == self.filesystem:
yield directory
d_gen = itertools.chain(
directory.directories,
*tuple(list_dirs_recursively(d)
for d in directory.directories))
for d in d_gen:
yield d
return list_dirs_recursively(self.filesystem)
@exit_after
def capture(self, to_camera_storage=False):
""" Capture an image.
Some cameras (mostly Canon and Nikon) support capturing to internal
RAM. On these devices, you have to specify `to_camera_storage` if
you want to save the images to the memory card. On devices that
do not support saving to RAM, the only difference is that the file
is automatically downloaded and deleted when set to `False`.
:param to_camera_storage: Save image to the camera's internal storage
:type to_camera_storage: bool
:return: A :py:class:`File` if `to_camera_storage` was `True`,
otherwise the captured image as a bytestring.
:rtype: :py:class:`File` or bytes
"""
target = self.config['settings']['capturetarget']
if to_camera_storage and target.value != "Memory card":
target.set("Memory card")
elif not to_camera_storage and target.value != "Internal RAM":
target.set("Internal RAM")
lib.gp_camera_trigger_capture(self._cam, self._ctx)
fobj = self._wait_for_event(event_type=lib.GP_EVENT_FILE_ADDED)
if to_camera_storage:
self._logger.info("File written to storage at {0}.".format(fobj))
return fobj
else:
data = fobj.get_data()
try:
fobj.remove()
except errors.CameraIOError:
# That probably means the file is already gone from RAM,
# so nothing to worry about.
pass
return data
def capture_video_context(self):
""" Get a :py:class:`VideoCaptureContext` object.
This allows the user to control when to stop the video capture.
:rtype: :py:class:`VideoCaptureContext`
"""
return VideoCaptureContext(self)
@exit_after
def capture_video(self, length):
""" Capture a video.
This always writes to the memory card, since internal RAM is likely
to run out of space very quickly.
Currently this only works with Nikon cameras.
:param length: Length of the video to capture in seconds.
:type length: int
:return: Video file
:rtype: :py:class:`File`
"""
with self.capture_video_context() as ctx:
time.sleep(length)
return ctx.videofile
@exit_after
def get_preview(self):
""" Get a preview from the camera's viewport.
This will usually be a JPEG image with the dimensions depending on
the camera.
:return: The preview image as a bytestring
:rtype: bytes
"""
camfile_p = ffi.new("CameraFile**")
lib.gp_file_new(camfile_p)
lib.gp_camera_capture_preview(self._cam, camfile_p[0], self._ctx)
data_p = ffi.new("char**")
length_p = ffi.new("unsigned long*")
lib.gp_file_get_data_and_size(camfile_p[0], data_p, length_p)
return ffi.buffer(data_p[0], length_p[0])[:]
@property
def _cam(self):
if self.__cam is None:
self.__cam = new_gp_object("Camera")
if self._usb_address != (None, None):
port_name = ("usb:{0:03},{1:03}".format(*self._usb_address)
.encode())
port_list_p = new_gp_object("GPPortInfoList")
lib.gp_port_info_list_load(port_list_p)
port_info_p = ffi.new("GPPortInfo*")
lib.gp_port_info_new(port_info_p)
port_num = lib.gp_port_info_list_lookup_path(
port_list_p, port_name)
lib.gp_port_info_list_get_info(port_list_p, port_num,
port_info_p)
lib.gp_camera_set_port_info(self.__cam, port_info_p[0])
lib.gp_camera_init(self.__cam, self._ctx)
else:
try:
lib.gp_camera_init(self.__cam, self._ctx)
except errors.UnsupportedDevice as e:
raise errors.UnsupportedDevice(
e.error_code, "Could not find any supported devices.")
return self.__cam
@property
def _abilities(self):
if self.__abilities is None:
self.__abilities = ffi.new("CameraAbilities*")
lib.gp_camera_get_abilities(self._cam, self.__abilities)
return self.__abilities
def _wait_for_event(self, event_type=None, duration=0):
if event_type is None and not duration:
raise ValueError("Please specifiy either `event_type` or "
"`duration!`")
start_time = time.time()
event_type_p = ffi.new("CameraEventType*")
event_data_p = ffi.new("void**", ffi.NULL)
while True:
lib.gp_camera_wait_for_event(self._cam, 1000, event_type_p,
event_data_p, self._ctx)
if event_type_p[0] == lib.GP_EVENT_CAPTURE_COMPLETE:
self._logger.info("Capture completed.")
elif event_type_p[0] == lib.GP_EVENT_FILE_ADDED:
self._logger.info("File added.")
elif event_type_p[0] == lib.GP_EVENT_TIMEOUT:
self._logger.debug("Timeout while waiting for event.")
continue
do_break = (event_type_p[0] == event_type or
((time.time() - start_time > duration)
if duration else False))
if do_break:
break
if event_type == lib.GP_EVENT_FILE_ADDED:
camfile_p = ffi.cast("CameraFilePath*", event_data_p[0])
dirname = ffi.string(camfile_p[0].folder).decode()
directory = next(f for f in self.list_all_directories()
if f.path == dirname)
return File(name=ffi.string(camfile_p[0].name).decode(),
directory=directory, camera=self)
@exit_after
def _get_config(self):
def _widget_to_dict(cwidget):
out = {}
for idx in range(lib.gp_widget_count_children(cwidget)):
child_p = ffi.new("CameraWidget**")
lib.gp_widget_get_child(cwidget, idx, child_p)
key = get_string(lib.gp_widget_get_name, child_p[0])
typenum = get_ctype("CameraWidgetType*",
lib.gp_widget_get_type, child_p[0])
if typenum in (lib.GP_WIDGET_WINDOW, lib.GP_WIDGET_SECTION):
out[key] = _widget_to_dict(child_p[0])
else:
item = ConfigItem(child_p[0], self)
out[key] = item
return out
root_widget = ffi.new("CameraWidget**")
lib.gp_camera_get_config(self._cam, root_widget, self._ctx)
return _widget_to_dict(root_widget[0])
def __repr__(self):
return "<Camera \"{0}\" at usb:{1:03}:{2:03}>".format(
self.model_name, *self._usb_address)
def __del__(self):
if self.__cam is not None:
lib.gp_camera_exit(self.__cam, self._ctx)
lib.gp_camera_free(self.__cam)
|