KinoCommon Class Reference

This class is the main GUI class. More...

#include <kino_common.h>

Collaboration diagram for KinoCommon:

[legend]List of all members.

Public Member Functions
	KinoCommon (GtkWidget *widget)
	Constructor for KinoCommon - initialises all GUI widgets.
	~KinoCommon ()
	Destructor for the kino common object.
GtkWidget *	getWidget ()
PlayList *	getPlayList ()
int	getCurrentScene ()
bool	newFile (bool prompt=true)
	Carries out a New File request in the kino application.
void	bulkLoad (int, char *[])
	Loads all files specified in the command line style arguments.
std::string	importFile (const char *filename)
	Give option to import a file by transcoding to DV.
void	insertFile ()
	Inserts a file at the current position.
void	appendFile ()
	Appends a file after the current position.
void	loadFile ()
	Opens a file.
bool	savePlayListAs ()
	Save the current play list with a different name to the original loaded (or previously saved as) play list file name.
bool	savePlayList ()
	Save the current play list to the file used to load the playlist originally.
void	saveFrame ()
	Save the current frame as a still frame.
void	publishPlayList ()
void	publishFrame ()
void	loadPlayList (char *)
void	changePageRequest (int page)
	Sends change page request to the gui.
void	setCurrentPage (int page)
	Carries out a change page - this should be triggered by changePageRequest to ensure that the GUI stays in sync with the common structure.
Page *	getCurrentPage ()
	Returns the current Page object.
Page *	getPage (int page)
	Returns the Page object associated to the specified notebook page.
void	activateWidgets ()
	Activate or deactivate the widgets at the request of the previous page.
PageEditor *	getPageEditor ()
	Returns the Page associated to the Editor page.
PageCapture *	getPageCapture ()
	Returns the Page associated to the Capture page.
PageTimeline *	getPageTimeline ()
	Returns the Page associated to the Timeline page.
PageBttv *	getPageBttv ()
	Returns the 'BTTV' page (test code for extending hardware support).
PageExport *	getPageExport ()
	Returns the Export page.
PageTrim *	getPageTrim ()
	Returns the Trim page.
PageMagick *	getPageMagick ()
	Returns the Magick page.
PageUndefined *	getPageUndefined ()
	Returns the Page associated to the Undefined page.
int	moveToFrame ()
	Move to the current frame.
int	moveToFrame (int)
	Move to the frame specified.
int	moveByFrames (int)
	Move the frame relative to the number specified.
void	showFrameInfo (int)
	Relay the current frame info to the GUI.
void	showFrameMoreInfo (Frame &, FileHandler *)
	Display detailed information about this frame and its file.
void	keyboardFeedback (const char *, const char *)
	Relay the current command and any message associated to it.
gboolean	processKeyboard (GdkEventKey *event)
	Trigger the keyboard action of the current page.
gboolean	processCommand (char *)
	Trigger a menu command action of the current page.
void	selectScene (int)
	Trigger the select scene action of the current page.
void	videoStartOfMovie ()
	Trigger the start of movie action of the current page.
void	videoPreviousScene ()
	Trigger the previous scene action of the current page.
void	videoStartOfScene ()
	Trigger the start of scene action of the current page.
void	videoRewind ()
	Trigger the rewind action of the current page.
void	videoBack (int step=-1)
	Trigger the back action of the current page.
void	videoPlay ()
	Trigger the play action of the current page.
void	videoForward (int step=1)
	Trigger the forward action of the current page.
void	videoFastForward ()
	Trigger the fast forward action of the current page.
void	videoNextScene ()
	Trigger the next scene action of the current page.
void	videoEndOfScene ()
	Trigger the end of scene action of the current page.
void	videoEndOfMovie ()
	Trigger the end movie action of the current page.
void	videoPause ()
	Trigger the pause action of the current page.
void	videoStop ()
	Trigger the stop action of the current page.
void	videoShuttle (int)
	Bi-directional variable-speed playback.
void	windowMoved ()
void	visibilityChanged (gboolean)
void	toggleComponents (component_enum, bool)
	Set the state of toggle buttons.
component_enum	getComponentState ()
	Get the current component state data.
void	commitComponentState (component_enum=(component_enum) 0)
	Set the component state data and commit it.
char *	getFileToOpen (char *title, bool isDVFile, GtkWidget *widget)
	Handles the modal dialog for collecting a file to open.
char *	getFileToSaveFormat (char *title, GtkWidget *widget, int &format)
char *	getFileToOpen (char *title, bool isDVFile=true)
char *	getFileToSave (char *title)
char *	getFileToSaveFormat (char *title, int &format)
void	setPreviewSize (float factor, bool noWarning=false)
	Resize the video preview area to a percentage of source image size.
void	loadSplash (GtkDrawingArea *)
	Load the splash image into the video preview area.
void	clearPreview (GtkDrawingArea *)
	Make the video preview area black.
void	setWindowTitle ()
	Sets the document name in the window title.
void	saveFrame (int, char *)
	Save the specified frame to the specified file.
bool	loadMediaObject (char *, int)
	Loads the specified media file before the specified frame.
void	packIt (const char *, const char *)
	Set the video display to be fixed size or scalable.
void	setStatusBar (const char *,...)
	Helper function for the pages.
void	setMoreInfo (bool state)
SMIL::Time::TimeFormat	getTimeFormat () const
void	setTimeFormat (SMIL::Time::TimeFormat format)
SMIL::MediaClippingTime &	getTime ()
void	setCurrentScene (int frame)
string	getLastDirectory ()
void	setLastDirectory (const string &value)
void	updateRecentFiles ()
bool	exitKino ()
int	checkFile (char *)
	Determines the format of the file.
Static Public Member Functions
static GtkWindow *	getWidgetWindow (GtkWidget *widget)
Public Attributes
int	g_currentFrame
gboolean	hasListChanged
Protected Member Functions
void	start ()
	Trigger the start action of the current page.
void	clean ()
	Trigger the clean action of the current page.
void	setFileEditted (char *)
void	setCurrentDirectoryFromFile (char *)
void	saveAVI (char *)
bool	loadPlayList (char *, int)
	Loads the specified play list before the specified frame.
bool	savePlayList (char *)
	Saves the playlist.
void	fetchProjectMetadata (const std::string &projectKey)
	Uses libml2 to fetch the metadata from a CMS.
Private Attributes
GtkWidget *	widget
GtkWidget *	edit_menu
GtkWidget *	view_menu
GtkNotebook *	notebook
GtkEntry *	command
GtkButton *	video_start_movie_button
GtkButton *	video_start_scene_button
GtkButton *	video_rewind_button
GtkButton *	video_back_button
GtkButton *	video_play_button
GtkButton *	video_stop_button
GtkButton *	video_forward_button
GtkButton *	video_fast_forward_button
GtkButton *	video_end_scene_button
GtkButton *	video_end_movie_button
GtkRange *	video_shuttle
GtkStatusbar *	statusbar
PlayList	playlist
int	currentPage
PageEditor *	editor
PageCapture *	capture
PageTimeline *	timeline
PageBttv *	bttv
PageExport *	exportPage
PageTrim *	trimPage
PageMagick *	magickPage
PageUndefined *	undefined
char	tempFileName [PATH_MAX+NAME_MAX]
char	playlistFileName [PATH_MAX+NAME_MAX]
gulong	component_state
bool	is_component_state_changing
string	last_directory
bool	showMoreInfo
int	currentScene
SMIL::MediaClippingTime	time
std::vector< GtkWidget * >	recentMenuItems

---

Detailed Description

This class is the main GUI class.

As such it is responsible for providing the functionality for all GUI actions relating to widgets which are outside of an individual notebook page (ie: the menu, scene list, transport controls, command line, frame info and the notebook itself).

It is also responsible for holding the current play list.

NB: I would like to make this class more dynamic, especially in terms of notebook pages. Ideally, a notebook page would become a plug in, with each Page object being registered with this class (and a subsequent notebook page being added to the GUI). Glade (and libglade) could be used in such a scenario, but it would necessitate a separate glade project per page (I think... haven't really looked at how best to do this yet). The advantage would be that not only could third party plug-ins be developed, but irrelevant notebook pages could be discarded (ie: if you have no firewire capture card, then that page could be excluded).

Definition at line 108 of file kino_common.h.

---

Constructor & Destructor Documentation

KinoCommon::KinoCommon (  GtkWidget *  widget  )

Constructor for KinoCommon - initialises all GUI widgets. Parameters: widget  top level widget for the main window Definition at line 90 of file kino_common.cc. References bttv, capture, component_state, currentPage, currentScene, edit_menu, editor, exportPage, g_currentFrame, Preferences::getInstance(), hasListChanged, is_component_state_changing, lookup_widget(), magickPage, notebook, setTimeFormat(), statusbar, SMIL::Time::TIME_FORMAT_FRAMES, SMIL::Time::TIME_FORMAT_NONE, timeline, trimPage, undefined, video_back_button, video_end_movie_button, video_end_scene_button, video_fast_forward_button, video_forward_button, video_play_button, video_rewind_button, video_shuttle, video_start_movie_button, video_start_scene_button, VIDEO_STOP, video_stop_button, and view_menu. : last_directory( "" ) { cerr << "> Kino Common being built" << endl; // Initialise class variables from GUI components this->widget = widget; this->edit_menu = lookup_widget( widget, "edit" ); this->view_menu = lookup_widget( widget, "view1" ); this->notebook = GTK_NOTEBOOK( lookup_widget( widget, "main_notebook" ) ); this->video_start_movie_button = GTK_BUTTON( lookup_widget( widget, "video_start_movie_button" ) ); this->video_start_scene_button = GTK_BUTTON( lookup_widget( widget, "video_start_scene_button" ) ); this->video_rewind_button = GTK_BUTTON( lookup_widget( widget, "video_rewind_button" ) ); this->video_back_button = GTK_BUTTON( lookup_widget( widget, "video_back_button" ) ); this->video_play_button = GTK_BUTTON( lookup_widget( widget, "video_play_button" ) ); this->video_stop_button = GTK_BUTTON( lookup_widget( widget, "video_stop_button" ) ); this->video_forward_button = GTK_BUTTON( lookup_widget( widget, "video_forward_button" ) ); this->video_fast_forward_button = GTK_BUTTON( lookup_widget( widget, "video_fast_forward_button" ) ); this->video_end_scene_button = GTK_BUTTON( lookup_widget( widget, "video_end_scene_button" ) ); this->video_end_movie_button = GTK_BUTTON( lookup_widget( widget, "video_end_movie_button" ) ); this->video_shuttle = GTK_RANGE( lookup_widget( widget, "hscale_shuttle" ) ); this->statusbar = GTK_STATUSBAR( lookup_widget( widget, "statusbar" ) ); // Create page objects this->editor = new PageEditor( this ); this->capture = new PageCapture( this ); this->timeline = new PageTimeline( this ); this->undefined = new PageUndefined( this ); this->bttv = new PageBttv( this ); this->exportPage = new PageExport( this ); this->trimPage = new PageTrim( this ); this->magickPage = new PageMagick( this ); // Initialise other class variables strcpy( this->tempFileName, "" ); this->g_currentFrame = -1; this->hasListChanged = TRUE; this->currentScene = -1; this->currentPage = -1; this->component_state = VIDEO_STOP; this->is_component_state_changing = false; SMIL::Time::TimeFormat timeFormat = static_cast< SMIL::Time::TimeFormat >( Preferences::getInstance().timeFormat ); GtkWidget *timemenu = lookup_widget( widget, "optionmenu_time_format" ); if ( timeFormat == SMIL::Time::TIME_FORMAT_NONE ) setTimeFormat( SMIL::Time::TIME_FORMAT_FRAMES ); gtk_option_menu_set_history( GTK_OPTION_MENU( timemenu ), Preferences::getInstance().timeFormat - 1 ); }

KinoCommon::~KinoCommon (   )

Destructor for the kino common object. Definition at line 143 of file kino_common.cc. References bttv, capture, clean(), editor, exportPage, GetFileMap(), magickPage, timeline, trimPage, and undefined. { cerr << "> Kino Common being destroyed" << endl; clean(); delete this->editor; delete this->capture; delete this->timeline; delete this->undefined; delete this->bttv; delete this->exportPage; delete this->trimPage; delete this->magickPage; GetFileMap() ->Clear(); cerr << "> Kino Common destroyed" << endl; }

---

Member Function Documentation

void KinoCommon::activateWidgets (   )

Activate or deactivate the widgets at the request of the previous page. This method is always called immediately after the current pages start method and can be called at the discretion of the page if required. Definition at line 1994 of file kino_common.cc. References EDIT_MENU, getCurrentPage(), GetStoryboard(), lookup_widget(), SCENE_LIST, VIDEO_BACK, video_back_button, video_end_movie_button, VIDEO_END_OF_MOVIE, video_end_scene_button, VIDEO_FAST_FORWARD, video_fast_forward_button, VIDEO_FORWARD, video_forward_button, VIDEO_NEXT_SCENE, VIDEO_PLAY, video_play_button, VIDEO_REWIND, video_rewind_button, VIDEO_SHUTTLE, video_shuttle, video_start_movie_button, VIDEO_START_OF_MOVIE, VIDEO_START_OF_SCENE, video_start_scene_button, VIDEO_STOP, video_stop_button, and widget. Referenced by PageCapture::applyAVCState(), on_preferences_dialog_ok_button_clicked(), PageExport::setCurrentMode(), PageMagick::ShowCurrentStatus(), PageCapture::start(), start(), PageCapture::startCapture(), and PageMagick::StartRender(). { component_enum pattern = ( component_enum ) ( this->getCurrentPage()->activate() ^ this->getCurrentPage()->deactivate() ); gtk_widget_set_sensitive( lookup_widget( widget, "undo" ), pattern & EDIT_MENU ); gtk_widget_set_sensitive( lookup_widget( widget, "redo" ), pattern & EDIT_MENU ); gtk_widget_set_sensitive( lookup_widget( widget, "copy_current_scene" ), pattern & EDIT_MENU ); gtk_widget_set_sensitive( lookup_widget( widget, "cut_current_scene" ), pattern & EDIT_MENU ); gtk_widget_set_sensitive( lookup_widget( widget, "paste_before_current_frame" ), pattern & EDIT_MENU ); gtk_widget_set_sensitive( lookup_widget( widget, "split_scene" ), pattern & EDIT_MENU ); gtk_widget_set_sensitive( lookup_widget( widget, "join_scenes" ), pattern & EDIT_MENU ); gtk_widget_set_sensitive( lookup_widget( widget, "button_undo" ), pattern & EDIT_MENU ); gtk_widget_set_sensitive( lookup_widget( widget, "button_redo" ), pattern & EDIT_MENU ); gtk_widget_set_sensitive( lookup_widget( widget, "button_cut" ), pattern & EDIT_MENU ); gtk_widget_set_sensitive( lookup_widget( widget, "button_copy" ), pattern & EDIT_MENU ); gtk_widget_set_sensitive( lookup_widget( widget, "button_paste" ), pattern & EDIT_MENU ); gtk_widget_set_sensitive( lookup_widget( widget, "button_split" ), pattern & EDIT_MENU ); gtk_widget_set_sensitive( lookup_widget( widget, "button_join" ), pattern & EDIT_MENU ); GetStoryboard() ->setSensitive( pattern & SCENE_LIST ); gtk_widget_set_sensitive( GTK_WIDGET( video_start_movie_button ), pattern & VIDEO_START_OF_MOVIE ); gtk_widget_set_sensitive( GTK_WIDGET( video_start_scene_button ), pattern & VIDEO_START_OF_SCENE ); gtk_widget_set_sensitive( GTK_WIDGET( video_rewind_button ), pattern & VIDEO_REWIND ); gtk_widget_set_sensitive( GTK_WIDGET( video_back_button ), pattern & VIDEO_BACK ); gtk_widget_set_sensitive( GTK_WIDGET( video_play_button ), pattern & VIDEO_PLAY ); gtk_widget_set_sensitive( GTK_WIDGET( video_stop_button ), pattern & VIDEO_STOP ); gtk_widget_set_sensitive( GTK_WIDGET( video_forward_button ), pattern & VIDEO_FORWARD ); gtk_widget_set_sensitive( GTK_WIDGET( video_fast_forward_button ), pattern & VIDEO_FAST_FORWARD ); gtk_widget_set_sensitive( GTK_WIDGET( video_end_scene_button ), pattern & VIDEO_NEXT_SCENE ); gtk_widget_set_sensitive( GTK_WIDGET( video_end_movie_button ), pattern & VIDEO_END_OF_MOVIE ); gtk_widget_set_sensitive( GTK_WIDGET( video_shuttle ), pattern & VIDEO_SHUTTLE ); }

void KinoCommon::appendFile (   )

Appends a file after the current position. Definition at line 751 of file kino_common.cc. References AVI, changePageRequest(), checkFile(), g_currentFrame, getFileToOpen(), getPageEditor(), getPlayList(), hasListChanged, importFile(), loadMediaObject(), loadPlayList(), modal_message(), moveToFrame(), PAGE_EDITOR, PLAYLIST, QT, RAW_DV, setWindowTitle(), and UNKNOWN_FORMAT. Referenced by PageEditor::processCommand(). { changePageRequest( PAGE_EDITOR ); char * filename = this->getFileToOpen( _( "Choose a DV or SMIL file to append" ) ); if ( filename && strcmp( filename, "" ) ) { switch ( checkFile( filename ) ) { case AVI: case RAW_DV: case QT: if ( loadMediaObject( filename, g_currentFrame + 1 ) ) { g_currentFrame++; hasListChanged = TRUE; getPlayList() ->SetDirty( true ); break; } // Else, ask to import case UNKNOWN_FORMAT: { const std::string& importedFile = importFile( filename ); if ( loadMediaObject( const_cast<char*>( importedFile.c_str() ), g_currentFrame + 1 ) ) { g_currentFrame++; hasListChanged = TRUE; getPlayList() ->SetDirty( true ); break; } else { modal_message( _( "Failed to load media file \"%s\"" ), importedFile.c_str() ); } break; } case PLAYLIST: // Insert the new smil if ( loadPlayList( filename, g_currentFrame + 1 ) ) { g_currentFrame++; hasListChanged = TRUE; getPlayList() ->SetDirty( true ); getPageEditor() ->snapshot(); } break; } } setWindowTitle(); moveToFrame( ); }

void KinoCommon::bulkLoad (  int  argc, char *  argv[] )

Loads all files specified in the command line style arguments. Parameters: argc  number of arguments argv  arguments Definition at line 1433 of file kino_common.cc. References AVI, checkFile(), currentPage, g_currentFrame, getPageEditor(), getPlayList(), hasListChanged, importFile(), loadMediaObject(), loadPlayList(), lookup_widget(), modal_message(), PAGE_TRIM, PLAYLIST, QT, RAW_DV, setWindowTitle(), UNKNOWN_FORMAT, url_decode(), and widget. { char temp[ PATH_MAX + NAME_MAX ]; char filename[ PATH_MAX + NAME_MAX ]; for ( int i = 1; i < argc; ++i ) { /* Get the real name of the file, to make sure that we store absolute paths in smil files */ if ( NULL != realpath( url_decode( temp, argv[ i ] ), filename ) ) { switch ( checkFile( filename ) ) { case AVI: case RAW_DV: case QT: // a little hook to make the trimmer load the clip for insert edting if ( currentPage == PAGE_TRIM ) { gtk_entry_set_text( GTK_ENTRY( lookup_widget( widget, "entry_trim_clip" ) ), filename ); } else if ( loadMediaObject( filename, this->getPlayList() ->GetNumFrames() ) ) { if ( g_currentFrame == -1 ) g_currentFrame = 0; this->hasListChanged = TRUE; } else { cerr << "KinoCommon::bulkLoad: Failed to load " << filename << endl; } break; case PLAYLIST: { int last_count = getPlayList( ) ->GetNumFrames( ); string last_doc_name = getPlayList( ) ->GetDocName( ); if ( loadPlayList( filename, last_count ) ) { if ( last_count == 0 && last_doc_name == "" ) { getPlayList() ->SetDocName( filename ); getPlayList() ->SetDirty( false ); } else { getPlayList() ->SetDirty( true ); } getPageEditor() ->snapshot(); if ( g_currentFrame == -1 ) g_currentFrame = 0; this->hasListChanged = TRUE; } } break; case UNKNOWN_FORMAT: { const std::string& importedFile = importFile( filename ); if ( currentPage == PAGE_TRIM ) { gtk_entry_set_text( GTK_ENTRY( lookup_widget( widget, "entry_trim_clip" ) ), importedFile.c_str() ); } else if ( loadMediaObject( const_cast<char*>( importedFile.c_str() ), this->getPlayList() ->GetNumFrames() ) ) { if ( g_currentFrame == -1 ) g_currentFrame = 0; hasListChanged = TRUE; getPlayList() ->SetDirty( true ); } else { modal_message( _( "Failed to load media file \"%s\"" ), importedFile.c_str() ); } } break; } } else { cerr << "KinoCommon::bulkLoad: Unable to resolve " << filename << endl; } } setWindowTitle( ); }

void KinoCommon::changePageRequest (  int  page  )

Sends change page request to the gui. Parameters: page  page to change to Definition at line 408 of file kino_common.cc. References notebook. Referenced by appendFile(), insertFile(), loadFile(), newFile(), on_iconview_timeline_item_activated(), on_iconview_timeline_selection_changed(), PageTrim::processCommand(), PageTimeline::processCommand(), PageMagick::processCommand(), PageExport::processCommand(), PageEditor::processCommand(), PageCapture::processCommand(), PageTrim::processKeyboard(), PageTimeline::processKeyboard(), PageMagick::processKeyboard(), PageExport::processKeyboard(), and PageCapture::processKeyboard(). { gtk_notebook_set_page( notebook, page ); }

int KinoCommon::checkFile (  char *  FileName  )

Determines the format of the file. It is required that a file be at least 20 bytes for it to load. Note that it is currently required that mediafiles have either a .dv or .avi suffix since the PlayList uses the suffixes .avi and .dv to determine what FileHandler to create. Smil files are allowed to load without suffixes. (Correct?) Parameters: filename  file to check Returns: AVI, PLAYLIST, RAW_DV or UNKNOWN_FORMAT Definition at line 1240 of file kino_common.cc. References AVI, PLAYLIST, QT, RAW_DV, and UNKNOWN_FORMAT. Referenced by appendFile(), bulkLoad(), generate_file_preview(), insertFile(), loadFile(), on_combo_trim_clip_entry_changed(), and on_combo_trim_clip_entry_focus_out_event(). { // Try reading a few bytes from the file ... std::ifstream file( FileName ); std::vector<char> buffer( 22, '\0' ); file.read( &buffer[ 0 ], buffer.size() ); // If it didn't work, we're done ... if ( file.bad() ) { cerr << "> Error reading file: " << FileName << endl; return UNKNOWN_FORMAT; } // If the file is shorter than our buffer, we're done ... if ( file.eof() ) { cerr << "> File size < " << buffer.size() << " bytes: " << FileName << endl; return UNKNOWN_FORMAT; } // Start looking at file suffixes ... const std::string filename( FileName ); const std::string suffix( filename.begin() + filename.rfind( "." ), filename.end() ); if ( suffix == ".avi" ) { return AVI; } else if ( suffix == ".dv" || suffix == ".dif" ) { // This bit of magic brought to you from the dvgrab AVI iso handler ... const unsigned char * const p = reinterpret_cast<unsigned char*>( &buffer[ 0 ] ); const int section_type = p[ 0 ] >> 5; const int dif_sequence = p[ 1 ] >> 4; if ( 0 == section_type && 0 == dif_sequence ) return RAW_DV; return UNKNOWN_FORMAT; } else if ( suffix == ".mov" ) { return QT; } // Check to see if it's SMIL ... const std::string smil_magic( "<?xml version=\"1.0\"?>" ); if ( std::string( buffer.begin(), buffer.begin() + smil_magic.size() ) == smil_magic ) return PLAYLIST; // No can do! return UNKNOWN_FORMAT; }

void KinoCommon::clean (   )  [protected]

Trigger the clean action of the current page. Definition at line 1747 of file kino_common.cc. References getCurrentPage(). Referenced by newFile(), setCurrentPage(), and ~KinoCommon(). { getCurrentPage() ->clean(); }

void KinoCommon::clearPreview (  GtkDrawingArea *  drawable  )

Make the video preview area black. Parameters: widget  the GtkDrawingArea to clear. Definition at line 2247 of file kino_common.cc. References widget. Referenced by PageTrim::windowMoved(), and PageCapture::windowMoved(). { GtkWidget * widget = GTK_WIDGET( drawable ); if ( widget->window && GDK_IS_DRAWABLE( widget->window ) ) { gdk_draw_rectangle ( widget->window, widget->style->black_gc, TRUE, widget->allocation.x, widget->allocation.y, widget->allocation.width, widget->allocation.height ); } }

void KinoCommon::commitComponentState (  component_enum  pattern = ( component_enum ) 0  )

Set the component state data and commit it. You can set component state at the same time too. See the toggleComponents() method. Parameters: pattern  A set of component_enums to set true Definition at line 2091 of file kino_common.cc. References component_state, and is_component_state_changing. Referenced by PageCapture::applyAVCState(), PageCapture::start(), start(), PageCapture::startCapture(), PageMagick::StartRender(), videoBack(), videoEndOfMovie(), videoEndOfScene(), videoFastForward(), videoForward(), videoNextScene(), videoPause(), PageMagick::videoPlay(), videoPlay(), videoPreviousScene(), videoRewind(), videoShuttle(), videoStartOfMovie(), videoStartOfScene(), and videoStop(). { this->component_state |= pattern; this->is_component_state_changing = false; }

bool KinoCommon::exitKino (   )

Definition at line 2303 of file kino_common.cc. References newFile(). { return newFile( false ); }

void KinoCommon::fetchProjectMetadata (  const std::string &  projectKey  )  [protected]

Uses libml2 to fetch the metadata from a CMS. Added for tagesschau.de. It uses config items newProjectURI to make an HTTP request and newProjectXPath to extract the project ID, and expands metaValues containing xpaths. Parameters: projectKey  a project name or identifier to put into the newProjectURI. Definition at line 168 of file kino_common.cc. References Preferences::getInstance(), getPlayList(), and modal_message(). Referenced by loadFile(), loadPlayList(), and newFile(). { if ( projectKey == "" ) return; // Fetch the project metadata from CMS char uri[1024]; uri[1023] = '\0'; snprintf( uri, 1023, Preferences::getInstance().newProjectURI, projectKey.c_str() ); cerr << "Composed Project URI " << uri << endl; xmlNanoHTTPInit(); void *httpContext = xmlNanoHTTPOpen( uri, NULL ); int code = 0; if ( httpContext && ( code = xmlNanoHTTPReturnCode( httpContext ) ) == 200 ) { char *buffer = (char*) calloc( 1, 1000 ); int size = 0; int nread; while ( ( nread = xmlNanoHTTPRead( httpContext, buffer + size, 999 ) ) > 0 ) { size += nread; if ( nread == 999 ) { buffer = ( char* )realloc( buffer, size + 999 ); buffer[ size + 1 ] = '\0'; } } // Parse the response xmlDocPtr doc = xmlParseMemory( buffer, size ); xmlXPathInit(); xmlXPathContextPtr xpathContext = xmlXPathNewContext( doc ); if ( xpathContext ) { xmlXPathObjectPtr xpathResult; // Extract the project ID if ( strcmp( Preferences::getInstance().newProjectXPath, "" ) ) { xpathResult = xmlXPathEval( (xmlChar*) Preferences::getInstance().newProjectXPath, xpathContext ); if ( xpathResult ) { if ( xpathResult->type == XPATH_NODESET && !xmlXPathNodeSetIsEmpty( xpathResult->nodesetval ) ) { getPlayList()->SetDocId( (char*) xmlXPathCastToString( xpathResult ) ); cerr << "newProject ID = " << xmlXPathCastToString( xpathResult ) << endl; if ( strcmp( reinterpret_cast< char* >( xmlXPathCastToString( xpathResult ) ), "" ) == 0 ) modal_message( _("The server returned an empty response.\n\nPlease choose File/New to query the server again.") ); } else modal_message( _("Failed to parse project metadata:\nthe result of newProjectXPath is empty") ); xmlXPathFreeObject( xpathResult ); } else modal_message( _("Failed to parse project metadata:\nbad newProjectXPath expression") ); } // Expand metaValues map< string, vector< std::pair< std::string, std::string > > >& metaValuesMap = Preferences::getInstance().metaValues; map< string, vector< std::pair< std::string, std::string > > >::iterator metaValuesMapIter; for ( metaValuesMapIter = metaValuesMap.begin(); metaValuesMapIter != metaValuesMap.end(); ++metaValuesMapIter ) { if ( metaValuesMapIter->second.size() > 0 ) { const string labelPath = metaValuesMapIter->second[0].first; const string valuePath = metaValuesMapIter->second[0].second; // Expand the label if ( labelPath.length() > 5 && labelPath.substr( 0, 6 ) == "xpath:" ) { // remove the xpath from the values metaValuesMapIter->second.erase( metaValuesMapIter->second.begin() ); xpathResult = xmlXPathEval( (xmlChar*) labelPath.substr( 6 ).c_str(), xpathContext ); if ( xpathResult ) { if ( xpathResult->type == XPATH_NODESET ) { for ( int i = 0; i < xmlXPathNodeSetGetLength( xpathResult->nodesetval ); i++ ) { string label( (char *) xmlXPathCastNodeToString( xmlXPathNodeSetItem( xpathResult->nodesetval, i ) ) ); metaValuesMapIter->second.push_back( make_pair( label, label ) ); } } xmlXPathFreeObject( xpathResult ); } else modal_message( _("Failed to parse project metadata:\nbad metaValues XPath expression") ); } // Expand the value if ( valuePath.length() > 5 && valuePath.substr( 0, 6 ) == "xpath:" ) { xpathResult = xmlXPathEval( (xmlChar*) valuePath.substr( 6 ).c_str(), xpathContext ); if ( xpathResult ) { if ( xpathResult->type == XPATH_NODESET ) { for ( int i = 0; i < xmlXPathNodeSetGetLength( xpathResult->nodesetval ); i++ ) metaValuesMapIter->second[ i ].second = (char *) xmlXPathCastNodeToString( xmlXPathNodeSetItem( xpathResult->nodesetval, i ) ); } xmlXPathFreeObject( xpathResult ); } else modal_message( _("Failed to parse project metadata:\nbad metaValues XPath expression") ); } } } xmlXPathFreeContext( xpathContext ); } free( buffer ); } else if ( httpContext ) { modal_message( "Server responded with error %d", code ); } if ( httpContext ) xmlNanoHTTPClose( httpContext ); xmlNanoHTTPCleanup(); }

component_enum KinoCommon::getComponentState (   )

Get the current component state data. Definition at line 2079 of file kino_common.cc. References component_state. Referenced by PageCapture::applyAVCState(), PageTrim::processKeyboard(), PageCapture::processKeyboard(), start(), PageMagick::StartRender(), PageTrim::videoBack(), PageMagick::videoBack(), PageEditor::videoBack(), PageTrim::videoEndOfMovie(), PageMagick::videoEndOfMovie(), PageEditor::videoEndOfMovie(), PageTrim::videoFastForward(), PageEditor::videoFastForward(), PageTrim::videoForward(), PageMagick::videoForward(), PageEditor::videoForward(), PageMagick::videoNextScene(), PageTrim::videoPause(), PageTrim::videoPlay(), PageMagick::videoPlay(), PageEditor::videoPlay(), PageMagick::videoPreviousScene(), PageTrim::videoRewind(), PageEditor::videoRewind(), videoShuttle(), PageMagick::videoStartOfMovie(), PageTrim::videoStop(), PageMagick::videoStop(), and PageEditor::videoStop(). { return ( component_enum ) this->component_state; }

Page * KinoCommon::getCurrentPage (   )

Returns the current Page object. Returns: the current Page object (will be PageUndefined if current page is invalid). Definition at line 475 of file kino_common.cc. References getPage(), and getPageUndefined(). Referenced by activateWidgets(), clean(), loadFile(), loadPlayList(), moveToFrame(), on_preferences_dialog_ok_button_clicked(), processCommand(), processKeyboard(), selectScene(), setTimeFormat(), showFrameInfo(), start(), videoBack(), videoEndOfMovie(), videoEndOfScene(), videoFastForward(), videoForward(), videoNextScene(), videoPause(), videoPlay(), videoPreviousScene(), videoRewind(), videoShuttle(), videoStartOfMovie(), videoStartOfScene(), videoStop(), visibilityChanged(), and windowMoved(). { Page * ret = getPage( this->currentPage ); if ( ret == NULL ) ret = getPageUndefined(); return ret; }

int KinoCommon::getCurrentScene (   )  [inline]

Definition at line 179 of file kino_common.h. References currentScene. Referenced by on_tool_change(), showScenesThread(), and Storyboard::Storyboard(). { return this->currentScene; }

char* KinoCommon::getFileToOpen (  char *  title, bool  isDVFile = true )  [inline]

Definition at line 258 of file kino_common.h. References getFileToOpen(), and getWidget(). { return getFileToOpen( title, isDVFile, getWidget() ); }

char * KinoCommon::getFileToOpen (  char *  title, bool  isDVFile, GtkWidget *  widget )

Handles the modal dialog for collecting a file to open. The file is not opened, but returned by this method. Parameters: title  title of the window Returns: a string inidicating the selected file (an empty string denotes no selection) Definition at line 1079 of file kino_common.cc. References directory_utils::get_directory_from_file(), getPlayList(), getWidgetWindow(), last_directory, tempFileName, and update_preview_cb(). Referenced by appendFile(), getFileToOpen(), insertFile(), loadFile(), ImageCreateFromFile::on_button_file_clicked(), AudioMix::on_button_mix_file_clicked(), AudioDub::on_button_sub_file_clicked(), and on_button_trim_open_clicked(). { GtkWidget *dialog; GtkDrawingArea *preview; GtkFileFilter *filter; dialog = gtk_file_chooser_dialog_new( title, getWidgetWindow(widget), GTK_FILE_CHOOSER_ACTION_OPEN, GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL, GTK_STOCK_OPEN, GTK_RESPONSE_ACCEPT, static_cast<gchar*>( NULL ) ); gtk_dialog_set_alternative_button_order( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT, GTK_RESPONSE_CANCEL, -1 ); // gtk_file_chooser_set_select_multiple( GTK_FILE_CHOOSER(dialog), TRUE ); if ( isDVFile ) { preview = ( GtkDrawingArea* )gtk_drawing_area_new(); gtk_widget_set_size_request( GTK_WIDGET(preview), 160, 120 ); gtk_file_chooser_set_preview_widget( GTK_FILE_CHOOSER(dialog), GTK_WIDGET(preview) ); g_signal_connect( dialog, "update-preview", G_CALLBACK(update_preview_cb), preview ); filter = gtk_file_filter_new(); gtk_file_filter_set_name( filter, "All Files" ); gtk_file_filter_add_pattern( filter, "*" ); gtk_file_chooser_add_filter( GTK_FILE_CHOOSER(dialog), filter ); filter = gtk_file_filter_new(); gtk_file_filter_set_name( filter, "SMIL Files (*.smil, *.kino)" ); gtk_file_filter_add_pattern( filter, "*.smil" ); gtk_file_filter_add_pattern( filter, "*.kino" ); gtk_file_chooser_add_filter( GTK_FILE_CHOOSER(dialog), filter ); filter = gtk_file_filter_new(); gtk_file_filter_set_name( filter, "Raw DV Files (*.dv, *.dif)" ); gtk_file_filter_add_pattern( filter, "*.dv" ); gtk_file_filter_add_pattern( filter, "*.dif" ); gtk_file_choose