aviglitch 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bcaf49d8305bd36386f606954fe702468fc5196e30b0d5e4f3dea11f0bfb8a7
-  data.tar.gz: a1ede07ce50e3005abcd505e501ddf8f73c18b0241d7b34834ac78781d76e389
+  metadata.gz: 1d39333c753326230a28e3ecde64dfee176af851c53fd1b185a10797e90bbdd0
+  data.tar.gz: dfb9e4b6613a38c7da422ac82ebf100c12bf84fee40cfc44d899950e547f13d6
 SHA512:
-  metadata.gz: b9a0c0905f0131bec187618e48e7281eac79d01d6067a66dad82bafbc2c923d84bd7472738b147fc2866ee1f5ef14b1064556e05b7109a7ffef5a0c73370ec6f
-  data.tar.gz: f698216510d97cf7713e14127cf75af8264c5c003fa876caed72e51168575eb75e0dba05930ff22c6a145c0da9a0967da9959dfc65d0276909e9db081ba6810c
+  metadata.gz: 9df626227e793840d861bd26510323d315024278bfd4dedc7a4d5a147aef2e92ccd5d7cb0564ad8b743e6c1d2c5fea70f9858c86fcefa4f2434869169df1a2c2
+  data.tar.gz: de1adf2790a8c7250e2db4f73bf45b7884b1f1797069ba05899b1f3cb5cd0930d89698ba7d9959099e73e15cd937f83bf3f86939528bdc4310cb4e3c6c82880e

data/.github/workflows/ruby.yml

@@ -1,35 +1,19 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
 name: test
-
 on:
   push:
     branches: [ master ]
   pull_request:
     branches: [ master ]
-
 jobs:
   test:
-
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
-
+        ruby-version: ['3.3']
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake
+        bundler-cache: true
+    - run: bundle exec rake

data/ChangeLog.md

@@ -1,3 +1,9 @@
+### 0.2.2 / 2024-07-20
+
+* Added option to set a custom directory for temporary files that internally duplicate input files.
+* Also added an option for the custom temp directory in the datamosh cli.
+* Some improvements regarding internal temporary files.
+
 ### 0.2.0 / 2021-09-13
 
 * Support for AVI2.0 formatted files. Now this library can handle files larger than 1GB.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2021 ucnv
+Copyright (c) 2009-2024 ucnv
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/bin/datamosh

@@ -8,6 +8,7 @@ require 'aviglitch'
 output = './out.avi'
 all = false
 fake = false
+tmpdir = nil
 
 opts = OptionParser.new do |opts|
   opts.banner = "datamosh - AviGlitch's datamoshing video generator."
@@ -28,10 +29,14 @@ opts = OptionParser.new do |opts|
       exit
     end
   end
+  opts.on("--tmpdir [DIR]", "Specify the temporary directory") do |dir| 
+    tmpdir = dir
+  end
   opts.on_tail("-h", "--help", "Show this message") do
     puts opts
     exit
   end
+  opts.version = AviGlitch::VERSION
 end
 
 input = opts.parse!
@@ -48,7 +53,7 @@ else
   end
 end
 
-a = AviGlitch.open input.shift
+a = AviGlitch.open input.shift, tmpdir: tmpdir
 unless fake
   a.glitch_with_index :keyframe do |frame, i|
     (!all && i == 0) ? frame : "" # keep the first frame
@@ -62,7 +67,7 @@ else
 end
 
 input.each do |file|
-  b = AviGlitch.open file
+  b = AviGlitch.open file, tmpdir: tmpdir
   unless fake
     b.glitch :keyframe do |frame|
       ""

data/lib/aviglitch/avi.rb

@@ -79,16 +79,22 @@ module AviGlitch
     # Object which represents RIFF structure.
     attr_accessor :riff
 
-    attr_accessor :path, :movi #:nodoc:
+    attr_accessor :path, :movi, :tmpdir #:nodoc:
     protected :path, :path=, :movi, :movi=
 
     ##
-    # Generates an instance with the necessary structure from the +path+.
+    # Generates an instance.
     def initialize path = nil
-      return if path.nil?
+      return unless @movi.nil? # don't reconfigure the path when cloning
+      self.path = path unless path.nil?
+    end
+
+    ##
+    # Set +path+ of the source file.
+    def path= path #:nodoc:
       @path = path
       File.open(path, 'rb') do |io|
-        @movi = Tempfile.new 'aviglitch', binmode: true
+        @movi = Tempfile.new 'aviglitch', @tmpdir, binmode: true
         @riff = []
         @indices = []
         @superidx = []
@@ -390,18 +396,19 @@ module AviGlitch
     end
 
     def initialize_copy avi #:nodoc:
-      avi.path = @path.dup
-      md = Marshal.dump @indices
-      avi.indices = Marshal.load md
-      md = Marshal.dump @riff
-      avi.riff = Marshal.load md
-      newmovi = Tempfile.new 'aviglitch', binmode: true
-      movipos = @movi.pos
-      @movi.rewind
-      newmovi.print @movi.read
-      @movi.pos = movipos
+      md = Marshal.dump avi.indices
+      @indices = Marshal.load md
+      md = Marshal.dump avi.riff
+      @riff = Marshal.load md
+      newmovi = Tempfile.new 'aviglitch-clone', @tmpdir, binmode: true
+      movipos = avi.movi.pos
+      avi.movi.rewind
+      while d = avi.movi.read(BUFFER_SIZE) do
+        newmovi.print d
+      end
+      avi.movi.pos = movipos
       newmovi.rewind
-      avi.movi = newmovi
+      @movi = newmovi
     end
 
     def print_chunk io, chunk  #:nodoc:

data/lib/aviglitch/base.rb

@@ -14,14 +14,16 @@ module AviGlitch
     # Creates a new instance of AviGlitch::Base, open the file and 
     # make it ready to manipulate.
     # It requires +path+ as Pathname or an instance of AviGlirtch::Avi.
-    def initialize path_or_object
+    def initialize path_or_object, tmpdir: nil
       if path_or_object.kind_of?(Avi)
         @avi = path_or_object
       else
         unless AviGlitch::Base.surely_formatted? path_or_object
           raise 'Unsupported file passed.'
         end
-        @avi = Avi.new path_or_object
+        @avi = Avi.new 
+        @avi.tmpdir = tmpdir
+        @avi.path = path_or_object
       end
       @frames = Frames.new @avi
     end

data/lib/aviglitch/frames.rb

@@ -22,6 +22,7 @@ module AviGlitch
 
     ##
     # Creates a new AviGlitch::Frames object.
+    # It takes AviGlitch::Avi as an argument.
     def initialize avi
       @avi = avi
     end
@@ -31,7 +32,7 @@ module AviGlitch
     # It returns Enumerator if a block is not given.
     def each &block
       if block_given?
-        Tempfile.open('temp', binmode: true) do |newmovi|
+        Tempfile.open('aviglitch-temp', @avi.tmpdir, binmode: true) do |newmovi|
           @avi.process_movi do |indices, movi|
             newindices = indices.select do |m|
               movi.pos = m[:offset] + 8    # 8 for id and size
@@ -136,6 +137,7 @@ module AviGlitch
       times.times do
         result.concat frames
       end
+      frames.terminate
       result
     end
 
@@ -175,7 +177,12 @@ module AviGlitch
       l = 1 if l.nil?
       tail = self.slice((b + l)..-1)
       self.clear
-      self.concat head + tail
+      temp = head + tail
+      self.concat temp
+      temp.terminate
+      head.terminate
+      tail.terminate
+      
       sliced
     end
 
@@ -199,6 +206,10 @@ module AviGlitch
 
       self.clear
       self.concat new_frames
+      
+      new_frames.terminate
+      head.terminate
+      rest.terminate
     end
 
     ##
@@ -342,6 +353,7 @@ module AviGlitch
 
       self.clear
       self.concat new_frames
+      new_frames.terminate
       self
     end
 
@@ -369,6 +381,13 @@ module AviGlitch
       @avi == other.avi
     end
 
+    ##
+    # Closes the internal temp file explicitly. This instance becomes unusable.
+    def terminate
+      @avi.close
+      @avi = nil
+    end
+
     ##
     # Generates new AviGlitch::Base instance using self.
     def to_avi

data/lib/aviglitch.rb

@@ -28,9 +28,16 @@ require 'aviglitch/frames'
 #   end
 #   avi.output '/path/to/broken.avi'
 #
+# Since v0.2.2, it allows to specify the temporary directory. This library
+# duplicates and processes a input file in the temporary directory, which
+# by default is +Dir.tmpdir+. To specify the custom temporary directory, use 
+# +tmpdir:+ option, like:
+#
+#   avi = AviGlitch.open '/path/to/your.avi', tmpdir: '/path/to/tmpdir'
+#
 module AviGlitch
 
-  VERSION = '0.2.0'
+  VERSION = '0.2.2'
 
   BUFFER_SIZE = 2 ** 24
 
@@ -38,11 +45,12 @@ module AviGlitch
     ##
     # Returns AviGlitch::Base instance.
     # It requires +path_or_frames+ as String or Pathname, or Frames instance.
-    def open path_or_frames
+    # Additionally, it allows +tmpdir:+ as the internal temporary directory.
+    def open path_or_frames, tmpdir: nil
       if path_or_frames.kind_of?(Frames)
         path_or_frames.to_avi
       else
-        AviGlitch::Base.new(Pathname(path_or_frames))
+        AviGlitch::Base.new(Pathname(path_or_frames), tmpdir: tmpdir)
       end
     end
   end

data/spec/avi2_spec.rb

@@ -31,6 +31,7 @@ describe AviGlitch, 'AVI2.0' do
     n.times do
       fx = f[0..-1]
       f.concat fx
+      fx.terminate
     end
     f.to_avi.output @out
     b = AviGlitch.open @out

data/spec/aviglitch_spec.rb

@@ -92,7 +92,7 @@ describe AviGlitch do
     }.should raise_error(IOError)
   end
 
-  it 'can explicit close file' do
+  it 'can close the file explicitly' do
     avi = AviGlitch.open @in
     avi.close
     lambda {
@@ -160,7 +160,7 @@ describe AviGlitch do
     end
   end
 
-  it 'should check if keyframes exist.' do
+  it 'should check if keyframes exist' do
     a = AviGlitch.open @in
     a.has_keyframe?.should be true
     a.glitch :keyframe do |f|
@@ -190,5 +190,24 @@ describe AviGlitch do
 
     expect(dc1).to eq(dc2)
   end
+
+  it 'can be set custom temp dir' do
+    custom_tmpdir = Pathname.new(OUTPUT_DIR) + 'custom_tmpdir'
+    Dir.mkdir custom_tmpdir unless File.exist? custom_tmpdir
+
+    c = Dir.glob((custom_tmpdir + '*').to_s).size
+    b = AviGlitch.open @in, tmpdir: custom_tmpdir
+    b2 = b.frames[0, 100].to_avi
+    b2.frames.each do |f|
+      Dir.glob((custom_tmpdir + '*').to_s).size.should >= c
+    end
+  end
+
+  it 'shoud raise an error when specified temp dir is not writable' do
+    custom_tmpdir = Pathname.new(OUTPUT_DIR) + 'not_dir'
+    lambda {
+      AviGlitch.open @in, tmpdir: custom_tmpdir
+    }.should raise_error(SystemCallError)
+  end
   
 end

data/spec/frames_spec.rb

@@ -1,6 +1,9 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe AviGlitch::Frames do
+# Since Ruby 3.3.x, Windows frequently fails to close the Tempfile on GC.
+# Although not a fatal error, it should be better to remove them manually in such cases.
+# Now this spec is skipped in Windows because it could generate a lot of warning messages and undeleted temp files.
+describe AviGlitch::Frames, :skip => Gem.win_platform? do
 
   before :all do
     AviGlitch::Frames.class_eval do
@@ -479,8 +482,7 @@ describe AviGlitch::Frames do
     expect(File.size(@out)).to be < File.size(@in)
   end
 
-  it 'should use Enumerator as an external iterator',
-     :skip => Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('1.9.0') || RUBY_PLATFORM == 'java' do
+  it 'should use Enumerator as an external iterator' do
     a = AviGlitch.open @in
     e = a.frames.each
     expect {

data/spec/spec_helper.rb

@@ -50,6 +50,10 @@ RSpec.configure do |config|
   end
 
   config.after(:each) do
-    FileUtils.rm Dir.glob((OUTPUT_DIR + '*').to_s)
+    begin
+      FileUtils.rm_r Dir.glob((OUTPUT_DIR + '*').to_s)
+    rescue => e
+      # Sometimes windows can't remove files.
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aviglitch
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - ucnv
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-13 00:00:00.000000000 Z
+date: 2024-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A Ruby library to destroy your AVI files.