me@1942: #!/usr/bin/python
me@1942: 
me@1942: import xml.etree.ElementTree as ET
me@1942: import os # list files in directory
me@1942: import sys # command line arguments
me@1942: import matplotlib.pyplot as plt # plots
me@1942: import matplotlib.patches as patches # rectangles
me@1942: 
me@1942: 
me@1942: # COMMAND LINE ARGUMENTS
me@1942: 
me@1942: assert len(sys.argv)<3, "timeline_view_movement takes at most 1 command line argument\n"+\
me@1942:                         "Use: python timeline_view_movement.py [XML_files_location]"
me@1942: 
me@1942: # XML results files location
me@1942: if len(sys.argv) == 1:
me@1942:     folder_name = "../saves"    # Looks in 'saves/' folder from 'scripts/' folder
me@1942:     print "Use: python timeline_view_movement.py [XML_files_location]"
me@1942:     print "Using default path: " + folder_name
me@1942: elif len(sys.argv) == 2:
me@1942:     folder_name = sys.argv[1]   # First command line argument is folder
me@1942: 
me@1942: # check if folder_name exists
me@1942: if not os.path.exists(folder_name):
me@1942:     #the file is not there
me@1942:     print "Folder '"+folder_name+"' does not exist."
me@1942:     sys.exit() # terminate script execution
me@1942: elif not os.access(os.path.dirname(folder_name), os.W_OK):
me@1942:     #the file does exist but write privileges are not given
me@1942:     print "No write privileges in folder '"+folder_name+"'."
me@1942: 
me@1942: 
me@1942: # CONFIGURATION 
me@1942: 
me@1942: # Folder where to store timelines
me@1942: timeline_folder = folder_name + '/timelines_movement/'    # Stores in 'saves/timelines_movement/' by default
me@1942: 
me@1942: # Font settings
me@1942: font = {'weight' : 'bold',
me@1942:         'size'   : 16}
me@1942: plt.rc('font', **font)
me@1942: 
me@1942: # Colormap for to cycle through
me@1942: colormap = ['b', 'g', 'c', 'm', 'y', 'k']
me@1942: 
me@1942: # figure size
me@1942: fig_width = 25
me@1942: fig_height = 10
me@1942: 
me@1942: 
me@1942: # CODE
me@1942: 
me@1942: # create timeline_folder if not yet created
me@1942: if not os.path.exists(timeline_folder):
me@1942:     os.makedirs(timeline_folder)
me@1942: 
me@1942: # get every XML file in folder
me@1942: for file in os.listdir(folder_name):
me@1942:     if file.endswith(".xml"):
me@1942:         tree = ET.parse(folder_name + '/' + file)
me@1942:         root = tree.getroot()
me@1942:         subject_id = file[:-4] # drop '.xml'
me@1942:         
me@1942:         previous_audioholder_time = 0 # time spent before current audioholder
me@1942:         time_offset = 0 # test starts at zero
me@1942:         
me@1942:         # ONE TIMELINE PER PAGE - make new plot per page
me@1942: 
me@1942:         # get list of all page names
me@1942:         for audioholder in root.findall("./audioholder"):   # iterate over pages
me@1942:             page_name = audioholder.get('id')               # get page name
me@1942:             plot_empty = True                               # check if any data is plotted
me@1942:             
me@1942:             if page_name is None: # ignore 'empty' audio_holders
me@1942:                 print "Skipping empty audioholder name from "+subject_id+"."
me@1942:                 break
me@1942:                 
me@1942:             # subtract total audioholder length from subsequent audioholder event times
me@1942:             audioholder_time_temp = audioholder.find("./metric/metricresult/[@id='testTime']")
me@1942:             if audioholder_time_temp is not None: 
me@1942:                 audioholder_time = float(audioholder_time_temp.text)
me@1942:             else: 
me@1942:                 print "Skipping audioholder without total time specified from "+subject_id+"."
me@1942:                 break
me@1942: 
me@1942:             # get audioelements
me@1942:             audioelements = audioholder.findall("./audioelement")
me@1942:             
me@1942:             # sort alphabetically
me@1942:             data = []
me@1942:             for elem in audioelements: # from http://effbot.org/zone/element-sort.htm
me@1942:                 key = elem.get("id")
me@1942:                 data.append((key, elem))
me@1942:             data.sort()
me@1942:             
me@1942:             N_audioelements = len(audioelements) # number of audio elements for this page
me@1942:             increment = 0 # increased for every new audioelement
me@1942:             
me@1942:             # get axes handle
me@1942:             fig = plt.figure(figsize=(fig_width, fig_height))
me@1942:             ax  = fig.add_subplot(111)
me@1942:             
me@1942:             # for page [page_name], print comments related to fragment [id]
me@1942:             #for tuple in data:
me@1942:             #    audioelement = tuple[1]
me@1942:             for tuple in data:
me@1942:                 audioelement = tuple[1]
me@1942:                 if audioelement is not None: # Check it exists
me@1942:                     audio_id = str(audioelement.get('id'))
me@1942:                     
me@1942:                     # break if no initial position or move events registered
me@1942:                     initial_position_temp = audioelement.find("./metric/metricresult/[@name='elementInitialPosition']")
me@1942:                     if initial_position_temp is None:
me@1942:                         print "Skipping "+page_name+" from "+subject_id+": does not have initial positions specified."
me@1942:                         break
me@1942:                     
me@1942:                     # get move events, initial and eventual position
me@1942:                     initial_position = float(initial_position_temp.text)
me@1942:                     move_events = audioelement.findall("./metric/metricresult/[@name='elementTrackerFull']/timepos")
me@1942:                     final_position = float(audioelement.find("./value").text)
me@1942:                     
me@1942:                     # get listen events
me@1942:                     start_times_global = []
me@1942:                     stop_times_global  = []
me@1942:                     listen_events = audioelement.findall("./metric/metricresult/[@name='elementListenTracker']/event")
me@1942:                     for event in listen_events:
me@1942:                         # get testtime: start and stop
me@1942:                         start_times_global.append(float(event.find('testtime').get('start'))-time_offset)
me@1942:                         stop_times_global.append(float(event.find('testtime').get('stop'))-time_offset)
me@1942:                     
me@1942:                     # display fragment name at start
me@1942:                     plt.text(0,initial_position+0.02,audio_id,color=colormap[increment%len(colormap)]) #,rotation=45
me@1942:                     
me@1942:                     # previous position and time
me@1942:                     previous_position = initial_position
me@1942:                     previous_time = 0
me@1942:                     
me@1942:                     # assume not playing at start
me@1942:                     currently_playing = False # keep track of whether fragment is playing during move event
me@1942:                                         
me@1942:                     # draw all segments except final one
me@1942:                     for event in move_events: 
me@1942:                         # mark this plot as not empty
me@1942:                         plot_empty = False
me@1942:                     
me@1942:                         # get time and final position of move event
me@1942:                         new_time = float(event.find("./time").text)-time_offset
me@1942:                         new_position = float(event.find("./position").text)
me@1942:                         
me@1942:                         # get play/stop events since last move until current move event
me@1942:                         stop_times = []
me@1942:                         start_times = []
me@1942:                         # is there a play and/or stop event between previous_time and new_time?
me@1942:                         for time in start_times_global:
me@1942:                             if time>previous_time and time<new_time:
me@1942:                                 start_times.append(time)
me@1942:                         for time in stop_times_global:
me@1942:                             if time>previous_time and time<new_time:
me@1942:                                 stop_times.append(time)
me@1942:                         # if no play/stop events between move events, find out whether playing
me@1942:                         
me@1942:                         segment_start = previous_time # first segment starts at previous move event
me@1942:                         
me@1942:                         # draw segments (horizontal line)
me@1942:                         while len(start_times)+len(stop_times)>0: # while still play/stop events left
me@1942:                             if len(stop_times)<1: # upcoming event is 'play'
me@1942:                                 # draw non-playing segment from segment_start to 'play'
me@1942:                                 currently_playing = False
me@1942:                                 segment_stop = start_times.pop(0) # remove and return first item
me@1942:                             elif len(start_times)<1: # upcoming event is 'stop'
me@1942:                                 # draw playing segment (red) from segment_start to 'stop'
me@1942:                                 currently_playing = True
me@1942:                                 segment_stop = stop_times.pop(0) # remove and return first item
me@1942:                             elif start_times[0]<stop_times[0]: # upcoming event is 'play'
me@1942:                                 # draw non-playing segment from segment_start to 'play'
me@1942:                                 currently_playing = False
me@1942:                                 segment_stop = start_times.pop(0) # remove and return first item
me@1942:                             else: # stop_times[0]<start_times[0]: upcoming event is 'stop'
me@1942:                                 # draw playing segment (red) from segment_start to 'stop'
me@1942:                                 currently_playing = True
me@1942:                                 segment_stop = stop_times.pop(0) # remove and return first item
me@1942:                                 
me@1942:                             # draw segment
me@1942:                             plt.plot([segment_start, segment_stop], # x-values
me@1942:                                 [previous_position, previous_position], # y-values
me@1942:                                 color='r' if currently_playing else colormap[increment%len(colormap)],
me@1942:                                 linewidth=3
me@1942:                             )
me@1942:                             segment_start = segment_stop # move on to next segment
me@1942:                             currently_playing = not currently_playing # toggle to draw final segment correctly
me@1942:                         
me@1942:                         # draw final segment (horizontal line) from last 'segment_start' to current move event time
me@1942:                         plt.plot([segment_start, new_time], # x-values
me@1942:                             [previous_position, previous_position], # y-values
me@1942:                             # color depends on playing during move event or not:
me@1942:                             color='r' if currently_playing else colormap[increment%len(colormap)], 
me@1942:                             linewidth=3
me@1942:                         )
me@1942:                         
me@1942:                         # vertical line from previous to current position
me@1942:                         plt.plot([new_time, new_time], # x-values
me@1942:                             [previous_position, new_position], # y-values
me@1942:                             # color depends on playing during move event or not:
me@1942:                             color='r' if currently_playing else colormap[increment%len(colormap)], 
me@1942:                             linewidth=3
me@1942:                         )
me@1942:                         
me@1942:                         # update previous_position value
me@1942:                         previous_position = new_position
me@1942:                         previous_time     = new_time
me@1942:                     
me@1942:                     
me@1942:                     
me@1942:                     # draw final horizontal segment (or only segment if audioelement not moved)
me@1942:                     # horizontal line from previous time to end of audioholder
me@1942:                     
me@1942:                     # get play/stop events since last move until current move event
me@1942:                     stop_times = []
me@1942:                     start_times = []
me@1942:                     # is there a play and/or stop event between previous_time and new_time?
me@1942:                     for time in start_times_global:
me@1942:                         if time>previous_time and time<audioholder_time-time_offset:
me@1942:                             start_times.append(time)
me@1942:                     for time in stop_times_global:
me@1942:                         if time>previous_time and time<audioholder_time-time_offset:
me@1942:                             stop_times.append(time)
me@1942:                     # if no play/stop events between move events, find out whether playing
me@1942:                     
me@1942:                     segment_start = previous_time # first segment starts at previous move event
me@1942:                     
me@1942:                     # draw segments (horizontal line)
me@1942:                     while len(start_times)+len(stop_times)>0: # while still play/stop events left
me@1942:                         # mark this plot as not empty
me@1942:                         plot_empty = False
me@1942:                         if len(stop_times)<1: # upcoming event is 'play'
me@1942:                             # draw non-playing segment from segment_start to 'play'
me@1942:                             currently_playing = False
me@1942:                             segment_stop = start_times.pop(0) # remove and return first item
me@1942:                         elif len(start_times)<1: # upcoming event is 'stop'
me@1942:                             # draw playing segment (red) from segment_start to 'stop'
me@1942:                             currently_playing = True
me@1942:                             segment_stop = stop_times.pop(0) # remove and return first item
me@1942:                         elif start_times[0]<stop_times[0]: # upcoming event is 'play'
me@1942:                             # draw non-playing segment from segment_start to 'play'
me@1942:                             currently_playing = False
me@1942:                             segment_stop = start_times.pop(0) # remove and return first item
me@1942:                         else: # stop_times[0]<start_times[0]: upcoming event is 'stop'
me@1942:                             # draw playing segment (red) from segment_start to 'stop'
me@1942:                             currently_playing = True
me@1942:                             segment_stop = stop_times.pop(0) # remove and return first item
me@1942:                             
me@1942:                         # draw segment
me@1942:                         plt.plot([segment_start, segment_stop], # x-values
me@1942:                             [previous_position, previous_position], # y-values
me@1942:                             color='r' if currently_playing else colormap[increment%len(colormap)],
me@1942:                             linewidth=3
me@1942:                         )
me@1942:                         segment_start = segment_stop # move on to next segment
me@1942:                         currently_playing = not currently_playing # toggle to draw final segment correctly
me@1942:                     
me@1942:                     # draw final segment (horizontal line) from last 'segment_start' to current move event time
me@1942:                     plt.plot([segment_start, audioholder_time-time_offset], # x-values
me@1942:                         [previous_position, previous_position], # y-values
me@1942:                         # color depends on playing during move event or not:
me@1942:                         color='r' if currently_playing else colormap[increment%len(colormap)], 
me@1942:                         linewidth=3
me@1942:                     )
me@1942:                     
me@1942: #                     plt.plot([previous_time, audioholder_time-time_offset], # x-values
me@1942: #                         [previous_position, previous_position], # y-values
me@1942: #                         color=colormap[increment%len(colormap)],
me@1942: #                         linewidth=3
me@1942: #                     )
me@1942:                     
me@1942:                     # display fragment name at end
me@1942:                     plt.text(audioholder_time-time_offset,previous_position,\
me@1942:                              audio_id,color=colormap[increment%len(colormap)]) #,rotation=45
me@1942:                         
me@1942:                 increment+=1 # to next audioelement
me@1942:             
me@1942:             last_audioholder_duration = audioholder_time-time_offset
me@1942:             time_offset = audioholder_time
me@1942:             
me@1942:             if not plot_empty: # if plot is not empty, show or store
me@1942:                 # set plot parameters
me@1942:                 plt.title('Timeline ' + file + ": "+page_name)
me@1942:                 plt.xlabel('Time [seconds]')
me@1942:                 plt.xlim(0, last_audioholder_duration)
me@1942:                 plt.ylabel('Rating') # default
me@1942:                 plt.ylim(0, 1) # rating between 0 and 1
me@1942:             
me@1942:                 #y-ticks: labels on rating axis
me@1942:                 label_positions = []
me@1942:                 label_text = []
me@1942:                 scale_tags = root.findall("./BrowserEvalProjectDocument/audioHolder/interface/scale")
me@1942:                 scale_title = root.find("./BrowserEvalProjectDocument/audioHolder/interface/title")
me@1942:                 for tag in scale_tags:
me@1942:                     label_positions.append(float(tag.get('position'))/100) # on a scale from 0 to 100
me@1942:                     label_text.append(tag.text)
me@1942:                 if len(label_positions) > 0: # if any labels available
me@1942:                     plt.yticks(label_positions, label_text) # show rating axis labels
me@1942:                 # set label Y-axis
me@1942:                 if scale_title is not None: 
me@1942:                     plt.ylabel(scale_title.text)
me@1942:             
me@1942:                 #plt.show() # uncomment to show plot; comment when just saving
me@1942:                 #exit()
me@1942:             
me@1942:                 plt.savefig(timeline_folder+subject_id+"-"+page_name+".pdf", bbox_inches='tight')
me@1942:                 plt.close()
me@1942: