Skip to content

Commit

Permalink
examples: Improve documentation on V3C examples
Browse files Browse the repository at this point in the history
  • Loading branch information
tampsa committed Jan 30, 2024
1 parent 8ce471d commit 5a68623
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
8 changes: 5 additions & 3 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ Follow either Visual Studio or Linux compilation instructions below:

### Visual Studio compilation

Navigate to `uvgRTP/build/examples` and open the `uvgrtp_examples.sln` with Visual Studio, through which you can build the individual example programs.
Navigate to `uvgRTP/build/examples` and open the `uvgrtp_examples.sln` with Visual Studio, through which you can build the individual example programs. When building, select the Release x64 version.
The built executable files will be found in uvgRTP/build/examples/Release

### Linux and MinGW compilation

Expand All @@ -33,8 +34,9 @@ To demonstrate V3C streaming, uvgRTP comes with example V3C sender and V3C recei
3. Download a test sequence from [here](https://ultravideo.fi/uvgRTP_example_sequence_longdress.vpcc).
4. Set the PATH variable in the [v3c_sender](v3c_sender.cc#L20) and [v3c_receiver](v3c_receiver.cc#L49) to the path of the test sequence.
5. Build the `v3c_sender` and `v3c_receiver` applications according to building instructions on the top of this page.
6. Start the `v3c_receiver` program.
7. Start the `v3c_sender` program. The program will parse the test sequence for transmission and send it to the receiver.
6. Start the `v3c_receiver` program with `./v3c_receiver`
7. Start the `v3c_sender` program with `./v3c_sender`. The program will parse the test sequence for transmission and send it to the receiver.
8. The with `v3c_receiver` will print information on the reception and reconstruction of the V3C bitstream.

## RTCP example

Expand Down
1 change: 0 additions & 1 deletion examples/v3c_receiver.cc
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,6 @@ int main(void)
// Compare reconstructed file with the original one
for (auto i = 0; i < bytes; ++i) {
if (original_buf[i] != out_buf[i]) {
std::cout << "Difference at " << i << std::endl;
diff = true;
break;
}
Expand Down

0 comments on commit 5a68623

Please sign in to comment.