media-hud-looped - Set up looped from the HUD

[deyan]

• In the appearance HUD of the media frames there must be a checkbox allowing the user to loop its media frames.
• The checkbox must be labeled "Loop"
• When the checkbox is empty the media will play only once and then stops.
• When the checkbox is full the media will be looped.
• By default the media is looped.

[deyan]

Batch update from file 0911261.csv

[stefan]

Design

First and foremost, it is important to note that this ticket is closely related to few other tickets:

• #2180 - media-hud-controls - Toggle show of media controls. (this ticket is not implemented yet)
• #2198 - media-hud-clip - Set up clipping from the HUD (this ticket is implemented in the same branch as the current ticket's design.

In order to provide looping feature for the media files we made following changes:

• added KEY_LOOP key in the MediaFrameR4 class in order to provide persistence for the feature.
• a utility method for transforming seconds to milliseconds is added in MediaUtil class (in our case its not simple as multiplying by 1000, because there is condition that milliseconds must be divisible by 10). This method is also used in the #2198 ticket. The code is:

  public static long getMillis(double seconds) {
  		long millis = (long) (seconds * 1000 / AudioChunk.MILLIS_LEN) - 1;
  		return millis * AudioChunk.MILLIS_LEN;
  	}
  

• important method is added in the MediaFrameView class, which calculates/transforms the requested time (which, most of the time, is the time passed since creating/opening of the book) in time of the media file, in respect, of course, of looping and clipping. The code is as follows (it is clear and simple enough to provide needed explanation by itself):

  protected long calculatePosition(TimePos time) {
  		MediaState state = model().get().getMediaState(time);
  		long pos = state.getPosition();
  		long duration = MediaUtil.getMillis(handler().get().getInfo().getDuration());
  		long precede = 0;
  
  		if (model().get().isClipped()) {
  			MediaClip clip = model().get().getMediaClip();
  			if (clip.getEndSecond() >= 0) {
  				duration = MediaUtil.getMillis(clip.getEndSecond());
  			}
  			precede = MediaUtil.getMillis(clip.getStartSecond());
  			duration -= precede;
  		}
  		if (model().get().isLooped()) {
  			pos %= duration;
  		}
  		if (pos > duration) {
  			return -1;
  		}
  		return precede + pos;
  	}
  

[meddle]

Think it works, by the way why do you write sentences with a small letter??
I like that you add code to the design, but could you add and the JavaDoc?
And there is one thing, the ticket is some bug, so when you write design and put some methods in it write the use-cases in which they will be used, because it is hard to understand the reason you write them otherwise...

@todor : The analysis works I think, Stefan should have reviewed it...

WRITE YOUR NAMES IN THE FIELDS!!!

4p

[stefan]

It was mistake that I used small letters when listing the changes. Regarding the use-cases of the methods:

• calculatePosition(TimePos time) - as the name implies, it is used for calculating needed position in the media file in milliseconds(i.e. at which millisecond of the length of the media the given time is). If we are before or after the end of the file, and it is not looped, then we return -1, which means that there is not corresponding frame for the given time.
• getMillis(double seconds) - it is mainly used for transforming seconds to milliseconds of the duration of media files (it is kept in seconds), because in our application we use milliseconds for requesting frames from the media bridge/native.

Implementation code: [8291]

[stefan]

I'm sorry, I've forgotten the JavaDoc. It is as follows:

/**
 * Calculate position in milliseconds, while it considers clipping and
 * looping of the media;
 * 
 * @param time
 *            TimePos that is needed actual time for.
 *            
 * @return 
 * 			  Referential time in milliseconds in media.
 */
protected long calculatePosition(TimePos time) {
...
}

and

/**
 * Provides transforming from double to long with sligther different
 * accuracy.
 * 
 * @param seconds
 *            actual time in double.
 *            
 * @return same time in long (milliseconds);
*/
public static long getMillis(double seconds) {
...
}

[stefan]

Minor fix [8322]

[pap]

• Very bad JavaDoc for the class MediaClip itself.
• This class and its persister don't belong to base.media module - I moved them to main.func.media.
• Don't write ValueRefs that way. Override getInitial only if it is really necessary. Otherwise - see the JavaDoc of ValueRef.
• It seems that there is some sort of problems with media link actions and looping/clipping.
• Navigation with media slider doesn't work correct.
• In MediaLogic ON_PALY_PAUSE when calculating endTime you should use TimelineOptions.advance in order to have correct calculation of the phase.
• There were some places (timelines palette) and slider navigation that didn't consider clipping. That made me extract media length calculation in a method in MediaView.

[pap]

• Commited to trunk in [8349], [8351]

[meddle]

Closing all the tickets before M Y1