module AdventureRL
  class Clip < FileGroup
    IMAGE_FILENAME_REGEX = /\A\d+\.(png|jpe?g)\z/i
    INTERNAL_DEFAULT_SETTINGS = Settings.new({
      name:      :clip_name,
      directory: nil,
      fps:       24,
      audio:     false
    })
    @@default_settings = nil
    @@root_directory   = Pathname.new($0).dirname

    class << self
      # Set the root directory for the images directory.
      # All settings 'directory' values will be relative to this.
      # Defaults to the entry scripts (the script that was called, <tt>$0</tt>) directory.
      # Pass either a String with the directory path, or an instance of Pathname.
      def set_root_directory directory
        directory = Pathname.new directory  unless (directory.is_a? Pathname)
        @@root_directory = Pathname.new directory
      end
      alias_method :root=, :set_root_directory

      # Returns the currently set root images directory.
      def get_root_directory
        return @@root_directory
      end
      alias_method :root, :get_root_directory

      # Set the default Settings.
      # Pass either String to a YAML settings file,
      # or a Hash with your default settings.
      def set_default_settings settings
        default_settings = nil
        if    ([String, Pathname].include? settings.class)
          filepath = settings
          filepath = Pathname.new filepath  unless (filepath.is_a? Pathname)
          if (filepath.absolute?)
            default_settings = Settings.new filepath
          else
            if (File.file?(filepath))
              default_settings = Settings.new filepath
            else
              default_settings = Settings.new get_root_directory.join(filepath)
            end
          end
        elsif (settings.is_a? Hash)
          default_settings = Settings.new settings
        end
        @@default_settings = default_settings
      end
      alias_method :default_settings=, :set_default_settings
    end

    # Initialize with either a path to a YAML settings file as a String,
    # or a Hash containing your settings.
    def initialize settings
      super
      audio_settings = get_settings :audio
      @audio = load_audio audio_settings  if (audio_settings)
    end

    # Returns this Clip's Audio, if one was provided at #new.
    def get_audio
      return @audio
    end

    # Returns true if this Clip has Audio.
    def has_audio?
      return !!get_audio
    end

    private

      # Loads Audio, if one was provided
      def load_audio audio_settings
        return Audio.new audio_settings
      end

      # Returns this class' specific INTERNAL_DEFAULT_SETTINGS.
      def get_default_settings
        return INTERNAL_DEFAULT_SETTINGS.merge @@default_settings  if (@@default_settings)
        return INTERNAL_DEFAULT_SETTINGS
      end

      # Should return the regex which must match the filenames.
      def get_filename_regex
        return IMAGE_FILENAME_REGEX
      end
  end
end