Skip to content

Commit

Permalink
Merge pull request #385 from Trinitou/move-and_rename-timestamp
Browse files Browse the repository at this point in the history
Rename clap_timestamp_t to clap_timestamp and move to separate header
  • Loading branch information
abique authored Jan 18, 2024
2 parents 2ed82ac + 897dac4 commit 2a98bd9
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 20 deletions.
1 change: 1 addition & 0 deletions ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Note: we kept the last draft factory ID in order to not break plugins already us
## Refactoring

* `clap_plugin_id_t` was renamed to `clap_universal_plugin_id_t` to make it clear that it can describe more than just a CLAP plugin ID.
* `clap_timestamp_t` was renamed to `clap_timestamp` to be consistent with other types, like e.g. `clap_id`. Also it was moved to a separate header as `CLAP_PRESET_DISCOVERY_FACTORY_ID` was stabilized.

## Documentation

Expand Down
31 changes: 11 additions & 20 deletions include/clap/factory/preset-discovery.h
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@

#include "../private/std.h"
#include "../private/macros.h"
#include "../timestamp.h"
#include "../version.h"
#include "../universal-plugin-id.h"

Expand Down Expand Up @@ -89,16 +90,6 @@ enum clap_preset_discovery_flags {
CLAP_PRESET_DISCOVERY_IS_FAVORITE = 1 << 3,
};

// TODO: move clap_timestamp_t, CLAP_TIMESTAMP_UNKNOWN and clap_plugin_id_t to parent files once we
// settle with preset discovery

// This type defines a timestamp: the number of seconds since UNIX EPOCH.
// See C's time_t time(time_t *).
typedef uint64_t clap_timestamp_t;

// Value for unknown timestamp.
static const clap_timestamp_t CLAP_TIMESTAMP_UNKNOWN = 0;

// Receiver that receives the metadata for a single preset file.
// The host would define the various callbacks in this interface and the preset parser function
// would then call them.
Expand Down Expand Up @@ -157,8 +148,8 @@ typedef struct clap_preset_discovery_metadata_receiver {
// If this function is not called, then the indexer may look at the file's creation and
// modification time.
void(CLAP_ABI *set_timestamps)(const struct clap_preset_discovery_metadata_receiver *receiver,
clap_timestamp_t creation_time,
clap_timestamp_t modification_time);
clap_timestamp creation_time,
clap_timestamp modification_time);

// Adds a feature to the preset.
//
Expand Down Expand Up @@ -204,14 +195,14 @@ typedef struct clap_preset_discovery_location {

// Describes an installed sound pack.
typedef struct clap_preset_discovery_soundpack {
uint32_t flags; // see enum clap_preset_discovery_flags
const char *id; // sound pack identifier
const char *name; // name of this sound pack
const char *description; // optional, reasonably short description of the sound pack
const char *homepage_url; // optional, url to the pack's homepage
const char *vendor; // optional, sound pack's vendor
const char *image_path; // optional, an image on disk
clap_timestamp_t release_timestamp; // release date, CLAP_TIMESTAMP_UNKNOWN if unavailable
uint32_t flags; // see enum clap_preset_discovery_flags
const char *id; // sound pack identifier
const char *name; // name of this sound pack
const char *description; // optional, reasonably short description of the sound pack
const char *homepage_url; // optional, url to the pack's homepage
const char *vendor; // optional, sound pack's vendor
const char *image_path; // optional, an image on disk
clap_timestamp release_timestamp; // release date, CLAP_TIMESTAMP_UNKNOWN if unavailable
} clap_preset_discovery_soundpack_t;

// Describes a preset provider
Expand Down
11 changes: 11 additions & 0 deletions include/clap/timestamp.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#pragma once

#include "private/std.h"
#include "private/macros.h"

// This type defines a timestamp: the number of seconds since UNIX EPOCH.
// See C's time_t time(time_t *).
typedef uint64_t clap_timestamp;

// Value for unknown timestamp.
static const CLAP_CONSTEXPR clap_timestamp CLAP_TIMESTAMP_UNKNOWN = 0;

0 comments on commit 2a98bd9

Please sign in to comment.