Small fixes and lots of comments

This commit is contained in:
Sean Davis 2013-07-15 22:57:35 -04:00
parent 1f95800db7
commit a418fb39b2
1 changed files with 107 additions and 75 deletions

View File

@ -30,12 +30,13 @@ class CameraMugshotDialog(CameraDialog):
__gtype_name__ = "CameraMugshotDialog"
def finish_initializing(self, builder): # pylint: disable=E1002
"""Set up the preferences dialog"""
"""Set up the camera dialog"""
super(CameraMugshotDialog, self).finish_initializing(builder)
# Initialize Gst or nothing will work.
Gst.init(None)
# Code for other initialization actions should be added here.
# Pack the video widget into the dialog.
vbox = builder.get_object('camera_box')
self.video_window = Gtk.DrawingArea()
self.draw_handler = self.video_window.connect('draw', self.on_draw)
@ -43,6 +44,7 @@ class CameraMugshotDialog(CameraDialog):
vbox.pack_start(self.video_window, True, True, 0)
self.video_window.show()
# Prepare the camerabin element.
self.camerabin = Gst.ElementFactory.make("camerabin", "camera-source")
bus = self.camerabin.get_bus()
bus.add_signal_watch()
@ -51,41 +53,51 @@ class CameraMugshotDialog(CameraDialog):
bus.connect("sync-message::element", self._on_sync_message)
self.realized = False
# Essential widgets
self.record_button = builder.get_object('camera_record')
self.apply_button = builder.get_object('camera_apply')
self.show_all()
# Store the temporary filename to be used.
self.filename = None
self.show_all()
def on_draw(self, widget, ctx):
"""Display a message that the camera is initializing on first draw.
Afterwards, blank the drawing area to clear the message."""
# Get the height and width of the drawing area.
alloc = widget.get_allocation()
height = alloc.height
width = alloc.width
font_size = 20
ctx.set_source_rgb(255,255,255)
ctx.select_font_face("Sans", cairo.FONT_SLANT_NORMAL,
cairo.FONT_WEIGHT_NORMAL)
ctx.set_font_size(20)
ctx.move_to(10,(height-font_size)/2)
ctx.show_text(_("Please wait while your"))
ctx.move_to(10,(height-font_size)/2+20)
ctx.show_text(_("camera is initialized."))
widget.disconnect(self.draw_handler)
self.draw_handler = widget.connect('draw', self.on_blank)
def on_blank(self, widget, ctx):
ctx.set_source_rgb(0,0,0)
ctx.paint()
# Set the font details.
font_size = 20
font_color = (255,255,255)
font_name = "Sans"
# Draw the message to the drawing area.
ctx.set_source_rgb(*font_color)
ctx.select_font_face(font_name, cairo.FONT_SLANT_NORMAL,
cairo.FONT_WEIGHT_NORMAL)
ctx.set_font_size(font_size)
ctx.move_to(10,(height-font_size)/2)
# Translators: This string is split for use with cairo. The complete string is "Please wait while your camera is initialized."
ctx.show_text(_("Please wait while your"))
ctx.move_to(10,(height-font_size)/2+font_size)
# Translators: This string is split for use with cairo. The complete string is "Please wait while your camera is initialized."
ctx.show_text(_("camera is initialized."))
# Redefine on_draw to blank the drawing area next time.
def on_draw(self, widget, ctx):
ctx.set_source_rgb(0,0,0)
ctx.paint()
# Redefine on_draw once more to do nothing else.
def on_draw(self, widget, ctx):
pass
def play(self):
"""play - Start the camera streaming and display the output. It is
necessary to start the camera playing before using most other functions.
This function has no arguments
"""
"""Start the camera streaming and display the output. It is necessary
to start the camera playing before using most other functions."""
if not self.realized:
self._set_video_window_id()
if not self.realized:
@ -94,175 +106,195 @@ class CameraMugshotDialog(CameraDialog):
self.camerabin.set_state(Gst.State.PLAYING)
def pause(self):
"""pause - Pause the camera output. It will cause the image to
"freeze". Use play() to start the camera playng again. Note that
calling pause before play may cause errors on certain camera.
This function has no arguments
"""
"""Pause the camera output. It will cause the image to "freeze".
Use play() to start the camera playing again. Note that calling pause
before play may cause errors on certain camera."""
self.camerabin.set_state(Gst.State.PAUSED)
def take_picture(self, filename):
"""take_picture - grab a frame from the web cam and save it to
~/Pictures/datestamp.png, where datestamp is the current datestamp.
It's possible to add a prefix to the datestamp by setting the
filename_prefix property.
"""take_picture - grab a frame from the webcam and save it to
'filename.
If play is not called before take_picture,
an error may occur. If take_picture is called immediately after play,
the camera may not be fully initialized, and an error may occur.
Connect to the signal "image-captured" to be alerted when the picture
is saved.
This function has no arguments
returns - a string of the filename used to save the image
"""
is saved."""
self.camerabin.set_property("location", filename)
self.camerabin.emit("start-capture")
#self.pause()
return filename
def stop(self):
"""stop - Stop the camera streaming and display the output.
This function has no arguments
"""
"""Stop the camera streaming and display the output."""
self.camerabin.set_state(Gst.State.NULL)
def _on_message(self, bus, message):
""" _on_message - internal signal handler for bus messages.
"""Internal signal handler for bus messages.
May be useful to extend in a base class to handle messages
produced from custom behaviors.
arguments -
bus: the bus from which the message was sent, typically self.bux
message: the message sent
"""
message: the message sent"""
# Ignore if there is no message.
if message is None:
return
# Get the message type.
t = message.type
# Initial load, wait until camera is ready before enabling capture.
if t == Gst.MessageType.ASYNC_DONE:
self.record_button.set_sensitive(True)
if t == Gst.MessageType.ELEMENT:
# Keep the camera working after several pictures are taken.
if message.get_structure().get_name() == "image-captured":
#work around to keep the camera working after lots
#of pictures are taken
self.camerabin.set_state(Gst.Sate.NULL)
self.camerabin.set_state(Gst.State.PLAYING)
self.emit("image-captured", self.filename)
# Enable interface elements once the images are finished saving.
elif message.get_structure().get_name() == "image-done":
self.apply_button.set_sensitive(True)
self.record_button.set_sensitive(True)
self.pause()
# Stop the stream if the EOS (end of stream) message is received.
if t == Gst.MessageType.EOS:
self.camerabin.set_state(Gst.State.NULL)
# Capture and report any error received.
elif t == Gst.MessageType.ERROR:
err, debug = message.parse_error()
print "Error: %s" % err, debug
logger.error("%s" % err, debug)
def _on_sync_message(self, bus, message):
""" _on_sync_message - internal signal handler for bus messages.
May be useful to extend in a base class to handle messages
produced from custom behaviors.
arguments -
bus: the bus from which the message was sent, typically self.bux
message: the message sent
"""
# Ignore empty messages.
if message.get_structure() is None:
return
message_name = message.get_structure().get_name()
# Embed the gstreamer element into our window.
if message_name == "prepare-window-handle":
imagesink = message.src
imagesink.set_property("force-aspect-ratio", True)
imagesink.set_window_handle(self.video_window.get_window().get_xid())
def __on_video_window_realized(self, widget, data=None):
"""__on_video_window_realized - internal signal handler, used
to set up the xid for the drawing area in thread safe manner.
Do not call directly.
"""
"""Internal signal handler, used to set up the xid for the drawing area
in a thread safe manner. Do not call directly."""
self._set_video_window_id()
def _set_video_window_id(self):
"""Set the window ID only if not previously configured."""
if not self.realized and self.video_window.get_window() is not None:
x = self.video_window.get_window().get_xid()
self.realized = True
def on_camera_record_clicked(self, widget):
if self.filename: os.remove(self.filename)
"""When the camera record/retry button is clicked:
Record: Pause the video, start the capture, enable apply and retry.
Retry: Restart the video stream."""
# Remove any previous temporary file.
if self.filename and os.path.isfile(self.filename):
os.remove(self.filename)
# Retry action.
if self.apply_button.get_sensitive():
# Retry mode
self.record_button.set_label(Gtk.STOCK_MEDIA_RECORD)
self.apply_button.set_sensitive(False)
self.play()
# Record (Capture) action.
else:
# Create a new temporary file.
tmpfile = tempfile.NamedTemporaryFile(delete=False)
tmpfile.close()
self.filename = tmpfile.name
# Capture the current image.
self.take_picture(self.filename)
# Set the record button to retry, and disable it until the capture
# finishes.
self.record_button.set_label(_("Retry"))
self.record_button.set_sensitive(False)
#self.apply_button.set_sensitive(True)
def on_camera_apply_clicked(self, widget):
"""When the camera Apply button is clicked, crop the current photo and
emit a signal to let the main application know there is a new file
available. Then close the camera dialog."""
self.center_crop(self.filename)
self.emit( "apply", self.filename )
self.emit("apply", self.filename)
self.hide()
def on_camera_cancel_clicked(self, widget):
"""When the Cancel button is clicked, just hide the dialog."""
self.hide()
def on_camera_mugshot_dialog_destroy(self, widget, data=None):
"""When the application exits, remove the current temporary file and
stop the gstreamer element."""
# Clear away the temp file.
os.remove(self.filename)
#clean up the camera before exiting
if self.filename and os.path.isfile(self.filename):
os.remove(self.filename)
# Clean up the camera before exiting
self.camerabin.set_state(Gst.State.NULL)
def on_camera_mugshot_dialog_hide(self, widget, data=None):
"""When the dialog is hidden, pause the camera recording."""
self.pause()
def on_camera_mugshot_dialog_show(self, widget, data=None):
"""When the dialog is shown, set the record button to record, disable
the apply button, and start the camera."""
self.record_button.set_label(Gtk.STOCK_MEDIA_RECORD)
self.apply_button.set_sensitive(False)
self.show_all()
self.play()
def center_crop(self, filename):
"""Crop the specified file to square dimensions."""
# Load the image into a Pixbuf.
pixbuf = GdkPixbuf.Pixbuf.new_from_file(filename)
# Get the image dimensions.
height = pixbuf.get_height()
width = pixbuf.get_width()
start_x = 0
start_y = 0
# Calculate a balanced center.
if width > height:
start_x = (width-height)/2
width = height
else:
start_y = (height-width)/2
height = width
# Create a new cropped pixbuf.
new_pixbuf = pixbuf.new_subpixbuf(start_x, start_y, width, height)
# Overwrite the temporary file with our new cropped image.
new_pixbuf.savev(filename, "png", [], [])
def on_camera_mugshot_dialog_delete_event(self, widget, data=None):
"""Override the dialog delete event to just hide the window."""
self.hide()
return True
# Signals used by CameraMugshotDialog:
# image-captured: emitted when the camera is done capturing an image.
# apply: emitted when the apply button has been pressed and there is a new file saved for use.
__gsignals__ = {'image-captured' : (GObject.SIGNAL_RUN_LAST, GObject.TYPE_NONE,
(GObject.TYPE_PYOBJECT,)),
'apply' : (GObject.SIGNAL_RUN_LAST, GObject.TYPE_NONE, (GObject.TYPE_STRING,))