Skip to content

Commit 9b02ee6

Browse files
authored
Merge pull request #188 from contentauth/rename/c2pa-c-to-c2pa-cpp
chore: rename project from c2pa-c to c2pa-cpp
2 parents 13a0b5f + 5b298a7 commit 9b02ee6

File tree

8 files changed

+30
-30
lines changed

8 files changed

+30
-30
lines changed

Doxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
PROJECT_NAME = "c2pa-c"
2-
PROJECT_BRIEF = "C++ API for c2pa-c library"
1+
PROJECT_NAME = "c2pa-cpp"
2+
PROJECT_BRIEF = "C++ API for the C2PA SDK"
33
OUTPUT_DIRECTORY = api-docs/_build
44
CREATE_SUBDIRS = YES
55
GENERATE_HTML = YES

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CAI SDK C++ library
22

3-
The [c2pa-c repository](https://github.com/contentauth/c2pa-c) implements C++ APIs that:
3+
The [c2pa-cpp repository](https://github.com/contentauth/c2pa-cpp) implements C++ APIs that:
44
- Read and validate C2PA data from media files in supported formats.
55
- Add signed manifests to media files in supported formats.
66

@@ -34,7 +34,7 @@ include(FetchContent)
3434
3535
FetchContent_Declare(
3636
c2pa_cpp
37-
GIT_REPOSITORY https://github.com/contentauth/c2pa-c.git
37+
GIT_REPOSITORY https://github.com/contentauth/c2pa-cpp.git
3838
GIT_TAG main # Or use a specific release tag
3939
)
4040
FetchContent_MakeAvailable(c2pa_cpp)
@@ -103,7 +103,7 @@ export LD_LIBRARY_PATH="$(pwd)/build/release/tests:$LD_LIBRARY_PATH"
103103

104104
### Testing
105105

106-
Build the [unit tests](https://github.com/contentauth/c2pa-c/tree/main/tests) by entering this `make` command:
106+
Build the [unit tests](https://github.com/contentauth/c2pa-cpp/tree/main/tests) by entering this `make` command:
107107

108108
```
109109
make test
@@ -115,8 +115,8 @@ API documentation generated by Doxygen is automatically built on each PR.
115115

116116
To generate API docs locally, these are the main files:
117117

118-
- Configuration file: `c2pa-c/Doxyfile`
119-
- Script: `c2pa-c/scripts/generate_api_docs.sh`
118+
- Configuration file: `c2pa-cpp/Doxyfile`
119+
- Script: `c2pa-cpp/scripts/generate_api_docs.sh`
120120
- Output directory: `docs/_build/html`
121121

122122
Install Doxygen if needed:
@@ -138,10 +138,10 @@ Open `_build/html/index.html` to see the results.
138138

139139
## License
140140

141-
This package is distributed under the terms of both the [MIT license](https://github.com/contentauth/c2pa-c/blob/main/LICENSE-MIT) and the [Apache License (Version 2.0)](https://github.com/contentauth/c2pa-c/blob/main/LICENSE-APACHE).
141+
This package is distributed under the terms of both the [MIT license](https://github.com/contentauth/c2pa-cpp/blob/main/LICENSE-MIT) and the [Apache License (Version 2.0)](https://github.com/contentauth/c2pa-cpp/blob/main/LICENSE-APACHE).
142142

143143
Note that some components and dependent crates are licensed under different terms; please check the license terms for each crate and component for details.
144144

145145
### Contributions and feedback
146146

147-
We welcome contributions to this project. For information on contributing, providing feedback, and about ongoing work, see [Contributing](https://github.com/contentauth/c2pa-c/blob/main/CONTRIBUTING.md).
147+
We welcome contributions to this project. For information on contributing, providing feedback, and about ongoing work, see [Contributing](https://github.com/contentauth/c2pa-cpp/blob/main/CONTRIBUTING.md).

ci-cd/amalgam-build.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# c2pa-c amalgam build
1+
# c2pa-cpp amalgam build
22

33
## Overview
44

@@ -160,7 +160,7 @@ the shared library at runtime without needing `LD_LIBRARY_PATH`.
160160
Add this project as a subdirectory in the CMakeLists.txt:
161161

162162
```cmake
163-
add_subdirectory(path/to/c2pa-c)
163+
add_subdirectory(path/to/c2pa-cpp)
164164
target_link_libraries(your_target PRIVATE c2pa_cpp)
165165
```
166166

docs/context-settings.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -440,12 +440,12 @@ The `Settings` class provides methods for creating and manipulating configuratio
440440
441441
| Method | Description |
442442
|--------|-------------|
443-
| [`Settings()`](https://contentauth.github.io/c2pa-c/da/d96/classc2pa_1_1Settings.html#a70274281f05d59ddcfda4aa21397b896) | Create default settings |
444-
| [`Settings(data, format)`](https://contentauth.github.io/c2pa-c/da/d96/classc2pa_1_1Settings.html#a695e6e8c5a8cf16e40d6522af1fc13dd) | Parse settings from a string. Format is `"json"` or `"toml"` |
445-
| [`set(path, json_value)`](https://contentauth.github.io/c2pa-c/da/d96/classc2pa_1_1Settings.html#a13810c5df3183aa2b0132e3c7c8edd1c) | Set a value by dot-separated path (e.g., `"verify.verify_after_sign"`). Value must be JSON-encoded. Returns `*this` for chaining |
446-
| [`update(data)`](https://contentauth.github.io/c2pa-c/da/d96/classc2pa_1_1Settings.html#a1bd09762fb2e6c4c937c814500826ecc) | Merge JSON configuration (same as `update(data, "json")`) |
447-
| [`update(data, format)`](https://contentauth.github.io/c2pa-c/da/d96/classc2pa_1_1Settings.html#a80a12a51569bd89cc18231c7c9c36242) | Merge configuration from a string with specified format |
448-
| [`is_valid()`](https://contentauth.github.io/c2pa-c/da/d96/classc2pa_1_1Settings.html#add51c3e2ef459978be035b86803b338e) | Returns `true` if the object is valid (not moved-from) |
443+
| [`Settings()`](https://contentauth.github.io/c2pa-cpp/da/d96/classc2pa_1_1Settings.html#a70274281f05d59ddcfda4aa21397b896) | Create default settings |
444+
| [`Settings(data, format)`](https://contentauth.github.io/c2pa-cpp/da/d96/classc2pa_1_1Settings.html#a695e6e8c5a8cf16e40d6522af1fc13dd) | Parse settings from a string. Format is `"json"` or `"toml"` |
445+
| [`set(path, json_value)`](https://contentauth.github.io/c2pa-cpp/da/d96/classc2pa_1_1Settings.html#a13810c5df3183aa2b0132e3c7c8edd1c) | Set a value by dot-separated path (e.g., `"verify.verify_after_sign"`). Value must be JSON-encoded. Returns `*this` for chaining |
446+
| [`update(data)`](https://contentauth.github.io/c2pa-cpp/da/d96/classc2pa_1_1Settings.html#a1bd09762fb2e6c4c937c814500826ecc) | Merge JSON configuration (same as `update(data, "json")`) |
447+
| [`update(data, format)`](https://contentauth.github.io/c2pa-cpp/da/d96/classc2pa_1_1Settings.html#a80a12a51569bd89cc18231c7c9c36242) | Merge configuration from a string with specified format |
448+
| [`is_valid()`](https://contentauth.github.io/c2pa-cpp/da/d96/classc2pa_1_1Settings.html#add51c3e2ef459978be035b86803b338e) | Returns `true` if the object is valid (not moved-from) |
449449
450450
> [!NOTE]
451451
>

docs/intents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ Enum values are in the global namespace:
209209

210210
### Using `set_intent`
211211

212-
Use the `Builder` [`set_intent`](https://contentauth.github.io/c2pa-c/da/db7/classc2pa_1_1Builder.html#ac3ca980a43f44c9349ac0d6de50a088c) method to specify the intent:
212+
Use the `Builder` [`set_intent`](https://contentauth.github.io/c2pa-cpp/da/db7/classc2pa_1_1Builder.html#ac3ca980a43f44c9349ac0d6de50a088c) method to specify the intent:
213213

214214
```cpp
215215
void Builder::set_intent(

docs/usage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ ifs.close();
4343
4444
The manifest JSON string defines the C2PA manifest to add to the file.
4545
46-
A sample JSON manifest is provided in [tests/fixtures/training.json](https://github.com/contentauth/c2pa-c/blob/main/tests/fixtures/training.json).
46+
A sample JSON manifest is provided in [tests/fixtures/training.json](https://github.com/contentauth/c2pa-cpp/blob/main/tests/fixtures/training.json).
4747
4848
For example:
4949
@@ -196,14 +196,14 @@ Trust affects manifest validation status: a manifest whose trust chain was verif
196196

197197
## More examples
198198

199-
The C++ example in [`examples/training.cpp`](https://github.com/contentauth/c2pa-c/blob/main/examples/training.cpp) uses the [JSON for Modern C++](https://json.nlohmann.me/) library class.
199+
The C++ example in [`examples/training.cpp`](https://github.com/contentauth/c2pa-cpp/blob/main/examples/training.cpp) uses the [JSON for Modern C++](https://json.nlohmann.me/) library class.
200200

201201
Build and run the example by entering this `make` command:
202202

203203
```
204204
make examples
205205
```
206206

207-
This example adds the manifest [`tests/fixtures/training.json`](https://github.com/contentauth/c2pa-c/blob/main/tests/fixtures/training.json) to the image file [`tests/fixtures/A.jpg`](https://github.com/contentauth/c2pa-c/blob/main/tests/fixtures/A.jpg) using the sample private key and certificate in the [`tests/fixtures`](https://github.com/contentauth/c2pa-c/tree/main/tests/fixtures) directory.
207+
This example adds the manifest [`tests/fixtures/training.json`](https://github.com/contentauth/c2pa-cpp/blob/main/tests/fixtures/training.json) to the image file [`tests/fixtures/A.jpg`](https://github.com/contentauth/c2pa-cpp/blob/main/tests/fixtures/A.jpg) using the sample private key and certificate in the [`tests/fixtures`](https://github.com/contentauth/c2pa-cpp/tree/main/tests/fixtures) directory.
208208

209209
The example displays some text to standard out that summarizes whether AI training is allowed based on the specified manifest and then saves the resulting image file with attached manifest to `build/examples/training.jpg`.

docs/working-stores.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ This table summarizes the fundamental entities that you work with when using the
44

55
| Object | Description | Where it is | Primary API |
66
|--------|-------------|-------------|-------------|
7-
| [**Manifest store**](#manifest-store) | Final signed provenance data. Contains one or more manifests. | Embedded in asset or remotely in cloud | [`Reader`](https://contentauth.github.io/c2pa-c/d9/dbb/classc2pa_1_1Reader.html) class |
8-
| [**Working store**](#working-store) | Editable in-progress manifest. | `Builder` object | [`Builder`](https://contentauth.github.io/c2pa-c/da/db7/classc2pa_1_1Builder.html) class |
9-
| [**Archive**](#archive) | Serialized working store | `.c2pa` file/stream | [`Builder::to_archive()`](https://contentauth.github.io/c2pa-c/da/db7/classc2pa_1_1Builder.html#a68074eac71b7fc57d338019220101db3)<br/> [`Builder::from_archive()`](https://contentauth.github.io/c2pa-c/da/db7/classc2pa_1_1Builder.html#a913c64f6b5ec978322ef0edc89e407b3) |
10-
| [**Resources**](#working-with-resources) | Binary assets referenced by manifest assertions, such as thumbnails or ingredient thumbnails. | In manifest. | [`Builder::add_resource()`](https://contentauth.github.io/c2pa-c/da/db7/classc2pa_1_1Builder.html#a45bf6fc8163b0194b334aa21f73f8476) <br/> [`Reader::get_resource`](https://contentauth.github.io/c2pa-c/d9/dbb/classc2pa_1_1Reader.html#a308939c990cab98bf8435c699bc96096) |
11-
| [**Ingredients**](#working-with-ingredients) | Source materials used to create an asset. | In manifest. | [`builder.add_ingredient`](https://contentauth.github.io/c2pa-c/da/db7/classc2pa_1_1Builder.html#a49407f9604a53b5b68bcfa699cba05f5)
7+
| [**Manifest store**](#manifest-store) | Final signed provenance data. Contains one or more manifests. | Embedded in asset or remotely in cloud | [`Reader`](https://contentauth.github.io/c2pa-cpp/d9/dbb/classc2pa_1_1Reader.html) class |
8+
| [**Working store**](#working-store) | Editable in-progress manifest. | `Builder` object | [`Builder`](https://contentauth.github.io/c2pa-cpp/da/db7/classc2pa_1_1Builder.html) class |
9+
| [**Archive**](#archive) | Serialized working store | `.c2pa` file/stream | [`Builder::to_archive()`](https://contentauth.github.io/c2pa-cpp/da/db7/classc2pa_1_1Builder.html#a68074eac71b7fc57d338019220101db3)<br/> [`Builder::from_archive()`](https://contentauth.github.io/c2pa-cpp/da/db7/classc2pa_1_1Builder.html#a913c64f6b5ec978322ef0edc89e407b3) |
10+
| [**Resources**](#working-with-resources) | Binary assets referenced by manifest assertions, such as thumbnails or ingredient thumbnails. | In manifest. | [`Builder::add_resource()`](https://contentauth.github.io/c2pa-cpp/da/db7/classc2pa_1_1Builder.html#a45bf6fc8163b0194b334aa21f73f8476) <br/> [`Reader::get_resource`](https://contentauth.github.io/c2pa-cpp/d9/dbb/classc2pa_1_1Reader.html#a308939c990cab98bf8435c699bc96096) |
11+
| [**Ingredients**](#working-with-ingredients) | Source materials used to create an asset. | In manifest. | [`builder.add_ingredient`](https://contentauth.github.io/c2pa-cpp/da/db7/classc2pa_1_1Builder.html#a49407f9604a53b5b68bcfa699cba05f5)
1212

1313
This diagram summarizes the relationships among these entities.
1414

@@ -67,7 +67,7 @@ A _C2PA archive_ (or just _archive_) contains the serialized bytes of a working
6767
**Characteristics:**
6868

6969
- Portable serialization of a working store (Builder).
70-
- Save an archive by using [`Builder::to_archive()`](https://contentauth.github.io/c2pa-c/da/db7/classc2pa_1_1Builder.html#a68074eac71b7fc57d338019220101db3) and restore a full working store from an archive by using [`Builder::from_archive()`](https://contentauth.github.io/c2pa-c/da/db7/classc2pa_1_1Builder.html#a913c64f6b5ec978322ef0edc89e407b3).
70+
- Save an archive by using [`Builder::to_archive()`](https://contentauth.github.io/c2pa-cpp/da/db7/classc2pa_1_1Builder.html#a68074eac71b7fc57d338019220101db3) and restore a full working store from an archive by using [`Builder::from_archive()`](https://contentauth.github.io/c2pa-cpp/da/db7/classc2pa_1_1Builder.html#a913c64f6b5ec978322ef0edc89e407b3).
7171
- Useful for separating manifest preparation ("work in progress") from final signing.
7272

7373
For more information, see [Working with archives](#working-with-archives)
@@ -236,7 +236,7 @@ auto builder = c2pa::Builder(custom_context, manifest_json);
236236
237237
### Creating a Signer
238238
239-
For testing, create a [`Signer`](https://contentauth.github.io/c2pa-c/d3/da1/classc2pa_1_1Signer.html) with certificates and private key:
239+
For testing, create a [`Signer`](https://contentauth.github.io/c2pa-cpp/d3/da1/classc2pa_1_1Signer.html) with certificates and private key:
240240
241241
```cpp
242242
#include <fstream>

scripts/amalgamate.cmake

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ set(HEADER
3434
// specific language governing permissions and limitations under
3535
// each license.
3636
37-
// Amalgamated c2pa.cpp, automatically generated from c2pa-c sources during build.
37+
// Amalgamated c2pa.cpp, automatically generated from c2pa-cpp sources during build.
3838
// DO NOT EDIT MANUALLY, this file is generated by the build system.
39-
// Built by c2pa-c. Single compilable translation unit for distribution.
39+
// Built by c2pa-cpp. Single compilable translation unit for distribution.
4040
// Include path: only c2pa.hpp (and code-requested system headers) required.
4141
4242
#include \"c2pa.hpp\"

0 commit comments

Comments
 (0)