Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reaper DAW Project Support #227

Merged
merged 6 commits into from
Jan 26, 2024
Merged

Reaper DAW Project Support #227

merged 6 commits into from
Jan 26, 2024

Conversation

DropSnorz
Copy link
Owner

@DropSnorz DropSnorz commented Jan 13, 2024

Resolves #219

Summary by CodeRabbit

  • New Features

    • Added support for Reaper DAW projects, including exploration and analysis.
    • Introduced parsing for Reaper project files (.rpp).
    • Added a custom H2 database dialect to support flexible enum handling.
    • Updated the application to recognize and handle Reaper as a new DAW application option.
  • Enhancements

    • Updated application defaults to include a new logo for Reaper.
  • Bug Fixes

    • Improved handling of enumerated fields in the database for plugin formats and types.
  • Documentation

    • Added new test cases for parsing Reaper project files.
  • Refactor

    • Implemented a new ProjectExplorer interface for file exploration.
    • Updated Hibernate dialect configuration to use the custom OwlPlug dialect.
  • Tests

    • Created new test resources for advanced and simple Reaper project files.

Copy link

coderabbitai bot commented Jan 13, 2024

Walkthrough

The changes reflect the introduction of support for Reaper (a Digital Audio Workstation) in OwlPlug. This includes the ability to parse .rpp project files, extract plugin references, and update the application to handle Reaper-specific data. Custom parsing logic and project file analysis for Reaper have been implemented, and the Hibernate dialect has been customized to accommodate changes in enumerated types without schema conflicts.

Changes

Files Change Summary
owlplug-client/src/main/java/com/owlplug/OwlPlugH2Dialect.java Introduces a custom H2 dialect that disables check conditions for enumerated values in Hibernate.
owlplug-client/src/main/java/com/owlplug/core/components/ApplicationDefaults.java Modifies ApplicationDefaults to include the declaration and initialization of a reaperLogoImage field and updates the getDAWApplicationIcon method for REAPER support.
owlplug-client/src/main/java/com/owlplug/core/model/Plugin.java, PluginComponent.java, PackageBundle.java, RemotePackage.java, RemoteSource.java, DawPlugin.java, DawPluginLookup.java Adds jakarta.persistence.EnumType and jakarta.persistence.Enumerated annotations for enum fields.
owlplug-client/src/main/java/com/owlplug/project/model/DawApplication.java Modifies the DawApplication enum to include a new constant REAPER.
owlplug-client/src/main/java/com/owlplug/project/tasks/ProjectSyncTask.java Extends functionality to support the exploration and analysis of Reaper project files in addition to Ableton project files.
owlplug-client/src/main/resources/application.properties Updates Hibernate dialect configuration to custom OwlPlugH2Dialect.
owlplug-parsers/src/main/antlr4/com/owlplug/parsers/reaper/ReaperProject.g4 Introduces a grammar for parsing Reaper project files.
owlplug-parsers/src/main/java/com/owlplug/parsers/reaper/PluginNodeListener.java, ReaperPlugin.java Introduces classes for parsing Reaper project files and maintaining plugin instances.
owlplug-parsers/src/test/java/com/owlplug/parsers/reaper/ReaperProjectGrammarTest.java, src/test/resources/reaper/... Adds test cases and resources for Reaper project file parsing.

Assessment against linked issues

Objective Addressed Explanation
Analyze Reaper project files (.rpp) and extract VST, VST3, AU references. (#219) The introduction of ReaperProjectExplorer and the related parsing classes indicates that Reaper project files can now be analyzed and plugin references can be extracted.
Support for a new DAW: Reaper in OwlPlug. (#219) The changes in the codebase, including the addition of REAPER in the DawApplication enum and the handling of Reaper project files, show that support for Reaper has been implemented.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@DropSnorz DropSnorz self-assigned this Jan 13, 2024
@DropSnorz DropSnorz changed the title Reaper DAW Support Reaper DAW Project Support Jan 13, 2024
@DropSnorz DropSnorz added the Type: Feature New Feature label Jan 13, 2024
@DropSnorz DropSnorz marked this pull request as ready for review January 24, 2024 22:18
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between f13aeb6 and 0a13e2f.
Files ignored due to path filters (4)
  • owlplug-client/pom.xml is excluded by: !**/*.xml
  • owlplug-client/src/main/resources/icons/reaper-white-16.png is excluded by: !**/*.png
  • owlplug-parsers/pom.xml is excluded by: !**/*.xml
  • pom.xml is excluded by: !**/*.xml
Files selected for processing (22)
  • owlplug-client/src/main/java/com/owlplug/OwlPlugH2Dialect.java (1 hunks)
  • owlplug-client/src/main/java/com/owlplug/core/components/ApplicationDefaults.java (2 hunks)
  • owlplug-client/src/main/java/com/owlplug/core/model/Plugin.java (2 hunks)
  • owlplug-client/src/main/java/com/owlplug/core/model/PluginComponent.java (2 hunks)
  • owlplug-client/src/main/java/com/owlplug/explore/model/PackageBundle.java (2 hunks)
  • owlplug-client/src/main/java/com/owlplug/explore/model/RemotePackage.java (2 hunks)
  • owlplug-client/src/main/java/com/owlplug/explore/model/RemoteSource.java (2 hunks)
  • owlplug-client/src/main/java/com/owlplug/project/model/DawApplication.java (1 hunks)
  • owlplug-client/src/main/java/com/owlplug/project/model/DawPlugin.java (2 hunks)
  • owlplug-client/src/main/java/com/owlplug/project/model/DawPluginLookup.java (2 hunks)
  • owlplug-client/src/main/java/com/owlplug/project/tasks/ProjectSyncTask.java (2 hunks)
  • owlplug-client/src/main/java/com/owlplug/project/tasks/discovery/ProjectExplorer.java (1 hunks)
  • owlplug-client/src/main/java/com/owlplug/project/tasks/discovery/ableton/AbletonProjectExplorer.java (2 hunks)
  • owlplug-client/src/main/java/com/owlplug/project/tasks/discovery/reaper/ReaperProjectExplorer.java (1 hunks)
  • owlplug-client/src/main/resources/application.properties (1 hunks)
  • owlplug-parsers/src/main/antlr4/com/owlplug/parsers/reaper/ReaperProject.g4 (1 hunks)
  • owlplug-parsers/src/main/java/com/owlplug/parsers/reaper/PluginNodeListener.java (1 hunks)
  • owlplug-parsers/src/main/java/com/owlplug/parsers/reaper/ReaperPlugin.java (1 hunks)
  • owlplug-parsers/src/test/java/com/owlplug/parsers/reaper/ReaperProjectGrammarTest.java (1 hunks)
  • owlplug-parsers/src/test/resources/reaper/advanced.rpp (1 hunks)
  • owlplug-parsers/src/test/resources/reaper/reaper7.rpp (1 hunks)
  • owlplug-parsers/src/test/resources/reaper/simpleReaperFile.rpp (1 hunks)
Additional comments: 23
owlplug-parsers/src/test/resources/reaper/simpleReaperFile.rpp (1)
  • 1-14: The provided Reaper project file example seems to be correctly formatted according to the .rpp file structure. No issues detected.
owlplug-parsers/src/main/antlr4/com/owlplug/parsers/reaper/ReaperProject.g4 (1)
  • 1-17: The grammar definition for parsing Reaper project files appears to be well-defined and follows the ANTLR4 syntax rules. No issues detected.
owlplug-client/src/main/java/com/owlplug/project/model/DawApplication.java (1)
  • 22-23: The addition of the REAPER constant to the DawApplication enum is correct and follows Java enum standards.
owlplug-client/src/main/java/com/owlplug/project/tasks/discovery/ProjectExplorer.java (1)
  • 25-30: The ProjectExplorer interface is correctly defined with methods that are essential for file exploration functionality. No issues detected.
owlplug-client/src/main/resources/application.properties (1)
  • 29-29: The update to the Hibernate dialect configuration in application.properties is correct and points to the custom dialect com.owlplug.OwlPlugH2Dialect.
owlplug-parsers/src/main/java/com/owlplug/parsers/reaper/ReaperPlugin.java (1)
  • 22-51: The ReaperPlugin class is well-structured with appropriate getters and setters for its fields. No issues detected.
owlplug-client/src/main/java/com/owlplug/OwlPlugH2Dialect.java (1)
  • 49-56: The custom H2 dialect class OwlPlugH2Dialect correctly overrides the getCheckCondition methods to return null, disabling check conditions as intended.
owlplug-client/src/main/java/com/owlplug/project/model/DawPluginLookup.java (1)
  • 47-47: The addition of the @Enumerated(EnumType.STRING) annotation to the result field in DawPluginLookup is correct and ensures that the enum values are persisted as strings in the database.
owlplug-client/src/main/java/com/owlplug/explore/model/RemoteSource.java (1)
  • 40-40: The addition of the @Enumerated(EnumType.STRING) annotation to the type field in RemoteSource is correct and ensures that the enum values are persisted as strings in the database.
owlplug-client/src/main/java/com/owlplug/project/tasks/ProjectSyncTask.java (1)
  • 68-83: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [71-93]

The extension of the ProjectSyncTask class to support Reaper project files is implemented correctly. The logic to determine whether a file is an Ableton or Reaper project and to process it accordingly is sound.

owlplug-client/src/main/java/com/owlplug/explore/model/PackageBundle.java (1)
  • 43-43: The addition of the @Enumerated(EnumType.STRING) annotation to the format field in PackageBundle is correct and ensures that the enum values are persisted as strings in the database.
owlplug-client/src/main/java/com/owlplug/core/model/PluginComponent.java (1)
  • 48-48: The addition of the @Enumerated(EnumType.STRING) annotation to the type field in PluginComponent is correct and ensures that the enum values are persisted as strings in the database.
owlplug-client/src/main/java/com/owlplug/project/model/DawPlugin.java (1)
  • 49-49: The addition of the @Enumerated(EnumType.STRING) annotation to the format field in DawPlugin is correct and ensures that the enum values are persisted as strings in the database.
owlplug-parsers/src/main/java/com/owlplug/parsers/reaper/PluginNodeListener.java (1)
  • 46-62: The PluginNodeListener class correctly identifies and processes VST nodes within the Reaper project file. The logic to extract plugin names, filenames, and raw IDs is implemented correctly.
owlplug-parsers/src/test/java/com/owlplug/parsers/reaper/ReaperProjectGrammarTest.java (1)
  • 34-98: The test cases in ReaperProjectGrammarTest are well-structured and seem to cover the basic scenarios for parsing Reaper project files. No issues detected.
owlplug-client/src/main/java/com/owlplug/project/tasks/discovery/reaper/ReaperProjectExplorer.java (1)
  • 46-101: The ReaperProjectExplorer class correctly implements the ProjectExplorer interface and contains logic to parse .rpp files and extract plugin information. The handling of file attributes and the creation of DawProject and DawPlugin instances are implemented correctly.
owlplug-client/src/main/java/com/owlplug/explore/model/RemotePackage.java (1)
  • 62-64: The addition of the @Enumerated(EnumType.STRING) annotations to the type and stage fields in RemotePackage is correct and ensures that the enum values are persisted as strings in the database.
owlplug-client/src/main/java/com/owlplug/project/tasks/discovery/ableton/AbletonProjectExplorer.java (1)
  • 55-55: The AbletonProjectExplorer class correctly implements the ProjectExplorer interface, which is evident from the correct method signatures and the logic within the explore method.
owlplug-client/src/main/java/com/owlplug/core/model/Plugin.java (1)
  • 25-26: The addition of jakarta.persistence.EnumType and jakarta.persistence.Enumerated annotations for the format and type fields is correct and follows best practices for JPA to ensure the enum values are stored as strings in the database.
owlplug-client/src/main/java/com/owlplug/core/components/ApplicationDefaults.java (2)
  • 79-79: The addition of the reaperLogoImage field is consistent with the existing pattern of initializing image resources for DAW logos. This change is necessary to support the new Reaper integration.
  • 173-173: The update to the getDAWApplicationIcon method to handle the REAPER case is correct and ensures that the Reaper logo is returned when requested. This change is aligned with the PR's objective to support Reaper DAW projects.
owlplug-parsers/src/test/resources/reaper/advanced.rpp (1)
  • 1-477: This file appears to be a sample Reaper project file included for testing purposes. It is important to ensure that the parser being developed can handle all the elements and attributes present in this file. Since this is a test resource file and not actual code, no specific code review comments are necessary unless there are discrepancies with the expected format for Reaper project files.
owlplug-parsers/src/test/resources/reaper/reaper7.rpp (1)
  • 1-278: The Reaper project file format appears to be correct and consistent with the XML-like structure that the custom parser in the OwlPlug application expects to process.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 0a13e2f and 906cbdd.
Files selected for processing (3)
  • owlplug-client/src/main/java/com/owlplug/project/tasks/discovery/ProjectExplorer.java (1 hunks)
  • owlplug-parsers/src/main/java/com/owlplug/parsers/reaper/PluginNodeListener.java (1 hunks)
  • owlplug-parsers/src/test/java/com/owlplug/parsers/reaper/ReaperProjectGrammarTest.java (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • owlplug-client/src/main/java/com/owlplug/project/tasks/discovery/ProjectExplorer.java
  • owlplug-parsers/src/main/java/com/owlplug/parsers/reaper/PluginNodeListener.java
  • owlplug-parsers/src/test/java/com/owlplug/parsers/reaper/ReaperProjectGrammarTest.java

@DropSnorz DropSnorz merged commit b579883 into dev Jan 26, 2024
3 checks passed
@DropSnorz DropSnorz linked an issue Feb 12, 2024 that may be closed by this pull request
@DropSnorz DropSnorz deleted the feat/reaper branch February 18, 2024 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Feature New Feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DAW Project Support: Reaper
1 participant