rmov 0.1.0 → 0.1.1

data/CHANGELOG

@@ -1,3 +1,9 @@
+0.1.1 (October 3rd, 2008)
+
+* RubyGems 1.3 compatibility (updated Echoe)
+
+* fixing inline RDocs so call sequence is handled properly
+
 0.1.0 (October 2nd, 2008)
 
 * initial release

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('rmov', '0.1.0') do |p|
+Echoe.new('rmov', '0.1.1') do |p|
   p.summary        = "Ruby wrapper for the QuickTime C API."
   p.description    = "Ruby wrapper for the QuickTime C API."
   p.url            = "http://github.com/ryanb/rmov"

data/ext/exporter.c

@@ -14,10 +14,9 @@ static void exporter_mark(struct RExporter *rExporter)
 }
 
 /*
+  call-seq: new(movie) -> exporter
+  
   Creates a new exporter instance. Usually this is done through movie.exporter.
-
-call-seq:
-  new(movie) -> exporter
 */
 static VALUE exporter_new(VALUE klass)
 {
@@ -35,15 +34,14 @@ static ComponentInstance exporter_component(VALUE obj)
 }
 
 /*
+  call-seq: export_to_file(filepath)
+  
   Exports a movie to the given filepath. This will use either the 
   settings you set beforehand, or QuickTime's defaults.
 
   You can track the progress of this operation by passing a block to this 
   method. It will be called regularly during the process and pass the 
   percentage complete (0.0 to 1.0) as an argument to the block.
-
-call-seq:
-  export_to_file(filepath)
 */
 static VALUE exporter_export_to_file(VALUE obj, VALUE filepath)
 {
@@ -76,14 +74,13 @@ static VALUE exporter_export_to_file(VALUE obj, VALUE filepath)
 }
 
 /*
+  call-seq: open_settings_dialog()
+  
   Opens the offical QuickTime GUI settings dialog. The process will be 
   suspended until the user closes the dialogue. If the user clicks Okay 
   the settings will be applied to this Exporter. You can then use 
   save_settings to save them to a file, and load_settings to load them 
   back again.
-
-call-seq:
-  open_settings_dialog()
 */
 static VALUE exporter_open_settings_dialog(VALUE obj)
 {
@@ -126,10 +123,9 @@ static VALUE exporter_open_settings_dialog(VALUE obj)
 }
 
 /*
+  call-seq: load_settings(filepath)
+  
   Loads the settings at the given filepath. See save_settings.
-
-call-seq:
-  load_settings(filepath)
 */
 static VALUE exporter_load_settings(VALUE obj, VALUE filepath)
 {
@@ -164,11 +160,10 @@ static VALUE exporter_load_settings(VALUE obj, VALUE filepath)
 }
 
 /*
+  call-seq: save_settings(filepath)
+  
   Saves the settings to the given filepath (usually with .st extension). 
   See open_settings_dialog and load_settings.
-
-call-seq:
-  save_settings(filepath)
 */
 static VALUE exporter_save_settings(VALUE obj, VALUE filepath)
 {
@@ -191,6 +186,8 @@ static VALUE exporter_save_settings(VALUE obj, VALUE filepath)
 
 void Init_quicktime_exporter()
 {
+  VALUE mQuicktime;
+  mQuicktime = rb_define_module("Quicktime");
   cExporter = rb_define_class_under(mQuicktime, "Exporter", rb_cObject);
   rb_define_alloc_func(cExporter, exporter_new);
   rb_define_method(cExporter, "export", exporter_export_to_file, 1);

data/ext/movie.c

@@ -20,13 +20,12 @@ static void movie_mark(struct RMovie *rMovie)
 }
 
 /*
+  call-seq: new() -> movie
+  
   Creates a new movie instance. Generally you want to go through 
   Movie.open or Movie.empty to load or create a new movie respectively. 
   If you do no then you will need to load the movie with load_empty or 
   load_from_file before you can accomplish anything.
-
-call-seq:
-  new() -> movie
 */
 static VALUE movie_new(VALUE klass)
 {
@@ -35,13 +34,12 @@ static VALUE movie_new(VALUE klass)
 }
 
 /*
+  call-seq: dispose()
+  
   Dispose of the loaded QuickTime movie. This will automatically be done 
   when this movie instance is garbage collected. However if you are 
   iterating through many movies it is often helpful to dispose of it 
   as soon as you're done with it.
-
-call-seq:
-  dispose()
 */
 static VALUE movie_dispose(VALUE obj)
 {
@@ -53,12 +51,11 @@ static VALUE movie_dispose(VALUE obj)
 }
 
 /*
+  call-seq: load_from_file(filepath)
+  
   Loads a new, empty QuickTime movie at given filepath. Should only be 
   called if no movie has been loaded (or it has been disposed). Usually 
   you go through Movie.open.
-
-call-seq:
-  load_from_file(filepath)
 */
 static VALUE movie_load_from_file(VALUE obj, VALUE filepath)
 {
@@ -94,12 +91,11 @@ static VALUE movie_load_from_file(VALUE obj, VALUE filepath)
 }
 
 /*
+  call-seq: load_empty()
+  
   Loads a new, empty QuickTime movie. Should only be called if no movie 
   has been loaded (or it has been disposed). Usually you go through 
   Movie.empty.
-
-call-seq:
-  load_empty()
 */
 static VALUE movie_load_empty(VALUE obj)
 {
@@ -112,11 +108,10 @@ static VALUE movie_load_empty(VALUE obj)
 }
 
 /*
+  call-seq: raw_duration() -> duration_int
+  
   Returns the raw duration of the movie. Combine this with time_scale to 
   reach the duration in seconds.
-
-call-seq:
-  raw_duration() -> duration_int
 */
 static VALUE movie_raw_duration(VALUE obj)
 {
@@ -124,11 +119,10 @@ static VALUE movie_raw_duration(VALUE obj)
 }
 
 /*
+  call-seq: time_scale() -> scale_int
+  
   Returns the time scale of the movie. Usually only needed when working 
   with raw_duration.
-
-call-seq:
-  time_scale() -> scale_int
 */
 static VALUE movie_time_scale(VALUE obj)
 {
@@ -136,10 +130,10 @@ static VALUE movie_time_scale(VALUE obj)
 }
 
 /*
-  Returns the number of tracks in the movie.
-
-call-seq:
-  track_count() -> count
+  call-seq: bounds() -> bounds_hash
+  
+  Returns a hash of boundaries. The hash contains four keys: :left, :top, 
+  :right, :bottom. Each holds an integer representing the pixel value.
 */
 static VALUE movie_bounds(VALUE obj)
 {
@@ -154,10 +148,9 @@ static VALUE movie_bounds(VALUE obj)
 }
 
 /*
+  call-seq: track_count() -> count
+  
   Returns the number of tracks in the movie.
-
-call-seq:
-  track_count -> count
 */
 static VALUE movie_track_count(VALUE obj)
 {
@@ -165,14 +158,13 @@ static VALUE movie_track_count(VALUE obj)
 }
 
 /*
+  call-seq: composite_movie(movie, position)
+  
   Adds the tracks of given movie into called movie at given position (in seconds).
   
   You can track the progress of this operation by passing a block to this 
   method. It will be called regularly during the process and pass the 
   percentage complete (0.0 to 1.0) as an argument to the block.
-
-call-seq:
-  composite_movie(movie, position)
 */
 static VALUE movie_composite_movie(VALUE obj, VALUE src, VALUE position)
 {
@@ -189,14 +181,13 @@ static VALUE movie_composite_movie(VALUE obj, VALUE src, VALUE position)
 }
 
 /*
+  call-seq: append_movie(movie, position)
+  
   Inserts given movie into called movie at given position (in seconds).
 
   You can track the progress of this operation by passing a block to this 
   method. It will be called regularly during the process and pass the 
   percentage complete (0.0 to 1.0) as an argument to the block.
-
-call-seq:
-  append_movie(movie, position)
 */
 static VALUE movie_insert_movie(VALUE obj, VALUE src, VALUE position)
 {
@@ -213,14 +204,13 @@ static VALUE movie_insert_movie(VALUE obj, VALUE src, VALUE position)
 }
 
 /*
+  call-seq: append_movie(movie)
+  
   Adds given movie to the end of movie which this method is called on.
 
   You can track the progress of this operation by passing a block to this 
   method. It will be called regularly during the process and pass the 
   percentage complete (0.0 to 1.0) as an argument to the block.
-
-call-seq:
-  append_movie(movie)
 */
 static VALUE movie_append_movie(VALUE obj, VALUE src)
 {
@@ -237,11 +227,10 @@ static VALUE movie_append_movie(VALUE obj, VALUE src)
 }
 
 /*
+  call-seq: delete_section(start_time, duration)
+  
   Deletes given section from movie. Both start_time and duration 
   should be floats representing seconds.
-
-call-seq:
-  delete_section(start_time, duration)
 */
 static VALUE movie_delete_section(VALUE obj, VALUE start, VALUE duration)
 {
@@ -251,6 +240,8 @@ static VALUE movie_delete_section(VALUE obj, VALUE start, VALUE duration)
 }
 
 /*
+  call-seq: clone_section(start_time, duration) -> movie
+  
   Returns a new movie in the given section. Does not modify original 
   movie. Both start_time and duration should be floats representing 
   seconds.
@@ -258,9 +249,6 @@ static VALUE movie_delete_section(VALUE obj, VALUE start, VALUE duration)
   You can track the progress of this operation by passing a block to this 
   method. It will be called regularly during the process and pass the 
   percentage complete (0.0 to 1.0) as an argument to the block.
-
-call-seq:
-  clone_section(start_time, duration) -> movie
 */
 static VALUE movie_clone_section(VALUE obj, VALUE start, VALUE duration)
 {
@@ -279,6 +267,8 @@ static VALUE movie_clone_section(VALUE obj, VALUE start, VALUE duration)
 }
 
 /*
+  call-seq: clip_section(start_time, duration) -> movie
+  
   Deletes given section on movie and returns a new movie with that 
   section. Both start_time and duration should be floats representing 
   seconds.
@@ -286,9 +276,6 @@ static VALUE movie_clone_section(VALUE obj, VALUE start, VALUE duration)
   You can track the progress of this operation by passing a block to this 
   method. It will be called regularly during the process and pass the 
   percentage complete (0.0 to 1.0) as an argument to the block.
-
-call-seq:
-  clip_section(start_time, duration) -> movie
 */
 static VALUE movie_clip_section(VALUE obj, VALUE start, VALUE duration)
 {
@@ -307,11 +294,10 @@ static VALUE movie_clip_section(VALUE obj, VALUE start, VALUE duration)
 }
 
 /*
+  call-seq: changed?() -> bool
+  
   Determine if a movie has changed since opening. Returns true/false. 
   See reset_changed_status to reset this value.
-
-call-seq:
-  changed?() -> bool
 */
 static VALUE movie_changed(VALUE obj)
 {
@@ -323,10 +309,9 @@ static VALUE movie_changed(VALUE obj)
 }
 
 /*
+  call-seq: clear_changed_status()
+  
   Resets the "changed?" status. Does not revert the movie itself.
-
-call-seq:
-  clear_changed_status()
 */
 static VALUE movie_clear_changed_status(VALUE obj)
 {
@@ -336,12 +321,10 @@ static VALUE movie_clear_changed_status(VALUE obj)
 
 
 /*
+  call-seq: flatten(filepath)
+  
   Saves the movie to the given filepath by flattening it.
-
-call-seq:
-  flatten(filepath)
 */
-
 static VALUE movie_flatten(VALUE obj, VALUE filepath)
 {
   OSErr err;
@@ -363,12 +346,10 @@ static VALUE movie_flatten(VALUE obj, VALUE filepath)
 }
 
 /*
+  call-seq: export_pict(filepath, time)
+  
   Exports a PICT file to given filepath (should end in .pct) at the given 
   time. Time should be a floating point in seconds.
-
-call-seq:
-  export_pict(filepath, time)
-  
 */
 
 static VALUE movie_export_pict(VALUE obj, VALUE filepath, VALUE frame_time)
@@ -413,6 +394,8 @@ static VALUE movie_export_pict(VALUE obj, VALUE filepath, VALUE frame_time)
 
 void Init_quicktime_movie()
 {
+  VALUE mQuicktime;
+  mQuicktime = rb_define_module("Quicktime");
   cMovie = rb_define_class_under(mQuicktime, "Movie", rb_cObject);
   rb_define_alloc_func(cMovie, movie_new);
   rb_define_method(cMovie, "load_from_file", movie_load_from_file, 1);

data/ext/rmov_ext.c

@@ -1,11 +1,13 @@
 #include "rmov_ext.h"
 
-VALUE mQuicktime;
 VALUE eQuicktime;
 
 void Init_rmov_ext()
 {
+  VALUE mQuicktime;
+  
   EnterMovies(); // Enables the QuickTime framework
+  
   mQuicktime = rb_define_module("Quicktime");
   eQuicktime = rb_define_class_under(mQuicktime, "Error", rb_eStandardError);
   Init_quicktime_movie();

data/ext/rmov_ext.h

@@ -1,7 +1,7 @@
 #include <ruby.h>
 #include <QuickTime/QuickTime.h>
 
-extern VALUE mQuicktime, eQuicktime, cMovie, cTrack, cExporter;
+extern VALUE eQuicktime, cMovie, cTrack, cExporter;
 
 /*** MOVIE ***/
 

data/ext/track.c

@@ -11,11 +11,10 @@ static void track_mark(struct RTrack *rTrack)
 }
 
 /*
+  call-seq: new() -> track
+  
   Creates a new track instance. Generally you will do this through 
   movie.tracks to fetch the Track instances for a given movie.
-
-call-seq:
-  new() -> track
 */
 static VALUE track_new(VALUE klass)
 {
@@ -24,11 +23,10 @@ static VALUE track_new(VALUE klass)
 }
 
 /*
+  call-seq: load(movie, index)
+  
   Loads a QuickTime track from a given movie. This is done automatically 
   when calling movie.tracks.
-
-call-seq:
-  load(movie, index)
 */
 static VALUE track_load(VALUE obj, VALUE movie_obj, VALUE index_obj)
 {
@@ -40,11 +38,10 @@ static VALUE track_load(VALUE obj, VALUE movie_obj, VALUE index_obj)
 }
 
 /*
+  call-seq: raw_duration() -> duration_int
+  
   Returns the raw duration of the track. Combine this with time_scale to 
   reach the duration in seconds.
-
-call-seq:
-  raw_duration() -> duration_int
 */
 static VALUE track_raw_duration(VALUE obj)
 {
@@ -52,11 +49,10 @@ static VALUE track_raw_duration(VALUE obj)
 }
 
 /*
+  call-seq: time_scale() -> scale_int
+  
   Returns the time scale of the track. Usually only needed when working 
   with raw_duration.
-
-call-seq:
-  time_scale() -> scale_int
 */
 static VALUE track_time_scale(VALUE obj)
 {
@@ -64,10 +60,9 @@ static VALUE track_time_scale(VALUE obj)
 }
 
 /*
+  call-seq: frame_count() -> count
+  
   Returns the number of frames in the track.
-
-call-seq:
-  frame_count() -> count
 */
 static VALUE track_frame_count(VALUE obj)
 {
@@ -75,10 +70,9 @@ static VALUE track_frame_count(VALUE obj)
 }
 
 /*
+  call-seq: media_type() -> media_type_sym
+  
   Returns either :audio or :video depending on the type of track this is.
-
-call-seq:
-  media_type() -> media_type_sym
 */
 static VALUE track_media_type(VALUE obj)
 {
@@ -95,11 +89,10 @@ static VALUE track_media_type(VALUE obj)
 }
 
 /*
+  call-seq: id() -> quicktime_track_id_int
+  
   Returns either id number QuickTime uses to reference this track. 
   Usually only used internally.
-
-call-seq:
-  id() -> quicktime_track_id_int
 */
 static VALUE track_id(VALUE obj)
 {
@@ -107,10 +100,9 @@ static VALUE track_id(VALUE obj)
 }
 
 /*
+  call-seq: delete()
+  
   Removes the track from its movie and deletes it from memory.
-
-call-seq:
-  delete()
 */
 static VALUE track_delete(VALUE obj)
 {
@@ -119,10 +111,9 @@ static VALUE track_delete(VALUE obj)
 }
 
 /*
+  call-seq: disable()
+  
   Disables the track. See enabled? to determine if it's disabled already.
-
-call-seq:
-  disable()
 */
 static VALUE track_disable(VALUE obj, VALUE boolean)
 {
@@ -131,10 +122,9 @@ static VALUE track_disable(VALUE obj, VALUE boolean)
 }
 
 /*
+  call-seq: enable()
+  
   Enables the track. See enabled? to determine if it's enabled already.
-
-call-seq:
-  enable()
 */
 static VALUE track_enable(VALUE obj, VALUE boolean)
 {
@@ -143,10 +133,9 @@ static VALUE track_enable(VALUE obj, VALUE boolean)
 }
 
 /*
+  call-seq: enabled?() -> bool
+  
   Returns true/false depending on if the track is enabled.
-
-call-seq:
-  enabled?() -> bool
 */
 static VALUE track_enabled(VALUE obj, VALUE boolean)
 {
@@ -159,6 +148,8 @@ static VALUE track_enabled(VALUE obj, VALUE boolean)
 
 void Init_quicktime_track()
 {
+  VALUE mQuicktime;
+  mQuicktime = rb_define_module("Quicktime");
   cTrack = rb_define_class_under(mQuicktime, "Track", rb_cObject);
   rb_define_alloc_func(cTrack, track_new);
   rb_define_method(cTrack, "load_from_movie", track_load, 2);

data/rmov.gemspec

@@ -1,18 +1,18 @@
 
-# Gem::Specification for Rmov-0.1.0
+# Gem::Specification for Rmov-0.1.1
 # Originally generated by Echoe
 
 --- !ruby/object:Gem::Specification 
 name: rmov
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Ryan Bates
 autorequire: 
 bindir: bin
 
-date: 2008-10-02 00:00:00 -07:00
+date: 2008-10-03 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -88,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - "="
+  - - ">="
     - !ruby/object:Gem::Version 
       version: "1.2"
   version: 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rmov
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Ryan Bates
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-02 00:00:00 -07:00
+date: 2008-10-03 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -85,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - "="
+  - - ">="
     - !ruby/object:Gem::Version 
       version: "1.2"
   version: